1 # ---------------------------------------------------------------------
3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
7 # This software is governed by the CeCILL-B license under French law and
8 # abiding by the rules of distribution of free software. You can use,
9 # modify and/ or redistribute the software under the terms of the CeCILL-B
10 # license as circulated by CEA, CNRS and INRIA at the following URL
11 # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
12 # or in the file LICENSE.txt.
14 # As a counterpart to the access to the source code and rights to copy,
15 # modify and redistribute granted by the license, users are provided only
16 # with a limited warranty and the software's author, the holder of the
17 # economic rights, and the successive licensors have only limited
20 # The fact that you are presently reading this means that you have had
21 # knowledge of the CeCILL-B license and that you accept its terms.
22 # ------------------------------------------------------------------------ */
27 # This file describes the settings to be used by the documentation system
28 # doxygen (www.doxygen.org) for a project
30 # All text after a hash (#) is considered a comment and will be ignored
32 # TAG = value [value, ...]
33 # For lists items can also be appended using:
34 # TAG += value [value, ...]
35 # Values that contain spaces should be placed between quotes (" ")
37 #---------------------------------------------------------------------------
38 # Project related configuration options
39 #---------------------------------------------------------------------------
41 # This tag specifies the encoding used for all characters in the config file
42 # that follow. The default is UTF-8 which is also the encoding used for all
43 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
44 # iconv built into libc) for the transcoding. See
45 # http://www.gnu.org/software/libiconv for the list of possible encodings.
47 DOXYFILE_ENCODING = UTF-8
49 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
50 # by quotes) that should identify the project.
52 PROJECT_NAME = @DOXYGEN_PROJECT_NAME@
54 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
55 # This could be handy for archiving the generated documentation or
56 # if some version control system is used.
58 PROJECT_NUMBER = @PROJECT_VERSION@
60 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
61 # base path where the generated documentation will be put.
62 # If a relative path is entered, it will be relative to the location
63 # where doxygen was started. If left blank the current directory will be used.
65 OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT@
67 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
68 # 4096 sub-directories (in 2 levels) under the output directory of each output
69 # format and will distribute the generated files over these directories.
70 # Enabling this option can be useful when feeding doxygen a huge amount of
71 # source files, where putting all generated files in the same directory would
72 # otherwise cause performance problems for the file system.
76 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
77 # documentation generated by doxygen is written. Doxygen will use this
78 # information to generate all constant output in the proper language.
79 # The default language is English, other supported languages are:
80 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
81 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
82 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
83 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
84 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
87 OUTPUT_LANGUAGE = English
89 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
90 # include brief member descriptions after the members that are listed in
91 # the file and class documentation (similar to JavaDoc).
92 # Set to NO to disable this.
94 BRIEF_MEMBER_DESC = YES
96 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
97 # the brief description of a member or function before the detailed description.
98 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
99 # brief descriptions will be completely suppressed.
103 # This tag implements a quasi-intelligent brief description abbreviator
104 # that is used to form the text in various listings. Each string
105 # in this list, if found as the leading text of the brief description, will be
106 # stripped from the text and the result after processing the whole list, is
107 # used as the annotated text. Otherwise, the brief description is used as-is.
108 # If left blank, the following values are used ("$name" is automatically
109 # replaced with the name of the entity): "The $name class" "The $name widget"
110 # "The $name file" "is" "provides" "specifies" "contains"
111 # "represents" "a" "an" "the"
115 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
116 # Doxygen will generate a detailed section even if there is only a brief
119 ALWAYS_DETAILED_SEC = NO
121 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
122 # inherited members of a class in the documentation of that class as if those
123 # members were ordinary class members. Constructors, destructors and assignment
124 # operators of the base classes will not be shown.
126 INLINE_INHERITED_MEMB = YES
128 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
129 # path before files name in the file list and in the header files. If set
130 # to NO the shortest path that makes the file name unique will be used.
132 FULL_PATH_NAMES = YES
134 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
135 # can be used to strip a user-defined part of the path. Stripping is
136 # only done if one of the specified strings matches the left-hand part of
137 # the path. The tag can be used to show relative paths in the file list.
138 # If left blank the directory from which doxygen is run is used as the
143 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
144 # the path mentioned in the documentation of a class, which tells
145 # the reader which header file to include in order to use a class.
146 # If left blank only the name of the header file containing the class
147 # definition is used. Otherwise one should specify the include paths that
148 # are normally passed to the compiler using the -I flag.
150 STRIP_FROM_INC_PATH =
152 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
153 # (but less readable) file names. This can be useful is your file systems
154 # doesn't support long names like on DOS, Mac, or CD-ROM.
158 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
159 # will interpret the first line (until the first dot) of a JavaDoc-style
160 # comment as the brief description. If set to NO, the JavaDoc
161 # comments will behave just like regular Qt-style comments
162 # (thus requiring an explicit @brief command for a brief description.)
164 JAVADOC_AUTOBRIEF = NO
166 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
167 # interpret the first line (until the first dot) of a Qt-style
168 # comment as the brief description. If set to NO, the comments
169 # will behave just like regular Qt-style comments (thus requiring
170 # an explicit \brief command for a brief description.)
174 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
175 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
176 # comments) as a brief description. This used to be the default behaviour.
177 # The new default is to treat a multi-line C++ comment block as a detailed
178 # description. Set this tag to YES if you prefer the old behaviour instead.
180 MULTILINE_CPP_IS_BRIEF = NO
182 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
183 # will output the detailed description near the top, like JavaDoc.
184 # If set to NO, the detailed description appears after the member
189 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
190 # member inherits the documentation from any documented member that it
195 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
196 # a new page for each member. If set to NO, the documentation of a member will
197 # be part of the file/class/namespace that contains it.
199 SEPARATE_MEMBER_PAGES = NO
201 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
202 # Doxygen uses this value to replace tabs by spaces in code fragments.
206 # This tag can be used to specify a number of aliases that acts
207 # as commands in the documentation. An alias has the form "name=value".
208 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
209 # put the command \sideeffect (or @sideeffect) in the documentation, which
210 # will result in a user-defined paragraph with heading "Side Effects:".
211 # You can put \n's in the value part of an alias to insert newlines.
215 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
216 # sources only. Doxygen will then generate output that is more tailored for C.
217 # For instance, some of the names that are used will be different. The list
218 # of all members will be omitted, etc.
220 OPTIMIZE_OUTPUT_FOR_C = NO
222 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
223 # sources only. Doxygen will then generate output that is more tailored for
224 # Java. For instance, namespaces will be presented as packages, qualified
225 # scopes will look different, etc.
227 OPTIMIZE_OUTPUT_JAVA = NO
229 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
230 # sources only. Doxygen will then generate output that is more tailored for
233 OPTIMIZE_FOR_FORTRAN = NO
235 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
236 # sources. Doxygen will then generate output that is tailored for
239 OPTIMIZE_OUTPUT_VHDL = NO
241 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
242 # to include (a tag file for) the STL sources as input, then you should
243 # set this tag to YES in order to let doxygen match functions declarations and
244 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
245 # func(std::string) {}). This also make the inheritance and collaboration
246 # diagrams that involve STL classes more complete and accurate.
248 BUILTIN_STL_SUPPORT = NO
250 # If you use Microsoft's C++/CLI language, you should set this option to YES to
251 # enable parsing support.
255 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
256 # Doxygen will parse them like normal C++ but will assume all classes use public
257 # instead of private inheritance when no explicit protection keyword is present.
261 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
262 # tag is set to YES, then doxygen will reuse the documentation of the first
263 # member in the group (if any) for the other members of the group. By default
264 # all members of a group must be documented explicitly.
266 DISTRIBUTE_GROUP_DOC = NO
268 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
269 # the same type (for instance a group of public functions) to be put as a
270 # subgroup of that type (e.g. under the Public Functions section). Set it to
271 # NO to prevent subgrouping. Alternatively, this can be done per class using
272 # the \nosubgrouping command.
276 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
277 # is documented as struct, union, or enum with the name of the typedef. So
278 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
279 # with name TypeT. When disabled the typedef will appear as a member of a file,
280 # namespace, or class. And the struct will be named TypeS. This can typically
281 # be useful for C code in case the coding convention dictates that all compound
282 # types are typedef'ed and only the typedef is referenced, never the tag name.
284 TYPEDEF_HIDES_STRUCT = NO
286 #---------------------------------------------------------------------------
287 # Build related configuration options
288 #---------------------------------------------------------------------------
290 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
291 # documentation are documented, even if no documentation was available.
292 # Private class members and static file members will be hidden unless
293 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
297 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
298 # will be included in the documentation.
300 EXTRACT_PRIVATE = YES
302 # If the EXTRACT_STATIC tag is set to YES all static members of a file
303 # will be included in the documentation.
307 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
308 # defined locally in source files will be included in the documentation.
309 # If set to NO only classes defined in header files are included.
311 EXTRACT_LOCAL_CLASSES = YES
313 # This flag is only useful for Objective-C code. When set to YES local
314 # methods, which are defined in the implementation section but not in
315 # the interface are included in the documentation.
316 # If set to NO (the default) only methods in the interface are included.
318 EXTRACT_LOCAL_METHODS = NO
320 # If this flag is set to YES, the members of anonymous namespaces will be
321 # extracted and appear in the documentation as a namespace called
322 # 'anonymous_namespace{file}', where file will be replaced with the base
323 # name of the file that contains the anonymous namespace. By default
324 # anonymous namespace are hidden.
326 EXTRACT_ANON_NSPACES = NO
328 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
329 # undocumented members of documented classes, files or namespaces.
330 # If set to NO (the default) these members will be included in the
331 # various overviews, but no documentation section is generated.
332 # This option has no effect if EXTRACT_ALL is enabled.
334 HIDE_UNDOC_MEMBERS = NO
336 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
337 # undocumented classes that are normally visible in the class hierarchy.
338 # If set to NO (the default) these classes will be included in the various
339 # overviews. This option has no effect if EXTRACT_ALL is enabled.
341 HIDE_UNDOC_CLASSES = NO
343 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
344 # friend (class|struct|union) declarations.
345 # If set to NO (the default) these declarations will be included in the
348 HIDE_FRIEND_COMPOUNDS = NO
350 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
351 # documentation blocks found inside the body of a function.
352 # If set to NO (the default) these blocks will be appended to the
353 # function's detailed documentation block.
355 HIDE_IN_BODY_DOCS = NO
357 # The INTERNAL_DOCS tag determines if documentation
358 # that is typed after a \internal command is included. If the tag is set
359 # to NO (the default) then the documentation will be excluded.
360 # Set it to YES to include the internal documentation.
364 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
365 # file names in lower-case letters. If set to YES upper-case letters are also
366 # allowed. This is useful if you have classes or files whose names only differ
367 # in case and if your file system supports case sensitive file names. Windows
368 # and Mac users are advised to set this option to NO.
370 CASE_SENSE_NAMES = YES
372 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
373 # will show members with their full class and namespace scopes in the
374 # documentation. If set to YES the scope will be hidden.
376 HIDE_SCOPE_NAMES = NO
378 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
379 # will put a list of the files that are included by a file in the documentation
382 SHOW_INCLUDE_FILES = YES
384 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
385 # is inserted in the documentation for inline members.
389 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
390 # will sort the (detailed) documentation of file and class members
391 # alphabetically by member name. If set to NO the members will appear in
394 SORT_MEMBER_DOCS = YES
396 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
397 # brief documentation of file, namespace and class members alphabetically
398 # by member name. If set to NO (the default) the members will appear in
403 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
404 # hierarchy of group names into alphabetical order. If set to NO (the default)
405 # the group names will appear in their defined order.
407 SORT_GROUP_NAMES = NO
409 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
410 # sorted by fully-qualified names, including namespaces. If set to
411 # NO (the default), the class list will be sorted only by class name,
412 # not including the namespace part.
413 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
414 # Note: This option applies only to the class list, not to the
417 SORT_BY_SCOPE_NAME = NO
419 # The GENERATE_TODOLIST tag can be used to enable (YES) or
420 # disable (NO) the todo list. This list is created by putting \todo
421 # commands in the documentation.
423 GENERATE_TODOLIST = YES
425 # The GENERATE_TESTLIST tag can be used to enable (YES) or
426 # disable (NO) the test list. This list is created by putting \test
427 # commands in the documentation.
429 GENERATE_TESTLIST = YES
431 # The GENERATE_BUGLIST tag can be used to enable (YES) or
432 # disable (NO) the bug list. This list is created by putting \bug
433 # commands in the documentation.
435 GENERATE_BUGLIST = YES
437 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
438 # disable (NO) the deprecated list. This list is created by putting
439 # \deprecated commands in the documentation.
441 GENERATE_DEPRECATEDLIST= YES
443 # The ENABLED_SECTIONS tag can be used to enable conditional
444 # documentation sections, marked by \if sectionname ... \endif.
448 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
449 # the initial value of a variable or define consists of for it to appear in
450 # the documentation. If the initializer consists of more lines than specified
451 # here it will be hidden. Use a value of 0 to hide initializers completely.
452 # The appearance of the initializer of individual variables and defines in the
453 # documentation can be controlled using \showinitializer or \hideinitializer
454 # command in the documentation regardless of this setting.
456 MAX_INITIALIZER_LINES = 30
458 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
459 # at the bottom of the documentation of classes and structs. If set to YES the
460 # list will mention the files that were used to generate the documentation.
462 SHOW_USED_FILES = YES
464 # If the sources in your project are distributed over multiple directories
465 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
466 # in the documentation. The default is NO.
468 SHOW_DIRECTORIES = YES
470 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
471 # doxygen should invoke to get the current version for each file (typically from
472 # the version control system). Doxygen will invoke the program by executing (via
473 # popen()) the command <command> <input-file>, where <command> is the value of
474 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
475 # provided by doxygen. Whatever the program writes to standard output
476 # is used as the file version. See the manual for examples.
478 FILE_VERSION_FILTER =
480 #---------------------------------------------------------------------------
481 # configuration options related to warning and progress messages
482 #---------------------------------------------------------------------------
484 # The QUIET tag can be used to turn on/off the messages that are generated
485 # by doxygen. Possible values are YES and NO. If left blank NO is used.
489 # The WARNINGS tag can be used to turn on/off the warning messages that are
490 # generated by doxygen. Possible values are YES and NO. If left blank
495 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
496 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
497 # automatically be disabled.
499 WARN_IF_UNDOCUMENTED = YES
501 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
502 # potential errors in the documentation, such as not documenting some
503 # parameters in a documented function, or documenting parameters that
504 # don't exist or using markup commands wrongly.
506 WARN_IF_DOC_ERROR = YES
508 # This WARN_NO_PARAMDOC option can be abled to get warnings for
509 # functions that are documented, but have no documentation for their parameters
510 # or return value. If set to NO (the default) doxygen will only warn about
511 # wrong or incomplete parameter documentation, but not about the absence of
514 WARN_NO_PARAMDOC = NO
516 # The WARN_FORMAT tag determines the format of the warning messages that
517 # doxygen can produce. The string should contain the $file, $line, and $text
518 # tags, which will be replaced by the file and line number from which the
519 # warning originated and the warning text. Optionally the format may contain
520 # $version, which will be replaced by the version of the file (if it could
521 # be obtained via FILE_VERSION_FILTER)
523 WARN_FORMAT = "$file:$line: $text"
525 # The WARN_LOGFILE tag can be used to specify a file to which warning
526 # and error messages should be written. If left blank the output is written
529 WARN_LOGFILE = @DOXYGEN_LOGFILE@
531 #---------------------------------------------------------------------------
532 # configuration options related to the input files
533 #---------------------------------------------------------------------------
535 # The INPUT tag can be used to specify the files and/or directories that contain
536 # documented source files. You may enter file names like "myfile.cpp" or
537 # directories like "/usr/src/myproject". Separate the files or directories
540 INPUT = @DOXYGEN_INPUT@
542 # This tag can be used to specify the character encoding of the source files
543 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
544 # also the default input encoding. Doxygen uses libiconv (or the iconv built
545 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
546 # the list of possible encodings.
548 INPUT_ENCODING = UTF-8
550 # If the value of the INPUT tag contains directories, you can use the
551 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
552 # and *.h) to filter out the source-files in the directories. If left
553 # blank the following patterns are tested:
554 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
555 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
557 FILE_PATTERNS = *.h \
561 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
562 # should be searched for input files as well. Possible values are YES and NO.
563 # If left blank NO is used.
567 # The EXCLUDE tag can be used to specify files and/or directories that should
568 # excluded from the INPUT source files. This way you can easily exclude a
569 # subdirectory from a directory tree whose root is specified with the INPUT tag.
571 EXCLUDE = @DOXYGEN_EXCLUDE@
573 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
574 # directories that are symbolic links (a Unix filesystem feature) are excluded
577 EXCLUDE_SYMLINKS = NO
579 # If the value of the INPUT tag contains directories, you can use the
580 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
581 # certain files from those directories. Note that the wildcards are matched
582 # against the file with absolute path, so to exclude all test directories
583 # for example use the pattern */test/*
587 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
588 # (namespaces, classes, functions, etc.) that should be excluded from the
589 # output. The symbol name can be a fully qualified name, a word, or if the
590 # wildcard * is used, a substring. Examples: ANamespace, AClass,
591 # AClass::ANamespace, ANamespace::*Test
595 # The EXAMPLE_PATH tag can be used to specify one or more files or
596 # directories that contain example code fragments that are included (see
597 # the \include command).
601 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
602 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
603 # and *.h) to filter out the source-files in the directories. If left
604 # blank all files are included.
606 EXAMPLE_PATTERNS = *.cxx
608 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
609 # searched for input files to be used with the \include or \dontinclude
610 # commands irrespective of the value of the RECURSIVE tag.
611 # Possible values are YES and NO. If left blank NO is used.
613 EXAMPLE_RECURSIVE = NO
615 # The IMAGE_PATH tag can be used to specify one or more files or
616 # directories that contain image that are included in the documentation (see
617 # the \image command).
621 # The INPUT_FILTER tag can be used to specify a program that doxygen should
622 # invoke to filter for each input file. Doxygen will invoke the filter program
623 # by executing (via popen()) the command <filter> <input-file>, where <filter>
624 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
625 # input file. Doxygen will then use the output that the filter program writes
626 # to standard output. If FILTER_PATTERNS is specified, this tag will be
631 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
632 # basis. Doxygen will compare the file name with each pattern and apply the
633 # filter if there is a match. The filters are a list of the form:
634 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
635 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
636 # is applied to all files.
640 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
641 # INPUT_FILTER) will be used to filter the input files when producing source
642 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
644 FILTER_SOURCE_FILES = NO
646 #---------------------------------------------------------------------------
647 # configuration options related to source browsing
648 #---------------------------------------------------------------------------
650 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
651 # be generated. Documented entities will be cross-referenced with these sources.
652 # Note: To get rid of all source code in the generated output, make sure also
653 # VERBATIM_HEADERS is set to NO.
657 # Setting the INLINE_SOURCES tag to YES will include the body
658 # of functions and classes directly in the documentation.
662 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
663 # doxygen to hide any special comment blocks from generated source code
664 # fragments. Normal C and C++ comments will always remain visible.
666 STRIP_CODE_COMMENTS = YES
668 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
669 # then for each documented function all documented
670 # functions referencing it will be listed.
672 REFERENCED_BY_RELATION = YES
674 # If the REFERENCES_RELATION tag is set to YES (the default)
675 # then for each documented function all documented entities
676 # called/used by that function will be listed.
678 REFERENCES_RELATION = YES
680 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
681 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
682 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
683 # link to the source code. Otherwise they will link to the documentstion.
685 REFERENCES_LINK_SOURCE = YES
687 # If the USE_HTAGS tag is set to YES then the references to source code
688 # will point to the HTML generated by the htags(1) tool instead of doxygen
689 # built-in source browser. The htags tool is part of GNU's global source
690 # tagging system (see http://www.gnu.org/software/global/global.html). You
691 # will need version 4.8.6 or higher.
695 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
696 # will generate a verbatim copy of the header file for each class for
697 # which an include is specified. Set to NO to disable this.
699 VERBATIM_HEADERS = YES
701 #---------------------------------------------------------------------------
702 # configuration options related to the alphabetical class index
703 #---------------------------------------------------------------------------
705 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
706 # of all compounds will be generated. Enable this if the project
707 # contains a lot of classes, structs, unions or interfaces.
709 ALPHABETICAL_INDEX = YES
711 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
712 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
713 # in which this list will be split (can be a number in the range [1..20])
715 COLS_IN_ALPHA_INDEX = 3
717 # In case all classes in a project start with a common prefix, all
718 # classes will be put under the same header in the alphabetical index.
719 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
720 # should be ignored while generating the index headers.
724 #---------------------------------------------------------------------------
725 # configuration options related to the HTML output
726 #---------------------------------------------------------------------------
728 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
729 # generate HTML output.
733 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
734 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
735 # put in front of it. If left blank `html' will be used as the default path.
737 HTML_OUTPUT = @DOXYGEN_HTML_OUTPUT@
739 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
740 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
741 # doxygen will generate files with .html extension.
743 HTML_FILE_EXTENSION = .html
745 # The HTML_HEADER tag can be used to specify a personal HTML header for
746 # each generated HTML page. If it is left blank doxygen will generate a
751 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
752 # each generated HTML page. If it is left blank doxygen will generate a
757 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
758 # style sheet that is used by each HTML page. It can be used to
759 # fine-tune the look of the HTML output. If the tag is left blank doxygen
760 # will generate a default style sheet. Note that doxygen will try to copy
761 # the style sheet file to the HTML output directory, so don't put your own
762 # stylesheet in the HTML output directory as well, or it will be erased!
766 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
767 # files or namespaces will be aligned in HTML using tables. If set to
768 # NO a bullet list will be used.
770 HTML_ALIGN_MEMBERS = YES
772 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
773 # will be generated that can be used as input for tools like the
774 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
775 # of the generated HTML documentation.
777 GENERATE_HTMLHELP = NO
779 # If the GENERATE_DOCSET tag is set to YES, additional index files
780 # will be generated that can be used as input for Apple's Xcode 3
781 # integrated development environment, introduced with OSX 10.5 (Leopard).
782 # To create a documentation set, doxygen will generate a Makefile in the
783 # HTML output directory. Running make will produce the docset in that
784 # directory and running "make install" will install the docset in
785 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
790 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
791 # feed. A documentation feed provides an umbrella under which multiple
792 # documentation sets from a single provider (such as a company or product suite)
795 DOCSET_FEEDNAME = "Doxygen generated docs"
797 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
798 # should uniquely identify the documentation set bundle. This should be a
799 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
800 # will append .docset to the name.
802 DOCSET_BUNDLE_ID = org.doxygen.Project
804 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
805 # documentation will contain sections that can be hidden and shown after the
806 # page has loaded. For this to work a browser that supports
807 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
808 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
810 HTML_DYNAMIC_SECTIONS = NO
812 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
813 # be used to specify the file name of the resulting .chm file. You
814 # can add a path in front of the file if the result should not be
815 # written to the html output directory.
819 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
820 # be used to specify the location (absolute path including file name) of
821 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
822 # the HTML help compiler on the generated index.hhp.
826 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
827 # controls if a separate .chi index file is generated (YES) or that
828 # it should be included in the master .chm file (NO).
832 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
833 # controls whether a binary table of contents is generated (YES) or a
834 # normal table of contents (NO) in the .chm file.
838 # The TOC_EXPAND flag can be set to YES to add extra items for group members
839 # to the contents of the HTML help documentation and to the tree view.
843 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
844 # top of each HTML page. The value NO (the default) enables the index and
845 # the value YES disables it.
849 # This tag can be used to set the number of enum values (range [1..20])
850 # that doxygen will group on one line in the generated HTML documentation.
852 ENUM_VALUES_PER_LINE = 4
854 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
855 # generated containing a tree-like index structure (just like the one that
856 # is generated for HTML Help). For this to work a browser that supports
857 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
858 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
859 # probably better off using the HTML help feature.
861 GENERATE_TREEVIEW = YES
863 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
864 # used to set the initial width (in pixels) of the frame in which the tree
869 #---------------------------------------------------------------------------
870 # configuration options related to the LaTeX output
871 #---------------------------------------------------------------------------
873 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
874 # generate Latex output.
878 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
879 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
880 # put in front of it. If left blank `latex' will be used as the default path.
884 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
885 # invoked. If left blank `latex' will be used as the default command name.
887 LATEX_CMD_NAME = latex
889 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
890 # generate index for LaTeX. If left blank `makeindex' will be used as the
891 # default command name.
893 MAKEINDEX_CMD_NAME = makeindex
895 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
896 # LaTeX documents. This may be useful for small projects and may help to
897 # save some trees in general.
901 # The PAPER_TYPE tag can be used to set the paper type that is used
902 # by the printer. Possible values are: a4, a4wide, letter, legal and
903 # executive. If left blank a4wide will be used.
907 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
908 # packages that should be included in the LaTeX output.
912 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
913 # the generated latex document. The header should contain everything until
914 # the first chapter. If it is left blank doxygen will generate a
915 # standard header. Notice: only use this tag if you know what you are doing!
919 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
920 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
921 # contain links (just like the HTML output) instead of page references
922 # This makes the output suitable for online browsing using a pdf viewer.
926 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
927 # plain latex in the generated Makefile. Set this option to YES to get a
928 # higher quality PDF documentation.
932 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
933 # command to the generated LaTeX files. This will instruct LaTeX to keep
934 # running if errors occur, instead of asking the user for help.
935 # This option is also used when generating formulas in HTML.
939 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
940 # include the index chapters (such as File Index, Compound Index, etc.)
943 LATEX_HIDE_INDICES = NO
945 #---------------------------------------------------------------------------
946 # configuration options related to the RTF output
947 #---------------------------------------------------------------------------
949 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
950 # The RTF output is optimized for Word 97 and may not look very pretty with
951 # other RTF readers or editors.
955 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
956 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
957 # put in front of it. If left blank `rtf' will be used as the default path.
961 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
962 # RTF documents. This may be useful for small projects and may help to
963 # save some trees in general.
967 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
968 # will contain hyperlink fields. The RTF file will
969 # contain links (just like the HTML output) instead of page references.
970 # This makes the output suitable for online browsing using WORD or other
971 # programs which support those fields.
972 # Note: wordpad (write) and others do not support links.
976 # Load stylesheet definitions from file. Syntax is similar to doxygen's
977 # config file, i.e. a series of assignments. You only have to provide
978 # replacements, missing definitions are set to their default value.
980 RTF_STYLESHEET_FILE =
982 # Set optional variables used in the generation of an rtf document.
983 # Syntax is similar to doxygen's config file.
985 RTF_EXTENSIONS_FILE =
987 #---------------------------------------------------------------------------
988 # configuration options related to the man page output
989 #---------------------------------------------------------------------------
991 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
996 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
997 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
998 # put in front of it. If left blank `man' will be used as the default path.
1002 # The MAN_EXTENSION tag determines the extension that is added to
1003 # the generated man pages (default is the subroutine's section .3)
1007 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1008 # then it will generate one additional man file for each entity
1009 # documented in the real man page(s). These additional files
1010 # only source the real man page, but without them the man command
1011 # would be unable to find the correct page. The default is NO.
1015 #---------------------------------------------------------------------------
1016 # configuration options related to the XML output
1017 #---------------------------------------------------------------------------
1019 # If the GENERATE_XML tag is set to YES Doxygen will
1020 # generate an XML file that captures the structure of
1021 # the code including all documentation.
1025 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1026 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1027 # put in front of it. If left blank `xml' will be used as the default path.
1031 # The XML_SCHEMA tag can be used to specify an XML schema,
1032 # which can be used by a validating XML parser to check the
1033 # syntax of the XML files.
1037 # The XML_DTD tag can be used to specify an XML DTD,
1038 # which can be used by a validating XML parser to check the
1039 # syntax of the XML files.
1043 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1044 # dump the program listings (including syntax highlighting
1045 # and cross-referencing information) to the XML output. Note that
1046 # enabling this will significantly increase the size of the XML output.
1048 XML_PROGRAMLISTING = YES
1050 #---------------------------------------------------------------------------
1051 # configuration options for the AutoGen Definitions output
1052 #---------------------------------------------------------------------------
1054 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1055 # generate an AutoGen Definitions (see autogen.sf.net) file
1056 # that captures the structure of the code including all
1057 # documentation. Note that this feature is still experimental
1058 # and incomplete at the moment.
1060 GENERATE_AUTOGEN_DEF = NO
1062 #---------------------------------------------------------------------------
1063 # configuration options related to the Perl module output
1064 #---------------------------------------------------------------------------
1066 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1067 # generate a Perl module file that captures the structure of
1068 # the code including all documentation. Note that this
1069 # feature is still experimental and incomplete at the
1072 GENERATE_PERLMOD = NO
1074 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1075 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1076 # to generate PDF and DVI output from the Perl module output.
1080 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1081 # nicely formatted so it can be parsed by a human reader. This is useful
1082 # if you want to understand what is going on. On the other hand, if this
1083 # tag is set to NO the size of the Perl module output will be much smaller
1084 # and Perl will parse it just the same.
1086 PERLMOD_PRETTY = YES
1088 # The names of the make variables in the generated doxyrules.make file
1089 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1090 # This is useful so different doxyrules.make files included by the same
1091 # Makefile don't overwrite each other's variables.
1093 PERLMOD_MAKEVAR_PREFIX =
1095 #---------------------------------------------------------------------------
1096 # Configuration options related to the preprocessor
1097 #---------------------------------------------------------------------------
1099 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1100 # evaluate all C-preprocessor directives found in the sources and include
1103 ENABLE_PREPROCESSING = YES
1105 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1106 # names in the source code. If set to NO (the default) only conditional
1107 # compilation will be performed. Macro expansion can be done in a controlled
1108 # way by setting EXPAND_ONLY_PREDEF to YES.
1110 MACRO_EXPANSION = YES
1112 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1113 # then the macro expansion is limited to the macros specified with the
1114 # PREDEFINED and EXPAND_AS_DEFINED tags.
1116 EXPAND_ONLY_PREDEF = NO
1118 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1119 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1121 SEARCH_INCLUDES = YES
1123 # The INCLUDE_PATH tag can be used to specify one or more directories that
1124 # contain include files that are not input files but should be processed by
1129 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1130 # patterns (like *.h and *.hpp) to filter out the header-files in the
1131 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1134 INCLUDE_FILE_PATTERNS =
1136 # The PREDEFINED tag can be used to specify one or more macro names that
1137 # are defined before the preprocessor is started (similar to the -D option of
1138 # gcc). The argument of the tag is a list of macros of the form: name
1139 # or name=definition (no spaces). If the definition and the = are
1140 # omitted =1 is assumed. To prevent a macro definition from being
1141 # undefined via #undef or recursively expanded use the := operator
1142 # instead of the = operator.
1144 PREDEFINED = @DOXYGEN_DOC_PREDEFINED@
1146 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1147 # this tag can be used to specify a list of macro names that should be expanded.
1148 # The macro definition that is found in the sources will be used.
1149 # Use the PREDEFINED tag if you want to use a different macro definition.
1153 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1154 # doxygen's preprocessor will remove all function-like macros that are alone
1155 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1156 # function macros are typically used for boiler-plate code, and will confuse
1157 # the parser if not removed.
1159 SKIP_FUNCTION_MACROS = YES
1161 #---------------------------------------------------------------------------
1162 # Configuration::additions related to external references
1163 #---------------------------------------------------------------------------
1165 # The TAGFILES option can be used to specify one or more tagfiles.
1166 # Optionally an initial location of the external documentation
1167 # can be added for each tagfile. The format of a tag file without
1168 # this location is as follows:
1169 # TAGFILES = file1 file2 ...
1170 # Adding location for the tag files is done as follows:
1171 # TAGFILES = file1=loc1 "file2 = loc2" ...
1172 # where "loc1" and "loc2" can be relative or absolute paths or
1173 # URLs. If a location is present for each tag, the installdox tool
1174 # does not have to be run to correct the links.
1175 # Note that each tag file must have a unique name
1176 # (where the name does NOT include the path)
1177 # If a tag file is not located in the directory in which doxygen
1178 # is run, you must also specify the path to the tagfile here.
1182 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1183 # a tag file that is based on the input files it reads.
1187 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1188 # in the class index. If set to NO only the inherited external classes
1193 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1194 # in the modules index. If set to NO, only the current project's groups will
1197 EXTERNAL_GROUPS = YES
1199 # The PERL_PATH should be the absolute path and name of the perl script
1200 # interpreter (i.e. the result of `which perl').
1202 PERL_PATH = /usr/bin/perl
1204 #---------------------------------------------------------------------------
1205 # Configuration options related to the dot tool
1206 #---------------------------------------------------------------------------
1208 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1209 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1210 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1211 # this option is superseded by the HAVE_DOT option below. This is only a
1212 # fallback. It is recommended to install and use dot, since it yields more
1215 CLASS_DIAGRAMS = YES
1217 # You can define message sequence charts within doxygen comments using the \msc
1218 # command. Doxygen will then run the mscgen tool (see
1219 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1220 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1221 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1222 # default search path.
1226 # If set to YES, the inheritance and collaboration graphs will hide
1227 # inheritance and usage relations if the target is undocumented
1228 # or is not a class.
1230 HIDE_UNDOC_RELATIONS = YES
1232 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1233 # available from the path. This tool is part of Graphviz, a graph visualization
1234 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1235 # have no effect if this option is set to NO (the default)
1237 HAVE_DOT = @DOXYGEN_HAVE_DOT@
1239 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1240 # will generate a graph for each documented class showing the direct and
1241 # indirect inheritance relations. Setting this tag to YES will force the
1242 # the CLASS_DIAGRAMS tag to NO.
1246 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1247 # will generate a graph for each documented class showing the direct and
1248 # indirect implementation dependencies (inheritance, containment, and
1249 # class references variables) of the class with other documented classes.
1251 COLLABORATION_GRAPH = YES
1253 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1254 # will generate a graph for groups, showing the direct groups dependencies
1258 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1259 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1264 # If set to YES, the inheritance and collaboration graphs will show the
1265 # relations between templates and their instances.
1267 TEMPLATE_RELATIONS = YES
1269 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1270 # tags are set to YES then doxygen will generate a graph for each documented
1271 # file showing the direct and indirect include dependencies of the file with
1272 # other documented files.
1276 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1277 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1278 # documented header file showing the documented files that directly or
1279 # indirectly include this file.
1281 INCLUDED_BY_GRAPH = YES
1283 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1284 # doxygen will generate a call dependency graph for every global function
1285 # or class method. Note that enabling this option will significantly increase
1286 # the time of a run. So in most cases it will be better to enable call graphs
1287 # for selected functions only using the \callgraph command.
1291 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1292 # doxygen will generate a caller dependency graph for every global function
1293 # or class method. Note that enabling this option will significantly increase
1294 # the time of a run. So in most cases it will be better to enable caller
1295 # graphs for selected functions only using the \callergraph command.
1299 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1300 # will graphical hierarchy of all classes instead of a textual one.
1302 GRAPHICAL_HIERARCHY = YES
1304 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1305 # then doxygen will show the dependencies a directory has on other directories
1306 # in a graphical way. The dependency relations are determined by the #include
1307 # relations between the files in the directories.
1309 DIRECTORY_GRAPH = YES
1311 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1312 # generated by dot. Possible values are png, jpg, or gif
1313 # If left blank png will be used.
1315 DOT_IMAGE_FORMAT = png
1317 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1318 # found. If left blank, it is assumed the dot tool can be found in the path.
1320 DOT_PATH = "@DOXYGEN_DOT_PATH@"
1322 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1323 # contain dot files that are included in the documentation (see the
1324 # \dotfile command).
1328 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1329 # nodes that will be shown in the graph. If the number of nodes in a graph
1330 # becomes larger than this value, doxygen will truncate the graph, which is
1331 # visualized by representing a node as a red box. Note that doxygen if the
1332 # number of direct children of the root node in a graph is already larger than
1333 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1334 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1336 DOT_GRAPH_MAX_NODES = 50
1338 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1339 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1340 # from the root by following a path via at most 3 edges will be shown. Nodes
1341 # that lay further from the root node will be omitted. Note that setting this
1342 # option to 1 or 2 may greatly reduce the computation time needed for large
1343 # code bases. Also note that the size of a graph can be further restricted by
1344 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1346 MAX_DOT_GRAPH_DEPTH = 0
1348 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1349 # background. This is enabled by default, which results in a transparent
1350 # background. Warning: Depending on the platform used, enabling this option
1351 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1352 # become hard to read).
1354 DOT_TRANSPARENT = NO
1356 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1357 # files in one run (i.e. multiple -o and -T options on the command line). This
1358 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1359 # support this, this feature is disabled by default.
1361 DOT_MULTI_TARGETS = NO
1363 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1364 # generate a legend page explaining the meaning of the various boxes and
1365 # arrows in the dot generated graphs.
1367 GENERATE_LEGEND = YES
1369 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1370 # remove the intermediate dot files that are used to generate
1371 # the various graphs.
1375 #---------------------------------------------------------------------------
1376 # Configuration::additions related to the search engine
1377 #---------------------------------------------------------------------------
1379 # The SEARCHENGINE tag specifies whether or not a search engine should be
1380 # used. If set to NO the values of all tags below this one will be ignored.