Doxygen Cleanup
authorAndrew Latham <lathama@gmail.com>
Mon, 1 Oct 2012 23:24:10 +0000 (23:24 +0000)
committerAndrew Latham <lathama@gmail.com>
Mon, 1 Oct 2012 23:24:10 +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@374165 65c4cc65-6c06-0410-ace0-fbb531ad65f3

14 files changed:
res/res_calendar.c
res/res_clialiases.c
res/res_config_ldap.c
res/res_config_sqlite.c
res/res_config_sqlite3.c
res/res_curl.c
res/res_fax.c
res/res_musiconhold.c
res/res_odbc.c
res/res_phoneprov.c
res/res_smdi.c
res/res_snmp.c
res/res_timing_kqueue.c
res/res_xmpp.c

index 8c34994..dd2a643 100644 (file)
  * \todo Support writing attendees
  */
 
+/*!
+ * \li The resource res_calendar uses the configuration file \ref calendar.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*! 
+ * \page calendar.conf calendar.conf
+ * \verbinclude calendar.conf.sample
+ */
+
 /*** MODULEINFO
        <support_level>core</support_level>
  ***/
@@ -1830,6 +1840,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)
 {
        if (!(calendars = ao2_container_alloc(CALENDAR_BUCKETS, calendar_hash_fn, calendar_cmp_fn))) {
index 123fe5a..58e0710 100644 (file)
  * CLI commands.
  */
 
+/*!
+ * \li The resource res_clialiases uses the configuration file \ref cli_aliases.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*! 
+ * \page cli_aliases.conf cli_aliases.conf
+ * \verbinclude cli_aliases.conf.sample
+ */
+
 /*** MODULEINFO
        <support_level>core</support_level>
  ***/
@@ -238,7 +248,16 @@ static int unload_module(void)
        return 0;
 }
 
-/*! \brief Function called to load the module */
+/*!
+ * \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 (!(cli_aliases = ao2_container_alloc(MAX_ALIAS_BUCKETS, alias_hash_cb, alias_cmp_cb))) {
index 0818c49..b7df2a1 100644 (file)
  * OpenLDAP http://www.openldap.org
  */
 
+/*!
+ * \li The resource res_config_ldap uses the configuration file \ref res_ldap.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*! 
+ * \page res_ldap.conf res_ldap.conf
+ * \verbinclude res_ldap.conf.sample
+ */
+
 /*** MODULEINFO
        <depend>ldap</depend>
        <support_level>extended</support_level>
@@ -1542,6 +1552,16 @@ static struct ast_config_engine ldap_engine = {
        .update2_func = update2_ldap,
 };
 
+/*!
+ * \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 (parse_config() < 0) {
index e075360..835d779 100644 (file)
  * \brief res_config_sqlite module.
  */
 
+/*! 
+ * \li The resource res_config_sqlite uses the configuration file \ref res_config_sqlite.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*! 
+ * \page res_config_sqlite.conf res_config_sqlite.conf
+ * \verbinclude res_config_sqlite.conf.sample
+ */
+
 /*** MODULEINFO
        <depend>sqlite</depend>
        <support_level>extended</support_level>
@@ -1758,6 +1768,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)
 {
        char *errormsg = NULL;
index 17b641d..9482614 100644 (file)
  * \ingroup resources
  */
 
+/*!
+ * \li The resource res_config_sqlite3 uses the configuration file \ref res_config_sqlite3.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*! 
+ * \page res_config_sqlite3.conf res_config_sqlite3.conf
+ * \verbinclude res_config_sqlite3.conf.sample
+ */
+
 /*** MODULEINFO
        <depend>sqlite3</depend>
        <support_level>core</support_level>
@@ -1162,6 +1172,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)
 {
        if (!((databases = ao2_container_alloc(DB_BUCKETS, db_hash_fn, db_cmp_fn)))) {
index 9008f2a..dede2f1 100644 (file)
  * 
  */
 
+/*!
+ * \li The resource res_curl uses the configuration file \ref res_curl.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*! 
+ * \page res_curl.conf res_curl.conf
+ * \verbinclude res_curl.conf.sample
+ */
+
 /*** MODULEINFO
        <depend>curl</depend>
        <support_level>core</support_level>
@@ -65,6 +75,16 @@ static int unload_module(void)
        return res;
 }
 
+/*!
+ * \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 900f21f..dcc3fd4 100644 (file)
  * \ingroup applications
  */
 
+/*!
+ * \li The resource res_fax uses the configuration file \ref res_fax.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*! 
+ * \page res_fax.conf res_fax.conf
+ * \verbinclude res_fax.conf.sample
+ */
+
 #include "asterisk.h"
 
 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
@@ -4104,7 +4114,16 @@ static int unload_module(void)
        return 0;
 }
 
