diff options
| author | Andrew Latham <lathama@gmail.com> | 2012-10-01 23:39:45 +0000 |
|---|---|---|
| committer | Andrew Latham <lathama@gmail.com> | 2012-10-01 23:39:45 +0000 |
| commit | 4e228fce0382550136e5c34cb4d9fd400b8d4ad3 (patch) | |
| tree | 22499c040bee4cf7050bacc71c6361e111e3ee4b /addons/app_mysql.c | |
| parent | 99e1174bfabb3579b97ca6ec5309e1dea2041006 (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@374167 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'addons/app_mysql.c')
| -rw-r--r-- | addons/app_mysql.c | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/addons/app_mysql.c b/addons/app_mysql.c index 2e9cae94a..91d300591 100644 --- a/addons/app_mysql.c +++ b/addons/app_mysql.c @@ -23,6 +23,16 @@ * \ingroup applications */ +/*! + * \li The application app_mysql uses the configuration file \ref app_mysql.conf + * \addtogroup configuration_file Configuration Files + */ + +/*! + * \page app_mysql.conf app_mysql.conf + * \verbinclude app_mysql.conf.sample + */ + /*** MODULEINFO <depend>mysqlclient</depend> <defaultenabled>no</defaultenabled> @@ -605,6 +615,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) { struct MYSQLidshead *headp = &_mysql_ids_head; |