Doxygen Cleanup
authorAndrew Latham <lathama@gmail.com>
Mon, 1 Oct 2012 23:24:35 +0000 (23:24 +0000)
committerAndrew Latham <lathama@gmail.com>
Mon, 1 Oct 2012 23:24:35 +0000 (23:24 +0000)
Start adding configuration file linking and pages.  Add module loading doxygen block.

Breaking up commits to keep it easy to track

(issue ASTERISK-20259)

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@374166 65c4cc65-6c06-0410-ace0-fbb531ad65f3

13 files changed:
channels/chan_alsa.c
channels/chan_console.c
channels/chan_dahdi.c
channels/chan_gtalk.c
channels/chan_iax2.c
channels/chan_jingle.c
channels/chan_mgcp.c
channels/chan_misdn.c
channels/chan_motif.c
channels/chan_oss.c
channels/chan_sip.c
channels/chan_skinny.c
channels/chan_vpb.cc

index 71d51ad..ec4fa8c 100644 (file)
  *
  * \author Matthew Fredrickson <creslin@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
        <depend>alsa</depend>
        <support_level>extended</support_level>
@@ -925,6 +931,16 @@ static struct ast_cli_entry cli_alsa[] = {
        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;
index 5eef4c3..d936084 100644 (file)
  * - 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
        <depend>portaudio</depend>
        <support_level>extended</support_level>
@@ -1469,6 +1478,16 @@ static int unload_module(void)
        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;
index f669e2e..6783126 100644 (file)
  * 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
        <use type="module">res_smdi</use>
        <depend>dahdi</depend>
@@ -19096,6 +19102,16 @@ static const struct ast_data_entry dahdi_data_providers[] = {
        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;
index f30a341..d257f0f 100644 (file)
  * \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
         <defaultenabled>no</defaultenabled>
        <depend>iksemel</depend>
@@ -2297,7 +2306,16 @@ static int gtalk_load_config(void)
        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;
index 6309184..961efa7 100644 (file)
  * \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
        <use type="external">crypto</use>
        <support_level>core</support_level>
@@ -14888,7 +14897,16 @@ static const struct ast_data_entry iax2_data_providers[] = {
        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";
index dfc2ea9..d5fe3c0 100644 (file)
  * \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
        <depend>iksemel</depend>
        <depend>res_jabber</depend>
@@ -1936,7 +1945,16 @@ static int jingle_load_config(void)
        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;
index 13a5180..1655399 100644 (file)
  *
  * \author Mark Spencer <markster@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
         <use type="module">res_pktccops</use>
        <support_level>extended</support_level>
@@ -4794,7 +4800,16 @@ static int reload_config(int reload)
        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;
index 2f644a8..5a36e93 100644 (file)
  */
 
 /*!
+ * \li The channel chan_misdn uses the configuration file \ref misdn.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page misdn.conf misdn.conf
+ * \verbinclude misdn.conf.sample
+ */
+
+/*!
  * \note
  * To use the CCBS/CCNR supplementary service feature and other
  * supplementary services using FACILITY messages requires a
@@ -11275,6 +11284,16 @@ static int unload_module(void)
        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;
index 77c4467..6c62f6a 100644 (file)
  * \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
        <depend>iksemel</depend>
        <depend>res_xmpp</depend>
@@ -2498,7 +2507,16 @@ static int custom_transport_handler(const struct aco_option *opt, struct ast_var
        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())) {
index 0e3b02b..504cb90 100644 (file)
  * \author Mark Spencer <markster@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
        <depend>oss</depend>
        <support_level>extended</support_level>
@@ -1436,6 +1442,16 @@ error:
 #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;
index a1edca9..8e071e1 100644 (file)
  * 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
+ */
+
 /*!
  * \page sip_tcp_tls SIP TCP and TLS support
  *
@@ -815,13 +828,15 @@ static unsigned char global_refer_addheaders; /*!< Add extra headers to outgoing
 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 @@ static const struct ast_data_entry sip_data_providers[] = {
        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");
index c30338a..a62de91 100644 (file)
  * \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
        <support_level>extended</support_level>
  ***/
@@ -7958,6 +7967,16 @@ int skinny_reload(void)
         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;
index 378c447..d4d08c0 100644 (file)
  * \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
        <depend>vpb</depend>
        <defaultenabled>no</defaultenabled>
@@ -2648,6 +2657,16 @@ static int unload_module(void)
        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;