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_iax2.c | |
| 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_iax2.c')
| -rw-r--r-- | channels/chan_iax2.c | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/channels/chan_iax2.c b/channels/chan_iax2.c index 630918480..961efa7df 100644 --- a/channels/chan_iax2.c +++ b/channels/chan_iax2.c @@ -31,6 +31,15 @@ * \todo Implement musicclass settings for IAX2 devices */ +/*! + * \li The channel chan_iax uses the configuration file \ref iax.conf + * \addtogroup configuration_file + */ + +/*! \page iax.conf iax.conf + * \verbinclude iax.conf.sample + */ + /*** MODULEINFO <use type="external">crypto</use> <support_level>core</support_level> @@ -14888,7 +14897,16 @@ static const struct ast_data_entry iax2_data_providers[] = { AST_DATA_ENTRY("asterisk/channel/iax2/users", &users_data_provider), }; -/*! \brief Load IAX2 module, load configuraiton ---*/ +/*! + * \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) { static const char config[] = "iax.conf"; |