[asterisk-commits] lathama: trunk r374166 - /trunk/channels/
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Mon Oct 1 18:24:42 CDT 2012
Author: lathama
Date: Mon Oct 1 18:24:35 2012
New Revision: 374166
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=374166
Log:
Doxygen Cleanup
Start adding configuration file linking and pages. Add module loading doxygen block.
Breaking up commits to keep it easy to track
(issue ASTERISK-20259)
Modified:
trunk/channels/chan_alsa.c
trunk/channels/chan_console.c
trunk/channels/chan_dahdi.c
trunk/channels/chan_gtalk.c
trunk/channels/chan_iax2.c
trunk/channels/chan_jingle.c
trunk/channels/chan_mgcp.c
trunk/channels/chan_misdn.c
trunk/channels/chan_motif.c
trunk/channels/chan_oss.c
trunk/channels/chan_sip.c
trunk/channels/chan_skinny.c
trunk/channels/chan_vpb.cc
Modified: trunk/channels/chan_alsa.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_alsa.c?view=diff&rev=374166&r1=374165&r2=374166
==============================================================================
--- trunk/channels/chan_alsa.c (original)
+++ trunk/channels/chan_alsa.c Mon Oct 1 18:24:35 2012
@@ -21,10 +21,16 @@
*
* \author Matthew Fredrickson <creslin at digium.com>
*
- * \par See also
- * \arg Config_alsa
- *
* \ingroup channel_drivers
+ */
+
+/*!
+ * \li The channel chan_alsa uses the configuration file \ref alsa.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page alsa.conf alsa.conf
+ * \verbinclude alsa.conf.sample
*/
/*** MODULEINFO
@@ -925,6 +931,16 @@
AST_CLI_DEFINE(console_mute, "Disable/Enable mic input"),
};
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
+ * configuration file or other non-critical problem return
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
static int load_module(void)
{
struct ast_config *cfg;
Modified: trunk/channels/chan_console.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_console.c?view=diff&rev=374166&r1=374165&r2=374166
==============================================================================
--- trunk/channels/chan_console.c (original)
+++ trunk/channels/chan_console.c Mon Oct 1 18:24:35 2012
@@ -45,6 +45,15 @@
* - transfer CLI command
* - boost CLI command and .conf option
* - console_video support
+ */
+
+/*!
+ * \li The channel chan_console uses the configuration file \ref console.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page console.conf console.conf
+ * \verbinclude console.conf.sample
*/
/*** MODULEINFO
@@ -1469,6 +1478,16 @@
return 0;
}
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
+ * configuration file or other non-critical problem return
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
static int load_module(void)
{
struct ast_format tmpfmt;
Modified: trunk/channels/chan_dahdi.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_dahdi.c?view=diff&rev=374166&r1=374165&r2=374166
==============================================================================
--- trunk/channels/chan_dahdi.c (original)
+++ trunk/channels/chan_dahdi.c Mon Oct 1 18:24:35 2012
@@ -29,12 +29,18 @@
* 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
+ */
+
+/*!
+ * \li The channel chan_dahdi uses the configuration file \ref chan_dahdi.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page chan_dahdi.conf chan_dahdi.conf
+ * \verbinclude chan_dahdi.conf.sample
*/
/*** MODULEINFO
@@ -19096,6 +19102,16 @@
AST_DATA_ENTRY("asterisk/channel/dahdi/version", &dahdi_version_data_provider)
};
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
+ * configuration file or other non-critical problem return
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
static int load_module(void)
{
int res;
Modified: trunk/channels/chan_gtalk.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_gtalk.c?view=diff&rev=374166&r1=374165&r2=374166
==============================================================================
--- trunk/channels/chan_gtalk.c (original)
+++ trunk/channels/chan_gtalk.c Mon Oct 1 18:24:35 2012
@@ -29,6 +29,15 @@
* ********** General TODO:s
* \todo Support config reloading.
* \todo Fix native bridging.
+ */
+
+/*!
+ * \li The channel chan_gtalk uses the configuration file \ref gtalk.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page gtalk.conf gtalk.conf
+ * \verbinclude gtalk.conf.sample
*/
/*** MODULEINFO
@@ -2297,7 +2306,16 @@
return 1;
}
-/*! \brief Load module into PBX, register channel */
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
+ * configuration file or other non-critical problem return
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
static int load_module(void)
{
struct ast_sockaddr bindaddr_tmp;
Modified: trunk/channels/chan_iax2.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_iax2.c?view=diff&rev=374166&r1=374165&r2=374166
==============================================================================
--- trunk/channels/chan_iax2.c (original)
+++ trunk/channels/chan_iax2.c Mon Oct 1 18:24:35 2012
@@ -29,6 +29,15 @@
* \ingroup channel_drivers
*
* \todo Implement musicclass settings for IAX2 devices
+ */
+
+/*!
+ * \li The channel chan_iax uses the configuration file \ref iax.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page iax.conf iax.conf
+ * \verbinclude iax.conf.sample
*/
/*** MODULEINFO
@@ -14888,7 +14897,16 @@
AST_DATA_ENTRY("asterisk/channel/iax2/users", &users_data_provider),
};
-/*! \brief Load IAX2 module, load configuraiton ---*/
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
+ * configuration file or other non-critical problem return
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
static int load_module(void)
{
static const char config[] = "iax.conf";
Modified: trunk/channels/chan_jingle.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_jingle.c?view=diff&rev=374166&r1=374165&r2=374166
==============================================================================
--- trunk/channels/chan_jingle.c (original)
+++ trunk/channels/chan_jingle.c Mon Oct 1 18:24:35 2012
@@ -25,6 +25,15 @@
* Iksemel http://iksemel.jabberstudio.org/
*
* \ingroup channel_drivers
+ */
+
+/*!
+ * \li The channel chan_jingle uses the configuration file \ref jingle.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page jingle.conf jingle.conf
+ * \verbinclude jingle.conf.sample
*/
/*** MODULEINFO
@@ -1936,7 +1945,16 @@
return 1;
}
-/*! \brief Load module into PBX, register channel */
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
+ * configuration file or other non-critical problem return
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
static int load_module(void)
{
struct ast_sockaddr ourip_tmp;
Modified: trunk/channels/chan_mgcp.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_mgcp.c?view=diff&rev=374166&r1=374165&r2=374166
==============================================================================
--- trunk/channels/chan_mgcp.c (original)
+++ trunk/channels/chan_mgcp.c Mon Oct 1 18:24:35 2012
@@ -22,10 +22,16 @@
*
* \author Mark Spencer <markster at digium.com>
*
- * \par See also
- * \arg \ref Config_mgcp
- *
* \ingroup channel_drivers
+ */
+
+/*!
+ * \li The channel chan_mgcp uses the configuration file \ref mgcp.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page mgcp.conf mgcp.conf
+ * \verbinclude mgcp.conf.sample
*/
/*** MODULEINFO
@@ -4794,7 +4800,16 @@
return 0;
}
-/*! \brief load_module: PBX load module - initialization ---*/
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
+ * configuration file or other non-critical problem return
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
static int load_module(void)
{
struct ast_format tmpfmt;
Modified: trunk/channels/chan_misdn.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_misdn.c?view=diff&rev=374166&r1=374165&r2=374166
==============================================================================
--- trunk/channels/chan_misdn.c (original)
+++ trunk/channels/chan_misdn.c Mon Oct 1 18:24:35 2012
@@ -27,6 +27,15 @@
* MISDN http://www.misdn.org/
*
* \ingroup channel_drivers
+ */
+
+/*!
+ * \li The channel chan_misdn uses the configuration file \ref misdn.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page misdn.conf misdn.conf
+ * \verbinclude misdn.conf.sample
*/
/*!
@@ -11275,6 +11284,16 @@
return 0;
}
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
+ * configuration file or other non-critical problem return
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
static int load_module(void)
{
int i, port;
Modified: trunk/channels/chan_motif.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_motif.c?view=diff&rev=374166&r1=374165&r2=374166
==============================================================================
--- trunk/channels/chan_motif.c (original)
+++ trunk/channels/chan_motif.c Mon Oct 1 18:24:35 2012
@@ -25,6 +25,15 @@
* Iksemel http://iksemel.jabberstudio.org/
*
* \ingroup channel_drivers
+ */
+
+/*!
+ * \li The channel chan_motif uses the configuration file \ref motif.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page motif.conf motif.conf
+ * \verbinclude motif.conf.sample
*/
/*** MODULEINFO
@@ -2498,7 +2507,16 @@
return 0;
}
-/*! \brief Load module into PBX, register channel */
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
+ * configuration file or other non-critical problem return
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
static int load_module(void)
{
if (!(jingle_tech.capabilities = ast_format_cap_alloc())) {
Modified: trunk/channels/chan_oss.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_oss.c?view=diff&rev=374166&r1=374165&r2=374166
==============================================================================
--- trunk/channels/chan_oss.c (original)
+++ trunk/channels/chan_oss.c Mon Oct 1 18:24:35 2012
@@ -27,10 +27,16 @@
* \author Mark Spencer <markster at digium.com>
* \author Luigi Rizzo
*
- * \par See also
- * \arg \ref Config_oss
- *
* \ingroup channel_drivers
+ */
+
+/*!
+ * \li The channel chan_oss uses the configuration file \ref oss.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page oss.conf oss.conf
+ * \verbinclude oss.conf.sample
*/
/*** MODULEINFO
@@ -1436,6 +1442,16 @@
#endif
}
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
+ * configuration file or other non-critical problem return
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
static int load_module(void)
{
struct ast_config *cfg = NULL;
Modified: trunk/channels/chan_sip.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_sip.c?view=diff&rev=374166&r1=374165&r2=374166
==============================================================================
--- trunk/channels/chan_sip.c (original)
+++ trunk/channels/chan_sip.c Mon Oct 1 18:24:35 2012
@@ -90,6 +90,19 @@
* \par Hanging up
* The PBX issues a hangup on both incoming and outgoing calls through
* the sip_hangup() function
+ */
+
+/*!
+ * \li The channel chan_sip uses configuration files \ref sip.conf and \ref sip_notify.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page sip.conf sip.conf
+ * \verbinclude sip.conf.sample
+ */
+
+/*! \page sip_notify.conf sip_notify.conf
+ * \verbinclude sip_notify.conf.sample
*/
/*!
@@ -815,13 +828,15 @@
static int can_parse_xml;
/*! \name Object counters @{
- * \bug These counters are not handled in a thread-safe way ast_atomic_fetchadd_int()
- * should be used to modify these values. */
+ *
+ * \bug These counters are not handled in a thread-safe way ast_atomic_fetchadd_int()
+ * should be used to modify these values.
+ */
static int speerobjs = 0; /*!< Static peers */
static int rpeerobjs = 0; /*!< Realtime peers */
static int apeerobjs = 0; /*!< Autocreated peer objects */
static int regobjs = 0; /*!< Registry objects */
-/* }@ */
+/*! @} */
static struct ast_flags global_flags[3] = {{0}}; /*!< global SIP_ flags */
static int global_t38_maxdatagram; /*!< global T.38 FaxMaxDatagram override */
@@ -33306,7 +33321,16 @@
AST_DATA_ENTRY("asterisk/channel/sip/peers", &peers_data_provider),
};
-/*! \brief PBX load module - initialization */
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
+ * configuration file or other non-critical problem return
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
static int load_module(void)
{
ast_verbose("SIP channel loading...\n");
Modified: trunk/channels/chan_skinny.c
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_skinny.c?view=diff&rev=374166&r1=374165&r2=374166
==============================================================================
--- trunk/channels/chan_skinny.c (original)
+++ trunk/channels/chan_skinny.c Mon Oct 1 18:24:35 2012
@@ -23,6 +23,15 @@
*
* \author Jeremy McNamara & Florian Overkamp & North Antara
* \ingroup channel_drivers
+ */
+
+/*!
+ * \li The channel chan_skinny uses the configuration file \ref skinny.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page skinny.conf skinny.conf
+ * \verbinclude skinny.conf.sample
*/
/*** MODULEINFO
@@ -7958,6 +7967,16 @@
return 0;
}
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
+ * configuration file or other non-critical problem return
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
static int load_module(void)
{
int res = 0;
Modified: trunk/channels/chan_vpb.cc
URL: http://svnview.digium.com/svn/asterisk/trunk/channels/chan_vpb.cc?view=diff&rev=374166&r1=374165&r2=374166
==============================================================================
--- trunk/channels/chan_vpb.cc (original)
+++ trunk/channels/chan_vpb.cc Mon Oct 1 18:24:35 2012
@@ -27,6 +27,15 @@
* \brief VoiceTronix Interface driver
*
* \ingroup channel_drivers
+ */
+
+/*!
+ * \li The channel chan_vpb uses the configuration file \ref vpb.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page vpb.conf vpb.conf
+ * \verbinclude vpb.conf.sample
*/
/*** MODULEINFO
@@ -2648,6 +2657,16 @@
return 0;
}
+/*!
+ * \brief Load the module
+ *
+ * Module loading including tests for configuration or dependencies.
+ * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
+ * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
+ * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
+ * configuration file or other non-critical problem return
+ * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
+ */
static enum ast_module_load_result load_module()
{
struct ast_config *cfg;
More information about the asterisk-commits
mailing list