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_voicemail.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_voicemail.c')
-rw-r--r-- | apps/app_voicemail.c | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/apps/app_voicemail.c b/apps/app_voicemail.c index 5e8b4e86f..673058182 100644 --- a/apps/app_voicemail.c +++ b/apps/app_voicemail.c @@ -28,7 +28,7 @@ * \par See also * \arg \ref Config_vm * \note For information about voicemail IMAP storage, https://wiki.asterisk.org/wiki/display/AST/IMAP+Voicemail+Storage - * \ingroup applications + * \ingroup applications * \todo This module requires res_adsi to load. This needs to be optional * during compilation. * @@ -37,6 +37,16 @@ * with a plan to clean this up. */ +/*! + * \li The application app_voicemail uses configuration file \ref voicemail.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page voicemail.conf voicemail.conf + * \verbinclude voicemail.conf.sample + */ + /*** MODULEINFO <use type="module">res_adsi</use> <use type="module">res_smdi</use> @@ -14277,6 +14287,16 @@ static int unload_module(void) return res; } +/*! + * \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) { int res; |