Doxygen Cleanup
[asterisk/asterisk.git] / channels / chan_iax2.c
index 6309184..961efa7 100644 (file)
  * \todo Implement musicclass settings for IAX2 devices
  */
 
+/*!
+ * \li The channel chan_iax uses the configuration file \ref iax.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page iax.conf iax.conf
+ * \verbinclude iax.conf.sample
+ */
+
 /*** MODULEINFO
        <use type="external">crypto</use>
        <support_level>core</support_level>
@@ -14888,7 +14897,16 @@ static const struct ast_data_entry iax2_data_providers[] = {
        AST_DATA_ENTRY("asterisk/channel/iax2/users", &users_data_provider),
 };
 
-/*! \brief Load IAX2 module, load configuraiton ---*/
+/*!
+ * \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)
 {
        static const char config[] = "iax.conf";