3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project
6 # All text after a hash (#) is considered a comment and will be ignored
8 # TAG = value [value, ...]
9 # For lists items can also be appended using:
10 # TAG += value [value, ...]
11 # Values that contain spaces should be placed between quotes (" ")
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
17 # This tag specifies the encoding used for all characters in the config file
18 # that follow. The default is UTF-8 which is also the encoding used for all
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
20 # iconv built into libc) for the transcoding. See
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
23 DOXYFILE_ENCODING = UTF-8
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 # by quotes) that should identify the project.
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
31 # This could be handy for archiving the generated documentation or
32 # if some version control system is used.
36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37 # base path where the generated documentation will be put.
38 # If a relative path is entered, it will be relative to the location
39 # where doxygen was started. If left blank the current directory will be used.
41 OUTPUT_DIRECTORY = doc
43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44 # 4096 sub-directories (in 2 levels) under the output directory of each output
45 # format and will distribute the generated files over these directories.
46 # Enabling this option can be useful when feeding doxygen a huge amount of
47 # source files, where putting all generated files in the same directory would
48 # otherwise cause performance problems for the file system.
52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 # documentation generated by doxygen is written. Doxygen will use this
54 # information to generate all constant output in the proper language.
55 # The default language is English, other supported languages are:
56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
63 OUTPUT_LANGUAGE = English
65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66 # include brief member descriptions after the members that are listed in
67 # the file and class documentation (similar to JavaDoc).
68 # Set to NO to disable this.
70 BRIEF_MEMBER_DESC = YES
72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73 # the brief description of a member or function before the detailed description.
74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 # brief descriptions will be completely suppressed.
79 # This tag implements a quasi-intelligent brief description abbreviator
80 # that is used to form the text in various listings. Each string
81 # in this list, if found as the leading text of the brief description, will be
82 # stripped from the text and the result after processing the whole list, is
83 # used as the annotated text. Otherwise, the brief description is used as-is.
84 # If left blank, the following values are used ("$name" is automatically
85 # replaced with the name of the entity): "The $name class" "The $name widget"
86 # "The $name file" "is" "provides" "specifies" "contains"
87 # "represents" "a" "an" "the"
91 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92 # Doxygen will generate a detailed section even if there is only a brief
95 ALWAYS_DETAILED_SEC = YES
97 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98 # inherited members of a class in the documentation of that class as if those
99 # members were ordinary class members. Constructors, destructors and assignment
100 # operators of the base classes will not be shown.
102 INLINE_INHERITED_MEMB = NO
104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105 # path before files name in the file list and in the header files. If set
106 # to NO the shortest path that makes the file name unique will be used.
108 FULL_PATH_NAMES = YES
110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111 # can be used to strip a user-defined part of the path. Stripping is
112 # only done if one of the specified strings matches the left-hand part of
113 # the path. The tag can be used to show relative paths in the file list.
114 # If left blank the directory from which doxygen is run is used as the
119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120 # the path mentioned in the documentation of a class, which tells
121 # the reader which header file to include in order to use a class.
122 # If left blank only the name of the header file containing the class
123 # definition is used. Otherwise one should specify the include paths that
124 # are normally passed to the compiler using the -I flag.
126 STRIP_FROM_INC_PATH = $(TOPDIR)
128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129 # (but less readable) file names. This can be useful is your file systems
130 # doesn't support long names like on DOS, Mac, or CD-ROM.
134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135 # will interpret the first line (until the first dot) of a JavaDoc-style
136 # comment as the brief description. If set to NO, the JavaDoc
137 # comments will behave just like regular Qt-style comments
138 # (thus requiring an explicit @brief command for a brief description.)
140 JAVADOC_AUTOBRIEF = NO
142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143 # interpret the first line (until the first dot) of a Qt-style
144 # comment as the brief description. If set to NO, the comments
145 # will behave just like regular Qt-style comments (thus requiring
146 # an explicit \brief command for a brief description.)
150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
152 # comments) as a brief description. This used to be the default behaviour.
153 # The new default is to treat a multi-line C++ comment block as a detailed
154 # description. Set this tag to YES if you prefer the old behaviour instead.
156 MULTILINE_CPP_IS_BRIEF = YES
158 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
159 # will output the detailed description near the top, like JavaDoc.
160 # If set to NO, the detailed description appears after the member
164 LAYOUT_FILE = $(TOPDIR)/doclib/DoxygenLayout.xml
166 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
167 # member inherits the documentation from any documented member that it
172 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
173 # a new page for each member. If set to NO, the documentation of a member will
174 # be part of the file/class/namespace that contains it.
176 SEPARATE_MEMBER_PAGES = NO
178 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
179 # Doxygen uses this value to replace tabs by spaces in code fragments.
183 # This tag can be used to specify a number of aliases that acts
184 # as commands in the documentation. An alias has the form "name=value".
185 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
186 # put the command \sideeffect (or @sideeffect) in the documentation, which
187 # will result in a user-defined paragraph with heading "Side Effects:".
188 # You can put \n's in the value part of an alias to insert newlines.
190 ALIASES = "fixme=\xrefitem fixme \"Fix\" \"Fixmes\"" \
191 "idea=\xrefitem idea \"Idea\" \"Ideas\"" \
192 "implementation=\par \"Implementation note:\"" \
193 "doc=\xrefitem doc \"Documentation request\" \"Documentation Requests\"" \
194 "autotoc=\htmlonly <div id=\"autotoc\"></div> \endhtmlonly" \
195 "seechapter=<b>\htmlonly → \endhtmlonly see </b>"
197 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
198 # sources only. Doxygen will then generate output that is more tailored for C.
199 # For instance, some of the names that are used will be different. The list
200 # of all members will be omitted, etc.
202 OPTIMIZE_OUTPUT_FOR_C = NO
204 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
205 # sources only. Doxygen will then generate output that is more tailored for
206 # Java. For instance, namespaces will be presented as packages, qualified
207 # scopes will look different, etc.
209 OPTIMIZE_OUTPUT_JAVA = NO
211 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
212 # sources only. Doxygen will then generate output that is more tailored for
215 OPTIMIZE_FOR_FORTRAN = NO
217 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
218 # sources. Doxygen will then generate output that is tailored for
221 OPTIMIZE_OUTPUT_VHDL = NO
223 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
224 # to include (a tag file for) the STL sources as input, then you should
225 # set this tag to YES in order to let doxygen match functions declarations and
226 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
227 # func(std::string) {}). This also make the inheritance and collaboration
228 # diagrams that involve STL classes more complete and accurate.
230 BUILTIN_STL_SUPPORT = YES
232 # If you use Microsoft's C++/CLI language, you should set this option to YES to
233 # enable parsing support.
237 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
238 # Doxygen will parse them like normal C++ but will assume all classes use public
239 # instead of private inheritance when no explicit protection keyword is present.
243 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
244 # tag is set to YES, then doxygen will reuse the documentation of the first
245 # member in the group (if any) for the other members of the group. By default
246 # all members of a group must be documented explicitly.
248 DISTRIBUTE_GROUP_DOC = NO
250 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
251 # the same type (for instance a group of public functions) to be put as a
252 # subgroup of that type (e.g. under the Public Functions section). Set it to
253 # NO to prevent subgrouping. Alternatively, this can be done per class using
254 # the \nosubgrouping command.
258 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
259 # is documented as struct, union, or enum with the name of the typedef. So
260 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
261 # with name TypeT. When disabled the typedef will appear as a member of a file,
262 # namespace, or class. And the struct will be named TypeS. This can typically
263 # be useful for C code in case the coding convention dictates that all compound
264 # types are typedef'ed and only the typedef is referenced, never the tag name.
266 TYPEDEF_HIDES_STRUCT = NO
268 #---------------------------------------------------------------------------
269 # Build related configuration options
270 #---------------------------------------------------------------------------
272 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
273 # documentation are documented, even if no documentation was available.
274 # Private class members and static file members will be hidden unless
275 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
279 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
280 # will be included in the documentation.
284 # If the EXTRACT_STATIC tag is set to YES all static members of a file
285 # will be included in the documentation.
289 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
290 # defined locally in source files will be included in the documentation.
291 # If set to NO only classes defined in header files are included.
293 EXTRACT_LOCAL_CLASSES = YES
295 # This flag is only useful for Objective-C code. When set to YES local
296 # methods, which are defined in the implementation section but not in
297 # the interface are included in the documentation.
298 # If set to NO (the default) only methods in the interface are included.
300 EXTRACT_LOCAL_METHODS = NO
302 # If this flag is set to YES, the members of anonymous namespaces will be
303 # extracted and appear in the documentation as a namespace called
304 # 'anonymous_namespace{file}', where file will be replaced with the base
305 # name of the file that contains the anonymous namespace. By default
306 # anonymous namespace are hidden.
308 EXTRACT_ANON_NSPACES = NO
310 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
311 # undocumented members of documented classes, files or namespaces.
312 # If set to NO (the default) these members will be included in the
313 # various overviews, but no documentation section is generated.
314 # This option has no effect if EXTRACT_ALL is enabled.
316 HIDE_UNDOC_MEMBERS = NO
318 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
319 # undocumented classes that are normally visible in the class hierarchy.
320 # If set to NO (the default) these classes will be included in the various
321 # overviews. This option has no effect if EXTRACT_ALL is enabled.
323 HIDE_UNDOC_CLASSES = NO
325 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
326 # friend (class|struct|union) declarations.
327 # If set to NO (the default) these declarations will be included in the
330 HIDE_FRIEND_COMPOUNDS = YES
332 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
333 # documentation blocks found inside the body of a function.
334 # If set to NO (the default) these blocks will be appended to the
335 # function's detailed documentation block.
337 HIDE_IN_BODY_DOCS = NO
339 # The INTERNAL_DOCS tag determines if documentation
340 # that is typed after a \internal command is included. If the tag is set
341 # to NO (the default) then the documentation will be excluded.
342 # Set it to YES to include the internal documentation.
346 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
347 # file names in lower-case letters. If set to YES upper-case letters are also
348 # allowed. This is useful if you have classes or files whose names only differ
349 # in case and if your file system supports case sensitive file names. Windows
350 # and Mac users are advised to set this option to NO.
352 CASE_SENSE_NAMES = YES
354 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
355 # will show members with their full class and namespace scopes in the
356 # documentation. If set to YES the scope will be hidden.
358 HIDE_SCOPE_NAMES = NO
360 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
361 # will put a list of the files that are included by a file in the documentation
364 SHOW_INCLUDE_FILES = YES
366 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
367 # is inserted in the documentation for inline members.
371 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
372 # will sort the (detailed) documentation of file and class members
373 # alphabetically by member name. If set to NO the members will appear in
376 SORT_MEMBER_DOCS = YES
378 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
379 # brief documentation of file, namespace and class members alphabetically
380 # by member name. If set to NO (the default) the members will appear in
385 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
386 # hierarchy of group names into alphabetical order. If set to NO (the default)
387 # the group names will appear in their defined order.
389 SORT_GROUP_NAMES = NO
391 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
392 # sorted by fully-qualified names, including namespaces. If set to
393 # NO (the default), the class list will be sorted only by class name,
394 # not including the namespace part.
395 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
396 # Note: This option applies only to the class list, not to the
399 SORT_BY_SCOPE_NAME = NO
401 # The GENERATE_TODOLIST tag can be used to enable (YES) or
402 # disable (NO) the todo list. This list is created by putting \todo
403 # commands in the documentation.
405 GENERATE_TODOLIST = YES
407 # The GENERATE_TESTLIST tag can be used to enable (YES) or
408 # disable (NO) the test list. This list is created by putting \test
409 # commands in the documentation.
411 GENERATE_TESTLIST = YES
413 # The GENERATE_BUGLIST tag can be used to enable (YES) or
414 # disable (NO) the bug list. This list is created by putting \bug
415 # commands in the documentation.
417 GENERATE_BUGLIST = YES
419 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
420 # disable (NO) the deprecated list. This list is created by putting
421 # \deprecated commands in the documentation.
423 GENERATE_DEPRECATEDLIST= YES
425 # The ENABLED_SECTIONS tag can be used to enable conditional
426 # documentation sections, marked by \if sectionname ... \endif.
430 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
431 # the initial value of a variable or define consists of for it to appear in
432 # the documentation. If the initializer consists of more lines than specified
433 # here it will be hidden. Use a value of 0 to hide initializers completely.
434 # The appearance of the initializer of individual variables and defines in the
435 # documentation can be controlled using \showinitializer or \hideinitializer
436 # command in the documentation regardless of this setting.
438 MAX_INITIALIZER_LINES = 30
440 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
441 # at the bottom of the documentation of classes and structs. If set to YES the
442 # list will mention the files that were used to generate the documentation.
444 SHOW_USED_FILES = YES
446 # If the sources in your project are distributed over multiple directories
447 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
448 # in the documentation. The default is NO.
450 SHOW_DIRECTORIES = NO
452 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
453 # doxygen should invoke to get the current version for each file (typically from
454 # the version control system). Doxygen will invoke the program by executing (via
455 # popen()) the command <command> <input-file>, where <command> is the value of
456 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
457 # provided by doxygen. Whatever the program writes to standard output
458 # is used as the file version. See the manual for examples.
460 ##FILE_VERSION_FILTER =
462 #---------------------------------------------------------------------------
463 # configuration options related to warning and progress messages
464 #---------------------------------------------------------------------------
466 # The QUIET tag can be used to turn on/off the messages that are generated
467 # by doxygen. Possible values are YES and NO. If left blank NO is used.
471 # The WARNINGS tag can be used to turn on/off the warning messages that are
472 # generated by doxygen. Possible values are YES and NO. If left blank
477 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
478 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
479 # automatically be disabled.
481 WARN_IF_UNDOCUMENTED = YES
483 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
484 # potential errors in the documentation, such as not documenting some
485 # parameters in a documented function, or documenting parameters that
486 # don't exist or using markup commands wrongly.
488 WARN_IF_DOC_ERROR = YES
490 # This WARN_NO_PARAMDOC option can be abled to get warnings for
491 # functions that are documented, but have no documentation for their parameters
492 # or return value. If set to NO (the default) doxygen will only warn about
493 # wrong or incomplete parameter documentation, but not about the absence of
496 WARN_NO_PARAMDOC = NO
498 # The WARN_FORMAT tag determines the format of the warning messages that
499 # doxygen can produce. The string should contain the $file, $line, and $text
500 # tags, which will be replaced by the file and line number from which the
501 # warning originated and the warning text. Optionally the format may contain
502 # $version, which will be replaced by the version of the file (if it could
503 # be obtained via FILE_VERSION_FILTER)
505 WARN_FORMAT = "$file:$line: $text"
507 # The WARN_LOGFILE tag can be used to specify a file to which warning
508 # and error messages should be written. If left blank the output is written
513 #---------------------------------------------------------------------------
514 # configuration options related to the input files
515 #---------------------------------------------------------------------------
517 # The INPUT tag can be used to specify the files and/or directories that contain
518 # documented source files. You may enter file names like "myfile.cpp" or
519 # directories like "/usr/src/myproject". Separate the files or directories
524 # This tag can be used to specify the character encoding of the source files
525 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
526 # also the default input encoding. Doxygen uses libiconv (or the iconv built
527 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
528 # the list of possible encodings.
530 INPUT_ENCODING = UTF-8
532 # If the value of the INPUT tag contains directories, you can use the
533 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
534 # and *.h) to filter out the source-files in the directories. If left
535 # blank the following patterns are tested:
536 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
537 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
539 FILE_PATTERNS = *.c \
550 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
551 # should be searched for input files as well. Possible values are YES and NO.
552 # If left blank NO is used.
556 # The EXCLUDE tag can be used to specify files and/or directories that should
557 # excluded from the INPUT source files. This way you can easily exclude a
558 # subdirectory from a directory tree whose root is specified with the INPUT tag.
562 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
563 # directories that are symbolic links (a Unix filesystem feature) are excluded
566 EXCLUDE_SYMLINKS = NO
568 # If the value of the INPUT tag contains directories, you can use the
569 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
570 # certain files from those directories. Note that the wildcards are matched
571 # against the file with absolute path, so to exclude all test directories
572 # for example use the pattern */test/*
574 EXCLUDE_PATTERNS = *.test.cc \
580 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
581 # (namespaces, classes, functions, etc.) that should be excluded from the
582 # output. The symbol name can be a fully qualified name, a word, or if the
583 # wildcard * is used, a substring. Examples: ANamespace, AClass,
584 # AClass::ANamespace, ANamespace::*Test
586 EXCLUDE_SYMBOLS = boost std
588 # The EXAMPLE_PATH tag can be used to specify one or more files or
589 # directories that contain example code fragments that are included (see
590 # the \include command).
594 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
595 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
596 # and *.h) to filter out the source-files in the directories. If left
597 # blank all files are included.
601 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
602 # searched for input files to be used with the \include or \dontinclude
603 # commands irrespective of the value of the RECURSIVE tag.
604 # Possible values are YES and NO. If left blank NO is used.
606 EXAMPLE_RECURSIVE = NO
608 # The IMAGE_PATH tag can be used to specify one or more files or
609 # directories that contain image that are included in the documentation (see
610 # the \image command).
614 # The INPUT_FILTER tag can be used to specify a program that doxygen should
615 # invoke to filter for each input file. Doxygen will invoke the filter program
616 # by executing (via popen()) the command <filter> <input-file>, where <filter>
617 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
618 # input file. Doxygen will then use the output that the filter program writes
619 # to standard output. If FILTER_PATTERNS is specified, this tag will be
622 INPUT_FILTER = "$(TOPDIR)/doclib/filter.pl"
624 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
625 # basis. Doxygen will compare the file name with each pattern and apply the
626 # filter if there is a match. The filters are a list of the form:
627 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
628 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
629 # is applied to all files.
633 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
634 # INPUT_FILTER) will be used to filter the input files when producing source
635 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
637 FILTER_SOURCE_FILES = NO
639 #---------------------------------------------------------------------------
640 # configuration options related to source browsing
641 #---------------------------------------------------------------------------
643 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
644 # be generated. Documented entities will be cross-referenced with these sources.
645 # Note: To get rid of all source code in the generated output, make sure also
646 # VERBATIM_HEADERS is set to NO.
650 # Setting the INLINE_SOURCES tag to YES will include the body
651 # of functions and classes directly in the documentation.
655 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
656 # doxygen to hide any special comment blocks from generated source code
657 # fragments. Normal C and C++ comments will always remain visible.
659 STRIP_CODE_COMMENTS = YES
661 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
662 # then for each documented function all documented
663 # functions referencing it will be listed.
665 REFERENCED_BY_RELATION = NO
667 # If the REFERENCES_RELATION tag is set to YES (the default)
668 # then for each documented function all documented entities
669 # called/used by that function will be listed.
671 REFERENCES_RELATION = NO
673 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
674 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
675 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
676 # link to the source code. Otherwise they will link to the documentstion.
678 REFERENCES_LINK_SOURCE = YES
680 # If the USE_HTAGS tag is set to YES then the references to source code
681 # will point to the HTML generated by the htags(1) tool instead of doxygen
682 # built-in source browser. The htags tool is part of GNU's global source
683 # tagging system (see http://www.gnu.org/software/global/global.html). You
684 # will need version 4.8.6 or higher.
688 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
689 # will generate a verbatim copy of the header file for each class for
690 # which an include is specified. Set to NO to disable this.
692 VERBATIM_HEADERS = YES
694 #---------------------------------------------------------------------------
695 # configuration options related to the alphabetical class index
696 #---------------------------------------------------------------------------
698 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
699 # of all compounds will be generated. Enable this if the project
700 # contains a lot of classes, structs, unions or interfaces.
702 ALPHABETICAL_INDEX = YES
704 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
705 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
706 # in which this list will be split (can be a number in the range [1..20])
708 COLS_IN_ALPHA_INDEX = 3
710 # In case all classes in a project start with a common prefix, all
711 # classes will be put under the same header in the alphabetical index.
712 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
713 # should be ignored while generating the index headers.
717 #---------------------------------------------------------------------------
718 # configuration options related to the HTML output
719 #---------------------------------------------------------------------------
721 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
722 # generate HTML output.
726 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
727 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
728 # put in front of it. If left blank `html' will be used as the default path.
732 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
733 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
734 # doxygen will generate files with .html extension.
736 HTML_FILE_EXTENSION = .html
738 # The HTML_HEADER tag can be used to specify a personal HTML header for
739 # each generated HTML page. If it is left blank doxygen will generate a
742 HTML_HEADER = "$(TOPDIR)/doclib/doxy-header.html"
744 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
745 # each generated HTML page. If it is left blank doxygen will generate a
748 HTML_FOOTER = "$(TOPDIR)/doclib/doxy-footer.html"
750 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
751 # style sheet that is used by each HTML page. It can be used to
752 # fine-tune the look of the HTML output. If the tag is left blank doxygen
753 # will generate a default style sheet. Note that doxygen will try to copy
754 # the style sheet file to the HTML output directory, so don't put your own
755 # stylesheet in the HTML output directory as well, or it will be erased!
759 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
760 # files or namespaces will be aligned in HTML using tables. If set to
761 # NO a bullet list will be used.
763 HTML_ALIGN_MEMBERS = YES
765 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
766 # will be generated that can be used as input for tools like the
767 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
768 # of the generated HTML documentation.
770 GENERATE_HTMLHELP = NO
772 # If the GENERATE_DOCSET tag is set to YES, additional index files
773 # will be generated that can be used as input for Apple's Xcode 3
774 # integrated development environment, introduced with OSX 10.5 (Leopard).
775 # To create a documentation set, doxygen will generate a Makefile in the
776 # HTML output directory. Running make will produce the docset in that
777 # directory and running "make install" will install the docset in
778 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
783 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
784 # feed. A documentation feed provides an umbrella under which multiple
785 # documentation sets from a single provider (such as a company or product suite)
788 DOCSET_FEEDNAME = "Doxygen generated docs"
790 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
791 # should uniquely identify the documentation set bundle. This should be a
792 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
793 # will append .docset to the name.
795 DOCSET_BUNDLE_ID = org.doxygen.Project
797 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
798 # documentation will contain sections that can be hidden and shown after the
799 # page has loaded. For this to work a browser that supports
800 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
801 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
803 HTML_DYNAMIC_SECTIONS = NO
805 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
806 # be used to specify the file name of the resulting .chm file. You
807 # can add a path in front of the file if the result should not be
808 # written to the html output directory.
812 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
813 # be used to specify the location (absolute path including file name) of
814 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
815 # the HTML help compiler on the generated index.hhp.
819 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
820 # controls if a separate .chi index file is generated (YES) or that
821 # it should be included in the master .chm file (NO).
825 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
826 # controls whether a binary table of contents is generated (YES) or a
827 # normal table of contents (NO) in the .chm file.
831 # The TOC_EXPAND flag can be set to YES to add extra items for group members
832 # to the contents of the HTML help documentation and to the tree view.
836 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
837 # top of each HTML page. The value NO (the default) enables the index and
838 # the value YES disables it.
842 # This tag can be used to set the number of enum values (range [1..20])
843 # that doxygen will group on one line in the generated HTML documentation.
845 ENUM_VALUES_PER_LINE = 4
847 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
848 # generated containing a tree-like index structure (just like the one that
849 # is generated for HTML Help). For this to work a browser that supports
850 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
851 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
852 # probably better off using the HTML help feature.
854 GENERATE_TREEVIEW = NO
856 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
857 # used to set the initial width (in pixels) of the frame in which the tree
862 #---------------------------------------------------------------------------
863 # configuration options related to the LaTeX output
864 #---------------------------------------------------------------------------
866 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
867 # generate Latex output.
871 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
872 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
873 # put in front of it. If left blank `latex' will be used as the default path.
877 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
878 # invoked. If left blank `latex' will be used as the default command name.
880 LATEX_CMD_NAME = latex
882 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
883 # generate index for LaTeX. If left blank `makeindex' will be used as the
884 # default command name.
886 MAKEINDEX_CMD_NAME = makeindex
888 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
889 # LaTeX documents. This may be useful for small projects and may help to
890 # save some trees in general.
894 # The PAPER_TYPE tag can be used to set the paper type that is used
895 # by the printer. Possible values are: a4, a4wide, letter, legal and
896 # executive. If left blank a4wide will be used.
900 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
901 # packages that should be included in the LaTeX output.
905 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
906 # the generated latex document. The header should contain everything until
907 # the first chapter. If it is left blank doxygen will generate a
908 # standard header. Notice: only use this tag if you know what you are doing!
912 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
913 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
914 # contain links (just like the HTML output) instead of page references
915 # This makes the output suitable for online browsing using a pdf viewer.
919 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
920 # plain latex in the generated Makefile. Set this option to YES to get a
921 # higher quality PDF documentation.
925 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
926 # command to the generated LaTeX files. This will instruct LaTeX to keep
927 # running if errors occur, instead of asking the user for help.
928 # This option is also used when generating formulas in HTML.
932 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
933 # include the index chapters (such as File Index, Compound Index, etc.)
936 LATEX_HIDE_INDICES = NO
938 #---------------------------------------------------------------------------
939 # configuration options related to the RTF output
940 #---------------------------------------------------------------------------
942 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
943 # The RTF output is optimized for Word 97 and may not look very pretty with
944 # other RTF readers or editors.
948 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
949 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
950 # put in front of it. If left blank `rtf' will be used as the default path.
954 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
955 # RTF documents. This may be useful for small projects and may help to
956 # save some trees in general.
960 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
961 # will contain hyperlink fields. The RTF file will
962 # contain links (just like the HTML output) instead of page references.
963 # This makes the output suitable for online browsing using WORD or other
964 # programs which support those fields.
965 # Note: wordpad (write) and others do not support links.
969 # Load stylesheet definitions from file. Syntax is similar to doxygen's
970 # config file, i.e. a series of assignments. You only have to provide
971 # replacements, missing definitions are set to their default value.
973 ##RTF_STYLESHEET_FILE =
975 # Set optional variables used in the generation of an rtf document.
976 # Syntax is similar to doxygen's config file.
978 ##RTF_EXTENSIONS_FILE =
980 #---------------------------------------------------------------------------
981 # configuration options related to the man page output
982 #---------------------------------------------------------------------------
984 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
989 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
990 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
991 # put in front of it. If left blank `man' will be used as the default path.
995 # The MAN_EXTENSION tag determines the extension that is added to
996 # the generated man pages (default is the subroutine's section .3)
1000 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1001 # then it will generate one additional man file for each entity
1002 # documented in the real man page(s). These additional files
1003 # only source the real man page, but without them the man command
1004 # would be unable to find the correct page. The default is NO.
1008 #---------------------------------------------------------------------------
1009 # configuration options related to the XML output
1010 #---------------------------------------------------------------------------
1012 # If the GENERATE_XML tag is set to YES Doxygen will
1013 # generate an XML file that captures the structure of
1014 # the code including all documentation.
1018 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1019 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1020 # put in front of it. If left blank `xml' will be used as the default path.
1024 # The XML_SCHEMA tag can be used to specify an XML schema,
1025 # which can be used by a validating XML parser to check the
1026 # syntax of the XML files.
1030 # The XML_DTD tag can be used to specify an XML DTD,
1031 # which can be used by a validating XML parser to check the
1032 # syntax of the XML files.
1036 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1037 # dump the program listings (including syntax highlighting
1038 # and cross-referencing information) to the XML output. Note that
1039 # enabling this will significantly increase the size of the XML output.
1041 XML_PROGRAMLISTING = YES
1043 #---------------------------------------------------------------------------
1044 # configuration options for the AutoGen Definitions output
1045 #---------------------------------------------------------------------------
1047 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1048 # generate an AutoGen Definitions (see autogen.sf.net) file
1049 # that captures the structure of the code including all
1050 # documentation. Note that this feature is still experimental
1051 # and incomplete at the moment.
1053 GENERATE_AUTOGEN_DEF = NO
1055 #---------------------------------------------------------------------------
1056 # configuration options related to the Perl module output
1057 #---------------------------------------------------------------------------
1059 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1060 # generate a Perl module file that captures the structure of
1061 # the code including all documentation. Note that this
1062 # feature is still experimental and incomplete at the
1065 GENERATE_PERLMOD = NO
1067 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1068 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1069 # to generate PDF and DVI output from the Perl module output.
1073 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1074 # nicely formatted so it can be parsed by a human reader. This is useful
1075 # if you want to understand what is going on. On the other hand, if this
1076 # tag is set to NO the size of the Perl module output will be much smaller
1077 # and Perl will parse it just the same.
1079 PERLMOD_PRETTY = YES
1081 # The names of the make variables in the generated doxyrules.make file
1082 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1083 # This is useful so different doxyrules.make files included by the same
1084 # Makefile don't overwrite each other's variables.
1086 ##PERLMOD_MAKEVAR_PREFIX =
1088 #---------------------------------------------------------------------------
1089 # Configuration options related to the preprocessor
1090 #---------------------------------------------------------------------------
1092 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1093 # evaluate all C-preprocessor directives found in the sources and include
1096 ENABLE_PREPROCESSING = YES
1098 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1099 # names in the source code. If set to NO (the default) only conditional
1100 # compilation will be performed. Macro expansion can be done in a controlled
1101 # way by setting EXPAND_ONLY_PREDEF to YES.
1103 MACRO_EXPANSION = YES
1105 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1106 # then the macro expansion is limited to the macros specified with the
1107 # PREDEFINED and EXPAND_AS_DEFINED tags.
1109 EXPAND_ONLY_PREDEF = YES
1111 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1112 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1114 SEARCH_INCLUDES = YES
1116 # The INCLUDE_PATH tag can be used to specify one or more directories that
1117 # contain include files that are not input files but should be processed by
1122 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1123 # patterns (like *.h and *.hpp) to filter out the header-files in the
1124 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1127 ##INCLUDE_FILE_PATTERNS =
1129 # The PREDEFINED tag can be used to specify one or more macro names that
1130 # are defined before the preprocessor is started (similar to the -D option of
1131 # gcc). The argument of the tag is a list of macros of the form: name
1132 # or name=definition (no spaces). If the definition and the = are
1133 # omitted =1 is assumed. To prevent a macro definition from being
1134 # undefined via #undef or recursively expanded use the := operator
1135 # instead of the = operator.
1137 PREDEFINED = DOXYGEN \
1138 "SENF_PPI_MODULE(x)=" \
1140 "SENF_FIXED_PARSER()=" \
1141 "SENF_PARSER_INHERIT(name)=" \
1142 "SENF_PARSER_FIELD(name,type)=type name() const" \
1143 "SENF_PARSER_FIELD_RO(name,type)=type::value_type name() const" \
1144 "SENF_PARSER_BITFIELD(name, bits, type)=senf::ParseField_ ## type(bits) name() const" \
1145 "SENF_PARSER_BITFIELD_RO(name, bits, type)=senf::ParseField_ ## type(bits)::value_type name() const" \
1146 "SENF_PARSER_CUSTOM_FIELD(name, type, size, isize)=type name() const" \
1147 "SENF_PARSER_PRIVATE_FIELD(name,type)=private: type name() const; public:" \
1148 "SENF_PARSER_PRIVATE_FIELD_RO(name, type)=private: type::value_type name() const; public:" \
1149 "SENF_PARSER_PRIVATE_BITFIELD(name, bits, type)=private: senf::ParseField_ ## type(bits) name() const; public:" \
1150 "SENF_PARSER_PRIVATE_BITFIELD_RO(name, bits, type)=private: senf::ParseField_ ## type(bits)::value_type name() const; public:" \
1151 "SENF_PARSER_SKIP(x)=" \
1152 "SENF_PARSER_SKIP_BITS(x)=" \
1153 "SENF_PARSER_GOTO(x)=" \
1154 "SENF_PARSER_GOTO_OFFSET(x)=" \
1155 "SENF_PARSER_LABEL(x)=" \
1156 "SENF_PARSER_INIT()=void init()" \
1157 "SENF_PARSER_FINALIZE(name)=" \
1158 "ParseField_unsigned(b)=UIntFieldParser<?,?+b>" \
1159 "ParseField_signed(b)=IntFieldParser<?,?+b>" \
1160 "ParseField_bool(b)=FlagParser<?>" \
1161 "SENF_PARSER_ARRAY(name,elt_type,size)=senf::Parse_Array<size,elt_type> name() const" \
1162 "SENF_PARSER_LIST_B(name,elt_type,size_type)=senf::Parse_ListB<elt_type,size_type>::parser name() const" \
1163 "SENF_PARSER_LIST_N(name,elt_type,size_type)=senf::Parse_ListN<elt_type,size_type>::parser name() const" \
1164 "SENF_PARSER_VARIANT(name,chooser,types)=senf::Parse_Variant_Direct<chooser ## _t,?,types>::parser name() const" \
1165 "SENF_PARSER_PRIVATE_VARIANT(name,chooser,types)=private: senf::Parse_Variant_Direct<chooser ## _t,?,types>::parser name() const; public:" \
1166 "SENF_PARSER_VEC_N(name,elt_type,size_type)=senf::Parse_VectorN<elt_type,size_type> name() const" \
1167 "SENF_LOG_CLASS_AREA()=" \
1168 "SENF_LOG_DEFAULT_AREA(area)=" \
1169 "SENF_LOG_DEFAULT_STREAM(stream)=" \
1170 "BOOST_PP_ITERATE()=" \
1171 "BOOST_PARAMETER_KEYWORD(ns, name)=unspecified_keyword_type name;"
1173 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1174 # this tag can be used to specify a list of macro names that should be expanded.
1175 # The macro definition that is found in the sources will be used.
1176 # Use the PREDEFINED tag if you want to use a different macro definition.
1178 EXPAND_AS_DEFINED = prefix_ \
1179 SENF_LOG_DEF_STREAM \
1183 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1184 # doxygen's preprocessor will remove all function-like macros that are alone
1185 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1186 # function macros are typically used for boiler-plate code, and will confuse
1187 # the parser if not removed.
1189 SKIP_FUNCTION_MACROS = YES
1191 #---------------------------------------------------------------------------
1192 # Configuration::additions related to external references
1193 #---------------------------------------------------------------------------
1195 # The TAGFILES option can be used to specify one or more tagfiles.
1196 # Optionally an initial location of the external documentation
1197 # can be added for each tagfile. The format of a tag file without
1198 # this location is as follows:
1199 # TAGFILES = file1 file2 ...
1200 # Adding location for the tag files is done as follows:
1201 # TAGFILES = file1=loc1 "file2 = loc2" ...
1202 # where "loc1" and "loc2" can be relative or absolute paths or
1203 # URLs. If a location is present for each tag, the installdox tool
1204 # does not have to be run to correct the links.
1205 # Note that each tag file must have a unique name
1206 # (where the name does NOT include the path)
1207 # If a tag file is not located in the directory in which doxygen
1208 # is run, you must also specify the path to the tagfile here.
1212 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1213 # a tag file that is based on the input files it reads.
1215 ##GENERATE_TAGFILE =
1217 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1218 # in the class index. If set to NO only the inherited external classes
1223 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1224 # in the modules index. If set to NO, only the current project's groups will
1227 EXTERNAL_GROUPS = YES
1229 # The PERL_PATH should be the absolute path and name of the perl script
1230 # interpreter (i.e. the result of `which perl').
1232 PERL_PATH = /usr/bin/perl
1234 #---------------------------------------------------------------------------
1235 # Configuration options related to the dot tool
1236 #---------------------------------------------------------------------------
1238 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1239 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1240 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1241 # this option is superseded by the HAVE_DOT option below. This is only a
1242 # fallback. It is recommended to install and use dot, since it yields more
1245 CLASS_DIAGRAMS = YES
1247 # You can define message sequence charts within doxygen comments using the \msc
1248 # command. Doxygen will then run the mscgen tool (see
1249 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1250 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1251 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1252 # default search path.
1256 # If set to YES, the inheritance and collaboration graphs will hide
1257 # inheritance and usage relations if the target is undocumented
1258 # or is not a class.
1260 HIDE_UNDOC_RELATIONS = NO
1262 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1263 # available from the path. This tool is part of Graphviz, a graph visualization
1264 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1265 # have no effect if this option is set to NO (the default)
1269 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1270 # will generate a graph for each documented class showing the direct and
1271 # indirect inheritance relations. Setting this tag to YES will force the
1272 # the CLASS_DIAGRAMS tag to NO.
1276 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1277 # will generate a graph for each documented class showing the direct and
1278 # indirect implementation dependencies (inheritance, containment, and
1279 # class references variables) of the class with other documented classes.
1281 COLLABORATION_GRAPH = NO
1283 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1284 # will generate a graph for groups, showing the direct groups dependencies
1288 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1289 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1294 # If set to YES, the inheritance and collaboration graphs will show the
1295 # relations between templates and their instances.
1297 TEMPLATE_RELATIONS = NO
1299 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1300 # tags are set to YES then doxygen will generate a graph for each documented
1301 # file showing the direct and indirect include dependencies of the file with
1302 # other documented files.
1306 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1307 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1308 # documented header file showing the documented files that directly or
1309 # indirectly include this file.
1311 INCLUDED_BY_GRAPH = YES
1313 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1314 # doxygen will generate a call dependency graph for every global function
1315 # or class method. Note that enabling this option will significantly increase
1316 # the time of a run. So in most cases it will be better to enable call graphs
1317 # for selected functions only using the \callgraph command.
1321 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1322 # doxygen will generate a caller dependency graph for every global function
1323 # or class method. Note that enabling this option will significantly increase
1324 # the time of a run. So in most cases it will be better to enable caller
1325 # graphs for selected functions only using the \callergraph command.
1329 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1330 # will graphical hierarchy of all classes instead of a textual one.
1332 GRAPHICAL_HIERARCHY = NO
1334 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1335 # then doxygen will show the dependencies a directory has on other directories
1336 # in a graphical way. The dependency relations are determined by the #include
1337 # relations between the files in the directories.
1339 DIRECTORY_GRAPH = NO
1341 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1342 # generated by dot. Possible values are png, jpg, or gif
1343 # If left blank png will be used.
1345 DOT_IMAGE_FORMAT = png
1347 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1348 # found. If left blank, it is assumed the dot tool can be found in the path.
1350 DOT_PATH = "$(TOPDIR)/doclib"
1352 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1353 # contain dot files that are included in the documentation (see the
1354 # \dotfile command).
1358 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1359 # nodes that will be shown in the graph. If the number of nodes in a graph
1360 # becomes larger than this value, doxygen will truncate the graph, which is
1361 # visualized by representing a node as a red box. Note that doxygen if the
1362 # number of direct children of the root node in a graph is already larger than
1363 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1364 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1366 DOT_GRAPH_MAX_NODES = 10
1368 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1369 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1370 # from the root by following a path via at most 3 edges will be shown. Nodes
1371 # that lay further from the root node will be omitted. Note that setting this
1372 # option to 1 or 2 may greatly reduce the computation time needed for large
1373 # code bases. Also note that the size of a graph can be further restricted by
1374 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1376 MAX_DOT_GRAPH_DEPTH = 5
1378 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1379 # background. This is enabled by default, which results in a transparent
1380 # background. Warning: Depending on the platform used, enabling this option
1381 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1382 # become hard to read).
1384 DOT_TRANSPARENT = YES
1386 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1387 # files in one run (i.e. multiple -o and -T options on the command line). This
1388 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1389 # support this, this feature is disabled by default.
1391 DOT_MULTI_TARGETS = YES
1393 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1394 # generate a legend page explaining the meaning of the various boxes and
1395 # arrows in the dot generated graphs.
1397 GENERATE_LEGEND = YES
1399 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1400 # remove the intermediate dot files that are used to generate
1401 # the various graphs.
1405 #---------------------------------------------------------------------------
1406 # Configuration::additions related to the search engine
1407 #---------------------------------------------------------------------------
1409 # The SEARCHENGINE tag specifies whether or not a search engine should be
1410 # used. If set to NO the values of all tags below this one will be ignored.
1414 #---------------------------------------------------------------------------
1416 @INCLUDE = "$(TOPDIR)/Doxyfile.local"
1419 # mode: indented-text
1420 # indent-tabs-mode: nil