uhd: doc: Fix Doxygen warnings on 1.8.13

1 files changed, 77 insertions, 22 deletions

diff --git a/host/docs/Doxyfile.in b/host/docs/Doxyfile.in
index de08c1d08..963e10ddc 100644
--- a/host/docs/Doxyfile.in
+++ b/host/docs/Doxyfile.in
@@ -98,8 +98,13 @@ OUTPUT_LANGUAGE        = English
 # information to generate all generated output in the proper direction.
 # Possible values are: None, LTR, RTL and Context.
 # The default value is: None.
-
-OUTPUT_TEXT_DIRECTION  = None
+# 
+# NOTE: This tag is unsupported in Doxygen 1.8.13 and generates a warning
+# while building the documentation using that version. Because the value is 
+# not being set to a non-default value, it is commented out but left in
+# place for documentary purposes.
+#
+# OUTPUT_TEXT_DIRECTION  = None
 
 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
 # descriptions after the members that are listed in the file and class
@@ -195,8 +200,13 @@ JAVADOC_AUTOBRIEF      = NO
 # Javadoc-style will behave just like regular comments and it will not be
 # interpreted by doxygen.
 # The default value is: NO.
-
-JAVADOC_BANNER         = NO
+#
+# NOTE: This tag is unsupported in Doxygen 1.8.13 and generates a warning
+# while building the documentation using that version. Because the value is 
+# not being set to a non-default value, it is commented out but left in
+# place for documentary purposes.
+#
+# JAVADOC_BANNER         = NO
 
 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
 # line (until the first dot) of a Qt-style comment as the brief description. If
@@ -293,8 +303,13 @@ OPTIMIZE_OUTPUT_VHDL   = NO
 # language. For instance, namespaces will be presented as modules, types will be
 # separated into more groups, etc.
 # The default value is: NO.
-
-OPTIMIZE_OUTPUT_SLICE  = NO
+#
+# NOTE: This tag is unsupported in Doxygen 1.8.13 and generates a warning
+# while building the documentation using that version. Because the value is 
+# not being set to a non-default value, it is commented out but left in
+# place for documentary purposes.
+#
+# OPTIMIZE_OUTPUT_SLICE  = NO
 
 # Doxygen selects the parser to use depending on the extension of the files it
 # parses. With this tag you can assign which parser to use for a given
@@ -332,8 +347,13 @@ MARKDOWN_SUPPORT       = YES
 # Note: This feature currently applies only to Markdown headings.
 # Minimum value: 0, maximum value: 99, default value: 5.
 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
-
-TOC_INCLUDE_HEADINGS   = 5
+#
+# NOTE: with Doxygen 1.8.13 installed, setting TOC_INCLUDE_HEADINGS, even
+# to its default value of 5, will cause the generation of a TON of Doxygen
+# warnings when building the UHD documentation. The setting is commented
+# out to prevent the issue, but left in place for documentary purposes.
+#
+# TOC_INCLUDE_HEADINGS   = 5
 
 # When enabled doxygen tries to link words that correspond to documented
 # classes, or namespaces to their corresponding documentation. Such a link can
@@ -469,8 +489,13 @@ EXTRACT_PRIVATE        = NO
 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
 # methods of a class will be included in the documentation.
 # The default value is: NO.
-
-EXTRACT_PRIV_VIRTUAL   = NO
+#
+# NOTE: This tag is unsupported in Doxygen 1.8.13 and generates a warning
+# while building the documentation using that version. Because the value is 
+# not being set to a non-default value, it is commented out but left in
+# place for documentary purposes.
+#
+# EXTRACT_PRIV_VIRTUAL   = NO
 
 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
 # scope will be included in the documentation.
@@ -1093,8 +1118,13 @@ CLANG_OPTIONS          =
 # such as clang-check. These options will then be passed to the parser.
 # Note: The availability of this option depends on whether or not doxygen was
 # generated with the -Duse_libclang=ON option for CMake.
-
-CLANG_DATABASE_PATH    =
+#
+# NOTE: This tag is unsupported in Doxygen 1.8.13 and generates a warning
+# while building the documentation using that version. Because the value is 
+# not being set to a non-default value, it is commented out but left in
+# place for documentary purposes.
+#
+# CLANG_DATABASE_PATH    =
 
 #---------------------------------------------------------------------------
 # Configuration options related to the alphabetical class index
@@ -1258,8 +1288,13 @@ HTML_TIMESTAMP         = NO
 # like the Qt help browser.
 # The default value is: YES.
 # This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_DYNAMIC_MENUS     = YES
+#
+# NOTE: This tag is unsupported in Doxygen 1.8.13 and generates a warning
+# while building the documentation using that version. Because the value is 
+# not being set to a non-default value, it is commented out but left in
+# place for documentary purposes.
+#
+# HTML_DYNAMIC_MENUS     = YES
 
 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
 # documentation will contain sections that can be hidden and shown after the
@@ -1545,8 +1580,13 @@ FORMULA_TRANSPARENT    = YES
 # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
 # to create new LaTeX commands to be used in formulas as building blocks. See
 # the section "Including formulas" for details.
-
-FORMULA_MACROFILE      =
+#
+# NOTE: This tag is unsupported in Doxygen 1.8.13 and generates a warning
+# while building the documentation using that version. Because the value is 
+# not being set to a non-default value, it is commented out but left in
+# place for documentary purposes.
+#
+# FORMULA_MACROFILE      =
 
 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
 # https://www.mathjax.org) which uses client side JavaScript for the rendering
@@ -1729,8 +1769,13 @@ MAKEINDEX_CMD_NAME     = makeindex
 # See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
 # The default value is: makeindex.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_MAKEINDEX_CMD    = makeindex
+#
+# NOTE: This tag is unsupported in Doxygen 1.8.13 and generates a warning
+# while building the documentation using that version. Because the value is 
+# not being set to a non-default value, it is commented out but left in
+# place for documentary purposes.
+#
+# LATEX_MAKEINDEX_CMD    = makeindex
 
 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
 # documents. This may be useful for small projects and may help to save some
@@ -1871,8 +1916,13 @@ LATEX_TIMESTAMP        = NO
 # it will be relative to the LATEX_OUTPUT directory. If left blank the
 # LATEX_OUTPUT directory will be used.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_EMOJI_DIRECTORY  =
+#
+# NOTE: This tag is unsupported in Doxygen 1.8.13 and generates a warning
+# while building the documentation using that version. Because the value is 
+# not being set to a non-default value, it is commented out but left in
+# place for documentary purposes.
+# 
+# LATEX_EMOJI_DIRECTORY  =
 
 #---------------------------------------------------------------------------
 # Configuration options related to the RTF output
@@ -2015,8 +2065,13 @@ XML_PROGRAMLISTING     = YES
 # namespace members in file scope as well, matching the HTML output.
 # The default value is: NO.
 # This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_NS_MEMB_FILE_SCOPE = NO
+#
+# NOTE: This tag is unsupported in Doxygen 1.8.13 and generates a warning
+# while building the documentation using that version. Because the value is 
+# not being set to a non-default value, it is commented out but left in
+# place for documentary purposes.
+#
+# XML_NS_MEMB_FILE_SCOPE = NO
 
 #---------------------------------------------------------------------------
 # Configuration options related to the DOCBOOK output