From 6c20cf2d8ac34f7f336565118c2e88e238c0b2d0 Mon Sep 17 00:00:00 2001 From: Andrew Latham Date: Thu, 18 Oct 2012 14:17:40 +0000 Subject: Doxygen Updates - Title update Update and extend the configuration_file group and enable linking. Commit other cleanups from multi-version Doxygen testing. Update title that was left behind many years ago. (issue ASTERISK-20259) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@375182 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- main/app.c | 6 ++++-- main/asterisk.c | 5 +++-- main/ccss.c | 9 +++++++++ main/cdr.c | 8 ++++++++ main/cel.c | 9 +++++++++ main/cli.c | 9 +++++++++ main/dnsmgr.c | 11 +++++++++++ main/dsp.c | 9 +++++++++ main/enum.c | 9 +++++++++ main/features.c | 9 +++++++++ main/http.c | 3 +-- main/logger.c | 9 +++++++++ main/manager.c | 7 +++++-- main/named_acl.c | 2 +- main/udptl.c | 11 ++++++++++- 15 files changed, 106 insertions(+), 10 deletions(-) (limited to 'main') diff --git a/main/app.c b/main/app.c index bd94b40ea..e3a5f02c3 100644 --- a/main/app.c +++ b/main/app.c @@ -23,8 +23,10 @@ * \author Mark Spencer */ -/** \example app_skel.c - * This is an example of how to develop an app +/** \example + * \par This is an example of how to develop an app. + * Application Skeleton is an example of creating an application for Asterisk. + * \verbinclude app_skel.c */ /*** MODULEINFO diff --git a/main/asterisk.c b/main/asterisk.c index 78a481d7c..80643b15a 100644 --- a/main/asterisk.c +++ b/main/asterisk.c @@ -48,6 +48,8 @@ * \arg \ref Licensing * \arg \ref DevDoc * \arg \ref configuration_file + * \arg \ref channel_drivers + * \arg \ref applications * * \section copyright Copyright and Author * @@ -133,8 +135,7 @@ * Implementation of PBX core functions and CLI interface. */ -/*! - * \li The Asterisk core uses the configuration file \ref asterisk.conf +/*! \li \ref asterisk.c uses the configuration file \ref asterisk.conf * \addtogroup configuration_file */ diff --git a/main/ccss.c b/main/ccss.c index 70e16c7a9..d6b10b261 100644 --- a/main/ccss.c +++ b/main/ccss.c @@ -21,6 +21,15 @@ * \author Mark Michelson */ +/*! \li \ref ccss.c uses the configuration file \ref ccss.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page ccss.conf ccss.conf + * \verbinclude ccss.conf.sample + */ + /*** MODULEINFO core ***/ diff --git a/main/cdr.c b/main/cdr.c index 9c4efee21..44cf1c3d2 100644 --- a/main/cdr.c +++ b/main/cdr.c @@ -30,6 +30,14 @@ * isn't properly generated and posted. */ +/*! \li \ref cdr.c uses the configuration file \ref cdr.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page cdr.conf cdr.conf + * \verbinclude cdr.conf.sample + */ /*** MODULEINFO core diff --git a/main/cel.c b/main/cel.c index 3301e81e7..6af617478 100644 --- a/main/cel.c +++ b/main/cel.c @@ -27,6 +27,15 @@ * as expected. */ +/*! \li \ref cel.c uses the configuration file \ref cel.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page cel.conf cel.conf + * \verbinclude cel.conf.sample + */ + /*** MODULEINFO core ***/ diff --git a/main/cli.c b/main/cli.c index 6a2a39f81..fc307b164 100644 --- a/main/cli.c +++ b/main/cli.c @@ -23,6 +23,15 @@ * \author Mark Spencer */ +/*! \li \ref cli.c uses the configuration file \ref cli_permissions.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page cli_permissions.conf cli_permissions.conf + * \verbinclude cli_permissions.conf.sample + */ + /*** MODULEINFO core ***/ diff --git a/main/dnsmgr.c b/main/dnsmgr.c index d4b9d94d2..1a5fd154e 100644 --- a/main/dnsmgr.c +++ b/main/dnsmgr.c @@ -28,6 +28,17 @@ * thread is in the middle of updating it to the new address. */ + +/*! \li \ref dnsmgr.c uses the configuration file \ref dnsmgr.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page dnsmgr.conf dnsmgr.conf + * \verbinclude dnsmgr.conf.sample + */ + + /*** MODULEINFO core ***/ diff --git a/main/dsp.c b/main/dsp.c index 56fae0db4..6027cd748 100644 --- a/main/dsp.c +++ b/main/dsp.c @@ -27,6 +27,15 @@ * \author Steve Underwood */ +/*! \li \ref dsp.c uses the configuration file \ref dsp.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page dsp.conf dsp.conf + * \verbinclude dsp.conf.sample + */ + /* Some routines from tone_detect.c by Steven Underwood as published under the zapata library */ /* tone_detect.c - General telephony tone detection, and specific diff --git a/main/enum.c b/main/enum.c index 0dead9aa5..60e603d21 100644 --- a/main/enum.c +++ b/main/enum.c @@ -45,6 +45,15 @@ * \todo The service type selection needs to be redone. */ +/*! \li \ref enum.c uses the configuration file \ref enum.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page enum.conf enum.conf + * \verbinclude enum.conf.sample + */ + /*** MODULEINFO core ***/ diff --git a/main/features.c b/main/features.c index e84a2a271..42aaa7c5f 100644 --- a/main/features.c +++ b/main/features.c @@ -24,6 +24,15 @@ * \author Mark Spencer */ +/*! \li \ref features.c uses the configuration file \ref features.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page features.conf features.conf + * \verbinclude features.conf.sample + */ + /*** MODULEINFO core ***/ diff --git a/main/http.c b/main/http.c index b940ae17e..62552529a 100644 --- a/main/http.c +++ b/main/http.c @@ -30,8 +30,7 @@ * \ref AstHTTP - AMI over the http protocol */ -/*! - * \li The core module http uses the configuration file \ref http.conf +/*! \li \ref http.c uses the configuration file \ref http.conf * \addtogroup configuration_file */ diff --git a/main/logger.c b/main/logger.c index c4836c653..945a453d0 100644 --- a/main/logger.c +++ b/main/logger.c @@ -25,6 +25,15 @@ * \author Mark Spencer */ +/*! \li \ref logger.c uses the configuration file \ref logger.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page logger.conf logger.conf + * \verbinclude logger.conf.sample + */ + /*** MODULEINFO core ***/ diff --git a/main/manager.c b/main/manager.c index a493af346..b383b8720 100644 --- a/main/manager.c +++ b/main/manager.c @@ -36,8 +36,7 @@ * \ref amiconf */ -/*! - * \li The core Manager uses the configuration file \ref manager.conf +/*! \li \ref manager.c uses the configuration file \ref manager.conf and \ref users.conf * \addtogroup configuration_file */ @@ -45,6 +44,10 @@ * \verbinclude manager.conf.sample */ +/*! \page users.conf users.conf + * \verbinclude users.conf.sample + */ + /*** MODULEINFO core ***/ diff --git a/main/named_acl.c b/main/named_acl.c index fce6aa88e..a70ca87a4 100644 --- a/main/named_acl.c +++ b/main/named_acl.c @@ -1,5 +1,5 @@ /* - * Asterisk -- A telephony toolkit for Linux. + * Asterisk -- An open source telephony toolkit. * * Copyright (C) 2012, Digium, Inc. * diff --git a/main/udptl.c b/main/udptl.c index 83dcd3d90..4e48ac80e 100644 --- a/main/udptl.c +++ b/main/udptl.c @@ -1,5 +1,5 @@ /* - * Asterisk -- A telephony toolkit for Linux. + * Asterisk -- An open source telephony toolkit. * * UDPTL support for T.38 * @@ -48,6 +48,15 @@ * - app_fax.c */ +/*! \li \ref udptl.c uses the configuration file \ref udptl.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page udptl.conf udptl.conf + * \verbinclude udptl.conf.sample + */ + /*** MODULEINFO core ***/ -- cgit v1.2.3