Doc fixes
[u/mrichter/AliRoot.git] / PWG2 / FORWARD / doc / Doxyfile
CommitLineData
9d8b0427 1# Doxyfile 1.6.3
655b45b0 2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project
5#
6# All text after a hash (#) is considered a comment and will be ignored
7# The format is:
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 (" ")
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
17# This tag specifies the encoding used for all characters in the config file
18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
25# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26# by quotes) that should identify the project.
27
28PROJECT_NAME = "PWG2 Forward Mulitplicity Analysis"
29
30# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31# This could be handy for archiving the generated documentation or
32# if some version control system is used.
33
34PROJECT_NUMBER = 0.1
35
36# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37# base path where the generated documentation will be put.
38# If a relative path is entered, it will be relative to the location
39# where doxygen was started. If left blank the current directory will be used.
40
41OUTPUT_DIRECTORY =
42
43# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44# 4096 sub-directories (in 2 levels) under the output directory of each output
45# format and will distribute the generated files over these directories.
46# Enabling this option can be useful when feeding doxygen a huge amount of
47# source files, where putting all generated files in the same directory would
48# otherwise cause performance problems for the file system.
49
50CREATE_SUBDIRS = NO
51
52# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53# documentation generated by doxygen is written. Doxygen will use this
54# information to generate all constant output in the proper language.
55# The default language is English, other supported languages are:
56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
9d8b0427 57# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
655b45b0 62
63OUTPUT_LANGUAGE = English
64
65# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66# include brief member descriptions after the members that are listed in
67# the file and class documentation (similar to JavaDoc).
68# Set to NO to disable this.
69
70BRIEF_MEMBER_DESC = YES
71
72# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73# the brief description of a member or function before the detailed description.
74# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75# brief descriptions will be completely suppressed.
76
77REPEAT_BRIEF = YES
78
79# This tag implements a quasi-intelligent brief description abbreviator
80# that is used to form the text in various listings. Each string
81# in this list, if found as the leading text of the brief description, will be
82# stripped from the text and the result after processing the whole list, is
83# used as the annotated text. Otherwise, the brief description is used as-is.
84# If left blank, the following values are used ("$name" is automatically
85# replaced with the name of the entity): "The $name class" "The $name widget"
86# "The $name file" "is" "provides" "specifies" "contains"
87# "represents" "a" "an" "the"
88
89ABBREVIATE_BRIEF = "The $name class" \
90 "The $name widget" \
91 "The $name file" \
92 is \
93 provides \
94 specifies \
95 contains \
96 represents \
97 a \
98 an \
99 the
100
101# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102# Doxygen will generate a detailed section even if there is only a brief
103# description.
104
105ALWAYS_DETAILED_SEC = YES
106
107# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108# inherited members of a class in the documentation of that class as if those
109# members were ordinary class members. Constructors, destructors and assignment
110# operators of the base classes will not be shown.
111
112INLINE_INHERITED_MEMB = NO
113
114# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115# path before files name in the file list and in the header files. If set
116# to NO the shortest path that makes the file name unique will be used.
117
118FULL_PATH_NAMES = YES
119
120# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121# can be used to strip a user-defined part of the path. Stripping is
122# only done if one of the specified strings matches the left-hand part of
123# the path. The tag can be used to show relative paths in the file list.
124# If left blank the directory from which doxygen is run is used as the
125# path to strip.
126
127STRIP_FROM_PATH = /home/cholm/alice/aliroot.trunk/
128
129# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130# the path mentioned in the documentation of a class, which tells
131# the reader which header file to include in order to use a class.
132# If left blank only the name of the header file containing the class
133# definition is used. Otherwise one should specify the include paths that
134# are normally passed to the compiler using the -I flag.
135
136STRIP_FROM_INC_PATH = /home/cholm/alice/aliroot.trunk/
137
138# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139# (but less readable) file names. This can be useful is your file systems
140# doesn't support long names like on DOS, Mac, or CD-ROM.
141
142SHORT_NAMES = NO
143
144# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
145# will interpret the first line (until the first dot) of a JavaDoc-style
146# comment as the brief description. If set to NO, the JavaDoc
147# comments will behave just like regular Qt-style comments
148# (thus requiring an explicit @brief command for a brief description.)
149
150JAVADOC_AUTOBRIEF = YES
151
152# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
153# interpret the first line (until the first dot) of a Qt-style
154# comment as the brief description. If set to NO, the comments
155# will behave just like regular Qt-style comments (thus requiring
156# an explicit \brief command for a brief description.)
157
158QT_AUTOBRIEF = NO
159
160# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
161# treat a multi-line C++ special comment block (i.e. a block of //! or ///
162# comments) as a brief description. This used to be the default behaviour.
163# The new default is to treat a multi-line C++ comment block as a detailed
164# description. Set this tag to YES if you prefer the old behaviour instead.
165
166MULTILINE_CPP_IS_BRIEF = NO
167
168# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
169# member inherits the documentation from any documented member that it
170# re-implements.
171
172INHERIT_DOCS = YES
173
174# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175# a new page for each member. If set to NO, the documentation of a member will
176# be part of the file/class/namespace that contains it.
177
178SEPARATE_MEMBER_PAGES = NO
179
180# The TAB_SIZE tag can be used to set the number of spaces in a tab.
181# Doxygen uses this value to replace tabs by spaces in code fragments.
182
183TAB_SIZE = 2
184
185# This tag can be used to specify a number of aliases that acts
186# as commands in the documentation. An alias has the form "name=value".
187# For example adding "sideeffect=\par Side Effects:\n" will allow you to
188# put the command \sideeffect (or @sideeffect) in the documentation, which
189# will result in a user-defined paragraph with heading "Side Effects:".
190# You can put \n's in the value part of an alias to insert newlines.
191
192ALIASES =
193
194# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
195# sources only. Doxygen will then generate output that is more tailored for C.
196# For instance, some of the names that are used will be different. The list
197# of all members will be omitted, etc.
198
199OPTIMIZE_OUTPUT_FOR_C = NO
200
201# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
202# sources only. Doxygen will then generate output that is more tailored for
203# Java. For instance, namespaces will be presented as packages, qualified
204# scopes will look different, etc.
205
206OPTIMIZE_OUTPUT_JAVA = NO
207
208# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
209# sources only. Doxygen will then generate output that is more tailored for
210# Fortran.
211
212OPTIMIZE_FOR_FORTRAN = NO
213
214# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
215# sources. Doxygen will then generate output that is tailored for
216# VHDL.
217
218OPTIMIZE_OUTPUT_VHDL = NO
219
220# Doxygen selects the parser to use depending on the extension of the files it parses.
221# With this tag you can assign which parser to use for a given extension.
222# Doxygen has a built-in mapping, but you can override or extend it using this tag.
223# The format is ext=language, where ext is a file extension, and language is one of
224# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
225# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
226# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
9d8b0427 227# use: inc=Fortran f=C. Note that for custom extensions you also need to set
228# FILE_PATTERNS otherwise the files are not read by doxygen.
655b45b0 229
230EXTENSION_MAPPING =
231
232# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
233# to include (a tag file for) the STL sources as input, then you should
234# set this tag to YES in order to let doxygen match functions declarations and
235# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
236# func(std::string) {}). This also make the inheritance and collaboration
237# diagrams that involve STL classes more complete and accurate.
238
239BUILTIN_STL_SUPPORT = NO
240
241# If you use Microsoft's C++/CLI language, you should set this option to YES to
242# enable parsing support.
243
244CPP_CLI_SUPPORT = NO
245
246# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
247# Doxygen will parse them like normal C++ but will assume all classes use public
248# instead of private inheritance when no explicit protection keyword is present.
249
250SIP_SUPPORT = NO
251
252# For Microsoft's IDL there are propget and propput attributes to indicate getter
253# and setter methods for a property. Setting this option to YES (the default)
254# will make doxygen to replace the get and set methods by a property in the
255# documentation. This will only work if the methods are indeed getting or
256# setting a simple type. If this is not the case, or you want to show the
257# methods anyway, you should set this option to NO.
258
259IDL_PROPERTY_SUPPORT = YES
260
261# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
262# tag is set to YES, then doxygen will reuse the documentation of the first
263# member in the group (if any) for the other members of the group. By default
264# all members of a group must be documented explicitly.
265
266DISTRIBUTE_GROUP_DOC = NO
267
268# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
269# the same type (for instance a group of public functions) to be put as a
270# subgroup of that type (e.g. under the Public Functions section). Set it to
271# NO to prevent subgrouping. Alternatively, this can be done per class using
272# the \nosubgrouping command.
273
274SUBGROUPING = YES
275
276# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
277# is documented as struct, union, or enum with the name of the typedef. So
278# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
279# with name TypeT. When disabled the typedef will appear as a member of a file,
280# namespace, or class. And the struct will be named TypeS. This can typically
281# be useful for C code in case the coding convention dictates that all compound
282# types are typedef'ed and only the typedef is referenced, never the tag name.
283
284TYPEDEF_HIDES_STRUCT = NO
285
286# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
287# determine which symbols to keep in memory and which to flush to disk.
288# When the cache is full, less often used symbols will be written to disk.
289# For small to medium size projects (<1000 input files) the default value is
290# probably good enough. For larger projects a too small cache size can cause
291# doxygen to be busy swapping symbols to and from disk most of the time
292# causing a significant performance penality.
293# If the system has enough physical memory increasing the cache will improve the
294# performance by keeping more symbols in memory. Note that the value works on
295# a logarithmic scale so increasing the size by one will rougly double the
296# memory usage. The cache size is given by this formula:
297# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
298# corresponding to a cache size of 2^16 = 65536 symbols
299
300SYMBOL_CACHE_SIZE = 0
301
302#---------------------------------------------------------------------------
303# Build related configuration options
304#---------------------------------------------------------------------------
305
306# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
307# documentation are documented, even if no documentation was available.
308# Private class members and static file members will be hidden unless
309# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
310
311EXTRACT_ALL = YES
312
313# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
314# will be included in the documentation.
315
9d8b0427 316EXTRACT_PRIVATE = YES
655b45b0 317
318# If the EXTRACT_STATIC tag is set to YES all static members of a file
319# will be included in the documentation.
320
321EXTRACT_STATIC = NO
322
323# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
324# defined locally in source files will be included in the documentation.
325# If set to NO only classes defined in header files are included.
326
327EXTRACT_LOCAL_CLASSES = YES
328
329# This flag is only useful for Objective-C code. When set to YES local
330# methods, which are defined in the implementation section but not in
331# the interface are included in the documentation.
332# If set to NO (the default) only methods in the interface are included.
333
334EXTRACT_LOCAL_METHODS = NO
335
336# If this flag is set to YES, the members of anonymous namespaces will be
337# extracted and appear in the documentation as a namespace called
338# 'anonymous_namespace{file}', where file will be replaced with the base
339# name of the file that contains the anonymous namespace. By default
340# anonymous namespace are hidden.
341
342EXTRACT_ANON_NSPACES = NO
343
344# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
345# undocumented members of documented classes, files or namespaces.
346# If set to NO (the default) these members will be included in the
347# various overviews, but no documentation section is generated.
348# This option has no effect if EXTRACT_ALL is enabled.
349
350HIDE_UNDOC_MEMBERS = NO
351
352# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
353# undocumented classes that are normally visible in the class hierarchy.
354# If set to NO (the default) these classes will be included in the various
355# overviews. This option has no effect if EXTRACT_ALL is enabled.
356
357HIDE_UNDOC_CLASSES = NO
358
359# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
360# friend (class|struct|union) declarations.
361# If set to NO (the default) these declarations will be included in the
362# documentation.
363
364HIDE_FRIEND_COMPOUNDS = NO
365
366# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
367# documentation blocks found inside the body of a function.
368# If set to NO (the default) these blocks will be appended to the
369# function's detailed documentation block.
370
371HIDE_IN_BODY_DOCS = NO
372
373# The INTERNAL_DOCS tag determines if documentation
374# that is typed after a \internal command is included. If the tag is set
375# to NO (the default) then the documentation will be excluded.
376# Set it to YES to include the internal documentation.
377
378INTERNAL_DOCS = NO
379
380# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
381# file names in lower-case letters. If set to YES upper-case letters are also
382# allowed. This is useful if you have classes or files whose names only differ
383# in case and if your file system supports case sensitive file names. Windows
384# and Mac users are advised to set this option to NO.
385
386CASE_SENSE_NAMES = NO
387
388# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
389# will show members with their full class and namespace scopes in the
390# documentation. If set to YES the scope will be hidden.
391
392HIDE_SCOPE_NAMES = NO
393
394# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
395# will put a list of the files that are included by a file in the documentation
396# of that file.
397
398SHOW_INCLUDE_FILES = YES
399
9d8b0427 400# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
401# will list include files with double quotes in the documentation
402# rather than with sharp brackets.
403
404FORCE_LOCAL_INCLUDES = NO
405
655b45b0 406# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
407# is inserted in the documentation for inline members.
408
409INLINE_INFO = YES
410
411# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
412# will sort the (detailed) documentation of file and class members
413# alphabetically by member name. If set to NO the members will appear in
414# declaration order.
415
416SORT_MEMBER_DOCS = YES
417
418# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
419# brief documentation of file, namespace and class members alphabetically
420# by member name. If set to NO (the default) the members will appear in
421# declaration order.
422
423SORT_BRIEF_DOCS = NO
424
9d8b0427 425# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
426# will sort the (brief and detailed) documentation of class members so that
427# constructors and destructors are listed first. If set to NO (the default)
428# the constructors will appear in the respective orders defined by
429# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
430# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
431# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
432
433SORT_MEMBERS_CTORS_1ST = YES
434
655b45b0 435# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
436# hierarchy of group names into alphabetical order. If set to NO (the default)
437# the group names will appear in their defined order.
438
439SORT_GROUP_NAMES = NO
440
441# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
442# sorted by fully-qualified names, including namespaces. If set to
443# NO (the default), the class list will be sorted only by class name,
444# not including the namespace part.
445# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
446# Note: This option applies only to the class list, not to the
447# alphabetical list.
448
449SORT_BY_SCOPE_NAME = NO
450
451# The GENERATE_TODOLIST tag can be used to enable (YES) or
452# disable (NO) the todo list. This list is created by putting \todo
453# commands in the documentation.
454
455GENERATE_TODOLIST = YES
456
457# The GENERATE_TESTLIST tag can be used to enable (YES) or
458# disable (NO) the test list. This list is created by putting \test
459# commands in the documentation.
460
461GENERATE_TESTLIST = YES
462
463# The GENERATE_BUGLIST tag can be used to enable (YES) or
464# disable (NO) the bug list. This list is created by putting \bug
465# commands in the documentation.
466
467GENERATE_BUGLIST = YES
468
469# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
470# disable (NO) the deprecated list. This list is created by putting
471# \deprecated commands in the documentation.
472
473GENERATE_DEPRECATEDLIST= YES
474
475# The ENABLED_SECTIONS tag can be used to enable conditional
476# documentation sections, marked by \if sectionname ... \endif.
477
478ENABLED_SECTIONS =
479
480# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
481# the initial value of a variable or define consists of for it to appear in
482# the documentation. If the initializer consists of more lines than specified
483# here it will be hidden. Use a value of 0 to hide initializers completely.
484# The appearance of the initializer of individual variables and defines in the
485# documentation can be controlled using \showinitializer or \hideinitializer
486# command in the documentation regardless of this setting.
487
9d8b0427 488MAX_INITIALIZER_LINES = 44
655b45b0 489
490# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
491# at the bottom of the documentation of classes and structs. If set to YES the
492# list will mention the files that were used to generate the documentation.
493
494SHOW_USED_FILES = YES
495
496# If the sources in your project are distributed over multiple directories
497# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
498# in the documentation. The default is NO.
499
500SHOW_DIRECTORIES = NO
501
502# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
503# This will remove the Files entry from the Quick Index and from the
504# Folder Tree View (if specified). The default is YES.
505
506SHOW_FILES = YES
507
508# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
509# Namespaces page. This will remove the Namespaces entry from the Quick Index
510# and from the Folder Tree View (if specified). The default is YES.
511
512SHOW_NAMESPACES = YES
513
514# The FILE_VERSION_FILTER tag can be used to specify a program or script that
515# doxygen should invoke to get the current version for each file (typically from
516# the version control system). Doxygen will invoke the program by executing (via
517# popen()) the command <command> <input-file>, where <command> is the value of
518# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
519# provided by doxygen. Whatever the program writes to standard output
520# is used as the file version. See the manual for examples.
521
522FILE_VERSION_FILTER =
523
524# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
525# doxygen. The layout file controls the global structure of the generated output files
526# in an output format independent way. The create the layout file that represents
527# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
528# file name after the option, if omitted DoxygenLayout.xml will be used as the name
529# of the layout file.
530
531LAYOUT_FILE =
532
533#---------------------------------------------------------------------------
534# configuration options related to warning and progress messages
535#---------------------------------------------------------------------------
536
537# The QUIET tag can be used to turn on/off the messages that are generated
538# by doxygen. Possible values are YES and NO. If left blank NO is used.
539
540QUIET = YES
541
542# The WARNINGS tag can be used to turn on/off the warning messages that are
543# generated by doxygen. Possible values are YES and NO. If left blank
544# NO is used.
545
546WARNINGS = YES
547
548# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
549# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
550# automatically be disabled.
551
552WARN_IF_UNDOCUMENTED = YES
553
554# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
555# potential errors in the documentation, such as not documenting some
556# parameters in a documented function, or documenting parameters that
557# don't exist or using markup commands wrongly.
558
559WARN_IF_DOC_ERROR = YES
560
561# This WARN_NO_PARAMDOC option can be abled to get warnings for
562# functions that are documented, but have no documentation for their parameters
563# or return value. If set to NO (the default) doxygen will only warn about
564# wrong or incomplete parameter documentation, but not about the absence of
565# documentation.
566
567WARN_NO_PARAMDOC = NO
568
569# The WARN_FORMAT tag determines the format of the warning messages that
570# doxygen can produce. The string should contain the $file, $line, and $text
571# tags, which will be replaced by the file and line number from which the
572# warning originated and the warning text. Optionally the format may contain
573# $version, which will be replaced by the version of the file (if it could
574# be obtained via FILE_VERSION_FILTER)
575
576WARN_FORMAT = "$file:$line: $text"
577
578# The WARN_LOGFILE tag can be used to specify a file to which warning
579# and error messages should be written. If left blank the output is written
580# to stderr.
581
582WARN_LOGFILE =
583
584#---------------------------------------------------------------------------
585# configuration options related to the input files
586#---------------------------------------------------------------------------
587
588# The INPUT tag can be used to specify the files and/or directories that contain
589# documented source files. You may enter file names like "myfile.cpp" or
590# directories like "/usr/src/myproject". Separate the files or directories
591# with spaces.
592
f390fb84 593INPUT = ../analysis2 \
594 ../analysis2/scripts \
595 ../analysis2/corrs \
596 ../analysis2/qa \
597 ../analysis2/trains
655b45b0 598
599# This tag can be used to specify the character encoding of the source files
600# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
601# also the default input encoding. Doxygen uses libiconv (or the iconv built
602# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
603# the list of possible encodings.
604
605INPUT_ENCODING = UTF-8
606
607# If the value of the INPUT tag contains directories, you can use the
608# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
609# and *.h) to filter out the source-files in the directories. If left
610# blank the following patterns are tested:
611# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
612# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
613
614FILE_PATTERNS = *.cxx \
615 *.C \
616 *.h
617
618# The RECURSIVE tag can be used to turn specify whether or not subdirectories
619# should be searched for input files as well. Possible values are YES and NO.
620# If left blank NO is used.
621
622RECURSIVE = NO
623
624# The EXCLUDE tag can be used to specify files and/or directories that should
625# excluded from the INPUT source files. This way you can easily exclude a
626# subdirectory from a directory tree whose root is specified with the INPUT tag.
627
628EXCLUDE =
629
630# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
631# directories that are symbolic links (a Unix filesystem feature) are excluded
632# from the input.
633
634EXCLUDE_SYMLINKS = NO
635
636# If the value of the INPUT tag contains directories, you can use the
637# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
638# certain files from those directories. Note that the wildcards are matched
639# against the file with absolute path, so to exclude all test directories
640# for example use the pattern */test/*
641
642EXCLUDE_PATTERNS =
643
644# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
645# (namespaces, classes, functions, etc.) that should be excluded from the
646# output. The symbol name can be a fully qualified name, a word, or if the
647# wildcard * is used, a substring. Examples: ANamespace, AClass,
648# AClass::ANamespace, ANamespace::*Test
649
650EXCLUDE_SYMBOLS =
651
652# The EXAMPLE_PATH tag can be used to specify one or more files or
653# directories that contain example code fragments that are included (see
654# the \include command).
655
f390fb84 656EXAMPLE_PATH = ../analysis2 \
657 ../analysis2/scripts \
658 ../analysis2/tests \
659 ../analysis2/qa \
660 ../analysis2/corrs \
661 ../analysis2/trains
655b45b0 662
663# If the value of the EXAMPLE_PATH tag contains directories, you can use the
664# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
665# and *.h) to filter out the source-files in the directories. If left
666# blank all files are included.
667
f390fb84 668EXAMPLE_PATTERNS = *.C \
669 *.h \
670 *.cxx
655b45b0 671
672# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
673# searched for input files to be used with the \include or \dontinclude
674# commands irrespective of the value of the RECURSIVE tag.
675# Possible values are YES and NO. If left blank NO is used.
676
677EXAMPLE_RECURSIVE = NO
678
679# The IMAGE_PATH tag can be used to specify one or more files or
680# directories that contain image that are included in the documentation (see
681# the \image command).
682
683IMAGE_PATH =
684
685# The INPUT_FILTER tag can be used to specify a program that doxygen should
686# invoke to filter for each input file. Doxygen will invoke the filter program
687# by executing (via popen()) the command <filter> <input-file>, where <filter>
688# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
689# input file. Doxygen will then use the output that the filter program writes
690# to standard output. If FILTER_PATTERNS is specified, this tag will be
691# ignored.
692
693INPUT_FILTER =
694
695# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
696# basis. Doxygen will compare the file name with each pattern and apply the
697# filter if there is a match. The filters are a list of the form:
698# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
699# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
700# is applied to all files.
701
702FILTER_PATTERNS =
703
704# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
705# INPUT_FILTER) will be used to filter the input files when producing source
706# files to browse (i.e. when SOURCE_BROWSER is set to YES).
707
708FILTER_SOURCE_FILES = NO
709
710#---------------------------------------------------------------------------
711# configuration options related to source browsing
712#---------------------------------------------------------------------------
713
714# If the SOURCE_BROWSER tag is set to YES then a list of source files will
715# be generated. Documented entities will be cross-referenced with these sources.
716# Note: To get rid of all source code in the generated output, make sure also
717# VERBATIM_HEADERS is set to NO.
718
719SOURCE_BROWSER = YES
720
721# Setting the INLINE_SOURCES tag to YES will include the body
722# of functions and classes directly in the documentation.
723
724INLINE_SOURCES = NO
725
726# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
727# doxygen to hide any special comment blocks from generated source code
728# fragments. Normal C and C++ comments will always remain visible.
729
730STRIP_CODE_COMMENTS = NO
731
732# If the REFERENCED_BY_RELATION tag is set to YES
733# then for each documented function all documented
734# functions referencing it will be listed.
735
736REFERENCED_BY_RELATION = YES
737
738# If the REFERENCES_RELATION tag is set to YES
739# then for each documented function all documented entities
740# called/used by that function will be listed.
741
742REFERENCES_RELATION = YES
743
744# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
745# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
746# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
747# link to the source code. Otherwise they will link to the documentation.
748
749REFERENCES_LINK_SOURCE = YES
750
751# If the USE_HTAGS tag is set to YES then the references to source code
752# will point to the HTML generated by the htags(1) tool instead of doxygen
753# built-in source browser. The htags tool is part of GNU's global source
754# tagging system (see http://www.gnu.org/software/global/global.html). You
755# will need version 4.8.6 or higher.
756
757USE_HTAGS = NO
758
759# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
760# will generate a verbatim copy of the header file for each class for
761# which an include is specified. Set to NO to disable this.
762
f390fb84 763VERBATIM_HEADERS = NO
655b45b0 764
765#---------------------------------------------------------------------------
766# configuration options related to the alphabetical class index
767#---------------------------------------------------------------------------
768
769# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
770# of all compounds will be generated. Enable this if the project
771# contains a lot of classes, structs, unions or interfaces.
772
773ALPHABETICAL_INDEX = YES
774
775# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
776# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
777# in which this list will be split (can be a number in the range [1..20])
778
779COLS_IN_ALPHA_INDEX = 5
780
781# In case all classes in a project start with a common prefix, all
782# classes will be put under the same header in the alphabetical index.
783# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
784# should be ignored while generating the index headers.
785
786IGNORE_PREFIX =
787
788#---------------------------------------------------------------------------
789# configuration options related to the HTML output
790#---------------------------------------------------------------------------
791
792# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
793# generate HTML output.
794
795GENERATE_HTML = YES
796
797# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
798# If a relative path is entered the value of OUTPUT_DIRECTORY will be
799# put in front of it. If left blank `html' will be used as the default path.
800
801HTML_OUTPUT = html
802
803# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
804# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
805# doxygen will generate files with .html extension.
806
807HTML_FILE_EXTENSION = .html
808
809# The HTML_HEADER tag can be used to specify a personal HTML header for
810# each generated HTML page. If it is left blank doxygen will generate a
811# standard header.
812
813HTML_HEADER =
814
815# The HTML_FOOTER tag can be used to specify a personal HTML footer for
816# each generated HTML page. If it is left blank doxygen will generate a
817# standard footer.
818
819HTML_FOOTER =
820
821# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
822# style sheet that is used by each HTML page. It can be used to
823# fine-tune the look of the HTML output. If the tag is left blank doxygen
824# will generate a default style sheet. Note that doxygen will try to copy
825# the style sheet file to the HTML output directory, so don't put your own
826# stylesheet in the HTML output directory as well, or it will be erased!
827
828HTML_STYLESHEET =
829
9d8b0427 830# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
831# page will contain the date and time when the page was generated. Setting
832# this to NO can help when comparing the output of multiple runs.
833
834HTML_TIMESTAMP = YES
835
655b45b0 836# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
837# files or namespaces will be aligned in HTML using tables. If set to
838# NO a bullet list will be used.
839
840HTML_ALIGN_MEMBERS = YES
841
842# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
843# documentation will contain sections that can be hidden and shown after the
844# page has loaded. For this to work a browser that supports
845# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
846# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
847
f390fb84 848HTML_DYNAMIC_SECTIONS = YES
655b45b0 849
850# If the GENERATE_DOCSET tag is set to YES, additional index files
851# will be generated that can be used as input for Apple's Xcode 3
852# integrated development environment, introduced with OSX 10.5 (Leopard).
853# To create a documentation set, doxygen will generate a Makefile in the
854# HTML output directory. Running make will produce the docset in that
855# directory and running "make install" will install the docset in
856# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
857# it at startup.
858# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
859
860GENERATE_DOCSET = NO
861
862# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
863# feed. A documentation feed provides an umbrella under which multiple
864# documentation sets from a single provider (such as a company or product suite)
865# can be grouped.
866
867DOCSET_FEEDNAME = "Doxygen generated docs"
868
869# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
870# should uniquely identify the documentation set bundle. This should be a
871# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
872# will append .docset to the name.
873
874DOCSET_BUNDLE_ID = org.doxygen.Project
875
876# If the GENERATE_HTMLHELP tag is set to YES, additional index files
877# will be generated that can be used as input for tools like the
878# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
879# of the generated HTML documentation.
880
881GENERATE_HTMLHELP = NO
882
883# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
884# be used to specify the file name of the resulting .chm file. You
885# can add a path in front of the file if the result should not be
886# written to the html output directory.
887
888CHM_FILE =
889
890# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
891# be used to specify the location (absolute path including file name) of
892# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
893# the HTML help compiler on the generated index.hhp.
894
895HHC_LOCATION =
896
897# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
898# controls if a separate .chi index file is generated (YES) or that
899# it should be included in the master .chm file (NO).
900
901GENERATE_CHI = NO
902
903# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
904# is used to encode HtmlHelp index (hhk), content (hhc) and project file
905# content.
906
907CHM_INDEX_ENCODING =
908
909# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
910# controls whether a binary table of contents is generated (YES) or a
911# normal table of contents (NO) in the .chm file.
912
913BINARY_TOC = NO
914
915# The TOC_EXPAND flag can be set to YES to add extra items for group members
916# to the contents of the HTML help documentation and to the tree view.
917
918TOC_EXPAND = NO
919
920# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
921# are set, an additional index file will be generated that can be used as input for
922# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
923# HTML documentation.
924
925GENERATE_QHP = NO
926
927# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
928# be used to specify the file name of the resulting .qch file.
929# The path specified is relative to the HTML output folder.
930
931QCH_FILE =
932
933# The QHP_NAMESPACE tag specifies the namespace to use when generating
934# Qt Help Project output. For more information please see
935# http://doc.trolltech.com/qthelpproject.html#namespace
936
9d8b0427 937QHP_NAMESPACE = org.doxygen.Project
655b45b0 938
939# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
940# Qt Help Project output. For more information please see
941# http://doc.trolltech.com/qthelpproject.html#virtual-folders
942
943QHP_VIRTUAL_FOLDER = doc
944
945# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
946# For more information please see
947# http://doc.trolltech.com/qthelpproject.html#custom-filters
948
949QHP_CUST_FILTER_NAME =
950
951# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
952# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
953
954QHP_CUST_FILTER_ATTRS =
955
956# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
957# filter section matches.
958# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
959
960QHP_SECT_FILTER_ATTRS =
961
962# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
963# be used to specify the location of Qt's qhelpgenerator.
964# If non-empty doxygen will try to run qhelpgenerator on the generated
965# .qhp file.
966
967QHG_LOCATION =
968
9d8b0427 969# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
970# will be generated, which together with the HTML files, form an Eclipse help
971# plugin. To install this plugin and make it available under the help contents
972# menu in Eclipse, the contents of the directory containing the HTML and XML
973# files needs to be copied into the plugins directory of eclipse. The name of
974# the directory within the plugins directory should be the same as
975# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
976# the help appears.
977
978GENERATE_ECLIPSEHELP = NO
979
980# A unique identifier for the eclipse help plugin. When installing the plugin
981# the directory name containing the HTML and XML files should also have
982# this name.
983
984ECLIPSE_DOC_ID = org.doxygen.Project
985
655b45b0 986# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
987# top of each HTML page. The value NO (the default) enables the index and
988# the value YES disables it.
989
990DISABLE_INDEX = NO
991
992# This tag can be used to set the number of enum values (range [1..20])
993# that doxygen will group on one line in the generated HTML documentation.
994
995ENUM_VALUES_PER_LINE = 4
996
997# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
998# structure should be generated to display hierarchical information.
9d8b0427 999# If the tag value is set to YES, a side panel will be generated
655b45b0 1000# containing a tree-like index structure (just like the one that
1001# is generated for HTML Help). For this to work a browser that supports
9d8b0427 1002# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1003# Windows users are probably better off using the HTML help feature.
1004
1005GENERATE_TREEVIEW = NO
1006
1007# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1008# and Class Hierarchy pages using a tree view instead of an ordered list.
1009
1010USE_INLINE_TREES = NO
655b45b0 1011
1012# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1013# used to set the initial width (in pixels) of the frame in which the tree
1014# is shown.
1015
1016TREEVIEW_WIDTH = 250
1017
1018# Use this tag to change the font size of Latex formulas included
1019# as images in the HTML documentation. The default is 10. Note that
1020# when you change the font size after a successful doxygen run you need
1021# to manually remove any form_*.png images from the HTML output directory
1022# to force them to be regenerated.
1023
1024FORMULA_FONTSIZE = 10
1025
9d8b0427 1026# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1027# for the HTML output. The underlying search engine uses javascript
1028# and DHTML and should work on any modern browser. Note that when using
1029# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1030# (GENERATE_DOCSET) there is already a search function so this one should
1031# typically be disabled. For large projects the javascript based search engine
1032# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1033
1034SEARCHENGINE = NO
1035
1036# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1037# implemented using a PHP enabled web server instead of at the web client
1038# using Javascript. Doxygen will generate the search PHP script and index
1039# file to put on the web server. The advantage of the server
1040# based approach is that it scales better to large projects and allows
1041# full text search. The disadvances is that it is more difficult to setup
1042# and does not have live searching capabilities.
1043
1044SERVER_BASED_SEARCH = NO
1045
655b45b0 1046#---------------------------------------------------------------------------
1047# configuration options related to the LaTeX output
1048#---------------------------------------------------------------------------
1049
1050# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1051# generate Latex output.
1052
1053GENERATE_LATEX = NO
1054
1055# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1056# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1057# put in front of it. If left blank `latex' will be used as the default path.
1058
1059LATEX_OUTPUT = latex
1060
1061# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
9d8b0427 1062# invoked. If left blank `latex' will be used as the default command name.
1063# Note that when enabling USE_PDFLATEX this option is only used for
1064# generating bitmaps for formulas in the HTML output, but not in the
1065# Makefile that is written to the output directory.
655b45b0 1066
1067LATEX_CMD_NAME = latex
1068
1069# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1070# generate index for LaTeX. If left blank `makeindex' will be used as the
1071# default command name.
1072
1073MAKEINDEX_CMD_NAME = makeindex
1074
1075# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1076# LaTeX documents. This may be useful for small projects and may help to
1077# save some trees in general.
1078
1079COMPACT_LATEX = NO
1080
1081# The PAPER_TYPE tag can be used to set the paper type that is used
1082# by the printer. Possible values are: a4, a4wide, letter, legal and
1083# executive. If left blank a4wide will be used.
1084
1085PAPER_TYPE = a4wide
1086
1087# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1088# packages that should be included in the LaTeX output.
1089
1090EXTRA_PACKAGES =
1091
1092# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1093# the generated latex document. The header should contain everything until
1094# the first chapter. If it is left blank doxygen will generate a
1095# standard header. Notice: only use this tag if you know what you are doing!
1096
1097LATEX_HEADER =
1098
1099# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1100# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1101# contain links (just like the HTML output) instead of page references
1102# This makes the output suitable for online browsing using a pdf viewer.
1103
1104PDF_HYPERLINKS = YES
1105
1106# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1107# plain latex in the generated Makefile. Set this option to YES to get a
1108# higher quality PDF documentation.
1109
1110USE_PDFLATEX = YES
1111
1112# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1113# command to the generated LaTeX files. This will instruct LaTeX to keep
1114# running if errors occur, instead of asking the user for help.
1115# This option is also used when generating formulas in HTML.
1116
1117LATEX_BATCHMODE = NO
1118
1119# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1120# include the index chapters (such as File Index, Compound Index, etc.)
1121# in the output.
1122
1123LATEX_HIDE_INDICES = NO
1124
9d8b0427 1125# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1126# source code with syntax highlighting in the LaTeX output.
1127# Note that which sources are shown also depends on other settings
1128# such as SOURCE_BROWSER.
1129
1130LATEX_SOURCE_CODE = NO
1131
655b45b0 1132#---------------------------------------------------------------------------
1133# configuration options related to the RTF output
1134#---------------------------------------------------------------------------
1135
1136# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1137# The RTF output is optimized for Word 97 and may not look very pretty with
1138# other RTF readers or editors.
1139
1140GENERATE_RTF = NO
1141
1142# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1143# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1144# put in front of it. If left blank `rtf' will be used as the default path.
1145
1146RTF_OUTPUT = rtf
1147
1148# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1149# RTF documents. This may be useful for small projects and may help to
1150# save some trees in general.
1151
1152COMPACT_RTF = NO
1153
1154# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1155# will contain hyperlink fields. The RTF file will
1156# contain links (just like the HTML output) instead of page references.
1157# This makes the output suitable for online browsing using WORD or other
1158# programs which support those fields.
1159# Note: wordpad (write) and others do not support links.
1160
1161RTF_HYPERLINKS = NO
1162
1163# Load stylesheet definitions from file. Syntax is similar to doxygen's
1164# config file, i.e. a series of assignments. You only have to provide
1165# replacements, missing definitions are set to their default value.
1166
1167RTF_STYLESHEET_FILE =
1168
1169# Set optional variables used in the generation of an rtf document.
1170# Syntax is similar to doxygen's config file.
1171
1172RTF_EXTENSIONS_FILE =
1173
1174#---------------------------------------------------------------------------
1175# configuration options related to the man page output
1176#---------------------------------------------------------------------------
1177
1178# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1179# generate man pages
1180
1181GENERATE_MAN = NO
1182
1183# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1184# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1185# put in front of it. If left blank `man' will be used as the default path.
1186
1187MAN_OUTPUT = man
1188
1189# The MAN_EXTENSION tag determines the extension that is added to
1190# the generated man pages (default is the subroutine's section .3)
1191
1192MAN_EXTENSION = .3
1193
1194# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1195# then it will generate one additional man file for each entity
1196# documented in the real man page(s). These additional files
1197# only source the real man page, but without them the man command
1198# would be unable to find the correct page. The default is NO.
1199
1200MAN_LINKS = NO
1201
1202#---------------------------------------------------------------------------
1203# configuration options related to the XML output
1204#---------------------------------------------------------------------------
1205
1206# If the GENERATE_XML tag is set to YES Doxygen will
1207# generate an XML file that captures the structure of
1208# the code including all documentation.
1209
1210GENERATE_XML = NO
1211
1212# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1213# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1214# put in front of it. If left blank `xml' will be used as the default path.
1215
1216XML_OUTPUT = xml
1217
1218# The XML_SCHEMA tag can be used to specify an XML schema,
1219# which can be used by a validating XML parser to check the
1220# syntax of the XML files.
1221
1222XML_SCHEMA =
1223
1224# The XML_DTD tag can be used to specify an XML DTD,
1225# which can be used by a validating XML parser to check the
1226# syntax of the XML files.
1227
1228XML_DTD =
1229
1230# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1231# dump the program listings (including syntax highlighting
1232# and cross-referencing information) to the XML output. Note that
1233# enabling this will significantly increase the size of the XML output.
1234
1235XML_PROGRAMLISTING = YES
1236
1237#---------------------------------------------------------------------------
1238# configuration options for the AutoGen Definitions output
1239#---------------------------------------------------------------------------
1240
1241# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1242# generate an AutoGen Definitions (see autogen.sf.net) file
1243# that captures the structure of the code including all
1244# documentation. Note that this feature is still experimental
1245# and incomplete at the moment.
1246
1247GENERATE_AUTOGEN_DEF = NO
1248
1249#---------------------------------------------------------------------------
1250# configuration options related to the Perl module output
1251#---------------------------------------------------------------------------
1252
1253# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1254# generate a Perl module file that captures the structure of
1255# the code including all documentation. Note that this
1256# feature is still experimental and incomplete at the
1257# moment.
1258
1259GENERATE_PERLMOD = NO
1260
1261# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1262# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1263# to generate PDF and DVI output from the Perl module output.
1264
1265PERLMOD_LATEX = NO
1266
1267# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1268# nicely formatted so it can be parsed by a human reader. This is useful
1269# if you want to understand what is going on. On the other hand, if this
1270# tag is set to NO the size of the Perl module output will be much smaller
1271# and Perl will parse it just the same.
1272
1273PERLMOD_PRETTY = YES
1274
1275# The names of the make variables in the generated doxyrules.make file
1276# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1277# This is useful so different doxyrules.make files included by the same
1278# Makefile don't overwrite each other's variables.
1279
1280PERLMOD_MAKEVAR_PREFIX =
1281
1282#---------------------------------------------------------------------------
9d8b0427 1283# Configuration options related to the preprocessor
655b45b0 1284#---------------------------------------------------------------------------
1285
1286# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1287# evaluate all C-preprocessor directives found in the sources and include
1288# files.
1289
1290ENABLE_PREPROCESSING = YES
1291
1292# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1293# names in the source code. If set to NO (the default) only conditional
1294# compilation will be performed. Macro expansion can be done in a controlled
1295# way by setting EXPAND_ONLY_PREDEF to YES.
1296
1297MACRO_EXPANSION = NO
1298
1299# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1300# then the macro expansion is limited to the macros specified with the
1301# PREDEFINED and EXPAND_AS_DEFINED tags.
1302
1303EXPAND_ONLY_PREDEF = NO
1304
1305# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1306# in the INCLUDE_PATH (see below) will be search if a #include is found.
1307
1308SEARCH_INCLUDES = YES
1309
1310# The INCLUDE_PATH tag can be used to specify one or more directories that
1311# contain include files that are not input files but should be processed by
1312# the preprocessor.
1313
1314INCLUDE_PATH =
1315
1316# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1317# patterns (like *.h and *.hpp) to filter out the header-files in the
1318# directories. If left blank, the patterns specified with FILE_PATTERNS will
1319# be used.
1320
1321INCLUDE_FILE_PATTERNS =
1322
1323# The PREDEFINED tag can be used to specify one or more macro names that
1324# are defined before the preprocessor is started (similar to the -D option of
1325# gcc). The argument of the tag is a list of macros of the form: name
1326# or name=definition (no spaces). If the definition and the = are
1327# omitted =1 is assumed. To prevent a macro definition from being
1328# undefined via #undef or recursively expanded use the := operator
1329# instead of the = operator.
1330
9d8b0427 1331PREDEFINED = DOXY_INPUT \
1332 ClassImp(X)= \
1333 ClassDef(X,N)=
655b45b0 1334
1335# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1336# this tag can be used to specify a list of macro names that should be expanded.
1337# The macro definition that is found in the sources will be used.
1338# Use the PREDEFINED tag if you want to use a different macro definition.
1339
1340EXPAND_AS_DEFINED =
1341
1342# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1343# doxygen's preprocessor will remove all function-like macros that are alone
1344# on a line, have an all uppercase name, and do not end with a semicolon. Such
1345# function macros are typically used for boiler-plate code, and will confuse
1346# the parser if not removed.
1347
1348SKIP_FUNCTION_MACROS = YES
1349
1350#---------------------------------------------------------------------------
9d8b0427 1351# Configuration::additions related to external references
655b45b0 1352#---------------------------------------------------------------------------
1353
1354# The TAGFILES option can be used to specify one or more tagfiles.
1355# Optionally an initial location of the external documentation
1356# can be added for each tagfile. The format of a tag file without
1357# this location is as follows:
1358# TAGFILES = file1 file2 ...
1359# Adding location for the tag files is done as follows:
1360# TAGFILES = file1=loc1 "file2 = loc2" ...
1361# where "loc1" and "loc2" can be relative or absolute paths or
1362# URLs. If a location is present for each tag, the installdox tool
1363# does not have to be run to correct the links.
1364# Note that each tag file must have a unique name
1365# (where the name does NOT include the path)
1366# If a tag file is not located in the directory in which doxygen
1367# is run, you must also specify the path to the tagfile here.
1368
1369TAGFILES =
1370
1371# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1372# a tag file that is based on the input files it reads.
1373
1374GENERATE_TAGFILE =
1375
1376# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1377# in the class index. If set to NO only the inherited external classes
1378# will be listed.
1379
1380ALLEXTERNALS = NO
1381
1382# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1383# in the modules index. If set to NO, only the current project's groups will
1384# be listed.
1385
1386EXTERNAL_GROUPS = YES
1387
1388# The PERL_PATH should be the absolute path and name of the perl script
1389# interpreter (i.e. the result of `which perl').
1390
1391PERL_PATH = /usr/bin/perl
1392
1393#---------------------------------------------------------------------------
9d8b0427 1394# Configuration options related to the dot tool
655b45b0 1395#---------------------------------------------------------------------------
1396
1397# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1398# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1399# or super classes. Setting the tag to NO turns the diagrams off. Note that
1400# this option is superseded by the HAVE_DOT option below. This is only a
1401# fallback. It is recommended to install and use dot, since it yields more
1402# powerful graphs.
1403
1404CLASS_DIAGRAMS = YES
1405
1406# You can define message sequence charts within doxygen comments using the \msc
1407# command. Doxygen will then run the mscgen tool (see
1408# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1409# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1410# the mscgen tool resides. If left empty the tool is assumed to be found in the
1411# default search path.
1412
1413MSCGEN_PATH =
1414
1415# If set to YES, the inheritance and collaboration graphs will hide
1416# inheritance and usage relations if the target is undocumented
1417# or is not a class.
1418
1419HIDE_UNDOC_RELATIONS = YES
1420
1421# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1422# available from the path. This tool is part of Graphviz, a graph visualization
1423# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1424# have no effect if this option is set to NO (the default)
1425
1426HAVE_DOT = YES
1427
1428# By default doxygen will write a font called FreeSans.ttf to the output
1429# directory and reference it in all dot files that doxygen generates. This
1430# font does not include all possible unicode characters however, so when you need
1431# these (or just want a differently looking font) you can specify the font name
1432# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1433# which can be done by putting it in a standard location or by setting the
1434# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1435# containing the font.
1436
1437DOT_FONTNAME = FreeSans
1438
1439# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1440# The default size is 10pt.
1441
1442DOT_FONTSIZE = 10
1443
1444# By default doxygen will tell dot to use the output directory to look for the
1445# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1446# different font using DOT_FONTNAME you can set the path where dot
1447# can find it using this tag.
1448
1449DOT_FONTPATH =
1450
1451# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1452# will generate a graph for each documented class showing the direct and
1453# indirect inheritance relations. Setting this tag to YES will force the
1454# the CLASS_DIAGRAMS tag to NO.
1455
1456CLASS_GRAPH = YES
1457
1458# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1459# will generate a graph for each documented class showing the direct and
1460# indirect implementation dependencies (inheritance, containment, and
1461# class references variables) of the class with other documented classes.
1462
1463COLLABORATION_GRAPH = YES
1464
1465# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1466# will generate a graph for groups, showing the direct groups dependencies
1467
1468GROUP_GRAPHS = YES
1469
1470# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1471# collaboration diagrams in a style similar to the OMG's Unified Modeling
1472# Language.
1473
1474UML_LOOK = YES
1475
1476# If set to YES, the inheritance and collaboration graphs will show the
1477# relations between templates and their instances.
1478
1479TEMPLATE_RELATIONS = NO
1480
1481# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1482# tags are set to YES then doxygen will generate a graph for each documented
1483# file showing the direct and indirect include dependencies of the file with
1484# other documented files.
1485
1486INCLUDE_GRAPH = YES
1487
1488# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1489# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1490# documented header file showing the documented files that directly or
1491# indirectly include this file.
1492
1493INCLUDED_BY_GRAPH = YES
1494
1495# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1496# doxygen will generate a call dependency graph for every global function
1497# or class method. Note that enabling this option will significantly increase
1498# the time of a run. So in most cases it will be better to enable call graphs
1499# for selected functions only using the \callgraph command.
1500
1501CALL_GRAPH = YES
1502
1503# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1504# doxygen will generate a caller dependency graph for every global function
1505# or class method. Note that enabling this option will significantly increase
1506# the time of a run. So in most cases it will be better to enable caller
1507# graphs for selected functions only using the \callergraph command.
1508
1509CALLER_GRAPH = YES
1510
1511# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1512# will graphical hierarchy of all classes instead of a textual one.
1513
1514GRAPHICAL_HIERARCHY = YES
1515
1516# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1517# then doxygen will show the dependencies a directory has on other directories
1518# in a graphical way. The dependency relations are determined by the #include
1519# relations between the files in the directories.
1520
1521DIRECTORY_GRAPH = YES
1522
1523# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1524# generated by dot. Possible values are png, jpg, or gif
1525# If left blank png will be used.
1526
1527DOT_IMAGE_FORMAT = png
1528
1529# The tag DOT_PATH can be used to specify the path where the dot tool can be
1530# found. If left blank, it is assumed the dot tool can be found in the path.
1531
1532DOT_PATH =
1533
1534# The DOTFILE_DIRS tag can be used to specify one or more directories that
1535# contain dot files that are included in the documentation (see the
1536# \dotfile command).
1537
1538DOTFILE_DIRS =
1539
1540# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1541# nodes that will be shown in the graph. If the number of nodes in a graph
1542# becomes larger than this value, doxygen will truncate the graph, which is
1543# visualized by representing a node as a red box. Note that doxygen if the
1544# number of direct children of the root node in a graph is already larger than
1545# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1546# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1547
1548DOT_GRAPH_MAX_NODES = 50
1549
1550# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1551# graphs generated by dot. A depth value of 3 means that only nodes reachable
1552# from the root by following a path via at most 3 edges will be shown. Nodes
1553# that lay further from the root node will be omitted. Note that setting this
1554# option to 1 or 2 may greatly reduce the computation time needed for large
1555# code bases. Also note that the size of a graph can be further restricted by
1556# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1557
1558MAX_DOT_GRAPH_DEPTH = 0
1559
1560# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1561# background. This is disabled by default, because dot on Windows does not
1562# seem to support this out of the box. Warning: Depending on the platform used,
1563# enabling this option may lead to badly anti-aliased labels on the edges of
1564# a graph (i.e. they become hard to read).
1565
1566DOT_TRANSPARENT = YES
1567
1568# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1569# files in one run (i.e. multiple -o and -T options on the command line). This
1570# makes dot run faster, but since only newer versions of dot (>1.8.10)
1571# support this, this feature is disabled by default.
1572
1573DOT_MULTI_TARGETS = YES
1574
1575# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1576# generate a legend page explaining the meaning of the various boxes and
1577# arrows in the dot generated graphs.
1578
1579GENERATE_LEGEND = YES
1580
1581# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1582# remove the intermediate dot files that are used to generate
1583# the various graphs.
1584
1585DOT_CLEANUP = YES