Doxygen Cleanup

Start adding configuration file linking and pages.  Add module loading doxygen block.

(issue ASTERISK-20259)


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@374164 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Andrew Latham
2012-10-01 23:22:50 +00:00
parent b9eeff1521
commit 14be2a5514
10 changed files with 196 additions and 16 deletions

View File

@@ -30,6 +30,16 @@
* \ingroup applications
*/
/*!
* \li The application app_alarmreceiver uses the configuration file \ref alarmreceiver.conf
* \addtogroup configuration_file Configuration Files
*/
/*!
* \page alarmreceiver.conf alarmreceiver.conf
* \verbinclude alarmreceiver.conf.sample
*/
/*** MODULEINFO
<support_level>extended</support_level>
***/
@@ -724,11 +734,15 @@ static int unload_module(void)
return ast_unregister_application(app);
}
/**
* \brief Register Alarm Receiver App
/*!
* \brief Load the module
*
* \retval 0 success
* \retval -1 failure
* 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)
{