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

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