dmx/doxygen/doxygen.conf.in

9 # All text after a single hash (#) is considered a comment and will be ignored.
51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
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.
63 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
65 # will distribute the generated files over these directories. Enabling this
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
82 # documentation generated by doxygen is written. Doxygen will use this
96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
107 # brief descriptions will be completely suppressed.
114 # as the leading text of the brief description, will be stripped from the text
124 # doxygen will generate a detailed section even if there is only a brief
130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
133 # operators of the base classes will not be shown.
138 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
140 # shortest path that makes the file name unique will be used
152 # will be relative from the directory where doxygen is started.
166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
208 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
209 # page for each member. If set to NO, the documentation of a member will be part
226 # will allow you to put the command \sideeffect (or @sideeffect) in the
227 # documentation, which will result in a user-defined paragraph with heading
235 # will allow you to use the command class in the itcl::class meaning.
240 # only. Doxygen will then generate output that is more tailored for C. For
241 # instance, some of the names that are used will be different. The list of all
242 # members will be omitted, etc.
248 # Python sources only. Doxygen will then generate output that is more tailored
249 # for that language. For instance, namespaces will be presented as packages,
250 # qualified scopes will look different, etc.
256 # sources. Doxygen will then generate output that is tailored for Fortran.
262 # sources. Doxygen will then generate output that is tailored for VHDL.
322 # will parse them like normal C++ but will assume all classes use public instead
329 # getter and setter methods for a property. Setting this option to YES will make
331 # This will only work if the methods are indeed getting or setting a simple
339 # tag is set to YES then doxygen will reuse the documentation of the first
374 # with only public data fields or simple typedef fields will be shown inline in
385 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
386 # with name TypeT. When disabled the typedef will appear as a member of a file,
387 # namespace, or class. And the struct will be named TypeS. This can typically be
398 # doxygen will become slower. If the cache is too large, memory is wasted. The
401 # symbols. At the end of a run doxygen will report the cache usage and suggest
411 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
413 # class members and static file members will be hidden unless the
415 # Note: This will also disable the warnings about undocumented members that are
421 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
428 # scope will be included in the documentation.
433 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
440 # locally in source files will be included in the documentation. If set to NO,
455 # If this flag is set to YES, the members of anonymous namespaces will be
457 # 'anonymous_namespace{file}', where file will be replaced with the base name of
464 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
466 # members will be included in the various overviews, but no documentation
472 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
474 # to NO, these classes will be included in the various overviews. This option
480 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
481 # (class|struct|union) declarations. If set to NO, these declarations will be
487 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
489 # blocks will be appended to the function's detailed documentation block.
496 # will be excluded. Set it to YES to include the internal documentation.
501 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
510 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
512 # scope will be hidden.
517 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
519 # YES the compound reference will be hidden.
524 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
530 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
537 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
549 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
551 # name. If set to NO, the members will appear in declaration order.
556 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
558 # name. If set to NO, the members will appear in declaration order. Note that
559 # this will also influence the order of the classes in the class list.
564 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
566 # destructors are listed first. If set to NO the constructors will appear in the
576 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
577 # of group names into alphabetical order. If set to NO the group names will
583 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
584 # fully-qualified names, including namespaces. If set to NO, the class list will
594 # type resolution of all parameters of a function it will reject a match between
597 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
637 # it will be hidden. Use a value of 0 to hide initializers completely. The
647 # list will mention the files that were used to generate the documentation.
653 # will remove the Files entry from the Quick Index and from the Folder Tree View
660 # page. This will remove the Namespaces entry from the Quick Index and from the
668 # the version control system). Doxygen will invoke the program by executing (via
676 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
681 # will be used as the name of the layout file.
684 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
719 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
721 # will automatically be disabled.
726 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
736 # value. If set to NO, doxygen will only warn about wrong or incomplete
744 # will be replaced by the file and line number from which the warning originated
745 # and the warning text. Optionally the format may contain $version, which will
855 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
869 # invoke to filter for each input file. Doxygen will invoke the filter program
875 # name of an input file. Doxygen will then use the output that the filter
877 # will be ignored.
881 # or removed, the anchors will not be placed correctly.
886 # basis. Doxygen will compare the file name with each pattern and apply the
895 # INPUT_FILTER) will also be used to filter the input files that are used for
902 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
910 # is part of the input, its contents will be placed on the main page
920 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
921 # generated. Documented entities will be cross-referenced with these sources.
929 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
935 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
937 # Fortran comments will always remain visible.
943 # function all documented functions referencing it will be listed.
949 # all documented entities called/used by that function will be listed.
956 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
963 # source code will show a tooltip with additional information such as prototype,
965 # will make the HTML file larger and loading of large files a bit slower, you
972 # If the USE_HTAGS tag is set to YES then the references to source code will
975 # (see http://www.gnu.org/software/global/global.html). You will need version
984 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
988 # source code will now point to the output of htags.
994 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1007 # compounds will be generated. Enable this if the project contains a lot of
1014 # which the alphabetical index list will be split.
1020 # In case all classes in a project start with a common prefix, all classes will
1032 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1037 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1038 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1053 # each generated HTML page. If the tag is left blank doxygen will generate a
1073 # generated HTML page. If the tag is left blank doxygen will generate a standard
1084 # the HTML output. If left blank doxygen will generate a default style sheet.
1088 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1099 # Doxygen will copy the style sheet files to the output directory.
1109 # that these files will be copied to the base HTML output directory. Use the
1112 # files will be copied as-is; there are no commands or markers available.
1118 # will adjust the colors in the style sheet and background images according to
1129 # in the HTML output. For a value of 0 the output will use grayscales only. A
1130 # value of 255 will produce the most vivid colors.
1148 # page will contain the date and time when the page was generated. Setting this
1157 # documentation will contain sections that can be hidden and shown after the
1166 # and collapse entries dynamically later on. Doxygen will expand the tree to
1169 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1170 # representing an infinite number of entries and will result in a full expanded
1177 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1180 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1181 # Makefile in the HTML output directory. Running make will produce the docset in
1182 # that directory and running make install will install the docset in
1183 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1201 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1229 # files are now used as the Windows 98 help format, and will replace the old
1248 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1283 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1339 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1345 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1378 # value is set to YES, a side panel will be generated containing a tree-like
1394 # doxygen will group on one line in the generated HTML documentation.
1396 # Note that a value of 0 will completely suppress the enum values from appearing
1410 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1479 # of code that will be used on startup of the MathJax code. See the MathJax site
1486 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1507 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1510 # setting. When disabled, doxygen will generate a PHP script for searching and
1519 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1521 # which needs to be processed by an external indexer. Doxygen will invoke an
1536 # which will return the search results when EXTERNAL_SEARCH is enabled.
1576 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1581 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1582 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1631 # If left blank no extra packages will be included.
1638 # chapter. If it is left blank doxygen will generate a standard header. See
1645 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1654 # chapter. If it is left blank doxygen will generate a standard footer. See
1666 # will copy the style sheet files to the output directory.
1676 # directory. Note that the files will be copied as-is; there are no commands or
1683 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1691 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1699 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1700 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1708 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1715 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1734 # page will contain the date and time when the page was generated. Setting this
1745 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1752 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1753 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1768 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1769 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1797 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1811 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1817 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1818 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1819 # it. A directory man3 will be created inside the directory specified by
1843 # will generate one additional man file for each entity documented in the real
1855 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1861 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1862 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1869 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1871 # the XML output. Note that enabling this will significantly increase the size
1882 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1888 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1889 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1896 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1898 # information) to the DOCBOOK output. Note that enabling this will significantly
1909 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1921 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1929 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1937 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1940 # size of the Perl module output will be much smaller and Perl will parse it
1959 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1965 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1966 # in the source code. If set to NO, only conditional compilation will be
1983 # INCLUDE_PATH will be searched if a #include is found.
1998 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
2019 # macro definition that is found in the sources will be used. Use the PREDEFINED
2026 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2029 # are typically used for boiler-plate code, and will confuse the parser if not
2055 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2061 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2062 # the class index. If set to NO, only the inherited external classes will be
2068 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2069 # in the modules index. If set to NO, only the current project's groups will be
2075 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2076 # the related pages index. If set to NO, only the current project's pages will
2092 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2102 # command. Doxygen will then run the mscgen tool (see:
2110 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2117 # If set to YES the inheritance and collaboration graphs will hide inheritance
2123 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2133 # to run in parallel. When set to 0 doxygen will base this on the number of
2159 # By default doxygen will tell dot to use the default font as specified with
2166 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2168 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2174 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2183 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2190 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2212 # collaboration graphs will show the relations between templates and their
2220 # YES then doxygen will generate a graph for each documented file showing the
2229 # set to YES then doxygen will generate a graph for each documented file showing
2237 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2240 # Note that enabling this option will significantly increase the time of a run.
2241 # So in most cases it will be better to enable call graphs for selected
2249 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2252 # Note that enabling this option will significantly increase the time of a run.
2253 # So in most cases it will be better to enable caller graphs for selected
2261 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2268 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2331 # PlantUML is not used or called during a preprocessing step. Doxygen will
2333 # will not generate output for the diagram.
2343 # that will be shown in the graph. If the number of nodes in a graph becomes
2344 # larger than this value, doxygen will truncate the graph, which is visualized
2347 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2356 # root by following a path via at most 3 edges will be shown. Nodes that lay
2357 # further from the root node will be omitted. Note that setting this option to 1
2387 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2395 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot