mpp_doxyfile - OpenGrok cross reference for /rockchip-linux_mpp/tools/mpp_doxyfile

4 # doxygen (www.doxygen.org) for a project.
6 # All text after a double hash (##) is considered a comment and is placed in
9 # All text after a single hash (#) is considered a comment and will be ignored.
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
32 # title of most generated pages and in a few other places.
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
44 # for a project that appears at the top of each page and should give viewer a
57 # into which the generated documentation will be written. If a relative path is
66 # option can be useful when feeding doxygen a huge amount of source files, where
96 # description of a member or function before the detailed description
104 # This tag implements a quasi-intelligent brief description abbreviator that is
111 # specifies, contains, represents, a, an and the.
116 # doxygen will generate a detailed section even if there is only a brief
123 # inherited members of a class in the documentation of that class as if those
137 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
149 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
150 # path mentioned in the documentation of a class, which tells the reader which
151 # header file to include in order to use a class. If left blank only the name of
166 # first line (until the first dot) of a Javadoc-style comment as the brief
168 # style comments (thus requiring an explicit @brief command for a brief
175 # line (until the first dot) of a Qt-style comment as the brief description. If
177 # requiring an explicit \brief command for a brief description.)
182 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
183 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
184 # a brief description. This used to be the default behavior. The new default is
185 # to treat a multi-line C++ comment block as a detailed description. Set this
200 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
201 # new page for each member. If set to NO, the documentation of a member will be
207 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
213 # This tag can be used to specify a number of aliases that act as commands in
219 # documentation, which will result in a user-defined paragraph with heading
225 # This tag can be used to specify a number of word-keyword mappings (TCL only).
260 # parses. With this tag you can assign which parser to use for a given
261 # extension. Doxygen has a built-in mapping, but you can override or extend it
262 # using this tag. The format is ext=language, where ext is a file extension, and
268 # Note For files without extension you can use no_extension as a placeholder.
286 # classes, or namespaces to their corresponding documentation. Such a link can
287 # be prevented in individual cases by by putting a % sign in front of the word
294 # to include (a tag file for) the STL sources as input, then you should set this
318 # getter and setter methods for a property. Setting this option to YES will make
319 # doxygen to replace the get and set methods by a property in the documentation.
320 # This will only work if the methods are indeed getting or setting a simple
330 # all members of a group must be documented explicitly.
336 # (for instance a group of public functions) to be put as a subgroup of that
346 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
359 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
365 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
367 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
368 # with name TypeT. When disabled the typedef will appear as a member of a file,
379 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
382 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
383 # symbols. At the end of a run doxygen will report the cache usage and suggest
384 # the optimal cache size from a speed point of view.
403 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
415 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
438 # extracted and appear in the documentation as a namespace called
470 # documentation blocks found inside the body of a function. If set to NO these
476 # The INTERNAL_DOCS tag determines if documentation that is typed after a
499 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
500 # the files that are included by a file in the documentation of that file.
518 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
569 # type resolution of all parameters of a function it will reject a match between
570 # the prototype and the implementation of a member function even if there is
571 # only one candidate or it is obvious which candidate to choose by doing a
573 # accept a match between prototype and implementation in such cases.
612 # initial value of a variable or macro / define can have for it to appear in the
614 # it will be hidden. Use a value of 0 to hide initializers completely. The
643 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
653 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
657 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
660 # Note that if you run doxygen from a directory containing a file called
667 # the reference definitions. This must be a list of .bib files. The .bib
706 # in a documented function, or documenting parameters that don't exist or using
730 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
775 # excluded from the INPUT source files. This way you can easily exclude a
776 # subdirectory from a directory tree whose root is specified with the INPUT tag.
784 # directories that are symbolic links (a Unix file system feature) are excluded
801 # output. The symbol name can be a fully qualified name, a word, or if the
802 # wildcard * is used, a substring. Examples: ANamespace, AClass,
836 # The INPUT_FILTER tag can be used to specify a program that doxygen should
853 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
855 # filter if there is a match. The filters are a list of the form: pattern=filter
871 # it is also possible to disable source filtering for a specific pattern using
872 # *.ext= (so without naming a filter).
877 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
879 # (index.html). This can be useful if you have a project on for instance GitHub
888 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
930 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
931 # source code will show a tooltip with additional information such as prototype,
933 # will make the HTML file larger and loading of large files a bit slower, you
962 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
975 # compounds will be generated. Enable this if the project contains a lot of
988 # In case all classes in a project start with a common prefix, all classes will
990 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1005 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1020 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1021 # each generated HTML page. If the tag is left blank doxygen will generate a
1026 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1034 # default header when upgrading to a newer version of doxygen. For a description
1040 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1041 # generated HTML page. If the tag is left blank doxygen will generate a standard
1042 # footer. See HTML_HEADER for more information on how to generate a default
1050 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1052 # the HTML output. If left blank doxygen will generate a default style sheet.
1085 # this color. Hue is specified as an angle on a colorwheel, see
1095 # in the HTML output. For a value of 0 the output will use grayscales only. A
1106 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1132 # such a level that at most the specified number of entries are visible (unless
1133 # a fully collapsed tree already exceeds this amount). So setting the number of
1134 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1135 # representing an infinite number of entries and will result in a full expanded
1145 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1157 # an umbrella under which multiple documentation sets from a single provider
1158 # (such as a company or product suite) can be grouped.
1164 # This tag specifies a string that should uniquely identify the documentation
1165 # set bundle. This should be a reverse domain-name style string, e.g.
1172 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1173 # the documentation publisher. This should be a reverse domain-name style
1188 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1192 # The HTML Help Workshop contains a compiler that can convert all HTML output
1193 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1196 # HTML files also contain an index, a table of contents, and you can search for
1197 # words in the documentation. The HTML workshop also contains a viewer for
1205 # file. You can add a path in front of the file if the result should not be
1219 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1232 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1233 # YES) or a normal table of contents ( NO) in the .chm file.
1248 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1279 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1340 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1342 # value is set to YES, a side panel will be generated containing a tree-like
1344 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1360 # Note that a value of 0 will completely suppress the enum values from appearing
1375 # external symbols imported via tag files in a separate window.
1382 # the HTML documentation. When you change the font size after a successful
1428 # MathJax. However, it is strongly recommended to install a local copy of
1442 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1450 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1454 # there is already a search function so this one should typically be disabled.
1456 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1464 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1472 # implemented using a web server instead of a web client using Javascript. There
1474 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1499 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1511 # search data is written to a file for indexing by an external tool. With the
1528 # all added to the same external search index. Each project needs to have a
1530 # to a relative location where the documentation can be found. The format is:
1545 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1597 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1599 # chapter. If it is left blank doxygen will generate a standard header. See
1601 # default header to a separate file.
1603 # Note: Only use a user-defined header if you know what you are doing! The
1604 # following commands have a special meaning inside the header: $title,
1613 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1615 # chapter. If it is left blank doxygen will generate a standard footer.
1617 # Note: Only use a user-defined footer if you know what you are doing!
1633 # makes the output suitable for online browsing using a PDF viewer.
1640 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1692 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1721 # file, i.e. a series of assignments. You only have to provide replacements,
1747 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1757 # man pages. In case the manual section does not start with a number, the number
1784 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1792 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1798 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1824 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1847 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1864 # formatted so it can be parsed by a human reader. This is useful if you want to
1893 # performed. Macro expansion can be done in a controlled way by setting
1909 # INCLUDE_PATH will be searched if a #include is found.
1932 # gcc). The argument of the tag is a list of macros of the form: name or
1934 # is assumed. To prevent a macro definition from being undefined via #undef or
1941 # tag can be used to specify a list of macro names that should be expanded. The
1943 # tag if you want to use a different macro definition that overrules the
1950 # remove all refrences to function-like macros that are alone on a line, have an
1951 # all uppercase name, and do not end with a semicolon. Such function macros are
1965 # a tag file without this location is as follows:
1973 # the path). If a tag file is not located in the directory in which doxygen is
1978 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2014 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2040 # and usage relations if the target is undocumented or is not a class.
2047 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2056 # processors available in the system. You can set it explicitly to a value
2064 # When you want a differently looking font n the dot files that doxygen
2066 # sure dot is able to find the font, which can be done by putting it in a
2082 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2088 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2096 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2105 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2113 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2142 # YES then doxygen will generate a graph for each documented file showing the
2151 # set to YES then doxygen will generate a graph for each documented file showing
2159 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2162 # Note that enabling this option will significantly increase the time of a run.
2170 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2173 # Note that enabling this option will significantly increase the time of a run.
2182 # hierarchy of all classes instead of a textual one.
2189 # dependencies a directory has on other directories in a graphical way. The
2211 # Note that this requires a modern browser other than Internet Explorer. Tested
2246 # that will be shown in the graph. If the number of nodes in a graph becomes
2248 # by representing a node as a red box. Note that doxygen if the number of direct
2249 # children of the root node in a graph is already larger than
2251 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2259 # root by following a path via at most 3 edges will be shown. Nodes that lay
2262 # note that the size of a graph can be further restricted by
2263 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2269 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2274 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2290 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page