diff options
author | Andrew Latham <lathama@gmail.com> | 2012-10-01 23:22:50 +0000 |
---|---|---|
committer | Andrew Latham <lathama@gmail.com> | 2012-10-01 23:22:50 +0000 |
commit | 14be2a55144d3a6ee73d6df9442b703b00bfc482 (patch) | |
tree | 04c4d1ee5920a407d0b59250e7adcb8ec8941876 /apps/app_amd.c | |
parent | b9eeff1521cb1c0d479761dfa17cf88d19cd7bf7 (diff) |
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
Diffstat (limited to 'apps/app_amd.c')
-rw-r--r-- | apps/app_amd.c | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/apps/app_amd.c b/apps/app_amd.c index 597aac39c..3d6169d08 100644 --- a/apps/app_amd.c +++ b/apps/app_amd.c @@ -24,6 +24,18 @@ * \brief Answering machine detection * * \author Claude Klimos (claude.klimos@aheeva.com) + * + * \ingroup applications + */ + +/*! + * \li The application app_amd uses the configuration file \ref amd.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page amd.conf amd.conf + * \verbinclude amd.conf.sample */ /*** MODULEINFO @@ -487,6 +499,16 @@ static int unload_module(void) return ast_unregister_application(app); } +/*! + * \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 (load_config(0)) |