2 # Copyright (C) 2012 Modelon AB
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the Common Public License as published by
6 # IBM, version 1.0 of the License.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY. See the Common Public License for more details.
11 # You should have received a copy of the Common Public License
12 # along with this program. If not, see
13 # <http://www.ibm.com/developerworks/library/os-cpl.html/>.
18 # This file describes the settings to be used by the documentation system
19 # doxygen (www.doxygen.org) for a project
21 # All text after a hash (#) is considered a comment and will be ignored
23 # TAG = value [value, ...]
24 # For lists items can also be appended using:
25 # TAG += value [value, ...]
26 # Values that contain spaces should be placed between quotes (" ")
28 #---------------------------------------------------------------------------
29 # Project related configuration options
30 #---------------------------------------------------------------------------
32 # This tag specifies the encoding used for all characters in the config file
33 # that follow. The default is UTF-8 which is also the encoding used for all
34 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
35 # iconv built into libc) for the transcoding. See
36 # http://www.gnu.org/software/libiconv for the list of possible encodings.
38 DOXYFILE_ENCODING = UTF-8
40 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
41 # by quotes) that should identify the project.
43 PROJECT_NAME = "FMI Library: part of JModelica.org"
45 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
46 # This could be handy for archiving the generated documentation or
47 # if some version control system is used.
49 PROJECT_NUMBER = "@PROJECT_VERSION@"
51 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
52 # base path where the generated documentation will be put.
53 # If a relative path is entered, it will be relative to the location
54 # where doxygen was started. If left blank the current directory will be used.
56 OUTPUT_DIRECTORY = "@DOXYFILE_OUTPUT_DIR@"
58 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
59 # 4096 sub-directories (in 2 levels) under the output directory of each output
60 # format and will distribute the generated files over these directories.
61 # Enabling this option can be useful when feeding doxygen a huge amount of
62 # source files, where putting all generated files in the same directory would
63 # otherwise cause performance problems for the file system.
67 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
68 # documentation generated by doxygen is written. Doxygen will use this
69 # information to generate all constant output in the proper language.
70 # The default language is English, other supported languages are:
71 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
72 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
73 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
74 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
75 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
78 OUTPUT_LANGUAGE = English
80 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
81 # include brief member descriptions after the members that are listed in
82 # the file and class documentation (similar to JavaDoc).
83 # Set to NO to disable this.
85 BRIEF_MEMBER_DESC = YES
87 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
88 # the brief description of a member or function before the detailed description.
89 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
90 # brief descriptions will be completely suppressed.
94 # This tag implements a quasi-intelligent brief description abbreviator
95 # that is used to form the text in various listings. Each string
96 # in this list, if found as the leading text of the brief description, will be
97 # stripped from the text and the result after processing the whole list, is
98 # used as the annotated text. Otherwise, the brief description is used as-is.
99 # If left blank, the following values are used ("$name" is automatically
100 # replaced with the name of the entity): "The $name class" "The $name widget"
101 # "The $name file" "is" "provides" "specifies" "contains"
102 # "represents" "a" "an" "the"
106 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
107 # Doxygen will generate a detailed section even if there is only a brief
110 ALWAYS_DETAILED_SEC = YES
112 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
113 # inherited members of a class in the documentation of that class as if those
114 # members were ordinary class members. Constructors, destructors and assignment
115 # operators of the base classes will not be shown.
117 INLINE_INHERITED_MEMB = NO
119 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
120 # path before files name in the file list and in the header files. If set
121 # to NO the shortest path that makes the file name unique will be used.
123 FULL_PATH_NAMES = YES
125 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
126 # can be used to strip a user-defined part of the path. Stripping is
127 # only done if one of the specified strings matches the left-hand part of
128 # the path. The tag can be used to show relative paths in the file list.
129 # If left blank the directory from which doxygen is run is used as the
132 STRIP_FROM_PATH = "@DOXYFILE_STRIP_FROM_PATH@"
134 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
135 # the path mentioned in the documentation of a class, which tells
136 # the reader which header file to include in order to use a class.
137 # If left blank only the name of the header file containing the class
138 # definition is used. Otherwise one should specify the include paths that
139 # are normally passed to the compiler using the -I flag.
141 STRIP_FROM_INC_PATH =
143 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
144 # (but less readable) file names. This can be useful is your file systems
145 # doesn't support long names like on DOS, Mac, or CD-ROM.
149 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
150 # will interpret the first line (until the first dot) of a JavaDoc-style
151 # comment as the brief description. If set to NO, the JavaDoc
152 # comments will behave just like regular Qt-style comments
153 # (thus requiring an explicit @brief command for a brief description.)
155 JAVADOC_AUTOBRIEF = NO
157 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
158 # interpret the first line (until the first dot) of a Qt-style
159 # comment as the brief description. If set to NO, the comments
160 # will behave just like regular Qt-style comments (thus requiring
161 # an explicit \brief command for a brief description.)
165 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
166 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
167 # comments) as a brief description. This used to be the default behaviour.
168 # The new default is to treat a multi-line C++ comment block as a detailed
169 # description. Set this tag to YES if you prefer the old behaviour instead.
171 MULTILINE_CPP_IS_BRIEF = NO
173 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
174 # member inherits the documentation from any documented member that it
179 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
180 # a new page for each member. If set to NO, the documentation of a member will
181 # be part of the file/class/namespace that contains it.
183 SEPARATE_MEMBER_PAGES = NO
185 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
186 # Doxygen uses this value to replace tabs by spaces in code fragments.
190 # This tag can be used to specify a number of aliases that acts
191 # as commands in the documentation. An alias has the form "name=value".
192 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
193 # put the command \sideeffect (or @sideeffect) in the documentation, which
194 # will result in a user-defined paragraph with heading "Side Effects:".
195 # You can put \n's in the value part of an alias to insert newlines.
199 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
200 # sources only. Doxygen will then generate output that is more tailored for C.
201 # For instance, some of the names that are used will be different. The list
202 # of all members will be omitted, etc.
204 OPTIMIZE_OUTPUT_FOR_C = YES
206 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
207 # sources only. Doxygen will then generate output that is more tailored for
208 # Java. For instance, namespaces will be presented as packages, qualified
209 # scopes will look different, etc.
211 OPTIMIZE_OUTPUT_JAVA = NO
213 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
214 # sources only. Doxygen will then generate output that is more tailored for
217 OPTIMIZE_FOR_FORTRAN = NO
219 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
220 # sources. Doxygen will then generate output that is tailored for
223 OPTIMIZE_OUTPUT_VHDL = NO
225 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
226 # to include (a tag file for) the STL sources as input, then you should
227 # set this tag to YES in order to let doxygen match functions declarations and
228 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
229 # func(std::string) {}). This also make the inheritance and collaboration
230 # diagrams that involve STL classes more complete and accurate.
232 BUILTIN_STL_SUPPORT = NO
234 # If you use Microsoft's C++/CLI language, you should set this option to YES to
235 # enable parsing support.
239 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
240 # Doxygen will parse them like normal C++ but will assume all classes use public
241 # instead of private inheritance when no explicit protection keyword is present.
245 # For Microsoft's IDL there are propget and propput attributes to indicate getter
246 # and setter methods for a property. Setting this option to YES (the default)
247 # will make doxygen to replace the get and set methods by a property in the
248 # documentation. This will only work if the methods are indeed getting or
249 # setting a simple type. If this is not the case, or you want to show the
250 # methods anyway, you should set this option to NO.
252 IDL_PROPERTY_SUPPORT = YES
254 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
255 # tag is set to YES, then doxygen will reuse the documentation of the first
256 # member in the group (if any) for the other members of the group. By default
257 # all members of a group must be documented explicitly.
259 DISTRIBUTE_GROUP_DOC = NO
261 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
262 # the same type (for instance a group of public functions) to be put as a
263 # subgroup of that type (e.g. under the Public Functions section). Set it to
264 # NO to prevent subgrouping. Alternatively, this can be done per class using
265 # the \nosubgrouping command.
269 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
270 # is documented as struct, union, or enum with the name of the typedef. So
271 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
272 # with name TypeT. When disabled the typedef will appear as a member of a file,
273 # namespace, or class. And the struct will be named TypeS. This can typically
274 # be useful for C code in case the coding convention dictates that all compound
275 # types are typedef'ed and only the typedef is referenced, never the tag name.
277 TYPEDEF_HIDES_STRUCT = NO
279 #---------------------------------------------------------------------------
280 # Build related configuration options
281 #---------------------------------------------------------------------------
283 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
284 # documentation are documented, even if no documentation was available.
285 # Private class members and static file members will be hidden unless
286 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
290 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
291 # will be included in the documentation.
293 EXTRACT_PRIVATE = YES
295 # If the EXTRACT_STATIC tag is set to YES all static members of a file
296 # will be included in the documentation.
300 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
301 # defined locally in source files will be included in the documentation.
302 # If set to NO only classes defined in header files are included.
304 EXTRACT_LOCAL_CLASSES = YES
306 # This flag is only useful for Objective-C code. When set to YES local
307 # methods, which are defined in the implementation section but not in
308 # the interface are included in the documentation.
309 # If set to NO (the default) only methods in the interface are included.
311 EXTRACT_LOCAL_METHODS = YES
313 # If this flag is set to YES, the members of anonymous namespaces will be
314 # extracted and appear in the documentation as a namespace called
315 # 'anonymous_namespace{file}', where file will be replaced with the base
316 # name of the file that contains the anonymous namespace. By default
317 # anonymous namespace are hidden.
319 EXTRACT_ANON_NSPACES = YES
321 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
322 # undocumented members of documented classes, files or namespaces.
323 # If set to NO (the default) these members will be included in the
324 # various overviews, but no documentation section is generated.
325 # This option has no effect if EXTRACT_ALL is enabled.
327 HIDE_UNDOC_MEMBERS = NO
329 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
330 # undocumented classes that are normally visible in the class hierarchy.
331 # If set to NO (the default) these classes will be included in the various
332 # overviews. This option has no effect if EXTRACT_ALL is enabled.
334 HIDE_UNDOC_CLASSES = NO
336 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
337 # friend (class|struct|union) declarations.
338 # If set to NO (the default) these declarations will be included in the
341 HIDE_FRIEND_COMPOUNDS = NO
343 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
344 # documentation blocks found inside the body of a function.
345 # If set to NO (the default) these blocks will be appended to the
346 # function's detailed documentation block.
348 HIDE_IN_BODY_DOCS = NO
350 # The INTERNAL_DOCS tag determines if documentation
351 # that is typed after a \internal command is included. If the tag is set
352 # to NO (the default) then the documentation will be excluded.
353 # Set it to YES to include the internal documentation.
357 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
358 # file names in lower-case letters. If set to YES upper-case letters are also
359 # allowed. This is useful if you have classes or files whose names only differ
360 # in case and if your file system supports case sensitive file names. Windows
361 # and Mac users are advised to set this option to NO.
363 CASE_SENSE_NAMES = YES
365 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
366 # will show members with their full class and namespace scopes in the
367 # documentation. If set to YES the scope will be hidden.
369 HIDE_SCOPE_NAMES = NO
371 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
372 # will put a list of the files that are included by a file in the documentation
375 SHOW_INCLUDE_FILES = YES
377 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
378 # is inserted in the documentation for inline members.
382 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
383 # will sort the (detailed) documentation of file and class members
384 # alphabetically by member name. If set to NO the members will appear in
387 SORT_MEMBER_DOCS = NO
389 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
390 # brief documentation of file, namespace and class members alphabetically
391 # by member name. If set to NO (the default) the members will appear in
396 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
397 # hierarchy of group names into alphabetical order. If set to NO (the default)
398 # the group names will appear in their defined order.
400 SORT_GROUP_NAMES = NO
402 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
403 # sorted by fully-qualified names, including namespaces. If set to
404 # NO (the default), the class list will be sorted only by class name,
405 # not including the namespace part.
406 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
407 # Note: This option applies only to the class list, not to the
410 SORT_BY_SCOPE_NAME = NO
412 # The GENERATE_TODOLIST tag can be used to enable (YES) or
413 # disable (NO) the todo list. This list is created by putting \todo
414 # commands in the documentation.
416 GENERATE_TODOLIST = YES
418 # The GENERATE_TESTLIST tag can be used to enable (YES) or
419 # disable (NO) the test list. This list is created by putting \test
420 # commands in the documentation.
422 GENERATE_TESTLIST = YES
424 # The GENERATE_BUGLIST tag can be used to enable (YES) or
425 # disable (NO) the bug list. This list is created by putting \bug
426 # commands in the documentation.
428 GENERATE_BUGLIST = YES
430 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
431 # disable (NO) the deprecated list. This list is created by putting
432 # \deprecated commands in the documentation.
434 GENERATE_DEPRECATEDLIST= YES
436 # The ENABLED_SECTIONS tag can be used to enable conditional
437 # documentation sections, marked by \if sectionname ... \endif.
441 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
442 # the initial value of a variable or define consists of for it to appear in
443 # the documentation. If the initializer consists of more lines than specified
444 # here it will be hidden. Use a value of 0 to hide initializers completely.
445 # The appearance of the initializer of individual variables and defines in the
446 # documentation can be controlled using \showinitializer or \hideinitializer
447 # command in the documentation regardless of this setting.
449 MAX_INITIALIZER_LINES = 30
451 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
452 # at the bottom of the documentation of classes and structs. If set to YES the
453 # list will mention the files that were used to generate the documentation.
455 SHOW_USED_FILES = YES
457 # If the sources in your project are distributed over multiple directories
458 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
459 # in the documentation. The default is NO.
461 SHOW_DIRECTORIES = YES
463 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
464 # This will remove the Files entry from the Quick Index and from the
465 # Folder Tree View (if specified). The default is YES.
469 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
470 # Namespaces page. This will remove the Namespaces entry from the Quick Index
471 # and from the Folder Tree View (if specified). The default is YES.
473 SHOW_NAMESPACES = YES
475 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
476 # doxygen should invoke to get the current version for each file (typically from
477 # the version control system). Doxygen will invoke the program by executing (via
478 # popen()) the command <command> <input-file>, where <command> is the value of
479 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
480 # provided by doxygen. Whatever the program writes to standard output
481 # is used as the file version. See the manual for examples.
483 FILE_VERSION_FILTER =
485 #---------------------------------------------------------------------------
486 # configuration options related to warning and progress messages
487 #---------------------------------------------------------------------------
489 # The QUIET tag can be used to turn on/off the messages that are generated
490 # by doxygen. Possible values are YES and NO. If left blank NO is used.
494 # The WARNINGS tag can be used to turn on/off the warning messages that are
495 # generated by doxygen. Possible values are YES and NO. If left blank
500 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
501 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
502 # automatically be disabled.
504 WARN_IF_UNDOCUMENTED = YES
506 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
507 # potential errors in the documentation, such as not documenting some
508 # parameters in a documented function, or documenting parameters that
509 # don't exist or using markup commands wrongly.
511 WARN_IF_DOC_ERROR = YES
513 # This WARN_NO_PARAMDOC option can be abled to get warnings for
514 # functions that are documented, but have no documentation for their parameters
515 # or return value. If set to NO (the default) doxygen will only warn about
516 # wrong or incomplete parameter documentation, but not about the absence of
519 WARN_NO_PARAMDOC = NO
521 # The WARN_FORMAT tag determines the format of the warning messages that
522 # doxygen can produce. The string should contain the $file, $line, and $text
523 # tags, which will be replaced by the file and line number from which the
524 # warning originated and the warning text. Optionally the format may contain
525 # $version, which will be replaced by the version of the file (if it could
526 # be obtained via FILE_VERSION_FILTER)
528 WARN_FORMAT = "$file($line): $text"
530 # The WARN_LOGFILE tag can be used to specify a file to which warning
531 # and error messages should be written. If left blank the output is written
536 #---------------------------------------------------------------------------
537 # configuration options related to the input files
538 #---------------------------------------------------------------------------
540 # The INPUT tag can be used to specify the files and/or directories that contain
541 # documented source files. You may enter file names like "myfile.cpp" or
542 # directories like "/usr/src/myproject". Separate the files or directories
545 INPUT = @DOXYFILE_SOURCE_DIRS@
547 # This tag can be used to specify the character encoding of the source files
548 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
549 # also the default input encoding. Doxygen uses libiconv (or the iconv built
550 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
551 # the list of possible encodings.
553 INPUT_ENCODING = UTF-8
555 # If the value of the INPUT tag contains directories, you can use the
556 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
557 # and *.h) to filter out the source-files in the directories. If left
558 # blank the following patterns are tested:
559 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
560 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
562 FILE_PATTERNS = *.h *.c *.cc
564 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
565 # should be searched for input files as well. Possible values are YES and NO.
566 # If left blank NO is used.
570 # The EXCLUDE tag can be used to specify files and/or directories that should
571 # excluded from the INPUT source files. This way you can easily exclude a
572 # subdirectory from a directory tree whose root is specified with the INPUT tag.
576 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
577 # directories that are symbolic links (a Unix filesystem feature) are excluded
580 EXCLUDE_SYMLINKS = NO
582 # If the value of the INPUT tag contains directories, you can use the
583 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
584 # certain files from those directories. Note that the wildcards are matched
585 # against the file with absolute path, so to exclude all test directories
586 # for example use the pattern */test/*
588 EXCLUDE_PATTERNS = "*/.*" "*/.*/*"
590 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
591 # (namespaces, classes, functions, etc.) that should be excluded from the
592 # output. The symbol name can be a fully qualified name, a word, or if the
593 # wildcard * is used, a substring. Examples: ANamespace, AClass,
594 # AClass::ANamespace, ANamespace::*Test
598 # The EXAMPLE_PATH tag can be used to specify one or more files or
599 # directories that contain example code fragments that are included (see
600 # the \include command).
602 EXAMPLE_PATH = "@CMAKE_CURRENT_SOURCE_DIR@/examples"
604 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
605 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
606 # and *.h) to filter out the source-files in the directories. If left
607 # blank all files are included.
611 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
612 # searched for input files to be used with the \include or \dontinclude
613 # commands irrespective of the value of the RECURSIVE tag.
614 # Possible values are YES and NO. If left blank NO is used.
616 EXAMPLE_RECURSIVE = NO
618 # The IMAGE_PATH tag can be used to specify one or more files or
619 # directories that contain image that are included in the documentation (see
620 # the \image command).
622 IMAGE_PATH = "@DOXYFILE_IMAGE_DIR@"
624 # The INPUT_FILTER tag can be used to specify a program that doxygen should
625 # invoke to filter for each input file. Doxygen will invoke the filter program
626 # by executing (via popen()) the command <filter> <input-file>, where <filter>
627 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
628 # input file. Doxygen will then use the output that the filter program writes
629 # to standard output. If FILTER_PATTERNS is specified, this tag will be
634 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
635 # basis. Doxygen will compare the file name with each pattern and apply the
636 # filter if there is a match. The filters are a list of the form:
637 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
638 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
639 # is applied to all files.
643 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
644 # INPUT_FILTER) will be used to filter the input files when producing source
645 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
647 FILTER_SOURCE_FILES = NO
649 #---------------------------------------------------------------------------
650 # configuration options related to source browsing
651 #---------------------------------------------------------------------------
653 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
654 # be generated. Documented entities will be cross-referenced with these sources.
655 # Note: To get rid of all source code in the generated output, make sure also
656 # VERBATIM_HEADERS is set to NO.
660 # Setting the INLINE_SOURCES tag to YES will include the body
661 # of functions and classes directly in the documentation.
665 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
666 # doxygen to hide any special comment blocks from generated source code
667 # fragments. Normal C and C++ comments will always remain visible.
669 STRIP_CODE_COMMENTS = YES
671 # If the REFERENCED_BY_RELATION tag is set to YES
672 # then for each documented function all documented
673 # functions referencing it will be listed.
675 REFERENCED_BY_RELATION = NO
677 # If the REFERENCES_RELATION tag is set to YES
678 # then for each documented function all documented entities
679 # called/used by that function will be listed.
681 REFERENCES_RELATION = NO
683 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
684 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
685 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
686 # link to the source code. Otherwise they will link to the documentstion.
688 REFERENCES_LINK_SOURCE = YES
690 # If the USE_HTAGS tag is set to YES then the references to source code
691 # will point to the HTML generated by the htags(1) tool instead of doxygen
692 # built-in source browser. The htags tool is part of GNU's global source
693 # tagging system (see http://www.gnu.org/software/global/global.html). You
694 # will need version 4.8.6 or higher.
698 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
699 # will generate a verbatim copy of the header file for each class for
700 # which an include is specified. Set to NO to disable this.
702 VERBATIM_HEADERS = YES
704 #---------------------------------------------------------------------------
705 # configuration options related to the alphabetical class index
706 #---------------------------------------------------------------------------
708 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
709 # of all compounds will be generated. Enable this if the project
710 # contains a lot of classes, structs, unions or interfaces.
712 ALPHABETICAL_INDEX = NO
714 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
715 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
716 # in which this list will be split (can be a number in the range [1..20])
718 COLS_IN_ALPHA_INDEX = 5
720 # In case all classes in a project start with a common prefix, all
721 # classes will be put under the same header in the alphabetical index.
722 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
723 # should be ignored while generating the index headers.
727 #---------------------------------------------------------------------------
728 # configuration options related to the HTML output
729 #---------------------------------------------------------------------------
731 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
732 # generate HTML output.
736 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
737 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
738 # put in front of it. If left blank `html' will be used as the default path.
740 HTML_OUTPUT = "@DOXYFILE_HTML_DIR@"
742 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
743 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
744 # doxygen will generate files with .html extension.
746 HTML_FILE_EXTENSION = .html
748 # The HTML_HEADER tag can be used to specify a personal HTML header for
749 # each generated HTML page. If it is left blank doxygen will generate a
754 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
755 # each generated HTML page. If it is left blank doxygen will generate a
760 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
761 # style sheet that is used by each HTML page. It can be used to
762 # fine-tune the look of the HTML output. If the tag is left blank doxygen
763 # will generate a default style sheet. Note that doxygen will try to copy
764 # the style sheet file to the HTML output directory, so don't put your own
765 # stylesheet in the HTML output directory as well, or it will be erased!
769 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
770 # files or namespaces will be aligned in HTML using tables. If set to
771 # NO a bullet list will be used.
773 HTML_ALIGN_MEMBERS = YES
775 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
776 # will be generated that can be used as input for tools like the
777 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
778 # of the generated HTML documentation.
780 GENERATE_HTMLHELP = NO
782 # If the GENERATE_DOCSET tag is set to YES, additional index files
783 # will be generated that can be used as input for Apple's Xcode 3
784 # integrated development environment, introduced with OSX 10.5 (Leopard).
785 # To create a documentation set, doxygen will generate a Makefile in the
786 # HTML output directory. Running make will produce the docset in that
787 # directory and running "make install" will install the docset in
788 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
793 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
794 # feed. A documentation feed provides an umbrella under which multiple
795 # documentation sets from a single provider (such as a company or product suite)
798 DOCSET_FEEDNAME = "Doxygen generated docs"
800 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
801 # should uniquely identify the documentation set bundle. This should be a
802 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
803 # will append .docset to the name.
805 DOCSET_BUNDLE_ID = org.doxygen.Project
807 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
808 # documentation will contain sections that can be hidden and shown after the
809 # page has loaded. For this to work a browser that supports
810 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
811 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
813 HTML_DYNAMIC_SECTIONS = NO
815 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
816 # be used to specify the file name of the resulting .chm file. You
817 # can add a path in front of the file if the result should not be
818 # written to the html output directory.
822 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
823 # be used to specify the location (absolute path including file name) of
824 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
825 # the HTML help compiler on the generated index.hhp.
829 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
830 # controls if a separate .chi index file is generated (YES) or that
831 # it should be included in the master .chm file (NO).
835 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
836 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
841 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
842 # controls whether a binary table of contents is generated (YES) or a
843 # normal table of contents (NO) in the .chm file.
847 # The TOC_EXPAND flag can be set to YES to add extra items for group members
848 # to the contents of the HTML help documentation and to the tree view.
852 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
853 # top of each HTML page. The value NO (the default) enables the index and
854 # the value YES disables it.
858 # This tag can be used to set the number of enum values (range [1..20])
859 # that doxygen will group on one line in the generated HTML documentation.
861 ENUM_VALUES_PER_LINE = 4
863 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
864 # structure should be generated to display hierarchical information.
865 # If the tag value is set to FRAME, a side panel will be generated
866 # containing a tree-like index structure (just like the one that
867 # is generated for HTML Help). For this to work a browser that supports
868 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
869 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
870 # probably better off using the HTML help feature. Other possible values
871 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
872 # and Class Hiererachy pages using a tree view instead of an ordered list;
873 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
874 # disables this behavior completely. For backwards compatibility with previous
875 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
878 GENERATE_TREEVIEW = NONE
880 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
881 # used to set the initial width (in pixels) of the frame in which the tree
886 # Use this tag to change the font size of Latex formulas included
887 # as images in the HTML documentation. The default is 10. Note that
888 # when you change the font size after a successful doxygen run you need
889 # to manually remove any form_*.png images from the HTML output directory
890 # to force them to be regenerated.
892 FORMULA_FONTSIZE = 10
894 #---------------------------------------------------------------------------
895 # configuration options related to the LaTeX output
896 #---------------------------------------------------------------------------
898 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
899 # generate Latex output.
901 GENERATE_LATEX = @DOXYFILE_GENERATE_LATEX@
903 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
904 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
905 # put in front of it. If left blank `latex' will be used as the default path.
907 LATEX_OUTPUT = "@DOXYFILE_LATEX_DIR@"
909 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
910 # invoked. If left blank `latex' will be used as the default command name.
912 LATEX_CMD_NAME = "@LATEX_COMPILER@"
914 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
915 # generate index for LaTeX. If left blank `makeindex' will be used as the
916 # default command name.
918 MAKEINDEX_CMD_NAME = "@MAKEINDEX_COMPILER@"
920 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
921 # LaTeX documents. This may be useful for small projects and may help to
922 # save some trees in general.
926 # The PAPER_TYPE tag can be used to set the paper type that is used
927 # by the printer. Possible values are: a4, a4wide, letter, legal and
928 # executive. If left blank a4wide will be used.
932 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
933 # packages that should be included in the LaTeX output.
937 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
938 # the generated latex document. The header should contain everything until
939 # the first chapter. If it is left blank doxygen will generate a
940 # standard header. Notice: only use this tag if you know what you are doing!
944 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
945 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
946 # contain links (just like the HTML output) instead of page references
947 # This makes the output suitable for online browsing using a pdf viewer.
951 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
952 # plain latex in the generated Makefile. Set this option to YES to get a
953 # higher quality PDF documentation.
955 USE_PDFLATEX = @DOXYFILE_PDFLATEX@
957 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
958 # command to the generated LaTeX files. This will instruct LaTeX to keep
959 # running if errors occur, instead of asking the user for help.
960 # This option is also used when generating formulas in HTML.
962 LATEX_BATCHMODE = YES
964 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
965 # include the index chapters (such as File Index, Compound Index, etc.)
968 LATEX_HIDE_INDICES = NO
970 #---------------------------------------------------------------------------
971 # configuration options related to the RTF output
972 #---------------------------------------------------------------------------
974 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
975 # The RTF output is optimized for Word 97 and may not look very pretty with
976 # other RTF readers or editors.
980 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
981 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
982 # put in front of it. If left blank `rtf' will be used as the default path.
986 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
987 # RTF documents. This may be useful for small projects and may help to
988 # save some trees in general.
992 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
993 # will contain hyperlink fields. The RTF file will
994 # contain links (just like the HTML output) instead of page references.
995 # This makes the output suitable for online browsing using WORD or other
996 # programs which support those fields.
997 # Note: wordpad (write) and others do not support links.
1001 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1002 # config file, i.e. a series of assignments. You only have to provide
1003 # replacements, missing definitions are set to their default value.
1005 RTF_STYLESHEET_FILE =
1007 # Set optional variables used in the generation of an rtf document.
1008 # Syntax is similar to doxygen's config file.
1010 RTF_EXTENSIONS_FILE =
1012 #---------------------------------------------------------------------------
1013 # configuration options related to the man page output
1014 #---------------------------------------------------------------------------
1016 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1017 # generate man pages
1021 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1022 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1023 # put in front of it. If left blank `man' will be used as the default path.
1027 # The MAN_EXTENSION tag determines the extension that is added to
1028 # the generated man pages (default is the subroutine's section .3)
1032 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1033 # then it will generate one additional man file for each entity
1034 # documented in the real man page(s). These additional files
1035 # only source the real man page, but without them the man command
1036 # would be unable to find the correct page. The default is NO.
1040 #---------------------------------------------------------------------------
1041 # configuration options related to the XML output
1042 #---------------------------------------------------------------------------
1044 # If the GENERATE_XML tag is set to YES Doxygen will
1045 # generate an XML file that captures the structure of
1046 # the code including all documentation.
1050 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1051 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1052 # put in front of it. If left blank `xml' will be used as the default path.
1056 # The XML_SCHEMA tag can be used to specify an XML schema,
1057 # which can be used by a validating XML parser to check the
1058 # syntax of the XML files.
1062 # The XML_DTD tag can be used to specify an XML DTD,
1063 # which can be used by a validating XML parser to check the
1064 # syntax of the XML files.
1068 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1069 # dump the program listings (including syntax highlighting
1070 # and cross-referencing information) to the XML output. Note that
1071 # enabling this will significantly increase the size of the XML output.
1073 XML_PROGRAMLISTING = YES
1075 #---------------------------------------------------------------------------
1076 # configuration options for the AutoGen Definitions output
1077 #---------------------------------------------------------------------------
1079 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1080 # generate an AutoGen Definitions (see autogen.sf.net) file
1081 # that captures the structure of the code including all
1082 # documentation. Note that this feature is still experimental
1083 # and incomplete at the moment.
1085 GENERATE_AUTOGEN_DEF = NO
1087 #---------------------------------------------------------------------------
1088 # configuration options related to the Perl module output
1089 #---------------------------------------------------------------------------
1091 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1092 # generate a Perl module file that captures the structure of
1093 # the code including all documentation. Note that this
1094 # feature is still experimental and incomplete at the
1097 GENERATE_PERLMOD = NO
1099 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1100 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1101 # to generate PDF and DVI output from the Perl module output.
1105 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1106 # nicely formatted so it can be parsed by a human reader. This is useful
1107 # if you want to understand what is going on. On the other hand, if this
1108 # tag is set to NO the size of the Perl module output will be much smaller
1109 # and Perl will parse it just the same.
1111 PERLMOD_PRETTY = YES
1113 # The names of the make variables in the generated doxyrules.make file
1114 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1115 # This is useful so different doxyrules.make files included by the same
1116 # Makefile don't overwrite each other's variables.
1118 PERLMOD_MAKEVAR_PREFIX =
1120 #---------------------------------------------------------------------------
1121 # Configuration options related to the preprocessor
1122 #---------------------------------------------------------------------------
1124 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1125 # evaluate all C-preprocessor directives found in the sources and include
1128 ENABLE_PREPROCESSING = YES
1130 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1131 # names in the source code. If set to NO (the default) only conditional
1132 # compilation will be performed. Macro expansion can be done in a controlled
1133 # way by setting EXPAND_ONLY_PREDEF to YES.
1135 MACRO_EXPANSION = NO
1137 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1138 # then the macro expansion is limited to the macros specified with the
1139 # PREDEFINED and EXPAND_AS_DEFINED tags.
1141 EXPAND_ONLY_PREDEF = NO
1143 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1144 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1146 SEARCH_INCLUDES = YES
1148 # The INCLUDE_PATH tag can be used to specify one or more directories that
1149 # contain include files that are not input files but should be processed by
1154 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1155 # patterns (like *.h and *.hpp) to filter out the header-files in the
1156 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1159 INCLUDE_FILE_PATTERNS =
1161 # The PREDEFINED tag can be used to specify one or more macro names that
1162 # are defined before the preprocessor is started (similar to the -D option of
1163 # gcc). The argument of the tag is a list of macros of the form: name
1164 # or name=definition (no spaces). If the definition and the = are
1165 # omitted =1 is assumed. To prevent a macro definition from being
1166 # undefined via #undef or recursively expanded use the := operator
1167 # instead of the = operator.
1171 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1172 # this tag can be used to specify a list of macro names that should be expanded.
1173 # The macro definition that is found in the sources will be used.
1174 # Use the PREDEFINED tag if you want to use a different macro definition.
1178 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1179 # doxygen's preprocessor will remove all function-like macros that are alone
1180 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1181 # function macros are typically used for boiler-plate code, and will confuse
1182 # the parser if not removed.
1184 SKIP_FUNCTION_MACROS = YES
1186 #---------------------------------------------------------------------------
1187 # Configuration::additions related to external references
1188 #---------------------------------------------------------------------------
1190 # The TAGFILES option can be used to specify one or more tagfiles.
1191 # Optionally an initial location of the external documentation
1192 # can be added for each tagfile. The format of a tag file without
1193 # this location is as follows:
1194 # TAGFILES = file1 file2 ...
1195 # Adding location for the tag files is done as follows:
1196 # TAGFILES = file1=loc1 "file2 = loc2" ...
1197 # where "loc1" and "loc2" can be relative or absolute paths or
1198 # URLs. If a location is present for each tag, the installdox tool
1199 # does not have to be run to correct the links.
1200 # Note that each tag file must have a unique name
1201 # (where the name does NOT include the path)
1202 # If a tag file is not located in the directory in which doxygen
1203 # is run, you must also specify the path to the tagfile here.
1207 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1208 # a tag file that is based on the input files it reads.
1212 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1213 # in the class index. If set to NO only the inherited external classes
1218 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1219 # in the modules index. If set to NO, only the current project's groups will
1222 EXTERNAL_GROUPS = YES
1224 # The PERL_PATH should be the absolute path and name of the perl script
1225 # interpreter (i.e. the result of `which perl').
1227 PERL_PATH = /usr/bin/perl
1229 #---------------------------------------------------------------------------
1230 # Configuration options related to the dot tool
1231 #---------------------------------------------------------------------------
1233 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1234 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1235 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1236 # this option is superseded by the HAVE_DOT option below. This is only a
1237 # fallback. It is recommended to install and use dot, since it yields more
1240 CLASS_DIAGRAMS = YES
1242 # You can define message sequence charts within doxygen comments using the \msc
1243 # command. Doxygen will then run the mscgen tool (see
1244 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1245 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1246 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1247 # default search path.
1251 # If set to YES, the inheritance and collaboration graphs will hide
1252 # inheritance and usage relations if the target is undocumented
1253 # or is not a class.
1255 HIDE_UNDOC_RELATIONS = YES
1257 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1258 # available from the path. This tool is part of Graphviz, a graph visualization
1259 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1260 # have no effect if this option is set to NO (the default)
1262 HAVE_DOT = @DOXYFILE_DOT@
1264 # By default doxygen will write a font called FreeSans.ttf to the output
1265 # directory and reference it in all dot files that doxygen generates. This
1266 # font does not include all possible unicode characters however, so when you need
1267 # these (or just want a differently looking font) you can specify the font name
1268 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1269 # which can be done by putting it in a standard location or by setting the
1270 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1271 # containing the font.
1273 DOT_FONTNAME = FreeSans
1275 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1276 # The default size is 10pt.
1280 # By default doxygen will tell dot to use the output directory to look for the
1281 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1282 # different font using DOT_FONTNAME you can set the path where dot
1283 # can find it using this tag.
1287 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1288 # will generate a graph for each documented class showing the direct and
1289 # indirect inheritance relations. Setting this tag to YES will force the
1290 # the CLASS_DIAGRAMS tag to NO.
1294 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1295 # will generate a graph for each documented class showing the direct and
1296 # indirect implementation dependencies (inheritance, containment, and
1297 # class references variables) of the class with other documented classes.
1299 COLLABORATION_GRAPH = YES
1301 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1302 # will generate a graph for groups, showing the direct groups dependencies
1306 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1307 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1312 # If set to YES, the inheritance and collaboration graphs will show the
1313 # relations between templates and their instances.
1315 TEMPLATE_RELATIONS = NO
1317 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1318 # tags are set to YES then doxygen will generate a graph for each documented
1319 # file showing the direct and indirect include dependencies of the file with
1320 # other documented files.
1324 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1325 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1326 # documented header file showing the documented files that directly or
1327 # indirectly include this file.
1329 INCLUDED_BY_GRAPH = NO
1331 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1332 # doxygen will generate a call dependency graph for every global function
1333 # or class method. Note that enabling this option will significantly increase
1334 # the time of a run. So in most cases it will be better to enable call graphs
1335 # for selected functions only using the \callgraph command.
1339 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1340 # doxygen will generate a caller dependency graph for every global function
1341 # or class method. Note that enabling this option will significantly increase
1342 # the time of a run. So in most cases it will be better to enable caller
1343 # graphs for selected functions only using the \callergraph command.
1347 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1348 # will graphical hierarchy of all classes instead of a textual one.
1350 GRAPHICAL_HIERARCHY = YES
1352 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1353 # then doxygen will show the dependencies a directory has on other directories
1354 # in a graphical way. The dependency relations are determined by the #include
1355 # relations between the files in the directories.
1357 DIRECTORY_GRAPH = NO
1359 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1360 # generated by dot. Possible values are png, jpg, or gif
1361 # If left blank png will be used.
1363 DOT_IMAGE_FORMAT = png
1365 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1366 # found. If left blank, it is assumed the dot tool can be found in the path.
1368 DOT_PATH = "@DOXYGEN_DOT_PATH@"
1370 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1371 # contain dot files that are included in the documentation (see the
1372 # \dotfile command).
1376 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1377 # nodes that will be shown in the graph. If the number of nodes in a graph
1378 # becomes larger than this value, doxygen will truncate the graph, which is
1379 # visualized by representing a node as a red box. Note that doxygen if the
1380 # number of direct children of the root node in a graph is already larger than
1381 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1382 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1384 DOT_GRAPH_MAX_NODES = 50
1386 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1387 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1388 # from the root by following a path via at most 3 edges will be shown. Nodes
1389 # that lay further from the root node will be omitted. Note that setting this
1390 # option to 1 or 2 may greatly reduce the computation time needed for large
1391 # code bases. Also note that the size of a graph can be further restricted by
1392 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1394 MAX_DOT_GRAPH_DEPTH = 0
1396 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1397 # background. This is enabled by default, which results in a transparent
1398 # background. Warning: Depending on the platform used, enabling this option
1399 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1400 # become hard to read).
1402 DOT_TRANSPARENT = YES
1404 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1405 # files in one run (i.e. multiple -o and -T options on the command line). This
1406 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1407 # support this, this feature is disabled by default.
1409 DOT_MULTI_TARGETS = NO
1411 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1412 # generate a legend page explaining the meaning of the various boxes and
1413 # arrows in the dot generated graphs.
1415 GENERATE_LEGEND = YES
1417 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1418 # remove the intermediate dot files that are used to generate
1419 # the various graphs.
1423 #---------------------------------------------------------------------------
1424 # Configuration::additions related to the search engine
1425 #---------------------------------------------------------------------------
1427 # The SEARCHENGINE tag specifies whether or not a search engine should be
1428 # used. If set to NO the values of all tags below this one will be ignored.