Doxygen Updates Janitor Work

* Whitespace, doc-blocks, spelling, case, missing and incorrect tags.
* Add cleanup to Makefile for the Doxygen configuration update
* Start updating Doxygen configuration for cleaner output
* Enable inclusion of configuration files into documentation
* remove mantisworkflow...
* update documentation README
* Add markup to Tilghman's email and talk with him about updating his email, he knows...
* no code changes on this commit other than the mentioned Makefile change

(issue ASTERISK-20259)


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

7 files changed, 17 insertions, 15 deletions

diff --git a/main/asterisk.c b/main/asterisk.c
index ff3775194..4e3d24e61 100644
--- a/main/asterisk.c
+++ b/main/asterisk.c
@@ -121,7 +121,8 @@ int daemon(int, int);  /* defined in libresolv of all places */
 #endif /* HAVE_CAP */
 #endif /* linux */
 
-#include "asterisk/paths.h"	/* we define here the variables so better agree on the prototype */
+/* we define here the variables so to better agree on the prototype */
+#include "asterisk/paths.h"
 #include "asterisk/network.h"
 #include "asterisk/cli.h"
 #include "asterisk/channel.h"
@@ -411,8 +412,6 @@ const char *ast_file_version_find(const char *file)
 	return NULL;
 }
 
-
-
 struct thread_list_t {
 	AST_RWLIST_ENTRY(thread_list_t) list;
 	char *name;
diff --git a/main/astfd.c b/main/astfd.c
index 79094840d..3caa135d6 100644
--- a/main/astfd.c
+++ b/main/astfd.c
@@ -20,7 +20,7 @@
  *
  * \brief Debugging routines for file descriptor leaks
  *
- * \author Tilghman Lesher <tlesher@digium.com>
+ * \author Tilghman Lesher \verbatim <tlesher@digium.com> \endverbatim
  */
 
 /*** MODULEINFO
diff --git a/main/audiohook.c b/main/audiohook.c
index 0ca727d4e..d46936223 100644
--- a/main/audiohook.c
+++ b/main/audiohook.c
@@ -97,9 +97,11 @@ static int audiohook_set_internal_rate(struct ast_audiohook *audiohook, int rate
 }
 
 /*! \brief Initialize an audiohook structure
+ *
  * \param audiohook Audiohook structure
  * \param type
- * \param init, source, init_flags
+ * \param source, init_flags
+ *
  * \return Returns 0 on success, -1 on failure
  */
 int ast_audiohook_init(struct ast_audiohook *audiohook, enum ast_audiohook_type type, const char *source, enum ast_audiohook_init_flags init_flags)
diff --git a/main/ccss.c b/main/ccss.c
index 2480c7d38..9553321c3 100644
--- a/main/ccss.c
+++ b/main/ccss.c
@@ -565,7 +565,7 @@ static enum ast_device_state cc_state_to_devstate_map[] = {
 };
 
 /*!
- * \intenral
+ * \internal
  * \brief lookup the ast_device_state mapped to cc_state
  *
  * \param state
diff --git a/main/manager.c b/main/manager.c
index bb55544ab..4807dca82 100644
--- a/main/manager.c
+++ b/main/manager.c
@@ -1112,7 +1112,7 @@ struct mansession_session {
 	int authenticated;	/*!< Authentication status */
 	int readperm;		/*!< Authorization for reading */
 	int writeperm;		/*!< Authorization for writing */
-	char inbuf[1025];	/*!< Buffer -  we use the extra byte to add a '\0' and simplify parsing */
+	char inbuf[1025];	/*!< Buffer -  we use the extra byte to add a '\\0' and simplify parsing */
 	int inlen;		/*!< number of buffered bytes */
 	struct ao2_container *whitefilters;	/*!< Manager event filters - white list */
 	struct ao2_container *blackfilters;	/*!< Manager event filters - black list */
diff --git a/main/pbx.c b/main/pbx.c
index d2b2aa16e..6c1fbcdbb 100644
--- a/main/pbx.c
+++ b/main/pbx.c
@@ -8799,7 +8799,7 @@ static const char * const months[] =
 };
 /*! /brief Build timing
  *
- * /param i, info
+ * /param i info
  * /param info_in
  *
  */
diff --git a/main/xmldoc.c b/main/xmldoc.c
index c06b3ba8a..3c01d4300 100644
--- a/main/xmldoc.c
+++ b/main/xmldoc.c
@@ -2014,13 +2014,14 @@ static char *_xmldoc_build_field(struct ast_xml_node *node, const char *var, int
 }
 
 /*!
- *  \brief Get the content of a field (synopsis, description, etc) from an asterisk document tree
- *  \param type Type of element (application, function, ...).
- *  \param name Name of element (Dial, Echo, Playback, ...).
- *  \param var Name of field to return (synopsis, description, etc).
- *  \param raw Field only contains text, no other elements inside it.
- *  \retval NULL On error.
- *  \retval Field text content on success.
+ * \brief Get the content of a field (synopsis, description, etc) from an asterisk document tree
+ * \param type Type of element (application, function, ...).
+ * \param name Name of element (Dial, Echo, Playback, ...).
+ * \param var Name of field to return (synopsis, description, etc).
+ * \param module
+ * \param raw Field only contains text, no other elements inside it.
+ * \retval NULL On error.
+ * \retval Field text content on success.
  */
 static char *xmldoc_build_field(const char *type, const char *name, const char *module, const char *var, int raw)
 {