Removing leftover return
[u/mrichter/AliRoot.git] / MUON / Doxyfile
CommitLineData
12628611 1# Doxyfile 1.3.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 (" ")
12
13#---------------------------------------------------------------------------
14# Project related configuration options
15#---------------------------------------------------------------------------
16
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18# by quotes) that should identify the project.
19
20PROJECT_NAME = "AliRoot MUON"
21
22# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or
24# if some version control system is used.
25
020ae1db 26PROJECT_NUMBER = "Version SVN trunk"
12628611 27
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29# base path where the generated documentation will be put.
30# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.
32
33OUTPUT_DIRECTORY =
34
35# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36# 4096 sub-directories (in 2 levels) under the output directory of each output
37# format and will distribute the generated files over these directories.
38# Enabling this option can be useful when feeding doxygen a huge amount of source
39# files, where putting all generated files in the same directory would otherwise
40# cause performance problems for the file system.
41
42CREATE_SUBDIRS = NO
43
44# The OUTPUT_LANGUAGE tag is used to specify the language in which all
45# documentation generated by doxygen is written. Doxygen will use this
46# information to generate all constant output in the proper language.
47# The default language is English, other supported languages are:
48# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
49# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
50# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
51# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
52# Swedish, and Ukrainian.
53
54OUTPUT_LANGUAGE = English
55
12628611 56# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57# include brief member descriptions after the members that are listed in
58# the file and class documentation (similar to JavaDoc).
59# Set to NO to disable this.
60
61BRIEF_MEMBER_DESC = YES
62
63# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64# the brief description of a member or function before the detailed description.
65# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66# brief descriptions will be completely suppressed.
67
1fda6707 68REPEAT_BRIEF = YES
12628611 69
70# This tag implements a quasi-intelligent brief description abbreviator
71# that is used to form the text in various listings. Each string
72# in this list, if found as the leading text of the brief description, will be
73# stripped from the text and the result after processing the whole list, is used
74# as the annotated text. Otherwise, the brief description is used as-is. If left
75# blank, the following values are used ("$name" is automatically replaced with the
76# name of the entity): "The $name class" "The $name widget" "The $name file"
77# "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
78
211a13cd 79ABBREVIATE_BRIEF = YES
12628611 80
81# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
82# Doxygen will generate a detailed section even if there is only a brief
83# description.
84
211a13cd 85ALWAYS_DETAILED_SEC = YES
12628611 86
87# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
88# members of a class in the documentation of that class as if those members were
89# ordinary class members. Constructors, destructors and assignment operators of
90# the base classes will not be shown.
91
92INLINE_INHERITED_MEMB = NO
93
94# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
95# path before files name in the file list and in the header files. If set
96# to NO the shortest path that makes the file name unique will be used.
97
98FULL_PATH_NAMES = YES
99
100# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
101# can be used to strip a user-defined part of the path. Stripping is
102# only done if one of the specified strings matches the left-hand part of
103# the path. The tag can be used to show relative paths in the file list.
104# If left blank the directory from which doxygen is run is used as the
105# path to strip.
106
107STRIP_FROM_PATH =
108
109# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
110# the path mentioned in the documentation of a class, which tells
111# the reader which header file to include in order to use a class.
112# If left blank only the name of the header file containing the class
113# definition is used. Otherwise one should specify the include paths that
114# are normally passed to the compiler using the -I flag.
115
116STRIP_FROM_INC_PATH =
117
118# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
119# (but less readable) file names. This can be useful is your file systems
120# doesn't support long names like on DOS, Mac, or CD-ROM.
121
122SHORT_NAMES = NO
123
124# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
125# will interpret the first line (until the first dot) of a JavaDoc-style
126# comment as the brief description. If set to NO, the JavaDoc
127# comments will behave just like the Qt-style comments (thus requiring an
128# explicit @brief command for a brief description.
129
130JAVADOC_AUTOBRIEF = NO
131
132# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
133# treat a multi-line C++ special comment block (i.e. a block of //! or ///
134# comments) as a brief description. This used to be the default behaviour.
135# The new default is to treat a multi-line C++ comment block as a detailed
136# description. Set this tag to YES if you prefer the old behaviour instead.
137
138MULTILINE_CPP_IS_BRIEF = NO
139
140# If the DETAILS_AT_TOP tag is set to YES then Doxygen
141# will output the detailed description near the top, like JavaDoc.
142# If set to NO, the detailed description appears after the member
143# documentation.
144
145DETAILS_AT_TOP = YES
146
147# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
148# member inherits the documentation from any documented member that it
149# re-implements.
150
151INHERIT_DOCS = YES
152
153# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
154# tag is set to YES, then doxygen will reuse the documentation of the first
155# member in the group (if any) for the other members of the group. By default
156# all members of a group must be documented explicitly.
157
158DISTRIBUTE_GROUP_DOC = NO
159
160# The TAB_SIZE tag can be used to set the number of spaces in a tab.
161# Doxygen uses this value to replace tabs by spaces in code fragments.
162
163TAB_SIZE = 8
164
165# This tag can be used to specify a number of aliases that acts
166# as commands in the documentation. An alias has the form "name=value".
167# For example adding "sideeffect=\par Side Effects:\n" will allow you to
168# put the command \sideeffect (or @sideeffect) in the documentation, which
169# will result in a user-defined paragraph with heading "Side Effects:".
170# You can put \n's in the value part of an alias to insert newlines.
171
172ALIASES =
173
174# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
175# only. Doxygen will then generate output that is more tailored for C.
176# For instance, some of the names that are used will be different. The list
177# of all members will be omitted, etc.
178
179OPTIMIZE_OUTPUT_FOR_C = NO
180
181# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
182# only. Doxygen will then generate output that is more tailored for Java.
183# For instance, namespaces will be presented as packages, qualified scopes
184# will look different, etc.
185
186OPTIMIZE_OUTPUT_JAVA = NO
187
188# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
189# the same type (for instance a group of public functions) to be put as a
190# subgroup of that type (e.g. under the Public Functions section). Set it to
191# NO to prevent subgrouping. Alternatively, this can be done per class using
192# the \nosubgrouping command.
193
194SUBGROUPING = YES
195
196#---------------------------------------------------------------------------
197# Build related configuration options
198#---------------------------------------------------------------------------
199
200# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
201# documentation are documented, even if no documentation was available.
202# Private class members and static file members will be hidden unless
203# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
204
094f4788 205EXTRACT_ALL = YES
206#EXTRACT_ALL = NO
12628611 207
208# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
209# will be included in the documentation.
210
211EXTRACT_PRIVATE = YES
212
213# If the EXTRACT_STATIC tag is set to YES all static members of a file
214# will be included in the documentation.
215
216EXTRACT_STATIC = YES
217
218# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
219# defined locally in source files will be included in the documentation.
220# If set to NO only classes defined in header files are included.
221
222EXTRACT_LOCAL_CLASSES = YES
223
224# This flag is only useful for Objective-C code. When set to YES local
225# methods, which are defined in the implementation section but not in
226# the interface are included in the documentation.
227# If set to NO (the default) only methods in the interface are included.
228
229EXTRACT_LOCAL_METHODS = NO
230
231# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
232# undocumented members of documented classes, files or namespaces.
233# If set to NO (the default) these members will be included in the
234# various overviews, but no documentation section is generated.
235# This option has no effect if EXTRACT_ALL is enabled.
236
237HIDE_UNDOC_MEMBERS = NO
238
239# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
240# undocumented classes that are normally visible in the class hierarchy.
241# If set to NO (the default) these classes will be included in the various
242# overviews. This option has no effect if EXTRACT_ALL is enabled.
243
244HIDE_UNDOC_CLASSES = NO
245
246# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
247# friend (class|struct|union) declarations.
248# If set to NO (the default) these declarations will be included in the
249# documentation.
250
251HIDE_FRIEND_COMPOUNDS = NO
252
253# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
254# documentation blocks found inside the body of a function.
255# If set to NO (the default) these blocks will be appended to the
256# function's detailed documentation block.
257
258HIDE_IN_BODY_DOCS = NO
259
260# The INTERNAL_DOCS tag determines if documentation
261# that is typed after a \internal command is included. If the tag is set
262# to NO (the default) then the documentation will be excluded.
263# Set it to YES to include the internal documentation.
264
265INTERNAL_DOCS = NO
266
267# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
268# file names in lower-case letters. If set to YES upper-case letters are also
269# allowed. This is useful if you have classes or files whose names only differ
270# in case and if your file system supports case sensitive file names. Windows
271# and Mac users are advised to set this option to NO.
272
273CASE_SENSE_NAMES = YES
274
275# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
276# will show members with their full class and namespace scopes in the
277# documentation. If set to YES the scope will be hidden.
278
279HIDE_SCOPE_NAMES = NO
280
281# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
282# will put a list of the files that are included by a file in the documentation
283# of that file.
284
285SHOW_INCLUDE_FILES = YES
286
287# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
288# is inserted in the documentation for inline members.
289
290INLINE_INFO = YES
291
292# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
293# will sort the (detailed) documentation of file and class members
294# alphabetically by member name. If set to NO the members will appear in
295# declaration order.
296
297SORT_MEMBER_DOCS = NO
298
299# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
300# brief documentation of file, namespace and class members alphabetically
301# by member name. If set to NO (the default) the members will appear in
302# declaration order.
303
304SORT_BRIEF_DOCS = NO
305
306# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
307# sorted by fully-qualified names, including namespaces. If set to
308# NO (the default), the class list will be sorted only by class name,
309# not including the namespace part.
310# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
311# Note: This option applies only to the class list, not to the
312# alphabetical list.
313
314SORT_BY_SCOPE_NAME = NO
315
316# The GENERATE_TODOLIST tag can be used to enable (YES) or
317# disable (NO) the todo list. This list is created by putting \todo
318# commands in the documentation.
319
320GENERATE_TODOLIST = YES
321
322# The GENERATE_TESTLIST tag can be used to enable (YES) or
323# disable (NO) the test list. This list is created by putting \test
324# commands in the documentation.
325
326GENERATE_TESTLIST = YES
327
328# The GENERATE_BUGLIST tag can be used to enable (YES) or
329# disable (NO) the bug list. This list is created by putting \bug
330# commands in the documentation.
331
332GENERATE_BUGLIST = YES
333
334# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
335# disable (NO) the deprecated list. This list is created by putting
336# \deprecated commands in the documentation.
337
338GENERATE_DEPRECATEDLIST= YES
339
340# The ENABLED_SECTIONS tag can be used to enable conditional
341# documentation sections, marked by \if sectionname ... \endif.
342
343ENABLED_SECTIONS =
344
345# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
346# the initial value of a variable or define consists of for it to appear in
347# the documentation. If the initializer consists of more lines than specified
348# here it will be hidden. Use a value of 0 to hide initializers completely.
349# The appearance of the initializer of individual variables and defines in the
350# documentation can be controlled using \showinitializer or \hideinitializer
351# command in the documentation regardless of this setting.
352
353MAX_INITIALIZER_LINES = 30
354
355# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
356# at the bottom of the documentation of classes and structs. If set to YES the
357# list will mention the files that were used to generate the documentation.
358
359SHOW_USED_FILES = YES
360
361# If the sources in your project are distributed over multiple directories
362# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
363# in the documentation.
364
365SHOW_DIRECTORIES = NO
366
367#---------------------------------------------------------------------------
368# configuration options related to warning and progress messages
369#---------------------------------------------------------------------------
370
371# The QUIET tag can be used to turn on/off the messages that are generated
372# by doxygen. Possible values are YES and NO. If left blank NO is used.
373
374QUIET = NO
375
376# The WARNINGS tag can be used to turn on/off the warning messages that are
377# generated by doxygen. Possible values are YES and NO. If left blank
378# NO is used.
379
380WARNINGS = YES
381
382# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
383# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
384# automatically be disabled.
385
7537f3cf 386#WARN_IF_UNDOCUMENTED = YES
094f4788 387WARN_IF_UNDOCUMENTED = YES
12628611 388
389# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
390# potential errors in the documentation, such as not documenting some
391# parameters in a documented function, or documenting parameters that
392# don't exist or using markup commands wrongly.
393
394WARN_IF_DOC_ERROR = YES
395
396# The WARN_FORMAT tag determines the format of the warning messages that
397# doxygen can produce. The string should contain the $file, $line, and $text
398# tags, which will be replaced by the file and line number from which the
399# warning originated and the warning text.
400
401WARN_FORMAT = "$file:$line: $text"
402
403# The WARN_LOGFILE tag can be used to specify a file to which warning
404# and error messages should be written. If left blank the output is written
405# to stderr.
406
407WARN_LOGFILE =
408
409#---------------------------------------------------------------------------
410# configuration options related to the input files
411#---------------------------------------------------------------------------
412
413# The INPUT tag can be used to specify the files and/or directories that contain
414# documented source files. You may enter file names like "myfile.cpp" or
415# directories like "/usr/src/myproject". Separate the files or directories
416# with spaces.
417
e63d463b 418INPUT = . ../STEER ../EVGEN ../EVE/macros/alieve_init.C ../EVE/alice-macros/event_goto.C ../EVE/macros/muon_init.C ../EVE/alice-macros/esd_muon_tracks.C ../EVE/alice-macros/geom_gentle_muon.C ../EVE/alice-macros/muon_clusters.C ../EVE/alice-macros/muon_digits.C ../EVE/alice-macros/muon_raw.C ../EVE/alice-macros/muon_trackRefs.C ../EVE/alice-macros/MUON_displayData.C ../EVE/alice-macros/MUON_displaySimu.C ../EVE/alice-macros/MUON_geomAll.C ../EVE/alice-macros/MUON_geom.C ../EVE/alice-macros/MUON_makeGeom.C
094f4788 419#INPUT = .
12628611 420
421# If the value of the INPUT tag contains directories, you can use the
422# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
423# and *.h) to filter out the source-files in the directories. If left
424# blank the following patterns are tested:
425# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
426# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
427
535754fe 428FILE_PATTERNS = *.h *.cxx *.icc *.C README*.txt *.sh
12628611 429
430# The RECURSIVE tag can be used to turn specify whether or not subdirectories
431# should be searched for input files as well. Possible values are YES and NO.
432# If left blank NO is used.
433
434RECURSIVE = YES
435
436# The EXCLUDE tag can be used to specify files and/or directories that should
437# excluded from the INPUT source files. This way you can easily exclude a
438# subdirectory from a directory tree whose root is specified with the INPUT tag.
439
535754fe 440EXCLUDE = check muon_html test_out.100 tgt_linux
12628611 441
442# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
443# that are symbolic links (a Unix filesystem feature) are excluded from the input.
444
445EXCLUDE_SYMLINKS = NO
446
447# If the value of the INPUT tag contains directories, you can use the
448# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
449# certain files from those directories.
450
451EXCLUDE_PATTERNS = "G__*"
452
453# The EXAMPLE_PATH tag can be used to specify one or more files or
454# directories that contain example code fragments that are included (see
455# the \include command).
456
457EXAMPLE_PATH =
458
459# If the value of the EXAMPLE_PATH tag contains directories, you can use the
460# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
461# and *.h) to filter out the source-files in the directories. If left
462# blank all files are included.
463
464EXAMPLE_PATTERNS =
465
466# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
467# searched for input files to be used with the \include or \dontinclude
468# commands irrespective of the value of the RECURSIVE tag.
469# Possible values are YES and NO. If left blank NO is used.
470
471EXAMPLE_RECURSIVE = NO
472
473# The IMAGE_PATH tag can be used to specify one or more files or
474# directories that contain image that are included in the documentation (see
475# the \image command).
476
6589c175 477IMAGE_PATH = .
12628611 478
479# The INPUT_FILTER tag can be used to specify a program that doxygen should
480# invoke to filter for each input file. Doxygen will invoke the filter program
481# by executing (via popen()) the command <filter> <input-file>, where <filter>
482# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
483# input file. Doxygen will then use the output that the filter program writes
484# to standard output. If FILTER_PATTERNS is specified, this tag will be
485# ignored.
486
487INPUT_FILTER =
488
489# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
490# basis. Doxygen will compare the file name with each pattern and apply the
491# filter if there is a match. The filters are a list of the form:
492# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
493# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
494# is applied to all files.
495
496FILTER_PATTERNS =
497
498# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
499# INPUT_FILTER) will be used to filter the input files when producing source
500# files to browse (i.e. when SOURCE_BROWSER is set to YES).
501
502FILTER_SOURCE_FILES = NO
503
504#---------------------------------------------------------------------------
505# configuration options related to source browsing
506#---------------------------------------------------------------------------
507
508# If the SOURCE_BROWSER tag is set to YES then a list of source files will
509# be generated. Documented entities will be cross-referenced with these sources.
510# Note: To get rid of all source code in the generated output, make sure also
511# VERBATIM_HEADERS is set to NO.
512
513SOURCE_BROWSER = YES
514
515# Setting the INLINE_SOURCES tag to YES will include the body
516# of functions and classes directly in the documentation.
517
e75dac3c 518INLINE_SOURCES = NO
12628611 519
520# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
521# doxygen to hide any special comment blocks from generated source code
522# fragments. Normal C and C++ comments will always remain visible.
523
524STRIP_CODE_COMMENTS = NO
525
526# If the REFERENCED_BY_RELATION tag is set to YES (the default)
527# then for each documented function all documented
528# functions referencing it will be listed.
529
2ea0bebf 530REFERENCED_BY_RELATION = YES
12628611 531
532# If the REFERENCES_RELATION tag is set to YES (the default)
533# then for each documented function all documented entities
534# called/used by that function will be listed.
535
10eb3d17 536REFERENCES_RELATION = NO
12628611 537
538# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
539# will generate a verbatim copy of the header file for each class for
540# which an include is specified. Set to NO to disable this.
541
542VERBATIM_HEADERS = NO
543
544#---------------------------------------------------------------------------
545# configuration options related to the alphabetical class index
546#---------------------------------------------------------------------------
547
548# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
549# of all compounds will be generated. Enable this if the project
550# contains a lot of classes, structs, unions or interfaces.
551
552ALPHABETICAL_INDEX = YES
553
554# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
555# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
556# in which this list will be split (can be a number in the range [1..20])
557
558COLS_IN_ALPHA_INDEX = 2
559
560# In case all classes in a project start with a common prefix, all
561# classes will be put under the same header in the alphabetical index.
562# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
563# should be ignored while generating the index headers.
564
565IGNORE_PREFIX = AliMUON AliMp Ali
566
567#---------------------------------------------------------------------------
568# configuration options related to the HTML output
569#---------------------------------------------------------------------------
570
571# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
572# generate HTML output.
573
574GENERATE_HTML = YES
575
576# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
577# If a relative path is entered the value of OUTPUT_DIRECTORY will be
578# put in front of it. If left blank `html' will be used as the default path.
579
f1cb4ee8 580HTML_OUTPUT = muon_html
12628611 581
582# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
583# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
584# doxygen will generate files with .html extension.
585
586HTML_FILE_EXTENSION = .html
587
588# The HTML_HEADER tag can be used to specify a personal HTML header for
589# each generated HTML page. If it is left blank doxygen will generate a
590# standard header.
591
592HTML_HEADER =
593
594# The HTML_FOOTER tag can be used to specify a personal HTML footer for
595# each generated HTML page. If it is left blank doxygen will generate a
596# standard footer.
597
598HTML_FOOTER =
599
600# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
601# style sheet that is used by each HTML page. It can be used to
602# fine-tune the look of the HTML output. If the tag is left blank doxygen
603# will generate a default style sheet. Note that doxygen will try to copy
604# the style sheet file to the HTML output directory, so don't put your own
605# stylesheet in the HTML output directory as well, or it will be erased!
606
607HTML_STYLESHEET =
608
609# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
610# files or namespaces will be aligned in HTML using tables. If set to
611# NO a bullet list will be used.
612
613HTML_ALIGN_MEMBERS = YES
614
615# If the GENERATE_HTMLHELP tag is set to YES, additional index files
616# will be generated that can be used as input for tools like the
617# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
618# of the generated HTML documentation.
619
620GENERATE_HTMLHELP = NO
621
622# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
623# be used to specify the file name of the resulting .chm file. You
624# can add a path in front of the file if the result should not be
625# written to the html output directory.
626
627CHM_FILE =
628
629# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
630# be used to specify the location (absolute path including file name) of
631# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
632# the HTML help compiler on the generated index.hhp.
633
634HHC_LOCATION =
635
636# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
637# controls if a separate .chi index file is generated (YES) or that
638# it should be included in the master .chm file (NO).
639
640GENERATE_CHI = NO
641
642# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
643# controls whether a binary table of contents is generated (YES) or a
644# normal table of contents (NO) in the .chm file.
645
646BINARY_TOC = NO
647
648# The TOC_EXPAND flag can be set to YES to add extra items for group members
649# to the contents of the HTML help documentation and to the tree view.
650
651TOC_EXPAND = NO
652
653# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
654# top of each HTML page. The value NO (the default) enables the index and
655# the value YES disables it.
656
657DISABLE_INDEX = NO
658
659# This tag can be used to set the number of enum values (range [1..20])
660# that doxygen will group on one line in the generated HTML documentation.
661
662ENUM_VALUES_PER_LINE = 4
663
664# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
665# generated containing a tree-like index structure (just like the one that
666# is generated for HTML Help). For this to work a browser that supports
667# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
668# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
669# probably better off using the HTML help feature.
670
671GENERATE_TREEVIEW = NO
672
673# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
674# used to set the initial width (in pixels) of the frame in which the tree
675# is shown.
676
677TREEVIEW_WIDTH = 250
678
679#---------------------------------------------------------------------------
680# configuration options related to the LaTeX output
681#---------------------------------------------------------------------------
682
683# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
684# generate Latex output.
685
686GENERATE_LATEX = NO
687
688# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
689# If a relative path is entered the value of OUTPUT_DIRECTORY will be
690# put in front of it. If left blank `latex' will be used as the default path.
691
692LATEX_OUTPUT = latex
693
694# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
695# invoked. If left blank `latex' will be used as the default command name.
696
697LATEX_CMD_NAME = latex
698
699# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
700# generate index for LaTeX. If left blank `makeindex' will be used as the
701# default command name.
702
703MAKEINDEX_CMD_NAME = makeindex
704
705# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
706# LaTeX documents. This may be useful for small projects and may help to
707# save some trees in general.
708
709COMPACT_LATEX = NO
710
711# The PAPER_TYPE tag can be used to set the paper type that is used
712# by the printer. Possible values are: a4, a4wide, letter, legal and
713# executive. If left blank a4wide will be used.
714
715PAPER_TYPE = a4wide
716
717# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
718# packages that should be included in the LaTeX output.
719
720EXTRA_PACKAGES =
721
722# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
723# the generated latex document. The header should contain everything until
724# the first chapter. If it is left blank doxygen will generate a
725# standard header. Notice: only use this tag if you know what you are doing!
726
727LATEX_HEADER =
728
729# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
730# is prepared for conversion to pdf (using ps2pdf). The pdf file will
731# contain links (just like the HTML output) instead of page references
732# This makes the output suitable for online browsing using a pdf viewer.
733
734PDF_HYPERLINKS = NO
735
736# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
737# plain latex in the generated Makefile. Set this option to YES to get a
738# higher quality PDF documentation.
739
740USE_PDFLATEX = NO
741
742# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
743# command to the generated LaTeX files. This will instruct LaTeX to keep
744# running if errors occur, instead of asking the user for help.
745# This option is also used when generating formulas in HTML.
746
747LATEX_BATCHMODE = NO
748
749# If LATEX_HIDE_INDICES is set to YES then doxygen will not
750# include the index chapters (such as File Index, Compound Index, etc.)
751# in the output.
752
753LATEX_HIDE_INDICES = NO
754
755#---------------------------------------------------------------------------
756# configuration options related to the RTF output
757#---------------------------------------------------------------------------
758
759# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
760# The RTF output is optimized for Word 97 and may not look very pretty with
761# other RTF readers or editors.
762
763GENERATE_RTF = NO
764
765# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
766# If a relative path is entered the value of OUTPUT_DIRECTORY will be
767# put in front of it. If left blank `rtf' will be used as the default path.
768
769RTF_OUTPUT = rtf
770
771# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
772# RTF documents. This may be useful for small projects and may help to
773# save some trees in general.
774
775COMPACT_RTF = NO
776
777# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
778# will contain hyperlink fields. The RTF file will
779# contain links (just like the HTML output) instead of page references.
780# This makes the output suitable for online browsing using WORD or other
781# programs which support those fields.
782# Note: wordpad (write) and others do not support links.
783
784RTF_HYPERLINKS = NO
785
786# Load stylesheet definitions from file. Syntax is similar to doxygen's
787# config file, i.e. a series of assignments. You only have to provide
788# replacements, missing definitions are set to their default value.
789
790RTF_STYLESHEET_FILE =
791
792# Set optional variables used in the generation of an rtf document.
793# Syntax is similar to doxygen's config file.
794
795RTF_EXTENSIONS_FILE =
796
797#---------------------------------------------------------------------------
798# configuration options related to the man page output
799#---------------------------------------------------------------------------
800
801# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
802# generate man pages
803
804GENERATE_MAN = NO
805
806# The MAN_OUTPUT tag is used to specify where the man pages will be put.
807# If a relative path is entered the value of OUTPUT_DIRECTORY will be
808# put in front of it. If left blank `man' will be used as the default path.
809
810MAN_OUTPUT = man
811
812# The MAN_EXTENSION tag determines the extension that is added to
813# the generated man pages (default is the subroutine's section .3)
814
815MAN_EXTENSION = .3
816
817# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
818# then it will generate one additional man file for each entity
819# documented in the real man page(s). These additional files
820# only source the real man page, but without them the man command
821# would be unable to find the correct page. The default is NO.
822
823MAN_LINKS = NO
824
825#---------------------------------------------------------------------------
826# configuration options related to the XML output
827#---------------------------------------------------------------------------
828
829# If the GENERATE_XML tag is set to YES Doxygen will
830# generate an XML file that captures the structure of
831# the code including all documentation.
832
833GENERATE_XML = NO
834
835# The XML_OUTPUT tag is used to specify where the XML pages will be put.
836# If a relative path is entered the value of OUTPUT_DIRECTORY will be
837# put in front of it. If left blank `xml' will be used as the default path.
838
839XML_OUTPUT = xml
840
841# The XML_SCHEMA tag can be used to specify an XML schema,
842# which can be used by a validating XML parser to check the
843# syntax of the XML files.
844
845XML_SCHEMA =
846
847# The XML_DTD tag can be used to specify an XML DTD,
848# which can be used by a validating XML parser to check the
849# syntax of the XML files.
850
851XML_DTD =
852
853# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
854# dump the program listings (including syntax highlighting
855# and cross-referencing information) to the XML output. Note that
856# enabling this will significantly increase the size of the XML output.
857
858XML_PROGRAMLISTING = YES
859
860#---------------------------------------------------------------------------
861# configuration options for the AutoGen Definitions output
862#---------------------------------------------------------------------------
863
864# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
865# generate an AutoGen Definitions (see autogen.sf.net) file
866# that captures the structure of the code including all
867# documentation. Note that this feature is still experimental
868# and incomplete at the moment.
869
870GENERATE_AUTOGEN_DEF = NO
871
872#---------------------------------------------------------------------------
873# configuration options related to the Perl module output
874#---------------------------------------------------------------------------
875
876# If the GENERATE_PERLMOD tag is set to YES Doxygen will
877# generate a Perl module file that captures the structure of
878# the code including all documentation. Note that this
879# feature is still experimental and incomplete at the
880# moment.
881
882GENERATE_PERLMOD = NO
883
884# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
885# the necessary Makefile rules, Perl scripts and LaTeX code to be able
886# to generate PDF and DVI output from the Perl module output.
887
888PERLMOD_LATEX = NO
889
890# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
891# nicely formatted so it can be parsed by a human reader. This is useful
892# if you want to understand what is going on. On the other hand, if this
893# tag is set to NO the size of the Perl module output will be much smaller
894# and Perl will parse it just the same.
895
896PERLMOD_PRETTY = YES
897
898# The names of the make variables in the generated doxyrules.make file
899# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
900# This is useful so different doxyrules.make files included by the same
901# Makefile don't overwrite each other's variables.
902
903PERLMOD_MAKEVAR_PREFIX =
904
905#---------------------------------------------------------------------------
906# Configuration options related to the preprocessor
907#---------------------------------------------------------------------------
908
909# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
910# evaluate all C-preprocessor directives found in the sources and include
911# files.
912
e75dac3c 913ENABLE_PREPROCESSING = YES
12628611 914
915# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
916# names in the source code. If set to NO (the default) only conditional
917# compilation will be performed. Macro expansion can be done in a controlled
918# way by setting EXPAND_ONLY_PREDEF to YES.
919
920MACRO_EXPANSION = NO
921
922# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
923# then the macro expansion is limited to the macros specified with the
924# PREDEFINED and EXPAND_AS_PREDEFINED tags.
925
926EXPAND_ONLY_PREDEF = NO
927
928# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
929# in the INCLUDE_PATH (see below) will be search if a #include is found.
930
931SEARCH_INCLUDES = YES
932
933# The INCLUDE_PATH tag can be used to specify one or more directories that
934# contain include files that are not input files but should be processed by
935# the preprocessor.
936
ff549f4f 937INCLUDE_PATH =
12628611 938
939# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
940# patterns (like *.h and *.hpp) to filter out the header-files in the
941# directories. If left blank, the patterns specified with FILE_PATTERNS will
942# be used.
943
944INCLUDE_FILE_PATTERNS =
945
946# The PREDEFINED tag can be used to specify one or more macro names that
947# are defined before the preprocessor is started (similar to the -D option of
948# gcc). The argument of the tag is a list of macros of the form: name
949# or name=definition (no spaces). If the definition and the = are
950# omitted =1 is assumed. To prevent a macro definition from being
951# undefined via #undef or recursively expanded use the := operator
952# instead of the = operator.
953
954PREDEFINED =
955
956# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
957# this tag can be used to specify a list of macro names that should be expanded.
958# The macro definition that is found in the sources will be used.
959# Use the PREDEFINED tag if you want to use a different macro definition.
960
961EXPAND_AS_DEFINED =
962
963# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
964# doxygen's preprocessor will remove all function-like macros that are alone
965# on a line, have an all uppercase name, and do not end with a semicolon. Such
966# function macros are typically used for boiler-plate code, and will confuse the
967# parser if not removed.
968
969SKIP_FUNCTION_MACROS = YES
970
971#---------------------------------------------------------------------------
972# Configuration::additions related to external references
973#---------------------------------------------------------------------------
974
975# The TAGFILES option can be used to specify one or more tagfiles.
976# Optionally an initial location of the external documentation
977# can be added for each tagfile. The format of a tag file without
978# this location is as follows:
979# TAGFILES = file1 file2 ...
980# Adding location for the tag files is done as follows:
981# TAGFILES = file1=loc1 "file2 = loc2" ...
982# where "loc1" and "loc2" can be relative or absolute paths or
983# URLs. If a location is present for each tag, the installdox tool
984# does not have to be run to correct the links.
985# Note that each tag file must have a unique name
986# (where the name does NOT include the path)
987# If a tag file is not located in the directory in which doxygen
988# is run, you must also specify the path to the tagfile here.
989
990TAGFILES =
991
992# When a file name is specified after GENERATE_TAGFILE, doxygen will create
993# a tag file that is based on the input files it reads.
994
995GENERATE_TAGFILE =
996
997# If the ALLEXTERNALS tag is set to YES all external classes will be listed
998# in the class index. If set to NO only the inherited external classes
999# will be listed.
1000
1001ALLEXTERNALS = NO
1002
1003# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1004# in the modules index. If set to NO, only the current project's groups will
1005# be listed.
1006
1007EXTERNAL_GROUPS = YES
1008
1009# The PERL_PATH should be the absolute path and name of the perl script
1010# interpreter (i.e. the result of `which perl').
1011
1012PERL_PATH = /usr/bin/perl
1013
1014#---------------------------------------------------------------------------
1015# Configuration options related to the dot tool
1016#---------------------------------------------------------------------------
1017
1018# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1019# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
1020# super classes. Setting the tag to NO turns the diagrams off. Note that this
1021# option is superseded by the HAVE_DOT option below. This is only a fallback. It is
1022# recommended to install and use dot, since it yields more powerful graphs.
1023
1024CLASS_DIAGRAMS = YES
1025
1026# If set to YES, the inheritance and collaboration graphs will hide
1027# inheritance and usage relations if the target is undocumented
1028# or is not a class.
1029
1030HIDE_UNDOC_RELATIONS = NO
1031
1032# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1033# available from the path. This tool is part of Graphviz, a graph visualization
1034# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1035# have no effect if this option is set to NO (the default)
1036
1037HAVE_DOT = YES
1038
1039# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1040# will generate a graph for each documented class showing the direct and
1041# indirect inheritance relations. Setting this tag to YES will force the
1042# the CLASS_DIAGRAMS tag to NO.
1043
1044CLASS_GRAPH = YES
1045
1046# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1047# will generate a graph for each documented class showing the direct and
1048# indirect implementation dependencies (inheritance, containment, and
1049# class references variables) of the class with other documented classes.
1050
1051COLLABORATION_GRAPH = YES
1052
1053# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1054# collaboration diagrams in a style similar to the OMG's Unified Modeling
1055# Language.
1056
1057UML_LOOK = NO
1058
1059# If set to YES, the inheritance and collaboration graphs will show the
1060# relations between templates and their instances.
1061
1062TEMPLATE_RELATIONS = NO
1063
1064# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1065# tags are set to YES then doxygen will generate a graph for each documented
1066# file showing the direct and indirect include dependencies of the file with
1067# other documented files.
1068
1069INCLUDE_GRAPH = YES
1070
1071# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1072# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1073# documented header file showing the documented files that directly or
1074# indirectly include this file.
1075
1076INCLUDED_BY_GRAPH = YES
1077
1078# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1079# generate a call dependency graph for every global function or class method.
1080# Note that enabling this option will significantly increase the time of a run.
1081# So in most cases it will be better to enable call graphs for selected
1082# functions only using the \callgraph command.
1083
1084CALL_GRAPH = NO
1085
1086# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1087# will graphical hierarchy of all classes instead of a textual one.
1088
1089GRAPHICAL_HIERARCHY = YES
1090
1091# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1092# generated by dot. Possible values are png, jpg, or gif
1093# If left blank png will be used.
1094
1095DOT_IMAGE_FORMAT = png
1096
1097# The tag DOT_PATH can be used to specify the path where the dot tool can be
1098# found. If left blank, it is assumed the dot tool can be found on the path.
1099
1100DOT_PATH =
1101
1102# The DOTFILE_DIRS tag can be used to specify one or more directories that
1103# contain dot files that are included in the documentation (see the
1104# \dotfile command).
1105
1106DOTFILE_DIRS =
1107
12628611 1108# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1109# generate a legend page explaining the meaning of the various boxes and
1110# arrows in the dot generated graphs.
1111
1112GENERATE_LEGEND = YES
1113
1114# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1115# remove the intermediate dot files that are used to generate
1116# the various graphs.
1117
1118DOT_CLEANUP = YES
1119
1120#---------------------------------------------------------------------------
1121# Configuration::additions related to the search engine
1122#---------------------------------------------------------------------------
1123
1124# The SEARCHENGINE tag specifies whether or not a search engine should be
1125# used. If set to NO the values of all tags below this one will be ignored.
1126
1127SEARCHENGINE = NO