Doxygen Cleanup
[asterisk/asterisk.git] / channels / chan_jingle.c
index dfc2ea9..d5fe3c0 100644 (file)
  * \ingroup channel_drivers
  */
 
+/*!
+ * \li The channel chan_jingle uses the configuration file \ref jingle.conf
+ * \addtogroup configuration_file
+ */
+
+/*! \page jingle.conf jingle.conf
+ * \verbinclude jingle.conf.sample
+ */
+
 /*** MODULEINFO
        <depend>iksemel</depend>
        <depend>res_jabber</depend>
@@ -1936,7 +1945,16 @@ static int jingle_load_config(void)
        return 1;
 }
 
-/*! \brief Load module into PBX, register channel */
+/*!
+ * \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_sockaddr ourip_tmp;