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 = "AliRoot MUON"
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 SVN trunk"
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.
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 source
39 # files, where putting all generated files in the same directory would otherwise
40 # 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 used
74 # as the annotated text. Otherwise, the brief description is used as-is. If left
75 # blank, the following values are used ("$name" is automatically replaced with the
76 # name of the entity): "The $name class" "The $name widget" "The $name file"
77 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
79 ABBREVIATE_BRIEF = YES
81 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
82 # Doxygen will generate a detailed section even if there is only a brief
85 ALWAYS_DETAILED_SEC = YES
87 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
88 # members of a class in the documentation of that class as if those members were
89 # ordinary class members. Constructors, destructors and assignment operators of
90 # the base classes will not be shown.
92 INLINE_INHERITED_MEMB = NO
94 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
95 # path before files name in the file list and in the header files. If set
96 # to NO the shortest path that makes the file name unique will be used.
100 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
101 # can be used to strip a user-defined part of the path. Stripping is
102 # only done if one of the specified strings matches the left-hand part of
103 # the path. The tag can be used to show relative paths in the file list.
104 # If left blank the directory from which doxygen is run is used as the
109 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
110 # the path mentioned in the documentation of a class, which tells
111 # the reader which header file to include in order to use a class.
112 # If left blank only the name of the header file containing the class
113 # definition is used. Otherwise one should specify the include paths that
114 # are normally passed to the compiler using the -I flag.
116 STRIP_FROM_INC_PATH =
118 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
119 # (but less readable) file names. This can be useful is your file systems
120 # doesn't support long names like on DOS, Mac, or CD-ROM.
124 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
125 # will interpret the first line (until the first dot) of a JavaDoc-style
126 # comment as the brief description. If set to NO, the JavaDoc
127 # comments will behave just like the Qt-style comments (thus requiring an
128 # explicit @brief command for a brief description.
130 JAVADOC_AUTOBRIEF = NO
132 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
133 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
134 # comments) as a brief description. This used to be the default behaviour.
135 # The new default is to treat a multi-line C++ comment block as a detailed
136 # description. Set this tag to YES if you prefer the old behaviour instead.
138 MULTILINE_CPP_IS_BRIEF = NO
140 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
141 # will output the detailed description near the top, like JavaDoc.
142 # If set to NO, the detailed description appears after the member
147 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
148 # member inherits the documentation from any documented member that it
153 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
154 # tag is set to YES, then doxygen will reuse the documentation of the first
155 # member in the group (if any) for the other members of the group. By default
156 # all members of a group must be documented explicitly.
158 DISTRIBUTE_GROUP_DOC = 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.
174 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
175 # only. Doxygen will then generate output that is more tailored for C.
176 # For instance, some of the names that are used will be different. The list
177 # of all members will be omitted, etc.
179 OPTIMIZE_OUTPUT_FOR_C = NO
181 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
182 # only. Doxygen will then generate output that is more tailored for Java.
183 # For instance, namespaces will be presented as packages, qualified scopes
184 # will look different, etc.
186 OPTIMIZE_OUTPUT_JAVA = NO
188 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
189 # the same type (for instance a group of public functions) to be put as a
190 # subgroup of that type (e.g. under the Public Functions section). Set it to
191 # NO to prevent subgrouping. Alternatively, this can be done per class using
192 # the \nosubgrouping command.
196 #---------------------------------------------------------------------------
197 # Build related configuration options
198 #---------------------------------------------------------------------------
200 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
201 # documentation are documented, even if no documentation was available.
202 # Private class members and static file members will be hidden unless
203 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
208 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
209 # will be included in the documentation.
211 EXTRACT_PRIVATE = YES
213 # If the EXTRACT_STATIC tag is set to YES all static members of a file
214 # will be included in the documentation.
218 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
219 # defined locally in source files will be included in the documentation.
220 # If set to NO only classes defined in header files are included.
222 EXTRACT_LOCAL_CLASSES = YES
224 # This flag is only useful for Objective-C code. When set to YES local
225 # methods, which are defined in the implementation section but not in
226 # the interface are included in the documentation.
227 # If set to NO (the default) only methods in the interface are included.
229 EXTRACT_LOCAL_METHODS = NO
231 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
232 # undocumented members of documented classes, files or namespaces.
233 # If set to NO (the default) these members will be included in the
234 # various overviews, but no documentation section is generated.
235 # This option has no effect if EXTRACT_ALL is enabled.
237 HIDE_UNDOC_MEMBERS = NO
239 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
240 # undocumented classes that are normally visible in the class hierarchy.
241 # If set to NO (the default) these classes will be included in the various
242 # overviews. This option has no effect if EXTRACT_ALL is enabled.
244 HIDE_UNDOC_CLASSES = NO
246 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
247 # friend (class|struct|union) declarations.
248 # If set to NO (the default) these declarations will be included in the
251 HIDE_FRIEND_COMPOUNDS = NO
253 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
254 # documentation blocks found inside the body of a function.
255 # If set to NO (the default) these blocks will be appended to the
256 # function's detailed documentation block.
258 HIDE_IN_BODY_DOCS = NO
260 # The INTERNAL_DOCS tag determines if documentation
261 # that is typed after a \internal command is included. If the tag is set
262 # to NO (the default) then the documentation will be excluded.
263 # Set it to YES to include the internal documentation.
267 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
268 # file names in lower-case letters. If set to YES upper-case letters are also
269 # allowed. This is useful if you have classes or files whose names only differ
270 # in case and if your file system supports case sensitive file names. Windows
271 # and Mac users are advised to set this option to NO.
273 CASE_SENSE_NAMES = YES
275 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
276 # will show members with their full class and namespace scopes in the
277 # documentation. If set to YES the scope will be hidden.
279 HIDE_SCOPE_NAMES = NO
281 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
282 # will put a list of the files that are included by a file in the documentation
285 SHOW_INCLUDE_FILES = YES
287 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
288 # is inserted in the documentation for inline members.
292 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
293 # will sort the (detailed) documentation of file and class members
294 # alphabetically by member name. If set to NO the members will appear in
297 SORT_MEMBER_DOCS = NO
299 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
300 # brief documentation of file, namespace and class members alphabetically
301 # by member name. If set to NO (the default) the members will appear in
306 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
307 # sorted by fully-qualified names, including namespaces. If set to
308 # NO (the default), the class list will be sorted only by class name,
309 # not including the namespace part.
310 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
311 # Note: This option applies only to the class list, not to the
314 SORT_BY_SCOPE_NAME = NO
316 # The GENERATE_TODOLIST tag can be used to enable (YES) or
317 # disable (NO) the todo list. This list is created by putting \todo
318 # commands in the documentation.
320 GENERATE_TODOLIST = YES
322 # The GENERATE_TESTLIST tag can be used to enable (YES) or
323 # disable (NO) the test list. This list is created by putting \test
324 # commands in the documentation.
326 GENERATE_TESTLIST = YES
328 # The GENERATE_BUGLIST tag can be used to enable (YES) or
329 # disable (NO) the bug list. This list is created by putting \bug
330 # commands in the documentation.
332 GENERATE_BUGLIST = YES
334 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
335 # disable (NO) the deprecated list. This list is created by putting
336 # \deprecated commands in the documentation.
338 GENERATE_DEPRECATEDLIST= YES
340 # The ENABLED_SECTIONS tag can be used to enable conditional
341 # documentation sections, marked by \if sectionname ... \endif.
345 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
346 # the initial value of a variable or define consists of for it to appear in
347 # the documentation. If the initializer consists of more lines than specified
348 # here it will be hidden. Use a value of 0 to hide initializers completely.
349 # The appearance of the initializer of individual variables and defines in the
350 # documentation can be controlled using \showinitializer or \hideinitializer
351 # command in the documentation regardless of this setting.
353 MAX_INITIALIZER_LINES = 30
355 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
356 # at the bottom of the documentation of classes and structs. If set to YES the
357 # list will mention the files that were used to generate the documentation.
359 SHOW_USED_FILES = YES
361 # If the sources in your project are distributed over multiple directories
362 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
363 # in the documentation.
365 SHOW_DIRECTORIES = NO
367 #---------------------------------------------------------------------------
368 # configuration options related to warning and progress messages
369 #---------------------------------------------------------------------------
371 # The QUIET tag can be used to turn on/off the messages that are generated
372 # by doxygen. Possible values are YES and NO. If left blank NO is used.
376 # The WARNINGS tag can be used to turn on/off the warning messages that are
377 # generated by doxygen. Possible values are YES and NO. If left blank
382 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
383 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
384 # automatically be disabled.
386 WARN_IF_UNDOCUMENTED = YES
387 #WARN_IF_UNDOCUMENTED = YES
389 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
390 # potential errors in the documentation, such as not documenting some
391 # parameters in a documented function, or documenting parameters that
392 # don't exist or using markup commands wrongly.
394 WARN_IF_DOC_ERROR = YES
396 # The WARN_FORMAT tag determines the format of the warning messages that
397 # doxygen can produce. The string should contain the $file, $line, and $text
398 # tags, which will be replaced by the file and line number from which the
399 # warning originated and the warning text.
401 WARN_FORMAT = "$file:$line: $text"
403 # The WARN_LOGFILE tag can be used to specify a file to which warning
404 # and error messages should be written. If left blank the output is written
409 #---------------------------------------------------------------------------
410 # configuration options related to the input files
411 #---------------------------------------------------------------------------
413 # The INPUT tag can be used to specify the files and/or directories that contain
414 # documented source files. You may enter file names like "myfile.cpp" or
415 # directories like "/usr/src/myproject". Separate the files or directories
418 #INPUT = . ../STEER ../EVGEN
421 # If the value of the INPUT tag contains directories, you can use the
422 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
423 # and *.h) to filter out the source-files in the directories. If left
424 # blank the following patterns are tested:
425 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
426 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
428 #FILE_PATTERNS = *.h *.cxx *.icc *.C *.txt *.sh
429 #FILE_PATTERNS = *.h *.cxx *.icc
430 FILE_PATTERNS = Doxymain.h *README*.txt
432 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
433 # should be searched for input files as well. Possible values are YES and NO.
434 # If left blank NO is used.
438 # The EXCLUDE tag can be used to specify files and/or directories that should
439 # excluded from the INPUT source files. This way you can easily exclude a
440 # subdirectory from a directory tree whose root is specified with the INPUT tag.
443 EXCLUDE = Doxymodules_STEER.h Doxymodules_EVGEN.h
445 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
446 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
448 EXCLUDE_SYMLINKS = NO
450 # If the value of the INPUT tag contains directories, you can use the
451 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
452 # certain files from those directories.
454 EXCLUDE_PATTERNS = "G__*"
456 # The EXAMPLE_PATH tag can be used to specify one or more files or
457 # directories that contain example code fragments that are included (see
458 # the \include command).
462 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
463 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
464 # and *.h) to filter out the source-files in the directories. If left
465 # blank all files are included.
469 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
470 # searched for input files to be used with the \include or \dontinclude
471 # commands irrespective of the value of the RECURSIVE tag.
472 # Possible values are YES and NO. If left blank NO is used.
474 EXAMPLE_RECURSIVE = NO
476 # The IMAGE_PATH tag can be used to specify one or more files or
477 # directories that contain image that are included in the documentation (see
478 # the \image command).
482 # The INPUT_FILTER tag can be used to specify a program that doxygen should
483 # invoke to filter for each input file. Doxygen will invoke the filter program
484 # by executing (via popen()) the command <filter> <input-file>, where <filter>
485 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
486 # input file. Doxygen will then use the output that the filter program writes
487 # to standard output. If FILTER_PATTERNS is specified, this tag will be
492 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
493 # basis. Doxygen will compare the file name with each pattern and apply the
494 # filter if there is a match. The filters are a list of the form:
495 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
496 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
497 # is applied to all files.
501 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
502 # INPUT_FILTER) will be used to filter the input files when producing source
503 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
505 FILTER_SOURCE_FILES = NO
507 #---------------------------------------------------------------------------
508 # configuration options related to source browsing
509 #---------------------------------------------------------------------------
511 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
512 # be generated. Documented entities will be cross-referenced with these sources.
513 # Note: To get rid of all source code in the generated output, make sure also
514 # VERBATIM_HEADERS is set to NO.
518 # Setting the INLINE_SOURCES tag to YES will include the body
519 # of functions and classes directly in the documentation.
523 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
524 # doxygen to hide any special comment blocks from generated source code
525 # fragments. Normal C and C++ comments will always remain visible.
527 STRIP_CODE_COMMENTS = NO
529 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
530 # then for each documented function all documented
531 # functions referencing it will be listed.
533 REFERENCED_BY_RELATION = YES
535 # If the REFERENCES_RELATION tag is set to YES (the default)
536 # then for each documented function all documented entities
537 # called/used by that function will be listed.
539 REFERENCES_RELATION = YES
541 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
542 # will generate a verbatim copy of the header file for each class for
543 # which an include is specified. Set to NO to disable this.
545 VERBATIM_HEADERS = NO
547 #---------------------------------------------------------------------------
548 # configuration options related to the alphabetical class index
549 #---------------------------------------------------------------------------
551 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
552 # of all compounds will be generated. Enable this if the project
553 # contains a lot of classes, structs, unions or interfaces.
555 ALPHABETICAL_INDEX = YES
557 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
558 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
559 # in which this list will be split (can be a number in the range [1..20])
561 COLS_IN_ALPHA_INDEX = 2
563 # In case all classes in a project start with a common prefix, all
564 # classes will be put under the same header in the alphabetical index.
565 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
566 # should be ignored while generating the index headers.
568 IGNORE_PREFIX = AliMUON AliMp Ali
570 #---------------------------------------------------------------------------
571 # configuration options related to the HTML output
572 #---------------------------------------------------------------------------
574 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
575 # generate HTML output.
579 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
580 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
581 # put in front of it. If left blank `html' will be used as the default path.
583 HTML_OUTPUT = muon_html
585 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
586 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
587 # doxygen will generate files with .html extension.
589 HTML_FILE_EXTENSION = .html
591 # The HTML_HEADER tag can be used to specify a personal HTML header for
592 # each generated HTML page. If it is left blank doxygen will generate a
597 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
598 # each generated HTML page. If it is left blank doxygen will generate a
603 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
604 # style sheet that is used by each HTML page. It can be used to
605 # fine-tune the look of the HTML output. If the tag is left blank doxygen
606 # will generate a default style sheet. Note that doxygen will try to copy
607 # the style sheet file to the HTML output directory, so don't put your own
608 # stylesheet in the HTML output directory as well, or it will be erased!
612 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
613 # files or namespaces will be aligned in HTML using tables. If set to
614 # NO a bullet list will be used.
616 HTML_ALIGN_MEMBERS = YES
618 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
619 # will be generated that can be used as input for tools like the
620 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
621 # of the generated HTML documentation.
623 GENERATE_HTMLHELP = NO
625 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
626 # be used to specify the file name of the resulting .chm file. You
627 # can add a path in front of the file if the result should not be
628 # written to the html output directory.
632 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
633 # be used to specify the location (absolute path including file name) of
634 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
635 # the HTML help compiler on the generated index.hhp.
639 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
640 # controls if a separate .chi index file is generated (YES) or that
641 # it should be included in the master .chm file (NO).
645 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
646 # controls whether a binary table of contents is generated (YES) or a
647 # normal table of contents (NO) in the .chm file.
651 # The TOC_EXPAND flag can be set to YES to add extra items for group members
652 # to the contents of the HTML help documentation and to the tree view.
656 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
657 # top of each HTML page. The value NO (the default) enables the index and
658 # the value YES disables it.
662 # This tag can be used to set the number of enum values (range [1..20])
663 # that doxygen will group on one line in the generated HTML documentation.
665 ENUM_VALUES_PER_LINE = 4
667 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
668 # generated containing a tree-like index structure (just like the one that
669 # is generated for HTML Help). For this to work a browser that supports
670 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
671 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
672 # probably better off using the HTML help feature.
674 GENERATE_TREEVIEW = NO
676 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
677 # used to set the initial width (in pixels) of the frame in which the tree
682 #---------------------------------------------------------------------------
683 # configuration options related to the LaTeX output
684 #---------------------------------------------------------------------------
686 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
687 # generate Latex output.
691 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
692 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
693 # put in front of it. If left blank `latex' will be used as the default path.
697 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
698 # invoked. If left blank `latex' will be used as the default command name.
700 LATEX_CMD_NAME = latex
702 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
703 # generate index for LaTeX. If left blank `makeindex' will be used as the
704 # default command name.
706 MAKEINDEX_CMD_NAME = makeindex
708 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
709 # LaTeX documents. This may be useful for small projects and may help to
710 # save some trees in general.
714 # The PAPER_TYPE tag can be used to set the paper type that is used
715 # by the printer. Possible values are: a4, a4wide, letter, legal and
716 # executive. If left blank a4wide will be used.
720 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
721 # packages that should be included in the LaTeX output.
725 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
726 # the generated latex document. The header should contain everything until
727 # the first chapter. If it is left blank doxygen will generate a
728 # standard header. Notice: only use this tag if you know what you are doing!
732 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
733 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
734 # contain links (just like the HTML output) instead of page references
735 # This makes the output suitable for online browsing using a pdf viewer.
739 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
740 # plain latex in the generated Makefile. Set this option to YES to get a
741 # higher quality PDF documentation.
745 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
746 # command to the generated LaTeX files. This will instruct LaTeX to keep
747 # running if errors occur, instead of asking the user for help.
748 # This option is also used when generating formulas in HTML.
752 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
753 # include the index chapters (such as File Index, Compound Index, etc.)
756 LATEX_HIDE_INDICES = NO
758 #---------------------------------------------------------------------------
759 # configuration options related to the RTF output
760 #---------------------------------------------------------------------------
762 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
763 # The RTF output is optimized for Word 97 and may not look very pretty with
764 # other RTF readers or editors.
768 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
769 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
770 # put in front of it. If left blank `rtf' will be used as the default path.
774 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
775 # RTF documents. This may be useful for small projects and may help to
776 # save some trees in general.
780 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
781 # will contain hyperlink fields. The RTF file will
782 # contain links (just like the HTML output) instead of page references.
783 # This makes the output suitable for online browsing using WORD or other
784 # programs which support those fields.
785 # Note: wordpad (write) and others do not support links.
789 # Load stylesheet definitions from file. Syntax is similar to doxygen's
790 # config file, i.e. a series of assignments. You only have to provide
791 # replacements, missing definitions are set to their default value.
793 RTF_STYLESHEET_FILE =
795 # Set optional variables used in the generation of an rtf document.
796 # Syntax is similar to doxygen's config file.
798 RTF_EXTENSIONS_FILE =
800 #---------------------------------------------------------------------------
801 # configuration options related to the man page output
802 #---------------------------------------------------------------------------
804 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
809 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
810 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
811 # put in front of it. If left blank `man' will be used as the default path.
815 # The MAN_EXTENSION tag determines the extension that is added to
816 # the generated man pages (default is the subroutine's section .3)
820 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
821 # then it will generate one additional man file for each entity
822 # documented in the real man page(s). These additional files
823 # only source the real man page, but without them the man command
824 # would be unable to find the correct page. The default is NO.
828 #---------------------------------------------------------------------------
829 # configuration options related to the XML output
830 #---------------------------------------------------------------------------
832 # If the GENERATE_XML tag is set to YES Doxygen will
833 # generate an XML file that captures the structure of
834 # the code including all documentation.
838 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
839 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
840 # put in front of it. If left blank `xml' will be used as the default path.
844 # The XML_SCHEMA tag can be used to specify an XML schema,
845 # which can be used by a validating XML parser to check the
846 # syntax of the XML files.
850 # The XML_DTD tag can be used to specify an XML DTD,
851 # which can be used by a validating XML parser to check the
852 # syntax of the XML files.
856 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
857 # dump the program listings (including syntax highlighting
858 # and cross-referencing information) to the XML output. Note that
859 # enabling this will significantly increase the size of the XML output.
861 XML_PROGRAMLISTING = YES
863 #---------------------------------------------------------------------------
864 # configuration options for the AutoGen Definitions output
865 #---------------------------------------------------------------------------
867 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
868 # generate an AutoGen Definitions (see autogen.sf.net) file
869 # that captures the structure of the code including all
870 # documentation. Note that this feature is still experimental
871 # and incomplete at the moment.
873 GENERATE_AUTOGEN_DEF = NO
875 #---------------------------------------------------------------------------
876 # configuration options related to the Perl module output
877 #---------------------------------------------------------------------------
879 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
880 # generate a Perl module file that captures the structure of
881 # the code including all documentation. Note that this
882 # feature is still experimental and incomplete at the
885 GENERATE_PERLMOD = NO
887 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
888 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
889 # to generate PDF and DVI output from the Perl module output.
893 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
894 # nicely formatted so it can be parsed by a human reader. This is useful
895 # if you want to understand what is going on. On the other hand, if this
896 # tag is set to NO the size of the Perl module output will be much smaller
897 # and Perl will parse it just the same.
901 # The names of the make variables in the generated doxyrules.make file
902 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
903 # This is useful so different doxyrules.make files included by the same
904 # Makefile don't overwrite each other's variables.
906 PERLMOD_MAKEVAR_PREFIX =
908 #---------------------------------------------------------------------------
909 # Configuration options related to the preprocessor
910 #---------------------------------------------------------------------------
912 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
913 # evaluate all C-preprocessor directives found in the sources and include
916 ENABLE_PREPROCESSING = YES
918 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
919 # names in the source code. If set to NO (the default) only conditional
920 # compilation will be performed. Macro expansion can be done in a controlled
921 # way by setting EXPAND_ONLY_PREDEF to YES.
925 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
926 # then the macro expansion is limited to the macros specified with the
927 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
929 EXPAND_ONLY_PREDEF = NO
931 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
932 # in the INCLUDE_PATH (see below) will be search if a #include is found.
934 SEARCH_INCLUDES = YES
936 # The INCLUDE_PATH tag can be used to specify one or more directories that
937 # contain include files that are not input files but should be processed by
942 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
943 # patterns (like *.h and *.hpp) to filter out the header-files in the
944 # directories. If left blank, the patterns specified with FILE_PATTERNS will
947 INCLUDE_FILE_PATTERNS =
949 # The PREDEFINED tag can be used to specify one or more macro names that
950 # are defined before the preprocessor is started (similar to the -D option of
951 # gcc). The argument of the tag is a list of macros of the form: name
952 # or name=definition (no spaces). If the definition and the = are
953 # omitted =1 is assumed. To prevent a macro definition from being
954 # undefined via #undef or recursively expanded use the := operator
955 # instead of the = operator.
959 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
960 # this tag can be used to specify a list of macro names that should be expanded.
961 # The macro definition that is found in the sources will be used.
962 # Use the PREDEFINED tag if you want to use a different macro definition.
966 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
967 # doxygen's preprocessor will remove all function-like macros that are alone
968 # on a line, have an all uppercase name, and do not end with a semicolon. Such
969 # function macros are typically used for boiler-plate code, and will confuse the
970 # parser if not removed.
972 SKIP_FUNCTION_MACROS = YES
974 #---------------------------------------------------------------------------
975 # Configuration::additions related to external references
976 #---------------------------------------------------------------------------
978 # The TAGFILES option can be used to specify one or more tagfiles.
979 # Optionally an initial location of the external documentation
980 # can be added for each tagfile. The format of a tag file without
981 # this location is as follows:
982 # TAGFILES = file1 file2 ...
983 # Adding location for the tag files is done as follows:
984 # TAGFILES = file1=loc1 "file2 = loc2" ...
985 # where "loc1" and "loc2" can be relative or absolute paths or
986 # URLs. If a location is present for each tag, the installdox tool
987 # does not have to be run to correct the links.
988 # Note that each tag file must have a unique name
989 # (where the name does NOT include the path)
990 # If a tag file is not located in the directory in which doxygen
991 # is run, you must also specify the path to the tagfile here.
995 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
996 # a tag file that is based on the input files it reads.
1000 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1001 # in the class index. If set to NO only the inherited external classes
1006 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1007 # in the modules index. If set to NO, only the current project's groups will
1010 EXTERNAL_GROUPS = YES
1012 # The PERL_PATH should be the absolute path and name of the perl script
1013 # interpreter (i.e. the result of `which perl').
1015 PERL_PATH = /usr/bin/perl
1017 #---------------------------------------------------------------------------
1018 # Configuration options related to the dot tool
1019 #---------------------------------------------------------------------------
1021 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1022 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1023 # super classes. Setting the tag to NO turns the diagrams off. Note that this
1024 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1025 # recommended to install and use dot, since it yields more powerful graphs.
1027 CLASS_DIAGRAMS = YES
1029 # If set to YES, the inheritance and collaboration graphs will hide
1030 # inheritance and usage relations if the target is undocumented
1031 # or is not a class.
1033 HIDE_UNDOC_RELATIONS = NO
1035 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1036 # available from the path. This tool is part of Graphviz, a graph visualization
1037 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1038 # have no effect if this option is set to NO (the default)
1042 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1043 # will generate a graph for each documented class showing the direct and
1044 # indirect inheritance relations. Setting this tag to YES will force the
1045 # the CLASS_DIAGRAMS tag to NO.
1049 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1050 # will generate a graph for each documented class showing the direct and
1051 # indirect implementation dependencies (inheritance, containment, and
1052 # class references variables) of the class with other documented classes.
1054 COLLABORATION_GRAPH = YES
1056 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1057 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1062 # If set to YES, the inheritance and collaboration graphs will show the
1063 # relations between templates and their instances.
1065 TEMPLATE_RELATIONS = NO
1067 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1068 # tags are set to YES then doxygen will generate a graph for each documented
1069 # file showing the direct and indirect include dependencies of the file with
1070 # other documented files.
1074 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1075 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1076 # documented header file showing the documented files that directly or
1077 # indirectly include this file.
1079 INCLUDED_BY_GRAPH = YES
1081 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1082 # generate a call dependency graph for every global function or class method.
1083 # Note that enabling this option will significantly increase the time of a run.
1084 # So in most cases it will be better to enable call graphs for selected
1085 # functions only using the \callgraph command.
1089 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1090 # will graphical hierarchy of all classes instead of a textual one.
1092 GRAPHICAL_HIERARCHY = YES
1094 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1095 # generated by dot. Possible values are png, jpg, or gif
1096 # If left blank png will be used.
1098 DOT_IMAGE_FORMAT = png
1100 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1101 # found. If left blank, it is assumed the dot tool can be found on the path.
1105 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1106 # contain dot files that are included in the documentation (see the
1107 # \dotfile command).
1111 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1112 # generate a legend page explaining the meaning of the various boxes and
1113 # arrows in the dot generated graphs.
1115 GENERATE_LEGEND = YES
1117 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1118 # remove the intermediate dot files that are used to generate
1119 # the various graphs.
1123 #---------------------------------------------------------------------------
1124 # Configuration::additions related to the search engine
1125 #---------------------------------------------------------------------------
1127 # The SEARCHENGINE tag specifies whether or not a search engine should be
1128 # used. If set to NO the values of all tags below this one will be ignored.