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