Doxygen Updates - janitor work

Doxygen updates including mistakes, misspellings, missing parameters, updates for Doxygen style.  Some missing txt file links are removed but their content or essense will be included in some later updates.  A majority of the txt files were removed in the 1.6 era but never noted. The HR and EXTREF are simple changes that make the documentation more compatable with more versions of Doxygen.

Further updates coming.

(issue ASTERISK-20259)


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

9 files changed, 23 insertions, 13 deletions

diff --git a/res/res_config_curl.c b/res/res_config_curl.c
index 43fe888ed..7d8e79aab 100644
--- a/res/res_config_curl.c
+++ b/res/res_config_curl.c
@@ -22,7 +22,7 @@
  *
  * \author Tilghman Lesher <res_config_curl_v1@the-tilghman.com>
  *
- * \extref Depends on the CURL library  - http://curl.haxx.se/
+ * Depends on the CURL library - http://curl.haxx.se/
  * 
  */
 
diff --git a/res/res_config_ldap.c b/res/res_config_ldap.c
index 159d2ab80..0818c494b 100644
--- a/res/res_config_ldap.c
+++ b/res/res_config_ldap.c
@@ -28,7 +28,7 @@
  * \author Carl-Einar Thorner <cthorner@voicerd.com>
  * \author Russell Bryant <russell@digium.com>
  *
- * \extref OpenLDAP http://www.openldap.org
+ * OpenLDAP http://www.openldap.org
  */
 
 /*** MODULEINFO
diff --git a/res/res_config_pgsql.c b/res/res_config_pgsql.c
index bafa27197..e2268fbfd 100644
--- a/res/res_config_pgsql.c
+++ b/res/res_config_pgsql.c
@@ -19,7 +19,7 @@
  * \author Mark Spencer <markster@digium.com>
  * \author Manuel Guesdon <mguesdon@oxymium.net> - PostgreSQL RealTime Driver Author/Adaptor
  *
- * \extref PostgreSQL http://www.postgresql.org
+ * PostgreSQL http://www.postgresql.org
  */
 
 /*** MODULEINFO
diff --git a/res/res_crypto.c b/res/res_crypto.c
index 7c38e3d28..30c51194a 100644
--- a/res/res_crypto.c
+++ b/res/res_crypto.c
@@ -22,7 +22,7 @@
  *
  * \author Mark Spencer <markster@digium.com>
  *
- * \extref Uses the OpenSSL library, available at
+ * Uses the OpenSSL library, available at
  *	http://www.openssl.org/
  */
 
diff --git a/res/res_curl.c b/res/res_curl.c
index 663ecd17d..9008f2add 100644
--- a/res/res_curl.c
+++ b/res/res_curl.c
@@ -22,7 +22,7 @@
  *
  * \author Tilghman Lesher <res_curl_v1@the-tilghman.com>
  *
- * \extref Depends on the CURL library  - http://curl.haxx.se/
+ * Depends on the CURL library  - http://curl.haxx.se/
  * 
  */
 
diff --git a/res/res_jabber.c b/res/res_jabber.c
index fde8a452b..34895969b 100644
--- a/res/res_jabber.c
+++ b/res/res_jabber.c
@@ -23,7 +23,7 @@
  * References:
  * - http://www.xmpp.org - The XMPP standards foundation
  *
- * \extref Iksemel http://code.google.com/p/iksemel/
+ * Iksemel http://code.google.com/p/iksemel/
  *
  * \todo If you unload this module, chan_gtalk/jingle will be dead. How do we handle that?
  * \todo Dialplan applications need RETURN variable, like JABBERSENDSTATUS
@@ -3304,6 +3304,7 @@ static void aji_init_event_distribution(struct aji_client *client)
 /*!
  * \brief Callback for handling PubSub events
  * \param data void pointer to aji_client structure
+ * \param pak A pak
  * \return IKS_FILTER_EAT
  */
 static int aji_handle_pubsub_event(void *data, ikspak *pak)
