Compatibility with the trunk of ROOT
[u/mrichter/AliRoot.git] / FMD / Doxyfile
CommitLineData
eb282d36 1# Doxyfile 1.5.9
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 (" ")
9f662337 12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
eb282d36 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
9f662337 28PROJECT_NAME = "ALICE FMD Off-line"
eb282d36 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
9f662337 34PROJECT_NUMBER = 0.1
eb282d36 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
9f662337 41OUTPUT_DIRECTORY =
eb282d36 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
9f662337 50CREATE_SUBDIRS = NO
eb282d36 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, 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.
62
9f662337 63OUTPUT_LANGUAGE = English
eb282d36 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
9f662337 70BRIEF_MEMBER_DESC = NO
eb282d36 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
9f662337 77REPEAT_BRIEF = YES
eb282d36 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
9f662337 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
eb282d36 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
9f662337 105ALWAYS_DETAILED_SEC = YES
eb282d36 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
9f662337 112INLINE_INHERITED_MEMB = NO
eb282d36 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
9f662337 118FULL_PATH_NAMES = YES
eb282d36 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/hehi/cholm/work/alice/aliroot/FMD/ \
128 /home/hehi/cholm/alice/aliroot/FMD/
129
130# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
131# the path mentioned in the documentation of a class, which tells
132# the reader which header file to include in order to use a class.
133# If left blank only the name of the header file containing the class
134# definition is used. Otherwise one should specify the include paths that
135# are normally passed to the compiler using the -I flag.
136
9f662337 137STRIP_FROM_INC_PATH =
eb282d36 138
139# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
140# (but less readable) file names. This can be useful is your file systems
141# doesn't support long names like on DOS, Mac, or CD-ROM.
142
9f662337 143SHORT_NAMES = NO
eb282d36 144
145# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
146# will interpret the first line (until the first dot) of a JavaDoc-style
147# comment as the brief description. If set to NO, the JavaDoc
148# comments will behave just like regular Qt-style comments
149# (thus requiring an explicit @brief command for a brief description.)
150
151JAVADOC_AUTOBRIEF = YES
152
153# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
154# interpret the first line (until the first dot) of a Qt-style
155# comment as the brief description. If set to NO, the comments
156# will behave just like regular Qt-style comments (thus requiring
157# an explicit \brief command for a brief description.)
158
159QT_AUTOBRIEF = NO
160
161# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
162# treat a multi-line C++ special comment block (i.e. a block of //! or ///
163# comments) as a brief description. This used to be the default behaviour.
164# The new default is to treat a multi-line C++ comment block as a detailed
165# description. Set this tag to YES if you prefer the old behaviour instead.
166
9f662337 167MULTILINE_CPP_IS_BRIEF = NO
eb282d36 168
169# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
170# member inherits the documentation from any documented member that it
171# re-implements.
172
9f662337 173INHERIT_DOCS = YES
eb282d36 174
175# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
176# a new page for each member. If set to NO, the documentation of a member will
177# be part of the file/class/namespace that contains it.
178
9f662337 179SEPARATE_MEMBER_PAGES = NO
eb282d36 180
181# The TAB_SIZE tag can be used to set the number of spaces in a tab.
182# Doxygen uses this value to replace tabs by spaces in code fragments.
183
184TAB_SIZE = 2
185
186# This tag can be used to specify a number of aliases that acts
187# as commands in the documentation. An alias has the form "name=value".
188# For example adding "sideeffect=\par Side Effects:\n" will allow you to
189# put the command \sideeffect (or @sideeffect) in the documentation, which
190# will result in a user-defined paragraph with heading "Side Effects:".
191# You can put \n's in the value part of an alias to insert newlines.
192
9f662337 193ALIASES =
eb282d36 194
195# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
196# sources only. Doxygen will then generate output that is more tailored for C.
197# For instance, some of the names that are used will be different. The list
198# of all members will be omitted, etc.
199
9f662337 200OPTIMIZE_OUTPUT_FOR_C = NO
eb282d36 201
202# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
203# sources only. Doxygen will then generate output that is more tailored for
204# Java. For instance, namespaces will be presented as packages, qualified
205# scopes will look different, etc.
206
9f662337 207OPTIMIZE_OUTPUT_JAVA = NO
eb282d36 208
209# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
210# sources only. Doxygen will then generate output that is more tailored for
211# Fortran.
212
213OPTIMIZE_FOR_FORTRAN = NO
214
215# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
216# sources. Doxygen will then generate output that is tailored for
217# VHDL.
218
219OPTIMIZE_OUTPUT_VHDL = NO
220
221# Doxygen selects the parser to use depending on the extension of the files it parses.
222# With this tag you can assign which parser to use for a given extension.
223# Doxygen has a built-in mapping, but you can override or extend it using this tag.
224# The format is ext=language, where ext is a file extension, and language is one of
225# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
226# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
227# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
228# use: inc=Fortran f=C. Note that for custom extensions you also need to set
229# FILE_PATTERNS otherwise the files are not read by doxygen.
230
231EXTENSION_MAPPING =
232
233# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
234# to include (a tag file for) the STL sources as input, then you should
235# set this tag to YES in order to let doxygen match functions declarations and
236# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
237# func(std::string) {}). This also make the inheritance and collaboration
238# diagrams that involve STL classes more complete and accurate.
239
9f662337 240BUILTIN_STL_SUPPORT = NO
eb282d36 241
242# If you use Microsoft's C++/CLI language, you should set this option to YES to
243# enable parsing support.
244
245CPP_CLI_SUPPORT = NO
246
247# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
248# Doxygen will parse them like normal C++ but will assume all classes use public
249# instead of private inheritance when no explicit protection keyword is present.
250
251SIP_SUPPORT = NO
252
253# For Microsoft's IDL there are propget and propput attributes to indicate getter
254# and setter methods for a property. Setting this option to YES (the default)
255# will make doxygen to replace the get and set methods by a property in the
256# documentation. This will only work if the methods are indeed getting or
257# setting a simple type. If this is not the case, or you want to show the
258# methods anyway, you should set this option to NO.
259
260IDL_PROPERTY_SUPPORT = YES
261
262# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
263# tag is set to YES, then doxygen will reuse the documentation of the first
264# member in the group (if any) for the other members of the group. By default
265# all members of a group must be documented explicitly.
266
9f662337 267DISTRIBUTE_GROUP_DOC = NO
eb282d36 268
269# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
270# the same type (for instance a group of public functions) to be put as a
271# subgroup of that type (e.g. under the Public Functions section). Set it to
272# NO to prevent subgrouping. Alternatively, this can be done per class using
273# the \nosubgrouping command.
274
9f662337 275SUBGROUPING = YES
eb282d36 276
277# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
278# is documented as struct, union, or enum with the name of the typedef. So
279# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
280# with name TypeT. When disabled the typedef will appear as a member of a file,
281# namespace, or class. And the struct will be named TypeS. This can typically
282# be useful for C code in case the coding convention dictates that all compound
283# types are typedef'ed and only the typedef is referenced, never the tag name.
284
285TYPEDEF_HIDES_STRUCT = NO
286
287# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
288# determine which symbols to keep in memory and which to flush to disk.
289# When the cache is full, less often used symbols will be written to disk.
290# For small to medium size projects (<1000 input files) the default value is
291# probably good enough. For larger projects a too small cache size can cause
292# doxygen to be busy swapping symbols to and from disk most of the time
293# causing a significant performance penality.
294# If the system has enough physical memory increasing the cache will improve the
295# performance by keeping more symbols in memory. Note that the value works on
296# a logarithmic scale so increasing the size by one will rougly double the
297# memory usage. The cache size is given by this formula:
298# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
299# corresponding to a cache size of 2^16 = 65536 symbols
300
301SYMBOL_CACHE_SIZE = 0
302
9f662337 303#---------------------------------------------------------------------------
304# Build related configuration options
305#---------------------------------------------------------------------------
eb282d36 306
307# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
308# documentation are documented, even if no documentation was available.
309# Private class members and static file members will be hidden unless
310# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
311
9f662337 312EXTRACT_ALL = YES
eb282d36 313
314# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
315# will be included in the documentation.
316
9f662337 317EXTRACT_PRIVATE = YES
eb282d36 318
319# If the EXTRACT_STATIC tag is set to YES all static members of a file
320# will be included in the documentation.
321
9f662337 322EXTRACT_STATIC = YES
eb282d36 323
324# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
325# defined locally in source files will be included in the documentation.
326# If set to NO only classes defined in header files are included.
327
9f662337 328EXTRACT_LOCAL_CLASSES = YES
eb282d36 329
330# This flag is only useful for Objective-C code. When set to YES local
331# methods, which are defined in the implementation section but not in
332# the interface are included in the documentation.
333# If set to NO (the default) only methods in the interface are included.
334
9f662337 335EXTRACT_LOCAL_METHODS = NO
eb282d36 336
337# If this flag is set to YES, the members of anonymous namespaces will be
338# extracted and appear in the documentation as a namespace called
339# 'anonymous_namespace{file}', where file will be replaced with the base
340# name of the file that contains the anonymous namespace. By default
341# anonymous namespace are hidden.
342
343EXTRACT_ANON_NSPACES = NO
344
345# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
346# undocumented members of documented classes, files or namespaces.
347# If set to NO (the default) these members will be included in the
348# various overviews, but no documentation section is generated.
349# This option has no effect if EXTRACT_ALL is enabled.
350
9f662337 351HIDE_UNDOC_MEMBERS = NO
eb282d36 352
353# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
354# undocumented classes that are normally visible in the class hierarchy.
355# If set to NO (the default) these classes will be included in the various
356# overviews. This option has no effect if EXTRACT_ALL is enabled.
357
9f662337 358HIDE_UNDOC_CLASSES = NO
eb282d36 359
360# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
361# friend (class|struct|union) declarations.
362# If set to NO (the default) these declarations will be included in the
363# documentation.
364
9f662337 365HIDE_FRIEND_COMPOUNDS = NO
eb282d36 366
367# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
368# documentation blocks found inside the body of a function.
369# If set to NO (the default) these blocks will be appended to the
370# function's detailed documentation block.
371
9f662337 372HIDE_IN_BODY_DOCS = NO
eb282d36 373
374# The INTERNAL_DOCS tag determines if documentation
375# that is typed after a \internal command is included. If the tag is set
376# to NO (the default) then the documentation will be excluded.
377# Set it to YES to include the internal documentation.
378
9f662337 379INTERNAL_DOCS = NO
eb282d36 380
381# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
382# file names in lower-case letters. If set to YES upper-case letters are also
383# allowed. This is useful if you have classes or files whose names only differ
384# in case and if your file system supports case sensitive file names. Windows
385# and Mac users are advised to set this option to NO.
386
9f662337 387CASE_SENSE_NAMES = YES
eb282d36 388
389# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
390# will show members with their full class and namespace scopes in the
391# documentation. If set to YES the scope will be hidden.
392
9f662337 393HIDE_SCOPE_NAMES = NO
eb282d36 394
395# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
396# will put a list of the files that are included by a file in the documentation
397# of that file.
398
9f662337 399SHOW_INCLUDE_FILES = YES
eb282d36 400
401# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
402# is inserted in the documentation for inline members.
403
9f662337 404INLINE_INFO = YES
eb282d36 405
406# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
407# will sort the (detailed) documentation of file and class members
408# alphabetically by member name. If set to NO the members will appear in
409# declaration order.
410
9f662337 411SORT_MEMBER_DOCS = YES
eb282d36 412
413# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
414# brief documentation of file, namespace and class members alphabetically
415# by member name. If set to NO (the default) the members will appear in
416# declaration order.
417
9f662337 418SORT_BRIEF_DOCS = NO
eb282d36 419
420# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
421# hierarchy of group names into alphabetical order. If set to NO (the default)
422# the group names will appear in their defined order.
423
424SORT_GROUP_NAMES = NO
425
426# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
427# sorted by fully-qualified names, including namespaces. If set to
428# NO (the default), the class list will be sorted only by class name,
429# not including the namespace part.
430# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
431# Note: This option applies only to the class list, not to the
432# alphabetical list.
433
9f662337 434SORT_BY_SCOPE_NAME = NO
eb282d36 435
436# The GENERATE_TODOLIST tag can be used to enable (YES) or
437# disable (NO) the todo list. This list is created by putting \todo
438# commands in the documentation.
439
9f662337 440GENERATE_TODOLIST = YES
eb282d36 441
442# The GENERATE_TESTLIST tag can be used to enable (YES) or
443# disable (NO) the test list. This list is created by putting \test
444# commands in the documentation.
445
9f662337 446GENERATE_TESTLIST = YES
eb282d36 447
448# The GENERATE_BUGLIST tag can be used to enable (YES) or
449# disable (NO) the bug list. This list is created by putting \bug
450# commands in the documentation.
451
9f662337 452GENERATE_BUGLIST = YES
eb282d36 453
454# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
455# disable (NO) the deprecated list. This list is created by putting
456# \deprecated commands in the documentation.
457
9f662337 458GENERATE_DEPRECATEDLIST= YES
eb282d36 459
460# The ENABLED_SECTIONS tag can be used to enable conditional
461# documentation sections, marked by \if sectionname ... \endif.
462
9f662337 463ENABLED_SECTIONS =
eb282d36 464
465# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
466# the initial value of a variable or define consists of for it to appear in
467# the documentation. If the initializer consists of more lines than specified
468# here it will be hidden. Use a value of 0 to hide initializers completely.
469# The appearance of the initializer of individual variables and defines in the
470# documentation can be controlled using \showinitializer or \hideinitializer
471# command in the documentation regardless of this setting.
472
9f662337 473MAX_INITIALIZER_LINES = 30
eb282d36 474
475# If the sources in your project are distributed over multiple directories
476# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
477# in the documentation. The default is NO.
478
9f662337 479SHOW_DIRECTORIES = NO
eb282d36 480
481# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
482# This will remove the Files entry from the Quick Index and from the
483# Folder Tree View (if specified). The default is YES.
484
485SHOW_FILES = YES
486
487# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
488# Namespaces page. This will remove the Namespaces entry from the Quick Index
489# and from the Folder Tree View (if specified). The default is YES.
490
491SHOW_NAMESPACES = YES
492
493# The FILE_VERSION_FILTER tag can be used to specify a program or script that
494# doxygen should invoke to get the current version for each file (typically from
495# the version control system). Doxygen will invoke the program by executing (via
496# popen()) the command <command> <input-file>, where <command> is the value of
497# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
498# provided by doxygen. Whatever the program writes to standard output
499# is used as the file version. See the manual for examples.
500
9f662337 501FILE_VERSION_FILTER =
eb282d36 502
503# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
504# doxygen. The layout file controls the global structure of the generated output files
505# in an output format independent way. The create the layout file that represents
506# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
507# file name after the option, if omitted DoxygenLayout.xml will be used as the name
508# of the layout file.
509
510LAYOUT_FILE =
511
9f662337 512#---------------------------------------------------------------------------
513# configuration options related to warning and progress messages
514#---------------------------------------------------------------------------
eb282d36 515
516# The QUIET tag can be used to turn on/off the messages that are generated
517# by doxygen. Possible values are YES and NO. If left blank NO is used.
518
9f662337 519QUIET = YES
eb282d36 520
521# The WARNINGS tag can be used to turn on/off the warning messages that are
522# generated by doxygen. Possible values are YES and NO. If left blank
523# NO is used.
524
9f662337 525WARNINGS = YES
eb282d36 526
527# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
528# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
529# automatically be disabled.
530
9f662337 531WARN_IF_UNDOCUMENTED = YES
eb282d36 532
533# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
534# potential errors in the documentation, such as not documenting some
535# parameters in a documented function, or documenting parameters that
536# don't exist or using markup commands wrongly.
537
9f662337 538WARN_IF_DOC_ERROR = YES
eb282d36 539
540# This WARN_NO_PARAMDOC option can be abled to get warnings for
541# functions that are documented, but have no documentation for their parameters
542# or return value. If set to NO (the default) doxygen will only warn about
543# wrong or incomplete parameter documentation, but not about the absence of
544# documentation.
545
9f662337 546WARN_NO_PARAMDOC = YES
eb282d36 547
548# The WARN_FORMAT tag determines the format of the warning messages that
549# doxygen can produce. The string should contain the $file, $line, and $text
550# tags, which will be replaced by the file and line number from which the
551# warning originated and the warning text. Optionally the format may contain
552# $version, which will be replaced by the version of the file (if it could
553# be obtained via FILE_VERSION_FILTER)
554
9f662337 555WARN_FORMAT = "$file:$line: $text"
eb282d36 556
557# The WARN_LOGFILE tag can be used to specify a file to which warning
558# and error messages should be written. If left blank the output is written
559# to stderr.
560
9f662337 561WARN_LOGFILE =
eb282d36 562
9f662337 563#---------------------------------------------------------------------------
564# configuration options related to the input files
565#---------------------------------------------------------------------------
eb282d36 566
567# The INPUT tag can be used to specify the files and/or directories that contain
568# documented source files. You may enter file names like "myfile.cpp" or
569# directories like "/usr/src/myproject". Separate the files or directories
570# with spaces.
571
572INPUT = . \
573 scripts/ \
574 analysis \
575 flow
576
577# This tag can be used to specify the character encoding of the source files
578# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
579# also the default input encoding. Doxygen uses libiconv (or the iconv built
580# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
581# the list of possible encodings.
582
583INPUT_ENCODING = UTF-8
584
585# If the value of the INPUT tag contains directories, you can use the
586# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
587# and *.h) to filter out the source-files in the directories. If left
588# blank the following patterns are tested:
589# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
590# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
591
9b48326f 592FILE_PATTERNS = *.h \
eb282d36 593 *.C \
594 *.cxx
595
596# The RECURSIVE tag can be used to turn specify whether or not subdirectories
597# should be searched for input files as well. Possible values are YES and NO.
598# If left blank NO is used.
599
9f662337 600RECURSIVE = NO
eb282d36 601
602# The EXCLUDE tag can be used to specify files and/or directories that should
603# excluded from the INPUT source files. This way you can easily exclude a
604# subdirectory from a directory tree whose root is specified with the INPUT tag.
605
9f662337 606EXCLUDE =
eb282d36 607
608# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
609# directories that are symbolic links (a Unix filesystem feature) are excluded
610# from the input.
611
9f662337 612EXCLUDE_SYMLINKS = NO
eb282d36 613
614# If the value of the INPUT tag contains directories, you can use the
615# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
616# certain files from those directories. Note that the wildcards are matched
617# against the file with absolute path, so to exclude all test directories
618# for example use the pattern */test/*
619
620EXCLUDE_PATTERNS = *Dict.h \
621 *Dict.cxx
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 = scripts/
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
9f662337 642EXAMPLE_PATTERNS = *.C
eb282d36 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
9f662337 649EXAMPLE_RECURSIVE = NO
eb282d36 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 = pics/
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
9f662337 665INPUT_FILTER =
eb282d36 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
9f662337 674FILTER_PATTERNS =
eb282d36 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
9f662337 680FILTER_SOURCE_FILES = NO
eb282d36 681
9f662337 682#---------------------------------------------------------------------------
683# configuration options related to source browsing
684#---------------------------------------------------------------------------
eb282d36 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
9b48326f 691SOURCE_BROWSER = YES
eb282d36 692
693# Setting the INLINE_SOURCES tag to YES will include the body
694# of functions and classes directly in the documentation.
695
9f662337 696INLINE_SOURCES = NO
eb282d36 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
9f662337 702STRIP_CODE_COMMENTS = YES
eb282d36 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
9f662337 729USE_HTAGS = NO
eb282d36 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
9f662337 735VERBATIM_HEADERS = NO
eb282d36 736
9f662337 737#---------------------------------------------------------------------------
738# configuration options related to the alphabetical class index
739#---------------------------------------------------------------------------
eb282d36 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
9f662337 745ALPHABETICAL_INDEX = YES
eb282d36 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 = 3
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
9f662337 758IGNORE_PREFIX =
eb282d36 759
9f662337 760#---------------------------------------------------------------------------
761# configuration options related to the HTML output
762#---------------------------------------------------------------------------
eb282d36 763
764# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
765# generate HTML output.
766
9f662337 767GENERATE_HTML = YES
eb282d36 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
9f662337 773HTML_OUTPUT = html
eb282d36 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
9f662337 779HTML_FILE_EXTENSION = .html
eb282d36 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
9f662337 785HTML_HEADER =
eb282d36 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
9f662337 791HTML_FOOTER =
eb282d36 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
9f662337 800HTML_STYLESHEET =
eb282d36 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
9f662337 806HTML_ALIGN_MEMBERS = YES
eb282d36 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
9f662337 847GENERATE_HTMLHELP = NO
eb282d36 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
9f662337 854CHM_FILE =
eb282d36 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
9f662337 861HHC_LOCATION =
eb282d36 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
9f662337 867GENERATE_CHI = NO
eb282d36 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
9f662337 879BINARY_TOC = NO
eb282d36 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
9f662337 884TOC_EXPAND = NO
eb282d36 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
9f662337 939DISABLE_INDEX = NO
eb282d36 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
9f662337 944ENUM_VALUES_PER_LINE = 4
eb282d36 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 = ALL
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
9f662337 967TREEVIEW_WIDTH = 250
eb282d36 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
9f662337 977#---------------------------------------------------------------------------
978# configuration options related to the LaTeX output
979#---------------------------------------------------------------------------
eb282d36 980
981# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
982# generate Latex output.
983
9f662337 984GENERATE_LATEX = NO
eb282d36 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
9f662337 990LATEX_OUTPUT = latex
eb282d36 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
9f662337 995LATEX_CMD_NAME = latex
eb282d36 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
9f662337 1001MAKEINDEX_CMD_NAME = makeindex
eb282d36 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
9f662337 1007COMPACT_LATEX = NO
eb282d36 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
9f662337 1013PAPER_TYPE = a4wide
eb282d36 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
9f662337 1018EXTRA_PACKAGES =
eb282d36 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
9f662337 1025LATEX_HEADER =
eb282d36 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
9f662337 1032PDF_HYPERLINKS = NO
eb282d36 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
9f662337 1038USE_PDFLATEX = NO
eb282d36 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
9f662337 1045LATEX_BATCHMODE = NO
eb282d36 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
9f662337 1051LATEX_HIDE_INDICES = NO
eb282d36 1052
1053# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1054# source code with syntax highlighting in the LaTeX output.
1055# Note that which sources are shown also depends on other settings
1056# such as SOURCE_BROWSER.
1057
1058LATEX_SOURCE_CODE = NO
1059
9f662337 1060#---------------------------------------------------------------------------
1061# configuration options related to the RTF output
1062#---------------------------------------------------------------------------
eb282d36 1063
1064# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1065# The RTF output is optimized for Word 97 and may not look very pretty with
1066# other RTF readers or editors.
1067
9f662337 1068GENERATE_RTF = NO
eb282d36 1069
1070# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1071# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1072# put in front of it. If left blank `rtf' will be used as the default path.
1073
9f662337 1074RTF_OUTPUT = rtf
eb282d36 1075
1076# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1077# RTF documents. This may be useful for small projects and may help to
1078# save some trees in general.
1079
9f662337 1080COMPACT_RTF = NO
eb282d36 1081
1082# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1083# will contain hyperlink fields. The RTF file will
1084# contain links (just like the HTML output) instead of page references.
1085# This makes the output suitable for online browsing using WORD or other
1086# programs which support those fields.
1087# Note: wordpad (write) and others do not support links.
1088
9f662337 1089RTF_HYPERLINKS = NO
eb282d36 1090
1091# Load stylesheet definitions from file. Syntax is similar to doxygen's
1092# config file, i.e. a series of assignments. You only have to provide
1093# replacements, missing definitions are set to their default value.
1094
9f662337 1095RTF_STYLESHEET_FILE =
eb282d36 1096
1097# Set optional variables used in the generation of an rtf document.
1098# Syntax is similar to doxygen's config file.
1099
9f662337 1100RTF_EXTENSIONS_FILE =
eb282d36 1101
9f662337 1102#---------------------------------------------------------------------------
1103# configuration options related to the man page output
1104#---------------------------------------------------------------------------
eb282d36 1105
1106# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1107# generate man pages
1108
9f662337 1109GENERATE_MAN = NO
eb282d36 1110
1111# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1112# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1113# put in front of it. If left blank `man' will be used as the default path.
1114
9f662337 1115MAN_OUTPUT = man
eb282d36 1116
1117# The MAN_EXTENSION tag determines the extension that is added to
1118# the generated man pages (default is the subroutine's section .3)
1119
9f662337 1120MAN_EXTENSION = .3
eb282d36 1121
1122# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1123# then it will generate one additional man file for each entity
1124# documented in the real man page(s). These additional files
1125# only source the real man page, but without them the man command
1126# would be unable to find the correct page. The default is NO.
1127
9f662337 1128MAN_LINKS = NO
eb282d36 1129
9f662337 1130#---------------------------------------------------------------------------
1131# configuration options related to the XML output
1132#---------------------------------------------------------------------------
eb282d36 1133
1134# If the GENERATE_XML tag is set to YES Doxygen will
1135# generate an XML file that captures the structure of
1136# the code including all documentation.
1137
9f662337 1138GENERATE_XML = NO
eb282d36 1139
1140# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1141# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1142# put in front of it. If left blank `xml' will be used as the default path.
1143
9f662337 1144XML_OUTPUT = xml
eb282d36 1145
1146# The XML_SCHEMA tag can be used to specify an XML schema,
1147# which can be used by a validating XML parser to check the
1148# syntax of the XML files.
1149
9f662337 1150XML_SCHEMA =
eb282d36 1151
1152# The XML_DTD tag can be used to specify an XML DTD,
1153# which can be used by a validating XML parser to check the
1154# syntax of the XML files.
1155
9f662337 1156XML_DTD =
eb282d36 1157
1158# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1159# dump the program listings (including syntax highlighting
1160# and cross-referencing information) to the XML output. Note that
1161# enabling this will significantly increase the size of the XML output.
1162
9f662337 1163XML_PROGRAMLISTING = YES
eb282d36 1164
9f662337 1165#---------------------------------------------------------------------------
1166# configuration options for the AutoGen Definitions output
1167#---------------------------------------------------------------------------
eb282d36 1168
1169# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1170# generate an AutoGen Definitions (see autogen.sf.net) file
1171# that captures the structure of the code including all
1172# documentation. Note that this feature is still experimental
1173# and incomplete at the moment.
1174
9f662337 1175GENERATE_AUTOGEN_DEF = NO
eb282d36 1176
9f662337 1177#---------------------------------------------------------------------------
1178# configuration options related to the Perl module output
1179#---------------------------------------------------------------------------
eb282d36 1180
1181# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1182# generate a Perl module file that captures the structure of
1183# the code including all documentation. Note that this
1184# feature is still experimental and incomplete at the
1185# moment.
1186
9f662337 1187GENERATE_PERLMOD = NO
eb282d36 1188
1189# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1190# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1191# to generate PDF and DVI output from the Perl module output.
1192
9f662337 1193PERLMOD_LATEX = NO
eb282d36 1194
1195# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1196# nicely formatted so it can be parsed by a human reader. This is useful
1197# if you want to understand what is going on. On the other hand, if this
1198# tag is set to NO the size of the Perl module output will be much smaller
1199# and Perl will parse it just the same.
1200
9f662337 1201PERLMOD_PRETTY = YES
eb282d36 1202
1203# The names of the make variables in the generated doxyrules.make file
1204# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1205# This is useful so different doxyrules.make files included by the same
1206# Makefile don't overwrite each other's variables.
1207
9f662337 1208PERLMOD_MAKEVAR_PREFIX =
eb282d36 1209
9f662337 1210#---------------------------------------------------------------------------
1211# Configuration options related to the preprocessor
1212#---------------------------------------------------------------------------
eb282d36 1213
1214# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1215# evaluate all C-preprocessor directives found in the sources and include
1216# files.
1217
9f662337 1218ENABLE_PREPROCESSING = YES
eb282d36 1219
1220# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1221# names in the source code. If set to NO (the default) only conditional
1222# compilation will be performed. Macro expansion can be done in a controlled
1223# way by setting EXPAND_ONLY_PREDEF to YES.
1224
9f662337 1225MACRO_EXPANSION = YES
eb282d36 1226
1227# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1228# then the macro expansion is limited to the macros specified with the
1229# PREDEFINED and EXPAND_AS_DEFINED tags.
1230
9f662337 1231EXPAND_ONLY_PREDEF = NO
eb282d36 1232
1233# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1234# in the INCLUDE_PATH (see below) will be search if a #include is found.
1235
9f662337 1236SEARCH_INCLUDES = YES
eb282d36 1237
1238# The INCLUDE_PATH tag can be used to specify one or more directories that
1239# contain include files that are not input files but should be processed by
1240# the preprocessor.
1241
1242INCLUDE_PATH = ../STEER \
1243 ../RAW \
1244 ../CDB
1245
1246# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1247# patterns (like *.h and *.hpp) to filter out the header-files in the
1248# directories. If left blank, the patterns specified with FILE_PATTERNS will
1249# be used.
1250
9f662337 1251INCLUDE_FILE_PATTERNS =
eb282d36 1252
1253# The PREDEFINED tag can be used to specify one or more macro names that
1254# are defined before the preprocessor is started (similar to the -D option of
1255# gcc). The argument of the tag is a list of macros of the form: name
1256# or name=definition (no spaces). If the definition and the = are
1257# omitted =1 is assumed. To prevent a macro definition from being
1258# undefined via #undef or recursively expanded use the := operator
1259# instead of the = operator.
1260
1261PREDEFINED = ClassDef(X)=
1262
1263# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1264# this tag can be used to specify a list of macro names that should be expanded.
1265# The macro definition that is found in the sources will be used.
1266# Use the PREDEFINED tag if you want to use a different macro definition.
1267
9f662337 1268EXPAND_AS_DEFINED =
eb282d36 1269
1270# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1271# doxygen's preprocessor will remove all function-like macros that are alone
1272# on a line, have an all uppercase name, and do not end with a semicolon. Such
1273# function macros are typically used for boiler-plate code, and will confuse
1274# the parser if not removed.
1275
9f662337 1276SKIP_FUNCTION_MACROS = YES
eb282d36 1277
9f662337 1278#---------------------------------------------------------------------------
1279# Configuration::additions related to external references
1280#---------------------------------------------------------------------------
eb282d36 1281
1282# The TAGFILES option can be used to specify one or more tagfiles.
1283# Optionally an initial location of the external documentation
1284# can be added for each tagfile. The format of a tag file without
1285# this location is as follows:
1286# TAGFILES = file1 file2 ...
1287# Adding location for the tag files is done as follows:
1288# TAGFILES = file1=loc1 "file2 = loc2" ...
1289# where "loc1" and "loc2" can be relative or absolute paths or
1290# URLs. If a location is present for each tag, the installdox tool
1291# does not have to be run to correct the links.
1292# Note that each tag file must have a unique name
1293# (where the name does NOT include the path)
1294# If a tag file is not located in the directory in which doxygen
1295# is run, you must also specify the path to the tagfile here.
1296
9f662337 1297TAGFILES =
eb282d36 1298
1299# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1300# a tag file that is based on the input files it reads.
1301
9f662337 1302GENERATE_TAGFILE =
eb282d36 1303
1304# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1305# in the class index. If set to NO only the inherited external classes
1306# will be listed.
1307
9f662337 1308ALLEXTERNALS = NO
eb282d36 1309
1310# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1311# in the modules index. If set to NO, only the current project's groups will
1312# be listed.
1313
9f662337 1314EXTERNAL_GROUPS = YES
eb282d36 1315
1316# The PERL_PATH should be the absolute path and name of the perl script
1317# interpreter (i.e. the result of `which perl').
1318
9f662337 1319PERL_PATH = /usr/bin/perl
eb282d36 1320
9f662337 1321#---------------------------------------------------------------------------
1322# Configuration options related to the dot tool
1323#---------------------------------------------------------------------------
eb282d36 1324
1325# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1326# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1327# or super classes. Setting the tag to NO turns the diagrams off. Note that
1328# this option is superseded by the HAVE_DOT option below. This is only a
1329# fallback. It is recommended to install and use dot, since it yields more
1330# powerful graphs.
1331
9f662337 1332CLASS_DIAGRAMS = YES
eb282d36 1333
1334# You can define message sequence charts within doxygen comments using the \msc
1335# command. Doxygen will then run the mscgen tool (see
1336# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1337# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1338# the mscgen tool resides. If left empty the tool is assumed to be found in the
1339# default search path.
1340
1341MSCGEN_PATH =
1342
1343# If set to YES, the inheritance and collaboration graphs will hide
1344# inheritance and usage relations if the target is undocumented
1345# or is not a class.
1346
55f0ce5b 1347HIDE_UNDOC_RELATIONS = NO
eb282d36 1348
1349# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1350# available from the path. This tool is part of Graphviz, a graph visualization
1351# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1352# have no effect if this option is set to NO (the default)
1353
9f662337 1354HAVE_DOT = YES
eb282d36 1355
1356# By default doxygen will write a font called FreeSans.ttf to the output
1357# directory and reference it in all dot files that doxygen generates. This
1358# font does not include all possible unicode characters however, so when you need
1359# these (or just want a differently looking font) you can specify the font name
1360# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1361# which can be done by putting it in a standard location or by setting the
1362# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1363# containing the font.
1364
1365DOT_FONTNAME = FreeSans
1366
1367# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1368# The default size is 10pt.
1369
1370DOT_FONTSIZE = 10
1371
1372# By default doxygen will tell dot to use the output directory to look for the
1373# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1374# different font using DOT_FONTNAME you can set the path where dot
1375# can find it using this tag.
1376
1377DOT_FONTPATH =
1378
1379# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1380# will generate a graph for each documented class showing the direct and
1381# indirect inheritance relations. Setting this tag to YES will force the
1382# the CLASS_DIAGRAMS tag to NO.
1383
9f662337 1384CLASS_GRAPH = YES
eb282d36 1385
1386# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1387# will generate a graph for each documented class showing the direct and
1388# indirect implementation dependencies (inheritance, containment, and
1389# class references variables) of the class with other documented classes.
1390
9f662337 1391COLLABORATION_GRAPH = YES
eb282d36 1392
1393# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1394# will generate a graph for groups, showing the direct groups dependencies
1395
1396GROUP_GRAPHS = YES
1397
1398# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1399# collaboration diagrams in a style similar to the OMG's Unified Modeling
1400# Language.
1401
9f662337 1402UML_LOOK = YES
eb282d36 1403
1404# If set to YES, the inheritance and collaboration graphs will show the
1405# relations between templates and their instances.
1406
9f662337 1407TEMPLATE_RELATIONS = NO
eb282d36 1408
1409# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1410# tags are set to YES then doxygen will generate a graph for each documented
1411# file showing the direct and indirect include dependencies of the file with
1412# other documented files.
1413
55f0ce5b 1414INCLUDE_GRAPH = NO
eb282d36 1415
1416# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1417# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1418# documented header file showing the documented files that directly or
1419# indirectly include this file.
1420
55f0ce5b 1421INCLUDED_BY_GRAPH = NO
eb282d36 1422
1423# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1424# doxygen will generate a call dependency graph for every global function
1425# or class method. Note that enabling this option will significantly increase
1426# the time of a run. So in most cases it will be better to enable call graphs
1427# for selected functions only using the \callgraph command.
1428
1429CALL_GRAPH = YES
1430
1431# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1432# doxygen will generate a caller dependency graph for every global function
1433# or class method. Note that enabling this option will significantly increase
1434# the time of a run. So in most cases it will be better to enable caller
1435# graphs for selected functions only using the \callergraph command.
1436
1437CALLER_GRAPH = YES
1438
1439# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1440# will graphical hierarchy of all classes instead of a textual one.
1441
9f662337 1442GRAPHICAL_HIERARCHY = YES
eb282d36 1443
1444# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1445# then doxygen will show the dependencies a directory has on other directories
1446# in a graphical way. The dependency relations are determined by the #include
1447# relations between the files in the directories.
1448
55f0ce5b 1449DIRECTORY_GRAPH = NO
eb282d36 1450
1451# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1452# generated by dot. Possible values are png, jpg, or gif
1453# If left blank png will be used.
1454
9f662337 1455DOT_IMAGE_FORMAT = png
eb282d36 1456
1457# The tag DOT_PATH can be used to specify the path where the dot tool can be
1458# found. If left blank, it is assumed the dot tool can be found in the path.
1459
9f662337 1460DOT_PATH =
eb282d36 1461
1462# The DOTFILE_DIRS tag can be used to specify one or more directories that
1463# contain dot files that are included in the documentation (see the
1464# \dotfile command).
1465
9f662337 1466DOTFILE_DIRS =
eb282d36 1467
1468# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1469# nodes that will be shown in the graph. If the number of nodes in a graph
1470# becomes larger than this value, doxygen will truncate the graph, which is
1471# visualized by representing a node as a red box. Note that doxygen if the
1472# number of direct children of the root node in a graph is already larger than
1473# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1474# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1475
1476DOT_GRAPH_MAX_NODES = 50
1477
1478# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1479# graphs generated by dot. A depth value of 3 means that only nodes reachable
1480# from the root by following a path via at most 3 edges will be shown. Nodes
1481# that lay further from the root node will be omitted. Note that setting this
1482# option to 1 or 2 may greatly reduce the computation time needed for large
1483# code bases. Also note that the size of a graph can be further restricted by
1484# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1485
9f662337 1486MAX_DOT_GRAPH_DEPTH = 1000
eb282d36 1487
1488# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1489# background. This is disabled by default, because dot on Windows does not
1490# seem to support this out of the box. Warning: Depending on the platform used,
1491# enabling this option may lead to badly anti-aliased labels on the edges of
1492# a graph (i.e. they become hard to read).
1493
9f662337 1494DOT_TRANSPARENT = NO
eb282d36 1495
1496# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1497# files in one run (i.e. multiple -o and -T options on the command line). This
1498# makes dot run faster, but since only newer versions of dot (>1.8.10)
1499# support this, this feature is disabled by default.
1500
9f662337 1501DOT_MULTI_TARGETS = YES
eb282d36 1502
1503# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1504# generate a legend page explaining the meaning of the various boxes and
1505# arrows in the dot generated graphs.
1506
9f662337 1507GENERATE_LEGEND = YES
eb282d36 1508
1509# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1510# remove the intermediate dot files that are used to generate
1511# the various graphs.
1512
9f662337 1513DOT_CLEANUP = YES
eb282d36 1514
9f662337 1515#---------------------------------------------------------------------------
eb282d36 1516# Options related to the search engine
9f662337 1517#---------------------------------------------------------------------------
eb282d36 1518
1519# The SEARCHENGINE tag specifies whether or not a search engine should be
1520# used. If set to NO the values of all tags below this one will be ignored.
1521
9f662337 1522SEARCHENGINE = NO