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 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 # by quotes) that should identify the project.
20 PROJECT_NAME = @PACKAGE@
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
23 # This could be handy for archiving the generated documentation or
24 # if some version control system is used.
26 PROJECT_NUMBER = @VERSION@
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29 # base path where the generated documentation will be put.
30 # If a relative path is entered, it will be relative to the location
31 # where doxygen was started. If left blank the current directory will be used.
33 OUTPUT_DIRECTORY = doc
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36 # 4096 sub-directories (in 2 levels) under the output directory of each output
37 # format and will distribute the generated files over these directories.
38 # Enabling this option can be useful when feeding doxygen a huge amount of
39 # source files, where putting all generated files in the same directory would
40 # otherwise cause performance problems for the file system.
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
45 # documentation generated by doxygen is written. Doxygen will use this
46 # information to generate all constant output in the proper language.
47 # The default language is English, other supported languages are:
48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
52 # Swedish, and Ukrainian.
54 OUTPUT_LANGUAGE = English
56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57 # include brief member descriptions after the members that are listed in
58 # the file and class documentation (similar to JavaDoc).
59 # Set to NO to disable this.
61 BRIEF_MEMBER_DESC = YES
63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64 # the brief description of a member or function before the detailed description.
65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66 # brief descriptions will be completely suppressed.
70 # This tag implements a quasi-intelligent brief description abbreviator
71 # that is used to form the text in various listings. Each string
72 # in this list, if found as the leading text of the brief description, will be
73 # stripped from the text and the result after processing the whole list, is
74 # used as the annotated text. Otherwise, the brief description is used as-is.
75 # If left blank, the following values are used ("$name" is automatically
76 # replaced with the name of the entity): "The $name class" "The $name widget"
77 # "The $name file" "is" "provides" "specifies" "contains"
78 # "represents" "a" "an" "the"
82 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
83 # Doxygen will generate a detailed section even if there is only a brief
86 ALWAYS_DETAILED_SEC = NO
88 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
89 # inherited members of a class in the documentation of that class as if those
90 # members were ordinary class members. Constructors, destructors and assignment
91 # operators of the base classes will not be shown.
93 INLINE_INHERITED_MEMB = NO
95 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
96 # path before files name in the file list and in the header files. If set
97 # to NO the shortest path that makes the file name unique will be used.
101 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
102 # can be used to strip a user-defined part of the path. Stripping is
103 # only done if one of the specified strings matches the left-hand part of
104 # the path. The tag can be used to show relative paths in the file list.
105 # If left blank the directory from which doxygen is run is used as the
110 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
111 # the path mentioned in the documentation of a class, which tells
112 # the reader which header file to include in order to use a class.
113 # If left blank only the name of the header file containing the class
114 # definition is used. Otherwise one should specify the include paths that
115 # are normally passed to the compiler using the -I flag.
117 STRIP_FROM_INC_PATH =
119 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
120 # (but less readable) file names. This can be useful is your file systems
121 # doesn't support long names like on DOS, Mac, or CD-ROM.
125 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
126 # will interpret the first line (until the first dot) of a JavaDoc-style
127 # comment as the brief description. If set to NO, the JavaDoc
128 # comments will behave just like the Qt-style comments (thus requiring an
129 # explicit @brief command for a brief description.
131 JAVADOC_AUTOBRIEF = NO
133 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
134 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
135 # comments) as a brief description. This used to be the default behaviour.
136 # The new default is to treat a multi-line C++ comment block as a detailed
137 # description. Set this tag to YES if you prefer the old behaviour instead.
139 MULTILINE_CPP_IS_BRIEF = NO
141 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
142 # will output the detailed description near the top, like JavaDoc.
143 # If set to NO, the detailed description appears after the member
148 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
149 # member inherits the documentation from any documented member that it
154 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
155 # a new page for each member. If set to NO, the documentation of a member will
156 # be part of the file/class/namespace that contains it.
158 SEPARATE_MEMBER_PAGES = NO
160 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
161 # Doxygen uses this value to replace tabs by spaces in code fragments.
165 # This tag can be used to specify a number of aliases that acts
166 # as commands in the documentation. An alias has the form "name=value".
167 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
168 # put the command \sideeffect (or @sideeffect) in the documentation, which
169 # will result in a user-defined paragraph with heading "Side Effects:".
170 # You can put \n's in the value part of an alias to insert newlines.
172 ALIASES = "legal=\if legal" \
174 "writeme=\todo This needs to be documented further." \
175 "stub=\todo This is a non-functional stub." \
176 "optimize=\todo This needs to be optimized further."
178 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
179 # sources only. Doxygen will then generate output that is more tailored for C.
180 # For instance, some of the names that are used will be different. The list
181 # of all members will be omitted, etc.
183 OPTIMIZE_OUTPUT_FOR_C = NO
185 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
186 # sources only. Doxygen will then generate output that is more tailored for Java.
187 # For instance, namespaces will be presented as packages, qualified scopes
188 # will look different, etc.
190 OPTIMIZE_OUTPUT_JAVA = NO
192 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
193 # include (a tag file for) the STL sources as input, then you should
194 # set this tag to YES in order to let doxygen match functions declarations and
195 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
196 # func(std::string) {}). This also make the inheritance and collaboration
197 # diagrams that involve STL classes more complete and accurate.
199 BUILTIN_STL_SUPPORT = NO
201 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
202 # tag is set to YES, then doxygen will reuse the documentation of the first
203 # member in the group (if any) for the other members of the group. By default
204 # all members of a group must be documented explicitly.
206 DISTRIBUTE_GROUP_DOC = YES
208 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
209 # the same type (for instance a group of public functions) to be put as a
210 # subgroup of that type (e.g. under the Public Functions section). Set it to
211 # NO to prevent subgrouping. Alternatively, this can be done per class using
212 # the \nosubgrouping command.
216 #---------------------------------------------------------------------------
217 # Build related configuration options
218 #---------------------------------------------------------------------------
220 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
221 # documentation are documented, even if no documentation was available.
222 # Private class members and static file members will be hidden unless
223 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
227 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
228 # will be included in the documentation.
232 # If the EXTRACT_STATIC tag is set to YES all static members of a file
233 # will be included in the documentation.
237 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
238 # defined locally in source files will be included in the documentation.
239 # If set to NO only classes defined in header files are included.
241 EXTRACT_LOCAL_CLASSES = NO
243 # This flag is only useful for Objective-C code. When set to YES local
244 # methods, which are defined in the implementation section but not in
245 # the interface are included in the documentation.
246 # If set to NO (the default) only methods in the interface are included.
248 EXTRACT_LOCAL_METHODS = NO
250 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
251 # undocumented members of documented classes, files or namespaces.
252 # If set to NO (the default) these members will be included in the
253 # various overviews, but no documentation section is generated.
254 # This option has no effect if EXTRACT_ALL is enabled.
256 HIDE_UNDOC_MEMBERS = NO
258 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
259 # undocumented classes that are normally visible in the class hierarchy.
260 # If set to NO (the default) these classes will be included in the various
261 # overviews. This option has no effect if EXTRACT_ALL is enabled.
263 HIDE_UNDOC_CLASSES = NO
265 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
266 # friend (class|struct|union) declarations.
267 # If set to NO (the default) these declarations will be included in the
270 HIDE_FRIEND_COMPOUNDS = NO
272 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
273 # documentation blocks found inside the body of a function.
274 # If set to NO (the default) these blocks will be appended to the
275 # function's detailed documentation block.
277 HIDE_IN_BODY_DOCS = NO
279 # The INTERNAL_DOCS tag determines if documentation
280 # that is typed after a \internal command is included. If the tag is set
281 # to NO (the default) then the documentation will be excluded.
282 # Set it to YES to include the internal documentation.
286 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
287 # file names in lower-case letters. If set to YES upper-case letters are also
288 # allowed. This is useful if you have classes or files whose names only differ
289 # in case and if your file system supports case sensitive file names. Windows
290 # and Mac users are advised to set this option to NO.
292 CASE_SENSE_NAMES = YES
294 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
295 # will show members with their full class and namespace scopes in the
296 # documentation. If set to YES the scope will be hidden.
298 HIDE_SCOPE_NAMES = NO
300 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
301 # will put a list of the files that are included by a file in the documentation
304 SHOW_INCLUDE_FILES = YES
306 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
307 # is inserted in the documentation for inline members.
311 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
312 # will sort the (detailed) documentation of file and class members
313 # alphabetically by member name. If set to NO the members will appear in
316 SORT_MEMBER_DOCS = NO
318 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
319 # brief documentation of file, namespace and class members alphabetically
320 # by member name. If set to NO (the default) the members will appear in
325 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
326 # sorted by fully-qualified names, including namespaces. If set to
327 # NO (the default), the class list will be sorted only by class name,
328 # not including the namespace part.
329 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
330 # Note: This option applies only to the class list, not to the
333 SORT_BY_SCOPE_NAME = NO
335 # The GENERATE_TODOLIST tag can be used to enable (YES) or
336 # disable (NO) the todo list. This list is created by putting \todo
337 # commands in the documentation.
339 GENERATE_TODOLIST = YES
341 # The GENERATE_TESTLIST tag can be used to enable (YES) or
342 # disable (NO) the test list. This list is created by putting \test
343 # commands in the documentation.
345 GENERATE_TESTLIST = YES
347 # The GENERATE_BUGLIST tag can be used to enable (YES) or
348 # disable (NO) the bug list. This list is created by putting \bug
349 # commands in the documentation.
351 GENERATE_BUGLIST = YES
353 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
354 # disable (NO) the deprecated list. This list is created by putting
355 # \deprecated commands in the documentation.
357 GENERATE_DEPRECATEDLIST= YES
359 # The ENABLED_SECTIONS tag can be used to enable conditional
360 # documentation sections, marked by \if sectionname ... \endif.
364 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
365 # the initial value of a variable or define consists of for it to appear in
366 # the documentation. If the initializer consists of more lines than specified
367 # here it will be hidden. Use a value of 0 to hide initializers completely.
368 # The appearance of the initializer of individual variables and defines in the
369 # documentation can be controlled using \showinitializer or \hideinitializer
370 # command in the documentation regardless of this setting.
372 MAX_INITIALIZER_LINES = 30
374 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
375 # at the bottom of the documentation of classes and structs. If set to YES the
376 # list will mention the files that were used to generate the documentation.
378 SHOW_USED_FILES = YES
380 # If the sources in your project are distributed over multiple directories
381 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
382 # in the documentation. The default is NO.
384 SHOW_DIRECTORIES = NO
386 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
387 # doxygen should invoke to get the current version for each file (typically from the
388 # version control system). Doxygen will invoke the program by executing (via
389 # popen()) the command <command> <input-file>, where <command> is the value of
390 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
391 # provided by doxygen. Whatever the program writes to standard output
392 # is used as the file version. See the manual for examples.
394 FILE_VERSION_FILTER =
396 #---------------------------------------------------------------------------
397 # configuration options related to warning and progress messages
398 #---------------------------------------------------------------------------
400 # The QUIET tag can be used to turn on/off the messages that are generated
401 # by doxygen. Possible values are YES and NO. If left blank NO is used.
405 # The WARNINGS tag can be used to turn on/off the warning messages that are
406 # generated by doxygen. Possible values are YES and NO. If left blank
411 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
412 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
413 # automatically be disabled.
415 WARN_IF_UNDOCUMENTED = YES
417 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
418 # potential errors in the documentation, such as not documenting some
419 # parameters in a documented function, or documenting parameters that
420 # don't exist or using markup commands wrongly.
422 WARN_IF_DOC_ERROR = YES
424 # This WARN_NO_PARAMDOC option can be abled to get warnings for
425 # functions that are documented, but have no documentation for their parameters
426 # or return value. If set to NO (the default) doxygen will only warn about
427 # wrong or incomplete parameter documentation, but not about the absence of
430 WARN_NO_PARAMDOC = NO
432 # The WARN_FORMAT tag determines the format of the warning messages that
433 # doxygen can produce. The string should contain the $file, $line, and $text
434 # tags, which will be replaced by the file and line number from which the
435 # warning originated and the warning text. Optionally the format may contain
436 # $version, which will be replaced by the version of the file (if it could
437 # be obtained via FILE_VERSION_FILTER)
439 WARN_FORMAT = "$file:$line: $text"
441 # The WARN_LOGFILE tag can be used to specify a file to which warning
442 # and error messages should be written. If left blank the output is written
447 #---------------------------------------------------------------------------
448 # configuration options related to the input files
449 #---------------------------------------------------------------------------
451 # The INPUT tag can be used to specify the files and/or directories that contain
452 # documented source files. You may enter file names like "myfile.cpp" or
453 # directories like "/usr/src/myproject". Separate the files or directories
458 # If the value of the INPUT tag contains directories, you can use the
459 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
460 # and *.h) to filter out the source-files in the directories. If left
461 # blank the following patterns are tested:
462 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
463 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
465 FILE_PATTERNS = *.h \
471 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
472 # should be searched for input files as well. Possible values are YES and NO.
473 # If left blank NO is used.
477 # The EXCLUDE tag can be used to specify files and/or directories that should
478 # excluded from the INPUT source files. This way you can easily exclude a
479 # subdirectory from a directory tree whose root is specified with the INPUT tag.
481 EXCLUDE = src/template.cpp src/template.h
483 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
484 # directories that are symbolic links (a Unix filesystem feature) are excluded
487 EXCLUDE_SYMLINKS = NO
489 # If the value of the INPUT tag contains directories, you can use the
490 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
491 # certain files from those directories. Note that the wildcards are matched
492 # against the file with absolute path, so to exclude all test directories
493 # for example use the pattern */test/*
497 # The EXAMPLE_PATH tag can be used to specify one or more files or
498 # directories that contain example code fragments that are included (see
499 # the \include command).
503 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
504 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
505 # and *.h) to filter out the source-files in the directories. If left
506 # blank all files are included.
510 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
511 # searched for input files to be used with the \include or \dontinclude
512 # commands irrespective of the value of the RECURSIVE tag.
513 # Possible values are YES and NO. If left blank NO is used.
515 EXAMPLE_RECURSIVE = NO
517 # The IMAGE_PATH tag can be used to specify one or more files or
518 # directories that contain image that are included in the documentation (see
519 # the \image command).
523 # The INPUT_FILTER tag can be used to specify a program that doxygen should
524 # invoke to filter for each input file. Doxygen will invoke the filter program
525 # by executing (via popen()) the command <filter> <input-file>, where <filter>
526 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
527 # input file. Doxygen will then use the output that the filter program writes
528 # to standard output. If FILTER_PATTERNS is specified, this tag will be
533 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
534 # basis. Doxygen will compare the file name with each pattern and apply the
535 # filter if there is a match. The filters are a list of the form:
536 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
537 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
538 # is applied to all files.
542 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
543 # INPUT_FILTER) will be used to filter the input files when producing source
544 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
546 FILTER_SOURCE_FILES = NO
548 #---------------------------------------------------------------------------
549 # configuration options related to source browsing
550 #---------------------------------------------------------------------------
552 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
553 # be generated. Documented entities will be cross-referenced with these sources.
554 # Note: To get rid of all source code in the generated output, make sure also
555 # VERBATIM_HEADERS is set to NO.
559 # Setting the INLINE_SOURCES tag to YES will include the body
560 # of functions and classes directly in the documentation.
564 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
565 # doxygen to hide any special comment blocks from generated source code
566 # fragments. Normal C and C++ comments will always remain visible.
568 STRIP_CODE_COMMENTS = YES
570 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
571 # then for each documented function all documented
572 # functions referencing it will be listed.
574 REFERENCED_BY_RELATION = YES
576 # If the REFERENCES_RELATION tag is set to YES (the default)
577 # then for each documented function all documented entities
578 # called/used by that function will be listed.
580 REFERENCES_RELATION = YES
582 # If the USE_HTAGS tag is set to YES then the references to source code
583 # will point to the HTML generated by the htags(1) tool instead of doxygen
584 # built-in source browser. The htags tool is part of GNU's global source
585 # tagging system (see http://www.gnu.org/software/global/global.html). You
586 # will need version 4.8.6 or higher.
590 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
591 # will generate a verbatim copy of the header file for each class for
592 # which an include is specified. Set to NO to disable this.
594 VERBATIM_HEADERS = YES
596 #---------------------------------------------------------------------------
597 # configuration options related to the alphabetical class index
598 #---------------------------------------------------------------------------
600 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
601 # of all compounds will be generated. Enable this if the project
602 # contains a lot of classes, structs, unions or interfaces.
604 ALPHABETICAL_INDEX = YES
606 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
607 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
608 # in which this list will be split (can be a number in the range [1..20])
610 COLS_IN_ALPHA_INDEX = 5
612 # In case all classes in a project start with a common prefix, all
613 # classes will be put under the same header in the alphabetical index.
614 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
615 # should be ignored while generating the index headers.
619 #---------------------------------------------------------------------------
620 # configuration options related to the HTML output
621 #---------------------------------------------------------------------------
623 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
624 # generate HTML output.
628 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
629 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
630 # put in front of it. If left blank `html' will be used as the default path.
634 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
635 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
636 # doxygen will generate files with .html extension.
638 HTML_FILE_EXTENSION = .html
640 # The HTML_HEADER tag can be used to specify a personal HTML header for
641 # each generated HTML page. If it is left blank doxygen will generate a
646 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
647 # each generated HTML page. If it is left blank doxygen will generate a
652 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
653 # style sheet that is used by each HTML page. It can be used to
654 # fine-tune the look of the HTML output. If the tag is left blank doxygen
655 # will generate a default style sheet. Note that doxygen will try to copy
656 # the style sheet file to the HTML output directory, so don't put your own
657 # stylesheet in the HTML output directory as well, or it will be erased!
661 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
662 # files or namespaces will be aligned in HTML using tables. If set to
663 # NO a bullet list will be used.
665 HTML_ALIGN_MEMBERS = YES
667 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
668 # will be generated that can be used as input for tools like the
669 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
670 # of the generated HTML documentation.
672 GENERATE_HTMLHELP = NO
674 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
675 # be used to specify the file name of the resulting .chm file. You
676 # can add a path in front of the file if the result should not be
677 # written to the html output directory.
681 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
682 # be used to specify the location (absolute path including file name) of
683 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
684 # the HTML help compiler on the generated index.hhp.
688 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
689 # controls if a separate .chi index file is generated (YES) or that
690 # it should be included in the master .chm file (NO).
694 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
695 # controls whether a binary table of contents is generated (YES) or a
696 # normal table of contents (NO) in the .chm file.
700 # The TOC_EXPAND flag can be set to YES to add extra items for group members
701 # to the contents of the HTML help documentation and to the tree view.
705 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
706 # top of each HTML page. The value NO (the default) enables the index and
707 # the value YES disables it.
711 # This tag can be used to set the number of enum values (range [1..20])
712 # that doxygen will group on one line in the generated HTML documentation.
714 ENUM_VALUES_PER_LINE = 4
716 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
717 # generated containing a tree-like index structure (just like the one that
718 # is generated for HTML Help). For this to work a browser that supports
719 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
720 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
721 # probably better off using the HTML help feature.
723 GENERATE_TREEVIEW = NO
725 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
726 # used to set the initial width (in pixels) of the frame in which the tree
731 #---------------------------------------------------------------------------
732 # configuration options related to the LaTeX output
733 #---------------------------------------------------------------------------
735 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
736 # generate Latex output.
740 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
741 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
742 # put in front of it. If left blank `latex' will be used as the default path.
746 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
747 # invoked. If left blank `latex' will be used as the default command name.
749 LATEX_CMD_NAME = latex
751 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
752 # generate index for LaTeX. If left blank `makeindex' will be used as the
753 # default command name.
755 MAKEINDEX_CMD_NAME = makeindex
757 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
758 # LaTeX documents. This may be useful for small projects and may help to
759 # save some trees in general.
763 # The PAPER_TYPE tag can be used to set the paper type that is used
764 # by the printer. Possible values are: a4, a4wide, letter, legal and
765 # executive. If left blank a4wide will be used.
769 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
770 # packages that should be included in the LaTeX output.
774 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
775 # the generated latex document. The header should contain everything until
776 # the first chapter. If it is left blank doxygen will generate a
777 # standard header. Notice: only use this tag if you know what you are doing!
781 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
782 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
783 # contain links (just like the HTML output) instead of page references
784 # This makes the output suitable for online browsing using a pdf viewer.
788 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
789 # plain latex in the generated Makefile. Set this option to YES to get a
790 # higher quality PDF documentation.
794 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
795 # command to the generated LaTeX files. This will instruct LaTeX to keep
796 # running if errors occur, instead of asking the user for help.
797 # This option is also used when generating formulas in HTML.
801 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
802 # include the index chapters (such as File Index, Compound Index, etc.)
805 LATEX_HIDE_INDICES = NO
807 #---------------------------------------------------------------------------
808 # configuration options related to the RTF output
809 #---------------------------------------------------------------------------
811 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
812 # The RTF output is optimized for Word 97 and may not look very pretty with
813 # other RTF readers or editors.
817 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
818 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
819 # put in front of it. If left blank `rtf' will be used as the default path.
823 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
824 # RTF documents. This may be useful for small projects and may help to
825 # save some trees in general.
829 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
830 # will contain hyperlink fields. The RTF file will
831 # contain links (just like the HTML output) instead of page references.
832 # This makes the output suitable for online browsing using WORD or other
833 # programs which support those fields.
834 # Note: wordpad (write) and others do not support links.
838 # Load stylesheet definitions from file. Syntax is similar to doxygen's
839 # config file, i.e. a series of assignments. You only have to provide
840 # replacements, missing definitions are set to their default value.
842 RTF_STYLESHEET_FILE =
844 # Set optional variables used in the generation of an rtf document.
845 # Syntax is similar to doxygen's config file.
847 RTF_EXTENSIONS_FILE =
849 #---------------------------------------------------------------------------
850 # configuration options related to the man page output
851 #---------------------------------------------------------------------------
853 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
858 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
859 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
860 # put in front of it. If left blank `man' will be used as the default path.
864 # The MAN_EXTENSION tag determines the extension that is added to
865 # the generated man pages (default is the subroutine's section .3)
869 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
870 # then it will generate one additional man file for each entity
871 # documented in the real man page(s). These additional files
872 # only source the real man page, but without them the man command
873 # would be unable to find the correct page. The default is NO.
877 #---------------------------------------------------------------------------
878 # configuration options related to the XML output
879 #---------------------------------------------------------------------------
881 # If the GENERATE_XML tag is set to YES Doxygen will
882 # generate an XML file that captures the structure of
883 # the code including all documentation.
887 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
888 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
889 # put in front of it. If left blank `xml' will be used as the default path.
893 # The XML_SCHEMA tag can be used to specify an XML schema,
894 # which can be used by a validating XML parser to check the
895 # syntax of the XML files.
899 # The XML_DTD tag can be used to specify an XML DTD,
900 # which can be used by a validating XML parser to check the
901 # syntax of the XML files.
905 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
906 # dump the program listings (including syntax highlighting
907 # and cross-referencing information) to the XML output. Note that
908 # enabling this will significantly increase the size of the XML output.
910 XML_PROGRAMLISTING = YES
912 #---------------------------------------------------------------------------
913 # configuration options for the AutoGen Definitions output
914 #---------------------------------------------------------------------------
916 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
917 # generate an AutoGen Definitions (see autogen.sf.net) file
918 # that captures the structure of the code including all
919 # documentation. Note that this feature is still experimental
920 # and incomplete at the moment.
922 GENERATE_AUTOGEN_DEF = NO
924 #---------------------------------------------------------------------------
925 # configuration options related to the Perl module output
926 #---------------------------------------------------------------------------
928 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
929 # generate a Perl module file that captures the structure of
930 # the code including all documentation. Note that this
931 # feature is still experimental and incomplete at the
934 GENERATE_PERLMOD = NO
936 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
937 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
938 # to generate PDF and DVI output from the Perl module output.
942 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
943 # nicely formatted so it can be parsed by a human reader. This is useful
944 # if you want to understand what is going on. On the other hand, if this
945 # tag is set to NO the size of the Perl module output will be much smaller
946 # and Perl will parse it just the same.
950 # The names of the make variables in the generated doxyrules.make file
951 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
952 # This is useful so different doxyrules.make files included by the same
953 # Makefile don't overwrite each other's variables.
955 PERLMOD_MAKEVAR_PREFIX =
957 #---------------------------------------------------------------------------
958 # Configuration options related to the preprocessor
959 #---------------------------------------------------------------------------
961 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
962 # evaluate all C-preprocessor directives found in the sources and include
965 ENABLE_PREPROCESSING = YES
967 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
968 # names in the source code. If set to NO (the default) only conditional
969 # compilation will be performed. Macro expansion can be done in a controlled
970 # way by setting EXPAND_ONLY_PREDEF to YES.
974 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
975 # then the macro expansion is limited to the macros specified with the
976 # PREDEFINED and EXPAND_AS_DEFINED tags.
978 EXPAND_ONLY_PREDEF = NO
980 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
981 # in the INCLUDE_PATH (see below) will be search if a #include is found.
983 SEARCH_INCLUDES = YES
985 # The INCLUDE_PATH tag can be used to specify one or more directories that
986 # contain include files that are not input files but should be processed by
991 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
992 # patterns (like *.h and *.hpp) to filter out the header-files in the
993 # directories. If left blank, the patterns specified with FILE_PATTERNS will
996 INCLUDE_FILE_PATTERNS =
998 # The PREDEFINED tag can be used to specify one or more macro names that
999 # are defined before the preprocessor is started (similar to the -D option of
1000 # gcc). The argument of the tag is a list of macros of the form: name
1001 # or name=definition (no spaces). If the definition and the = are
1002 # omitted =1 is assumed. To prevent a macro definition from being
1003 # undefined via #undef or recursively expanded use the := operator
1004 # instead of the = operator.
1006 PREDEFINED = SYNFIG_NO_DEPRECATED \
1009 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1010 # this tag can be used to specify a list of macro names that should be expanded.
1011 # The macro definition that is found in the sources will be used.
1012 # Use the PREDEFINED tag if you want to use a different macro definition.
1016 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1017 # doxygen's preprocessor will remove all function-like macros that are alone
1018 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1019 # function macros are typically used for boiler-plate code, and will confuse
1020 # the parser if not removed.
1022 SKIP_FUNCTION_MACROS = YES
1024 #---------------------------------------------------------------------------
1025 # Configuration::additions related to external references
1026 #---------------------------------------------------------------------------
1028 # The TAGFILES option can be used to specify one or more tagfiles.
1029 # Optionally an initial location of the external documentation
1030 # can be added for each tagfile. The format of a tag file without
1031 # this location is as follows:
1032 # TAGFILES = file1 file2 ...
1033 # Adding location for the tag files is done as follows:
1034 # TAGFILES = file1=loc1 "file2 = loc2" ...
1035 # where "loc1" and "loc2" can be relative or absolute paths or
1036 # URLs. If a location is present for each tag, the installdox tool
1037 # does not have to be run to correct the links.
1038 # Note that each tag file must have a unique name
1039 # (where the name does NOT include the path)
1040 # If a tag file is not located in the directory in which doxygen
1041 # is run, you must also specify the path to the tagfile here.
1045 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1046 # a tag file that is based on the input files it reads.
1050 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1051 # in the class index. If set to NO only the inherited external classes
1056 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1057 # in the modules index. If set to NO, only the current project's groups will
1060 EXTERNAL_GROUPS = YES
1062 # The PERL_PATH should be the absolute path and name of the perl script
1063 # interpreter (i.e. the result of `which perl').
1065 PERL_PATH = /usr/bin/perl
1067 #---------------------------------------------------------------------------
1068 # Configuration options related to the dot tool
1069 #---------------------------------------------------------------------------
1071 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1072 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1073 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1074 # this option is superseded by the HAVE_DOT option below. This is only a
1075 # fallback. It is recommended to install and use dot, since it yields more
1078 CLASS_DIAGRAMS = YES
1080 # If set to YES, the inheritance and collaboration graphs will hide
1081 # inheritance and usage relations if the target is undocumented
1082 # or is not a class.
1084 HIDE_UNDOC_RELATIONS = YES
1086 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1087 # available from the path. This tool is part of Graphviz, a graph visualization
1088 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1089 # have no effect if this option is set to NO (the default)
1093 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1094 # will generate a graph for each documented class showing the direct and
1095 # indirect inheritance relations. Setting this tag to YES will force the
1096 # the CLASS_DIAGRAMS tag to NO.
1100 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1101 # will generate a graph for each documented class showing the direct and
1102 # indirect implementation dependencies (inheritance, containment, and
1103 # class references variables) of the class with other documented classes.
1105 COLLABORATION_GRAPH = YES
1107 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1108 # will generate a graph for groups, showing the direct groups dependencies
1112 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1113 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1118 # If set to YES, the inheritance and collaboration graphs will show the
1119 # relations between templates and their instances.
1121 TEMPLATE_RELATIONS = YES
1123 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1124 # tags are set to YES then doxygen will generate a graph for each documented
1125 # file showing the direct and indirect include dependencies of the file with
1126 # other documented files.
1130 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1131 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1132 # documented header file showing the documented files that directly or
1133 # indirectly include this file.
1135 INCLUDED_BY_GRAPH = YES
1137 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1138 # generate a call dependency graph for every global function or class method.
1139 # Note that enabling this option will significantly increase the time of a run.
1140 # So in most cases it will be better to enable call graphs for selected
1141 # functions only using the \callgraph command.
1145 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1146 # will graphical hierarchy of all classes instead of a textual one.
1148 GRAPHICAL_HIERARCHY = YES
1150 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1151 # then doxygen will show the dependencies a directory has on other directories
1152 # in a graphical way. The dependency relations are determined by the #include
1153 # relations between the files in the directories.
1155 DIRECTORY_GRAPH = YES
1157 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1158 # generated by dot. Possible values are png, jpg, or gif
1159 # If left blank png will be used.
1161 DOT_IMAGE_FORMAT = gif
1163 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1164 # found. If left blank, it is assumed the dot tool can be found in the path.
1168 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1169 # contain dot files that are included in the documentation (see the
1170 # \dotfile command).
1174 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1175 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1176 # from the root by following a path via at most 3 edges will be shown. Nodes
1177 # that lay further from the root node will be omitted. Note that setting this
1178 # option to 1 or 2 may greatly reduce the computation time needed for large
1179 # code bases. Also note that a graph may be further truncated if the graph's
1180 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1181 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1182 # the graph is not depth-constrained.
1184 MAX_DOT_GRAPH_DEPTH = 0
1186 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1187 # background. This is disabled by default, which results in a white background.
1188 # Warning: Depending on the platform used, enabling this option may lead to
1189 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1192 DOT_TRANSPARENT = NO
1194 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1195 # files in one run (i.e. multiple -o and -T options on the command line). This
1196 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1197 # support this, this feature is disabled by default.
1199 DOT_MULTI_TARGETS = NO
1201 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1202 # generate a legend page explaining the meaning of the various boxes and
1203 # arrows in the dot generated graphs.
1205 GENERATE_LEGEND = YES
1207 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1208 # remove the intermediate dot files that are used to generate
1209 # the various graphs.
1213 #---------------------------------------------------------------------------
1214 # Configuration::additions related to the search engine
1215 #---------------------------------------------------------------------------
1217 # The SEARCHENGINE tag specifies whether or not a search engine should be
1218 # used. If set to NO the values of all tags below this one will be ignored.