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@374166 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Andrew Latham
2012-10-01 23:24:35 +00:00
parent e11cc29360
commit 99e1174bfa
13 changed files with 256 additions and 21 deletions

View File

@@ -27,6 +27,15 @@
* \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())) {