1 # ---------------------------------------------------------------------
3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
6 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
7 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
9 # This software is governed by the CeCILL-B license under French law and
10 # abiding by the rules of distribution of free software. You can use,
11 # modify and/ or redistribute the software under the terms of the CeCILL-B
12 # license as circulated by CEA, CNRS and INRIA at the following URL
13 # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
14 # or in the file LICENSE.txt.
16 # As a counterpart to the access to the source code and rights to copy,
17 # modify and redistribute granted by the license, users are provided only
18 # with a limited warranty and the software's author, the holder of the
19 # economic rights, and the successive licensors have only limited
22 # The fact that you are presently reading this means that you have had
23 # knowledge of the CeCILL-B license and that you accept its terms.
24 # ------------------------------------------------------------------------ */
30 # This file describes the settings to be used by the documentation system
31 # doxygen (www.doxygen.org) for a project
33 # All text after a hash (#) is considered a comment and will be ignored
35 # TAG = value [value, ...]
36 # For lists items can also be appended using:
37 # TAG += value [value, ...]
38 # Values that contain spaces should be placed between quotes (" ")
40 #---------------------------------------------------------------------------
41 # Project related configuration options
42 #---------------------------------------------------------------------------
44 # This tag specifies the encoding used for all characters in the config file
45 # that follow. The default is UTF-8 which is also the encoding used for all
46 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
47 # iconv built into libc) for the transcoding. See
48 # http://www.gnu.org/software/libiconv for the list of possible encodings.
50 DOXYFILE_ENCODING = UTF-8
52 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
53 # by quotes) that should identify the project.
55 PROJECT_NAME = @DOXYGEN_PROJECT_NAME@
57 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
58 # This could be handy for archiving the generated documentation or
59 # if some version control system is used.
61 PROJECT_NUMBER = @PROJECT_VERSION@
63 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
64 # base path where the generated documentation will be put.
65 # If a relative path is entered, it will be relative to the location
66 # where doxygen was started. If left blank the current directory will be used.
68 OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT@
70 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
71 # 4096 sub-directories (in 2 levels) under the output directory of each output
72 # format and will distribute the generated files over these directories.
73 # Enabling this option can be useful when feeding doxygen a huge amount of
74 # source files, where putting all generated files in the same directory would
75 # otherwise cause performance problems for the file system.
79 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
80 # documentation generated by doxygen is written. Doxygen will use this
81 # information to generate all constant output in the proper language.
82 # The default language is English, other supported languages are:
83 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
84 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
85 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
86 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
87 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
88 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
90 OUTPUT_LANGUAGE = English
92 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
93 # include brief member descriptions after the members that are listed in
94 # the file and class documentation (similar to JavaDoc).
95 # Set to NO to disable this.
97 BRIEF_MEMBER_DESC = YES
99 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
100 # the brief description of a member or function before the detailed description.
101 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
102 # brief descriptions will be completely suppressed.
106 # This tag implements a quasi-intelligent brief description abbreviator
107 # that is used to form the text in various listings. Each string
108 # in this list, if found as the leading text of the brief description, will be
109 # stripped from the text and the result after processing the whole list, is
110 # used as the annotated text. Otherwise, the brief description is used as-is.
111 # If left blank, the following values are used ("$name" is automatically
112 # replaced with the name of the entity): "The $name class" "The $name widget"
113 # "The $name file" "is" "provides" "specifies" "contains"
114 # "represents" "a" "an" "the"
118 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
119 # Doxygen will generate a detailed section even if there is only a brief
122 ALWAYS_DETAILED_SEC = NO
124 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
125 # inherited members of a class in the documentation of that class as if those
126 # members were ordinary class members. Constructors, destructors and assignment
127 # operators of the base classes will not be shown.
129 INLINE_INHERITED_MEMB = YES
131 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
132 # path before files name in the file list and in the header files. If set
133 # to NO the shortest path that makes the file name unique will be used.
135 FULL_PATH_NAMES = YES
137 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
138 # can be used to strip a user-defined part of the path. Stripping is
139 # only done if one of the specified strings matches the left-hand part of
140 # the path. The tag can be used to show relative paths in the file list.
141 # If left blank the directory from which doxygen is run is used as the
146 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
147 # the path mentioned in the documentation of a class, which tells
148 # the reader which header file to include in order to use a class.
149 # If left blank only the name of the header file containing the class
150 # definition is used. Otherwise one should specify the include paths that
151 # are normally passed to the compiler using the -I flag.
153 STRIP_FROM_INC_PATH =
155 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
156 # (but less readable) file names. This can be useful is your file systems
157 # doesn't support long names like on DOS, Mac, or CD-ROM.
161 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
162 # will interpret the first line (until the first dot) of a JavaDoc-style
163 # comment as the brief description. If set to NO, the JavaDoc
164 # comments will behave just like regular Qt-style comments
165 # (thus requiring an explicit @brief command for a brief description.)
167 JAVADOC_AUTOBRIEF = NO
169 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
170 # interpret the first line (until the first dot) of a Qt-style
171 # comment as the brief description. If set to NO, the comments
172 # will behave just like regular Qt-style comments (thus requiring
173 # an explicit \brief command for a brief description.)
177 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
178 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
179 # comments) as a brief description. This used to be the default behaviour.
180 # The new default is to treat a multi-line C++ comment block as a detailed
181 # description. Set this tag to YES if you prefer the old behaviour instead.
183 MULTILINE_CPP_IS_BRIEF = NO
185 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
186 # member inherits the documentation from any documented member that it
191 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
192 # a new page for each member. If set to NO, the documentation of a member will
193 # be part of the file/class/namespace that contains it.
195 SEPARATE_MEMBER_PAGES = NO
197 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
198 # Doxygen uses this value to replace tabs by spaces in code fragments.
202 # This tag can be used to specify a number of aliases that acts
203 # as commands in the documentation. An alias has the form "name=value".
204 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
205 # put the command \sideeffect (or @sideeffect) in the documentation, which
206 # will result in a user-defined paragraph with heading "Side Effects:".
207 # You can put \n's in the value part of an alias to insert newlines.
211 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
212 # sources only. Doxygen will then generate output that is more tailored for C.
213 # For instance, some of the names that are used will be different. The list
214 # of all members will be omitted, etc.
216 OPTIMIZE_OUTPUT_FOR_C = NO
218 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
219 # sources only. Doxygen will then generate output that is more tailored for
220 # Java. For instance, namespaces will be presented as packages, qualified
221 # scopes will look different, etc.
223 OPTIMIZE_OUTPUT_JAVA = NO
225 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
226 # sources only. Doxygen will then generate output that is more tailored for
229 OPTIMIZE_FOR_FORTRAN = NO
231 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
232 # sources. Doxygen will then generate output that is tailored for
235 OPTIMIZE_OUTPUT_VHDL = NO
237 # Doxygen selects the parser to use depending on the extension of the files it parses.
238 # With this tag you can assign which parser to use for a given extension.
239 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
240 # The format is ext=language, where ext is a file extension, and language is one of
241 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
242 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
243 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
244 # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
248 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
249 # to include (a tag file for) the STL sources as input, then you should
250 # set this tag to YES in order to let doxygen match functions declarations and
251 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
252 # func(std::string) {}). This also make the inheritance and collaboration
253 # diagrams that involve STL classes more complete and accurate.
255 BUILTIN_STL_SUPPORT = NO
257 # If you use Microsoft's C++/CLI language, you should set this option to YES to
258 # enable parsing support.
262 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
263 # Doxygen will parse them like normal C++ but will assume all classes use public
264 # instead of private inheritance when no explicit protection keyword is present.
268 # For Microsoft's IDL there are propget and propput attributes to indicate getter
269 # and setter methods for a property. Setting this option to YES (the default)
270 # will make doxygen to replace the get and set methods by a property in the
271 # documentation. This will only work if the methods are indeed getting or
272 # setting a simple type. If this is not the case, or you want to show the
273 # methods anyway, you should set this option to NO.
275 IDL_PROPERTY_SUPPORT = YES
277 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
278 # tag is set to YES, then doxygen will reuse the documentation of the first
279 # member in the group (if any) for the other members of the group. By default
280 # all members of a group must be documented explicitly.
282 DISTRIBUTE_GROUP_DOC = NO
284 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
285 # the same type (for instance a group of public functions) to be put as a
286 # subgroup of that type (e.g. under the Public Functions section). Set it to
287 # NO to prevent subgrouping. Alternatively, this can be done per class using
288 # the \nosubgrouping command.
292 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
293 # is documented as struct, union, or enum with the name of the typedef. So
294 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
295 # with name TypeT. When disabled the typedef will appear as a member of a file,
296 # namespace, or class. And the struct will be named TypeS. This can typically
297 # be useful for C code in case the coding convention dictates that all compound
298 # types are typedef'ed and only the typedef is referenced, never the tag name.
300 TYPEDEF_HIDES_STRUCT = NO
302 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
303 # determine which symbols to keep in memory and which to flush to disk.
304 # When the cache is full, less often used symbols will be written to disk.
305 # For small to medium size projects (<1000 input files) the default value is
306 # probably good enough. For larger projects a too small cache size can cause
307 # doxygen to be busy swapping symbols to and from disk most of the time
308 # causing a significant performance penality.
309 # If the system has enough physical memory increasing the cache will improve the
310 # performance by keeping more symbols in memory. Note that the value works on
311 # a logarithmic scale so increasing the size by one will rougly double the
312 # memory usage. The cache size is given by this formula:
313 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
314 # corresponding to a cache size of 2^16 = 65536 symbols
316 SYMBOL_CACHE_SIZE = 0
318 #---------------------------------------------------------------------------
319 # Build related configuration options
320 #---------------------------------------------------------------------------
322 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
323 # documentation are documented, even if no documentation was available.
324 # Private class members and static file members will be hidden unless
325 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
329 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
330 # will be included in the documentation.
332 EXTRACT_PRIVATE = YES
334 # If the EXTRACT_STATIC tag is set to YES all static members of a file
335 # will be included in the documentation.
339 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
340 # defined locally in source files will be included in the documentation.
341 # If set to NO only classes defined in header files are included.
343 EXTRACT_LOCAL_CLASSES = YES
345 # This flag is only useful for Objective-C code. When set to YES local
346 # methods, which are defined in the implementation section but not in
347 # the interface are included in the documentation.
348 # If set to NO (the default) only methods in the interface are included.
350 EXTRACT_LOCAL_METHODS = NO
352 # If this flag is set to YES, the members of anonymous namespaces will be
353 # extracted and appear in the documentation as a namespace called
354 # 'anonymous_namespace{file}', where file will be replaced with the base
355 # name of the file that contains the anonymous namespace. By default
356 # anonymous namespace are hidden.
358 EXTRACT_ANON_NSPACES = NO
360 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
361 # undocumented members of documented classes, files or namespaces.
362 # If set to NO (the default) these members will be included in the
363 # various overviews, but no documentation section is generated.
364 # This option has no effect if EXTRACT_ALL is enabled.
366 HIDE_UNDOC_MEMBERS = NO
368 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
369 # undocumented classes that are normally visible in the class hierarchy.
370 # If set to NO (the default) these classes will be included in the various
371 # overviews. This option has no effect if EXTRACT_ALL is enabled.
373 HIDE_UNDOC_CLASSES = NO
375 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
376 # friend (class|struct|union) declarations.
377 # If set to NO (the default) these declarations will be included in the
380 HIDE_FRIEND_COMPOUNDS = NO
382 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
383 # documentation blocks found inside the body of a function.
384 # If set to NO (the default) these blocks will be appended to the
385 # function's detailed documentation block.
387 HIDE_IN_BODY_DOCS = NO
389 # The INTERNAL_DOCS tag determines if documentation
390 # that is typed after a \internal command is included. If the tag is set
391 # to NO (the default) then the documentation will be excluded.
392 # Set it to YES to include the internal documentation.
396 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
397 # file names in lower-case letters. If set to YES upper-case letters are also
398 # allowed. This is useful if you have classes or files whose names only differ
399 # in case and if your file system supports case sensitive file names. Windows
400 # and Mac users are advised to set this option to NO.
402 CASE_SENSE_NAMES = YES
404 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
405 # will show members with their full class and namespace scopes in the
406 # documentation. If set to YES the scope will be hidden.
408 HIDE_SCOPE_NAMES = NO
410 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
411 # will put a list of the files that are included by a file in the documentation
414 SHOW_INCLUDE_FILES = YES
416 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
417 # is inserted in the documentation for inline members.
421 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
422 # will sort the (detailed) documentation of file and class members
423 # alphabetically by member name. If set to NO the members will appear in
426 SORT_MEMBER_DOCS = YES
428 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
429 # brief documentation of file, namespace and class members alphabetically
430 # by member name. If set to NO (the default) the members will appear in
435 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
437 SORT_MEMBERS_CTORS_1ST = NO
439 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
440 # hierarchy of group names into alphabetical order. If set to NO (the default)
441 # the group names will appear in their defined order.
443 SORT_GROUP_NAMES = NO
445 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
446 # sorted by fully-qualified names, including namespaces. If set to
447 # NO (the default), the class list will be sorted only by class name,
448 # not including the namespace part.
449 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
450 # Note: This option applies only to the class list, not to the
453 SORT_BY_SCOPE_NAME = NO
455 # The GENERATE_TODOLIST tag can be used to enable (YES) or
456 # disable (NO) the todo list. This list is created by putting \todo
457 # commands in the documentation.
459 GENERATE_TODOLIST = YES
461 # The GENERATE_TESTLIST tag can be used to enable (YES) or
462 # disable (NO) the test list. This list is created by putting \test
463 # commands in the documentation.
465 GENERATE_TESTLIST = YES
467 # The GENERATE_BUGLIST tag can be used to enable (YES) or
468 # disable (NO) the bug list. This list is created by putting \bug
469 # commands in the documentation.
471 GENERATE_BUGLIST = YES
473 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
474 # disable (NO) the deprecated list. This list is created by putting
475 # \deprecated commands in the documentation.
477 GENERATE_DEPRECATEDLIST= YES
479 # The ENABLED_SECTIONS tag can be used to enable conditional
480 # documentation sections, marked by \if sectionname ... \endif.
484 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
485 # the initial value of a variable or define consists of for it to appear in
486 # the documentation. If the initializer consists of more lines than specified
487 # here it will be hidden. Use a value of 0 to hide initializers completely.
488 # The appearance of the initializer of individual variables and defines in the
489 # documentation can be controlled using \showinitializer or \hideinitializer
490 # command in the documentation regardless of this setting.
492 MAX_INITIALIZER_LINES = 30
494 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
495 # at the bottom of the documentation of classes and structs. If set to YES the
496 # list will mention the files that were used to generate the documentation.
498 SHOW_USED_FILES = YES
500 # If the sources in your project are distributed over multiple directories
501 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
502 # in the documentation. The default is NO.
504 SHOW_DIRECTORIES = NO
506 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
507 # This will remove the Files entry from the Quick Index and from the
508 # Folder Tree View (if specified). The default is YES.
512 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
514 # This will remove the Namespaces entry from the Quick Index
515 # and from the Folder Tree View (if specified). The default is YES.
517 SHOW_NAMESPACES = YES
519 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
520 # doxygen should invoke to get the current version for each file (typically from
521 # the version control system). Doxygen will invoke the program by executing (via
522 # popen()) the command <command> <input-file>, where <command> is the value of
523 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
524 # provided by doxygen. Whatever the program writes to standard output
525 # is used as the file version. See the manual for examples.
527 FILE_VERSION_FILTER =
529 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
530 # doxygen. The layout file controls the global structure of the generated output files
531 # in an output format independent way. The create the layout file that represents
532 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
533 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
534 # of the layout file.
538 #---------------------------------------------------------------------------
539 # configuration options related to warning and progress messages
540 #---------------------------------------------------------------------------
542 # The QUIET tag can be used to turn on/off the messages that are generated
543 # by doxygen. Possible values are YES and NO. If left blank NO is used.
547 # The WARNINGS tag can be used to turn on/off the warning messages that are
548 # generated by doxygen. Possible values are YES and NO. If left blank
553 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
554 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
555 # automatically be disabled.
557 WARN_IF_UNDOCUMENTED = YES
559 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
560 # potential errors in the documentation, such as not documenting some
561 # parameters in a documented function, or documenting parameters that
562 # don't exist or using markup commands wrongly.
564 WARN_IF_DOC_ERROR = YES
566 # This WARN_NO_PARAMDOC option can be abled to get warnings for
567 # functions that are documented, but have no documentation for their parameters
568 # or return value. If set to NO (the default) doxygen will only warn about
569 # wrong or incomplete parameter documentation, but not about the absence of
572 WARN_NO_PARAMDOC = NO
574 # The WARN_FORMAT tag determines the format of the warning messages that
575 # doxygen can produce. The string should contain the $file, $line, and $text
576 # tags, which will be replaced by the file and line number from which the
577 # warning originated and the warning text. Optionally the format may contain
578 # $version, which will be replaced by the version of the file (if it could
579 # be obtained via FILE_VERSION_FILTER)
581 WARN_FORMAT = "$file:$line: $text"
583 # The WARN_LOGFILE tag can be used to specify a file to which warning
584 # and error messages should be written. If left blank the output is written
587 WARN_LOGFILE = @DOXYGEN_LOGFILE@
589 #---------------------------------------------------------------------------
590 # configuration options related to the input files
591 #---------------------------------------------------------------------------
593 # The INPUT tag can be used to specify the files and/or directories that contain
594 # documented source files. You may enter file names like "myfile.cpp" or
595 # directories like "/usr/src/myproject". Separate the files or directories
598 INPUT = @DOXYGEN_INPUT@
600 # This tag can be used to specify the character encoding of the source files
601 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
602 # also the default input encoding. Doxygen uses libiconv (or the iconv built
603 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
604 # the list of possible encodings.
606 INPUT_ENCODING = UTF-8
608 # If the value of the INPUT tag contains directories, you can use the
609 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
610 # and *.h) to filter out the source-files in the directories. If left
611 # blank the following patterns are tested:
612 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
613 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
615 FILE_PATTERNS = *.h \
619 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
620 # should be searched for input files as well. Possible values are YES and NO.
621 # If left blank NO is used.
625 # The EXCLUDE tag can be used to specify files and/or directories that should
626 # excluded from the INPUT source files. This way you can easily exclude a
627 # subdirectory from a directory tree whose root is specified with the INPUT tag.
629 EXCLUDE = @DOXYGEN_EXCLUDE@
631 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
632 # directories that are symbolic links (a Unix filesystem feature) are excluded
635 EXCLUDE_SYMLINKS = NO
637 # If the value of the INPUT tag contains directories, you can use the
638 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
639 # certain files from those directories. Note that the wildcards are matched
640 # against the file with absolute path, so to exclude all test directories
641 # for example use the pattern */test/*
645 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
646 # (namespaces, classes, functions, etc.) that should be excluded from the
647 # output. The symbol name can be a fully qualified name, a word, or if the
648 # wildcard * is used, a substring. Examples: ANamespace, AClass,
649 # AClass::ANamespace, ANamespace::*Test
653 # The EXAMPLE_PATH tag can be used to specify one or more files or
654 # directories that contain example code fragments that are included (see
655 # the \include command).
659 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
660 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
661 # and *.h) to filter out the source-files in the directories. If left
662 # blank all files are included.
664 EXAMPLE_PATTERNS = *.cxx
666 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
667 # searched for input files to be used with the \include or \dontinclude
668 # commands irrespective of the value of the RECURSIVE tag.
669 # Possible values are YES and NO. If left blank NO is used.
671 EXAMPLE_RECURSIVE = NO
673 # The IMAGE_PATH tag can be used to specify one or more files or
674 # directories that contain image that are included in the documentation (see
675 # the \image command).
679 # The INPUT_FILTER tag can be used to specify a program that doxygen should
680 # invoke to filter for each input file. Doxygen will invoke the filter program
681 # by executing (via popen()) the command <filter> <input-file>, where <filter>
682 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
683 # input file. Doxygen will then use the output that the filter program writes
684 # to standard output.
685 # If FILTER_PATTERNS is specified, this tag will be
690 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
692 # Doxygen will compare the file name with each pattern and apply the
693 # filter if there is a match.
694 # The filters are a list of the form:
695 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
696 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
697 # is applied to all files.
701 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
702 # INPUT_FILTER) will be used to filter the input files when producing source
703 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
705 FILTER_SOURCE_FILES = NO
707 #---------------------------------------------------------------------------
708 # configuration options related to source browsing
709 #---------------------------------------------------------------------------
711 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
712 # be generated. Documented entities will be cross-referenced with these sources.
713 # Note: To get rid of all source code in the generated output, make sure also
714 # VERBATIM_HEADERS is set to NO.
718 # Setting the INLINE_SOURCES tag to YES will include the body
719 # of functions and classes directly in the documentation.
723 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
724 # doxygen to hide any special comment blocks from generated source code
725 # fragments. Normal C and C++ comments will always remain visible.
727 STRIP_CODE_COMMENTS = YES
729 # If the REFERENCED_BY_RELATION tag is set to YES
730 # then for each documented function all documented
731 # functions referencing it will be listed.
733 REFERENCED_BY_RELATION = YES
735 # If the REFERENCES_RELATION tag is set to YES
736 # then for each documented function all documented entities
737 # called/used by that function will be listed.
739 REFERENCES_RELATION = YES
741 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
742 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
743 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
744 # link to the source code.
745 # Otherwise they will link to the documentation.
747 REFERENCES_LINK_SOURCE = YES
749 # If the USE_HTAGS tag is set to YES then the references to source code
750 # will point to the HTML generated by the htags(1) tool instead of doxygen
751 # built-in source browser. The htags tool is part of GNU's global source
752 # tagging system (see http://www.gnu.org/software/global/global.html). You
753 # will need version 4.8.6 or higher.
757 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
758 # will generate a verbatim copy of the header file for each class for
759 # which an include is specified. Set to NO to disable this.
761 VERBATIM_HEADERS = YES
763 #---------------------------------------------------------------------------
764 # configuration options related to the alphabetical class index
765 #---------------------------------------------------------------------------
767 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
768 # of all compounds will be generated. Enable this if the project
769 # contains a lot of classes, structs, unions or interfaces.
771 ALPHABETICAL_INDEX = YES
773 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
774 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
775 # in which this list will be split (can be a number in the range [1..20])
777 COLS_IN_ALPHA_INDEX = 3
779 # In case all classes in a project start with a common prefix, all
780 # classes will be put under the same header in the alphabetical index.
781 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
782 # should be ignored while generating the index headers.
786 #---------------------------------------------------------------------------
787 # configuration options related to the HTML output
788 #---------------------------------------------------------------------------
790 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
791 # generate HTML output.
795 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
796 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
797 # put in front of it. If left blank `html' will be used as the default path.
799 HTML_OUTPUT = @DOXYGEN_HTML_OUTPUT@
801 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
802 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
803 # doxygen will generate files with .html extension.
805 HTML_FILE_EXTENSION = .html
807 # The HTML_HEADER tag can be used to specify a personal HTML header for
808 # each generated HTML page. If it is left blank doxygen will generate a
813 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
814 # each generated HTML page. If it is left blank doxygen will generate a
819 # If the HTML_TIMESTAMP tag is set to YES then the generated HTML
820 # documentation will contain the timesstamp.
824 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
825 # style sheet that is used by each HTML page. It can be used to
826 # fine-tune the look of the HTML output. If the tag is left blank doxygen
827 # will generate a default style sheet. Note that doxygen will try to copy
828 # the style sheet file to the HTML output directory, so don't put your own
829 # stylesheet in the HTML output directory as well, or it will be erased!
833 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
834 # files or namespaces will be aligned in HTML using tables. If set to
835 # NO a bullet list will be used.
837 HTML_ALIGN_MEMBERS = YES
839 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
840 # documentation will contain sections that can be hidden and shown after the
841 # page has loaded. For this to work a browser that supports
842 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
843 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
845 HTML_DYNAMIC_SECTIONS = NO
847 # If the GENERATE_DOCSET tag is set to YES, additional index files
848 # will be generated that can be used as input for Apple's Xcode 3
849 # integrated development environment, introduced with OSX 10.5 (Leopard).
850 # To create a documentation set, doxygen will generate a Makefile in the
851 # HTML output directory. Running make will produce the docset in that
852 # directory and running "make install" will install the docset in
853 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
855 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
859 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
860 # feed. A documentation feed provides an umbrella under which multiple
861 # documentation sets from a single provider (such as a company or product suite)
864 DOCSET_FEEDNAME = "Doxygen generated docs"
866 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
867 # should uniquely identify the documentation set bundle. This should be a
868 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
869 # will append .docset to the name.
871 DOCSET_BUNDLE_ID = org.doxygen.Project
873 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
874 # will be generated that can be used as input for tools like the
875 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
876 # of the generated HTML documentation.
878 GENERATE_HTMLHELP = NO
880 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
881 # be used to specify the file name of the resulting .chm file. You
882 # can add a path in front of the file if the result should not be
883 # written to the html output directory.
887 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
888 # be used to specify the location (absolute path including file name) of
889 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
890 # the HTML help compiler on the generated index.hhp.
894 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
895 # controls if a separate .chi index file is generated (YES) or that
896 # it should be included in the master .chm file (NO).
900 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
901 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
906 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
907 # controls whether a binary table of contents is generated (YES) or a
908 # normal table of contents (NO) in the .chm file.
912 # The TOC_EXPAND flag can be set to YES to add extra items for group members
913 # to the contents of the HTML help documentation and to the tree view.
917 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
918 # are set, an additional index file will be generated that can be used as input for
919 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
920 # HTML documentation.
924 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
925 # be used to specify the file name of the resulting .qch file.
926 # The path specified is relative to the HTML output folder.
930 # The QHP_NAMESPACE tag specifies the namespace to use when generating
931 # Qt Help Project output. For more information please see
932 # http://doc.trolltech.com/qthelpproject.html#namespace
936 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
937 # Qt Help Project output. For more information please see
938 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
940 QHP_VIRTUAL_FOLDER = doc
942 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
943 # For more information please see
944 # http://doc.trolltech.com/qthelpproject.html#custom-filters
946 QHP_CUST_FILTER_NAME =
948 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
949 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
951 QHP_CUST_FILTER_ATTRS =
953 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
954 # filter section matches.
955 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
957 QHP_SECT_FILTER_ATTRS =
959 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
960 # be used to specify the location of Qt's qhelpgenerator.
961 # If non-empty doxygen will try to run qhelpgenerator on the generated
966 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
967 # top of each HTML page. The value NO (the default) enables the index and
968 # the value YES disables it.
972 # This tag can be used to set the number of enum values (range [1..20])
973 # that doxygen will group on one line in the generated HTML documentation.
975 ENUM_VALUES_PER_LINE = 4
977 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
978 # structure should be generated to display hierarchical information.
979 # If the tag value is set to YES, a side panel will be generated
980 # containing a tree-like index structure (just like the one that
981 # is generated for HTML Help). For this to work a browser that supports
982 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
983 # Windows users are probably better off using the HTML help feature.
985 GENERATE_TREEVIEW = YES
987 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
988 # and Class Hierarchy pages using a tree view instead of an ordered list.
990 USE_INLINE_TREES = NO
992 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
993 # used to set the initial width (in pixels) of the frame in which the tree
998 # Use this tag to change the font size of Latex formulas included
999 # as images in the HTML documentation. The default is 10. Note that
1000 # when you change the font size after a successful doxygen run you need
1001 # to manually remove any form_*.png images from the HTML output directory
1002 # to force them to be regenerated.
1004 FORMULA_FONTSIZE = 10
1006 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
1007 # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
1008 # there is already a search function so this one should typically
1013 #---------------------------------------------------------------------------
1014 # configuration options related to the LaTeX output
1015 #---------------------------------------------------------------------------
1017 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1018 # generate Latex output.
1022 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1023 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1024 # put in front of it. If left blank `latex' will be used as the default path.
1026 LATEX_OUTPUT = latex
1028 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1029 # invoked. If left blank `latex' will be used as the default command name.
1031 LATEX_CMD_NAME = latex
1033 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1034 # generate index for LaTeX. If left blank `makeindex' will be used as the
1035 # default command name.
1037 MAKEINDEX_CMD_NAME = makeindex
1039 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1040 # LaTeX documents. This may be useful for small projects and may help to
1041 # save some trees in general.
1045 # The PAPER_TYPE tag can be used to set the paper type that is used
1046 # by the printer. Possible values are: a4, a4wide, letter, legal and
1047 # executive. If left blank a4wide will be used.
1051 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1052 # packages that should be included in the LaTeX output.
1056 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1057 # the generated latex document. The header should contain everything until
1058 # the first chapter. If it is left blank doxygen will generate a
1059 # standard header. Notice: only use this tag if you know what you are doing!
1063 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1064 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1065 # contain links (just like the HTML output) instead of page references
1066 # This makes the output suitable for online browsing using a pdf viewer.
1070 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1071 # plain latex in the generated Makefile. Set this option to YES to get a
1072 # higher quality PDF documentation.
1076 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1077 # command to the generated LaTeX files. This will instruct LaTeX to keep
1078 # running if errors occur, instead of asking the user for help.
1079 # This option is also used when generating formulas in HTML.
1081 LATEX_BATCHMODE = NO
1083 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1084 # include the index chapters (such as File Index, Compound Index, etc.)
1087 LATEX_HIDE_INDICES = NO
1089 # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
1091 LATEX_SOURCE_CODE = NO
1093 #---------------------------------------------------------------------------
1094 # configuration options related to the RTF output
1095 #---------------------------------------------------------------------------
1097 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1098 # The RTF output is optimized for Word 97 and may not look very pretty with
1099 # other RTF readers or editors.
1103 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1104 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1105 # put in front of it. If left blank `rtf' will be used as the default path.
1109 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1110 # RTF documents. This may be useful for small projects and may help to
1111 # save some trees in general.
1115 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1116 # will contain hyperlink fields. The RTF file will
1117 # contain links (just like the HTML output) instead of page references.
1118 # This makes the output suitable for online browsing using WORD or other
1119 # programs which support those fields.
1120 # Note: wordpad (write) and others do not support links.
1124 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1125 # config file, i.e. a series of assignments. You only have to provide
1126 # replacements, missing definitions are set to their default value.
1128 RTF_STYLESHEET_FILE =
1130 # Set optional variables used in the generation of an rtf document.
1131 # Syntax is similar to doxygen's config file.
1133 RTF_EXTENSIONS_FILE =
1135 #---------------------------------------------------------------------------
1136 # configuration options related to the man page output
1137 #---------------------------------------------------------------------------
1139 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1140 # generate man pages
1144 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1145 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1146 # put in front of it. If left blank `man' will be used as the default path.
1150 # The MAN_EXTENSION tag determines the extension that is added to
1151 # the generated man pages (default is the subroutine's section .3)
1155 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1156 # then it will generate one additional man file for each entity
1157 # documented in the real man page(s). These additional files
1158 # only source the real man page, but without them the man command
1159 # would be unable to find the correct page. The default is NO.
1163 #---------------------------------------------------------------------------
1164 # configuration options related to the XML output
1165 #---------------------------------------------------------------------------
1167 # If the GENERATE_XML tag is set to YES Doxygen will
1168 # generate an XML file that captures the structure of
1169 # the code including all documentation.
1173 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1174 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1175 # put in front of it. If left blank `xml' will be used as the default path.
1179 # The XML_SCHEMA tag can be used to specify an XML schema,
1180 # which can be used by a validating XML parser to check the
1181 # syntax of the XML files.
1185 # The XML_DTD tag can be used to specify an XML DTD,
1186 # which can be used by a validating XML parser to check the
1187 # syntax of the XML files.
1191 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1192 # dump the program listings (including syntax highlighting
1193 # and cross-referencing information) to the XML output. Note that
1194 # enabling this will significantly increase the size of the XML output.
1196 XML_PROGRAMLISTING = YES
1198 #---------------------------------------------------------------------------
1199 # configuration options for the AutoGen Definitions output
1200 #---------------------------------------------------------------------------
1202 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1203 # generate an AutoGen Definitions (see autogen.sf.net) file
1204 # that captures the structure of the code including all
1205 # documentation. Note that this feature is still experimental
1206 # and incomplete at the moment.
1208 GENERATE_AUTOGEN_DEF = NO
1210 #---------------------------------------------------------------------------
1211 # configuration options related to the Perl module output
1212 #---------------------------------------------------------------------------
1214 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1215 # generate a Perl module file that captures the structure of
1216 # the code including all documentation. Note that this
1217 # feature is still experimental and incomplete at the
1220 GENERATE_PERLMOD = NO
1222 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1223 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1224 # to generate PDF and DVI output from the Perl module output.
1228 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1229 # nicely formatted so it can be parsed by a human reader.
1231 # if you want to understand what is going on.
1232 # On the other hand, if this
1233 # tag is set to NO the size of the Perl module output will be much smaller
1234 # and Perl will parse it just the same.
1236 PERLMOD_PRETTY = YES
1238 # The names of the make variables in the generated doxyrules.make file
1239 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1240 # This is useful so different doxyrules.make files included by the same
1241 # Makefile don't overwrite each other's variables.
1243 PERLMOD_MAKEVAR_PREFIX =
1245 #---------------------------------------------------------------------------
1246 # Configuration options related to the preprocessor
1247 #---------------------------------------------------------------------------
1249 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1250 # evaluate all C-preprocessor directives found in the sources and include
1253 ENABLE_PREPROCESSING = YES
1255 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1256 # names in the source code. If set to NO (the default) only conditional
1257 # compilation will be performed. Macro expansion can be done in a controlled
1258 # way by setting EXPAND_ONLY_PREDEF to YES.
1260 MACRO_EXPANSION = YES
1262 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1263 # then the macro expansion is limited to the macros specified with the
1264 # PREDEFINED and EXPAND_AS_DEFINED tags.
1266 EXPAND_ONLY_PREDEF = NO
1268 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1269 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1271 SEARCH_INCLUDES = YES
1273 # The INCLUDE_PATH tag can be used to specify one or more directories that
1274 # contain include files that are not input files but should be processed by
1279 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1280 # patterns (like *.h and *.hpp) to filter out the header-files in the
1281 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1284 INCLUDE_FILE_PATTERNS =
1286 # The PREDEFINED tag can be used to specify one or more macro names that
1287 # are defined before the preprocessor is started (similar to the -D option of
1288 # gcc). The argument of the tag is a list of macros of the form: name
1289 # or name=definition (no spaces). If the definition and the = are
1290 # omitted =1 is assumed. To prevent a macro definition from being
1291 # undefined via #undef or recursively expanded use the := operator
1292 # instead of the = operator.
1294 PREDEFINED = @DOXYGEN_DOC_PREDEFINED@
1296 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1297 # this tag can be used to specify a list of macro names that should be expanded.
1298 # The macro definition that is found in the sources will be used.
1299 # Use the PREDEFINED tag if you want to use a different macro definition.
1303 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1304 # doxygen's preprocessor will remove all function-like macros that are alone
1305 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1306 # function macros are typically used for boiler-plate code, and will confuse
1307 # the parser if not removed.
1309 SKIP_FUNCTION_MACROS = YES
1311 #---------------------------------------------------------------------------
1312 # Configuration::additions related to external references
1313 #---------------------------------------------------------------------------
1315 # The TAGFILES option can be used to specify one or more tagfiles.
1316 # Optionally an initial location of the external documentation
1317 # can be added for each tagfile. The format of a tag file without
1318 # this location is as follows:
1320 # TAGFILES = file1 file2 ...
1321 # Adding location for the tag files is done as follows:
1323 # TAGFILES = file1=loc1 "file2 = loc2" ...
1324 # where "loc1" and "loc2" can be relative or absolute paths or
1325 # URLs. If a location is present for each tag, the installdox tool
1326 # does not have to be run to correct the links.
1327 # Note that each tag file must have a unique name
1328 # (where the name does NOT include the path)
1329 # If a tag file is not located in the directory in which doxygen
1330 # is run, you must also specify the path to the tagfile here.
1334 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1335 # a tag file that is based on the input files it reads.
1339 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1340 # in the class index. If set to NO only the inherited external classes
1345 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1346 # in the modules index. If set to NO, only the current project's groups will
1349 EXTERNAL_GROUPS = YES
1351 # The PERL_PATH should be the absolute path and name of the perl script
1352 # interpreter (i.e. the result of `which perl').
1354 PERL_PATH = /usr/bin/perl
1356 #---------------------------------------------------------------------------
1357 # Configuration options related to the dot tool
1358 #---------------------------------------------------------------------------
1360 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1361 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1362 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1363 # this option is superseded by the HAVE_DOT option below. This is only a
1364 # fallback. It is recommended to install and use dot, since it yields more
1367 CLASS_DIAGRAMS = YES
1369 # You can define message sequence charts within doxygen comments using the \msc
1370 # command. Doxygen will then run the mscgen tool (see
1371 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1372 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1373 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1374 # default search path.
1378 # If set to YES, the inheritance and collaboration graphs will hide
1379 # inheritance and usage relations if the target is undocumented
1380 # or is not a class.
1382 HIDE_UNDOC_RELATIONS = YES
1384 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1385 # available from the path. This tool is part of Graphviz, a graph visualization
1386 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1387 # have no effect if this option is set to NO (the default)
1389 HAVE_DOT = @DOXYGEN_HAVE_DOT@
1391 # By default doxygen will write a font called FreeSans.ttf to the output
1392 # directory and reference it in all dot files that doxygen generates. This
1393 # font does not include all possible unicode characters however, so when you need
1394 # these (or just want a differently looking font) you can specify the font name
1395 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1396 # which can be done by putting it in a standard location or by setting the
1397 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1398 # containing the font.
1400 DOT_FONTNAME = FreeSans
1402 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1403 # The default size is 10pt.
1407 # By default doxygen will tell dot to use the output directory to look for the
1408 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1409 # different font using DOT_FONTNAME you can set the path where dot
1410 # can find it using this tag.
1414 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1415 # will generate a graph for each documented class showing the direct and
1416 # indirect inheritance relations. Setting this tag to YES will force the
1417 # the CLASS_DIAGRAMS tag to NO.
1421 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1422 # will generate a graph for each documented class showing the direct and
1423 # indirect implementation dependencies (inheritance, containment, and
1424 # class references variables) of the class with other documented classes.
1426 COLLABORATION_GRAPH = YES
1428 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1429 # will generate a graph for groups, showing the direct groups dependencies
1433 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1434 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1439 # If set to YES, the inheritance and collaboration graphs will show the
1440 # relations between templates and their instances.
1442 TEMPLATE_RELATIONS = YES
1444 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1445 # tags are set to YES then doxygen will generate a graph for each documented
1446 # file showing the direct and indirect include dependencies of the file with
1447 # other documented files.
1451 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1452 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1453 # documented header file showing the documented files that directly or
1454 # indirectly include this file.
1456 INCLUDED_BY_GRAPH = YES
1458 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1459 # doxygen will generate a call dependency graph for every global function
1460 # or class method. Note that enabling this option will significantly increase
1461 # the time of a run. So in most cases it will be better to enable call graphs
1462 # for selected functions only using the \callgraph command.
1466 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1467 # doxygen will generate a caller dependency graph for every global function
1468 # or class method. Note that enabling this option will significantly increase
1469 # the time of a run. So in most cases it will be better to enable caller
1470 # graphs for selected functions only using the \callergraph command.
1474 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1475 # will graphical hierarchy of all classes instead of a textual one.
1477 GRAPHICAL_HIERARCHY = YES
1479 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1480 # then doxygen will show the dependencies a directory has on other directories
1481 # in a graphical way. The dependency relations are determined by the #include
1482 # relations between the files in the directories.
1484 DIRECTORY_GRAPH = YES
1486 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1487 # generated by dot. Possible values are png, jpg, or gif
1488 # If left blank png will be used.
1490 DOT_IMAGE_FORMAT = png
1492 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1493 # found. If left blank, it is assumed the dot tool can be found in the path.
1495 DOT_PATH = "@DOXYGEN_DOT_PATH@"
1497 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1498 # contain dot files that are included in the documentation (see the
1499 # \dotfile command).
1503 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1504 # nodes that will be shown in the graph. If the number of nodes in a graph
1505 # becomes larger than this value, doxygen will truncate the graph, which is
1506 # visualized by representing a node as a red box. Note that doxygen if the
1507 # number of direct children of the root node in a graph is already larger than
1508 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1509 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1511 DOT_GRAPH_MAX_NODES = 50
1513 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1514 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1515 # from the root by following a path via at most 3 edges will be shown. Nodes
1516 # that lay further from the root node will be omitted. Note that setting this
1517 # option to 1 or 2 may greatly reduce the computation time needed for large
1518 # code bases. Also note that the size of a graph can be further restricted by
1519 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1521 MAX_DOT_GRAPH_DEPTH = 0
1523 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1524 # background. This is disabled by default, because dot on Windows does not
1525 # seem to support this out of the box. Warning: Depending on the platform used,
1526 # enabling this option may lead to badly anti-aliased labels on the edges of
1527 # a graph (i.e. they become hard to read).
1529 DOT_TRANSPARENT = NO
1531 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1532 # files in one run (i.e. multiple -o and -T options on the command line). This
1533 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1534 # support this, this feature is disabled by default.
1536 DOT_MULTI_TARGETS = NO
1538 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1539 # generate a legend page explaining the meaning of the various boxes and
1540 # arrows in the dot generated graphs.
1542 GENERATE_LEGEND = YES
1544 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1545 # remove the intermediate dot files that are used to generate
1546 # the various graphs.