|
|
@@ -1,11 +1,11 @@
|
|
|
-# Doxyfile 1.8.5
|
|
|
+# Doxyfile 1.8.6
|
|
|
|
|
|
# This file describes the settings to be used by the documentation system
|
|
|
# doxygen (www.doxygen.org) for a project.
|
|
|
-#
|
|
|
+#
|
|
|
# All text after a double hash (##) is considered a comment and is placed in
|
|
|
# front of the TAG it is preceding.
|
|
|
-#
|
|
|
+#
|
|
|
# All text after a single hash (#) is considered a comment and will be ignored.
|
|
|
# The format is:
|
|
|
# TAG = value [value, ...]
|
|
|
@@ -38,7 +38,7 @@ PROJECT_NAME = tinyusb
|
|
|
# could be handy for archiving the generated documentation or if some version
|
|
|
# control system is used.
|
|
|
|
|
|
-PROJECT_NUMBER =
|
|
|
+PROJECT_NUMBER = 0.4
|
|
|
|
|
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
|
|
# for a project that appears at the top of each page and should give viewer a
|
|
|
@@ -73,12 +73,14 @@ CREATE_SUBDIRS = NO
|
|
|
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
|
|
# documentation generated by doxygen is written. Doxygen will use this
|
|
|
# information to generate all constant output in the proper language.
|
|
|
-# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
|
|
|
-# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
|
|
|
-# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
|
|
|
-# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
|
|
|
-# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
|
|
|
-# Turkish, Ukrainian and Vietnamese.
|
|
|
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
|
|
|
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
|
|
|
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
|
|
|
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
|
|
|
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
|
|
|
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
|
|
|
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
|
|
|
+# Ukrainian and Vietnamese.
|
|
|
# The default value is: English.
|
|
|
|
|
|
OUTPUT_LANGUAGE = English
|
|
|
@@ -92,7 +94,7 @@ BRIEF_MEMBER_DESC = YES
|
|
|
|
|
|
# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
|
|
|
# description of a member or function before the detailed description
|
|
|
-#
|
|
|
+#
|
|
|
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
|
|
# brief descriptions will be completely suppressed.
|
|
|
# The default value is: YES.
|
|
|
@@ -147,7 +149,7 @@ FULL_PATH_NAMES = YES
|
|
|
# part of the path. The tag can be used to show relative paths in the file list.
|
|
|
# If left blank the directory from which doxygen is run is used as the path to
|
|
|
# strip.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that you can specify absolute paths here, but also relative paths, which
|
|
|
# will be relative from the directory where doxygen is started.
|
|
|
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
|
|
|
@@ -192,7 +194,7 @@ QT_AUTOBRIEF = NO
|
|
|
# a brief description. This used to be the default behavior. The new default is
|
|
|
# to treat a multi-line C++ comment block as a detailed description. Set this
|
|
|
# tag to YES if you prefer the old behavior instead.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that setting this tag to YES also means that rational rose comments are
|
|
|
# not recognized any more.
|
|
|
# The default value is: NO.
|
|
|
@@ -272,9 +274,9 @@ OPTIMIZE_OUTPUT_VHDL = NO
|
|
|
# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
|
|
|
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
|
|
|
# (default is Fortran), use: inc=Fortran f=C.
|
|
|
-#
|
|
|
+#
|
|
|
# Note For files without extension you can use no_extension as a placeholder.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
|
|
|
# the files are not read by doxygen.
|
|
|
|
|
|
@@ -353,7 +355,7 @@ SUBGROUPING = YES
|
|
|
# are shown inside the group in which they are included (e.g. using \ingroup)
|
|
|
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
|
|
|
# and RTF).
|
|
|
-#
|
|
|
+#
|
|
|
# Note that this feature does not work in combination with
|
|
|
# SEPARATE_MEMBER_PAGES.
|
|
|
# The default value is: NO.
|
|
|
@@ -510,6 +512,9 @@ HIDE_SCOPE_NAMES = YES
|
|
|
|
|
|
SHOW_INCLUDE_FILES = YES
|
|
|
|
|
|
+
|
|
|
+SHOW_GROUPED_MEMB_INC = NO
|
|
|
+
|
|
|
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
|
|
|
# files with double quotes in the documentation rather than with sharp brackets.
|
|
|
# The default value is: NO.
|
|
|
@@ -531,7 +536,8 @@ SORT_MEMBER_DOCS = YES
|
|
|
|
|
|
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
|
|
|
# descriptions of file, namespace and class members alphabetically by member
|
|
|
-# name. If set to NO the members will appear in declaration order.
|
|
|
+# name. If set to NO the members will appear in declaration order. Note that
|
|
|
+# this will also influence the order of the classes in the class list.
|
|
|
# The default value is: NO.
|
|
|
|
|
|
SORT_BRIEF_DOCS = NO
|
|
|
@@ -656,7 +662,7 @@ FILE_VERSION_FILTER =
|
|
|
# that represents doxygen's defaults, run doxygen with the -l option. You can
|
|
|
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
|
|
|
# will be used as the name of the layout file.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that if you run doxygen from a directory containing a file called
|
|
|
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
|
|
|
# tag is left empty.
|
|
|
@@ -688,7 +694,7 @@ QUIET = NO
|
|
|
# The WARNINGS tag can be used to turn on/off the warning messages that are
|
|
|
# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
|
|
|
# this implies that the warnings are on.
|
|
|
-#
|
|
|
+#
|
|
|
# Tip: Turn warnings on while writing the documentation.
|
|
|
# The default value is: YES.
|
|
|
|
|
|
@@ -820,7 +826,7 @@ RECURSIVE = YES
|
|
|
# The EXCLUDE tag can be used to specify files and/or directories that should be
|
|
|
# excluded from the INPUT source files. This way you can easily exclude a
|
|
|
# subdirectory from a directory tree whose root is specified with the INPUT tag.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that relative paths are relative to the directory from which doxygen is
|
|
|
# run.
|
|
|
|
|
|
@@ -836,7 +842,7 @@ EXCLUDE_SYMLINKS = NO
|
|
|
# If the value of the INPUT tag contains directories, you can use the
|
|
|
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
|
|
# certain files from those directories.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that the wildcards are matched against the file with absolute path, so to
|
|
|
# exclude all test directories for example use the pattern */test/*
|
|
|
|
|
|
@@ -847,7 +853,7 @@ EXCLUDE_PATTERNS =
|
|
|
# output. The symbol name can be a fully qualified name, a word, or if the
|
|
|
# wildcard * is used, a substring. Examples: ANamespace, AClass,
|
|
|
# AClass::ANamespace, ANamespace::*Test
|
|
|
-#
|
|
|
+#
|
|
|
# Note that the wildcards are matched against the file with absolute path, so to
|
|
|
# exclude all test directories use the pattern */test/*
|
|
|
|
|
|
@@ -882,14 +888,14 @@ IMAGE_PATH =
|
|
|
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
|
|
# invoke to filter for each input file. Doxygen will invoke the filter program
|
|
|
# by executing (via popen()) the command:
|
|
|
-#
|
|
|
+#
|
|
|
# <filter> <input-file>
|
|
|
-#
|
|
|
+#
|
|
|
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
|
|
|
# name of an input file. Doxygen will then use the output that the filter
|
|
|
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
|
|
|
# will be ignored.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that the filter must not add or remove lines; it is applied before the
|
|
|
# code is scanned, but not when the output code is generated. If lines are added
|
|
|
# or removed, the anchors will not be placed correctly.
|
|
|
@@ -933,12 +939,12 @@ USE_MDFILE_AS_MAINPAGE = readme.markdown
|
|
|
|
|
|
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
|
|
|
# generated. Documented entities will be cross-referenced with these sources.
|
|
|
-#
|
|
|
+#
|
|
|
# Note: To get rid of all source code in the generated output, make sure that
|
|
|
# also VERBATIM_HEADERS is set to NO.
|
|
|
# The default value is: NO.
|
|
|
|
|
|
-SOURCE_BROWSER = NO
|
|
|
+SOURCE_BROWSER = YES
|
|
|
|
|
|
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
|
|
|
# classes and enums directly into the documentation.
|
|
|
@@ -988,16 +994,16 @@ SOURCE_TOOLTIPS = YES
|
|
|
# source browser. The htags tool is part of GNU's global source tagging system
|
|
|
# (see http://www.gnu.org/software/global/global.html). You will need version
|
|
|
# 4.8.6 or higher.
|
|
|
-#
|
|
|
+#
|
|
|
# To use it do the following:
|
|
|
# - Install the latest version of global
|
|
|
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
|
|
|
# - Make sure the INPUT points to the root of the source tree
|
|
|
# - Run doxygen as normal
|
|
|
-#
|
|
|
+#
|
|
|
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
|
|
|
# tools must be available from the command line (i.e. in the search path).
|
|
|
-#
|
|
|
+#
|
|
|
# The result: instead of the source browser generated by doxygen, the links to
|
|
|
# source code will now point to the output of htags.
|
|
|
# The default value is: NO.
|
|
|
@@ -1085,7 +1091,7 @@ HTML_FILE_EXTENSION = .html
|
|
|
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
|
|
|
# each generated HTML page. If the tag is left blank doxygen will generate a
|
|
|
# standard header.
|
|
|
-#
|
|
|
+#
|
|
|
# To get valid HTML the header file that includes any scripts and style sheets
|
|
|
# that doxygen needs, which is dependent on the configuration options used (e.g.
|
|
|
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
|
|
|
@@ -1253,7 +1259,7 @@ DOCSET_PUBLISHER_NAME = Publisher
|
|
|
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
|
|
|
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
|
|
|
# Windows.
|
|
|
-#
|
|
|
+#
|
|
|
# The HTML Help Workshop contains a compiler that can convert all HTML output
|
|
|
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
|
|
|
# files are now used as the Windows 98 help format, and will replace the old
|
|
|
@@ -1421,7 +1427,7 @@ GENERATE_TREEVIEW = YES
|
|
|
|
|
|
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
|
|
|
# doxygen will group on one line in the generated HTML documentation.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that a value of 0 will completely suppress the enum values from appearing
|
|
|
# in the overview section.
|
|
|
# Minimum value: 0, maximum value: 20, default value: 4.
|
|
|
@@ -1455,7 +1461,7 @@ FORMULA_FONTSIZE = 10
|
|
|
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
|
|
|
# generated for formulas are transparent PNGs. Transparent PNGs are not
|
|
|
# supported properly for IE 6.0, but are supported on all modern browsers.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that when changing this option you need to delete any form_*.png files in
|
|
|
# the HTML output directory before the changes have effect.
|
|
|
# The default value is: YES.
|
|
|
@@ -1531,7 +1537,7 @@ MATHJAX_CODEFILE =
|
|
|
# The default value is: YES.
|
|
|
# This tag requires that the tag GENERATE_HTML is set to YES.
|
|
|
|
|
|
-SEARCHENGINE = NO
|
|
|
+SEARCHENGINE = YES
|
|
|
|
|
|
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
|
|
|
# implemented using a web server instead of a web client using Javascript. There
|
|
|
@@ -1550,11 +1556,11 @@ SERVER_BASED_SEARCH = NO
|
|
|
# which needs to be processed by an external indexer. Doxygen will invoke an
|
|
|
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
|
|
|
# search results.
|
|
|
-#
|
|
|
+#
|
|
|
# Doxygen ships with an example indexer ( doxyindexer) and search engine
|
|
|
# (doxysearch.cgi) which are based on the open source search engine library
|
|
|
# Xapian (see: http://xapian.org/).
|
|
|
-#
|
|
|
+#
|
|
|
# See the section "External Indexing and Searching" for details.
|
|
|
# The default value is: NO.
|
|
|
# This tag requires that the tag SEARCHENGINE is set to YES.
|
|
|
@@ -1563,7 +1569,7 @@ EXTERNAL_SEARCH = NO
|
|
|
|
|
|
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
|
|
|
# which will return the search results when EXTERNAL_SEARCH is enabled.
|
|
|
-#
|
|
|
+#
|
|
|
# Doxygen ships with an example indexer ( doxyindexer) and search engine
|
|
|
# (doxysearch.cgi) which are based on the open source search engine library
|
|
|
# Xapian (see: http://xapian.org/). See the section "External Indexing and
|
|
|
@@ -1617,7 +1623,7 @@ LATEX_OUTPUT = latex
|
|
|
|
|
|
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
|
|
# invoked.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that when enabling USE_PDFLATEX this option is only used for generating
|
|
|
# bitmaps for formulas in the HTML output, but not in the Makefile that is
|
|
|
# written to the output directory.
|
|
|
@@ -1664,7 +1670,7 @@ EXTRA_PACKAGES =
|
|
|
# chapter. If it is left blank doxygen will generate a standard header. See
|
|
|
# section "Doxygen usage" for information on how to let doxygen write the
|
|
|
# default header to a separate file.
|
|
|
-#
|
|
|
+#
|
|
|
# Note: Only use a user-defined header if you know what you are doing! The
|
|
|
# following commands have a special meaning inside the header: $title,
|
|
|
# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
|
|
|
@@ -1678,7 +1684,7 @@ LATEX_HEADER =
|
|
|
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
|
|
|
# generated LaTeX document. The footer should contain everything after the last
|
|
|
# chapter. If it is left blank doxygen will generate a standard footer.
|
|
|
-#
|
|
|
+#
|
|
|
# Note: Only use a user-defined footer if you know what you are doing!
|
|
|
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
|
|
|
|
|
@@ -1727,7 +1733,7 @@ LATEX_HIDE_INDICES = NO
|
|
|
|
|
|
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
|
|
|
# code with syntax highlighting in the LaTeX output.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that which sources are shown also depends on other settings such as
|
|
|
# SOURCE_BROWSER.
|
|
|
# The default value is: NO.
|
|
|
@@ -1775,7 +1781,7 @@ COMPACT_RTF = NO
|
|
|
# output) instead of page references. This makes the output suitable for online
|
|
|
# browsing using Word or some other Word compatible readers that support those
|
|
|
# fields.
|
|
|
-#
|
|
|
+#
|
|
|
# Note: WordPad (write) and others do not support links.
|
|
|
# The default value is: NO.
|
|
|
# This tag requires that the tag GENERATE_RTF is set to YES.
|
|
|
@@ -1785,7 +1791,7 @@ RTF_HYPERLINKS = NO
|
|
|
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
|
|
|
# file, i.e. a series of assignments. You only have to provide replacements,
|
|
|
# missing definitions are set to their default value.
|
|
|
-#
|
|
|
+#
|
|
|
# See also section "Doxygen usage" for information on how to generate the
|
|
|
# default style sheet that doxygen normally uses.
|
|
|
# This tag requires that the tag GENERATE_RTF is set to YES.
|
|
|
@@ -1911,7 +1917,7 @@ GENERATE_AUTOGEN_DEF = NO
|
|
|
|
|
|
# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
|
|
|
# file that captures the structure of the code including all documentation.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that this feature is still experimental and incomplete at the moment.
|
|
|
# The default value is: NO.
|
|
|
|
|
|
@@ -2100,6 +2106,13 @@ CLASS_DIAGRAMS = YES
|
|
|
|
|
|
MSCGEN_PATH =
|
|
|
|
|
|
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
|
|
|
+# then run dia to produce the diagram and insert it in the documentation. The
|
|
|
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
|
|
|
+# If left empty dia is assumed to be found in the default search path.
|
|
|
+
|
|
|
+DIA_PATH =
|
|
|
+
|
|
|
# If set to YES, the inheritance and collaboration graphs will hide inheritance
|
|
|
# and usage relations if the target is undocumented or is not a class.
|
|
|
# The default value is: YES.
|
|
|
@@ -2222,7 +2235,7 @@ INCLUDED_BY_GRAPH = YES
|
|
|
|
|
|
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
|
|
|
# dependency graph for every global function or class method.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that enabling this option will significantly increase the time of a run.
|
|
|
# So in most cases it will be better to enable call graphs for selected
|
|
|
# functions only using the \callgraph command.
|
|
|
@@ -2233,7 +2246,7 @@ CALL_GRAPH = NO
|
|
|
|
|
|
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
|
|
|
# dependency graph for every global function or class method.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that enabling this option will significantly increase the time of a run.
|
|
|
# So in most cases it will be better to enable caller graphs for selected
|
|
|
# functions only using the \callergraph command.
|
|
|
@@ -2271,7 +2284,7 @@ DOT_IMAGE_FORMAT = png
|
|
|
|
|
|
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
|
|
|
# enable generation of interactive SVG images that allow zooming and panning.
|
|
|
-#
|
|
|
+#
|
|
|
# Note that this requires a modern browser other than Internet Explorer. Tested
|
|
|
# and working are Firefox, Chrome, Safari, and Opera.
|
|
|
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
|
|
|
@@ -2300,6 +2313,12 @@ DOTFILE_DIRS =
|
|
|
|
|
|
MSCFILE_DIRS =
|
|
|
|
|
|
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
|
|
|
+# contain dia files that are included in the documentation (see the \diafile
|
|
|
+# command).
|
|
|
+
|
|
|
+DIAFILE_DIRS =
|
|
|
+
|
|
|
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
|
|
|
# that will be shown in the graph. If the number of nodes in a graph becomes
|
|
|
# larger than this value, doxygen will truncate the graph, which is visualized
|
|
|
@@ -2327,7 +2346,7 @@ MAX_DOT_GRAPH_DEPTH = 0
|
|
|
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
|
|
|
# background. This is disabled by default, because dot on Windows does not seem
|
|
|
# to support this out of the box.
|
|
|
-#
|
|
|
+#
|
|
|
# Warning: Depending on the platform used, enabling this option may lead to
|
|
|
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
|
|
|
# read).
|