@@ -3476,8 +3477,10 @@ static void aji_publish_device_state(struct aji_client *client, const char *devi
 /*!
  * \brief Publish MWI to a PubSub node
  * \param client the configured XMPP client we use to connect to a XMPP server
- * \param device the name of the device whose state to publish
- * \param device_state the state to publish
+ * \param mailbox The mailbox
+ * \param context The context
+ * \param oldmsgs Old messages
+ * \param newmsgs New messages
  * \return void
  */
 static void aji_publish_mwi(struct aji_client *client, const char *mailbox,
@@ -3833,6 +3836,7 @@ static void aji_create_pubsub_collection(struct aji_client *client, const char
 /*!
  * \brief Create a PubSub leaf node.
  * \param client the configured XMPP client we use to connect to a XMPP server
+ * \param collection_name The name to use for this collection
  * \param leaf_name The name to use for this collection
  * \return void.
  */
@@ -3847,6 +3851,7 @@ const char *leaf_name)
  * \param client the configured XMPP client we use to connect to a XMPP server
  * \param node_type the type of node to create
  * \param name the name of the node to create
+ * \param collection_name The name to use for this collection
  * \return iks*
  */
 static iks* aji_create_pubsub_node(struct aji_client *client, const char *node_type, const
diff --git a/res/res_smdi.c b/res/res_smdi.c
index cc49b98e9..354743ccd 100644
--- a/res/res_smdi.c
+++ b/res/res_smdi.c
@@ -24,7 +24,7 @@
  * \author Russell Bryant <russell@digium.com>
  *
  * Here is a useful mailing list post that describes SMDI protocol details:
- * \ref http://lists.digium.com/pipermail/asterisk-dev/2003-June/000884.html
+ * http://lists.digium.com/pipermail/asterisk-dev/2003-June/000884.html
  *
  * \todo This module currently has its own mailbox monitoring thread.  This should
  * be converted to MWI subscriptions and just let the optional global voicemail
diff --git a/res/res_snmp.c b/res/res_snmp.c
index f717cead0..4368d84cc 100644
--- a/res/res_snmp.c
+++ b/res/res_snmp.c
@@ -13,7 +13,7 @@
  *
  * \author Thorsten Lockert <tholo@voop.as>
  *
- * \extref Uses the Net-SNMP libraries available at
+ * Uses the Net-SNMP libraries available at
  *	 http://net-snmp.sourceforge.net/
  */
 
diff --git a/res/res_xmpp.c b/res/res_xmpp.c
index ce5c9ea53..ed4c95618 100644
--- a/res/res_xmpp.c
+++ b/res/res_xmpp.c
@@ -22,7 +22,7 @@
  *
  * \author Joshua Colp <jcolp@digium.com>
  *
- * \extref Iksemel http://code.google.com/p/iksemel/
+ * Iksemel http://code.google.com/p/iksemel/
  *
  * A reference module for interfacting Asterisk directly as a client or component with
  * an XMPP/Jabber compliant server.
@@ -1017,6 +1017,7 @@ static void xmpp_pubsub_create_affiliations(struct ast_xmpp_client *client, cons
  * \param client the configured XMPP client we use to connect to a XMPP server
  * \param node_type the type of node to create
  * \param name the name of the node to create
+ * \param collection_name
  * \return void
  */
 static void xmpp_pubsub_create_node(struct ast_xmpp_client *client, const char *node_type, const
@@ -1078,6 +1079,7 @@ static void xmpp_pubsub_create_collection(struct ast_xmpp_client *client, const
 /*!
  * \brief Create a PubSub leaf node.
  * \param client the configured XMPP client we use to connect to a XMPP server
+ * \param collection_name
  * \param leaf_name The name to use for this collection
  * \return void.
  */
@@ -1090,8 +1092,10 @@ static void xmpp_pubsub_create_leaf(struct ast_xmpp_client *client, const char *
 /*!
  * \brief Publish MWI to a PubSub node
  * \param client the configured XMPP client we use to connect to a XMPP server
- * \param device the name of the device whose state to publish
- * \param device_state the state to publish
+ * \param mailbox The Mailbox
+ * \param context The Context
+ * \param oldmsgs Old messages
+ * \param newmsgs New Messages
  * \return void
  */
 static void xmpp_pubsub_publish_mwi(struct ast_xmpp_client *client, const char *mailbox,
@@ -1278,6 +1282,7 @@ static void xmpp_pubsub_subscribe(struct ast_xmpp_client *client, const char *no
 /*!
  * \brief Callback for handling PubSub events
  * \param data void pointer to ast_xmpp_client structure
+ * \param pak A pak
  * \return IKS_FILTER_EAT
  */
 static int xmpp_pubsub_handle_event(void *data, ikspak *pak)