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

6 files changed, 63 insertions, 63 deletions

diff --git a/include/asterisk/doxygen/architecture.h b/include/asterisk/doxygen/architecture.h
index c157697ee..d507044ee 100644
--- a/include/asterisk/doxygen/architecture.h
+++ b/include/asterisk/doxygen/architecture.h
@@ -26,7 +26,7 @@
 \author Russell Bryant <russell@digium.com>
 \AsteriskTrunkWarning
 
-<hr/>
+<hr>
 
 \section ArchTOC Table of Contents
 
@@ -64,7 +64,7 @@
     -# \ref ArchThreadDebugging
     -# \ref ArchMemoryDebugging
 
-<hr/>
+<hr>
 
 \section ArchIntro Introduction
 
@@ -295,7 +295,7 @@ many events to one call.  The CEL modules look very similar to CDR modules.
 
 CEL modules typically live in the <code>cel/</code> directory in the source tree.
 
-For a list of CEL handlers, see \ref cel_drivers.
+For a list of CEL handlers, see cel_drivers.
 
 For additional information about the CEL API, see
 <code>include/asterisk/cel.h</code>.
@@ -407,7 +407,7 @@ When an inbound channel executes an application such as <code>Dial()</code>, an
 outbound channel is created and bridged to the inbound channel once it answers.
 
 Dialplan applications always execute in the context of a channel thread.  Dialplan
-functions \i almost always do, as well.  However, it is possible to read and write
+functions almost always do, as well.  However, it is possible to read and write
 dialplan functions from an asynchronous interface such as the Asterisk CLI or the
 manager interface (AMI).  However, it is still always the channel thread that is
 the owner of the ast_channel data structure.
@@ -710,7 +710,7 @@ The implementation of this memory debugging system can be found in
 <code>main/astmm.c</code>.
 
 
-<hr/>
+<hr>
 Return to the \ref ArchTOC
  */
 
diff --git a/include/asterisk/doxygen/asterisk-git-howto.h b/include/asterisk/doxygen/asterisk-git-howto.h
index ee35b76f3..3a13792c9 100644
--- a/include/asterisk/doxygen/asterisk-git-howto.h
+++ b/include/asterisk/doxygen/asterisk-git-howto.h
@@ -23,7 +23,7 @@
  *
  * \AsteriskTrunkWarning
  *
- * <hr/>
+ * <hr>
  *
  * \section Introduction Introduction
  * This document will instruct you how to setup a local git mirror of the 
@@ -32,7 +32,7 @@
  * Why would you want that? for starters, it's a fast repository browser
  * and works well even when offline. More on why and why not at 'Pros and Cons'
  * in the end of this document. 
- * <hr/>
+ * <hr>
  *
  * \section Setup Setup
  *
@@ -120,7 +120,7 @@
   echo 'exclude res_snmp' >build_tools/conf
  \endverbatim
  *
- * <hr/>
+ * <hr>
  *
  * \section Update Update
  * The main Asterisk repository tends to get new commits occasionally. I
@@ -133,7 +133,7 @@
  \endverbatim
  *
  * Next, get all updates.
- * <hr/>
+ * <hr>
  *
  * \section Usage Usage
  *
@@ -183,7 +183,7 @@
   git svn rebase --fetch-all
  \endverbatim
  *
- * <hr/>
+ * <hr>
  *
  * \section ProsAndCons Pros and Cons
  *
@@ -233,5 +233,5 @@
  *  to test that. Even if it will, it will require an extra step of manual
  *  editing.
  *
- * <hr/>
+ * <hr>
  */
diff --git a/include/asterisk/doxygen/commits.h b/include/asterisk/doxygen/commits.h
index 33df679d2..7f39c6e8e 100644
--- a/include/asterisk/doxygen/commits.h
+++ b/include/asterisk/doxygen/commits.h
@@ -23,23 +23,23 @@
  *
  * \AsteriskTrunkWarning
  *
