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 # General 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.
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.
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 = docs/doxygen
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
36 # documentation generated by doxygen is written. Doxygen will use this
37 # information to generate all constant output in the proper language.
38 # The default language is English, other supported languages are:
39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
44 OUTPUT_LANGUAGE = English
46 # This tag can be used to specify the encoding used in the generated output.
47 # The encoding is not always determined by the language that is chosen,
48 # but also whether or not the output is meant for Windows or non-Windows users.
49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
50 # forces the Windows encoding (this is the default for the Windows binary),
51 # whereas setting the tag to NO uses a Unix-style encoding (the default for
52 # all platforms other than Windows).
54 USE_WINDOWS_ENCODING = NO
56 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
57 # documentation are documented, even if no documentation was available.
58 # Private class members and static file members will be hidden unless
59 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
63 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
64 # will be included in the documentation.
68 # If the EXTRACT_STATIC tag is set to YES all static members of a file
69 # will be included in the documentation.
73 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
74 # defined locally in source files will be included in the documentation.
75 # If set to NO only classes defined in header files are included.
77 EXTRACT_LOCAL_CLASSES = YES
79 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
80 # undocumented members of documented classes, files or namespaces.
81 # If set to NO (the default) these members will be included in the
82 # various overviews, but no documentation section is generated.
83 # This option has no effect if EXTRACT_ALL is enabled.
85 HIDE_UNDOC_MEMBERS = NO
87 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
88 # undocumented classes that are normally visible in the class hierarchy.
89 # If set to NO (the default) these classes will be included in the various
90 # overviews. This option has no effect if EXTRACT_ALL is enabled.
92 HIDE_UNDOC_CLASSES = YES
94 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
95 # friend (class|struct|union) declarations.
96 # If set to NO (the default) these declarations will be included in the
99 HIDE_FRIEND_COMPOUNDS = NO
101 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
102 # documentation blocks found inside the body of a function.
103 # If set to NO (the default) these blocks will be appended to the
104 # function's detailed documentation block.
106 HIDE_IN_BODY_DOCS = NO
108 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
109 # include brief member descriptions after the members that are listed in
110 # the file and class documentation (similar to JavaDoc).
111 # Set to NO to disable this.
113 BRIEF_MEMBER_DESC = YES
115 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
116 # the brief description of a member or function before the detailed description.
117 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
118 # brief descriptions will be completely suppressed.
122 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
123 # Doxygen will generate a detailed section even if there is only a brief
126 ALWAYS_DETAILED_SEC = YES
128 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
129 # members of a class in the documentation of that class as if those members were
130 # ordinary class members. Constructors, destructors and assignment operators of
131 # the base classes will not be shown.
133 INLINE_INHERITED_MEMB = NO
135 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
136 # path before files name in the file list and in the header files. If set
137 # to NO the shortest path that makes the file name unique will be used.
139 FULL_PATH_NAMES = YES
141 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
142 # can be used to strip a user-defined part of the path. Stripping is
143 # only done if one of the specified strings matches the left-hand part of
144 # the path. It is allowed to use relative paths in the argument list.
148 # The INTERNAL_DOCS tag determines if documentation
149 # that is typed after a \internal command is included. If the tag is set
150 # to NO (the default) then the documentation will be excluded.
151 # Set it to YES to include the internal documentation.
155 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
156 # file names in lower-case letters. If set to YES upper-case letters are also
157 # allowed. This is useful if you have classes or files whose names only differ
158 # in case and if your file system supports case sensitive file names. Windows
159 # users are advised to set this option to NO.
161 CASE_SENSE_NAMES = YES
163 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
164 # (but less readable) file names. This can be useful is your file systems
165 # doesn't support long names like on DOS, Mac, or CD-ROM.
169 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
170 # will show members with their full class and namespace scopes in the
171 # documentation. If set to YES the scope will be hidden.
173 HIDE_SCOPE_NAMES = NO
175 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
176 # will put a list of the files that are included by a file in the documentation
179 SHOW_INCLUDE_FILES = YES
181 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
182 # will interpret the first line (until the first dot) of a JavaDoc-style
183 # comment as the brief description. If set to NO, the JavaDoc
184 # comments will behave just like the Qt-style comments (thus requiring an
185 # explict @brief command for a brief description.
187 JAVADOC_AUTOBRIEF = YES
189 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
190 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
191 # comments) as a brief description. This used to be the default behaviour.
192 # The new default is to treat a multi-line C++ comment block as a detailed
193 # description. Set this tag to YES if you prefer the old behaviour instead.
195 MULTILINE_CPP_IS_BRIEF = NO
197 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
198 # will output the detailed description near the top, like JavaDoc.
199 # If set to NO, the detailed description appears after the member
204 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
205 # member inherits the documentation from any documented member that it
210 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
211 # is inserted in the documentation for inline members.
215 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
216 # will sort the (detailed) documentation of file and class members
217 # alphabetically by member name. If set to NO the members will appear in
220 SORT_MEMBER_DOCS = YES
222 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
223 # tag is set to YES, then doxygen will reuse the documentation of the first
224 # member in the group (if any) for the other members of the group. By default
225 # all members of a group must be documented explicitly.
227 DISTRIBUTE_GROUP_DOC = NO
229 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
230 # Doxygen uses this value to replace tabs by spaces in code fragments.
234 # The GENERATE_TODOLIST tag can be used to enable (YES) or
235 # disable (NO) the todo list. This list is created by putting \todo
236 # commands in the documentation.
238 GENERATE_TODOLIST = YES
240 # The GENERATE_TESTLIST tag can be used to enable (YES) or
241 # disable (NO) the test list. This list is created by putting \test
242 # commands in the documentation.
244 GENERATE_TESTLIST = YES
246 # The GENERATE_BUGLIST tag can be used to enable (YES) or
247 # disable (NO) the bug list. This list is created by putting \bug
248 # commands in the documentation.
250 GENERATE_BUGLIST = YES
252 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
253 # disable (NO) the deprecated list. This list is created by putting
254 # \deprecated commands in the documentation.
256 GENERATE_DEPRECATEDLIST= YES
258 # This tag can be used to specify a number of aliases that acts
259 # as commands in the documentation. An alias has the form "name=value".
260 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
261 # put the command \sideeffect (or @sideeffect) in the documentation, which
262 # will result in a user-defined paragraph with heading "Side Effects:".
263 # You can put \n's in the value part of an alias to insert newlines.
267 # The ENABLED_SECTIONS tag can be used to enable conditional
268 # documentation sections, marked by \if sectionname ... \endif.
272 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
273 # the initial value of a variable or define consists of for it to appear in
274 # the documentation. If the initializer consists of more lines than specified
275 # here it will be hidden. Use a value of 0 to hide initializers completely.
276 # The appearance of the initializer of individual variables and defines in the
277 # documentation can be controlled using \showinitializer or \hideinitializer
278 # command in the documentation regardless of this setting.
280 MAX_INITIALIZER_LINES = 30
282 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
283 # only. Doxygen will then generate output that is more tailored for C.
284 # For instance, some of the names that are used will be different. The list
285 # of all members will be omitted, etc.
287 OPTIMIZE_OUTPUT_FOR_C = NO
289 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
290 # only. Doxygen will then generate output that is more tailored for Java.
291 # For instance, namespaces will be presented as packages, qualified scopes
292 # will look different, etc.
294 OPTIMIZE_OUTPUT_JAVA = NO
296 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
297 # at the bottom of the documentation of classes and structs. If set to YES the
298 # list will mention the files that were used to generate the documentation.
300 SHOW_USED_FILES = YES
302 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
303 # the same type (for instance a group of public functions) to be put as a
304 # subgroup of that type (e.g. under the Public Functions section). Set it to
305 # NO to prevent subgrouping. Alternatively, this can be done per class using
306 # the \nosubgrouping command.
310 #---------------------------------------------------------------------------
311 # configuration options related to warning and progress messages
312 #---------------------------------------------------------------------------
314 # The QUIET tag can be used to turn on/off the messages that are generated
315 # by doxygen. Possible values are YES and NO. If left blank NO is used.
319 # The WARNINGS tag can be used to turn on/off the warning messages that are
320 # generated by doxygen. Possible values are YES and NO. If left blank
325 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
326 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
327 # automatically be disabled.
329 WARN_IF_UNDOCUMENTED = YES
331 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
332 # potential errors in the documentation, such as not documenting some
333 # parameters in a documented function, or documenting parameters that
334 # don't exist or using markup commands wrongly.
336 WARN_IF_DOC_ERROR = YES
338 # The WARN_FORMAT tag determines the format of the warning messages that
339 # doxygen can produce. The string should contain the $file, $line, and $text
340 # tags, which will be replaced by the file and line number from which the
341 # warning originated and the warning text.
343 WARN_FORMAT = "$file:$line: $text"
345 # The WARN_LOGFILE tag can be used to specify a file to which warning
346 # and error messages should be written. If left blank the output is written
351 #---------------------------------------------------------------------------
352 # configuration options related to the input files
353 #---------------------------------------------------------------------------
355 # The INPUT tag can be used to specify the files and/or directories that contain
356 # documented source files. You may enter file names like "myfile.cpp" or
357 # directories like "/usr/src/myproject". Separate the files or directories
362 # If the value of the INPUT tag contains directories, you can use the
363 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
364 # and *.h) to filter out the source-files in the directories. If left
365 # blank the following patterns are tested:
366 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
367 # *.h++ *.idl *.odl *.cs
369 FILE_PATTERNS = *.c *.cc *.h *.hh *.doxygen
371 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
372 # should be searched for input files as well. Possible values are YES and NO.
373 # If left blank NO is used.
377 # The EXCLUDE tag can be used to specify files and/or directories that should
378 # excluded from the INPUT source files. This way you can easily exclude a
379 # subdirectory from a directory tree whose root is specified with the INPUT tag.
381 EXCLUDE = build configs setup PENDING RESYNC
383 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
384 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
386 EXCLUDE_SYMLINKS = YES
388 # If the value of the INPUT tag contains directories, you can use the
389 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
390 # certain files from those directories.
392 EXCLUDE_PATTERNS = */BitKeeper/* */Attic/* */SCCS/*
394 # The EXAMPLE_PATH tag can be used to specify one or more files or
395 # directories that contain example code fragments that are included (see
396 # the \include command).
400 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
401 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
402 # and *.h) to filter out the source-files in the directories. If left
403 # blank all files are included.
407 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
408 # searched for input files to be used with the \include or \dontinclude
409 # commands irrespective of the value of the RECURSIVE tag.
410 # Possible values are YES and NO. If left blank NO is used.
412 EXAMPLE_RECURSIVE = NO
414 # The IMAGE_PATH tag can be used to specify one or more files or
415 # directories that contain image that are included in the documentation (see
416 # the \image command).
420 # The INPUT_FILTER tag can be used to specify a program that doxygen should
421 # invoke to filter for each input file. Doxygen will invoke the filter program
422 # by executing (via popen()) the command <filter> <input-file>, where <filter>
423 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
424 # input file. Doxygen will then use the output that the filter program writes
425 # to standard output.
429 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
430 # INPUT_FILTER) will be used to filter the input files when producing source
431 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
433 FILTER_SOURCE_FILES = NO
435 #---------------------------------------------------------------------------
436 # configuration options related to source browsing
437 #---------------------------------------------------------------------------
439 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
440 # be generated. Documented entities will be cross-referenced with these sources.
444 # Setting the INLINE_SOURCES tag to YES will include the body
445 # of functions and classes directly in the documentation.
449 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
450 # doxygen to hide any special comment blocks from generated source code
451 # fragments. Normal C and C++ comments will always remain visible.
453 STRIP_CODE_COMMENTS = YES
455 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
456 # then for each documented function all documented
457 # functions referencing it will be listed.
459 REFERENCED_BY_RELATION = YES
461 # If the REFERENCES_RELATION tag is set to YES (the default)
462 # then for each documented function all documented entities
463 # called/used by that function will be listed.
465 REFERENCES_RELATION = YES
467 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
468 # will generate a verbatim copy of the header file for each class for
469 # which an include is specified. Set to NO to disable this.
471 VERBATIM_HEADERS = YES
473 #---------------------------------------------------------------------------
474 # configuration options related to the alphabetical class index
475 #---------------------------------------------------------------------------
477 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
478 # of all compounds will be generated. Enable this if the project
479 # contains a lot of classes, structs, unions or interfaces.
481 ALPHABETICAL_INDEX = YES
483 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
484 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
485 # in which this list will be split (can be a number in the range [1..20])
487 COLS_IN_ALPHA_INDEX = 3
489 # In case all classes in a project start with a common prefix, all
490 # classes will be put under the same header in the alphabetical index.
491 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
492 # should be ignored while generating the index headers.
496 #---------------------------------------------------------------------------
497 # configuration options related to the HTML output
498 #---------------------------------------------------------------------------
500 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
501 # generate HTML output.
505 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
506 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
507 # put in front of it. If left blank `html' will be used as the default path.
511 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
512 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
513 # doxygen will generate files with .html extension.
515 HTML_FILE_EXTENSION = .html
517 # The HTML_HEADER tag can be used to specify a personal HTML header for
518 # each generated HTML page. If it is left blank doxygen will generate a
523 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
524 # each generated HTML page. If it is left blank doxygen will generate a
527 HTML_FOOTER = docs/footer.html
529 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
530 # style sheet that is used by each HTML page. It can be used to
531 # fine-tune the look of the HTML output. If the tag is left blank doxygen
532 # will generate a default style sheet
536 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
537 # files or namespaces will be aligned in HTML using tables. If set to
538 # NO a bullet list will be used.
540 HTML_ALIGN_MEMBERS = YES
542 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
543 # will be generated that can be used as input for tools like the
544 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
545 # of the generated HTML documentation.
547 GENERATE_HTMLHELP = NO
549 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
550 # be used to specify the file name of the resulting .chm file. You
551 # can add a path in front of the file if the result should not be
552 # written to the html output dir.
556 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
557 # be used to specify the location (absolute path including file name) of
558 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
559 # the HTML help compiler on the generated index.hhp.
563 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
564 # controls if a separate .chi index file is generated (YES) or that
565 # it should be included in the master .chm file (NO).
569 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
570 # controls whether a binary table of contents is generated (YES) or a
571 # normal table of contents (NO) in the .chm file.
575 # The TOC_EXPAND flag can be set to YES to add extra items for group members
576 # to the contents of the HTML help documentation and to the tree view.
580 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
581 # top of each HTML page. The value NO (the default) enables the index and
582 # the value YES disables it.
586 # This tag can be used to set the number of enum values (range [1..20])
587 # that doxygen will group on one line in the generated HTML documentation.
589 ENUM_VALUES_PER_LINE = 4
591 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
592 # generated containing a tree-like index structure (just like the one that
593 # is generated for HTML Help). For this to work a browser that supports
594 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
595 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
596 # probably better off using the HTML help feature.
598 GENERATE_TREEVIEW = NO
600 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
601 # used to set the initial width (in pixels) of the frame in which the tree
606 #---------------------------------------------------------------------------
607 # configuration options related to the LaTeX output
608 #---------------------------------------------------------------------------
610 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
611 # generate Latex output.
615 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
616 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
617 # put in front of it. If left blank `latex' will be used as the default path.
621 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
622 # invoked. If left blank `latex' will be used as the default command name.
624 LATEX_CMD_NAME = latex
626 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
627 # generate index for LaTeX. If left blank `makeindex' will be used as the
628 # default command name.
630 MAKEINDEX_CMD_NAME = makeindex
632 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
633 # LaTeX documents. This may be useful for small projects and may help to
634 # save some trees in general.
638 # The PAPER_TYPE tag can be used to set the paper type that is used
639 # by the printer. Possible values are: a4, a4wide, letter, legal and
640 # executive. If left blank a4wide will be used.
644 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
645 # packages that should be included in the LaTeX output.
649 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
650 # the generated latex document. The header should contain everything until
651 # the first chapter. If it is left blank doxygen will generate a
652 # standard header. Notice: only use this tag if you know what you are doing!
656 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
657 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
658 # contain links (just like the HTML output) instead of page references
659 # This makes the output suitable for online browsing using a pdf viewer.
663 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
664 # plain latex in the generated Makefile. Set this option to YES to get a
665 # higher quality PDF documentation.
669 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
670 # command to the generated LaTeX files. This will instruct LaTeX to keep
671 # running if errors occur, instead of asking the user for help.
672 # This option is also used when generating formulas in HTML.
676 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
677 # include the index chapters (such as File Index, Compound Index, etc.)
680 LATEX_HIDE_INDICES = NO
682 #---------------------------------------------------------------------------
683 # configuration options related to the RTF output
684 #---------------------------------------------------------------------------
686 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
687 # The RTF output is optimised for Word 97 and may not look very pretty with
688 # other RTF readers or editors.
692 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
693 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
694 # put in front of it. If left blank `rtf' will be used as the default path.
698 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
699 # RTF documents. This may be useful for small projects and may help to
700 # save some trees in general.
704 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
705 # will contain hyperlink fields. The RTF file will
706 # contain links (just like the HTML output) instead of page references.
707 # This makes the output suitable for online browsing using WORD or other
708 # programs which support those fields.
709 # Note: wordpad (write) and others do not support links.
713 # Load stylesheet definitions from file. Syntax is similar to doxygen's
714 # config file, i.e. a series of assigments. You only have to provide
715 # replacements, missing definitions are set to their default value.
717 RTF_STYLESHEET_FILE =
719 # Set optional variables used in the generation of an rtf document.
720 # Syntax is similar to doxygen's config file.
722 RTF_EXTENSIONS_FILE =
724 #---------------------------------------------------------------------------
725 # configuration options related to the man page output
726 #---------------------------------------------------------------------------
728 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
733 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
734 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
735 # put in front of it. If left blank `man' will be used as the default path.
739 # The MAN_EXTENSION tag determines the extension that is added to
740 # the generated man pages (default is the subroutine's section .3)
744 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
745 # then it will generate one additional man file for each entity
746 # documented in the real man page(s). These additional files
747 # only source the real man page, but without them the man command
748 # would be unable to find the correct page. The default is NO.
752 #---------------------------------------------------------------------------
753 # configuration options related to the XML output
754 #---------------------------------------------------------------------------
756 # If the GENERATE_XML tag is set to YES Doxygen will
757 # generate an XML file that captures the structure of
758 # the code including all documentation. Note that this
759 # feature is still experimental and incomplete at the
764 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
765 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
766 # put in front of it. If left blank `xml' will be used as the default path.
770 # The XML_SCHEMA tag can be used to specify an XML schema,
771 # which can be used by a validating XML parser to check the
772 # syntax of the XML files.
776 # The XML_DTD tag can be used to specify an XML DTD,
777 # which can be used by a validating XML parser to check the
778 # syntax of the XML files.
782 #---------------------------------------------------------------------------
783 # configuration options for the AutoGen Definitions output
784 #---------------------------------------------------------------------------
786 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
787 # generate an AutoGen Definitions (see autogen.sf.net) file
788 # that captures the structure of the code including all
789 # documentation. Note that this feature is still experimental
790 # and incomplete at the moment.
792 GENERATE_AUTOGEN_DEF = NO
794 #---------------------------------------------------------------------------
795 # configuration options related to the Perl module output
796 #---------------------------------------------------------------------------
798 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
799 # generate a Perl module file that captures the structure of
800 # the code including all documentation. Note that this
801 # feature is still experimental and incomplete at the
804 GENERATE_PERLMOD = NO
806 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
807 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
808 # to generate PDF and DVI output from the Perl module output.
812 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
813 # nicely formatted so it can be parsed by a human reader. This is useful
814 # if you want to understand what is going on. On the other hand, if this
815 # tag is set to NO the size of the Perl module output will be much smaller
816 # and Perl will parse it just the same.
820 # The names of the make variables in the generated doxyrules.make file
821 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
822 # This is useful so different doxyrules.make files included by the same
823 # Makefile don't overwrite each other's variables.
825 PERLMOD_MAKEVAR_PREFIX =
827 #---------------------------------------------------------------------------
828 # Configuration options related to the preprocessor
829 #---------------------------------------------------------------------------
831 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
832 # evaluate all C-preprocessor directives found in the sources and include
835 ENABLE_PREPROCESSING = YES
837 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
838 # names in the source code. If set to NO (the default) only conditional
839 # compilation will be performed. Macro expansion can be done in a controlled
840 # way by setting EXPAND_ONLY_PREDEF to YES.
844 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
845 # then the macro expansion is limited to the macros specified with the
846 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
848 EXPAND_ONLY_PREDEF = NO
850 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
851 # in the INCLUDE_PATH (see below) will be search if a #include is found.
853 SEARCH_INCLUDES = YES
855 # The INCLUDE_PATH tag can be used to specify one or more directories that
856 # contain include files that are not input files but should be processed by
861 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
862 # patterns (like *.h and *.hpp) to filter out the header-files in the
863 # directories. If left blank, the patterns specified with FILE_PATTERNS will
866 INCLUDE_FILE_PATTERNS =
868 # The PREDEFINED tag can be used to specify one or more macro names that
869 # are defined before the preprocessor is started (similar to the -D option of
870 # gcc). The argument of the tag is a list of macros of the form: name
871 # or name=definition (no spaces). If the definition and the = are
872 # omitted =1 is assumed.
874 PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS
876 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
877 # this tag can be used to specify a list of macro names that should be expanded.
878 # The macro definition that is found in the sources will be used.
879 # Use the PREDEFINED tag if you want to use a different macro definition.
883 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
884 # doxygen's preprocessor will remove all function-like macros that are alone
885 # on a line, have an all uppercase name, and do not end with a semicolon. Such
886 # function macros are typically used for boiler-plate code, and will confuse the
887 # parser if not removed.
889 SKIP_FUNCTION_MACROS = YES
891 #---------------------------------------------------------------------------
892 # Configuration::addtions related to external references
893 #---------------------------------------------------------------------------
895 # The TAGFILES option can be used to specify one or more tagfiles.
896 # Optionally an initial location of the external documentation
897 # can be added for each tagfile. The format of a tag file without
898 # this location is as follows:
899 # TAGFILES = file1 file2 ...
900 # Adding location for the tag files is done as follows:
901 # TAGFILES = file1=loc1 "file2 = loc2" ...
902 # where "loc1" and "loc2" can be relative or absolute paths or
903 # URLs. If a location is present for each tag, the installdox tool
904 # does not have to be run to correct the links.
905 # Note that each tag file must have a unique name
906 # (where the name does NOT include the path)
907 # If a tag file is not located in the directory in which doxygen
908 # is run, you must also specify the path to the tagfile here.
912 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
913 # a tag file that is based on the input files it reads.
917 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
918 # in the class index. If set to NO only the inherited external classes
923 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
924 # in the modules index. If set to NO, only the current project's groups will
927 EXTERNAL_GROUPS = YES
929 # The PERL_PATH should be the absolute path and name of the perl script
930 # interpreter (i.e. the result of `which perl').
932 PERL_PATH = /usr/bin/perl
934 #---------------------------------------------------------------------------
935 # Configuration options related to the dot tool
936 #---------------------------------------------------------------------------
938 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
939 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
940 # super classes. Setting the tag to NO turns the diagrams off. Note that this
941 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
942 # recommended to install and use dot, since it yields more powerful graphs.
946 # If set to YES, the inheritance and collaboration graphs will hide
947 # inheritance and usage relations if the target is undocumented
950 HIDE_UNDOC_RELATIONS = YES
952 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
953 # available from the path. This tool is part of Graphviz, a graph visualization
954 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
955 # have no effect if this option is set to NO (the default)
959 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
960 # will generate a graph for each documented class showing the direct and
961 # indirect inheritance relations. Setting this tag to YES will force the
962 # the CLASS_DIAGRAMS tag to NO.
966 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
967 # will generate a graph for each documented class showing the direct and
968 # indirect implementation dependencies (inheritance, containment, and
969 # class references variables) of the class with other documented classes.
971 COLLABORATION_GRAPH = YES
973 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
974 # collaboration diagrams in a style similiar to the OMG's Unified Modeling
979 # If set to YES, the inheritance and collaboration graphs will show the
980 # relations between templates and their instances.
982 TEMPLATE_RELATIONS = NO
984 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
985 # tags are set to YES then doxygen will generate a graph for each documented
986 # file showing the direct and indirect include dependencies of the file with
987 # other documented files.
991 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
992 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
993 # documented header file showing the documented files that directly or
994 # indirectly include this file.
996 INCLUDED_BY_GRAPH = YES
998 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
999 # generate a call dependency graph for every global function or class method.
1000 # Note that enabling this option will significantly increase the time of a run.
1001 # So in most cases it will be better to enable call graphs for selected
1002 # functions only using the \callgraph command.
1006 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1007 # will graphical hierarchy of all classes instead of a textual one.
1009 GRAPHICAL_HIERARCHY = YES
1011 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1012 # generated by dot. Possible values are png, jpg, or gif
1013 # If left blank png will be used.
1015 DOT_IMAGE_FORMAT = png
1017 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1018 # found. If left blank, it is assumed the dot tool can be found on the path.
1022 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1023 # contain dot files that are included in the documentation (see the
1024 # \dotfile command).
1028 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1029 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1030 # this value, doxygen will try to truncate the graph, so that it fits within
1031 # the specified constraint. Beware that most browsers cannot cope with very
1034 MAX_DOT_GRAPH_WIDTH = 1024
1036 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1037 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1038 # this value, doxygen will try to truncate the graph, so that it fits within
1039 # the specified constraint. Beware that most browsers cannot cope with very
1042 MAX_DOT_GRAPH_HEIGHT = 1024
1044 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1045 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1046 # from the root by following a path via at most 3 edges will be shown. Nodes that
1047 # lay further from the root node will be omitted. Note that setting this option to
1048 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1049 # note that a graph may be further truncated if the graph's image dimensions are
1050 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1051 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1053 MAX_DOT_GRAPH_DEPTH = 0
1055 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1056 # generate a legend page explaining the meaning of the various boxes and
1057 # arrows in the dot generated graphs.
1059 GENERATE_LEGEND = YES
1061 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1062 # remove the intermediate dot files that are used to generate
1063 # the various graphs.
1067 #---------------------------------------------------------------------------
1068 # Configuration::addtions related to the search engine
1069 #---------------------------------------------------------------------------
1071 # The SEARCHENGINE tag specifies whether or not a search engine should be
1072 # used. If set to NO the values of all tags below this one will be ignored.
1076 # The CGI_NAME tag should be the name of the CGI script that
1077 # starts the search engine (doxysearch) with the correct parameters.
1078 # A script with this name will be generated by doxygen.
1080 CGI_NAME = search.cgi
1082 # The CGI_URL tag should be the absolute URL to the directory where the
1083 # cgi binaries are located. See the documentation of your http daemon for
1088 # The DOC_URL tag should be the absolute URL to the directory where the
1089 # documentation is located. If left blank the absolute path to the
1090 # documentation, with file:// prepended to it, will be used.
1094 # The DOC_ABSPATH tag should be the absolute path to the directory where the
1095 # documentation is located. If left blank the directory on the local machine
1100 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
1103 BIN_ABSPATH = /usr/local/bin/
1105 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
1106 # documentation generated for other projects. This allows doxysearch to search
1107 # the documentation for these projects as well.