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 = AliHLTPHOS
22 BUILTIN_STL_SUPPORT = YES
24 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
25 # This could be handy for archiving the generated documentation or
26 # if some version control system is used.
28 PROJECT_NUMBER = 0.0.0
30 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
31 # base path where the generated documentation will be put.
32 # If a relative path is entered, it will be relative to the location
33 # where doxygen was started. If left blank the current directory will be used.
37 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
38 # 4096 sub-directories (in 2 levels) under the output directory of each output
39 # format and will distribute the generated files over these directories.
40 # Enabling this option can be useful when feeding doxygen a huge amount of source
41 # files, where putting all generated files in the same directory would otherwise
42 # cause performance problems for the file system.
46 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
47 # documentation generated by doxygen is written. Doxygen will use this
48 # information to generate all constant output in the proper language.
49 # The default language is English, other supported languages are:
50 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
51 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
52 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
53 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
54 # Swedish, and Ukrainian.
56 OUTPUT_LANGUAGE = English
58 # This tag can be used to specify the encoding used in the generated output.
59 # The encoding is not always determined by the language that is chosen,
60 # but also whether or not the output is meant for Windows or non-Windows users.
61 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
62 # forces the Windows encoding (this is the default for the Windows binary),
63 # whereas setting the tag to NO uses a Unix-style encoding (the default for
64 # all platforms other than Windows).
66 USE_WINDOWS_ENCODING = NO
68 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
69 # include brief member descriptions after the members that are listed in
70 # the file and class documentation (similar to JavaDoc).
71 # Set to NO to disable this.
73 BRIEF_MEMBER_DESC = YES
75 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
76 # the brief description of a member or function before the detailed description.
77 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
78 # brief descriptions will be completely suppressed.
82 # This tag implements a quasi-intelligent brief description abbreviator
83 # that is used to form the text in various listings. Each string
84 # in this list, if found as the leading text of the brief description, will be
85 # stripped from the text and the result after processing the whole list, is used
86 # as the annotated text. Otherwise, the brief description is used as-is. If left
87 # blank, the following values are used ("$name" is automatically replaced with the
88 # name of the entity): "The $name class" "The $name widget" "The $name file"
89 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
93 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
94 # Doxygen will generate a detailed section even if there is only a brief
97 ALWAYS_DETAILED_SEC = YES
99 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
100 # members of a class in the documentation of that class as if those members were
101 # ordinary class members. Constructors, destructors and assignment operators of
102 # the base classes will not be shown.
104 INLINE_INHERITED_MEMB = NO
106 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
107 # path before files name in the file list and in the header files. If set
108 # to NO the shortest path that makes the file name unique will be used.
110 FULL_PATH_NAMES = YES
112 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
113 # can be used to strip a user-defined part of the path. Stripping is
114 # only done if one of the specified strings matches the left-hand part of
115 # the path. The tag can be used to show relative paths in the file list.
116 # If left blank the directory from which doxygen is run is used as the
121 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
122 # the path mentioned in the documentation of a class, which tells
123 # the reader which header file to include in order to use a class.
124 # If left blank only the name of the header file containing the class
125 # definition is used. Otherwise one should specify the include paths that
126 # are normally passed to the compiler using the -I flag.
128 STRIP_FROM_INC_PATH =
130 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
131 # (but less readable) file names. This can be useful is your file systems
132 # doesn't support long names like on DOS, Mac, or CD-ROM.
136 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
137 # will interpret the first line (until the first dot) of a JavaDoc-style
138 # comment as the brief description. If set to NO, the JavaDoc
139 # comments will behave just like the Qt-style comments (thus requiring an
140 # explicit @brief command for a brief description.
142 JAVADOC_AUTOBRIEF = NO
144 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
145 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
146 # comments) as a brief description. This used to be the default behaviour.
147 # The new default is to treat a multi-line C++ comment block as a detailed
148 # description. Set this tag to YES if you prefer the old behaviour instead.
150 MULTILINE_CPP_IS_BRIEF = NO
152 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
153 # will output the detailed description near the top, like JavaDoc.
154 # If set to NO, the detailed description appears after the member
159 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
160 # member inherits the documentation from any documented member that it
165 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
166 # tag is set to YES, then doxygen will reuse the documentation of the first
167 # member in the group (if any) for the other members of the group. By default
168 # all members of a group must be documented explicitly.
170 DISTRIBUTE_GROUP_DOC = YES
172 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
173 # Doxygen uses this value to replace tabs by spaces in code fragments.
177 # This tag can be used to specify a number of aliases that acts
178 # as commands in the documentation. An alias has the form "name=value".
179 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
180 # put the command \sideeffect (or @sideeffect) in the documentation, which
181 # will result in a user-defined paragraph with heading "Side Effects:".
182 # You can put \n's in the value part of an alias to insert newlines.
186 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
187 # only. Doxygen will then generate output that is more tailored for C.
188 # For instance, some of the names that are used will be different. The list
189 # of all members will be omitted, etc.
191 OPTIMIZE_OUTPUT_FOR_C = NO
193 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
194 # only. Doxygen will then generate output that is more tailored for Java.
195 # For instance, namespaces will be presented as packages, qualified scopes
196 # will look different, etc.
198 OPTIMIZE_OUTPUT_JAVA = NO
200 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
201 # the same type (for instance a group of public functions) to be put as a
202 # subgroup of that type (e.g. under the Public Functions section). Set it to
203 # NO to prevent subgrouping. Alternatively, this can be done per class using
204 # the \nosubgrouping command.
208 #---------------------------------------------------------------------------
209 # Build related configuration options
210 #---------------------------------------------------------------------------
212 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
213 # documentation are documented, even if no documentation was available.
214 # Private class members and static file members will be hidden unless
215 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
219 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
220 # will be included in the documentation.
222 EXTRACT_PRIVATE = YES
224 # If the EXTRACT_STATIC tag is set to YES all static members of a file
225 # will be included in the documentation.
229 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
230 # defined locally in source files will be included in the documentation.
231 # If set to NO only classes defined in header files are included.
233 EXTRACT_LOCAL_CLASSES = YES
235 # This flag is only useful for Objective-C code. When set to YES local
236 # methods, which are defined in the implementation section but not in
237 # the interface are included in the documentation.
238 # If set to NO (the default) only methods in the interface are included.
240 EXTRACT_LOCAL_METHODS = YES
242 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
243 # undocumented members of documented classes, files or namespaces.
244 # If set to NO (the default) these members will be included in the
245 # various overviews, but no documentation section is generated.
246 # This option has no effect if EXTRACT_ALL is enabled.
248 HIDE_UNDOC_MEMBERS = NO
250 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
251 # undocumented classes that are normally visible in the class hierarchy.
252 # If set to NO (the default) these classes will be included in the various
253 # overviews. This option has no effect if EXTRACT_ALL is enabled.
255 HIDE_UNDOC_CLASSES = NO
257 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
258 # friend (class|struct|union) declarations.
259 # If set to NO (the default) these declarations will be included in the
262 HIDE_FRIEND_COMPOUNDS = NO
264 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
265 # documentation blocks found inside the body of a function.
266 # If set to NO (the default) these blocks will be appended to the
267 # function's detailed documentation block.
269 HIDE_IN_BODY_DOCS = NO
271 # The INTERNAL_DOCS tag determines if documentation
272 # that is typed after a \internal command is included. If the tag is set
273 # to NO (the default) then the documentation will be excluded.
274 # Set it to YES to include the internal documentation.
278 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
279 # file names in lower-case letters. If set to YES upper-case letters are also
280 # allowed. This is useful if you have classes or files whose names only differ
281 # in case and if your file system supports case sensitive file names. Windows
282 # and Mac users are advised to set this option to NO.
284 CASE_SENSE_NAMES = YES
286 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
287 # will show members with their full class and namespace scopes in the
288 # documentation. If set to YES the scope will be hidden.
290 HIDE_SCOPE_NAMES = NO
292 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
293 # will put a list of the files that are included by a file in the documentation
296 SHOW_INCLUDE_FILES = YES
298 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
299 # is inserted in the documentation for inline members.
303 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
304 # will sort the (detailed) documentation of file and class members
305 # alphabetically by member name. If set to NO the members will appear in
308 SORT_MEMBER_DOCS = YES
310 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
311 # brief documentation of file, namespace and class members alphabetically
312 # by member name. If set to NO (the default) the members will appear in
317 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
318 # sorted by fully-qualified names, including namespaces. If set to
319 # NO (the default), the class list will be sorted only by class name,
320 # not including the namespace part.
321 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
322 # Note: This option applies only to the class list, not to the
325 SORT_BY_SCOPE_NAME = NO
327 # The GENERATE_TODOLIST tag can be used to enable (YES) or
328 # disable (NO) the todo list. This list is created by putting \todo
329 # commands in the documentation.
331 GENERATE_TODOLIST = YES
333 # The GENERATE_TESTLIST tag can be used to enable (YES) or
334 # disable (NO) the test list. This list is created by putting \test
335 # commands in the documentation.
337 GENERATE_TESTLIST = YES
339 # The GENERATE_BUGLIST tag can be used to enable (YES) or
340 # disable (NO) the bug list. This list is created by putting \bug
341 # commands in the documentation.
343 GENERATE_BUGLIST = YES
345 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
346 # disable (NO) the deprecated list. This list is created by putting
347 # \deprecated commands in the documentation.
349 GENERATE_DEPRECATEDLIST= YES
351 # The ENABLED_SECTIONS tag can be used to enable conditional
352 # documentation sections, marked by \if sectionname ... \endif.
356 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
357 # the initial value of a variable or define consists of for it to appear in
358 # the documentation. If the initializer consists of more lines than specified
359 # here it will be hidden. Use a value of 0 to hide initializers completely.
360 # The appearance of the initializer of individual variables and defines in the
361 # documentation can be controlled using \showinitializer or \hideinitializer
362 # command in the documentation regardless of this setting.
364 MAX_INITIALIZER_LINES = 30
366 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
367 # at the bottom of the documentation of classes and structs. If set to YES the
368 # list will mention the files that were used to generate the documentation.
370 SHOW_USED_FILES = YES
372 # If the sources in your project are distributed over multiple directories
373 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
374 # in the documentation.
376 SHOW_DIRECTORIES = YES
378 #---------------------------------------------------------------------------
379 # configuration options related to warning and progress messages
380 #---------------------------------------------------------------------------
382 # The QUIET tag can be used to turn on/off the messages that are generated
383 # by doxygen. Possible values are YES and NO. If left blank NO is used.
387 # The WARNINGS tag can be used to turn on/off the warning messages that are
388 # generated by doxygen. Possible values are YES and NO. If left blank
393 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
394 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
395 # automatically be disabled.
397 WARN_IF_UNDOCUMENTED = YES
399 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
400 # potential errors in the documentation, such as not documenting some
401 # parameters in a documented function, or documenting parameters that
402 # don't exist or using markup commands wrongly.
404 WARN_IF_DOC_ERROR = YES
406 # The WARN_FORMAT tag determines the format of the warning messages that
407 # doxygen can produce. The string should contain the $file, $line, and $text
408 # tags, which will be replaced by the file and line number from which the
409 # warning originated and the warning text.
411 WARN_FORMAT = "$file:$line: $text"
413 # The WARN_LOGFILE tag can be used to specify a file to which warning
414 # and error messages should be written. If left blank the output is written
419 #---------------------------------------------------------------------------
420 # configuration options related to the input files
421 #---------------------------------------------------------------------------
423 # The INPUT tag can be used to specify the files and/or directories that contain
424 # documented source files. You may enter file names like "myfile.cpp" or
425 # directories like "/usr/src/myproject". Separate the files or directories
438 # If the value of the INPUT tag contains directories, you can use the
439 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
440 # and *.h) to filter out the source-files in the directories. If left
441 # blank the following patterns are tested:
442 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
443 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
447 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
448 # should be searched for input files as well. Possible values are YES and NO.
449 # If left blank NO is used.
453 # The EXCLUDE tag can be used to specify files and/or directories that should
454 # excluded from the INPUT source files. This way you can easily exclude a
455 # subdirectory from a directory tree whose root is specified with the INPUT tag.
459 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
460 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
462 EXCLUDE_SYMLINKS = NO
464 # If the value of the INPUT tag contains directories, you can use the
465 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
466 # certain files from those directories.
470 # The EXAMPLE_PATH tag can be used to specify one or more files or
471 # directories that contain example code fragments that are included (see
472 # the \include command).
476 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
477 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
478 # and *.h) to filter out the source-files in the directories. If left
479 # blank all files are included.
483 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
484 # searched for input files to be used with the \include or \dontinclude
485 # commands irrespective of the value of the RECURSIVE tag.
486 # Possible values are YES and NO. If left blank NO is used.
488 EXAMPLE_RECURSIVE = YES
490 # The IMAGE_PATH tag can be used to specify one or more files or
491 # directories that contain image that are included in the documentation (see
492 # the \image command).
496 # The INPUT_FILTER tag can be used to specify a program that doxygen should
497 # invoke to filter for each input file. Doxygen will invoke the filter program
498 # by executing (via popen()) the command <filter> <input-file>, where <filter>
499 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
500 # input file. Doxygen will then use the output that the filter program writes
501 # to standard output. If FILTER_PATTERNS is specified, this tag will be
506 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
507 # basis. Doxygen will compare the file name with each pattern and apply the
508 # filter if there is a match. The filters are a list of the form:
509 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
510 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
511 # is applied to all files.
515 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
516 # INPUT_FILTER) will be used to filter the input files when producing source
517 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
519 FILTER_SOURCE_FILES = NO
521 #---------------------------------------------------------------------------
522 # configuration options related to source browsing
523 #---------------------------------------------------------------------------
525 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
526 # be generated. Documented entities will be cross-referenced with these sources.
527 # Note: To get rid of all source code in the generated output, make sure also
528 # VERBATIM_HEADERS is set to NO.
532 # Setting the INLINE_SOURCES tag to YES will include the body
533 # of functions and classes directly in the documentation.
537 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
538 # doxygen to hide any special comment blocks from generated source code
539 # fragments. Normal C and C++ comments will always remain visible.
541 STRIP_CODE_COMMENTS = YES
543 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
544 # then for each documented function all documented
545 # functions referencing it will be listed.
547 REFERENCED_BY_RELATION = YES
549 # If the REFERENCES_RELATION tag is set to YES (the default)
550 # then for each documented function all documented entities
551 # called/used by that function will be listed.
553 REFERENCES_RELATION = YES
555 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
556 # will generate a verbatim copy of the header file for each class for
557 # which an include is specified. Set to NO to disable this.
559 VERBATIM_HEADERS = YES
561 #---------------------------------------------------------------------------
562 # configuration options related to the alphabetical class index
563 #---------------------------------------------------------------------------
565 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
566 # of all compounds will be generated. Enable this if the project
567 # contains a lot of classes, structs, unions or interfaces.
569 ALPHABETICAL_INDEX = YES
571 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
572 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
573 # in which this list will be split (can be a number in the range [1..20])
575 COLS_IN_ALPHA_INDEX = 5
577 # In case all classes in a project start with a common prefix, all
578 # classes will be put under the same header in the alphabetical index.
579 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
580 # should be ignored while generating the index headers.
584 #---------------------------------------------------------------------------
585 # configuration options related to the HTML output
586 #---------------------------------------------------------------------------
588 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
589 # generate HTML output.
593 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
594 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
595 # put in front of it. If left blank `html' will be used as the default path.
599 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
600 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
601 # doxygen will generate files with .html extension.
603 HTML_FILE_EXTENSION = .html
605 # The HTML_HEADER tag can be used to specify a personal HTML header for
606 # each generated HTML page. If it is left blank doxygen will generate a
611 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
612 # each generated HTML page. If it is left blank doxygen will generate a
617 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
618 # style sheet that is used by each HTML page. It can be used to
619 # fine-tune the look of the HTML output. If the tag is left blank doxygen
620 # will generate a default style sheet. Note that doxygen will try to copy
621 # the style sheet file to the HTML output directory, so don't put your own
622 # stylesheet in the HTML output directory as well, or it will be erased!
626 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
627 # files or namespaces will be aligned in HTML using tables. If set to
628 # NO a bullet list will be used.
630 HTML_ALIGN_MEMBERS = YES
632 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
633 # will be generated that can be used as input for tools like the
634 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
635 # of the generated HTML documentation.
637 GENERATE_HTMLHELP = NO
639 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
640 # be used to specify the file name of the resulting .chm file. You
641 # can add a path in front of the file if the result should not be
642 # written to the html output directory.
646 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
647 # be used to specify the location (absolute path including file name) of
648 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
649 # the HTML help compiler on the generated index.hhp.
653 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
654 # controls if a separate .chi index file is generated (YES) or that
655 # it should be included in the master .chm file (NO).
659 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
660 # controls whether a binary table of contents is generated (YES) or a
661 # normal table of contents (NO) in the .chm file.
665 # The TOC_EXPAND flag can be set to YES to add extra items for group members
666 # to the contents of the HTML help documentation and to the tree view.
670 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
671 # top of each HTML page. The value NO (the default) enables the index and
672 # the value YES disables it.
676 # This tag can be used to set the number of enum values (range [1..20])
677 # that doxygen will group on one line in the generated HTML documentation.
679 ENUM_VALUES_PER_LINE = 4
681 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
682 # generated containing a tree-like index structure (just like the one that
683 # is generated for HTML Help). For this to work a browser that supports
684 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
685 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
686 # probably better off using the HTML help feature.
688 GENERATE_TREEVIEW = YES
690 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
691 # used to set the initial width (in pixels) of the frame in which the tree
696 #---------------------------------------------------------------------------
697 # configuration options related to the LaTeX output
698 #---------------------------------------------------------------------------
700 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
701 # generate Latex output.
705 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
706 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
707 # put in front of it. If left blank `latex' will be used as the default path.
711 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
712 # invoked. If left blank `latex' will be used as the default command name.
714 LATEX_CMD_NAME = latex
716 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
717 # generate index for LaTeX. If left blank `makeindex' will be used as the
718 # default command name.
720 MAKEINDEX_CMD_NAME = makeindex
722 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
723 # LaTeX documents. This may be useful for small projects and may help to
724 # save some trees in general.
728 # The PAPER_TYPE tag can be used to set the paper type that is used
729 # by the printer. Possible values are: a4, a4wide, letter, legal and
730 # executive. If left blank a4wide will be used.
734 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
735 # packages that should be included in the LaTeX output.
739 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
740 # the generated latex document. The header should contain everything until
741 # the first chapter. If it is left blank doxygen will generate a
742 # standard header. Notice: only use this tag if you know what you are doing!
746 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
747 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
748 # contain links (just like the HTML output) instead of page references
749 # This makes the output suitable for online browsing using a pdf viewer.
753 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
754 # plain latex in the generated Makefile. Set this option to YES to get a
755 # higher quality PDF documentation.
759 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
760 # command to the generated LaTeX files. This will instruct LaTeX to keep
761 # running if errors occur, instead of asking the user for help.
762 # This option is also used when generating formulas in HTML.
766 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
767 # include the index chapters (such as File Index, Compound Index, etc.)
770 LATEX_HIDE_INDICES = NO
772 #---------------------------------------------------------------------------
773 # configuration options related to the RTF output
774 #---------------------------------------------------------------------------
776 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
777 # The RTF output is optimized for Word 97 and may not look very pretty with
778 # other RTF readers or editors.
782 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
783 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
784 # put in front of it. If left blank `rtf' will be used as the default path.
788 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
789 # RTF documents. This may be useful for small projects and may help to
790 # save some trees in general.
794 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
795 # will contain hyperlink fields. The RTF file will
796 # contain links (just like the HTML output) instead of page references.
797 # This makes the output suitable for online browsing using WORD or other
798 # programs which support those fields.
799 # Note: wordpad (write) and others do not support links.
803 # Load stylesheet definitions from file. Syntax is similar to doxygen's
804 # config file, i.e. a series of assignments. You only have to provide
805 # replacements, missing definitions are set to their default value.
807 RTF_STYLESHEET_FILE =
809 # Set optional variables used in the generation of an rtf document.
810 # Syntax is similar to doxygen's config file.
812 RTF_EXTENSIONS_FILE =
814 #---------------------------------------------------------------------------
815 # configuration options related to the man page output
816 #---------------------------------------------------------------------------
818 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
824 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
825 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
826 # put in front of it. If left blank `man' will be used as the default path.
830 # The MAN_EXTENSION tag determines the extension that is added to
831 # the generated man pages (default is the subroutine's section .3)
835 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
836 # then it will generate one additional man file for each entity
837 # documented in the real man page(s). These additional files
838 # only source the real man page, but without them the man command
839 # would be unable to find the correct page. The default is NO.
844 #---------------------------------------------------------------------------
845 # configuration options related to the XML output
846 #---------------------------------------------------------------------------
848 # If the GENERATE_XML tag is set to YES Doxygen will
849 # generate an XML file that captures the structure of
850 # the code including all documentation.
855 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
856 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
857 # put in front of it. If left blank `xml' will be used as the default path.
861 # The XML_SCHEMA tag can be used to specify an XML schema,
862 # which can be used by a validating XML parser to check the
863 # syntax of the XML files.
867 # The XML_DTD tag can be used to specify an XML DTD,
868 # which can be used by a validating XML parser to check the
869 # syntax of the XML files.
873 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
874 # dump the program listings (including syntax highlighting
875 # and cross-referencing information) to the XML output. Note that
876 # enabling this will significantly increase the size of the XML output.
878 # XML_PROGRAMLISTING = YES
879 XML_PROGRAMLISTING = YES
881 #---------------------------------------------------------------------------
882 # configuration options for the AutoGen Definitions output
883 #---------------------------------------------------------------------------
885 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
886 # generate an AutoGen Definitions (see autogen.sf.net) file
887 # that captures the structure of the code including all
888 # documentation. Note that this feature is still experimental
889 # and incomplete at the moment.
891 GENERATE_AUTOGEN_DEF = NO
893 #---------------------------------------------------------------------------
894 # configuration options related to the Perl module output
895 #---------------------------------------------------------------------------
897 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
898 # generate a Perl module file that captures the structure of
899 # the code including all documentation. Note that this
900 # feature is still experimental and incomplete at the
903 GENERATE_PERLMOD = NO
905 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
906 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
907 # to generate PDF and DVI output from the Perl module output.
911 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
912 # nicely formatted so it can be parsed by a human reader. This is useful
913 # if you want to understand what is going on. On the other hand, if this
914 # tag is set to NO the size of the Perl module output will be much smaller
915 # and Perl will parse it just the same.
919 # The names of the make variables in the generated doxyrules.make file
920 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
921 # This is useful so different doxyrules.make files included by the same
922 # Makefile don't overwrite each other's variables.
924 PERLMOD_MAKEVAR_PREFIX =
926 #---------------------------------------------------------------------------
927 # Configuration options related to the preprocessor
928 #---------------------------------------------------------------------------
930 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
931 # evaluate all C-preprocessor directives found in the sources and include
934 ENABLE_PREPROCESSING = YES
936 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
937 # names in the source code. If set to NO (the default) only conditional
938 # compilation will be performed. Macro expansion can be done in a controlled
939 # way by setting EXPAND_ONLY_PREDEF to YES.
943 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
944 # then the macro expansion is limited to the macros specified with the
945 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
947 EXPAND_ONLY_PREDEF = NO
949 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
950 # in the INCLUDE_PATH (see below) will be search if a #include is found.
952 SEARCH_INCLUDES = YES
954 # The INCLUDE_PATH tag can be used to specify one or more directories that
955 # contain include files that are not input files but should be processed by
960 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
961 # patterns (like *.h and *.hpp) to filter out the header-files in the
962 # directories. If left blank, the patterns specified with FILE_PATTERNS will
965 INCLUDE_FILE_PATTERNS =
967 # The PREDEFINED tag can be used to specify one or more macro names that
968 # are defined before the preprocessor is started (similar to the -D option of
969 # gcc). The argument of the tag is a list of macros of the form: name
970 # or name=definition (no spaces). If the definition and the = are
971 # omitted =1 is assumed. To prevent a macro definition from being
972 # undefined via #undef or recursively expanded use the := operator
973 # instead of the = operator.
977 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
978 # this tag can be used to specify a list of macro names that should be expanded.
979 # The macro definition that is found in the sources will be used.
980 # Use the PREDEFINED tag if you want to use a different macro definition.
984 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
985 # doxygen's preprocessor will remove all function-like macros that are alone
986 # on a line, have an all uppercase name, and do not end with a semicolon. Such
987 # function macros are typically used for boiler-plate code, and will confuse the
988 # parser if not removed.
990 SKIP_FUNCTION_MACROS = YES
992 #---------------------------------------------------------------------------
993 # Configuration::additions related to external references
994 #---------------------------------------------------------------------------
996 # The TAGFILES option can be used to specify one or more tagfiles.
997 # Optionally an initial location of the external documentation
998 # can be added for each tagfile. The format of a tag file without
999 # this location is as follows:
1000 # TAGFILES = file1 file2 ...
1001 # Adding location for the tag files is done as follows:
1002 # TAGFILES = file1=loc1 "file2 = loc2" ...
1003 # where "loc1" and "loc2" can be relative or absolute paths or
1004 # URLs. If a location is present for each tag, the installdox tool
1005 # does not have to be run to correct the links.
1006 # Note that each tag file must have a unique name
1007 # (where the name does NOT include the path)
1008 # If a tag file is not located in the directory in which doxygen
1009 # is run, you must also specify the path to the tagfile here.
1013 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1014 # a tag file that is based on the input files it reads.
1018 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1019 # in the class index. If set to NO only the inherited external classes
1024 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1025 # in the modules index. If set to NO, only the current project's groups will
1028 EXTERNAL_GROUPS = YES
1030 # The PERL_PATH should be the absolute path and name of the perl script
1031 # interpreter (i.e. the result of `which perl').
1033 PERL_PATH = /usr/bin/perl
1035 #---------------------------------------------------------------------------
1036 # Configuration options related to the dot tool
1037 #---------------------------------------------------------------------------
1039 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1040 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1041 # super classes. Setting the tag to NO turns the diagrams off. Note that this
1042 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1043 # recommended to install and use dot, since it yields more powerful graphs.
1045 CLASS_DIAGRAMS = YES
1047 # If set to YES, the inheritance and collaboration graphs will hide
1048 # inheritance and usage relations if the target is undocumented
1049 # or is not a class.
1051 HIDE_UNDOC_RELATIONS = YES
1053 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1054 # available from the path. This tool is part of Graphviz, a graph visualization
1055 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1056 # have no effect if this option is set to NO (the default)
1060 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1061 # will generate a graph for each documented class showing the direct and
1062 # indirect inheritance relations. Setting this tag to YES will force the
1063 # the CLASS_DIAGRAMS tag to NO.
1067 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1068 # will generate a graph for each documented class showing the direct and
1069 # indirect implementation dependencies (inheritance, containment, and
1070 # class references variables) of the class with other documented classes.
1072 COLLABORATION_GRAPH = YES
1074 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1075 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1080 # If set to YES, the inheritance and collaboration graphs will show the
1081 # relations between templates and their instances.
1083 TEMPLATE_RELATIONS = NO
1085 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1086 # tags are set to YES then doxygen will generate a graph for each documented
1087 # file showing the direct and indirect include dependencies of the file with
1088 # other documented files.
1092 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1093 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1094 # documented header file showing the documented files that directly or
1095 # indirectly include this file.
1097 INCLUDED_BY_GRAPH = YES
1099 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1100 # generate a call dependency graph for every global function or class method.
1101 # Note that enabling this option will significantly increase the time of a run.
1102 # So in most cases it will be better to enable call graphs for selected
1103 # functions only using the \callgraph command.
1107 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1108 # will graphical hierarchy of all classes instead of a textual one.
1110 GRAPHICAL_HIERARCHY = YES
1112 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1113 # generated by dot. Possible values are png, jpg, or gif
1114 # If left blank png will be used.
1116 DOT_IMAGE_FORMAT = png
1118 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1119 # found. If left blank, it is assumed the dot tool can be found on the path.
1123 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1124 # contain dot files that are included in the documentation (see the
1125 # \dotfile command).
1129 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1130 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1131 # this value, doxygen will try to truncate the graph, so that it fits within
1132 # the specified constraint. Beware that most browsers cannot cope with very
1135 MAX_DOT_GRAPH_WIDTH = 1024
1137 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1138 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1139 # this value, doxygen will try to truncate the graph, so that it fits within
1140 # the specified constraint. Beware that most browsers cannot cope with very
1143 MAX_DOT_GRAPH_HEIGHT = 1024
1145 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1146 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1147 # from the root by following a path via at most 3 edges will be shown. Nodes that
1148 # lay further from the root node will be omitted. Note that setting this option to
1149 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1150 # note that a graph may be further truncated if the graph's image dimensions are
1151 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1152 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1154 MAX_DOT_GRAPH_DEPTH = 0
1156 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1157 # generate a legend page explaining the meaning of the various boxes and
1158 # arrows in the dot generated graphs.
1160 GENERATE_LEGEND = YES
1162 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1163 # remove the intermediate dot files that are used to generate
1164 # the various graphs.
1168 #---------------------------------------------------------------------------
1169 # Configuration::additions related to the search engine
1170 #---------------------------------------------------------------------------
1172 # The SEARCHENGINE tag specifies whether or not a search engine should be
1173 # used. If set to NO the values of all tags below this one will be ignored.