[asterisk-commits] lathama: trunk r374165 - /trunk/res/
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Mon Oct 1 18:24:16 CDT 2012
Author: lathama
Date: Mon Oct 1 18:24:10 2012
New Revision: 374165
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=374165
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/res/res_calendar.c
trunk/res/res_clialiases.c
trunk/res/res_config_ldap.c
trunk/res/res_config_sqlite.c
trunk/res/res_config_sqlite3.c
trunk/res/res_curl.c
trunk/res/res_fax.c
trunk/res/res_musiconhold.c
trunk/res/res_odbc.c
trunk/res/res_phoneprov.c
trunk/res/res_smdi.c
trunk/res/res_snmp.c
trunk/res/res_timing_kqueue.c
trunk/res/res_xmpp.c
Modified: trunk/res/res_calendar.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_calendar.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_calendar.c (original)
+++ trunk/res/res_calendar.c Mon Oct 1 18:24:10 2012
@@ -21,6 +21,16 @@
*
* \todo Support responding to a meeting invite
* \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
@@ -1830,6 +1840,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)
{
if (!(calendars = ao2_container_alloc(CALENDAR_BUCKETS, calendar_hash_fn, calendar_cmp_fn))) {
Modified: trunk/res/res_clialiases.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_clialiases.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_clialiases.c (original)
+++ trunk/res/res_clialiases.c Mon Oct 1 18:24:10 2012
@@ -24,6 +24,16 @@
*
* This module provides the capability to create aliases to other
* 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
@@ -238,7 +248,16 @@
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))) {
Modified: trunk/res/res_config_ldap.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_config_ldap.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_config_ldap.c (original)
+++ trunk/res/res_config_ldap.c Mon Oct 1 18:24:10 2012
@@ -29,6 +29,16 @@
* \author Russell Bryant <russell at digium.com>
*
* 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
@@ -1542,6 +1552,16 @@
.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) {
Modified: trunk/res/res_config_sqlite.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_config_sqlite.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_config_sqlite.c (original)
+++ trunk/res/res_config_sqlite.c Mon Oct 1 18:24:10 2012
@@ -69,6 +69,16 @@
/*!
* \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
@@ -1758,6 +1768,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)
{
char *errormsg = NULL;
Modified: trunk/res/res_config_sqlite3.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_config_sqlite3.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_config_sqlite3.c (original)
+++ trunk/res/res_config_sqlite3.c Mon Oct 1 18:24:10 2012
@@ -27,6 +27,16 @@
*
* This is a realtime configuration engine for the SQLite 3 Database
* \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
@@ -1162,6 +1172,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)
{
if (!((databases = ao2_container_alloc(DB_BUCKETS, db_hash_fn, db_cmp_fn)))) {
Modified: trunk/res/res_curl.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_curl.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_curl.c (original)
+++ trunk/res/res_curl.c Mon Oct 1 18:24:10 2012
@@ -24,6 +24,16 @@
*
* Depends on the CURL library - http://curl.haxx.se/
*
+ */
+
+/*!
+ * \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
@@ -65,6 +75,16 @@
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;
Modified: trunk/res/res_fax.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_fax.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_fax.c (original)
+++ trunk/res/res_fax.c Mon Oct 1 18:24:10 2012
@@ -52,6 +52,16 @@
* This module requires FAX technology modules, like res_fax_spandsp, to register with it
* so it can use the technology modules to perform the actual FAX transmissions.
* \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"
@@ -4104,7 +4114,16 @@
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;
Modified: trunk/res/res_musiconhold.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_musiconhold.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_musiconhold.c (original)
+++ trunk/res/res_musiconhold.c Mon Oct 1 18:24:10 2012
@@ -19,10 +19,18 @@
/*! \file
*
* \brief Routines implementing music on hold
- *
- * \arg See also \ref Config_moh
*
* \author Mark Spencer <markster at 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
@@ -1941,6 +1949,16 @@
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;
Modified: trunk/res/res_odbc.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_odbc.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_odbc.c (original)
+++ trunk/res/res_odbc.c Mon Oct 1 18:24:10 2012
@@ -28,6 +28,16 @@
* \author Tilghman Lesher <tilghman at digium.com>
*
* \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
@@ -1875,6 +1885,16 @@
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)))
Modified: trunk/res/res_phoneprov.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_phoneprov.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_phoneprov.c (original)
+++ trunk/res/res_phoneprov.c Mon Oct 1 18:24:10 2012
@@ -24,6 +24,16 @@
*
* \author Matthew Brooks <mbrooks at digium.com>
* \author Terry Wilson <twilson at 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
@@ -1270,6 +1280,16 @@
.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);
Modified: trunk/res/res_smdi.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_smdi.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_smdi.c (original)
+++ trunk/res/res_smdi.c Mon Oct 1 18:24:10 2012
@@ -29,6 +29,16 @@
* \todo This module currently has its own mailbox monitoring thread. This should
* be converted to MWI subscriptions and just let the optional global voicemail
* 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
@@ -1396,6 +1406,16 @@
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;
Modified: trunk/res/res_snmp.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_snmp.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_snmp.c (original)
+++ trunk/res/res_snmp.c Mon Oct 1 18:24:10 2012
@@ -15,6 +15,16 @@
*
* Uses the Net-SNMP libraries available at
* 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
@@ -94,6 +104,16 @@
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())
Modified: trunk/res/res_timing_kqueue.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_timing_kqueue.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_timing_kqueue.c (original)
+++ trunk/res/res_timing_kqueue.c Mon Oct 1 18:24:10 2012
@@ -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 @@
}
#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))) {
Modified: trunk/res/res_xmpp.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_xmpp.c?view=diff&rev=374165&r1=374164&r2=374165
==============================================================================
--- trunk/res/res_xmpp.c (original)
+++ trunk/res/res_xmpp.c Mon Oct 1 18:24:10 2012
@@ -29,6 +29,16 @@
*
* This module is based upon the original res_jabber as done by Matt O'Gorman.
*
+ */
+
+/*!
+ * \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
@@ -4317,6 +4327,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)
{
if (aco_info_init(&cfg_info)) {
More information about the asterisk-commits
mailing list