Update Doxygen configuration files to the latest version.

[pub/lufa.git] / Bootloaders / MassStorage / Doxygen.conf

diff --git a/Bootloaders/MassStorage/Doxygen.conf b/Bootloaders/MassStorage/Doxygen.conf
index 35a3de7..fd327d0 100644 (file)
--- a/Bootloaders/MassStorage/Doxygen.conf
+++ b/Bootloaders/MassStorage/Doxygen.conf
@@ -1,8 +1,10 @@
-# Doxyfile 1.8.3.1\r
+# Doxyfile 1.8.4\r

 \r
 # This file describes the settings to be used by the documentation system\r
 # doxygen (www.doxygen.org) for a project.\r
 #\r
 \r
 # This file describes the settings to be used by the documentation system\r
 # doxygen (www.doxygen.org) for a project.\r
 #\r

+# All text after a double hash (##) is considered a comment and is placed\r
+# in front of the TAG it is preceding .\r

 # All text after a hash (#) is considered a comment and will be ignored.\r
 # The format is:\r
 #       TAG = value [value, ...]\r
 # All text after a hash (#) is considered a comment and will be ignored.\r
 # The format is:\r
 #       TAG = value [value, ...]\r


@@ -70,9 +72,9 @@ CREATE_SUBDIRS         = NO
 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,\r
 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,\r
 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English\r
 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,\r
 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,\r
 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English\r

-# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,\r
-# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,\r
-# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.\r
+# messages), Korean, Korean-en, Latvian, Lithuanian, Norwegian, Macedonian,\r
+# Persian, Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic,\r
+# Slovak, Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.\r

 \r
 OUTPUT_LANGUAGE        = English\r
 \r
 \r
 OUTPUT_LANGUAGE        = English\r
 \r


@@ -262,10 +264,10 @@ EXTENSION_MAPPING      =
 \r
 MARKDOWN_SUPPORT       = NO\r
 \r
 \r
 MARKDOWN_SUPPORT       = NO\r
 \r

-# When enabled doxygen tries to link words that correspond to documented classes,\r
-# or namespaces to their corresponding documentation. Such a link can be\r
-# prevented in individual cases by by putting a % sign in front of the word or\r
-# globally by setting AUTOLINK_SUPPORT to NO.\r
+# When enabled doxygen tries to link words that correspond to documented\r
+# classes, or namespaces to their corresponding documentation. Such a link can\r
+# be prevented in individual cases by by putting a % sign in front of the word\r
+# or globally by setting AUTOLINK_SUPPORT to NO.\r

 \r
 AUTOLINK_SUPPORT       = YES\r
 \r
 \r
 AUTOLINK_SUPPORT       = YES\r
 \r


@@ -321,11 +323,11 @@ SUBGROUPING            = YES
 INLINE_GROUPED_CLASSES = NO\r
 \r
 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and\r
 INLINE_GROUPED_CLASSES = NO\r
 \r
 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and\r

-# unions with only public data fields will be shown inline in the documentation\r
-# of the scope in which they are defined (i.e. file, namespace, or group\r
-# documentation), provided this scope is documented. If set to NO (the default),\r
-# structs, classes, and unions are shown on a separate page (for HTML and Man\r
-# pages) or section (for LaTeX and RTF).\r
+# unions with only public data fields or simple typedef fields will be shown\r
+# inline in the documentation of the scope in which they are defined (i.e. file,\r
+# namespace, or group documentation), provided this scope is documented. If set\r
+# to NO (the default), structs, classes, and unions are shown on a separate\r
+# page (for HTML and Man pages) or section (for LaTeX and RTF).\r

 \r
 INLINE_SIMPLE_STRUCTS  = NO\r
 \r
 \r
 INLINE_SIMPLE_STRUCTS  = NO\r
 \r


@@ -339,30 +341,14 @@ INLINE_SIMPLE_STRUCTS  = NO
 \r
 TYPEDEF_HIDES_STRUCT   = NO\r
 \r
 \r
 TYPEDEF_HIDES_STRUCT   = NO\r
 \r

-# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to\r
-# determine which symbols to keep in memory and which to flush to disk.\r
-# When the cache is full, less often used symbols will be written to disk.\r
-# For small to medium size projects (<1000 input files) the default value is\r
-# probably good enough. For larger projects a too small cache size can cause\r
-# doxygen to be busy swapping symbols to and from disk most of the time\r
-# causing a significant performance penalty.\r
-# If the system has enough physical memory increasing the cache will improve the\r
-# performance by keeping more symbols in memory. Note that the value works on\r
-# a logarithmic scale so increasing the size by one will roughly double the\r
-# memory usage. The cache size is given by this formula:\r
-# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,\r
-# corresponding to a cache size of 2^16 = 65536 symbols.\r
-\r
-SYMBOL_CACHE_SIZE      = 0\r
-\r
-# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be\r
-# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given\r
-# their name and scope. Since this can be an expensive process and often the\r
-# same symbol appear multiple times in the code, doxygen keeps a cache of\r
-# pre-resolved symbols. If the cache is too small doxygen will become slower.\r
-# If the cache is too large, memory is wasted. The cache size is given by this\r
-# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,\r
-# corresponding to a cache size of 2^16 = 65536 symbols.\r
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This\r
+# cache is used to resolve symbols given their name and scope. Since this can\r
+# be an expensive process and often the same symbol appear multiple times in\r
+# the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too\r
+# small doxygen will become slower. If the cache is too large, memory is wasted.\r
+# The cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid\r
+# range is 0..9, the default is 0, corresponding to a cache size of 2^16 = 65536\r
+# symbols.\r

 \r
 LOOKUP_CACHE_SIZE      = 0\r
 \r
 \r
 LOOKUP_CACHE_SIZE      = 0\r
 \r


@@ -373,7 +359,7 @@ LOOKUP_CACHE_SIZE      = 0
 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in\r
 # documentation are documented, even if no documentation was available.\r
 # Private class members and static file members will be hidden unless\r
 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in\r
 # documentation are documented, even if no documentation was available.\r
 # Private class members and static file members will be hidden unless\r

-# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES\r
+# the EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES\r

 \r
 EXTRACT_ALL            = YES\r
 \r
 \r
 EXTRACT_ALL            = YES\r
 \r


@@ -769,8 +755,10 @@ IMAGE_PATH             =
 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an\r
 # input file. Doxygen will then use the output that the filter program writes\r
 # to standard output.\r
 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an\r
 # input file. Doxygen will then use the output that the filter program writes\r
 # to standard output.\r

-# If FILTER_PATTERNS is specified, this tag will be\r
-# ignored.\r
+# If FILTER_PATTERNS is specified, this tag will be ignored.\r
+# Note that the filter must not add or remove lines; it is applied before the\r
+# code is scanned, but not when the output code is generated. If lines are added\r
+# or removed, the anchors will not be placed correctly.\r

 \r
 INPUT_FILTER           =\r
 \r
 \r
 INPUT_FILTER           =\r
 \r


@@ -800,9 +788,9 @@ FILTER_SOURCE_FILES    = NO
 FILTER_SOURCE_PATTERNS =\r
 \r
 # If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that\r
 FILTER_SOURCE_PATTERNS =\r
 \r
 # If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that\r

-# is part of the input, its contents will be placed on the main page (index.html).\r
-# This can be useful if you have a project on for instance GitHub and want reuse\r
-# the introduction page also for the doxygen output.\r
+# is part of the input, its contents will be placed on the main page\r
+# (index.html). This can be useful if you have a project on for instance GitHub\r
+# and want reuse the introduction page also for the doxygen output.\r

 \r
 USE_MDFILE_AS_MAINPAGE =\r
 \r
 \r
 USE_MDFILE_AS_MAINPAGE =\r
 \r


@@ -862,6 +850,20 @@ USE_HTAGS              = NO
 \r
 VERBATIM_HEADERS       = NO\r
 \r
 \r
 VERBATIM_HEADERS       = NO\r
 \r

