Fix compile error for IBM VMX on ppc64
[gromacs/AngularHB.git] / src / external / tng_io / Doxyfile.in
blob27ca707b15822852083e95789d44ec85e64cca0b
1 # Doxyfile 1.7.6.1
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project.
6 # All text after a hash (#) is considered a comment and will be ignored.
7 # The format is:
8 #       TAG = value [value, ...]
9 # For lists items can also be appended using:
10 #       TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ").
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
23 DOXYFILE_ENCODING      = UTF-8
25 # The PROJECT_NAME tag is a single word (or sequence of words) that should
26 # identify the project. Note that if you do not use Doxywizard you need
27 # to put quotes around the project name if it contains spaces.
29 PROJECT_NAME           = "TNG API"
31 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
32 # This could be handy for archiving the generated documentation or
33 # if some version control system is used.
35 PROJECT_NUMBER         = "@TNG_IO_VERSION@"
37 # Using the PROJECT_BRIEF tag one can provide an optional one line description
38 # for a project that appears at the top of each page and should give viewer
39 # a quick idea about the purpose of the project. Keep the description short.
41 PROJECT_BRIEF          = "A flexible binary trajectory format"
43 # With the PROJECT_LOGO tag one can specify an logo or icon that is
44 # included in the documentation. The maximum height of the logo should not
45 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
46 # Doxygen will copy the logo to the output directory.
48 PROJECT_LOGO           =
50 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51 # base path where the generated documentation will be put.
52 # If a relative path is entered, it will be relative to the location
53 # where doxygen was started. If left blank the current directory will be used.
55 OUTPUT_DIRECTORY       = @PROJECT_BINARY_DIR@/Documentation
57 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58 # 4096 sub-directories (in 2 levels) under the output directory of each output
59 # format and will distribute the generated files over these directories.
60 # Enabling this option can be useful when feeding doxygen a huge amount of
61 # source files, where putting all generated files in the same directory would
62 # otherwise cause performance problems for the file system.
64 CREATE_SUBDIRS         = NO
66 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
67 # documentation generated by doxygen is written. Doxygen will use this
68 # information to generate all constant output in the proper language.
69 # The default language is English, other supported languages are:
70 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
77 OUTPUT_LANGUAGE        = English
79 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80 # include brief member descriptions after the members that are listed in
81 # the file and class documentation (similar to JavaDoc).
82 # Set to NO to disable this.
84 BRIEF_MEMBER_DESC      = YES
86 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87 # the brief description of a member or function before the detailed description.
88 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89 # brief descriptions will be completely suppressed.
91 REPEAT_BRIEF           = YES
93 # This tag implements a quasi-intelligent brief description abbreviator
94 # that is used to form the text in various listings. Each string
95 # in this list, if found as the leading text of the brief description, will be
96 # stripped from the text and the result after processing the whole list, is
97 # used as the annotated text. Otherwise, the brief description is used as-is.
98 # If left blank, the following values are used ("$name" is automatically
99 # replaced with the name of the entity): "The $name class" "The $name widget"
100 # "The $name file" "is" "provides" "specifies" "contains"
101 # "represents" "a" "an" "the"
103 ABBREVIATE_BRIEF       =
105 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
106 # Doxygen will generate a detailed section even if there is only a brief
107 # description.
109 ALWAYS_DETAILED_SEC    = NO
111 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
112 # inherited members of a class in the documentation of that class as if those
113 # members were ordinary class members. Constructors, destructors and assignment
114 # operators of the base classes will not be shown.
116 INLINE_INHERITED_MEMB  = NO
118 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
119 # path before files name in the file list and in the header files. If set
120 # to NO the shortest path that makes the file name unique will be used.
122 FULL_PATH_NAMES        = YES
124 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
125 # can be used to strip a user-defined part of the path. Stripping is
126 # only done if one of the specified strings matches the left-hand part of
127 # the path. The tag can be used to show relative paths in the file list.
128 # If left blank the directory from which doxygen is run is used as the
129 # path to strip.
131 STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@/src/lib
133 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
134 # the path mentioned in the documentation of a class, which tells
135 # the reader which header file to include in order to use a class.
136 # If left blank only the name of the header file containing the class
137 # definition is used. Otherwise one should specify the include paths that
138 # are normally passed to the compiler using the -I flag.
140 STRIP_FROM_INC_PATH    =
142 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
143 # (but less readable) file names. This can be useful if your file system
144 # doesn't support long names like on DOS, Mac, or CD-ROM.
146 SHORT_NAMES            = NO
148 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
149 # will interpret the first line (until the first dot) of a JavaDoc-style
150 # comment as the brief description. If set to NO, the JavaDoc
151 # comments will behave just like regular Qt-style comments
152 # (thus requiring an explicit @brief command for a brief description.)
154 JAVADOC_AUTOBRIEF      = NO
156 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
157 # interpret the first line (until the first dot) of a Qt-style
158 # comment as the brief description. If set to NO, the comments
159 # will behave just like regular Qt-style comments (thus requiring
160 # an explicit \brief command for a brief description.)
162 QT_AUTOBRIEF           = NO
164 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
165 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
166 # comments) as a brief description. This used to be the default behaviour.
167 # The new default is to treat a multi-line C++ comment block as a detailed
168 # description. Set this tag to YES if you prefer the old behaviour instead.
170 MULTILINE_CPP_IS_BRIEF = NO
172 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
173 # member inherits the documentation from any documented member that it
174 # re-implements.
176 INHERIT_DOCS           = YES
178 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
179 # a new page for each member. If set to NO, the documentation of a member will
180 # be part of the file/class/namespace that contains it.
182 SEPARATE_MEMBER_PAGES  = NO
184 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
185 # Doxygen uses this value to replace tabs by spaces in code fragments.
187 TAB_SIZE               = 8
189 # This tag can be used to specify a number of aliases that acts
190 # as commands in the documentation. An alias has the form "name=value".
191 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
192 # put the command \sideeffect (or @sideeffect) in the documentation, which
193 # will result in a user-defined paragraph with heading "Side Effects:".
194 # You can put \n's in the value part of an alias to insert newlines.
196 ALIASES                =
198 # This tag can be used to specify a number of word-keyword mappings (TCL only).
199 # A mapping has the form "name=value". For example adding
200 # "class=itcl::class" will allow you to use the command class in the
201 # itcl::class meaning.
203 TCL_SUBST              =
205 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
206 # sources only. Doxygen will then generate output that is more tailored for C.
207 # For instance, some of the names that are used will be different. The list
208 # of all members will be omitted, etc.
210 OPTIMIZE_OUTPUT_FOR_C  = YES
212 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
213 # sources only. Doxygen will then generate output that is more tailored for
214 # Java. For instance, namespaces will be presented as packages, qualified
215 # scopes will look different, etc.
217 OPTIMIZE_OUTPUT_JAVA   = NO
219 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
220 # sources only. Doxygen will then generate output that is more tailored for
221 # Fortran.
223 OPTIMIZE_FOR_FORTRAN   = NO
225 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
226 # sources. Doxygen will then generate output that is tailored for
227 # VHDL.
229 OPTIMIZE_OUTPUT_VHDL   = NO
231 # Doxygen selects the parser to use depending on the extension of the files it
232 # parses. With this tag you can assign which parser to use for a given extension.
233 # Doxygen has a built-in mapping, but you can override or extend it using this
234 # tag. The format is ext=language, where ext is a file extension, and language
235 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
236 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
237 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
238 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
239 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
241 EXTENSION_MAPPING      =
243 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
244 # to include (a tag file for) the STL sources as input, then you should
245 # set this tag to YES in order to let doxygen match functions declarations and
246 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
247 # func(std::string) {}). This also makes the inheritance and collaboration
248 # diagrams that involve STL classes more complete and accurate.
250 BUILTIN_STL_SUPPORT    = NO
252 # If you use Microsoft's C++/CLI language, you should set this option to YES to
253 # enable parsing support.
255 CPP_CLI_SUPPORT        = NO
257 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
258 # Doxygen will parse them like normal C++ but will assume all classes use public
259 # instead of private inheritance when no explicit protection keyword is present.
261 SIP_SUPPORT            = NO
263 # For Microsoft's IDL there are propget and propput attributes to indicate getter
264 # and setter methods for a property. Setting this option to YES (the default)
265 # will make doxygen replace the get and set methods by a property in the
266 # documentation. This will only work if the methods are indeed getting or
267 # setting a simple type. If this is not the case, or you want to show the
268 # methods anyway, you should set this option to NO.
270 IDL_PROPERTY_SUPPORT   = YES
272 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
273 # tag is set to YES, then doxygen will reuse the documentation of the first
274 # member in the group (if any) for the other members of the group. By default
275 # all members of a group must be documented explicitly.
277 DISTRIBUTE_GROUP_DOC   = NO
279 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
280 # the same type (for instance a group of public functions) to be put as a
281 # subgroup of that type (e.g. under the Public Functions section). Set it to
282 # NO to prevent subgrouping. Alternatively, this can be done per class using
283 # the \nosubgrouping command.
285 SUBGROUPING            = YES
287 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
288 # unions are shown inside the group in which they are included (e.g. using
289 # @ingroup) instead of on a separate page (for HTML and Man pages) or
290 # section (for LaTeX and RTF).
292 INLINE_GROUPED_CLASSES = NO
294 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
295 # unions with only public data fields will be shown inline in the documentation
296 # of the scope in which they are defined (i.e. file, namespace, or group
297 # documentation), provided this scope is documented. If set to NO (the default),
298 # structs, classes, and unions are shown on a separate page (for HTML and Man
299 # pages) or section (for LaTeX and RTF).
301 INLINE_SIMPLE_STRUCTS  = NO
303 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
304 # is documented as struct, union, or enum with the name of the typedef. So
305 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
306 # with name TypeT. When disabled the typedef will appear as a member of a file,
307 # namespace, or class. And the struct will be named TypeS. This can typically
308 # be useful for C code in case the coding convention dictates that all compound
309 # types are typedef'ed and only the typedef is referenced, never the tag name.
311 TYPEDEF_HIDES_STRUCT   = NO
313 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
314 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
315 # their name and scope. Since this can be an expensive process and often the
316 # same symbol appear multiple times in the code, doxygen keeps a cache of
317 # pre-resolved symbols. If the cache is too small doxygen will become slower.
318 # If the cache is too large, memory is wasted. The cache size is given by this
319 # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
320 # corresponding to a cache size of 2^16 = 65536 symbols.
322 LOOKUP_CACHE_SIZE      = 0
324 #---------------------------------------------------------------------------
325 # Build related configuration options
326 #---------------------------------------------------------------------------
328 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
329 # documentation are documented, even if no documentation was available.
330 # Private class members and static file members will be hidden unless
331 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
333 EXTRACT_ALL            = YES
335 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
336 # will be included in the documentation.
338 EXTRACT_PRIVATE        = NO
340 # If the EXTRACT_STATIC tag is set to YES all static members of a file
341 # will be included in the documentation.
343 EXTRACT_STATIC         = NO
345 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
346 # defined locally in source files will be included in the documentation.
347 # If set to NO only classes defined in header files are included.
349 EXTRACT_LOCAL_CLASSES  = NO
351 # This flag is only useful for Objective-C code. When set to YES local
352 # methods, which are defined in the implementation section but not in
353 # the interface are included in the documentation.
354 # If set to NO (the default) only methods in the interface are included.
356 EXTRACT_LOCAL_METHODS  = NO
358 # If this flag is set to YES, the members of anonymous namespaces will be
359 # extracted and appear in the documentation as a namespace called
360 # 'anonymous_namespace{file}', where file will be replaced with the base
361 # name of the file that contains the anonymous namespace. By default
362 # anonymous namespaces are hidden.
364 EXTRACT_ANON_NSPACES   = NO
366 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
367 # undocumented members of documented classes, files or namespaces.
368 # If set to NO (the default) these members will be included in the
369 # various overviews, but no documentation section is generated.
370 # This option has no effect if EXTRACT_ALL is enabled.
372 HIDE_UNDOC_MEMBERS     = NO
374 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
375 # undocumented classes that are normally visible in the class hierarchy.
376 # If set to NO (the default) these classes will be included in the various
377 # overviews. This option has no effect if EXTRACT_ALL is enabled.
379 HIDE_UNDOC_CLASSES     = NO
381 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
382 # friend (class|struct|union) declarations.
383 # If set to NO (the default) these declarations will be included in the
384 # documentation.
386 HIDE_FRIEND_COMPOUNDS  = NO
388 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
389 # documentation blocks found inside the body of a function.
390 # If set to NO (the default) these blocks will be appended to the
391 # function's detailed documentation block.
393 HIDE_IN_BODY_DOCS      = NO
395 # The INTERNAL_DOCS tag determines if documentation
396 # that is typed after a \internal command is included. If the tag is set
397 # to NO (the default) then the documentation will be excluded.
398 # Set it to YES to include the internal documentation.
400 INTERNAL_DOCS          = NO
402 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
403 # file names in lower-case letters. If set to YES upper-case letters are also
404 # allowed. This is useful if you have classes or files whose names only differ
405 # in case and if your file system supports case sensitive file names. Windows
406 # and Mac users are advised to set this option to NO.
408 CASE_SENSE_NAMES       = YES
410 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
411 # will show members with their full class and namespace scopes in the
412 # documentation. If set to YES the scope will be hidden.
414 HIDE_SCOPE_NAMES       = NO
416 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
417 # will put a list of the files that are included by a file in the documentation
418 # of that file.
420 SHOW_INCLUDE_FILES     = YES
422 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
423 # will list include files with double quotes in the documentation
424 # rather than with sharp brackets.
426 FORCE_LOCAL_INCLUDES   = NO
428 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
429 # is inserted in the documentation for inline members.
431 INLINE_INFO            = YES
433 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
434 # will sort the (detailed) documentation of file and class members
435 # alphabetically by member name. If set to NO the members will appear in
436 # declaration order.
438 SORT_MEMBER_DOCS       = YES
440 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
441 # brief documentation of file, namespace and class members alphabetically
442 # by member name. If set to NO (the default) the members will appear in
443 # declaration order.
445 SORT_BRIEF_DOCS        = NO
447 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
448 # will sort the (brief and detailed) documentation of class members so that
449 # constructors and destructors are listed first. If set to NO (the default)
450 # the constructors will appear in the respective orders defined by
451 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
452 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
453 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
455 SORT_MEMBERS_CTORS_1ST = NO
457 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
458 # hierarchy of group names into alphabetical order. If set to NO (the default)
459 # the group names will appear in their defined order.
461 SORT_GROUP_NAMES       = NO
463 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
464 # sorted by fully-qualified names, including namespaces. If set to
465 # NO (the default), the class list will be sorted only by class name,
466 # not including the namespace part.
467 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
468 # Note: This option applies only to the class list, not to the
469 # alphabetical list.
471 SORT_BY_SCOPE_NAME     = NO
473 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
474 # do proper type resolution of all parameters of a function it will reject a
475 # match between the prototype and the implementation of a member function even
476 # if there is only one candidate or it is obvious which candidate to choose
477 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
478 # will still accept a match between prototype and implementation in such cases.
480 STRICT_PROTO_MATCHING  = NO
482 # The GENERATE_TODOLIST tag can be used to enable (YES) or
483 # disable (NO) the todo list. This list is created by putting \todo
484 # commands in the documentation.
486 GENERATE_TODOLIST      = YES
488 # The GENERATE_TESTLIST tag can be used to enable (YES) or
489 # disable (NO) the test list. This list is created by putting \test
490 # commands in the documentation.
492 GENERATE_TESTLIST      = YES
494 # The GENERATE_BUGLIST tag can be used to enable (YES) or
495 # disable (NO) the bug list. This list is created by putting \bug
496 # commands in the documentation.
498 GENERATE_BUGLIST       = YES
500 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
501 # disable (NO) the deprecated list. This list is created by putting
502 # \deprecated commands in the documentation.
504 GENERATE_DEPRECATEDLIST= YES
506 # The ENABLED_SECTIONS tag can be used to enable conditional
507 # documentation sections, marked by \if sectionname ... \endif.
509 ENABLED_SECTIONS       =
511 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
512 # the initial value of a variable or macro consists of for it to appear in
513 # the documentation. If the initializer consists of more lines than specified
514 # here it will be hidden. Use a value of 0 to hide initializers completely.
515 # The appearance of the initializer of individual variables and macros in the
516 # documentation can be controlled using \showinitializer or \hideinitializer
517 # command in the documentation regardless of this setting.
519 MAX_INITIALIZER_LINES  = 30
521 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
522 # at the bottom of the documentation of classes and structs. If set to YES the
523 # list will mention the files that were used to generate the documentation.
525 SHOW_USED_FILES        = YES
527 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
528 # This will remove the Files entry from the Quick Index and from the
529 # Folder Tree View (if specified). The default is YES.
531 SHOW_FILES             = YES
533 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
534 # Namespaces page.
535 # This will remove the Namespaces entry from the Quick Index
536 # and from the Folder Tree View (if specified). The default is YES.
538 SHOW_NAMESPACES        = YES
540 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
541 # doxygen should invoke to get the current version for each file (typically from
542 # the version control system). Doxygen will invoke the program by executing (via
543 # popen()) the command <command> <input-file>, where <command> is the value of
544 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
545 # provided by doxygen. Whatever the program writes to standard output
546 # is used as the file version. See the manual for examples.
548 FILE_VERSION_FILTER    =
550 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
551 # by doxygen. The layout file controls the global structure of the generated
552 # output files in an output format independent way. The create the layout file
553 # that represents doxygen's defaults, run doxygen with the -l option.
554 # You can optionally specify a file name after the option, if omitted
555 # DoxygenLayout.xml will be used as the name of the layout file.
557 LAYOUT_FILE            =
559 # The CITE_BIB_FILES tag can be used to specify one or more bib files
560 # containing the references data. This must be a list of .bib files. The
561 # .bib extension is automatically appended if omitted. Using this command
562 # requires the bibtex tool to be installed. See also
563 # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
564 # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
565 # feature you need bibtex and perl available in the search path.
567 CITE_BIB_FILES         =
569 #---------------------------------------------------------------------------
570 # configuration options related to warning and progress messages
571 #---------------------------------------------------------------------------
573 # The QUIET tag can be used to turn on/off the messages that are generated
574 # by doxygen. Possible values are YES and NO. If left blank NO is used.
576 QUIET                  = NO
578 # The WARNINGS tag can be used to turn on/off the warning messages that are
579 # generated by doxygen. Possible values are YES and NO. If left blank
580 # NO is used.
582 WARNINGS               = YES
584 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
585 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
586 # automatically be disabled.
588 WARN_IF_UNDOCUMENTED   = YES
590 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
591 # potential errors in the documentation, such as not documenting some
592 # parameters in a documented function, or documenting parameters that
593 # don't exist or using markup commands wrongly.
595 WARN_IF_DOC_ERROR      = YES
597 # The WARN_NO_PARAMDOC option can be enabled to get warnings for
598 # functions that are documented, but have no documentation for their parameters
599 # or return value. If set to NO (the default) doxygen will only warn about
600 # wrong or incomplete parameter documentation, but not about the absence of
601 # documentation.
603 WARN_NO_PARAMDOC       = NO
605 # The WARN_FORMAT tag determines the format of the warning messages that
606 # doxygen can produce. The string should contain the $file, $line, and $text
607 # tags, which will be replaced by the file and line number from which the
608 # warning originated and the warning text. Optionally the format may contain
609 # $version, which will be replaced by the version of the file (if it could
610 # be obtained via FILE_VERSION_FILTER)
612 WARN_FORMAT            = "$file:$line: $text"
614 # The WARN_LOGFILE tag can be used to specify a file to which warning
615 # and error messages should be written. If left blank the output is written
616 # to stderr.
618 WARN_LOGFILE           =
620 #---------------------------------------------------------------------------
621 # configuration options related to the input files
622 #---------------------------------------------------------------------------
624 # The INPUT tag can be used to specify the files and/or directories that contain
625 # documented source files. You may enter file names like "myfile.cpp" or
626 # directories like "/usr/src/myproject". Separate the files or directories
627 # with spaces.
629 INPUT                  = @PROJECT_SOURCE_DIR@/src/lib @PROJECT_SOURCE_DIR@/include/tng/
631 # This tag can be used to specify the character encoding of the source files
632 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
633 # also the default input encoding. Doxygen uses libiconv (or the iconv built
634 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
635 # the list of possible encodings.
637 INPUT_ENCODING         = UTF-8
639 # If the value of the INPUT tag contains directories, you can use the
640 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
641 # and *.h) to filter out the source-files in the directories. If left
642 # blank the following patterns are tested:
643 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
644 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
645 # *.f90 *.f *.for *.vhd *.vhdl
647 FILE_PATTERNS          =
649 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
650 # should be searched for input files as well. Possible values are YES and NO.
651 # If left blank NO is used.
653 RECURSIVE              = NO
655 # The EXCLUDE tag can be used to specify files and/or directories that should be
656 # excluded from the INPUT source files. This way you can easily exclude a
657 # subdirectory from a directory tree whose root is specified with the INPUT tag.
658 # Note that relative paths are relative to the directory from which doxygen is
659 # run.
661 EXCLUDE                = @PROJECT_SOURCE_DIR@/src/lib/md5.c @PROJECT_SOURCE_DIR@/include/tng/md5.h @PROJECT_SOURCE_DIR@/include/tng/tng_io.hpp @PROJECT_SOURCE_DIR@/src/lib/tng_io.c @PROJECT_SOURCE_DIR@/src/lib/tng_io_fortran.c
663 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
664 # directories that are symbolic links (a Unix file system feature) are excluded
665 # from the input.
667 EXCLUDE_SYMLINKS       = NO
669 # If the value of the INPUT tag contains directories, you can use the
670 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
671 # certain files from those directories. Note that the wildcards are matched
672 # against the file with absolute path, so to exclude all test directories
673 # for example use the pattern */test/*
675 EXCLUDE_PATTERNS       =
677 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
678 # (namespaces, classes, functions, etc.) that should be excluded from the
679 # output. The symbol name can be a fully qualified name, a word, or if the
680 # wildcard * is used, a substring. Examples: ANamespace, AClass,
681 # AClass::ANamespace, ANamespace::*Test
683 EXCLUDE_SYMBOLS        = *_
685 # The EXAMPLE_PATH tag can be used to specify one or more files or
686 # directories that contain example code fragments that are included (see
687 # the \include command).
689 EXAMPLE_PATH           =
691 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
692 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
693 # and *.h) to filter out the source-files in the directories. If left
694 # blank all files are included.
696 EXAMPLE_PATTERNS       =
698 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
699 # searched for input files to be used with the \include or \dontinclude
700 # commands irrespective of the value of the RECURSIVE tag.
701 # Possible values are YES and NO. If left blank NO is used.
703 EXAMPLE_RECURSIVE      = NO
705 # The IMAGE_PATH tag can be used to specify one or more files or
706 # directories that contain image that are included in the documentation (see
707 # the \image command).
709 IMAGE_PATH             =
711 # The INPUT_FILTER tag can be used to specify a program that doxygen should
712 # invoke to filter for each input file. Doxygen will invoke the filter program
713 # by executing (via popen()) the command <filter> <input-file>, where <filter>
714 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
715 # input file. Doxygen will then use the output that the filter program writes
716 # to standard output.
717 # If FILTER_PATTERNS is specified, this tag will be
718 # ignored.
720 INPUT_FILTER           =
722 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
723 # basis.
724 # Doxygen will compare the file name with each pattern and apply the
725 # filter if there is a match.
726 # The filters are a list of the form:
727 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
728 # info on how filters are used. If FILTER_PATTERNS is empty or if
729 # non of the patterns match the file name, INPUT_FILTER is applied.
731 FILTER_PATTERNS        =
733 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
734 # INPUT_FILTER) will be used to filter the input files when producing source
735 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
737 FILTER_SOURCE_FILES    = NO
739 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
740 # pattern. A pattern will override the setting for FILTER_PATTERN (if any)
741 # and it is also possible to disable source filtering for a specific pattern
742 # using *.ext= (so without naming a filter). This option only has effect when
743 # FILTER_SOURCE_FILES is enabled.
745 FILTER_SOURCE_PATTERNS =
747 #---------------------------------------------------------------------------
748 # configuration options related to source browsing
749 #---------------------------------------------------------------------------
751 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
752 # be generated. Documented entities will be cross-referenced with these sources.
753 # Note: To get rid of all source code in the generated output, make sure also
754 # VERBATIM_HEADERS is set to NO.
756 SOURCE_BROWSER         = NO
758 # Setting the INLINE_SOURCES tag to YES will include the body
759 # of functions and classes directly in the documentation.
761 INLINE_SOURCES         = NO
763 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
764 # doxygen to hide any special comment blocks from generated source code
765 # fragments. Normal C and C++ comments will always remain visible.
767 STRIP_CODE_COMMENTS    = YES
769 # If the REFERENCED_BY_RELATION tag is set to YES
770 # then for each documented function all documented
771 # functions referencing it will be listed.
773 REFERENCED_BY_RELATION = NO
775 # If the REFERENCES_RELATION tag is set to YES
776 # then for each documented function all documented entities
777 # called/used by that function will be listed.
779 REFERENCES_RELATION    = NO
781 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
782 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
783 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
784 # link to the source code.
785 # Otherwise they will link to the documentation.
787 REFERENCES_LINK_SOURCE = YES
789 # If the USE_HTAGS tag is set to YES then the references to source code
790 # will point to the HTML generated by the htags(1) tool instead of doxygen
791 # built-in source browser. The htags tool is part of GNU's global source
792 # tagging system (see http://www.gnu.org/software/global/global.html). You
793 # will need version 4.8.6 or higher.
795 USE_HTAGS              = NO
797 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
798 # will generate a verbatim copy of the header file for each class for
799 # which an include is specified. Set to NO to disable this.
801 VERBATIM_HEADERS       = YES
803 #---------------------------------------------------------------------------
804 # configuration options related to the alphabetical class index
805 #---------------------------------------------------------------------------
807 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
808 # of all compounds will be generated. Enable this if the project
809 # contains a lot of classes, structs, unions or interfaces.
811 ALPHABETICAL_INDEX     = YES
813 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
814 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
815 # in which this list will be split (can be a number in the range [1..20])
817 COLS_IN_ALPHA_INDEX    = 5
819 # In case all classes in a project start with a common prefix, all
820 # classes will be put under the same header in the alphabetical index.
821 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
822 # should be ignored while generating the index headers.
824 IGNORE_PREFIX          =
826 #---------------------------------------------------------------------------
827 # configuration options related to the HTML output
828 #---------------------------------------------------------------------------
830 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
831 # generate HTML output.
833 GENERATE_HTML          = YES
835 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
836 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
837 # put in front of it. If left blank `html' will be used as the default path.
839 HTML_OUTPUT            = html
841 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
842 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
843 # doxygen will generate files with .html extension.
845 HTML_FILE_EXTENSION    = .html
847 # The HTML_HEADER tag can be used to specify a personal HTML header for
848 # each generated HTML page. If it is left blank doxygen will generate a
849 # standard header. Note that when using a custom header you are responsible
850 #  for the proper inclusion of any scripts and style sheets that doxygen
851 # needs, which is dependent on the configuration options used.
852 # It is advised to generate a default header using "doxygen -w html
853 # header.html footer.html stylesheet.css YourConfigFile" and then modify
854 # that header. Note that the header is subject to change so you typically
855 # have to redo this when upgrading to a newer version of doxygen or when
856 # changing the value of configuration settings such as GENERATE_TREEVIEW!
858 HTML_HEADER            =
860 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
861 # each generated HTML page. If it is left blank doxygen will generate a
862 # standard footer.
864 HTML_FOOTER            =
866 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
867 # style sheet that is used by each HTML page. It can be used to
868 # fine-tune the look of the HTML output. If the tag is left blank doxygen
869 # will generate a default style sheet. Note that doxygen will try to copy
870 # the style sheet file to the HTML output directory, so don't put your own
871 # style sheet in the HTML output directory as well, or it will be erased!
873 HTML_STYLESHEET        =
875 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
876 # other source files which should be copied to the HTML output directory. Note
877 # that these files will be copied to the base HTML output directory. Use the
878 # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
879 # files. In the HTML_STYLESHEET file, use the file name only. Also note that
880 # the files will be copied as-is; there are no commands or markers available.
882 HTML_EXTRA_FILES       =
884 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
885 # Doxygen will adjust the colors in the style sheet and background images
886 # according to this color. Hue is specified as an angle on a colorwheel,
887 # see http://en.wikipedia.org/wiki/Hue for more information.
888 # For instance the value 0 represents red, 60 is yellow, 120 is green,
889 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
890 # The allowed range is 0 to 359.
892 HTML_COLORSTYLE_HUE    = 220
894 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
895 # the colors in the HTML output. For a value of 0 the output will use
896 # grayscales only. A value of 255 will produce the most vivid colors.
898 HTML_COLORSTYLE_SAT    = 100
900 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
901 # the luminance component of the colors in the HTML output. Values below
902 # 100 gradually make the output lighter, whereas values above 100 make
903 # the output darker. The value divided by 100 is the actual gamma applied,
904 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
905 # and 100 does not change the gamma.
907 HTML_COLORSTYLE_GAMMA  = 80
909 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
910 # page will contain the date and time when the page was generated. Setting
911 # this to NO can help when comparing the output of multiple runs.
913 HTML_TIMESTAMP         = YES
915 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
916 # documentation will contain sections that can be hidden and shown after the
917 # page has loaded. For this to work a browser that supports
918 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
919 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
921 HTML_DYNAMIC_SECTIONS  = NO
923 # If the GENERATE_DOCSET tag is set to YES, additional index files
924 # will be generated that can be used as input for Apple's Xcode 3
925 # integrated development environment, introduced with OSX 10.5 (Leopard).
926 # To create a documentation set, doxygen will generate a Makefile in the
927 # HTML output directory. Running make will produce the docset in that
928 # directory and running "make install" will install the docset in
929 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
930 # it at startup.
931 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
932 # for more information.
934 GENERATE_DOCSET        = NO
936 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
937 # feed. A documentation feed provides an umbrella under which multiple
938 # documentation sets from a single provider (such as a company or product suite)
939 # can be grouped.
941 DOCSET_FEEDNAME        = "Doxygen generated docs"
943 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
944 # should uniquely identify the documentation set bundle. This should be a
945 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
946 # will append .docset to the name.
948 DOCSET_BUNDLE_ID       = org.doxygen.Project
950 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
951 # the documentation publisher. This should be a reverse domain-name style
952 # string, e.g. com.mycompany.MyDocSet.documentation.
954 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
956 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
958 DOCSET_PUBLISHER_NAME  = Publisher
960 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
961 # will be generated that can be used as input for tools like the
962 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
963 # of the generated HTML documentation.
965 GENERATE_HTMLHELP      = NO
967 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
968 # be used to specify the file name of the resulting .chm file. You
969 # can add a path in front of the file if the result should not be
970 # written to the html output directory.
972 CHM_FILE               =
974 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
975 # be used to specify the location (absolute path including file name) of
976 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
977 # the HTML help compiler on the generated index.hhp.
979 HHC_LOCATION           =
981 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
982 # controls if a separate .chi index file is generated (YES) or that
983 # it should be included in the master .chm file (NO).
985 GENERATE_CHI           = NO
987 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
988 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
989 # content.
991 CHM_INDEX_ENCODING     =
993 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
994 # controls whether a binary table of contents is generated (YES) or a
995 # normal table of contents (NO) in the .chm file.
997 BINARY_TOC             = NO
999 # The TOC_EXPAND flag can be set to YES to add extra items for group members
1000 # to the contents of the HTML help documentation and to the tree view.
1002 TOC_EXPAND             = NO
1004 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1005 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1006 # that can be used as input for Qt's qhelpgenerator to generate a
1007 # Qt Compressed Help (.qch) of the generated HTML documentation.
1009 GENERATE_QHP           = NO
1011 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1012 # be used to specify the file name of the resulting .qch file.
1013 # The path specified is relative to the HTML output folder.
1015 QCH_FILE               =
1017 # The QHP_NAMESPACE tag specifies the namespace to use when generating
1018 # Qt Help Project output. For more information please see
1019 # http://doc.trolltech.com/qthelpproject.html#namespace
1021 QHP_NAMESPACE          = org.doxygen.Project
1023 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1024 # Qt Help Project output. For more information please see
1025 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1027 QHP_VIRTUAL_FOLDER     = doc
1029 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1030 # add. For more information please see
1031 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1033 QHP_CUST_FILTER_NAME   =
1035 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1036 # custom filter to add. For more information please see
1037 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1038 # Qt Help Project / Custom Filters</a>.
1040 QHP_CUST_FILTER_ATTRS  =
1042 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1043 # project's
1044 # filter section matches.
1045 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1046 # Qt Help Project / Filter Attributes</a>.
1048 QHP_SECT_FILTER_ATTRS  =
1050 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1051 # be used to specify the location of Qt's qhelpgenerator.
1052 # If non-empty doxygen will try to run qhelpgenerator on the generated
1053 # .qhp file.
1055 QHG_LOCATION           =
1057 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1058 #  will be generated, which together with the HTML files, form an Eclipse help
1059 # plugin. To install this plugin and make it available under the help contents
1060 # menu in Eclipse, the contents of the directory containing the HTML and XML
1061 # files needs to be copied into the plugins directory of eclipse. The name of
1062 # the directory within the plugins directory should be the same as
1063 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1064 # the help appears.
1066 GENERATE_ECLIPSEHELP   = NO
1068 # A unique identifier for the eclipse help plugin. When installing the plugin
1069 # the directory name containing the HTML and XML files should also have
1070 # this name.
1072 ECLIPSE_DOC_ID         = org.doxygen.Project
1074 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1075 # at top of each HTML page. The value NO (the default) enables the index and
1076 # the value YES disables it. Since the tabs have the same information as the
1077 # navigation tree you can set this option to NO if you already set
1078 # GENERATE_TREEVIEW to YES.
1080 DISABLE_INDEX          = NO
1082 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1083 # structure should be generated to display hierarchical information.
1084 # If the tag value is set to YES, a side panel will be generated
1085 # containing a tree-like index structure (just like the one that
1086 # is generated for HTML Help). For this to work a browser that supports
1087 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1088 # Windows users are probably better off using the HTML help feature.
1089 # Since the tree basically has the same information as the tab index you
1090 # could consider to set DISABLE_INDEX to NO when enabling this option.
1092 GENERATE_TREEVIEW      = YES
1094 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1095 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
1096 # documentation. Note that a value of 0 will completely suppress the enum
1097 # values from appearing in the overview section.
1099 ENUM_VALUES_PER_LINE   = 4
1101 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1102 # used to set the initial width (in pixels) of the frame in which the tree
1103 # is shown.
1105 TREEVIEW_WIDTH         = 250
1107 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1108 # links to external symbols imported via tag files in a separate window.
1110 EXT_LINKS_IN_WINDOW    = NO
1112 # Use this tag to change the font size of Latex formulas included
1113 # as images in the HTML documentation. The default is 10. Note that
1114 # when you change the font size after a successful doxygen run you need
1115 # to manually remove any form_*.png images from the HTML output directory
1116 # to force them to be regenerated.
1118 FORMULA_FONTSIZE       = 10
1120 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1121 # generated for formulas are transparent PNGs. Transparent PNGs are
1122 # not supported properly for IE 6.0, but are supported on all modern browsers.
1123 # Note that when changing this option you need to delete any form_*.png files
1124 # in the HTML output before the changes have effect.
1126 FORMULA_TRANSPARENT    = YES
1128 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1129 # (see http://www.mathjax.org) which uses client side Javascript for the
1130 # rendering instead of using prerendered bitmaps. Use this if you do not
1131 # have LaTeX installed or if you want to formulas look prettier in the HTML
1132 # output. When enabled you also need to install MathJax separately and
1133 # configure the path to it using the MATHJAX_RELPATH option.
1135 USE_MATHJAX            = NO
1137 # When MathJax is enabled you need to specify the location relative to the
1138 # HTML output directory using the MATHJAX_RELPATH option. The destination
1139 # directory should contain the MathJax.js script. For instance, if the mathjax
1140 # directory is located at the same level as the HTML output directory, then
1141 # MATHJAX_RELPATH should be ../mathjax. The default value points to the
1142 # mathjax.org site, so you can quickly see the result without installing
1143 # MathJax, but it is strongly recommended to install a local copy of MathJax
1144 # before deployment.
1146 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1148 # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1149 # names that should be enabled during MathJax rendering.
1151 MATHJAX_EXTENSIONS     =
1153 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1154 # for the HTML output. The underlying search engine uses javascript
1155 # and DHTML and should work on any modern browser. Note that when using
1156 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1157 # (GENERATE_DOCSET) there is already a search function so this one should
1158 # typically be disabled. For large projects the javascript based search engine
1159 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1161 SEARCHENGINE           = YES
1163 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1164 # implemented using a PHP enabled web server instead of at the web client
1165 # using Javascript. Doxygen will generate the search PHP script and index
1166 # file to put on the web server. The advantage of the server
1167 # based approach is that it scales better to large projects and allows
1168 # full text search. The disadvantages are that it is more difficult to setup
1169 # and does not have live searching capabilities.
1171 SERVER_BASED_SEARCH    = NO
1173 #---------------------------------------------------------------------------
1174 # configuration options related to the LaTeX output
1175 #---------------------------------------------------------------------------
1177 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1178 # generate Latex output.
1180 GENERATE_LATEX         = YES
1182 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1183 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1184 # put in front of it. If left blank `latex' will be used as the default path.
1186 LATEX_OUTPUT           = latex
1188 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1189 # invoked. If left blank `latex' will be used as the default command name.
1190 # Note that when enabling USE_PDFLATEX this option is only used for
1191 # generating bitmaps for formulas in the HTML output, but not in the
1192 # Makefile that is written to the output directory.
1194 LATEX_CMD_NAME         = latex
1196 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1197 # generate index for LaTeX. If left blank `makeindex' will be used as the
1198 # default command name.
1200 MAKEINDEX_CMD_NAME     = makeindex
1202 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1203 # LaTeX documents. This may be useful for small projects and may help to
1204 # save some trees in general.
1206 COMPACT_LATEX          = NO
1208 # The PAPER_TYPE tag can be used to set the paper type that is used
1209 # by the printer. Possible values are: a4, letter, legal and
1210 # executive. If left blank a4wide will be used.
1212 PAPER_TYPE             = a4
1214 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1215 # packages that should be included in the LaTeX output.
1217 EXTRA_PACKAGES         =
1219 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1220 # the generated latex document. The header should contain everything until
1221 # the first chapter. If it is left blank doxygen will generate a
1222 # standard header. Notice: only use this tag if you know what you are doing!
1224 LATEX_HEADER           =
1226 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1227 # the generated latex document. The footer should contain everything after
1228 # the last chapter. If it is left blank doxygen will generate a
1229 # standard footer. Notice: only use this tag if you know what you are doing!
1231 LATEX_FOOTER           =
1233 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1234 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1235 # contain links (just like the HTML output) instead of page references
1236 # This makes the output suitable for online browsing using a pdf viewer.
1238 PDF_HYPERLINKS         = YES
1240 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1241 # plain latex in the generated Makefile. Set this option to YES to get a
1242 # higher quality PDF documentation.
1244 USE_PDFLATEX           = YES
1246 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1247 # command to the generated LaTeX files. This will instruct LaTeX to keep
1248 # running if errors occur, instead of asking the user for help.
1249 # This option is also used when generating formulas in HTML.
1251 LATEX_BATCHMODE        = NO
1253 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1254 # include the index chapters (such as File Index, Compound Index, etc.)
1255 # in the output.
1257 LATEX_HIDE_INDICES     = NO
1259 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1260 # source code with syntax highlighting in the LaTeX output.
1261 # Note that which sources are shown also depends on other settings
1262 # such as SOURCE_BROWSER.
1264 LATEX_SOURCE_CODE      = NO
1266 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1267 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1268 # http://en.wikipedia.org/wiki/BibTeX for more info.
1270 LATEX_BIB_STYLE        = plain
1272 #---------------------------------------------------------------------------
1273 # configuration options related to the RTF output
1274 #---------------------------------------------------------------------------
1276 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1277 # The RTF output is optimized for Word 97 and may not look very pretty with
1278 # other RTF readers or editors.
1280 GENERATE_RTF           = NO
1282 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1283 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1284 # put in front of it. If left blank `rtf' will be used as the default path.
1286 RTF_OUTPUT             = rtf
1288 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1289 # RTF documents. This may be useful for small projects and may help to
1290 # save some trees in general.
1292 COMPACT_RTF            = NO
1294 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1295 # will contain hyperlink fields. The RTF file will
1296 # contain links (just like the HTML output) instead of page references.
1297 # This makes the output suitable for online browsing using WORD or other
1298 # programs which support those fields.
1299 # Note: wordpad (write) and others do not support links.
1301 RTF_HYPERLINKS         = NO
1303 # Load style sheet definitions from file. Syntax is similar to doxygen's
1304 # config file, i.e. a series of assignments. You only have to provide
1305 # replacements, missing definitions are set to their default value.
1307 RTF_STYLESHEET_FILE    =
1309 # Set optional variables used in the generation of an rtf document.
1310 # Syntax is similar to doxygen's config file.
1312 RTF_EXTENSIONS_FILE    =
1314 #---------------------------------------------------------------------------
1315 # configuration options related to the man page output
1316 #---------------------------------------------------------------------------
1318 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1319 # generate man pages
1321 GENERATE_MAN           = NO
1323 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1324 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1325 # put in front of it. If left blank `man' will be used as the default path.
1327 MAN_OUTPUT             = man
1329 # The MAN_EXTENSION tag determines the extension that is added to
1330 # the generated man pages (default is the subroutine's section .3)
1332 MAN_EXTENSION          = .3
1334 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1335 # then it will generate one additional man file for each entity
1336 # documented in the real man page(s). These additional files
1337 # only source the real man page, but without them the man command
1338 # would be unable to find the correct page. The default is NO.
1340 MAN_LINKS              = NO
1342 #---------------------------------------------------------------------------
1343 # configuration options related to the XML output
1344 #---------------------------------------------------------------------------
1346 # If the GENERATE_XML tag is set to YES Doxygen will
1347 # generate an XML file that captures the structure of
1348 # the code including all documentation.
1350 GENERATE_XML           = NO
1352 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1353 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1354 # put in front of it. If left blank `xml' will be used as the default path.
1356 XML_OUTPUT             = xml
1358 # The XML_SCHEMA tag can be used to specify an XML schema,
1359 # which can be used by a validating XML parser to check the
1360 # syntax of the XML files.
1362 XML_SCHEMA             =
1364 # The XML_DTD tag can be used to specify an XML DTD,
1365 # which can be used by a validating XML parser to check the
1366 # syntax of the XML files.
1368 XML_DTD                =
1370 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1371 # dump the program listings (including syntax highlighting
1372 # and cross-referencing information) to the XML output. Note that
1373 # enabling this will significantly increase the size of the XML output.
1375 XML_PROGRAMLISTING     = YES
1377 #---------------------------------------------------------------------------
1378 # configuration options for the AutoGen Definitions output
1379 #---------------------------------------------------------------------------
1381 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1382 # generate an AutoGen Definitions (see autogen.sf.net) file
1383 # that captures the structure of the code including all
1384 # documentation. Note that this feature is still experimental
1385 # and incomplete at the moment.
1387 GENERATE_AUTOGEN_DEF   = NO
1389 #---------------------------------------------------------------------------
1390 # configuration options related to the Perl module output
1391 #---------------------------------------------------------------------------
1393 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1394 # generate a Perl module file that captures the structure of
1395 # the code including all documentation. Note that this
1396 # feature is still experimental and incomplete at the
1397 # moment.
1399 GENERATE_PERLMOD       = NO
1401 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1402 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1403 # to generate PDF and DVI output from the Perl module output.
1405 PERLMOD_LATEX          = NO
1407 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1408 # nicely formatted so it can be parsed by a human reader.
1409 # This is useful
1410 # if you want to understand what is going on.
1411 # On the other hand, if this
1412 # tag is set to NO the size of the Perl module output will be much smaller
1413 # and Perl will parse it just the same.
1415 PERLMOD_PRETTY         = YES
1417 # The names of the make variables in the generated doxyrules.make file
1418 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1419 # This is useful so different doxyrules.make files included by the same
1420 # Makefile don't overwrite each other's variables.
1422 PERLMOD_MAKEVAR_PREFIX =
1424 #---------------------------------------------------------------------------
1425 # Configuration options related to the preprocessor
1426 #---------------------------------------------------------------------------
1428 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1429 # evaluate all C-preprocessor directives found in the sources and include
1430 # files.
1432 ENABLE_PREPROCESSING   = YES
1434 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1435 # names in the source code. If set to NO (the default) only conditional
1436 # compilation will be performed. Macro expansion can be done in a controlled
1437 # way by setting EXPAND_ONLY_PREDEF to YES.
1439 MACRO_EXPANSION        = NO
1441 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1442 # then the macro expansion is limited to the macros specified with the
1443 # PREDEFINED and EXPAND_AS_DEFINED tags.
1445 EXPAND_ONLY_PREDEF     = NO
1447 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1448 # pointed to by INCLUDE_PATH will be searched when a #include is found.
1450 SEARCH_INCLUDES        = YES
1452 # The INCLUDE_PATH tag can be used to specify one or more directories that
1453 # contain include files that are not input files but should be processed by
1454 # the preprocessor.
1456 INCLUDE_PATH           =
1458 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1459 # patterns (like *.h and *.hpp) to filter out the header-files in the
1460 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1461 # be used.
1463 INCLUDE_FILE_PATTERNS  =
1465 # The PREDEFINED tag can be used to specify one or more macro names that
1466 # are defined before the preprocessor is started (similar to the -D option of
1467 # gcc). The argument of the tag is a list of macros of the form: name
1468 # or name=definition (no spaces). If the definition and the = are
1469 # omitted =1 is assumed. To prevent a macro definition from being
1470 # undefined via #undef or recursively expanded use the := operator
1471 # instead of the = operator.
1473 PREDEFINED             =
1475 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1476 # this tag can be used to specify a list of macro names that should be expanded.
1477 # The macro definition that is found in the sources will be used.
1478 # Use the PREDEFINED tag if you want to use a different macro definition that
1479 # overrules the definition found in the source code.
1481 EXPAND_AS_DEFINED      =
1483 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1484 # doxygen's preprocessor will remove all references to function-like macros
1485 # that are alone on a line, have an all uppercase name, and do not end with a
1486 # semicolon, because these will confuse the parser if not removed.
1488 SKIP_FUNCTION_MACROS   = YES
1490 #---------------------------------------------------------------------------
1491 # Configuration::additions related to external references
1492 #---------------------------------------------------------------------------
1494 # The TAGFILES option can be used to specify one or more tagfiles.
1495 # Optionally an initial location of the external documentation
1496 # can be added for each tagfile. The format of a tag file without
1497 # this location is as follows:
1499 # TAGFILES = file1 file2 ...
1500 # Adding location for the tag files is done as follows:
1502 # TAGFILES = file1=loc1 "file2 = loc2" ...
1503 # where "loc1" and "loc2" can be relative or absolute paths or
1504 # URLs. If a location is present for each tag, the installdox tool
1505 # does not have to be run to correct the links.
1506 # Note that each tag file must have a unique name
1507 # (where the name does NOT include the path)
1508 # If a tag file is not located in the directory in which doxygen
1509 # is run, you must also specify the path to the tagfile here.
1511 TAGFILES               =
1513 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1514 # a tag file that is based on the input files it reads.
1516 GENERATE_TAGFILE       =
1518 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1519 # in the class index. If set to NO only the inherited external classes
1520 # will be listed.
1522 ALLEXTERNALS           = NO
1524 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1525 # in the modules index. If set to NO, only the current project's groups will
1526 # be listed.
1528 EXTERNAL_GROUPS        = YES
1530 # The PERL_PATH should be the absolute path and name of the perl script
1531 # interpreter (i.e. the result of `which perl').
1533 PERL_PATH              = /usr/bin/perl
1535 #---------------------------------------------------------------------------
1536 # Configuration options related to the dot tool
1537 #---------------------------------------------------------------------------
1539 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1540 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1541 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1542 # this option also works with HAVE_DOT disabled, but it is recommended to
1543 # install and use dot, since it yields more powerful graphs.
1545 CLASS_DIAGRAMS         = YES
1547 # You can define message sequence charts within doxygen comments using the \msc
1548 # command. Doxygen will then run the mscgen tool (see
1549 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1550 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1551 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1552 # default search path.
1554 MSCGEN_PATH            =
1556 # If set to YES, the inheritance and collaboration graphs will hide
1557 # inheritance and usage relations if the target is undocumented
1558 # or is not a class.
1560 HIDE_UNDOC_RELATIONS   = YES
1562 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1563 # available from the path. This tool is part of Graphviz, a graph visualization
1564 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1565 # have no effect if this option is set to NO (the default)
1567 HAVE_DOT               = NO
1569 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1570 # allowed to run in parallel. When set to 0 (the default) doxygen will
1571 # base this on the number of processors available in the system. You can set it
1572 # explicitly to a value larger than 0 to get control over the balance
1573 # between CPU load and processing speed.
1575 DOT_NUM_THREADS        = 0
1577 # By default doxygen will use the Helvetica font for all dot files that
1578 # doxygen generates. When you want a differently looking font you can specify
1579 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
1580 # the font, which can be done by putting it in a standard location or by setting
1581 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1582 # directory containing the font.
1584 DOT_FONTNAME           = Helvetica
1586 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1587 # The default size is 10pt.
1589 DOT_FONTSIZE           = 10
1591 # By default doxygen will tell dot to use the Helvetica font.
1592 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1593 # set the path where dot can find it.
1595 DOT_FONTPATH           =
1597 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1598 # will generate a graph for each documented class showing the direct and
1599 # indirect inheritance relations. Setting this tag to YES will force the
1600 # CLASS_DIAGRAMS tag to NO.
1602 CLASS_GRAPH            = YES
1604 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1605 # will generate a graph for each documented class showing the direct and
1606 # indirect implementation dependencies (inheritance, containment, and
1607 # class references variables) of the class with other documented classes.
1609 COLLABORATION_GRAPH    = YES
1611 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1612 # will generate a graph for groups, showing the direct groups dependencies
1614 GROUP_GRAPHS           = YES
1616 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1617 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1618 # Language.
1620 UML_LOOK               = NO
1622 # If set to YES, the inheritance and collaboration graphs will show the
1623 # relations between templates and their instances.
1625 TEMPLATE_RELATIONS     = NO
1627 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1628 # tags are set to YES then doxygen will generate a graph for each documented
1629 # file showing the direct and indirect include dependencies of the file with
1630 # other documented files.
1632 INCLUDE_GRAPH          = YES
1634 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1635 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1636 # documented header file showing the documented files that directly or
1637 # indirectly include this file.
1639 INCLUDED_BY_GRAPH      = YES
1641 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1642 # doxygen will generate a call dependency graph for every global function
1643 # or class method. Note that enabling this option will significantly increase
1644 # the time of a run. So in most cases it will be better to enable call graphs
1645 # for selected functions only using the \callgraph command.
1647 CALL_GRAPH             = NO
1649 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1650 # doxygen will generate a caller dependency graph for every global function
1651 # or class method. Note that enabling this option will significantly increase
1652 # the time of a run. So in most cases it will be better to enable caller
1653 # graphs for selected functions only using the \callergraph command.
1655 CALLER_GRAPH           = NO
1657 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1658 # will generate a graphical hierarchy of all classes instead of a textual one.
1660 GRAPHICAL_HIERARCHY    = YES
1662 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1663 # then doxygen will show the dependencies a directory has on other directories
1664 # in a graphical way. The dependency relations are determined by the #include
1665 # relations between the files in the directories.
1667 DIRECTORY_GRAPH        = YES
1669 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1670 # generated by dot. Possible values are svg, png, jpg, or gif.
1671 # If left blank png will be used. If you choose svg you need to set
1672 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1673 # visible in IE 9+ (other browsers do not have this requirement).
1675 DOT_IMAGE_FORMAT       = png
1677 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1678 # enable generation of interactive SVG images that allow zooming and panning.
1679 # Note that this requires a modern browser other than Internet Explorer.
1680 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1681 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1682 # visible. Older versions of IE do not have SVG support.
1684 INTERACTIVE_SVG        = NO
1686 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1687 # found. If left blank, it is assumed the dot tool can be found in the path.
1689 DOT_PATH               =
1691 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1692 # contain dot files that are included in the documentation (see the
1693 # \dotfile command).
1695 DOTFILE_DIRS           =
1697 # The MSCFILE_DIRS tag can be used to specify one or more directories that
1698 # contain msc files that are included in the documentation (see the
1699 # \mscfile command).
1701 MSCFILE_DIRS           =
1703 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1704 # nodes that will be shown in the graph. If the number of nodes in a graph
1705 # becomes larger than this value, doxygen will truncate the graph, which is
1706 # visualized by representing a node as a red box. Note that doxygen if the
1707 # number of direct children of the root node in a graph is already larger than
1708 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1709 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1711 DOT_GRAPH_MAX_NODES    = 50
1713 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1714 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1715 # from the root by following a path via at most 3 edges will be shown. Nodes
1716 # that lay further from the root node will be omitted. Note that setting this
1717 # option to 1 or 2 may greatly reduce the computation time needed for large
1718 # code bases. Also note that the size of a graph can be further restricted by
1719 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1721 MAX_DOT_GRAPH_DEPTH    = 0
1723 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1724 # background. This is disabled by default, because dot on Windows does not
1725 # seem to support this out of the box. Warning: Depending on the platform used,
1726 # enabling this option may lead to badly anti-aliased labels on the edges of
1727 # a graph (i.e. they become hard to read).
1729 DOT_TRANSPARENT        = NO
1731 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1732 # files in one run (i.e. multiple -o and -T options on the command line). This
1733 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1734 # support this, this feature is disabled by default.
1736 DOT_MULTI_TARGETS      = YES
1738 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1739 # generate a legend page explaining the meaning of the various boxes and
1740 # arrows in the dot generated graphs.
1742 GENERATE_LEGEND        = YES
1744 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1745 # remove the intermediate dot files that are used to generate
1746 # the various graphs.
1748 DOT_CLEANUP            = YES