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)


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@374165 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Andrew Latham
2012-10-01 23:24:10 +00:00
parent 14be2a5514
commit e11cc29360
14 changed files with 272 additions and 4 deletions

View File

@@ -26,6 +26,16 @@
* 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))) {