doc/gbuild/doxygen.cfg

10 #  with the License.  You may obtain a copy of the License at
24 # doxygen (www.doxygen.org) for a project
26 # All text after a hash (#) is considered a comment and will be ignored
45 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
50 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
58 # If a relative path is entered, it will be relative to the location
66 # Enabling this option can be useful when feeding doxygen a huge amount of
93 # the brief description of a member or function before the detailed description.
99 # This tag implements a quasi-intelligent brief description abbreviator
107 # "represents" "a" "an" "the"
112 # Doxygen will generate a detailed section even if there is only a brief
118 # inherited members of a class in the documentation of that class as if those
131 # can be used to strip a user-defined part of the path. Stripping is
139 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
140 # the path mentioned in the documentation of a class, which tells
141 # the reader which header file to include in order to use a class.
155 # will interpret the first line (until the first dot) of a JavaDoc-style
158 # (thus requiring an explicit @brief command for a brief description.)
163 # interpret the first line (until the first dot) of a Qt-style
166 # an explicit \brief command for a brief description.)
171 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
172 # comments) as a brief description. This used to be the default behaviour.
173 # The new default is to treat a multi-line C++ comment block as a detailed
185 # a new page for each member. If set to NO, the documentation of a member will
190 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
195 # This tag can be used to specify a number of aliases that acts
199 # will result in a user-defined paragraph with heading "Side Effects:".
231 # With this tag you can assign which parser to use for a given extension.
232 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
233 # The format is ext=language, where ext is a file extension, and language is one of
242 # to include (a tag file for) the STL sources as input, then you should
262 # and setter methods for a property. Setting this option to YES (the default)
263 # will make doxygen to replace the get and set methods by a property in the
265 # setting a simple type. If this is not the case, or you want to show the
273 # all members of a group must be documented explicitly.
278 # the same type (for instance a group of public functions) to be put as a
285 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
287 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
288 # with name TypeT. When disabled the typedef will appear as a member of a file,
299 # probably good enough. For larger projects a too small cache size can cause
301 # causing a significant performance penality.
304 # a logarithmic scale so increasing the size by one will rougly double the
307 # corresponding to a cache size of 2^16 = 65536 symbols
322 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
327 # If the EXTRACT_STATIC tag is set to YES all static members of a file
346 # extracted and appear in the documentation as a namespace called
376 # documentation blocks found inside the body of a function.
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
409 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
474 # the initial value of a variable or define consists of for it to appear in
476 # here it will be hidden. Use a value of 0 to hide initializers completely.
508 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
518 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
521 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
550 # parameters in a documented function, or documenting parameters that
572 # The WARN_LOGFILE tag can be used to specify a file to which warning
613 # excluded from the INPUT source files. This way you can easily exclude a
614 # subdirectory from a directory tree whose root is specified with the INPUT tag.
619 # directories that are symbolic links (a Unix filesystem feature) are excluded
634 # output. The symbol name can be a fully qualified name, a word, or if the
635 # wildcard * is used, a substring. Examples: ANamespace, AClass,
666 # The INPUT_FILTER tag can be used to specify a program that doxygen should
677 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
680 # filter if there is a match.
681 # The filters are a list of the form:
698 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
745 # will generate a verbatim copy of the header file for each class for
756 # contains a lot of classes, structs, unions or interfaces.
762 # in which this list will be split (can be a number in the range [1..20])
766 # In case all classes in a project start with a common prefix, all
783 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
794 # The HTML_HEADER tag can be used to specify a personal HTML header for
795 # each generated HTML page. If it is left blank doxygen will generate a
800 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
801 # each generated HTML page. If it is left blank doxygen will generate a
806 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
809 # will generate a default style sheet. Note that doxygen will try to copy
817 # NO a bullet list will be used.
823 # page has loaded. For this to work a browser that supports
832 # To create a documentation set, doxygen will generate a Makefile in the
843 # documentation sets from a single provider (such as a company or product suite)
848 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
849 # should uniquely identify the documentation set bundle. This should be a
857 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
864 # can add a path in front of the file if the result should not be
877 # controls if a separate .chi index file is generated (YES) or that
889 # controls whether a binary table of contents is generated (YES) or a
901 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
924 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
931 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Fil…
937 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter …
959 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
961 # If the tag value is set to FRAME, a side panel will be generated
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
968 # and Class Hierarchy pages using a tree view instead of an ordered list;
984 # when you change the font size after a successful doxygen run you need
1000 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1033 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1035 # the first chapter. If it is left blank doxygen will generate a
1043 # This makes the output suitable for online browsing using a pdf viewer.
1048 # plain latex in the generated Makefile. Set this option to YES to get a
1077 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1098 # config file, i.e. a series of assignments. You only have to provide
1118 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1147 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1153 # which can be used by a validating XML parser to check the
1159 # which can be used by a validating XML parser to check the
1188 # generate a Perl module file that captures the structure of
1202 # nicely formatted so it can be parsed by a human reader.
1230 # compilation will be performed. Macro expansion can be done in a controlled
1242 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1261 # gcc). The argument of the tag is a list of macros of the form: name
1263 # omitted =1 is assumed. To prevent a macro definition from being
1270 # this tag can be used to specify a list of macro names that should be expanded.
1272 # Use the PREDEFINED tag if you want to use a different macro definition.
1278 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1290 # can be added for each tagfile. The format of a tag file without
1298 # URLs. If a location is present for each tag, the installdox tool
1300 # Note that each tag file must have a unique name
1302 # If a tag file is not located in the directory in which doxygen
1307 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1308 # a tag file that is based on the input files it reads.
1334 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1336 # this option is superseded by the HAVE_DOT option below. This is only a
1353 # or is not a class.
1358 # available from the path. This tool is part of Graphviz, a graph visualization
1364 # By default doxygen will write a font called FreeSans.ttf to the output
1367 # these (or just want a differently looking font) you can specify the font name
1369 # which can be done by putting it in a standard location or by setting the
1381 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1388 # will generate a graph for each documented class showing the direct and
1395 # will generate a graph for each documented class showing the direct and
1402 # will generate a graph for groups, showing the direct groups dependencies
1407 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1418 # tags are set to YES then doxygen will generate a graph for each documented
1425 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1432 # doxygen will generate a call dependency graph for every global function
1434 # the time of a run. So in most cases it will be better to enable call graphs
1440 # doxygen will generate a caller dependency graph for every global function
1442 # the time of a run. So in most cases it will be better to enable caller
1448 # will graphical hierarchy of all classes instead of a textual one.
1453 # then doxygen will show the dependencies a directory has on other directories
1454 # in a graphical way. The dependency relations are determined by the #include
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
1480 # number of direct children of the root node in a graph is already larger than
1482 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1488 # from the root by following a path via at most 3 edges will be shown. Nodes
1491 # code bases. Also note that the size of a graph can be further restricted by
1492 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1496 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1500 # a graph (i.e. they become hard to read).
1512 # generate a legend page explaining the meaning of the various boxes and
1527 # The SEARCHENGINE tag specifies whether or not a search engine should be