doc/gbuild/doxygen.cfg

31 # Values that contain spaces should be placed between quotes (" ")
38 # that follow. The default is UTF-8 which is also the encoding used for all
46 # by quotes) that should identify the project.
86 # include brief member descriptions after the members that are listed in
100 # that is used to form the text in various listings. Each string
118 # inherited members of a class in the documentation of that class as if those
126 # to NO the shortest path that makes the file name unique will be used.
143 # definition is used. Otherwise one should specify the include paths that
179 # member inherits the documentation from any documented member that it
186 # be part of the file/class/namespace that contains it.
195 # This tag can be used to specify a number of aliases that acts
205 # sources only. Doxygen will then generate output that is more tailored for C.
206 # For instance, some of the names that are used will be different. The list
212 # sources only. Doxygen will then generate output that is more tailored for
219 # sources only. Doxygen will then generate output that is more tailored for
225 # sources. Doxygen will then generate output that is tailored for
246 # diagrams that involve STL classes more complete and accurate.
279 # subgroup of that type (e.g. under the Public Functions section). Set it to
290 # be useful for C code in case the coding convention dictates that all compound
303 # performance by keeping more symbols in memory. Note that the value works on
348 # name of the file that contains the anonymous namespace. By default
362 # undocumented classes that are normally visible in the class hierarchy.
383 # that is typed after a \internal command is included. If the tag is set
404 # will put a list of the files that are included by a file in the documentation
405 # of that file.
485 # list will mention the files that were used to generate the documentation.
508 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
520 # in an output format independent way. The create the layout file that represents
531 # The QUIET tag can be used to turn on/off the messages that are generated
536 # The WARNINGS tag can be used to turn on/off the warning messages that are
550 # parameters in a documented function, or documenting parameters that
556 # functions that are documented, but have no documentation for their parameters
563 # The WARN_FORMAT tag determines the format of the warning messages that
582 # The INPUT tag can be used to specify the files and/or directories that contain
590 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
612 # The EXCLUDE tag can be used to specify files and/or directories that should
619 # directories that are symbolic links (a Unix filesystem feature) are excluded
626 # certain files from those directories. Note that the wildcards are matched
633 # (namespaces, classes, functions, etc.) that should be excluded from the
641 # directories that contain example code fragments that are included (see
661 # directories that contain image that are included in the documentation (see
666 # The INPUT_FILTER tag can be used to specify a program that doxygen should
670 # input file. Doxygen will then use the output that the filter program writes
724 # called/used by that function will be listed.
768 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
807 # style sheet that is used by each HTML page. It can be used to
809 # will generate a default style sheet. Note that doxygen will try to copy
822 # documentation will contain sections that can be hidden and shown after the
823 # page has loaded. For this to work a browser that supports
830 # will be generated that can be used as input for Apple's Xcode 3
833 # HTML output directory. Running make will produce the docset in that
835 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
848 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
856 # will be generated that can be used as input for tools like the
877 # controls if a separate .chi index file is generated (YES) or that
900 # are set, an additional index file will be generated that can be used as input for
955 # that doxygen will group on one line in the generated HTML documentation.
962 # containing a tree-like index structure (just like the one that
963 # is generated for HTML Help). For this to work a browser that supports
983 # as images in the HTML documentation. The default is 10. Note that
1022 # The PAPER_TYPE tag can be used to set the paper type that is used
1029 # packages that should be included in the LaTeX output.
1040 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1088 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1123 # The MAN_EXTENSION tag determines the extension that is added to
1141 # generate an XML file that captures the structure of
1166 # and cross-referencing information) to the XML output. Note that
1177 # that captures the structure of the code including all
1178 # documentation. Note that this feature is still experimental
1188 # generate a Perl module file that captures the structure of
1189 # the code including all documentation. Note that this
1246 # The INCLUDE_PATH tag can be used to specify one or more directories that
1247 # contain include files that are not input files but should be processed by
1259 # The PREDEFINED tag can be used to specify one or more macro names that
1270 # this tag can be used to specify a list of macro names that should be expanded.
1271 # The macro definition that is found in the sources will be used.
1277 # doxygen's preprocessor will remove all function-like macros that are alone
1300 # Note that each tag file must have a unique name
1308 # a tag file that is based on the input files it reads.
1335 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1365 # directory and reference it in all dot files that doxygen generates. This
1426 # documented header file showing the documented files that directly or
1433 # or class method. Note that enabling this option will significantly increase
1441 # or class method. Note that enabling this option will significantly increase
1470 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1471 # contain dot files that are included in the documentation (see the
1477 # nodes that will be shown in the graph. If the number of nodes in a graph
1479 # visualized by representing a node as a red box. Note that doxygen if the
1482 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1487 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1489 # that lay further from the root node will be omitted. Note that setting this
1491 # code bases. Also note that the size of a graph can be further restricted by
1518 # remove the intermediate dot files that are used to generate