+# If CLANG_ASSISTED_PARSING is set to YES, then doxygen will use the clang parser\r
+# for more acurate parsing at the cost of reduced performance. This can be\r
+# particularly helpful with template rich C++ code for which doxygen's built-in\r
+# parser lacks the necessairy type information.\r
+\r
+CLANG_ASSISTED_PARSING = NO\r
+\r
+# If clang assisted parsing is enabled you can provide the compiler with command\r
+# line options that you would normally use when invoking the compiler. Note that\r
+# the include paths will already be set by doxygen for the files and directories\r
+# specified at INPUT and INCLUDE_PATH.\r
+\r
+CLANG_OPTIONS          =\r
+\r

 #---------------------------------------------------------------------------\r
 # configuration options related to the alphabetical class index\r
 #---------------------------------------------------------------------------\r
 #---------------------------------------------------------------------------\r
 # configuration options related to the alphabetical class index\r
 #---------------------------------------------------------------------------\r


@@ -947,7 +949,7 @@ HTML_EXTRA_STYLESHEET  =
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or\r
 # other source files which should be copied to the HTML output directory. Note\r
 # that these files will be copied to the base HTML output directory. Use the\r
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or\r
 # other source files which should be copied to the HTML output directory. Note\r
 # that these files will be copied to the base HTML output directory. Use the\r

-# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\r
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these\r

 # files. In the HTML_STYLESHEET file, use the file name only. Also note that\r
 # the files will be copied as-is; there are no commands or markers available.\r
 \r
 # files. In the HTML_STYLESHEET file, use the file name only. Also note that\r
 # the files will be copied as-is; there are no commands or markers available.\r
 \r


@@ -1216,7 +1218,7 @@ FORMULA_TRANSPARENT    = YES
 USE_MATHJAX            = NO\r
 \r
 # When MathJax is enabled you can set the default output format to be used for\r
 USE_MATHJAX            = NO\r
 \r
 # When MathJax is enabled you can set the default output format to be used for\r

-# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and\r
+# the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and\r

 # SVG. The default value is HTML-CSS, which is slower, but has the best\r
 # compatibility.\r
 \r
 # SVG. The default value is HTML-CSS, which is slower, but has the best\r
 # compatibility.\r
 \r


@@ -1239,6 +1241,11 @@ MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 \r
 MATHJAX_EXTENSIONS     =\r
 \r
 \r
 MATHJAX_EXTENSIONS     =\r
 \r

+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript\r
+# pieces of code that will be used on startup of the MathJax code.\r
+\r
+MATHJAX_CODEFILE       =\r
+\r

 # When the SEARCHENGINE tag is enabled doxygen will generate a search box\r
 # for the HTML output. The underlying search engine uses javascript\r
 # and DHTML and should work on any modern browser. Note that when using\r
 # When the SEARCHENGINE tag is enabled doxygen will generate a search box\r
 # for the HTML output. The underlying search engine uses javascript\r
 # and DHTML and should work on any modern browser. Note that when using\r


@@ -1264,8 +1271,8 @@ SERVER_BASED_SEARCH    = NO
 # which needs to be processed by an external indexer. Doxygen will invoke an\r
 # external search engine pointed to by the SEARCHENGINE_URL option to obtain\r
 # the search results. Doxygen ships with an example indexer (doxyindexer) and\r
 # which needs to be processed by an external indexer. Doxygen will invoke an\r
 # external search engine pointed to by the SEARCHENGINE_URL option to obtain\r
 # the search results. Doxygen ships with an example indexer (doxyindexer) and\r

-# search engine (doxysearch.cgi) which are based on the open source search engine\r
-# library Xapian. See the manual for configuration details.\r
+# search engine (doxysearch.cgi) which are based on the open source search\r
+# engine library Xapian. See the manual for configuration details.\r

 \r
 EXTERNAL_SEARCH        = NO\r
 \r
 \r
 EXTERNAL_SEARCH        = NO\r
 \r


