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 that
18 # follow. The default is UTF-8 which is also the encoding used for all text before
19 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
20 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
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.
28 PROJECT_NAME = @PACKAGE@
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.
34 PROJECT_NUMBER = @VERSION@
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/hacking
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, Finnish, French, German, Greek, Hungarian,
58 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
59 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
60 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
62 OUTPUT_LANGUAGE = English
64 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65 # include brief member descriptions after the members that are listed in
66 # the file and class documentation (similar to JavaDoc).
67 # Set to NO to disable this.
69 BRIEF_MEMBER_DESC = YES
71 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72 # the brief description of a member or function before the detailed description.
73 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
74 # brief descriptions will be completely suppressed.
78 # This tag implements a quasi-intelligent brief description abbreviator
79 # that is used to form the text in various listings. Each string
80 # in this list, if found as the leading text of the brief description, will be
81 # stripped from the text and the result after processing the whole list, is
82 # used as the annotated text. Otherwise, the brief description is used as-is.
83 # If left blank, the following values are used ("$name" is automatically
84 # replaced with the name of the entity): "The $name class" "The $name widget"
85 # "The $name file" "is" "provides" "specifies" "contains"
86 # "represents" "a" "an" "the"
90 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
91 # Doxygen will generate a detailed section even if there is only a brief
94 ALWAYS_DETAILED_SEC = NO
96 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
97 # inherited members of a class in the documentation of that class as if those
98 # members were ordinary class members. Constructors, destructors and assignment
99 # operators of the base classes will not be shown.
101 INLINE_INHERITED_MEMB = NO
103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
104 # path before files name in the file list and in the header files. If set
105 # to NO the shortest path that makes the file name unique will be used.
107 FULL_PATH_NAMES = YES
109 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
110 # can be used to strip a user-defined part of the path. Stripping is
111 # only done if one of the specified strings matches the left-hand part of
112 # the path. The tag can be used to show relative paths in the file list.
113 # If left blank the directory from which doxygen is run is used as the
116 STRIP_FROM_PATH = @top_srcdir@/
118 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
119 # the path mentioned in the documentation of a class, which tells
120 # the reader which header file to include in order to use a class.
121 # If left blank only the name of the header file containing the class
122 # definition is used. Otherwise one should specify the include paths that
123 # are normally passed to the compiler using the -I flag.
125 STRIP_FROM_INC_PATH =
127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
128 # (but less readable) file names. This can be useful is your file systems
129 # doesn't support long names like on DOS, Mac, or CD-ROM.
133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
134 # will interpret the first line (until the first dot) of a JavaDoc-style
135 # comment as the brief description. If set to NO, the JavaDoc
136 # comments will behave just like the Qt-style comments (thus requiring an
137 # explicit @brief command for a brief description.
139 JAVADOC_AUTOBRIEF = YES
141 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
142 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
143 # comments) as a brief description. This used to be the default behaviour.
144 # The new default is to treat a multi-line C++ comment block as a detailed
145 # description. Set this tag to YES if you prefer the old behaviour instead.
147 MULTILINE_CPP_IS_BRIEF = NO
149 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
150 # member inherits the documentation from any documented member that it
155 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
156 # a new page for each member. If set to NO, the documentation of a member will
157 # be part of the file/class/namespace that contains it.
159 SEPARATE_MEMBER_PAGES = NO
161 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
162 # Doxygen uses this value to replace tabs by spaces in code fragments.
166 # This tag can be used to specify a number of aliases that acts
167 # as commands in the documentation. An alias has the form "name=value".
168 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
169 # put the command \sideeffect (or @sideeffect) in the documentation, which
170 # will result in a user-defined paragraph with heading "Side Effects:".
171 # You can put \n's in the value part of an alias to insert newlines.
175 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
176 # sources only. Doxygen will then generate output that is more tailored for C.
177 # For instance, some of the names that are used will be different. The list
178 # of all members will be omitted, etc.
180 OPTIMIZE_OUTPUT_FOR_C = YES
182 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
183 # sources only. Doxygen will then generate output that is more tailored for Java.
184 # For instance, namespaces will be presented as packages, qualified scopes
185 # will look different, etc.
187 OPTIMIZE_OUTPUT_JAVA = NO
189 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
190 # include (a tag file for) the STL sources as input, then you should
191 # set this tag to YES in order to let doxygen match functions declarations and
192 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
193 # func(std::string) {}). This also make the inheritance and collaboration
194 # diagrams that involve STL classes more complete and accurate.
196 BUILTIN_STL_SUPPORT = NO
198 # If you use Microsoft's C++/CLI language, you should set this option to YES to
199 # enable parsing support.
203 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
204 # tag is set to YES, then doxygen will reuse the documentation of the first
205 # member in the group (if any) for the other members of the group. By default
206 # all members of a group must be documented explicitly.
208 DISTRIBUTE_GROUP_DOC = NO
210 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
211 # the same type (for instance a group of public functions) to be put as a
212 # subgroup of that type (e.g. under the Public Functions section). Set it to
213 # NO to prevent subgrouping. Alternatively, this can be done per class using
214 # the \nosubgrouping command.
218 #---------------------------------------------------------------------------
219 # Build related configuration options
220 #---------------------------------------------------------------------------
222 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
223 # documentation are documented, even if no documentation was available.
224 # Private class members and static file members will be hidden unless
225 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
229 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
230 # will be included in the documentation.
234 # If the EXTRACT_STATIC tag is set to YES all static members of a file
235 # will be included in the documentation.
239 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
240 # defined locally in source files will be included in the documentation.
241 # If set to NO only classes defined in header files are included.
243 EXTRACT_LOCAL_CLASSES = YES
245 # This flag is only useful for Objective-C code. When set to YES local
246 # methods, which are defined in the implementation section but not in
247 # the interface are included in the documentation.
248 # If set to NO (the default) only methods in the interface are included.
250 EXTRACT_LOCAL_METHODS = NO
252 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
253 # undocumented members of documented classes, files or namespaces.
254 # If set to NO (the default) these members will be included in the
255 # various overviews, but no documentation section is generated.
256 # This option has no effect if EXTRACT_ALL is enabled.
258 HIDE_UNDOC_MEMBERS = NO
260 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
261 # undocumented classes that are normally visible in the class hierarchy.
262 # If set to NO (the default) these classes will be included in the various
263 # overviews. This option has no effect if EXTRACT_ALL is enabled.
265 HIDE_UNDOC_CLASSES = NO
267 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
268 # friend (class|struct|union) declarations.
269 # If set to NO (the default) these declarations will be included in the
272 HIDE_FRIEND_COMPOUNDS = NO
274 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
275 # documentation blocks found inside the body of a function.
276 # If set to NO (the default) these blocks will be appended to the
277 # function's detailed documentation block.
279 HIDE_IN_BODY_DOCS = NO
281 # The INTERNAL_DOCS tag determines if documentation
282 # that is typed after a \internal command is included. If the tag is set
283 # to NO (the default) then the documentation will be excluded.
284 # Set it to YES to include the internal documentation.
288 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
289 # file names in lower-case letters. If set to YES upper-case letters are also
290 # allowed. This is useful if you have classes or files whose names only differ
291 # in case and if your file system supports case sensitive file names. Windows
292 # and Mac users are advised to set this option to NO.
294 CASE_SENSE_NAMES = YES
296 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
297 # will show members with their full class and namespace scopes in the
298 # documentation. If set to YES the scope will be hidden.
300 HIDE_SCOPE_NAMES = NO
302 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
303 # will put a list of the files that are included by a file in the documentation
306 SHOW_INCLUDE_FILES = YES
308 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
309 # is inserted in the documentation for inline members.
313 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
314 # will sort the (detailed) documentation of file and class members
315 # alphabetically by member name. If set to NO the members will appear in
318 SORT_MEMBER_DOCS = YES
320 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
321 # brief documentation of file, namespace and class members alphabetically
322 # by member name. If set to NO (the default) the members will appear in
327 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
328 # sorted by fully-qualified names, including namespaces. If set to
329 # NO (the default), the class list will be sorted only by class name,
330 # not including the namespace part.
331 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
332 # Note: This option applies only to the class list, not to the
335 SORT_BY_SCOPE_NAME = NO
337 # The GENERATE_TODOLIST tag can be used to enable (YES) or
338 # disable (NO) the todo list. This list is created by putting \todo
339 # commands in the documentation.
341 GENERATE_TODOLIST = YES
343 # The GENERATE_TESTLIST tag can be used to enable (YES) or
344 # disable (NO) the test list. This list is created by putting \test
345 # commands in the documentation.
347 GENERATE_TESTLIST = YES
349 # The GENERATE_BUGLIST tag can be used to enable (YES) or
350 # disable (NO) the bug list. This list is created by putting \bug
351 # commands in the documentation.
353 GENERATE_BUGLIST = YES
355 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
356 # disable (NO) the deprecated list. This list is created by putting
357 # \deprecated commands in the documentation.
359 GENERATE_DEPRECATEDLIST= YES
361 # The ENABLED_SECTIONS tag can be used to enable conditional
362 # documentation sections, marked by \if sectionname ... \endif.
366 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
367 # the initial value of a variable or define consists of for it to appear in
368 # the documentation. If the initializer consists of more lines than specified
369 # here it will be hidden. Use a value of 0 to hide initializers completely.
370 # The appearance of the initializer of individual variables and defines in the
371 # documentation can be controlled using \showinitializer or \hideinitializer
372 # command in the documentation regardless of this setting.
374 MAX_INITIALIZER_LINES = 30
376 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
377 # at the bottom of the documentation of classes and structs. If set to YES the
378 # list will mention the files that were used to generate the documentation.
380 SHOW_USED_FILES = YES
382 # If the sources in your project are distributed over multiple directories
383 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
384 # in the documentation. The default is NO.
386 SHOW_DIRECTORIES = NO
388 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
389 # doxygen should invoke to get the current version for each file (typically from the
390 # version control system). Doxygen will invoke the program by executing (via
391 # popen()) the command <command> <input-file>, where <command> is the value of
392 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
393 # provided by doxygen. Whatever the program writes to standard output
394 # is used as the file version. See the manual for examples.
396 FILE_VERSION_FILTER =
398 #---------------------------------------------------------------------------
399 # configuration options related to warning and progress messages
400 #---------------------------------------------------------------------------
402 # The QUIET tag can be used to turn on/off the messages that are generated
403 # by doxygen. Possible values are YES and NO. If left blank NO is used.
407 # The WARNINGS tag can be used to turn on/off the warning messages that are
408 # generated by doxygen. Possible values are YES and NO. If left blank
413 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
414 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
415 # automatically be disabled.
417 WARN_IF_UNDOCUMENTED = YES
419 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
420 # potential errors in the documentation, such as not documenting some
421 # parameters in a documented function, or documenting parameters that
422 # don't exist or using markup commands wrongly.
424 WARN_IF_DOC_ERROR = YES
426 # This WARN_NO_PARAMDOC option can be abled to get warnings for
427 # functions that are documented, but have no documentation for their parameters
428 # or return value. If set to NO (the default) doxygen will only warn about
429 # wrong or incomplete parameter documentation, but not about the absence of
432 WARN_NO_PARAMDOC = NO
434 # The WARN_FORMAT tag determines the format of the warning messages that
435 # doxygen can produce. The string should contain the $file, $line, and $text
436 # tags, which will be replaced by the file and line number from which the
437 # warning originated and the warning text. Optionally the format may contain
438 # $version, which will be replaced by the version of the file (if it could
439 # be obtained via FILE_VERSION_FILTER)
441 WARN_FORMAT = "$file:$line: $text"
443 # The WARN_LOGFILE tag can be used to specify a file to which warning
444 # and error messages should be written. If left blank the output is written
449 #---------------------------------------------------------------------------
450 # configuration options related to the input files
451 #---------------------------------------------------------------------------
453 # The INPUT tag can be used to specify the files and/or directories that contain
454 # documented source files. You may enter file names like "myfile.cpp" or
455 # directories like "/usr/src/myproject". Separate the files or directories
458 INPUT = @top_srcdir@/doc/hacking/Doxyheader \
459 @top_srcdir@/build.c \
460 @top_srcdir@/build.h \
461 @top_srcdir@/config.h \
462 @top_srcdir@/debug.h \
463 @top_srcdir@/macros \
464 @top_srcdir@/rpmqv.c \
465 @top_srcdir@/rpmpopt-@VERSION@ \
467 @top_srcdir@/rpm2cpio.c \
468 @top_srcdir@/system.h \
469 @top_srcdir@/build/ \
470 @top_srcdir@/doc/manual/builddependencies \
471 @top_srcdir@/doc/manual/buildroot \
472 @top_srcdir@/doc/manual/conditionalbuilds \
473 @top_srcdir@/doc/manual/dependencies \
474 @top_srcdir@/doc/manual/format \
475 @top_srcdir@/doc/manual/hregions \
476 @top_srcdir@/doc/manual/macros \
477 @top_srcdir@/doc/manual/multiplebuilds \
478 @top_srcdir@/doc/manual/queryformat \
479 @top_srcdir@/doc/manual/signatures \
480 @top_srcdir@/doc/manual/relocatable \
481 @top_srcdir@/doc/manual/spec \
482 @top_srcdir@/doc/manual/triggers \
483 @top_srcdir@/doc/manual/tsort \
486 @top_srcdir@/rpmdb/ \
487 @top_srcdir@/rpmio/ \
488 @top_srcdir@/python/ \
491 # This tag can be used to specify the character encoding of the source files that
492 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
493 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
494 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
496 INPUT_ENCODING = UTF-8
498 # If the value of the INPUT tag contains directories, you can use the
499 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
500 # and *.h) to filter out the source-files in the directories. If left
501 # blank the following patterns are tested:
502 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
503 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
505 FILE_PATTERNS = *.c \
508 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
509 # should be searched for input files as well. Possible values are YES and NO.
510 # If left blank NO is used.
514 # The EXCLUDE tag can be used to specify files and/or directories that should
515 # excluded from the INPUT source files. This way you can easily exclude a
516 # subdirectory from a directory tree whose root is specified with the INPUT tag.
518 EXCLUDE = @top_srcdir@/db @top_srcdir@/db.h
520 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
521 # directories that are symbolic links (a Unix filesystem feature) are excluded
524 EXCLUDE_SYMLINKS = NO
526 # If the value of the INPUT tag contains directories, you can use the
527 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
528 # certain files from those directories. Note that the wildcards are matched
529 # against the file with absolute path, so to exclude all test directories
530 # for example use the pattern */test/*
534 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
535 # (namespaces, classes, functions, etc.) that should be excluded from the output.
536 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
537 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
541 # The EXAMPLE_PATH tag can be used to specify one or more files or
542 # directories that contain example code fragments that are included (see
543 # the \include command).
545 EXAMPLE_PATH = @top_srcdir@/doc/manual
547 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
548 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
549 # and *.h) to filter out the source-files in the directories. If left
550 # blank all files are included.
554 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
555 # searched for input files to be used with the \include or \dontinclude
556 # commands irrespective of the value of the RECURSIVE tag.
557 # Possible values are YES and NO. If left blank NO is used.
559 EXAMPLE_RECURSIVE = NO
561 # The IMAGE_PATH tag can be used to specify one or more files or
562 # directories that contain image that are included in the documentation (see
563 # the \image command).
567 # The INPUT_FILTER tag can be used to specify a program that doxygen should
568 # invoke to filter for each input file. Doxygen will invoke the filter program
569 # by executing (via popen()) the command <filter> <input-file>, where <filter>
570 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
571 # input file. Doxygen will then use the output that the filter program writes
572 # to standard output. If FILTER_PATTERNS is specified, this tag will be
577 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
578 # basis. Doxygen will compare the file name with each pattern and apply the
579 # filter if there is a match. The filters are a list of the form:
580 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
581 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
582 # is applied to all files.
586 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
587 # INPUT_FILTER) will be used to filter the input files when producing source
588 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
590 FILTER_SOURCE_FILES = NO
592 #---------------------------------------------------------------------------
593 # configuration options related to source browsing
594 #---------------------------------------------------------------------------
596 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
597 # be generated. Documented entities will be cross-referenced with these sources.
598 # Note: To get rid of all source code in the generated output, make sure also
599 # VERBATIM_HEADERS is set to NO.
603 # Setting the INLINE_SOURCES tag to YES will include the body
604 # of functions and classes directly in the documentation.
608 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
609 # doxygen to hide any special comment blocks from generated source code
610 # fragments. Normal C and C++ comments will always remain visible.
612 STRIP_CODE_COMMENTS = YES
614 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
615 # then for each documented function all documented
616 # functions referencing it will be listed.
618 REFERENCED_BY_RELATION = YES
620 # If the REFERENCES_RELATION tag is set to YES (the default)
621 # then for each documented function all documented entities
622 # called/used by that function will be listed.
624 REFERENCES_RELATION = YES
626 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
627 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
628 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
629 # link to the source code. Otherwise they will link to the documentstion.
631 REFERENCES_LINK_SOURCE = YES
633 # If the USE_HTAGS tag is set to YES then the references to source code
634 # will point to the HTML generated by the htags(1) tool instead of doxygen
635 # built-in source browser. The htags tool is part of GNU's global source
636 # tagging system (see http://www.gnu.org/software/global/global.html). You
637 # will need version 4.8.6 or higher.
641 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
642 # will generate a verbatim copy of the header file for each class for
643 # which an include is specified. Set to NO to disable this.
645 VERBATIM_HEADERS = YES
647 #---------------------------------------------------------------------------
648 # configuration options related to the alphabetical class index
649 #---------------------------------------------------------------------------
651 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
652 # of all compounds will be generated. Enable this if the project
653 # contains a lot of classes, structs, unions or interfaces.
655 ALPHABETICAL_INDEX = NO
657 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
658 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
659 # in which this list will be split (can be a number in the range [1..20])
661 COLS_IN_ALPHA_INDEX = 5
663 # In case all classes in a project start with a common prefix, all
664 # classes will be put under the same header in the alphabetical index.
665 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
666 # should be ignored while generating the index headers.
670 #---------------------------------------------------------------------------
671 # configuration options related to the HTML output
672 #---------------------------------------------------------------------------
674 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
675 # generate HTML output.
679 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
680 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
681 # put in front of it. If left blank `html' will be used as the default path.
685 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
686 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
687 # doxygen will generate files with .html extension.
689 HTML_FILE_EXTENSION = .html
691 # The HTML_HEADER tag can be used to specify a personal HTML header for
692 # each generated HTML page. If it is left blank doxygen will generate a
697 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
698 # each generated HTML page. If it is left blank doxygen will generate a
703 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
704 # style sheet that is used by each HTML page. It can be used to
705 # fine-tune the look of the HTML output. If the tag is left blank doxygen
706 # will generate a default style sheet. Note that doxygen will try to copy
707 # the style sheet file to the HTML output directory, so don't put your own
708 # stylesheet in the HTML output directory as well, or it will be erased!
712 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
713 # files or namespaces will be aligned in HTML using tables. If set to
714 # NO a bullet list will be used.
716 HTML_ALIGN_MEMBERS = YES
718 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
719 # will be generated that can be used as input for tools like the
720 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
721 # of the generated HTML documentation.
723 GENERATE_HTMLHELP = NO
725 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
726 # be used to specify the file name of the resulting .chm file. You
727 # can add a path in front of the file if the result should not be
728 # written to the html output directory.
732 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
733 # be used to specify the location (absolute path including file name) of
734 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
735 # the HTML help compiler on the generated index.hhp.
739 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
740 # controls if a separate .chi index file is generated (YES) or that
741 # it should be included in the master .chm file (NO).
745 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
746 # controls whether a binary table of contents is generated (YES) or a
747 # normal table of contents (NO) in the .chm file.
751 # The TOC_EXPAND flag can be set to YES to add extra items for group members
752 # to the contents of the HTML help documentation and to the tree view.
756 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
757 # top of each HTML page. The value NO (the default) enables the index and
758 # the value YES disables it.
762 # This tag can be used to set the number of enum values (range [1..20])
763 # that doxygen will group on one line in the generated HTML documentation.
765 ENUM_VALUES_PER_LINE = 4
767 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
768 # generated containing a tree-like index structure (just like the one that
769 # is generated for HTML Help). For this to work a browser that supports
770 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
771 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
772 # probably better off using the HTML help feature.
774 GENERATE_TREEVIEW = NO
776 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
777 # used to set the initial width (in pixels) of the frame in which the tree
782 #---------------------------------------------------------------------------
783 # configuration options related to the LaTeX output
784 #---------------------------------------------------------------------------
786 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
787 # generate Latex output.
791 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
792 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
793 # put in front of it. If left blank `latex' will be used as the default path.
797 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
798 # invoked. If left blank `latex' will be used as the default command name.
800 LATEX_CMD_NAME = latex
802 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
803 # generate index for LaTeX. If left blank `makeindex' will be used as the
804 # default command name.
806 MAKEINDEX_CMD_NAME = makeindex
808 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
809 # LaTeX documents. This may be useful for small projects and may help to
810 # save some trees in general.
814 # The PAPER_TYPE tag can be used to set the paper type that is used
815 # by the printer. Possible values are: a4, a4wide, letter, legal and
816 # executive. If left blank a4wide will be used.
820 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
821 # packages that should be included in the LaTeX output.
825 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
826 # the generated latex document. The header should contain everything until
827 # the first chapter. If it is left blank doxygen will generate a
828 # standard header. Notice: only use this tag if you know what you are doing!
832 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
833 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
834 # contain links (just like the HTML output) instead of page references
835 # This makes the output suitable for online browsing using a pdf viewer.
839 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
840 # plain latex in the generated Makefile. Set this option to YES to get a
841 # higher quality PDF documentation.
845 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
846 # command to the generated LaTeX files. This will instruct LaTeX to keep
847 # running if errors occur, instead of asking the user for help.
848 # This option is also used when generating formulas in HTML.
852 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
853 # include the index chapters (such as File Index, Compound Index, etc.)
856 LATEX_HIDE_INDICES = NO
858 #---------------------------------------------------------------------------
859 # configuration options related to the RTF output
860 #---------------------------------------------------------------------------
862 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
863 # The RTF output is optimized for Word 97 and may not look very pretty with
864 # other RTF readers or editors.
868 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
869 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
870 # put in front of it. If left blank `rtf' will be used as the default path.
874 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
875 # RTF documents. This may be useful for small projects and may help to
876 # save some trees in general.
880 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
881 # will contain hyperlink fields. The RTF file will
882 # contain links (just like the HTML output) instead of page references.
883 # This makes the output suitable for online browsing using WORD or other
884 # programs which support those fields.
885 # Note: wordpad (write) and others do not support links.
889 # Load stylesheet definitions from file. Syntax is similar to doxygen's
890 # config file, i.e. a series of assignments. You only have to provide
891 # replacements, missing definitions are set to their default value.
893 RTF_STYLESHEET_FILE =
895 # Set optional variables used in the generation of an rtf document.
896 # Syntax is similar to doxygen's config file.
898 RTF_EXTENSIONS_FILE =
900 #---------------------------------------------------------------------------
901 # configuration options related to the man page output
902 #---------------------------------------------------------------------------
904 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
909 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
910 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
911 # put in front of it. If left blank `man' will be used as the default path.
915 # The MAN_EXTENSION tag determines the extension that is added to
916 # the generated man pages (default is the subroutine's section .3)
920 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
921 # then it will generate one additional man file for each entity
922 # documented in the real man page(s). These additional files
923 # only source the real man page, but without them the man command
924 # would be unable to find the correct page. The default is NO.
928 #---------------------------------------------------------------------------
929 # configuration options related to the XML output
930 #---------------------------------------------------------------------------
932 # If the GENERATE_XML tag is set to YES Doxygen will
933 # generate an XML file that captures the structure of
934 # the code including all documentation.
938 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
939 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
940 # put in front of it. If left blank `xml' will be used as the default path.
944 # The XML_SCHEMA tag can be used to specify an XML schema,
945 # which can be used by a validating XML parser to check the
946 # syntax of the XML files.
950 # The XML_DTD tag can be used to specify an XML DTD,
951 # which can be used by a validating XML parser to check the
952 # syntax of the XML files.
956 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
957 # dump the program listings (including syntax highlighting
958 # and cross-referencing information) to the XML output. Note that
959 # enabling this will significantly increase the size of the XML output.
961 XML_PROGRAMLISTING = YES
963 #---------------------------------------------------------------------------
964 # configuration options for the AutoGen Definitions output
965 #---------------------------------------------------------------------------
967 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
968 # generate an AutoGen Definitions (see autogen.sf.net) file
969 # that captures the structure of the code including all
970 # documentation. Note that this feature is still experimental
971 # and incomplete at the moment.
973 GENERATE_AUTOGEN_DEF = NO
975 #---------------------------------------------------------------------------
976 # configuration options related to the Perl module output
977 #---------------------------------------------------------------------------
979 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
980 # generate a Perl module file that captures the structure of
981 # the code including all documentation. Note that this
982 # feature is still experimental and incomplete at the
985 GENERATE_PERLMOD = NO
987 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
988 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
989 # to generate PDF and DVI output from the Perl module output.
993 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
994 # nicely formatted so it can be parsed by a human reader. This is useful
995 # if you want to understand what is going on. On the other hand, if this
996 # tag is set to NO the size of the Perl module output will be much smaller
997 # and Perl will parse it just the same.
1001 # The names of the make variables in the generated doxyrules.make file
1002 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1003 # This is useful so different doxyrules.make files included by the same
1004 # Makefile don't overwrite each other's variables.
1006 PERLMOD_MAKEVAR_PREFIX =
1008 #---------------------------------------------------------------------------
1009 # Configuration options related to the preprocessor
1010 #---------------------------------------------------------------------------
1012 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1013 # evaluate all C-preprocessor directives found in the sources and include
1016 ENABLE_PREPROCESSING = YES
1018 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1019 # names in the source code. If set to NO (the default) only conditional
1020 # compilation will be performed. Macro expansion can be done in a controlled
1021 # way by setting EXPAND_ONLY_PREDEF to YES.
1023 MACRO_EXPANSION = YES
1025 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1026 # then the macro expansion is limited to the macros specified with the
1027 # PREDEFINED and EXPAND_AS_DEFINED tags.
1029 EXPAND_ONLY_PREDEF = NO
1031 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1032 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1034 SEARCH_INCLUDES = YES
1036 # The INCLUDE_PATH tag can be used to specify one or more directories that
1037 # contain include files that are not input files but should be processed by
1042 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1043 # patterns (like *.h and *.hpp) to filter out the header-files in the
1044 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1047 INCLUDE_FILE_PATTERNS =
1049 # The PREDEFINED tag can be used to specify one or more macro names that
1050 # are defined before the preprocessor is started (similar to the -D option of
1051 # gcc). The argument of the tag is a list of macros of the form: name
1052 # or name=definition (no spaces). If the definition and the = are
1053 # omitted =1 is assumed. To prevent a macro definition from being
1054 # undefined via #undef or recursively expanded use the := operator
1055 # instead of the = operator.
1059 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1060 # this tag can be used to specify a list of macro names that should be expanded.
1061 # The macro definition that is found in the sources will be used.
1062 # Use the PREDEFINED tag if you want to use a different macro definition.
1066 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1067 # doxygen's preprocessor will remove all function-like macros that are alone
1068 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1069 # function macros are typically used for boiler-plate code, and will confuse
1070 # the parser if not removed.
1072 SKIP_FUNCTION_MACROS = YES
1074 #---------------------------------------------------------------------------
1075 # Configuration::additions related to external references
1076 #---------------------------------------------------------------------------
1078 # The TAGFILES option can be used to specify one or more tagfiles.
1079 # Optionally an initial location of the external documentation
1080 # can be added for each tagfile. The format of a tag file without
1081 # this location is as follows:
1082 # TAGFILES = file1 file2 ...
1083 # Adding location for the tag files is done as follows:
1084 # TAGFILES = file1=loc1 "file2 = loc2" ...
1085 # where "loc1" and "loc2" can be relative or absolute paths or
1086 # URLs. If a location is present for each tag, the installdox tool
1087 # does not have to be run to correct the links.
1088 # Note that each tag file must have a unique name
1089 # (where the name does NOT include the path)
1090 # If a tag file is not located in the directory in which doxygen
1091 # is run, you must also specify the path to the tagfile here.
1095 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1096 # a tag file that is based on the input files it reads.
1098 GENERATE_TAGFILE = Doxytags
1100 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1101 # in the class index. If set to NO only the inherited external classes
1106 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1107 # in the modules index. If set to NO, only the current project's groups will
1110 EXTERNAL_GROUPS = YES
1112 # The PERL_PATH should be the absolute path and name of the perl script
1113 # interpreter (i.e. the result of `which perl').
1115 PERL_PATH = /usr/bin/perl
1117 #---------------------------------------------------------------------------
1118 # Configuration options related to the dot tool
1119 #---------------------------------------------------------------------------
1121 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1122 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1123 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1124 # this option is superseded by the HAVE_DOT option below. This is only a
1125 # fallback. It is recommended to install and use dot, since it yields more
1128 CLASS_DIAGRAMS = YES
1130 # You can define message sequence charts within doxygen comments using the \msc
1131 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1132 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1133 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1134 # be found in the default search path.
1138 # If set to YES, the inheritance and collaboration graphs will hide
1139 # inheritance and usage relations if the target is undocumented
1140 # or is not a class.
1142 HIDE_UNDOC_RELATIONS = YES
1144 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1145 # available from the path. This tool is part of Graphviz, a graph visualization
1146 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1147 # have no effect if this option is set to NO (the default)
1149 HAVE_DOT = @HAVE_DOT@
1151 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1152 # will generate a graph for each documented class showing the direct and
1153 # indirect inheritance relations. Setting this tag to YES will force the
1154 # the CLASS_DIAGRAMS tag to NO.
1158 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1159 # will generate a graph for each documented class showing the direct and
1160 # indirect implementation dependencies (inheritance, containment, and
1161 # class references variables) of the class with other documented classes.
1163 COLLABORATION_GRAPH = YES
1165 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1166 # will generate a graph for groups, showing the direct groups dependencies
1170 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1171 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1176 # If set to YES, the inheritance and collaboration graphs will show the
1177 # relations between templates and their instances.
1179 TEMPLATE_RELATIONS = YES
1181 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1182 # tags are set to YES then doxygen will generate a graph for each documented
1183 # file showing the direct and indirect include dependencies of the file with
1184 # other documented files.
1188 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1189 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1190 # documented header file showing the documented files that directly or
1191 # indirectly include this file.
1193 INCLUDED_BY_GRAPH = YES
1195 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1196 # generate a call dependency graph for every global function or class method.
1197 # Note that enabling this option will significantly increase the time of a run.
1198 # So in most cases it will be better to enable call graphs for selected
1199 # functions only using the \callgraph command.
1203 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1204 # generate a caller dependency graph for every global function or class method.
1205 # Note that enabling this option will significantly increase the time of a run.
1206 # So in most cases it will be better to enable caller graphs for selected
1207 # functions only using the \callergraph command.
1211 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1212 # will graphical hierarchy of all classes instead of a textual one.
1214 GRAPHICAL_HIERARCHY = YES
1216 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1217 # then doxygen will show the dependencies a directory has on other directories
1218 # in a graphical way. The dependency relations are determined by the #include
1219 # relations between the files in the directories.
1221 DIRECTORY_GRAPH = YES
1223 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1224 # generated by dot. Possible values are png, jpg, or gif
1225 # If left blank png will be used.
1227 DOT_IMAGE_FORMAT = png
1229 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1230 # found. If left blank, it is assumed the dot tool can be found in the path.
1234 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1235 # contain dot files that are included in the documentation (see the
1236 # \dotfile command).
1240 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1241 # nodes that will be shown in the graph. If the number of nodes in a graph
1242 # becomes larger than this value, doxygen will truncate the graph, which is
1243 # visualized by representing a node as a red box. Note that doxygen will always
1244 # show the root nodes and its direct children regardless of this setting.
1246 DOT_GRAPH_MAX_NODES = 50
1248 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1249 # background. This is disabled by default, which results in a white background.
1250 # Warning: Depending on the platform used, enabling this option may lead to
1251 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1254 DOT_TRANSPARENT = NO
1256 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1257 # files in one run (i.e. multiple -o and -T options on the command line). This
1258 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1259 # support this, this feature is disabled by default.
1261 DOT_MULTI_TARGETS = NO
1263 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1264 # generate a legend page explaining the meaning of the various boxes and
1265 # arrows in the dot generated graphs.
1267 GENERATE_LEGEND = YES
1269 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1270 # remove the intermediate dot files that are used to generate
1271 # the various graphs.
1275 #---------------------------------------------------------------------------
1276 # Configuration::additions related to the search engine
1277 #---------------------------------------------------------------------------
1279 # The SEARCHENGINE tag specifies whether or not a search engine should be
1280 # used. If set to NO the values of all tags below this one will be ignored.