Doxygen Cleanup
[asterisk/asterisk.git] / addons / app_mysql.c
index 2e9cae9..91d3005 100644 (file)
  * \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;