@@ -1336,7 +1343,7 @@ COMPACT_LATEX          = NO
 \r
 # The PAPER_TYPE tag can be used to set the paper type that is used\r
 # by the printer. Possible values are: a4, letter, legal and\r
 \r
 # The PAPER_TYPE tag can be used to set the paper type that is used\r
 # by the printer. Possible values are: a4, letter, legal and\r

-# executive. If left blank a4wide will be used.\r
+# executive. If left blank a4 will be used.\r

 \r
 PAPER_TYPE             = a4wide\r
 \r
 \r
 PAPER_TYPE             = a4wide\r
 \r


@@ -1359,6 +1366,13 @@ LATEX_HEADER           =
 \r
 LATEX_FOOTER           =\r
 \r
 \r
 LATEX_FOOTER           =\r
 \r

+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images\r
+# or other source files which should be copied to the LaTeX output directory.\r
+# Note that the files will be copied as-is; there are no commands or markers\r
+# available.\r
+\r
+LATEX_EXTRA_FILES      =\r
+\r

 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated\r
 # is prepared for conversion to pdf (using ps2pdf). The pdf file will\r
 # contain links (just like the HTML output) instead of page references\r
 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated\r
 # is prepared for conversion to pdf (using ps2pdf). The pdf file will\r
 # contain links (just like the HTML output) instead of page references\r


@@ -1504,6 +1518,21 @@ XML_DTD                =
 XML_PROGRAMLISTING     = YES\r
 \r
 #---------------------------------------------------------------------------\r
 XML_PROGRAMLISTING     = YES\r
 \r
 #---------------------------------------------------------------------------\r

+# configuration options related to the DOCBOOK output\r
+#---------------------------------------------------------------------------\r
+\r
+# If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files\r
+# that can be used to generate PDF.\r
+\r
+GENERATE_DOCBOOK       = NO\r
+\r
+# The DOCBOOK_OUTPUT tag is used to specify where the DOCBOOK pages will be put.\r
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in\r
+# front of it. If left blank docbook will be used as the default path.\r
+\r
+DOCBOOK_OUTPUT         = docbook\r
+\r
+#---------------------------------------------------------------------------\r

 # configuration options for the AutoGen Definitions output\r
 #---------------------------------------------------------------------------\r
 \r
 # configuration options for the AutoGen Definitions output\r
 #---------------------------------------------------------------------------\r
 \r


@@ -1654,6 +1683,12 @@ ALLEXTERNALS           = NO
 \r
 EXTERNAL_GROUPS        = YES\r
 \r
 \r
 EXTERNAL_GROUPS        = YES\r
 \r

+# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed\r
+# in the related pages index. If set to NO, only the current project's\r
+# pages will be listed.\r
+\r
+EXTERNAL_PAGES         = YES\r
+\r

 # The PERL_PATH should be the absolute path and name of the perl script\r
 # interpreter (i.e. the result of `which perl').\r
 \r
 # The PERL_PATH should be the absolute path and name of the perl script\r
 # interpreter (i.e. the result of `which perl').\r
 \r


@@ -1708,7 +1743,7 @@ DOT_NUM_THREADS        = 0
 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the\r
 # directory containing the font.\r
 \r
 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the\r
 # directory containing the font.\r
 \r

-DOT_FONTNAME           = FreeSans\r
+DOT_FONTNAME           =\r

 \r
 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.\r
 # The default size is 10pt.\r
 \r
 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.\r
 # The default size is 10pt.\r


@@ -1750,7 +1785,7 @@ UML_LOOK               = NO
 # the class node. If there are many fields or methods and many nodes the\r
 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS\r
 # threshold limits the number of items for each type to make the size more\r
 # the class node. If there are many fields or methods and many nodes the\r
 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS\r
 # threshold limits the number of items for each type to make the size more\r

-# managable. Set this to 0 for no limit. Note that the threshold may be\r
+# manageable. Set this to 0 for no limit. Note that the threshold may be\r

 # exceeded by 50% before the limit is enforced.\r
 \r
 UML_LIMIT_NUM_FIELDS   = 10\r
 # exceeded by 50% before the limit is enforced.\r
 \r
 UML_LIMIT_NUM_FIELDS   = 10\r