- * <hr/>
+ * <hr>
  *
  * \section CommitMsgFormatting Commit Message Formatting
  *
  * The following illustrates the basic outline for commit messages:
  *
-  \verbatim
-  <One-liner summary of changes>
-
-  <Empty Line> 
-
-  <Verbose description of the changes>
-
-  <Empty Line> 
-
-  <Special Tags>
-  \endverbatim
+ * \verbatim
+ * <One-liner summary of changes>
+ *
+ * <Empty Line> 
+ *
+ * <Verbose description of the changes>
+ *
+ * <Empty Line> 
+ *
+ * <Special Tags>
+ * \endverbatim
  *
  * Some commit history viewers treat the first line of commit messages as the
  * summary for the commit.  So, an effort should be made to format our commit
@@ -52,7 +52,7 @@
  * \note For trivial commits, such as "fix the build", or "fix spelling mistake",
  *       the verbose description may not be necessary.
  *
- * <hr/>
+ * <hr>
  *
  * \section CommitMsgTags Special Tags for Commit Messages
  *
@@ -77,12 +77,12 @@
  *
  * Here is an example of what the template will generate for you:
  *
-  \verbatim
-  (closes issue #1234)
-  Reported by: SomeGuy
-  Patches:
-       fix_bug_1234.diff uploaded by SomeDeveloper (license 5678)
-  \endverbatim
+ * \verbatim
+ * (closes issue #1234)
+ * Reported by: SomeGuy
+ * Patches:
+ *      fix_bug_1234.diff uploaded by SomeDeveloper (license 5678)
+ * \endverbatim
  *
  * If the patch being committed was written by the person doing the commit,
  * and is not available to reference as an upload to the issue, there is no
@@ -97,7 +97,7 @@
  *
  * \note The trailing slash in the review URL is required.
  *
- * <hr/>
+ * <hr>
  *
  * \section CommitMsgSvnmerge Commit Messages with svnmerge
  *
diff --git a/include/asterisk/doxygen/mantisworkflow.h b/include/asterisk/doxygen/mantisworkflow.h
index 3e1755710..cb5f341bf 100644
--- a/include/asterisk/doxygen/mantisworkflow.h
+++ b/include/asterisk/doxygen/mantisworkflow.h
@@ -23,7 +23,7 @@
  *
  * \AsteriskTrunkWarning
  *
- * <hr/>
+ * <hr>
  * \section WorkflowDescription Description of the Issue Tracker Workflow
  * 
  * (This document is most beneficial for Asterisk bug marshals, however it is good
diff --git a/include/asterisk/doxygen/releases.h b/include/asterisk/doxygen/releases.h
index c895d1c3c..7e53f3769 100644
--- a/include/asterisk/doxygen/releases.h
+++ b/include/asterisk/doxygen/releases.h
@@ -133,7 +133,7 @@
  *
  * \arg \ref ReleaseStatus
  *
- * <hr/>
+ * <hr>
  *
  * \section commitmonitoring Commit Monitoring
  *
@@ -141,7 +141,7 @@
  * <a href="http://lists.digium.com/">http://lists.digium.com</a>.  The Digium
  * mailing list server hosts a %number of mailing lists for commits.
  *
- * <hr/>
+ * <hr>
  *
  * \section ast10policy Asterisk 1.0
  *
@@ -154,7 +154,7 @@
  *
  * No commits should be made to the Asterisk 1.0 branch.
  * 
- * <hr/>
+ * <hr>
  *
  * \section ast12policy Asterisk 1.2
  *
@@ -181,7 +181,7 @@
  *  - 1.2.X.Y - a release that contains fixes to the security patches released in
  *    version 1.2.X
  *
- * <hr/>
+ * <hr>
  *
  * \section ast14policy Asterisk 1.4
  *
@@ -208,7 +208,7 @@
  *  - 1.4.X.Y - a release that contains very few changes on top of 1.4.X.  This
  *    may be for a security patch, or for a regression introduced in 1.4.X.
  *
- * <hr/>
+ * <hr>
  *
  * \section ast16policy Asterisk 1.6
  *
@@ -244,7 +244,7 @@
  *  - 1.6.X.Y - a release that contains fixes for bugs or security issues identified
  *    in the 1.6.X release series.
  *
- * <hr/>
+ * <hr>
  *
  * \section asttrunk Asterisk Trunk
  *
@@ -269,7 +269,7 @@
  * tested and reviewed such that there is reasonable belief that the code
  * is ready to go.
  *
- * <hr/>
+ * <hr>
  *
  * \section astteam Asterisk Team Branches
  *
diff --git a/include/asterisk/doxygen/reviewboard.h b/include/asterisk/doxygen/reviewboard.h
index b86445416..0b05b01dd 100644
--- a/include/asterisk/doxygen/reviewboard.h
+++ b/include/asterisk/doxygen/reviewboard.h
@@ -23,7 +23,7 @@
  *
  * \AsteriskTrunkWarning
  *
- * <hr/>
+ * <hr>
  *
  * \section ReviewboardGuidelines Usage Guidelines
  *
@@ -52,7 +52,7 @@
  * testing and should not have blatant coding guidelines violations.  Lack of
  * these things is careless and shows disrespect for those reviewing your code.
  *
- * <hr/>
+ * <hr>
  *
  * \section ReviewboardPosting Posting Code to Reviewboard
  *
@@ -61,25 +61,25 @@
  * The easiest way to post a patch to reviewboard is by using the
  * post-review tool.  We have post-review in our repotools svn repository.
  *
-   \verbatim
-   $ svn co http://svn.digium.com/svn/repotools
-   \endverbatim
+ * \verbatim
+ * $ svn co http://svn.digium.com/svn/repotools
+ * \endverbatim
  *
  * Essentially, post-review is a script that will take the output of "svn
  * diff" and create a review request out of it for you.  So, once you have
  * a working copy with the changes you expect in the output of "svn diff",
  * you just run the following command:
  *
-   \verbatim
-   $ post-review
-   \endverbatim
+ * \verbatim
+ * $ post-review
+ * \endverbatim
  * 
  * If it complains about not knowing which reviewboard server to use, add
  * the server option:
  * 
-   \verbatim
-   $ post-review --server=https://reviewboard.asterisk.org
-   \endverbatim
+ * \verbatim
+ * $ post-review --server=https://reviewboard.asterisk.org
+ * \endverbatim
  *
  * \subsection postreviewnewfiles Dealing with New Files
  * 
@@ -90,15 +90,15 @@
  * 
  * You would start by getting your changes applied to a trunk working copy:
  * 
-   \verbatim
-   $ cd .../trunk
-   \endverbatim
+ * \verbatim
+ * $ cd .../trunk
+ * \endverbatim
  * 
  * Then, apply the changes from your branch:
  * 
-   \verbatim
-   $ svn merge .../trunk .../team/group/my_new_code
-   \endverbatim
+ * \verbatim
+ * $ svn merge .../trunk .../team/group/my_new_code
+ * \endverbatim
  * 
  * Now, the code is merged into your working copy.  However, for a new
  * file, subversion treats it as a copy of existing content and not new
@@ -106,10 +106,10 @@
  * it to show up in the diff, use the following commands so svn treats it
  * as new content and publishes it in the diff:
  * 
-   \verbatim
-   $ svn revert my_new_file.c
-   $ svn add my_new_file.c
-   \endverbatim
+ * \verbatim
+ * $ svn revert my_new_file.c
+ * $ svn add my_new_file.c
+ * \endverbatim
  * 
  * Now, it should work, and you can run "post-review" as usual.
  *
@@ -121,7 +121,7 @@
  * Apply the current version of the diff to a working copy as described above,
  * and then run the following command:
  * 
-   \verbatim
-   $ post-review -r <review request number>
-   \endverbatim
+ * \verbatim
+ * $ post-review -r <review request number>
+ * \endverbatim
  */