6 # Copyright © 2017 AT&T Intellectual Property. All rights reserved.
8 # Licensed under the Apache License, Version 2.0 (the "License");
9 # you may not use this file except in compliance with the License.
10 # You may obtain a copy of the License at
11 # http://www.apache.org/licenses/LICENSE-2.0
13 # Unless required by applicable law or agreed to in writing, software
14 # distributed under the License is distributed on an "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 # See the License for the specific language governing permissions and
17 # limitations under the License.
20 # This file describes the settings to be used by the documentation system
21 # doxygen (www.doxygen.org) for a project
23 # All text after a hash (#) is considered a comment and will be ignored
25 # TAG = value [value, ...]
26 # For lists items can also be appended using:
27 # TAG += value [value, ...]
28 # Values that contain spaces should be placed between quotes (" ")
30 #---------------------------------------------------------------------------
31 # Project related configuration options
32 #---------------------------------------------------------------------------
34 # This tag specifies the encoding used for all characters in the config file
35 # that follow. The default is UTF-8 which is also the encoding used for all
36 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
37 # iconv built into libc) for the transcoding. See
38 # http://www.gnu.org/software/libiconv for the list of possible encodings.
40 DOXYFILE_ENCODING = UTF-8
42 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
43 # by quotes) that should identify the project.
45 PROJECT_NAME = "AT&T ECOMP Vendor Event Listener library"
47 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
48 # This could be handy for archiving the generated documentation or
49 # if some version control system is used.
53 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
54 # base path where the generated documentation will be put.
55 # If a relative path is entered, it will be relative to the location
56 # where doxygen was started. If left blank the current directory will be used.
58 OUTPUT_DIRECTORY = ../docs/source/evel
60 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
61 # 4096 sub-directories (in 2 levels) under the output directory of each output
62 # format and will distribute the generated files over these directories.
63 # Enabling this option can be useful when feeding doxygen a huge amount of
64 # source files, where putting all generated files in the same directory would
65 # otherwise cause performance problems for the file system.
69 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
70 # documentation generated by doxygen is written. Doxygen will use this
71 # information to generate all constant output in the proper language.
72 # The default language is English, other supported languages are:
73 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
74 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
75 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
76 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
77 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
78 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
80 OUTPUT_LANGUAGE = English
82 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
83 # include brief member descriptions after the members that are listed in
84 # the file and class documentation (similar to JavaDoc).
85 # Set to NO to disable this.
87 BRIEF_MEMBER_DESC = YES
89 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
90 # the brief description of a member or function before the detailed description.
91 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
92 # brief descriptions will be completely suppressed.
96 # This tag implements a quasi-intelligent brief description abbreviator
97 # that is used to form the text in various listings. Each string
98 # in this list, if found as the leading text of the brief description, will be
99 # stripped from the text and the result after processing the whole list, is
100 # used as the annotated text. Otherwise, the brief description is used as-is.
101 # If left blank, the following values are used ("$name" is automatically
102 # replaced with the name of the entity): "The $name class" "The $name widget"
103 # "The $name file" "is" "provides" "specifies" "contains"
104 # "represents" "a" "an" "the"
108 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
109 # Doxygen will generate a detailed section even if there is only a brief
112 ALWAYS_DETAILED_SEC = NO
114 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
115 # inherited members of a class in the documentation of that class as if those
116 # members were ordinary class members. Constructors, destructors and assignment
117 # operators of the base classes will not be shown.
119 INLINE_INHERITED_MEMB = NO
121 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
122 # path before files name in the file list and in the header files. If set
123 # to NO the shortest path that makes the file name unique will be used.
127 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
128 # can be used to strip a user-defined part of the path. Stripping is
129 # only done if one of the specified strings matches the left-hand part of
130 # the path. The tag can be used to show relative paths in the file list.
131 # If left blank the directory from which doxygen is run is used as the
136 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
137 # the path mentioned in the documentation of a class, which tells
138 # the reader which header file to include in order to use a class.
139 # If left blank only the name of the header file containing the class
140 # definition is used. Otherwise one should specify the include paths that
141 # are normally passed to the compiler using the -I flag.
143 STRIP_FROM_INC_PATH =
145 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
146 # (but less readable) file names. This can be useful is your file systems
147 # doesn't support long names like on DOS, Mac, or CD-ROM.
151 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
152 # will interpret the first line (until the first dot) of a JavaDoc-style
153 # comment as the brief description. If set to NO, the JavaDoc
154 # comments will behave just like regular Qt-style comments
155 # (thus requiring an explicit @brief command for a brief description.)
157 JAVADOC_AUTOBRIEF = YES
159 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
160 # interpret the first line (until the first dot) of a Qt-style
161 # comment as the brief description. If set to NO, the comments
162 # will behave just like regular Qt-style comments (thus requiring
163 # an explicit \brief command for a brief description.)
167 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
168 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
169 # comments) as a brief description. This used to be the default behaviour.
170 # The new default is to treat a multi-line C++ comment block as a detailed
171 # description. Set this tag to YES if you prefer the old behaviour instead.
173 MULTILINE_CPP_IS_BRIEF = NO
175 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
176 # member inherits the documentation from any documented member that it
181 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
182 # a new page for each member. If set to NO, the documentation of a member will
183 # be part of the file/class/namespace that contains it.
185 SEPARATE_MEMBER_PAGES = NO
187 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
188 # Doxygen uses this value to replace tabs by spaces in code fragments.
192 # This tag can be used to specify a number of aliases that acts
193 # as commands in the documentation. An alias has the form "name=value".
194 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
195 # put the command \sideeffect (or @sideeffect) in the documentation, which
196 # will result in a user-defined paragraph with heading "Side Effects:".
197 # You can put \n's in the value part of an alias to insert newlines.
201 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
202 # sources only. Doxygen will then generate output that is more tailored for C.
203 # For instance, some of the names that are used will be different. The list
204 # of all members will be omitted, etc.
206 OPTIMIZE_OUTPUT_FOR_C = YES
208 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
209 # sources only. Doxygen will then generate output that is more tailored for
210 # Java. For instance, namespaces will be presented as packages, qualified
211 # scopes will look different, etc.
213 OPTIMIZE_OUTPUT_JAVA = NO
215 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
216 # sources only. Doxygen will then generate output that is more tailored for
219 OPTIMIZE_FOR_FORTRAN = NO
221 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
222 # sources. Doxygen will then generate output that is tailored for
225 OPTIMIZE_OUTPUT_VHDL = NO
227 # Doxygen selects the parser to use depending on the extension of the files it parses.
228 # With this tag you can assign which parser to use for a given extension.
229 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
230 # The format is ext=language, where ext is a file extension, and language is one of
231 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
232 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
233 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
234 # 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.
238 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
239 # to include (a tag file for) the STL sources as input, then you should
240 # set this tag to YES in order to let doxygen match functions declarations and
241 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
242 # func(std::string) {}). This also make the inheritance and collaboration
243 # diagrams that involve STL classes more complete and accurate.
245 BUILTIN_STL_SUPPORT = NO
247 # If you use Microsoft's C++/CLI language, you should set this option to YES to
248 # enable parsing support.
252 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
253 # Doxygen will parse them like normal C++ but will assume all classes use public
254 # instead of private inheritance when no explicit protection keyword is present.
258 # For Microsoft's IDL there are propget and propput attributes to indicate getter
259 # and setter methods for a property. Setting this option to YES (the default)
260 # will make doxygen to replace the get and set methods by a property in the
261 # documentation. This will only work if the methods are indeed getting or
262 # setting a simple type. If this is not the case, or you want to show the
263 # methods anyway, you should set this option to NO.
265 IDL_PROPERTY_SUPPORT = YES
267 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
268 # tag is set to YES, then doxygen will reuse the documentation of the first
269 # member in the group (if any) for the other members of the group. By default
270 # all members of a group must be documented explicitly.
272 DISTRIBUTE_GROUP_DOC = NO
274 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
275 # the same type (for instance a group of public functions) to be put as a
276 # subgroup of that type (e.g. under the Public Functions section). Set it to
277 # NO to prevent subgrouping. Alternatively, this can be done per class using
278 # the \nosubgrouping command.
282 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
283 # is documented as struct, union, or enum with the name of the typedef. So
284 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
285 # with name TypeT. When disabled the typedef will appear as a member of a file,
286 # namespace, or class. And the struct will be named TypeS. This can typically
287 # be useful for C code in case the coding convention dictates that all compound
288 # types are typedef'ed and only the typedef is referenced, never the tag name.
290 TYPEDEF_HIDES_STRUCT = NO
292 #---------------------------------------------------------------------------
293 # Build related configuration options
294 #---------------------------------------------------------------------------
296 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
297 # documentation are documented, even if no documentation was available.
298 # Private class members and static file members will be hidden unless
299 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
303 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
304 # will be included in the documentation.
308 # If the EXTRACT_STATIC tag is set to YES all static members of a file
309 # will be included in the documentation.
313 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
314 # defined locally in source files will be included in the documentation.
315 # If set to NO only classes defined in header files are included.
317 EXTRACT_LOCAL_CLASSES = NO
319 # This flag is only useful for Objective-C code. When set to YES local
320 # methods, which are defined in the implementation section but not in
321 # the interface are included in the documentation.
322 # If set to NO (the default) only methods in the interface are included.
324 EXTRACT_LOCAL_METHODS = NO
326 # If this flag is set to YES, the members of anonymous namespaces will be
327 # extracted and appear in the documentation as a namespace called
328 # 'anonymous_namespace{file}', where file will be replaced with the base
329 # name of the file that contains the anonymous namespace. By default
330 # anonymous namespace are hidden.
332 EXTRACT_ANON_NSPACES = NO
334 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
335 # undocumented members of documented classes, files or namespaces.
336 # If set to NO (the default) these members will be included in the
337 # various overviews, but no documentation section is generated.
338 # This option has no effect if EXTRACT_ALL is enabled.
340 HIDE_UNDOC_MEMBERS = NO
342 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
343 # undocumented classes that are normally visible in the class hierarchy.
344 # If set to NO (the default) these classes will be included in the various
345 # overviews. This option has no effect if EXTRACT_ALL is enabled.
347 HIDE_UNDOC_CLASSES = NO
349 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
350 # friend (class|struct|union) declarations.
351 # If set to NO (the default) these declarations will be included in the
354 HIDE_FRIEND_COMPOUNDS = NO
356 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
357 # documentation blocks found inside the body of a function.
358 # If set to NO (the default) these blocks will be appended to the
359 # function's detailed documentation block.
361 HIDE_IN_BODY_DOCS = NO
363 # The INTERNAL_DOCS tag determines if documentation
364 # that is typed after a \internal command is included. If the tag is set
365 # to NO (the default) then the documentation will be excluded.
366 # Set it to YES to include the internal documentation.
370 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
371 # file names in lower-case letters. If set to YES upper-case letters are also
372 # allowed. This is useful if you have classes or files whose names only differ
373 # in case and if your file system supports case sensitive file names. Windows
374 # and Mac users are advised to set this option to NO.
376 CASE_SENSE_NAMES = YES
378 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
379 # will show members with their full class and namespace scopes in the
380 # documentation. If set to YES the scope will be hidden.
382 HIDE_SCOPE_NAMES = NO
384 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
385 # will put a list of the files that are included by a file in the documentation
388 SHOW_INCLUDE_FILES = YES
390 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
391 # is inserted in the documentation for inline members.
395 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
396 # will sort the (detailed) documentation of file and class members
397 # alphabetically by member name. If set to NO the members will appear in
400 SORT_MEMBER_DOCS = YES
402 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
403 # brief documentation of file, namespace and class members alphabetically
404 # by member name. If set to NO (the default) the members will appear in
409 # 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.
411 SORT_MEMBERS_CTORS_1ST = NO
413 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
414 # hierarchy of group names into alphabetical order. If set to NO (the default)
415 # the group names will appear in their defined order.
417 SORT_GROUP_NAMES = NO
419 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
420 # sorted by fully-qualified names, including namespaces. If set to
421 # NO (the default), the class list will be sorted only by class name,
422 # not including the namespace part.
423 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
424 # Note: This option applies only to the class list, not to the
427 SORT_BY_SCOPE_NAME = NO
429 # The GENERATE_TODOLIST tag can be used to enable (YES) or
430 # disable (NO) the todo list. This list is created by putting \todo
431 # commands in the documentation.
433 GENERATE_TODOLIST = YES
435 # The GENERATE_TESTLIST tag can be used to enable (YES) or
436 # disable (NO) the test list. This list is created by putting \test
437 # commands in the documentation.
439 GENERATE_TESTLIST = YES
441 # The GENERATE_BUGLIST tag can be used to enable (YES) or
442 # disable (NO) the bug list. This list is created by putting \bug
443 # commands in the documentation.
445 GENERATE_BUGLIST = YES
447 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
448 # disable (NO) the deprecated list. This list is created by putting
449 # \deprecated commands in the documentation.
451 GENERATE_DEPRECATEDLIST= YES
453 # The ENABLED_SECTIONS tag can be used to enable conditional
454 # documentation sections, marked by \if sectionname ... \endif.
458 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
459 # the initial value of a variable or define consists of for it to appear in
460 # the documentation. If the initializer consists of more lines than specified
461 # here it will be hidden. Use a value of 0 to hide initializers completely.
462 # The appearance of the initializer of individual variables and defines in the
463 # documentation can be controlled using \showinitializer or \hideinitializer
464 # command in the documentation regardless of this setting.
466 MAX_INITIALIZER_LINES = 30
468 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
469 # at the bottom of the documentation of classes and structs. If set to YES the
470 # list will mention the files that were used to generate the documentation.
472 SHOW_USED_FILES = YES
474 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
475 # This will remove the Files entry from the Quick Index and from the
476 # Folder Tree View (if specified). The default is YES.
480 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
482 # This will remove the Namespaces entry from the Quick Index
483 # and from the Folder Tree View (if specified). The default is YES.
485 SHOW_NAMESPACES = YES
487 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
488 # doxygen should invoke to get the current version for each file (typically from
489 # the version control system). Doxygen will invoke the program by executing (via
490 # popen()) the command <command> <input-file>, where <command> is the value of
491 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
492 # provided by doxygen. Whatever the program writes to standard output
493 # is used as the file version. See the manual for examples.
495 FILE_VERSION_FILTER =
497 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
498 # doxygen. The layout file controls the global structure of the generated output files
499 # in an output format independent way. The create the layout file that represents
500 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
501 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
502 # of the layout file.
506 #---------------------------------------------------------------------------
507 # configuration options related to warning and progress messages
508 #---------------------------------------------------------------------------
510 # The QUIET tag can be used to turn on/off the messages that are generated
511 # by doxygen. Possible values are YES and NO. If left blank NO is used.
515 # The WARNINGS tag can be used to turn on/off the warning messages that are
516 # generated by doxygen. Possible values are YES and NO. If left blank
521 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
522 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
523 # automatically be disabled.
525 WARN_IF_UNDOCUMENTED = YES
527 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
528 # potential errors in the documentation, such as not documenting some
529 # parameters in a documented function, or documenting parameters that
530 # don't exist or using markup commands wrongly.
532 WARN_IF_DOC_ERROR = YES
534 # This WARN_NO_PARAMDOC option can be abled to get warnings for
535 # functions that are documented, but have no documentation for their parameters
536 # or return value. If set to NO (the default) doxygen will only warn about
537 # wrong or incomplete parameter documentation, but not about the absence of
540 WARN_NO_PARAMDOC = NO
542 # The WARN_FORMAT tag determines the format of the warning messages that
543 # doxygen can produce. The string should contain the $file, $line, and $text
544 # tags, which will be replaced by the file and line number from which the
545 # warning originated and the warning text. Optionally the format may contain
546 # $version, which will be replaced by the version of the file (if it could
547 # be obtained via FILE_VERSION_FILTER)
549 WARN_FORMAT = "$file:$line: $text"
551 # The WARN_LOGFILE tag can be used to specify a file to which warning
552 # and error messages should be written. If left blank the output is written
557 #---------------------------------------------------------------------------
558 # configuration options related to the input files
559 #---------------------------------------------------------------------------
561 # The INPUT tag can be used to specify the files and/or directories that contain
562 # documented source files. You may enter file names like "myfile.cpp" or
563 # directories like "/usr/src/myproject". Separate the files or directories
566 INPUT = ../code/evel_library \
569 # This tag can be used to specify the character encoding of the source files
570 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
571 # also the default input encoding. Doxygen uses libiconv (or the iconv built
572 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
573 # the list of possible encodings.
575 INPUT_ENCODING = UTF-8
577 # If the value of the INPUT tag contains directories, you can use the
578 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
579 # and *.h) to filter out the source-files in the directories. If left
580 # blank the following patterns are tested:
581 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
582 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
584 FILE_PATTERNS = *.h *.c *.md
586 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
587 # should be searched for input files as well. Possible values are YES and NO.
588 # If left blank NO is used.
592 # The EXCLUDE tag can be used to specify files and/or directories that should
593 # excluded from the INPUT source files. This way you can easily exclude a
594 # subdirectory from a directory tree whose root is specified with the INPUT tag.
598 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
599 # directories that are symbolic links (a Unix filesystem feature) are excluded
602 EXCLUDE_SYMLINKS = NO
604 # If the value of the INPUT tag contains directories, you can use the
605 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
606 # certain files from those directories. Note that the wildcards are matched
607 # against the file with absolute path, so to exclude all test directories
608 # for example use the pattern */test/*
612 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
613 # (namespaces, classes, functions, etc.) that should be excluded from the
614 # output. The symbol name can be a fully qualified name, a word, or if the
615 # wildcard * is used, a substring. Examples: ANamespace, AClass,
616 # AClass::ANamespace, ANamespace::*Test
620 # The EXAMPLE_PATH tag can be used to specify one or more files or
621 # directories that contain example code fragments that are included (see
622 # the \include command).
626 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
627 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
628 # and *.h) to filter out the source-files in the directories. If left
629 # blank all files are included.
633 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
634 # searched for input files to be used with the \include or \dontinclude
635 # commands irrespective of the value of the RECURSIVE tag.
636 # Possible values are YES and NO. If left blank NO is used.
638 EXAMPLE_RECURSIVE = NO
640 # The IMAGE_PATH tag can be used to specify one or more files or
641 # directories that contain image that are included in the documentation (see
642 # the \image command).
646 # The INPUT_FILTER tag can be used to specify a program that doxygen should
647 # invoke to filter for each input file. Doxygen will invoke the filter program
648 # by executing (via popen()) the command <filter> <input-file>, where <filter>
649 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
650 # input file. Doxygen will then use the output that the filter program writes
651 # to standard output.
652 # If FILTER_PATTERNS is specified, this tag will be
657 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
659 # Doxygen will compare the file name with each pattern and apply the
660 # filter if there is a match.
661 # The filters are a list of the form:
662 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
663 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
664 # is applied to all files.
668 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
669 # INPUT_FILTER) will be used to filter the input files when producing source
670 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
672 FILTER_SOURCE_FILES = NO
674 #---------------------------------------------------------------------------
675 # configuration options related to source browsing
676 #---------------------------------------------------------------------------
678 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
679 # be generated. Documented entities will be cross-referenced with these sources.
680 # Note: To get rid of all source code in the generated output, make sure also
681 # VERBATIM_HEADERS is set to NO.
685 # Setting the INLINE_SOURCES tag to YES will include the body
686 # of functions and classes directly in the documentation.
690 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
691 # doxygen to hide any special comment blocks from generated source code
692 # fragments. Normal C and C++ comments will always remain visible.
694 STRIP_CODE_COMMENTS = YES
696 # If the REFERENCED_BY_RELATION tag is set to YES
697 # then for each documented function all documented
698 # functions referencing it will be listed.
700 REFERENCED_BY_RELATION = NO
702 # If the REFERENCES_RELATION tag is set to YES
703 # then for each documented function all documented entities
704 # called/used by that function will be listed.
706 REFERENCES_RELATION = NO
708 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
709 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
710 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
711 # link to the source code.
712 # Otherwise they will link to the documentation.
714 REFERENCES_LINK_SOURCE = YES
716 # If the USE_HTAGS tag is set to YES then the references to source code
717 # will point to the HTML generated by the htags(1) tool instead of doxygen
718 # built-in source browser. The htags tool is part of GNU's global source
719 # tagging system (see http://www.gnu.org/software/global/global.html). You
720 # will need version 4.8.6 or higher.
724 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
725 # will generate a verbatim copy of the header file for each class for
726 # which an include is specified. Set to NO to disable this.
728 VERBATIM_HEADERS = YES
730 #---------------------------------------------------------------------------
731 # configuration options related to the alphabetical class index
732 #---------------------------------------------------------------------------
734 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
735 # of all compounds will be generated. Enable this if the project
736 # contains a lot of classes, structs, unions or interfaces.
738 ALPHABETICAL_INDEX = NO
740 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
741 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
742 # in which this list will be split (can be a number in the range [1..20])
744 COLS_IN_ALPHA_INDEX = 5
746 # In case all classes in a project start with a common prefix, all
747 # classes will be put under the same header in the alphabetical index.
748 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
749 # should be ignored while generating the index headers.
753 #---------------------------------------------------------------------------
754 # configuration options related to the HTML output
755 #---------------------------------------------------------------------------
757 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
758 # generate HTML output.
762 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
763 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
764 # put in front of it. If left blank `html' will be used as the default path.
768 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
769 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
770 # doxygen will generate files with .html extension.
772 HTML_FILE_EXTENSION = .html
774 # The HTML_HEADER tag can be used to specify a personal HTML header for
775 # each generated HTML page. If it is left blank doxygen will generate a
780 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
781 # each generated HTML page. If it is left blank doxygen will generate a
786 # If the HTML_TIMESTAMP tag is set to YES then the generated HTML
787 # documentation will contain the timesstamp.
791 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
792 # style sheet that is used by each HTML page. It can be used to
793 # fine-tune the look of the HTML output. If the tag is left blank doxygen
794 # will generate a default style sheet. Note that doxygen will try to copy
795 # the style sheet file to the HTML output directory, so don't put your own
796 # stylesheet in the HTML output directory as well, or it will be erased!
800 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
801 # documentation will contain sections that can be hidden and shown after the
802 # page has loaded. For this to work a browser that supports
803 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
804 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
806 HTML_DYNAMIC_SECTIONS = NO
808 # If the GENERATE_DOCSET tag is set to YES, additional index files
809 # will be generated that can be used as input for Apple's Xcode 3
810 # integrated development environment, introduced with OSX 10.5 (Leopard).
811 # To create a documentation set, doxygen will generate a Makefile in the
812 # HTML output directory. Running make will produce the docset in that
813 # directory and running "make install" will install the docset in
814 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
816 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
820 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
821 # feed. A documentation feed provides an umbrella under which multiple
822 # documentation sets from a single provider (such as a company or product suite)
825 DOCSET_FEEDNAME = "Doxygen generated docs"
827 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
828 # should uniquely identify the documentation set bundle. This should be a
829 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
830 # will append .docset to the name.
832 DOCSET_BUNDLE_ID = org.doxygen.Project
834 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
835 # will be generated that can be used as input for tools like the
836 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
837 # of the generated HTML documentation.
839 GENERATE_HTMLHELP = NO
841 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
842 # be used to specify the file name of the resulting .chm file. You
843 # can add a path in front of the file if the result should not be
844 # written to the html output directory.
848 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
849 # be used to specify the location (absolute path including file name) of
850 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
851 # the HTML help compiler on the generated index.hhp.
855 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
856 # controls if a separate .chi index file is generated (YES) or that
857 # it should be included in the master .chm file (NO).
861 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
862 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
867 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
868 # controls whether a binary table of contents is generated (YES) or a
869 # normal table of contents (NO) in the .chm file.
873 # The TOC_EXPAND flag can be set to YES to add extra items for group members
874 # to the contents of the HTML help documentation and to the tree view.
878 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
879 # are set, an additional index file will be generated that can be used as input for
880 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
881 # HTML documentation.
885 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
886 # be used to specify the file name of the resulting .qch file.
887 # The path specified is relative to the HTML output folder.
891 # The QHP_NAMESPACE tag specifies the namespace to use when generating
892 # Qt Help Project output. For more information please see
893 # http://doc.trolltech.com/qthelpproject.html#namespace
897 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
898 # Qt Help Project output. For more information please see
899 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
901 QHP_VIRTUAL_FOLDER = doc
903 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
904 # For more information please see
905 # http://doc.trolltech.com/qthelpproject.html#custom-filters
907 QHP_CUST_FILTER_NAME =
909 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
910 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
912 QHP_CUST_FILTER_ATTRS =
914 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
915 # filter section matches.
916 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
918 QHP_SECT_FILTER_ATTRS =
920 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
921 # be used to specify the location of Qt's qhelpgenerator.
922 # If non-empty doxygen will try to run qhelpgenerator on the generated
927 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
928 # top of each HTML page. The value NO (the default) enables the index and
929 # the value YES disables it.
933 # This tag can be used to set the number of enum values (range [1..20])
934 # that doxygen will group on one line in the generated HTML documentation.
936 ENUM_VALUES_PER_LINE = 4
938 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
939 # structure should be generated to display hierarchical information.
940 # If the tag value is set to YES, a side panel will be generated
941 # containing a tree-like index structure (just like the one that
942 # is generated for HTML Help). For this to work a browser that supports
943 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
944 # Windows users are probably better off using the HTML help feature.
946 GENERATE_TREEVIEW = NO
948 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
949 # used to set the initial width (in pixels) of the frame in which the tree
954 # Use this tag to change the font size of Latex formulas included
955 # as images in the HTML documentation. The default is 10. Note that
956 # when you change the font size after a successful doxygen run you need
957 # to manually remove any form_*.png images from the HTML output directory
958 # to force them to be regenerated.
960 FORMULA_FONTSIZE = 10
962 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
963 # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
964 # there is already a search function so this one should typically
969 #---------------------------------------------------------------------------
970 # configuration options related to the LaTeX output
971 #---------------------------------------------------------------------------
973 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
974 # generate Latex output.
978 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
979 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
980 # put in front of it. If left blank `latex' will be used as the default path.
984 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
985 # invoked. If left blank `latex' will be used as the default command name.
987 LATEX_CMD_NAME = latex
989 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
990 # generate index for LaTeX. If left blank `makeindex' will be used as the
991 # default command name.
993 MAKEINDEX_CMD_NAME = makeindex
995 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
996 # LaTeX documents. This may be useful for small projects and may help to
997 # save some trees in general.
1001 # The PAPER_TYPE tag can be used to set the paper type that is used
1002 # by the printer. Possible values are: a4, a4wide, letter, legal and
1003 # executive. If left blank a4wide will be used.
1007 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1008 # packages that should be included in the LaTeX output.
1012 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1013 # the generated latex document. The header should contain everything until
1014 # the first chapter. If it is left blank doxygen will generate a
1015 # standard header. Notice: only use this tag if you know what you are doing!
1019 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1020 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1021 # contain links (just like the HTML output) instead of page references
1022 # This makes the output suitable for online browsing using a pdf viewer.
1024 PDF_HYPERLINKS = YES
1026 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1027 # plain latex in the generated Makefile. Set this option to YES to get a
1028 # higher quality PDF documentation.
1032 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1033 # command to the generated LaTeX files. This will instruct LaTeX to keep
1034 # running if errors occur, instead of asking the user for help.
1035 # This option is also used when generating formulas in HTML.
1037 LATEX_BATCHMODE = NO
1039 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1040 # include the index chapters (such as File Index, Compound Index, etc.)
1043 LATEX_HIDE_INDICES = NO
1045 # 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.
1047 LATEX_SOURCE_CODE = NO
1049 #---------------------------------------------------------------------------
1050 # configuration options related to the RTF output
1051 #---------------------------------------------------------------------------
1053 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1054 # The RTF output is optimized for Word 97 and may not look very pretty with
1055 # other RTF readers or editors.
1059 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1060 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1061 # put in front of it. If left blank `rtf' will be used as the default path.
1065 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1066 # RTF documents. This may be useful for small projects and may help to
1067 # save some trees in general.
1071 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1072 # will contain hyperlink fields. The RTF file will
1073 # contain links (just like the HTML output) instead of page references.
1074 # This makes the output suitable for online browsing using WORD or other
1075 # programs which support those fields.
1076 # Note: wordpad (write) and others do not support links.
1080 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1081 # config file, i.e. a series of assignments. You only have to provide
1082 # replacements, missing definitions are set to their default value.
1084 RTF_STYLESHEET_FILE =
1086 # Set optional variables used in the generation of an rtf document.
1087 # Syntax is similar to doxygen's config file.
1089 RTF_EXTENSIONS_FILE =
1091 #---------------------------------------------------------------------------
1092 # configuration options related to the man page output
1093 #---------------------------------------------------------------------------
1095 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1096 # generate man pages
1100 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1101 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1102 # put in front of it. If left blank `man' will be used as the default path.
1106 # The MAN_EXTENSION tag determines the extension that is added to
1107 # the generated man pages (default is the subroutine's section .3)
1111 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1112 # then it will generate one additional man file for each entity
1113 # documented in the real man page(s). These additional files
1114 # only source the real man page, but without them the man command
1115 # would be unable to find the correct page. The default is NO.
1119 #---------------------------------------------------------------------------
1120 # configuration options related to the XML output
1121 #---------------------------------------------------------------------------
1123 # If the GENERATE_XML tag is set to YES Doxygen will
1124 # generate an XML file that captures the structure of
1125 # the code including all documentation.
1129 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1130 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1131 # put in front of it. If left blank `xml' will be used as the default path.
1135 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1136 # dump the program listings (including syntax highlighting
1137 # and cross-referencing information) to the XML output. Note that
1138 # enabling this will significantly increase the size of the XML output.
1140 XML_PROGRAMLISTING = YES
1142 #---------------------------------------------------------------------------
1143 # configuration options for the AutoGen Definitions output
1144 #---------------------------------------------------------------------------
1146 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1147 # generate an AutoGen Definitions (see autogen.sf.net) file
1148 # that captures the structure of the code including all
1149 # documentation. Note that this feature is still experimental
1150 # and incomplete at the moment.
1152 GENERATE_AUTOGEN_DEF = NO
1154 #---------------------------------------------------------------------------
1155 # configuration options related to the Perl module output
1156 #---------------------------------------------------------------------------
1158 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1159 # generate a Perl module file that captures the structure of
1160 # the code including all documentation. Note that this
1161 # feature is still experimental and incomplete at the
1164 GENERATE_PERLMOD = NO
1166 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1167 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1168 # to generate PDF and DVI output from the Perl module output.
1172 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1173 # nicely formatted so it can be parsed by a human reader.
1175 # if you want to understand what is going on.
1176 # On the other hand, if this
1177 # tag is set to NO the size of the Perl module output will be much smaller
1178 # and Perl will parse it just the same.
1180 PERLMOD_PRETTY = YES
1182 # The names of the make variables in the generated doxyrules.make file
1183 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1184 # This is useful so different doxyrules.make files included by the same
1185 # Makefile don't overwrite each other's variables.
1187 PERLMOD_MAKEVAR_PREFIX =
1189 #---------------------------------------------------------------------------
1190 # Configuration options related to the preprocessor
1191 #---------------------------------------------------------------------------
1193 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1194 # evaluate all C-preprocessor directives found in the sources and include
1197 ENABLE_PREPROCESSING = YES
1199 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1200 # names in the source code. If set to NO (the default) only conditional
1201 # compilation will be performed. Macro expansion can be done in a controlled
1202 # way by setting EXPAND_ONLY_PREDEF to YES.
1204 MACRO_EXPANSION = NO
1206 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1207 # then the macro expansion is limited to the macros specified with the
1208 # PREDEFINED and EXPAND_AS_DEFINED tags.
1210 EXPAND_ONLY_PREDEF = NO
1212 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1213 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1215 SEARCH_INCLUDES = YES
1217 # The INCLUDE_PATH tag can be used to specify one or more directories that
1218 # contain include files that are not input files but should be processed by
1223 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1224 # patterns (like *.h and *.hpp) to filter out the header-files in the
1225 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1228 INCLUDE_FILE_PATTERNS =
1230 # The PREDEFINED tag can be used to specify one or more macro names that
1231 # are defined before the preprocessor is started (similar to the -D option of
1232 # gcc). The argument of the tag is a list of macros of the form: name
1233 # or name=definition (no spaces). If the definition and the = are
1234 # omitted =1 is assumed. To prevent a macro definition from being
1235 # undefined via #undef or recursively expanded use the := operator
1236 # instead of the = operator.
1240 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1241 # this tag can be used to specify a list of macro names that should be expanded.
1242 # The macro definition that is found in the sources will be used.
1243 # Use the PREDEFINED tag if you want to use a different macro definition.
1247 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1248 # doxygen's preprocessor will remove all function-like macros that are alone
1249 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1250 # function macros are typically used for boiler-plate code, and will confuse
1251 # the parser if not removed.
1253 SKIP_FUNCTION_MACROS = YES
1255 #---------------------------------------------------------------------------
1256 # Configuration::additions related to external references
1257 #---------------------------------------------------------------------------
1259 # The TAGFILES option can be used to specify one or more tagfiles.
1260 # Optionally an initial location of the external documentation
1261 # can be added for each tagfile. The format of a tag file without
1262 # this location is as follows:
1264 # TAGFILES = file1 file2 ...
1265 # Adding location for the tag files is done as follows:
1267 # TAGFILES = file1=loc1 "file2 = loc2" ...
1268 # where "loc1" and "loc2" can be relative or absolute paths or
1269 # URLs. If a location is present for each tag, the installdox tool
1270 # does not have to be run to correct the links.
1271 # Note that each tag file must have a unique name
1272 # (where the name does NOT include the path)
1273 # If a tag file is not located in the directory in which doxygen
1274 # is run, you must also specify the path to the tagfile here.
1278 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1279 # a tag file that is based on the input files it reads.
1283 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1284 # in the class index. If set to NO only the inherited external classes
1289 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1290 # in the modules index. If set to NO, only the current project's groups will
1293 EXTERNAL_GROUPS = YES
1295 # The PERL_PATH should be the absolute path and name of the perl script
1296 # interpreter (i.e. the result of `which perl').
1298 PERL_PATH = /usr/bin/perl
1300 #---------------------------------------------------------------------------
1301 # Configuration options related to the dot tool
1302 #---------------------------------------------------------------------------
1304 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1305 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1306 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1307 # this option is superseded by the HAVE_DOT option below. This is only a
1308 # fallback. It is recommended to install and use dot, since it yields more
1311 CLASS_DIAGRAMS = YES
1313 # You can define message sequence charts within doxygen comments using the \msc
1314 # command. Doxygen will then run the mscgen tool (see
1315 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1316 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1317 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1318 # default search path.
1322 # If set to YES, the inheritance and collaboration graphs will hide
1323 # inheritance and usage relations if the target is undocumented
1324 # or is not a class.
1326 HIDE_UNDOC_RELATIONS = YES
1328 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1329 # available from the path. This tool is part of Graphviz, a graph visualization
1330 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1331 # have no effect if this option is set to NO (the default)
1335 # By default doxygen will write a font called FreeSans.ttf to the output
1336 # directory and reference it in all dot files that doxygen generates. This
1337 # font does not include all possible unicode characters however, so when you need
1338 # these (or just want a differently looking font) you can specify the font name
1339 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1340 # which can be done by putting it in a standard location or by setting the
1341 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1342 # containing the font.
1346 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1347 # The default size is 10pt.
1351 # By default doxygen will tell dot to use the output directory to look for the
1352 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1353 # different font using DOT_FONTNAME you can set the path where dot
1354 # can find it using this tag.
1358 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1359 # will generate a graph for each documented class showing the direct and
1360 # indirect inheritance relations. Setting this tag to YES will force the
1361 # the CLASS_DIAGRAMS tag to NO.
1365 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1366 # will generate a graph for each documented class showing the direct and
1367 # indirect implementation dependencies (inheritance, containment, and
1368 # class references variables) of the class with other documented classes.
1370 COLLABORATION_GRAPH = YES
1372 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1373 # will generate a graph for groups, showing the direct groups dependencies
1377 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1378 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1383 # If set to YES, the inheritance and collaboration graphs will show the
1384 # relations between templates and their instances.
1386 TEMPLATE_RELATIONS = NO
1388 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1389 # tags are set to YES then doxygen will generate a graph for each documented
1390 # file showing the direct and indirect include dependencies of the file with
1391 # other documented files.
1395 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1396 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1397 # documented header file showing the documented files that directly or
1398 # indirectly include this file.
1400 INCLUDED_BY_GRAPH = YES
1402 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1403 # doxygen will generate a call dependency graph for every global function
1404 # or class method. Note that enabling this option will significantly increase
1405 # the time of a run. So in most cases it will be better to enable call graphs
1406 # for selected functions only using the \callgraph command.
1410 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1411 # doxygen will generate a caller dependency graph for every global function
1412 # or class method. Note that enabling this option will significantly increase
1413 # the time of a run. So in most cases it will be better to enable caller
1414 # graphs for selected functions only using the \callergraph command.
1418 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1419 # will graphical hierarchy of all classes instead of a textual one.
1421 GRAPHICAL_HIERARCHY = YES
1423 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1424 # then doxygen will show the dependencies a directory has on other directories
1425 # in a graphical way. The dependency relations are determined by the #include
1426 # relations between the files in the directories.
1428 DIRECTORY_GRAPH = YES
1430 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1431 # generated by dot. Possible values are png, jpg, or gif
1432 # If left blank png will be used.
1434 DOT_IMAGE_FORMAT = png
1436 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1437 # found. If left blank, it is assumed the dot tool can be found in the path.
1441 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1442 # contain dot files that are included in the documentation (see the
1443 # \dotfile command).
1447 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1448 # nodes that will be shown in the graph. If the number of nodes in a graph
1449 # becomes larger than this value, doxygen will truncate the graph, which is
1450 # visualized by representing a node as a red box. Note that doxygen if the
1451 # number of direct children of the root node in a graph is already larger than
1452 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1453 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1455 DOT_GRAPH_MAX_NODES = 50
1457 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1458 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1459 # from the root by following a path via at most 3 edges will be shown. Nodes
1460 # that lay further from the root node will be omitted. Note that setting this
1461 # option to 1 or 2 may greatly reduce the computation time needed for large
1462 # code bases. Also note that the size of a graph can be further restricted by
1463 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1465 MAX_DOT_GRAPH_DEPTH = 0
1467 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1468 # background. This is disabled by default, because dot on Windows does not
1469 # seem to support this out of the box. Warning: Depending on the platform used,
1470 # enabling this option may lead to badly anti-aliased labels on the edges of
1471 # a graph (i.e. they become hard to read).
1473 DOT_TRANSPARENT = NO
1475 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1476 # files in one run (i.e. multiple -o and -T options on the command line). This
1477 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1478 # support this, this feature is disabled by default.
1480 DOT_MULTI_TARGETS = NO
1482 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1483 # generate a legend page explaining the meaning of the various boxes and
1484 # arrows in the dot generated graphs.
1486 GENERATE_LEGEND = YES
1488 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1489 # remove the intermediate dot files that are used to generate
1490 # the various graphs.