[svn-commits] lathama: branch lathama/doxygencleanups r373402 - in /team/lathama/doxygencle...
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Sun Sep 23 11:59:48 CDT 2012
Author: lathama
Date: Sun Sep 23 11:59:44 2012
New Revision: 373402
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=373402
Log:
Configuration file notation updates
Modified:
team/lathama/doxygencleanups/addons/app_mysql.c
team/lathama/doxygencleanups/apps/app_adsiprog.c
team/lathama/doxygencleanups/apps/app_alarmreceiver.c
team/lathama/doxygencleanups/apps/app_amd.c
team/lathama/doxygencleanups/apps/app_queue.c
team/lathama/doxygencleanups/apps/app_voicemail.c
team/lathama/doxygencleanups/channels/chan_alsa.c
team/lathama/doxygencleanups/channels/chan_console.c
team/lathama/doxygencleanups/channels/chan_dahdi.c
team/lathama/doxygencleanups/channels/chan_gtalk.c
team/lathama/doxygencleanups/channels/chan_iax2.c
team/lathama/doxygencleanups/channels/chan_jingle.c
team/lathama/doxygencleanups/channels/chan_mgcp.c
team/lathama/doxygencleanups/channels/chan_misdn.c
team/lathama/doxygencleanups/channels/chan_motif.c
team/lathama/doxygencleanups/channels/chan_oss.c
team/lathama/doxygencleanups/channels/chan_sip.c
team/lathama/doxygencleanups/channels/chan_skinny.c
team/lathama/doxygencleanups/channels/chan_vpb.cc
team/lathama/doxygencleanups/main/asterisk.c
team/lathama/doxygencleanups/main/http.c
team/lathama/doxygencleanups/res/res_fax.c
Modified: team/lathama/doxygencleanups/addons/app_mysql.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/addons/app_mysql.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/addons/app_mysql.c (original)
+++ team/lathama/doxygencleanups/addons/app_mysql.c Sun Sep 23 11:59:44 2012
@@ -26,7 +26,6 @@
/*!
* \par The application app_mysql uses configuration files
* \li \ref app_mysql.conf
- *
* \addtogroup configuration_file Configuration Files
*/
Modified: team/lathama/doxygencleanups/apps/app_adsiprog.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_adsiprog.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/apps/app_adsiprog.c (original)
+++ team/lathama/doxygencleanups/apps/app_adsiprog.c Sun Sep 23 11:59:44 2012
@@ -29,7 +29,6 @@
* \par The application app_adsiprog uses configuration files
* \li \ref adsi.conf
* \li \ref asterisk.adsi
- *
* \addtogroup configuration_file Configuration Files
*/
Modified: team/lathama/doxygencleanups/apps/app_alarmreceiver.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_alarmreceiver.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/apps/app_alarmreceiver.c (original)
+++ team/lathama/doxygencleanups/apps/app_alarmreceiver.c Sun Sep 23 11:59:44 2012
@@ -33,7 +33,6 @@
/*!
* \par The application app_alarmreceiver uses configuration files
* \li \ref alarmreceiver.conf
- *
* \addtogroup configuration_file Configuration Files
*/
Modified: team/lathama/doxygencleanups/apps/app_amd.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_amd.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/apps/app_amd.c (original)
+++ team/lathama/doxygencleanups/apps/app_amd.c Sun Sep 23 11:59:44 2012
@@ -31,7 +31,6 @@
/*!
* \par The application app_amd uses configuration files
* \li \ref amd.conf
- *
* \addtogroup configuration_file Configuration Files
*/
Modified: team/lathama/doxygencleanups/apps/app_queue.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_queue.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/apps/app_queue.c (original)
+++ team/lathama/doxygencleanups/apps/app_queue.c Sun Sep 23 11:59:44 2012
@@ -55,8 +55,8 @@
*/
/*!
- * \par This application app_queues uses configuration files
- *
+ * \par The application app_queues uses configuration files
+ * \li \ref queues.conf
* \addtogroup configuration_file
*/
Modified: team/lathama/doxygencleanups/apps/app_voicemail.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/apps/app_voicemail.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/apps/app_voicemail.c (original)
+++ team/lathama/doxygencleanups/apps/app_voicemail.c Sun Sep 23 11:59:44 2012
@@ -28,7 +28,7 @@
* \par See also
* \arg \ref Config_vm
* \note For information about voicemail IMAP storage, https://wiki.asterisk.org/wiki/display/AST/IMAP+Voicemail+Storage
- * \ingroup applications
+ * \ingroup applications
* \todo This module requires res_adsi to load. This needs to be optional
* during compilation.
*
@@ -40,7 +40,6 @@
/*!
* \par The application app_voicemail uses configuration files
* \li \ref voicemail.conf
- *
* \addtogroup configuration_file Configuration Files
*/
Modified: team/lathama/doxygencleanups/channels/chan_alsa.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_alsa.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_alsa.c (original)
+++ team/lathama/doxygencleanups/channels/chan_alsa.c Sun Sep 23 11:59:44 2012
@@ -21,10 +21,17 @@
*
* \author Matthew Fredrickson <creslin at digium.com>
*
- * \par See also
- * \arg Config_alsa
- *
* \ingroup channel_drivers
+ */
+
+/*!
+ * \par The channel chan_alsa uses configuration files
+ * \li \ref alsa.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page alsa.conf alsa.conf
+ * \verbinclude alsa.conf.sample
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/channels/chan_console.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_console.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_console.c (original)
+++ team/lathama/doxygencleanups/channels/chan_console.c Sun Sep 23 11:59:44 2012
@@ -45,6 +45,16 @@
* - transfer CLI command
* - boost CLI command and .conf option
* - console_video support
+ */
+
+/*!
+ * \par The channel chan_console uses configuration files
+ * \li \ref console.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page console.conf console.conf
+ * \verbinclude console.conf.sample
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/channels/chan_dahdi.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_dahdi.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_dahdi.c (original)
+++ team/lathama/doxygencleanups/channels/chan_dahdi.c Sun Sep 23 11:59:44 2012
@@ -29,12 +29,19 @@
* You need to install libraries before you attempt to compile
* and install the DAHDI channel.
*
- * \par See also
- * \arg \ref Config_dahdi
- *
* \ingroup channel_drivers
*
* \todo Deprecate the "musiconhold" configuration option post 1.4
+ */
+
+/*!
+ * \par The channel chan_dahdi uses configuration files
+ * \li \ref chan_dahdi.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page chan_dahdi.conf chan_dahdi.conf
+ * \verbinclude chan_dahdi.conf.sample
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/channels/chan_gtalk.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_gtalk.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_gtalk.c (original)
+++ team/lathama/doxygencleanups/channels/chan_gtalk.c Sun Sep 23 11:59:44 2012
@@ -29,6 +29,16 @@
* ********** General TODO:s
* \todo Support config reloading.
* \todo Fix native bridging.
+ */
+
+/*!
+ * \par The channel chan_gtalk uses configuration files
+ * \li \ref gtalk.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page gtalk.conf gtalk.conf
+ * \verbinclude gtalk.conf.sample
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/channels/chan_iax2.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_iax2.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_iax2.c (original)
+++ team/lathama/doxygencleanups/channels/chan_iax2.c Sun Sep 23 11:59:44 2012
@@ -29,6 +29,16 @@
* \ingroup channel_drivers
*
* \todo Implement musicclass settings for IAX2 devices
+ */
+
+/*!
+ * \par The channel chan_iax uses configuration files
+ * \li \ref iax.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page iax.conf iax.conf
+ * \verbinclude iax.conf.sample
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/channels/chan_jingle.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_jingle.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_jingle.c (original)
+++ team/lathama/doxygencleanups/channels/chan_jingle.c Sun Sep 23 11:59:44 2012
@@ -25,6 +25,16 @@
* Iksemel http://iksemel.jabberstudio.org/
*
* \ingroup channel_drivers
+ */
+
+/*!
+ * \par The channel chan_jingle uses configuration files
+ * \li \ref jingle.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page jingle.conf jingle.conf
+ * \verbinclude jingle.conf.sample
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/channels/chan_mgcp.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_mgcp.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_mgcp.c (original)
+++ team/lathama/doxygencleanups/channels/chan_mgcp.c Sun Sep 23 11:59:44 2012
@@ -22,10 +22,17 @@
*
* \author Mark Spencer <markster at digium.com>
*
- * \par See also
- * \arg \ref Config_mgcp
- *
* \ingroup channel_drivers
+ */
+
+/*!
+ * \par The channel chan_mgcp uses configuration files
+ * \li \ref mgcp.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page mgcp.conf mgcp.conf
+ * \verbinclude mgcp.conf.sample
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/channels/chan_misdn.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_misdn.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_misdn.c (original)
+++ team/lathama/doxygencleanups/channels/chan_misdn.c Sun Sep 23 11:59:44 2012
@@ -27,6 +27,16 @@
* MISDN http://www.misdn.org/
*
* \ingroup channel_drivers
+ */
+
+/*!
+ * \par The channel chan_misdn uses configuration files
+ * \li \ref misdn.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page misdn.conf misdn.conf
+ * \verbinclude misdn.conf.sample
*/
/*!
Modified: team/lathama/doxygencleanups/channels/chan_motif.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_motif.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_motif.c (original)
+++ team/lathama/doxygencleanups/channels/chan_motif.c Sun Sep 23 11:59:44 2012
@@ -25,6 +25,16 @@
* Iksemel http://iksemel.jabberstudio.org/
*
* \ingroup channel_drivers
+ */
+
+/*!
+ * \par The channel chan_motif uses configuration files
+ * \li \ref motif.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page motif.conf motif.conf
+ * \verbinclude motif.conf.sample
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/channels/chan_oss.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_oss.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_oss.c (original)
+++ team/lathama/doxygencleanups/channels/chan_oss.c Sun Sep 23 11:59:44 2012
@@ -27,10 +27,17 @@
* \author Mark Spencer <markster at digium.com>
* \author Luigi Rizzo
*
- * \par See also
- * \arg \ref Config_oss
- *
* \ingroup channel_drivers
+ */
+
+/*!
+ * \par The channel chan_oss uses configuration files
+ * \li \ref oss.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page oss.conf oss.conf
+ * \verbinclude oss.conf.sample
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/channels/chan_sip.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_sip.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_sip.c (original)
+++ team/lathama/doxygencleanups/channels/chan_sip.c Sun Sep 23 11:59:44 2012
@@ -93,10 +93,9 @@
*/
/*!
- * \par Uses configuration files
+ * \par The channel chan_sip uses configuration files
* \li \ref sip.conf
* \li \ref sip_notify.conf
- *
* \addtogroup configuration_file
*/
Modified: team/lathama/doxygencleanups/channels/chan_skinny.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_skinny.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_skinny.c (original)
+++ team/lathama/doxygencleanups/channels/chan_skinny.c Sun Sep 23 11:59:44 2012
@@ -23,6 +23,16 @@
*
* \author Jeremy McNamara & Florian Overkamp & North Antara
* \ingroup channel_drivers
+ */
+
+/*!
+ * \par The channel chan_skinny uses configuration files
+ * \li \ref skinny.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page skinny.conf skinny.conf
+ * \verbinclude skinny.conf.sample
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/channels/chan_vpb.cc
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/channels/chan_vpb.cc?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/channels/chan_vpb.cc (original)
+++ team/lathama/doxygencleanups/channels/chan_vpb.cc Sun Sep 23 11:59:44 2012
@@ -27,6 +27,16 @@
* \brief VoiceTronix Interface driver
*
* \ingroup channel_drivers
+ */
+
+/*!
+ * \par The channel chan_vpb uses configuration files
+ * \li \ref vpb.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page vpb.conf vpb.conf
+ * \verbinclude vpb.conf.sample
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/main/asterisk.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/asterisk.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/main/asterisk.c (original)
+++ team/lathama/doxygencleanups/main/asterisk.c Sun Sep 23 11:59:44 2012
@@ -149,6 +149,16 @@
/*! \file
* \brief Top level source file for Asterisk - the Open Source PBX.
* Implementation of PBX core functions and CLI interface.
+ */
+
+/*!
+ * \par The Asterisk core uses configuration files
+ * \li \ref asterisk.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page asterisk.conf asterisk.conf
+ * \verbinclude asterisk.conf.sample
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/main/http.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/main/http.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/main/http.c (original)
+++ team/lathama/doxygencleanups/main/http.c Sun Sep 23 11:59:44 2012
@@ -28,6 +28,16 @@
* GMime http://spruce.sourceforge.net/gmime/
*
* \ref AstHTTP - AMI over the http protocol
+ */
+
+/*!
+ * \par The core module http uses configuration files
+ * \li \ref http.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page http.conf http.conf
+ * \verbinclude http.conf.sample
*/
/*** MODULEINFO
Modified: team/lathama/doxygencleanups/res/res_fax.c
URL: http://svnview.digium.com/svn/asterisk/team/lathama/doxygencleanups/res/res_fax.c?view=diff&rev=373402&r1=373401&r2=373402
==============================================================================
--- team/lathama/doxygencleanups/res/res_fax.c (original)
+++ team/lathama/doxygencleanups/res/res_fax.c Sun Sep 23 11:59:44 2012
@@ -57,7 +57,6 @@
/*!
* \par The resource res_fax uses configuration files
* \li \ref res_fax.conf
- *
* \addtogroup configuration_file Configuration Files
*/
More information about the svn-commits
mailing list