Doxygen Updates - Title update
authorAndrew Latham <lathama@gmail.com>
Sun, 14 Oct 2012 21:44:27 +0000 (21:44 +0000)
committerAndrew Latham <lathama@gmail.com>
Sun, 14 Oct 2012 21:44:27 +0000 (21:44 +0000)
Update and extend the configuration_file group and enable linking to the resource.  Update title that was left behind many years ago.

(issue ASTERISK-20259)

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@375003 65c4cc65-6c06-0410-ace0-fbb531ad65f3

17 files changed:
res/Makefile
res/res_calendar.c
res/res_clialiases.c
res/res_config_ldap.c
res/res_config_pgsql.c
res/res_config_sqlite.c
res/res_config_sqlite3.c
res/res_curl.c
res/res_fax.c
res/res_jabber.c
res/res_limit.c
res/res_musiconhold.c
res/res_odbc.c
res/res_phoneprov.c
res/res_smdi.c
res/res_snmp.c
res/res_xmpp.c

index 6a83b6c..3258867 100644 (file)
@@ -1,5 +1,5 @@
 #
-# Asterisk -- A telephony toolkit for Linux.
+# Asterisk -- An open source telephony toolkit.
 # 
 # Makefile for resource modules
 #
index dd2a643..ed441d1 100644 (file)
@@ -23,8 +23,7 @@
  * \todo Support writing attendees
  */
 
-/*!
- * \li The resource res_calendar uses the configuration file \ref calendar.conf
+/*! \li \ref res_calendar.c uses the configuration file \ref calendar.conf
  * \addtogroup configuration_file Configuration Files
  */
 
index 58e0710..d9c4088 100644 (file)
@@ -26,8 +26,7 @@
  * CLI commands.
  */
 
-/*!
- * \li The resource res_clialiases uses the configuration file \ref cli_aliases.conf
+/*! \li \ref res_clialiases.c uses the configuration file \ref cli_aliases.conf
  * \addtogroup configuration_file Configuration Files
  */
 
index b7df2a1..7b5b4f3 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
  * Copyright (C) 2005, Oxymium sarl
  * Manuel Guesdon <mguesdon@oxymium.net> - LDAP RealTime Driver Author/Adaptor
@@ -31,8 +31,7 @@
  * OpenLDAP http://www.openldap.org
  */
 
-/*!
- * \li The resource res_config_ldap uses the configuration file \ref res_ldap.conf
+/*! \li \ref res_config_ldap.c uses the configuration file \ref res_ldap.conf
  * \addtogroup configuration_file Configuration Files
  */
 
@@ -1561,6 +1560,9 @@ static struct ast_config_engine ldap_engine = {
  * 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.
+ *
+ * \todo Don't error or warn on a default install. If the config is
+ * default we should not attempt to connect to a server. -lathama
  */
 static int load_module(void)
 {
index 64b665b..e3b6058 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
  * Copyright (C) 1999-2010, Digium, Inc.
  *
index 835d779..e9ae6cd 100644 (file)
@@ -71,8 +71,7 @@
  * \brief res_config_sqlite module.
  */
 
-/*! 
- * \li The resource res_config_sqlite uses the configuration file \ref res_config_sqlite.conf
+/*! \li \ref res_config_sqlite.c uses the configuration file \ref res_config_sqlite.conf
  * \addtogroup configuration_file Configuration Files
  */
 
index 9482614..4b2d365 100644 (file)
@@ -29,8 +29,7 @@
  * \ingroup resources
  */
 
-/*!
- * \li The resource res_config_sqlite3 uses the configuration file \ref res_config_sqlite3.conf
+/*! \li \ref res_config_sqlite3.c uses the configuration file \ref res_config_sqlite3.conf
  * \addtogroup configuration_file Configuration Files
  */
 
index dede2f1..26dc229 100644 (file)
@@ -26,8 +26,7 @@
  * 
  */
 
-/*!
- * \li The resource res_curl uses the configuration file \ref res_curl.conf
+/*! \li \ref res_curl.c uses the configuration file \ref res_curl.conf
  * \addtogroup configuration_file Configuration Files
  */
 
index dcc3fd4..9cb8292 100644 (file)
@@ -54,8 +54,7 @@
  * \ingroup applications
  */
 
-/*!
- * \li The resource res_fax uses the configuration file \ref res_fax.conf
+/*! \li \ref res_fax.c uses the configuration file \ref res_fax.conf
  * \addtogroup configuration_file Configuration Files
  */
 
index defdfd9..fa6bbfd 100644 (file)
  *
  */
 
+/*! \li \ref res_jabber.c uses the configuration file \ref jabber.conf
+ * \addtogroup configuration_file Configuration Files
+ */
+
+/*! 
+ * \page jabber.conf jabber.conf
+ * \verbinclude jabber.conf.sample
+ */
+
 /*** MODULEINFO
         <defaultenabled>no</defaultenabled>
        <depend>iksemel</depend>
index dc07a4c..e883ff3 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
  * Resource limits
  * 
index 057c413..b71fb9c 100644 (file)
@@ -23,8 +23,7 @@
  * \author Mark Spencer <markster@digium.com>
  */
 
-/*!
- * \li The resource res_musiconhold uses the configuration file \ref musiconhold.conf
+/*! \li \ref res_musiconhold.c uses the configuration file \ref musiconhold.conf
  * \addtogroup configuration_file Configuration Files
  */
 
index 7420700..bdbe8f2 100644 (file)
@@ -30,8 +30,7 @@
  * \arg See also: \ref cdr_odbc
  */
 
-/*! 
- * \li The resource res_odbc uses the configuration file \ref res_odbc.conf
+/*! \li \ref res_odbc.c uses the configuration file \ref res_odbc.conf
  * \addtogroup configuration_file Configuration Files
  */
 
index aa38d60..6c7e383 100644 (file)
@@ -26,8 +26,7 @@
  * \author Terry Wilson <twilson@digium.com>
  */
 
-/*! 
- * \li The resource res_phoneprov uses the configuration file \ref phoneprov.conf
+/*! \li \ref res_phoneprov.c uses the configuration file \ref phoneprov.conf and \ref users.conf and \ref sip.conf
  * \addtogroup configuration_file Configuration Files
  */
 
index 4ae101b..5957e66 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
  * Copyright (C) 2005-2008, Digium, Inc.
  *
@@ -31,8 +31,7 @@
  * polling thread handle it.
  */
 
-/*!
- * \li The resource res_smdi uses the configuration file \ref smdi.conf
+/*! \li \ref res_smdi.c uses the configuration file \ref smdi.conf
  * \addtogroup configuration_file Configuration Files
  */
 
index 60d0070..1bed3ee 100644 (file)
@@ -17,8 +17,7 @@
  *      http://net-snmp.sourceforge.net/
  */
 
-/*!
- * \li The resource res_snmp uses the configuration file \ref res_snmp.conf
+/*! \li \ref res_snmp.c uses the configuration file \ref res_snmp.conf
  * \addtogroup configuration_file Configuration Files
  */
 
index 13c07c2..77369c4 100644 (file)
@@ -31,8 +31,7 @@
  *
  */
 
-/*! 
- * \li The resource res_xmpp uses the configuration file \ref xmpp.conf
+/*! \li \ref res_xmpp.c uses the configuration file \ref xmpp.conf and \ref jabber.conf
  * \addtogroup configuration_file Configuration Files
  */