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

3 # This file describes the settings to be used by the documentation system
9 # All text after a single hash (#) is considered a comment and will be ignored.
12 # For lists, items can also be appended using:
14 # Values that contain spaces should be placed between quotes (\" \").
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
66 # option can be useful when feeding doxygen a huge amount of source files, where
99 # brief descriptions will be completely suppressed.
106 # as the leading text of the brief description, will be stripped from the text
125 # operators of the base classes will not be shown.
132 # shortest path that makes the file name unique will be used
137 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
139 # part of the path. The tag can be used to show relative paths in the file list.
144 # will be relative from the directory where doxygen is started.
149 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
159 # less readable) file names. This can be useful is your file systems doesn't
182 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
184 # a brief description. This used to be the default behavior. The new default is
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
225 # This tag can be used to specify a number of word-keyword mappings (TCL only).
233 # instance, some of the names that are used will be different. The list of all
234 # members will be omitted, etc.
241 # for that language. For instance, namespaces will be presented as packages,
287 # be prevented in individual cases by by putting a % sign in front of the word
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
338 # subgrouping. Alternatively, this can be done per class using the
356 # with only public data fields or simple typedef fields will be shown inline in
369 # namespace, or class. And the struct will be named TypeS. This can typically be
376 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
377 # cache is used to resolve symbols given their name and scope. Since this can be
395 # class members and static file members will be hidden unless the
404 # be included in the documentation.
410 # scope will be included in the documentation.
415 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
422 # locally in source files will be included in the documentation. If set to NO
437 # If this flag is set to YES, the members of anonymous namespaces will be
439 # 'anonymous_namespace{file}', where file will be replaced with the base name of
448 # members will be included in the various overviews, but no documentation
456 # to NO these classes will be included in the various overviews. This option has
463 # (class|struct|union) declarations. If set to NO these declarations will be
471 # blocks will be appended to the function's detailed documentation block.
478 # will be excluded. Set it to YES to include the internal documentation.
494 # scope will be hidden.
558 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
560 # be sorted only by class name, not including the namespace part.
578 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
585 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
592 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
598 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
605 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
614 # it will be hidden. Use a value of 0 to hide initializers completely. The
615 # appearance of the value of individual variables and macros / defines can be
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
658 # will be used as the name of the layout file.
666 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
667 # the reference definitions. This must be a list of .bib files. The .bib
669 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
670 # For LaTeX the style of the bibliography can be controlled using
681 # The QUIET tag can be used to turn on/off the messages that are generated to
688 # The WARNINGS tag can be used to turn on/off the warning messages that are
699 # will automatically be disabled.
712 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
722 # will be replaced by the file and line number from which the warning originated
724 # be replaced by the version of the file (if it could be obtained via
730 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
731 # messages should be written. If left blank the output is written to standard
748 # This tag can be used to specify the character encoding of the source files
768 # The RECURSIVE tag can be used to specify whether or not subdirectories should
769 # be searched for input files as well.
774 # The EXCLUDE tag can be used to specify files and/or directories that should be
783 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
799 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
800 # (namespaces, classes, functions, etc.) that should be excluded from the
801 # output. The symbol name can be a fully qualified name, a word, or if the
810 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
823 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
824 # searched for input files to be used with the \include or \dontinclude commands
830 # The IMAGE_PATH tag can be used to specify one or more files or directories
831 # that contain images that are to be included in the documentation (see the
836 # The INPUT_FILTER tag can be used to specify a program that doxygen should
845 # will be ignored.
849 # or removed, the anchors will not be placed correctly.
853 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
863 # INPUT_FILTER ) will also be used to filter the input files that are used for
869 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
878 # is part of the input, its contents will be placed on the main page
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
889 # generated. Documented entities will be cross-referenced with these sources.
911 # function all documented functions referencing it will be listed.
917 # all documented entities called/used by that function will be listed.
953 # tools must be available from the command line (i.e. in the search path).
975 # compounds will be generated. Enable this if the project contains a lot of
981 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
982 # which the alphabetical index list will be split.
989 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
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
1006 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1013 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1020 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1040 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1043 # footer and what special commands can be used inside the footer. See also
1050 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1051 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1062 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1073 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1074 # other source files which should be copied to the HTML output directory. Note
1075 # that these files will be copied to the base HTML output directory. Use the
1078 # files will be copied as-is; there are no commands or markers available.
1122 # documentation will contain sections that can be hidden and shown after the
1142 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1143 # generated that can be used as input for Apple's Xcode 3 integrated development
1158 # (such as a company or product suite) can be grouped.
1165 # set bundle. This should be a reverse domain-name style string, e.g.
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
1204 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1205 # file. You can add a path in front of the file if the result should not be
1211 # The HHC_LOCATION tag can be used to specify the location (absolute path
1214 # The file has to be specified with full path.
1220 # YES) or that it should be included in the master .chm file ( NO).
1239 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1247 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1248 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1255 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1302 # The QHG_LOCATION tag can be used to specify the location of Qt's
1309 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1313 # to be copied into the plugins directory of eclipse. The name of the directory
1314 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1315 # After copying Eclipse needs to be restarted before the help appears.
1330 # be necessary to disable the index and replace it with your own. The
1331 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1341 # structure should be generated to display hierarchical information. If the tag
1342 # value is set to YES, a side panel will be generated containing a tree-like
1357 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1367 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1384 # output directory to force them to be regenerated.
1412 # When MathJax is enabled you can set the default output format to be used for
1426 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1435 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1436 # extension names that should be enabled during MathJax rendering. For example
1442 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1443 # of code that will be used on startup of the MathJax code. See the MathJax site
1454 # there is already a search function so this one should typically be disabled.
1455 # For large projects the javascript based search engine can be slow, then
1460 # key> to jump into the search results window, the results can be navigated
1462 # the search. The filter options can be selected when the cursor is inside the
1471 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1476 # enabled the indexing and searching needs to be provided by external tools. See
1485 # which needs to be processed by an external indexer. Doxygen will invoke an
1512 # SEARCHDATA_FILE tag the name of this file can be specified.
1519 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1526 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
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
1546 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1553 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1564 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1572 # documents. This may be useful for small projects and may help to save some
1579 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1588 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1589 # that should be included in the LaTeX output. To get the times font for
1592 # If left blank no extra packages will be included.
1597 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1613 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1622 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1623 # other source files which should be copied to the LATEX_OUTPUT output
1624 # directory. Note that the files will be copied as-is; there are no commands or
1673 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1692 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1693 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1701 # documents. This may be useful for small projects and may help to save some
1731 # similar to doxygen's config file. A template extensions file can be generated
1747 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1748 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1749 # it. A directory man3 will be created inside the directory specified by
1768 # them the man command would be unable to find the correct page.
1784 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1785 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
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
1818 # that can be used to generate PDF.
1823 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1824 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1856 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1863 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1864 # formatted so it can be parsed by a human reader. This is useful if you want to
1866 # size of the Perl module output will be much smaller and Perl will parse it
1892 # in the source code. If set to NO only conditional compilation will be
1893 # performed. Macro expansion can be done in a controlled way by setting
1909 # INCLUDE_PATH will be searched if a #include is found.
1915 # The INCLUDE_PATH tag can be used to specify one or more directories that
1916 # contain include files that are not input files but should be processed by the
1924 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1930 # The PREDEFINED tag can be used to specify one or more macro names that are
1941 # tag can be used to specify a list of macro names that should be expanded. The
1942 # macro definition that is found in the sources will be used. Use the PREDEFINED
1963 # The TAGFILES tag can be used to specify one or more tag files. For each tag
1964 # file the location of the external documentation should be added. The format of
1969 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
1984 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1985 # class index. If set to NO only the inherited external classes will be listed.
1990 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
1991 # the modules index. If set to NO, only the current project's groups will be
1997 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
1999 # be listed.
2004 # The PERL_PATH should be the absolute path and name of the perl script
2027 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2035 # If left empty dia is assumed to be found in the default search path.
2066 # sure dot is able to find the font, which can be done by putting it in a
2074 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2122 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2124 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2163 # So in most cases it will be better to enable call graphs for selected
2174 # So in most cases it will be better to enable caller graphs for selected
2197 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2208 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2220 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2221 # found. If left blank, it is assumed the dot tool can be found in the path.
2226 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2233 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2239 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2245 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2246 # that will be shown in the graph. If the number of nodes in a graph becomes
2250 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2251 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2257 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2259 # root by following a path via at most 3 edges will be shown. Nodes that lay
2260 # further from the root node will be omitted. Note that setting this option to 1
2262 # note that the size of a graph can be further restricted by