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

@@ -21,12 +21,18 @@
*
* \author Matthew Fredrickson <creslin@digium.com>
*
* \par See also
* \arg Config_alsa
*
* \ingroup channel_drivers
*/
/*!
* \li The channel chan_alsa uses the configuration file \ref alsa.conf
* \addtogroup configuration_file
*/
/*! \page alsa.conf alsa.conf
* \verbinclude alsa.conf.sample
*/
/*** MODULEINFO
<depend>alsa</depend>
<support_level>extended</support_level>
@@ -925,6 +931,16 @@ static struct ast_cli_entry cli_alsa[] = {
AST_CLI_DEFINE(console_mute, "Disable/Enable mic input"),
};
/*!
* \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)
{
struct ast_config *cfg;