summaryrefslogtreecommitdiff
path: root/apps/app_festival.c
diff options
context:
space:
mode:
authorAndrew Latham <lathama@gmail.com>2012-10-01 23:22:50 +0000
committerAndrew Latham <lathama@gmail.com>2012-10-01 23:22:50 +0000
commit14be2a55144d3a6ee73d6df9442b703b00bfc482 (patch)
tree04c4d1ee5920a407d0b59250e7adcb8ec8941876 /apps/app_festival.c
parentb9eeff1521cb1c0d479761dfa17cf88d19cd7bf7 (diff)
Doxygen Cleanup
Start adding configuration file linking and pages. Add module loading doxygen block. (issue ASTERISK-20259) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@374164 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps/app_festival.c')
-rw-r--r--apps/app_festival.c20
1 files changed, 20 insertions, 0 deletions
diff --git a/apps/app_festival.c b/apps/app_festival.c
index d875b7acb..c4ad0f6b9 100644
--- a/apps/app_festival.c
+++ b/apps/app_festival.c
@@ -27,6 +27,16 @@
* \ingroup applications
*/
+/*!
+ * \li The application app_festival uses the configuration file \ref festival.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*!
+ * \page festival.conf festival.conf
+ * \verbinclude festival.conf.sample
+ */
+
/*** MODULEINFO
<support_level>extended</support_level>
***/
@@ -537,6 +547,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 ast_flags config_flags = { 0 };