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 CVS"
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"
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 = NO
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
207 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
208 # will be included in the documentation.
210 EXTRACT_PRIVATE = YES
212 # If the EXTRACT_STATIC tag is set to YES all static members of a file
213 # will be included in the documentation.
217 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
218 # defined locally in source files will be included in the documentation.
219 # If set to NO only classes defined in header files are included.
221 EXTRACT_LOCAL_CLASSES = YES
223 # This flag is only useful for Objective-C code. When set to YES local
224 # methods, which are defined in the implementation section but not in
225 # the interface are included in the documentation.
226 # If set to NO (the default) only methods in the interface are included.
228 EXTRACT_LOCAL_METHODS = NO
230 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
231 # undocumented members of documented classes, files or namespaces.
232 # If set to NO (the default) these members will be included in the
233 # various overviews, but no documentation section is generated.
234 # This option has no effect if EXTRACT_ALL is enabled.
236 HIDE_UNDOC_MEMBERS = NO
238 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
239 # undocumented classes that are normally visible in the class hierarchy.
240 # If set to NO (the default) these classes will be included in the various
241 # overviews. This option has no effect if EXTRACT_ALL is enabled.
243 HIDE_UNDOC_CLASSES = NO
245 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
246 # friend (class|struct|union) declarations.
247 # If set to NO (the default) these declarations will be included in the
250 HIDE_FRIEND_COMPOUNDS = NO
252 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
253 # documentation blocks found inside the body of a function.
254 # If set to NO (the default) these blocks will be appended to the
255 # function's detailed documentation block.
257 HIDE_IN_BODY_DOCS = NO
259 # The INTERNAL_DOCS tag determines if documentation
260 # that is typed after a \internal command is included. If the tag is set
261 # to NO (the default) then the documentation will be excluded.
262 # Set it to YES to include the internal documentation.
266 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
267 # file names in lower-case letters. If set to YES upper-case letters are also
268 # allowed. This is useful if you have classes or files whose names only differ
269 # in case and if your file system supports case sensitive file names. Windows
270 # and Mac users are advised to set this option to NO.
272 CASE_SENSE_NAMES = YES
274 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
275 # will show members with their full class and namespace scopes in the
276 # documentation. If set to YES the scope will be hidden.
278 HIDE_SCOPE_NAMES = NO
280 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
281 # will put a list of the files that are included by a file in the documentation
284 SHOW_INCLUDE_FILES = YES
286 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
287 # is inserted in the documentation for inline members.
291 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
292 # will sort the (detailed) documentation of file and class members
293 # alphabetically by member name. If set to NO the members will appear in
296 SORT_MEMBER_DOCS = NO
298 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
299 # brief documentation of file, namespace and class members alphabetically
300 # by member name. If set to NO (the default) the members will appear in
305 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
306 # sorted by fully-qualified names, including namespaces. If set to
307 # NO (the default), the class list will be sorted only by class name,
308 # not including the namespace part.
309 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
310 # Note: This option applies only to the class list, not to the
313 SORT_BY_SCOPE_NAME = NO
315 # The GENERATE_TODOLIST tag can be used to enable (YES) or
316 # disable (NO) the todo list. This list is created by putting \todo
317 # commands in the documentation.
319 GENERATE_TODOLIST = YES
321 # The GENERATE_TESTLIST tag can be used to enable (YES) or
322 # disable (NO) the test list. This list is created by putting \test
323 # commands in the documentation.
325 GENERATE_TESTLIST = YES
327 # The GENERATE_BUGLIST tag can be used to enable (YES) or
328 # disable (NO) the bug list. This list is created by putting \bug
329 # commands in the documentation.
331 GENERATE_BUGLIST = YES
333 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
334 # disable (NO) the deprecated list. This list is created by putting
335 # \deprecated commands in the documentation.
337 GENERATE_DEPRECATEDLIST= YES
339 # The ENABLED_SECTIONS tag can be used to enable conditional
340 # documentation sections, marked by \if sectionname ... \endif.
344 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
345 # the initial value of a variable or define consists of for it to appear in
346 # the documentation. If the initializer consists of more lines than specified
347 # here it will be hidden. Use a value of 0 to hide initializers completely.
348 # The appearance of the initializer of individual variables and defines in the
349 # documentation can be controlled using \showinitializer or \hideinitializer
350 # command in the documentation regardless of this setting.
352 MAX_INITIALIZER_LINES = 30
354 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
355 # at the bottom of the documentation of classes and structs. If set to YES the
356 # list will mention the files that were used to generate the documentation.
358 SHOW_USED_FILES = YES
360 # If the sources in your project are distributed over multiple directories
361 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
362 # in the documentation.
364 SHOW_DIRECTORIES = NO
366 #---------------------------------------------------------------------------
367 # configuration options related to warning and progress messages
368 #---------------------------------------------------------------------------
370 # The QUIET tag can be used to turn on/off the messages that are generated
371 # by doxygen. Possible values are YES and NO. If left blank NO is used.
375 # The WARNINGS tag can be used to turn on/off the warning messages that are
376 # generated by doxygen. Possible values are YES and NO. If left blank
381 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
382 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
383 # automatically be disabled.
385 WARN_IF_UNDOCUMENTED = YES
387 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
388 # potential errors in the documentation, such as not documenting some
389 # parameters in a documented function, or documenting parameters that
390 # don't exist or using markup commands wrongly.
392 WARN_IF_DOC_ERROR = YES
394 # The WARN_FORMAT tag determines the format of the warning messages that
395 # doxygen can produce. The string should contain the $file, $line, and $text
396 # tags, which will be replaced by the file and line number from which the
397 # warning originated and the warning text.
399 WARN_FORMAT = "$file:$line: $text"
401 # The WARN_LOGFILE tag can be used to specify a file to which warning
402 # and error messages should be written. If left blank the output is written
407 #---------------------------------------------------------------------------
408 # configuration options related to the input files
409 #---------------------------------------------------------------------------
411 # The INPUT tag can be used to specify the files and/or directories that contain
412 # documented source files. You may enter file names like "myfile.cpp" or
413 # directories like "/usr/src/myproject". Separate the files or directories
416 INPUT = . ../STEER ../EVGEN
418 # If the value of the INPUT tag contains directories, you can use the
419 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
420 # and *.h) to filter out the source-files in the directories. If left
421 # blank the following patterns are tested:
422 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
423 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
425 FILE_PATTERNS = *.h *.cxx *.icc
427 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
428 # should be searched for input files as well. Possible values are YES and NO.
429 # If left blank NO is used.
433 # The EXCLUDE tag can be used to specify files and/or directories that should
434 # excluded from the INPUT source files. This way you can easily exclude a
435 # subdirectory from a directory tree whose root is specified with the INPUT tag.
437 EXCLUDE = tgt_linux mapping.new mapping.fromLaurent.0 untar
439 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
440 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
442 EXCLUDE_SYMLINKS = NO
444 # If the value of the INPUT tag contains directories, you can use the
445 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
446 # certain files from those directories.
448 EXCLUDE_PATTERNS = "G__*"
450 # The EXAMPLE_PATH tag can be used to specify one or more files or
451 # directories that contain example code fragments that are included (see
452 # the \include command).
456 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
457 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
458 # and *.h) to filter out the source-files in the directories. If left
459 # blank all files are included.
463 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
464 # searched for input files to be used with the \include or \dontinclude
465 # commands irrespective of the value of the RECURSIVE tag.
466 # Possible values are YES and NO. If left blank NO is used.
468 EXAMPLE_RECURSIVE = NO
470 # The IMAGE_PATH tag can be used to specify one or more files or
471 # directories that contain image that are included in the documentation (see
472 # the \image command).
476 # The INPUT_FILTER tag can be used to specify a program that doxygen should
477 # invoke to filter for each input file. Doxygen will invoke the filter program
478 # by executing (via popen()) the command <filter> <input-file>, where <filter>
479 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
480 # input file. Doxygen will then use the output that the filter program writes
481 # to standard output. If FILTER_PATTERNS is specified, this tag will be
486 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
487 # basis. Doxygen will compare the file name with each pattern and apply the
488 # filter if there is a match. The filters are a list of the form:
489 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
490 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
491 # is applied to all files.
495 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
496 # INPUT_FILTER) will be used to filter the input files when producing source
497 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
499 FILTER_SOURCE_FILES = NO
501 #---------------------------------------------------------------------------
502 # configuration options related to source browsing
503 #---------------------------------------------------------------------------
505 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
506 # be generated. Documented entities will be cross-referenced with these sources.
507 # Note: To get rid of all source code in the generated output, make sure also
508 # VERBATIM_HEADERS is set to NO.
512 # Setting the INLINE_SOURCES tag to YES will include the body
513 # of functions and classes directly in the documentation.
517 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
518 # doxygen to hide any special comment blocks from generated source code
519 # fragments. Normal C and C++ comments will always remain visible.
521 STRIP_CODE_COMMENTS = NO
523 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
524 # then for each documented function all documented
525 # functions referencing it will be listed.
527 REFERENCED_BY_RELATION = YES
529 # If the REFERENCES_RELATION tag is set to YES (the default)
530 # then for each documented function all documented entities
531 # called/used by that function will be listed.
533 REFERENCES_RELATION = YES
535 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
536 # will generate a verbatim copy of the header file for each class for
537 # which an include is specified. Set to NO to disable this.
539 VERBATIM_HEADERS = NO
541 #---------------------------------------------------------------------------
542 # configuration options related to the alphabetical class index
543 #---------------------------------------------------------------------------
545 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
546 # of all compounds will be generated. Enable this if the project
547 # contains a lot of classes, structs, unions or interfaces.
549 ALPHABETICAL_INDEX = YES
551 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
552 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
553 # in which this list will be split (can be a number in the range [1..20])
555 COLS_IN_ALPHA_INDEX = 2
557 # In case all classes in a project start with a common prefix, all
558 # classes will be put under the same header in the alphabetical index.
559 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
560 # should be ignored while generating the index headers.
562 IGNORE_PREFIX = AliMUON AliMp Ali
564 #---------------------------------------------------------------------------
565 # configuration options related to the HTML output
566 #---------------------------------------------------------------------------
568 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
569 # generate HTML output.
573 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
574 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
575 # put in front of it. If left blank `html' will be used as the default path.
579 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
580 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
581 # doxygen will generate files with .html extension.
583 HTML_FILE_EXTENSION = .html
585 # The HTML_HEADER tag can be used to specify a personal HTML header for
586 # each generated HTML page. If it is left blank doxygen will generate a
591 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
592 # each generated HTML page. If it is left blank doxygen will generate a
597 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
598 # style sheet that is used by each HTML page. It can be used to
599 # fine-tune the look of the HTML output. If the tag is left blank doxygen
600 # will generate a default style sheet. Note that doxygen will try to copy
601 # the style sheet file to the HTML output directory, so don't put your own
602 # stylesheet in the HTML output directory as well, or it will be erased!
606 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
607 # files or namespaces will be aligned in HTML using tables. If set to
608 # NO a bullet list will be used.
610 HTML_ALIGN_MEMBERS = YES
612 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
613 # will be generated that can be used as input for tools like the
614 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
615 # of the generated HTML documentation.
617 GENERATE_HTMLHELP = NO
619 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
620 # be used to specify the file name of the resulting .chm file. You
621 # can add a path in front of the file if the result should not be
622 # written to the html output directory.
626 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
627 # be used to specify the location (absolute path including file name) of
628 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
629 # the HTML help compiler on the generated index.hhp.
633 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
634 # controls if a separate .chi index file is generated (YES) or that
635 # it should be included in the master .chm file (NO).
639 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
640 # controls whether a binary table of contents is generated (YES) or a
641 # normal table of contents (NO) in the .chm file.
645 # The TOC_EXPAND flag can be set to YES to add extra items for group members
646 # to the contents of the HTML help documentation and to the tree view.
650 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
651 # top of each HTML page. The value NO (the default) enables the index and
652 # the value YES disables it.
656 # This tag can be used to set the number of enum values (range [1..20])
657 # that doxygen will group on one line in the generated HTML documentation.
659 ENUM_VALUES_PER_LINE = 4
661 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
662 # generated containing a tree-like index structure (just like the one that
663 # is generated for HTML Help). For this to work a browser that supports
664 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
665 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
666 # probably better off using the HTML help feature.
668 GENERATE_TREEVIEW = NO
670 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
671 # used to set the initial width (in pixels) of the frame in which the tree
676 #---------------------------------------------------------------------------
677 # configuration options related to the LaTeX output
678 #---------------------------------------------------------------------------
680 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
681 # generate Latex output.
685 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
686 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
687 # put in front of it. If left blank `latex' will be used as the default path.
691 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
692 # invoked. If left blank `latex' will be used as the default command name.
694 LATEX_CMD_NAME = latex
696 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
697 # generate index for LaTeX. If left blank `makeindex' will be used as the
698 # default command name.
700 MAKEINDEX_CMD_NAME = makeindex
702 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
703 # LaTeX documents. This may be useful for small projects and may help to
704 # save some trees in general.
708 # The PAPER_TYPE tag can be used to set the paper type that is used
709 # by the printer. Possible values are: a4, a4wide, letter, legal and
710 # executive. If left blank a4wide will be used.
714 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
715 # packages that should be included in the LaTeX output.
719 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
720 # the generated latex document. The header should contain everything until
721 # the first chapter. If it is left blank doxygen will generate a
722 # standard header. Notice: only use this tag if you know what you are doing!
726 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
727 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
728 # contain links (just like the HTML output) instead of page references
729 # This makes the output suitable for online browsing using a pdf viewer.
733 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
734 # plain latex in the generated Makefile. Set this option to YES to get a
735 # higher quality PDF documentation.
739 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
740 # command to the generated LaTeX files. This will instruct LaTeX to keep
741 # running if errors occur, instead of asking the user for help.
742 # This option is also used when generating formulas in HTML.
746 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
747 # include the index chapters (such as File Index, Compound Index, etc.)
750 LATEX_HIDE_INDICES = NO
752 #---------------------------------------------------------------------------
753 # configuration options related to the RTF output
754 #---------------------------------------------------------------------------
756 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
757 # The RTF output is optimized for Word 97 and may not look very pretty with
758 # other RTF readers or editors.
762 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
763 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
764 # put in front of it. If left blank `rtf' will be used as the default path.
768 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
769 # RTF documents. This may be useful for small projects and may help to
770 # save some trees in general.
774 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
775 # will contain hyperlink fields. The RTF file will
776 # contain links (just like the HTML output) instead of page references.
777 # This makes the output suitable for online browsing using WORD or other
778 # programs which support those fields.
779 # Note: wordpad (write) and others do not support links.
783 # Load stylesheet definitions from file. Syntax is similar to doxygen's
784 # config file, i.e. a series of assignments. You only have to provide
785 # replacements, missing definitions are set to their default value.
787 RTF_STYLESHEET_FILE =
789 # Set optional variables used in the generation of an rtf document.
790 # Syntax is similar to doxygen's config file.
792 RTF_EXTENSIONS_FILE =
794 #---------------------------------------------------------------------------
795 # configuration options related to the man page output
796 #---------------------------------------------------------------------------
798 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
803 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
804 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
805 # put in front of it. If left blank `man' will be used as the default path.
809 # The MAN_EXTENSION tag determines the extension that is added to
810 # the generated man pages (default is the subroutine's section .3)
814 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
815 # then it will generate one additional man file for each entity
816 # documented in the real man page(s). These additional files
817 # only source the real man page, but without them the man command
818 # would be unable to find the correct page. The default is NO.
822 #---------------------------------------------------------------------------
823 # configuration options related to the XML output
824 #---------------------------------------------------------------------------
826 # If the GENERATE_XML tag is set to YES Doxygen will
827 # generate an XML file that captures the structure of
828 # the code including all documentation.
832 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
833 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
834 # put in front of it. If left blank `xml' will be used as the default path.
838 # The XML_SCHEMA tag can be used to specify an XML schema,
839 # which can be used by a validating XML parser to check the
840 # syntax of the XML files.
844 # The XML_DTD tag can be used to specify an XML DTD,
845 # which can be used by a validating XML parser to check the
846 # syntax of the XML files.
850 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
851 # dump the program listings (including syntax highlighting
852 # and cross-referencing information) to the XML output. Note that
853 # enabling this will significantly increase the size of the XML output.
855 XML_PROGRAMLISTING = YES
857 #---------------------------------------------------------------------------
858 # configuration options for the AutoGen Definitions output
859 #---------------------------------------------------------------------------
861 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
862 # generate an AutoGen Definitions (see autogen.sf.net) file
863 # that captures the structure of the code including all
864 # documentation. Note that this feature is still experimental
865 # and incomplete at the moment.
867 GENERATE_AUTOGEN_DEF = NO
869 #---------------------------------------------------------------------------
870 # configuration options related to the Perl module output
871 #---------------------------------------------------------------------------
873 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
874 # generate a Perl module file that captures the structure of
875 # the code including all documentation. Note that this
876 # feature is still experimental and incomplete at the
879 GENERATE_PERLMOD = NO
881 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
882 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
883 # to generate PDF and DVI output from the Perl module output.
887 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
888 # nicely formatted so it can be parsed by a human reader. This is useful
889 # if you want to understand what is going on. On the other hand, if this
890 # tag is set to NO the size of the Perl module output will be much smaller
891 # and Perl will parse it just the same.
895 # The names of the make variables in the generated doxyrules.make file
896 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
897 # This is useful so different doxyrules.make files included by the same
898 # Makefile don't overwrite each other's variables.
900 PERLMOD_MAKEVAR_PREFIX =
902 #---------------------------------------------------------------------------
903 # Configuration options related to the preprocessor
904 #---------------------------------------------------------------------------
906 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
907 # evaluate all C-preprocessor directives found in the sources and include
910 ENABLE_PREPROCESSING = YES
912 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
913 # names in the source code. If set to NO (the default) only conditional
914 # compilation will be performed. Macro expansion can be done in a controlled
915 # way by setting EXPAND_ONLY_PREDEF to YES.
919 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
920 # then the macro expansion is limited to the macros specified with the
921 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
923 EXPAND_ONLY_PREDEF = NO
925 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
926 # in the INCLUDE_PATH (see below) will be search if a #include is found.
928 SEARCH_INCLUDES = YES
930 # The INCLUDE_PATH tag can be used to specify one or more directories that
931 # contain include files that are not input files but should be processed by
936 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
937 # patterns (like *.h and *.hpp) to filter out the header-files in the
938 # directories. If left blank, the patterns specified with FILE_PATTERNS will
941 INCLUDE_FILE_PATTERNS =
943 # The PREDEFINED tag can be used to specify one or more macro names that
944 # are defined before the preprocessor is started (similar to the -D option of
945 # gcc). The argument of the tag is a list of macros of the form: name
946 # or name=definition (no spaces). If the definition and the = are
947 # omitted =1 is assumed. To prevent a macro definition from being
948 # undefined via #undef or recursively expanded use the := operator
949 # instead of the = operator.
953 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
954 # this tag can be used to specify a list of macro names that should be expanded.
955 # The macro definition that is found in the sources will be used.
956 # Use the PREDEFINED tag if you want to use a different macro definition.
960 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
961 # doxygen's preprocessor will remove all function-like macros that are alone
962 # on a line, have an all uppercase name, and do not end with a semicolon. Such
963 # function macros are typically used for boiler-plate code, and will confuse the
964 # parser if not removed.
966 SKIP_FUNCTION_MACROS = YES
968 #---------------------------------------------------------------------------
969 # Configuration::additions related to external references
970 #---------------------------------------------------------------------------
972 # The TAGFILES option can be used to specify one or more tagfiles.
973 # Optionally an initial location of the external documentation
974 # can be added for each tagfile. The format of a tag file without
975 # this location is as follows:
976 # TAGFILES = file1 file2 ...
977 # Adding location for the tag files is done as follows:
978 # TAGFILES = file1=loc1 "file2 = loc2" ...
979 # where "loc1" and "loc2" can be relative or absolute paths or
980 # URLs. If a location is present for each tag, the installdox tool
981 # does not have to be run to correct the links.
982 # Note that each tag file must have a unique name
983 # (where the name does NOT include the path)
984 # If a tag file is not located in the directory in which doxygen
985 # is run, you must also specify the path to the tagfile here.
989 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
990 # a tag file that is based on the input files it reads.
994 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
995 # in the class index. If set to NO only the inherited external classes
1000 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1001 # in the modules index. If set to NO, only the current project's groups will
1004 EXTERNAL_GROUPS = YES
1006 # The PERL_PATH should be the absolute path and name of the perl script
1007 # interpreter (i.e. the result of `which perl').
1009 PERL_PATH = /usr/bin/perl
1011 #---------------------------------------------------------------------------
1012 # Configuration options related to the dot tool
1013 #---------------------------------------------------------------------------
1015 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1016 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1017 # super classes. Setting the tag to NO turns the diagrams off. Note that this
1018 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1019 # recommended to install and use dot, since it yields more powerful graphs.
1021 CLASS_DIAGRAMS = YES
1023 # If set to YES, the inheritance and collaboration graphs will hide
1024 # inheritance and usage relations if the target is undocumented
1025 # or is not a class.
1027 HIDE_UNDOC_RELATIONS = NO
1029 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1030 # available from the path. This tool is part of Graphviz, a graph visualization
1031 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1032 # have no effect if this option is set to NO (the default)
1036 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1037 # will generate a graph for each documented class showing the direct and
1038 # indirect inheritance relations. Setting this tag to YES will force the
1039 # the CLASS_DIAGRAMS tag to NO.
1043 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1044 # will generate a graph for each documented class showing the direct and
1045 # indirect implementation dependencies (inheritance, containment, and
1046 # class references variables) of the class with other documented classes.
1048 COLLABORATION_GRAPH = YES
1050 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1051 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1056 # If set to YES, the inheritance and collaboration graphs will show the
1057 # relations between templates and their instances.
1059 TEMPLATE_RELATIONS = NO
1061 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1062 # tags are set to YES then doxygen will generate a graph for each documented
1063 # file showing the direct and indirect include dependencies of the file with
1064 # other documented files.
1068 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1069 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1070 # documented header file showing the documented files that directly or
1071 # indirectly include this file.
1073 INCLUDED_BY_GRAPH = YES
1075 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1076 # generate a call dependency graph for every global function or class method.
1077 # Note that enabling this option will significantly increase the time of a run.
1078 # So in most cases it will be better to enable call graphs for selected
1079 # functions only using the \callgraph command.
1083 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1084 # will graphical hierarchy of all classes instead of a textual one.
1086 GRAPHICAL_HIERARCHY = YES
1088 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1089 # generated by dot. Possible values are png, jpg, or gif
1090 # If left blank png will be used.
1092 DOT_IMAGE_FORMAT = png
1094 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1095 # found. If left blank, it is assumed the dot tool can be found on the path.
1099 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1100 # contain dot files that are included in the documentation (see the
1101 # \dotfile command).
1105 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1106 # generate a legend page explaining the meaning of the various boxes and
1107 # arrows in the dot generated graphs.
1109 GENERATE_LEGEND = YES
1111 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1112 # remove the intermediate dot files that are used to generate
1113 # the various graphs.
1117 #---------------------------------------------------------------------------
1118 # Configuration::additions related to the search engine
1119 #---------------------------------------------------------------------------
1121 # The SEARCHENGINE tag specifies whether or not a search engine should be
1122 # used. If set to NO the values of all tags below this one will be ignored.