diff options
| author | Andrew Latham <lathama@gmail.com> | 2012-10-01 23:24:35 +0000 |
|---|---|---|
| committer | Andrew Latham <lathama@gmail.com> | 2012-10-01 23:24:35 +0000 |
| commit | 99e1174bfabb3579b97ca6ec5309e1dea2041006 (patch) | |
| tree | c543904347a18434ed79e900362d042ed01049d7 /channels/chan_vpb.cc | |
| parent | e11cc293602b6c35ed94722bc52376acf6c38164 (diff) | |
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
Diffstat (limited to 'channels/chan_vpb.cc')
| -rw-r--r-- | channels/chan_vpb.cc | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/channels/chan_vpb.cc b/channels/chan_vpb.cc index 378c44773..d4d08c097 100644 --- a/channels/chan_vpb.cc +++ b/channels/chan_vpb.cc @@ -29,6 +29,15 @@ * \ingroup channel_drivers */ +/*! + * \li The channel chan_vpb uses the configuration file \ref vpb.conf + * \addtogroup configuration_file + */ + +/*! \page vpb.conf vpb.conf + * \verbinclude vpb.conf.sample + */ + /*** MODULEINFO <depend>vpb</depend> <defaultenabled>no</defaultenabled> @@ -2648,6 +2657,16 @@ static int unload_module(void) return 0; } +/*! + * \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 enum ast_module_load_result load_module() { struct ast_config *cfg; |