diff options
| author | Andrew Latham <lathama@gmail.com> | 2012-10-01 23:24:10 +0000 |
|---|---|---|
| committer | Andrew Latham <lathama@gmail.com> | 2012-10-01 23:24:10 +0000 |
| commit | e11cc293602b6c35ed94722bc52376acf6c38164 (patch) | |
| tree | e07bed81cd6d19b703044202933bbc9dd9cf1915 /res/res_xmpp.c | |
| parent | 14be2a55144d3a6ee73d6df9442b703b00bfc482 (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@374165 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'res/res_xmpp.c')
| -rw-r--r-- | res/res_xmpp.c | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/res/res_xmpp.c b/res/res_xmpp.c index 9e9d47c16..031d367a6 100644 --- a/res/res_xmpp.c +++ b/res/res_xmpp.c @@ -31,6 +31,16 @@ * */ +/*! + * \li The resource res_xmpp uses the configuration file \ref xmpp.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page xmpp.conf xmpp.conf + * \verbinclude xmpp.conf.sample + */ + /*** MODULEINFO <depend>iksemel</depend> <use type="external">openssl</use> @@ -4317,6 +4327,16 @@ static int client_buddy_handler(const struct aco_option *opt, struct ast_variabl 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 int load_module(void) { if (aco_info_init(&cfg_info)) { |