summaryrefslogtreecommitdiff
path: root/res/res_musiconhold.c
diff options
context:
space:
mode:
Diffstat (limited to 'res/res_musiconhold.c')
-rw-r--r--res/res_musiconhold.c22
1 files changed, 20 insertions, 2 deletions
diff --git a/res/res_musiconhold.c b/res/res_musiconhold.c
index ec990d5d1..3c61b26fe 100644
--- a/res/res_musiconhold.c
+++ b/res/res_musiconhold.c
@@ -19,12 +19,20 @@
/*! \file
*
* \brief Routines implementing music on hold
- *
- * \arg See also \ref Config_moh
*
* \author Mark Spencer <markster@digium.com>
*/
+/*!
+ * \li The resource res_musiconhold uses the configuration file \ref musiconhold.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*!
+ * \page musiconhold.conf musiconhold.conf
+ * \verbinclude musiconhold.conf.sample
+ */
+
/*** MODULEINFO
<conflict>win32</conflict>
<support_level>core</support_level>
@@ -1941,6 +1949,16 @@ static int moh_class_cmp(void *obj, void *arg, int flags)
CMP_MATCH | CMP_STOP;
}
+/*!
+ * \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)
{
int res;