Doxygen Updates - Title update

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

diff --git a/res/Makefile b/res/Makefile
index 6a83b6ca36ba31766c0f5a1ab5debfad3561aa5b..3258867c16f149c17b573266bb1117a2be70e6f9 100644 (file)
--- a/res/Makefile
+++ b/res/Makefile
@@ -1,5 +1,5 @@
 #
-# Asterisk -- A telephony toolkit for Linux.
+# Asterisk -- An open source telephony toolkit.
 # 
 # Makefile for resource modules
 #

diff --git a/res/res_calendar.c b/res/res_calendar.c
index dd2a643c55849213b6ad9951227b386d44bb1f37..ed441d10accb37fcc3d335cbd19db50bf70d112f 100644 (file)
--- a/res/res_calendar.c
+++ b/res/res_calendar.c
@@ -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
  */
 

diff --git a/res/res_clialiases.c b/res/res_clialiases.c
index 58e07100d8a11937e1460f2b6712e9e9615139d4..d9c4088bc8343ea3da8be367c2ca180f09d34ecb 100644 (file)
--- a/res/res_clialiases.c
+++ b/res/res_clialiases.c
@@ -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
  */
 

diff --git a/res/res_config_ldap.c b/res/res_config_ldap.c
index b7df2a13b8f2d71525112ab96b8fb27d7705c505..7b5b4f34bcc11e59b57ec1e173bc1d30faf3a849 100644 (file)
--- a/res/res_config_ldap.c
+++ b/res/res_config_ldap.c
@@ -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)
 {

diff --git a/res/res_config_pgsql.c b/res/res_config_pgsql.c
index 64b665b1f2e6037a0fd3e98a7ffdd3bccd7ffad2..e3b605812ffe4184655fe068f3a9d561525da5c6 100644 (file)
--- a/res/res_config_pgsql.c
+++ b/res/res_config_pgsql.c
@@ -1,5 +1,5 @@
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
  * Copyright (C) 1999-2010, Digium, Inc.
  *

diff --git a/res/res_config_sqlite.c b/res/res_config_sqlite.c
index 835d7791c986a7f93f8de2e0b115e0153a397963..e9ae6cd55a9328490f78a63626dc40a11219768c 100644 (file)
--- a/res/res_config_sqlite.c
+++ b/res/res_config_sqlite.c
@@ -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
  */
 

diff --git a/res/res_config_sqlite3.c b/res/res_config_sqlite3.c
index 9482614bdfd2188642633a6e412b5c585e36ce5d..4b2d36598991d74bcda89692a3235fd2955509c6 100644 (file)
--- a/res/res_config_sqlite3.c
+++ b/res/res_config_sqlite3.c
@@ -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
  */
 

diff --git a/res/res_curl.c b/res/res_curl.c
index dede2f1a0d8878c1549ff53e3ae829e871025519..26dc229786fd1f2af07147922785353b2fa373b4 100644 (file)
--- a/res/res_curl.c
+++ b/res/res_curl.c
@@ -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
  */
 

diff --git a/res/res_fax.c b/res/res_fax.c
index dcc3fd4e3adb90a16cfa20f183aa207735a77a0c..9cb8292f011b3c67a352c5cbc9343285618964dc 100644 (file)
--- a/res/res_fax.c
+++ b/res/res_fax.c
@@ -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
  */
 

diff --git a/res/res_jabber.c b/res/res_jabber.c
index defdfd93414433cd8b982016682d8826dd9e4f7b..fa6bbfdbf14a7e71ab451de724e7ea8c30162aac 100644 (file)
--- a/res/res_jabber.c
+++ b/res/res_jabber.c
@@ -30,6 +30,15 @@
  *
  */
 
+/*! \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>

diff --git a/res/res_limit.c b/res/res_limit.c
index dc07a4caf8d50b204709eefca9ad4244c2c6b367..e883ff383362ecfb91fef9293a66c22e8f412bc9 100644 (file)
--- a/res/res_limit.c
+++ b/res/res_limit.c
@@ -1,5 +1,5 @@
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
  * Resource limits
  * 

diff --git a/res/res_musiconhold.c b/res/res_musiconhold.c
index 057c413261b7dcc6933145f62a9b9a43124047ea..b71fb9c4350210985086ff4c1c00a7cb40e82397 100644 (file)
--- a/res/res_musiconhold.c
+++ b/res/res_musiconhold.c
@@ -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
  */
 

diff --git a/res/res_odbc.c b/res/res_odbc.c
index 7420700e1efae28fa48a1d1ee57c02287ef26950..bdbe8f2df6fc46d2c53ca194be6acfadabf840b1 100644 (file)
--- a/res/res_odbc.c
+++ b/res/res_odbc.c
@@ -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
  */
 

diff --git a/res/res_phoneprov.c b/res/res_phoneprov.c
index aa38d60c02466319dbd1f82cb932ae1b2fa5b527..6c7e3835b8d8837f405c66d58324d3401489ec48 100644 (file)
--- a/res/res_phoneprov.c
+++ b/res/res_phoneprov.c
@@ -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
  */
 

diff --git a/res/res_smdi.c b/res/res_smdi.c
index 4ae101bd2d588c4f1f5b356cc9da4098b69152d4..5957e669c3bddf85235d617367faa1af7327d48e 100644 (file)
--- a/res/res_smdi.c
+++ b/res/res_smdi.c
@@ -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
  */
 

diff --git a/res/res_snmp.c b/res/res_snmp.c
index 60d0070fb2cd1814acd79f8dec6ce5c653014fb8..1bed3ee6f9e65ca5b0cf20eedbccaab04dba5813 100644 (file)
--- a/res/res_snmp.c
+++ b/res/res_snmp.c
@@ -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
  */
 

diff --git a/res/res_xmpp.c b/res/res_xmpp.c
index 13c07c29bf463bd5626d24d333e9d277995230b1..77369c487a6495e5071ad2b19f513b4820ff4207 100644 (file)
--- a/res/res_xmpp.c
+++ b/res/res_xmpp.c
@@ -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
  */