-/*! \brief load res_fax */
+/*!
+ * \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 ec990d5..3c61b26 100644 (file)
 /*! \file
  *
  * \brief Routines implementing music on hold
- *
- * \arg See also \ref Config_moh
  * 
  * \author Mark Spencer <markster@digium.com>
  */
 
+/*!
+ * \li The resource res_musiconhold uses the configuration file \ref musiconhold.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*! 
+ * \page musiconhold.conf musiconhold.conf
+ * \verbinclude musiconhold.conf.sample
+ */
+
 /*** MODULEINFO
        <conflict>win32</conflict>
        <support_level>core</support_level>
@@ -1941,6 +1949,16 @@ static int moh_class_cmp(void *obj, void *arg, int flags)
                CMP_MATCH | CMP_STOP;
 }
 
+/*!
+ * \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 797f31e..7420700 100644 (file)
  * \arg See also: \ref cdr_odbc
  */
 
+/*! 
+ * \li The resource res_odbc uses the configuration file \ref res_odbc.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*! 
+ * \page res_odbc.conf res_odbc.conf
+ * \verbinclude res_odbc.conf.sample
+ */
+
 /*** MODULEINFO
        <depend>generic_odbc</depend>
        <depend>ltdl</depend>
@@ -1875,6 +1885,16 @@ static int unload_module(void)
        return -1;
 }
 
+/*!
+ * \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 (!(class_container = ao2_container_alloc(1, null_hash_fn, ao2_match_by_addr)))
index 4ae7efe..aa38d60 100644 (file)
  * \author Terry Wilson <twilson@digium.com>
  */
 
+/*! 
+ * \li The resource res_phoneprov uses the configuration file \ref phoneprov.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*! 
+ * \page phoneprov.conf phoneprov.conf
+ * \verbinclude phoneprov.conf.sample
+ */
+
 /*** MODULEINFO
        <support_level>extended</support_level>
  ***/
@@ -1270,6 +1280,16 @@ static struct ast_http_uri phoneprovuri = {
        .key = __FILE__,
 };
 
+/*!
+ * \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)
 {
        profiles = ao2_container_alloc(MAX_PROFILE_BUCKETS, profile_hash_fn, profile_cmp_fn);
index 354743c..4ae101b 100644 (file)
  * polling thread handle it.
  */
 
+/*!
+ * \li The resource res_smdi uses the configuration file \ref smdi.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*!
+ * \page smdi.conf smdi.conf
+ * \verbinclude smdi.conf.sample
+ */
+
 /*** MODULEINFO
        <support_level>core</support_level>
  ***/
@@ -1396,6 +1406,16 @@ static struct ast_custom_function smdi_msg_function = {
 
 static int _unload_module(int fromload);
 
+/*!
+ * \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 4368d84..60d0070 100644 (file)
  *      http://net-snmp.sourceforge.net/
  */
 
+/*!
+ * \li The resource res_snmp uses the configuration file \ref res_snmp.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*!
+ * \page res_snmp.conf res_snmp.conf
+ * \verbinclude res_snmp.conf.sample
+ */
+
 /*** MODULEINFO
        <depend>netsnmp</depend>
        <support_level>extended</support_level>
@@ -94,6 +104,16 @@ static int load_config(void)
        return 1;
 }
 
+/*!
+ * \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(!load_config())
index d065df6..67ab0ba 100644 (file)
@@ -21,6 +21,8 @@
  * \author Tilghman Lesher \verbatim <tlesher AT digium DOT com> \endverbatim
  *
  * \brief kqueue timing interface
+ *
+ * \ingroup resource
  */
 
 /*** MODULEINFO
@@ -360,6 +362,16 @@ AST_TEST_DEFINE(test_kqueue_timing)
 }
 #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)
 {
        if (!(kqueue_timers = ao2_container_alloc(563, kqueue_timer_hash, kqueue_timer_cmp))) {
index 9e9d47c..031d367 100644 (file)
  *
  */
 
+/*! 
+ * \li The resource res_xmpp uses the configuration file \ref xmpp.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*!
+ * \page xmpp.conf xmpp.conf
+ * \verbinclude xmpp.conf.sample
+ */
+
 /*** MODULEINFO
        <depend>iksemel</depend>
        <use type="external">openssl</use>
@@ -4317,6 +4327,16 @@ static int client_buddy_handler(const struct aco_option *opt, struct ast_variabl
        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)
 {
        if (aco_info_init(&cfg_info)) {