From c7857504df95c83ccd89e2474331e1b8a4d0d66e Mon Sep 17 00:00:00 2001
From: Andrew Latham <lathama@gmail.com>
Date: Sun, 14 Oct 2012 21:44:27 +0000
Subject: [PATCH] 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
---
res/Makefile | 2 +-
res/res_calendar.c | 3 +--
res/res_clialiases.c | 3 +--
res/res_config_ldap.c | 8 +++++---
res/res_config_pgsql.c | 2 +-
res/res_config_sqlite.c | 3 +--
res/res_config_sqlite3.c | 3 +--
res/res_curl.c | 3 +--
res/res_fax.c | 3 +--
res/res_jabber.c | 9 +++++++++
res/res_limit.c | 2 +-
res/res_musiconhold.c | 3 +--
res/res_odbc.c | 3 +--
res/res_phoneprov.c | 3 +--
res/res_smdi.c | 5 ++---
res/res_snmp.c | 3 +--
res/res_xmpp.c | 3 +--
17 files changed, 30 insertions(+), 31 deletions(-)
diff --git a/res/Makefile b/res/Makefile
index 6a83b6ca36..3258867c16 100644
--- 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 dd2a643c55..ed441d10ac 100644
--- 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 58e07100d8..d9c4088bc8 100644
--- 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 b7df2a13b8..7b5b4f34bc 100644
--- 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 64b665b1f2..e3b605812f 100644
--- 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 835d7791c9..e9ae6cd55a 100644
--- 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 9482614bdf..4b2d365989 100644
--- 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 dede2f1a0d..26dc229786 100644
--- 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 dcc3fd4e3a..9cb8292f01 100644
--- 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 defdfd9341..fa6bbfdbf1 100644
--- 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 dc07a4caf8..e883ff3833 100644
--- 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 057c413261..b71fb9c435 100644
--- 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 7420700e1e..bdbe8f2df6 100644
--- 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 aa38d60c02..6c7e3835b8 100644
--- 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 4ae101bd2d..5957e669c3 100644
--- 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 60d0070fb2..1bed3ee6f9 100644
--- 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 13c07c29bf..77369c487a 100644
--- 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
*/
--
GitLab