doxy: MUON macros, refs, src links, no coll graph
[u/mrichter/AliRoot.git] / doxygen / Doxyfile.in
CommitLineData
36e6bf88 1# Doxyfile 1.8.9
a2a27b4c 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 double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
10# The format is:
11# TAG = value [value, ...]
12# For lists, items can also be appended using:
13# TAG += value [value, ...]
14# Values that contain spaces should be placed between quotes (\" \").
15
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
19
20# This tag specifies the encoding used for all characters in the config file
21# that follow. The default is UTF-8 which is also the encoding used for all text
22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24# for the list of possible encodings.
25# The default value is: UTF-8.
26
27DOXYFILE_ENCODING = UTF-8
28
29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30# double-quotes, unless you are using Doxywizard) that should identify the
31# project for which the documentation is generated. This name is used in the
32# title of most generated pages and in a few other places.
33# The default value is: My Project.
34
63dcde9a 35PROJECT_NAME = "AliRoot Core"
a2a27b4c 36
37# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38# could be handy for archiving the generated documentation or if some version
39# control system is used.
40
63dcde9a 41PROJECT_NUMBER = "@ALIROOT_VERSION@ (@GIT_SHORT_SHA1@)"
a2a27b4c 42
43# Using the PROJECT_BRIEF tag one can provide an optional one line description
44# for a project that appears at the top of each page and should give viewer a
45# quick idea about the purpose of the project. Keep the description short.
46
36e6bf88 47PROJECT_BRIEF =
a2a27b4c 48
36e6bf88 49# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50# in the documentation. The maximum height of the logo should not exceed 55
51# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52# the logo to the output directory.
a2a27b4c 53
937690e5 54PROJECT_LOGO = @CMAKE_CURRENT_SOURCE_DIR@/img/alice_logo_clearbg.png
a2a27b4c 55
56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57# into which the generated documentation will be written. If a relative path is
58# entered, it will be relative to the location where doxygen was started. If
59# left blank the current directory will be used.
60
63dcde9a 61OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
a2a27b4c 62
36e6bf88 63# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
a2a27b4c 64# directories (in 2 levels) under the output directory of each output format and
65# will distribute the generated files over these directories. Enabling this
66# option can be useful when feeding doxygen a huge amount of source files, where
67# putting all generated files in the same directory would otherwise causes
68# performance problems for the file system.
69# The default value is: NO.
70
71CREATE_SUBDIRS = NO
72
73# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74# characters to appear in the names of generated files. If set to NO, non-ASCII
75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76# U+3044.
77# The default value is: NO.
78
79ALLOW_UNICODE_NAMES = NO
80
81# The OUTPUT_LANGUAGE tag is used to specify the language in which all
82# documentation generated by doxygen is written. Doxygen will use this
83# information to generate all constant output in the proper language.
84# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91# Ukrainian and Vietnamese.
92# The default value is: English.
93
94OUTPUT_LANGUAGE = English
95
36e6bf88 96# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
a2a27b4c 97# descriptions after the members that are listed in the file and class
98# documentation (similar to Javadoc). Set to NO to disable this.
99# The default value is: YES.
100
101BRIEF_MEMBER_DESC = YES
102
36e6bf88 103# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
a2a27b4c 104# description of a member or function before the detailed description
105#
106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107# brief descriptions will be completely suppressed.
108# The default value is: YES.
109
110REPEAT_BRIEF = YES
111
112# This tag implements a quasi-intelligent brief description abbreviator that is
113# used to form the text in various listings. Each string in this list, if found
114# as the leading text of the brief description, will be stripped from the text
115# and the result, after processing the whole list, is used as the annotated
116# text. Otherwise, the brief description is used as-is. If left blank, the
117# following values are used ($name is automatically replaced with the name of
118# the entity):The $name class, The $name widget, The $name file, is, provides,
119# specifies, contains, represents, a, an and the.
120
36e6bf88 121ABBREVIATE_BRIEF =
a2a27b4c 122
123# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124# doxygen will generate a detailed section even if there is only a brief
125# description.
126# The default value is: NO.
127
128ALWAYS_DETAILED_SEC = NO
129
130# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131# inherited members of a class in the documentation of that class as if those
132# members were ordinary class members. Constructors, destructors and assignment
133# operators of the base classes will not be shown.
134# The default value is: NO.
135
136INLINE_INHERITED_MEMB = NO
137
36e6bf88 138# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
a2a27b4c 139# before files name in the file list and in the header files. If set to NO the
140# shortest path that makes the file name unique will be used
141# The default value is: YES.
142
143FULL_PATH_NAMES = YES
144
145# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146# Stripping is only done if one of the specified strings matches the left-hand
147# part of the path. The tag can be used to show relative paths in the file list.
148# If left blank the directory from which doxygen is run is used as the path to
149# strip.
150#
151# Note that you can specify absolute paths here, but also relative paths, which
152# will be relative from the directory where doxygen is started.
153# This tag requires that the tag FULL_PATH_NAMES is set to YES.
154
b3fd2f9f 155STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@
a2a27b4c 156
157# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158# path mentioned in the documentation of a class, which tells the reader which
159# header file to include in order to use a class. If left blank only the name of
160# the header file containing the class definition is used. Otherwise one should
161# specify the list of include paths that are normally passed to the compiler
162# using the -I flag.
163
36e6bf88 164STRIP_FROM_INC_PATH =
a2a27b4c 165
166# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167# less readable) file names. This can be useful is your file systems doesn't
168# support long names like on DOS, Mac, or CD-ROM.
169# The default value is: NO.
170
171SHORT_NAMES = NO
172
173# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174# first line (until the first dot) of a Javadoc-style comment as the brief
175# description. If set to NO, the Javadoc-style will behave just like regular Qt-
176# style comments (thus requiring an explicit @brief command for a brief
177# description.)
178# The default value is: NO.
179
180JAVADOC_AUTOBRIEF = NO
181
182# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183# line (until the first dot) of a Qt-style comment as the brief description. If
184# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185# requiring an explicit \brief command for a brief description.)
186# The default value is: NO.
187
188QT_AUTOBRIEF = NO
189
190# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192# a brief description. This used to be the default behavior. The new default is
193# to treat a multi-line C++ comment block as a detailed description. Set this
194# tag to YES if you prefer the old behavior instead.
195#
196# Note that setting this tag to YES also means that rational rose comments are
197# not recognized any more.
198# The default value is: NO.
199
200MULTILINE_CPP_IS_BRIEF = NO
201
202# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203# documentation from any documented member that it re-implements.
204# The default value is: YES.
205
206INHERIT_DOCS = YES
207
36e6bf88 208# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
209# page for each member. If set to NO, the documentation of a member will be part
210# of the file/class/namespace that contains it.
a2a27b4c 211# The default value is: NO.
212
213SEPARATE_MEMBER_PAGES = NO
214
215# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216# uses this value to replace tabs by spaces in code fragments.
217# Minimum value: 1, maximum value: 16, default value: 4.
218
219TAB_SIZE = 2
220
221# This tag can be used to specify a number of aliases that act as commands in
222# the documentation. An alias has the form:
223# name=value
224# For example adding
225# "sideeffect=@par Side Effects:\n"
226# will allow you to put the command \sideeffect (or @sideeffect) in the
227# documentation, which will result in a user-defined paragraph with heading
228# "Side Effects:". You can put \n's in the value part of an alias to insert
229# newlines.
230
36e6bf88 231ALIASES =
a2a27b4c 232
233# This tag can be used to specify a number of word-keyword mappings (TCL only).
234# A mapping has the form "name=value". For example adding "class=itcl::class"
235# will allow you to use the command class in the itcl::class meaning.
236
36e6bf88 237TCL_SUBST =
a2a27b4c 238
239# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240# only. Doxygen will then generate output that is more tailored for C. For
241# instance, some of the names that are used will be different. The list of all
242# members will be omitted, etc.
243# The default value is: NO.
244
245OPTIMIZE_OUTPUT_FOR_C = NO
246
247# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
248# Python sources only. Doxygen will then generate output that is more tailored
249# for that language. For instance, namespaces will be presented as packages,
250# qualified scopes will look different, etc.
251# The default value is: NO.
252
253OPTIMIZE_OUTPUT_JAVA = NO
254
255# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
256# sources. Doxygen will then generate output that is tailored for Fortran.
257# The default value is: NO.
258
259OPTIMIZE_FOR_FORTRAN = NO
260
261# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
262# sources. Doxygen will then generate output that is tailored for VHDL.
263# The default value is: NO.
264
265OPTIMIZE_OUTPUT_VHDL = NO
266
267# Doxygen selects the parser to use depending on the extension of the files it
268# parses. With this tag you can assign which parser to use for a given
269# extension. Doxygen has a built-in mapping, but you can override or extend it
270# using this tag. The format is ext=language, where ext is a file extension, and
271# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
272# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
273# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
274# Fortran. In the later case the parser tries to guess whether the code is fixed
275# or free formatted code, this is the default for Fortran type files), VHDL. For
276# instance to make doxygen treat .inc files as Fortran files (default is PHP),
277# and .f files as C (default is Fortran), use: inc=Fortran f=C.
278#
36e6bf88 279# Note: For files without extension you can use no_extension as a placeholder.
a2a27b4c 280#
281# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
282# the files are not read by doxygen.
283
36e6bf88 284EXTENSION_MAPPING =
a2a27b4c 285
286# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
287# according to the Markdown format, which allows for more readable
288# documentation. See http://daringfireball.net/projects/markdown/ for details.
289# The output of markdown processing is further processed by doxygen, so you can
290# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
291# case of backward compatibilities issues.
292# The default value is: YES.
293
294MARKDOWN_SUPPORT = YES
295
296# When enabled doxygen tries to link words that correspond to documented
297# classes, or namespaces to their corresponding documentation. Such a link can
36e6bf88 298# be prevented in individual cases by putting a % sign in front of the word or
299# globally by setting AUTOLINK_SUPPORT to NO.
a2a27b4c 300# The default value is: YES.
301
302AUTOLINK_SUPPORT = YES
303
304# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
305# to include (a tag file for) the STL sources as input, then you should set this
306# tag to YES in order to let doxygen match functions declarations and
307# definitions whose arguments contain STL classes (e.g. func(std::string);
308# versus func(std::string) {}). This also make the inheritance and collaboration
309# diagrams that involve STL classes more complete and accurate.
310# The default value is: NO.
311
312BUILTIN_STL_SUPPORT = NO
313
314# If you use Microsoft's C++/CLI language, you should set this option to YES to
315# enable parsing support.
316# The default value is: NO.
317
318CPP_CLI_SUPPORT = NO
319
320# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
321# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
322# will parse them like normal C++ but will assume all classes use public instead
323# of private inheritance when no explicit protection keyword is present.
324# The default value is: NO.
325
326SIP_SUPPORT = NO
327
328# For Microsoft's IDL there are propget and propput attributes to indicate
329# getter and setter methods for a property. Setting this option to YES will make
330# doxygen to replace the get and set methods by a property in the documentation.
331# This will only work if the methods are indeed getting or setting a simple
332# type. If this is not the case, or you want to show the methods anyway, you
333# should set this option to NO.
334# The default value is: YES.
335
336IDL_PROPERTY_SUPPORT = YES
337
338# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
36e6bf88 339# tag is set to YES then doxygen will reuse the documentation of the first
a2a27b4c 340# member in the group (if any) for the other members of the group. By default
341# all members of a group must be documented explicitly.
342# The default value is: NO.
343
344DISTRIBUTE_GROUP_DOC = NO
345
346# Set the SUBGROUPING tag to YES to allow class member groups of the same type
347# (for instance a group of public functions) to be put as a subgroup of that
348# type (e.g. under the Public Functions section). Set it to NO to prevent
349# subgrouping. Alternatively, this can be done per class using the
350# \nosubgrouping command.
351# The default value is: YES.
352
353SUBGROUPING = YES
354
355# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
356# are shown inside the group in which they are included (e.g. using \ingroup)
357# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
358# and RTF).
359#
360# Note that this feature does not work in combination with
361# SEPARATE_MEMBER_PAGES.
362# The default value is: NO.
363
364INLINE_GROUPED_CLASSES = NO
365
366# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
367# with only public data fields or simple typedef fields will be shown inline in
368# the documentation of the scope in which they are defined (i.e. file,
369# namespace, or group documentation), provided this scope is documented. If set
370# to NO, structs, classes, and unions are shown on a separate page (for HTML and
371# Man pages) or section (for LaTeX and RTF).
372# The default value is: NO.
373
374INLINE_SIMPLE_STRUCTS = NO
375
376# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
377# enum is documented as struct, union, or enum with the name of the typedef. So
378# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
379# with name TypeT. When disabled the typedef will appear as a member of a file,
380# namespace, or class. And the struct will be named TypeS. This can typically be
381# useful for C code in case the coding convention dictates that all compound
382# types are typedef'ed and only the typedef is referenced, never the tag name.
383# The default value is: NO.
384
385TYPEDEF_HIDES_STRUCT = NO
386
387# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
388# cache is used to resolve symbols given their name and scope. Since this can be
389# an expensive process and often the same symbol appears multiple times in the
390# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
391# doxygen will become slower. If the cache is too large, memory is wasted. The
392# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
393# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
394# symbols. At the end of a run doxygen will report the cache usage and suggest
395# the optimal cache size from a speed point of view.
396# Minimum value: 0, maximum value: 9, default value: 0.
397
398LOOKUP_CACHE_SIZE = 0
399
400#---------------------------------------------------------------------------
401# Build related configuration options
402#---------------------------------------------------------------------------
403
36e6bf88 404# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
a2a27b4c 405# documentation are documented, even if no documentation was available. Private
406# class members and static file members will be hidden unless the
407# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
408# Note: This will also disable the warnings about undocumented members that are
409# normally produced when WARNINGS is set to YES.
410# The default value is: NO.
411
9c227c3d 412EXTRACT_ALL = YES
a2a27b4c 413
36e6bf88 414# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
a2a27b4c 415# be included in the documentation.
416# The default value is: NO.
417
9c227c3d 418EXTRACT_PRIVATE = YES
a2a27b4c 419
36e6bf88 420# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
a2a27b4c 421# scope will be included in the documentation.
422# The default value is: NO.
423
424EXTRACT_PACKAGE = NO
425
36e6bf88 426# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
a2a27b4c 427# included in the documentation.
428# The default value is: NO.
429
9c227c3d 430EXTRACT_STATIC = YES
a2a27b4c 431
36e6bf88 432# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
433# locally in source files will be included in the documentation. If set to NO,
a2a27b4c 434# only classes defined in header files are included. Does not have any effect
435# for Java sources.
436# The default value is: YES.
437
438EXTRACT_LOCAL_CLASSES = YES
439
36e6bf88 440# This flag is only useful for Objective-C code. If set to YES, local methods,
a2a27b4c 441# which are defined in the implementation section but not in the interface are
36e6bf88 442# included in the documentation. If set to NO, only methods in the interface are
a2a27b4c 443# included.
444# The default value is: NO.
445
446EXTRACT_LOCAL_METHODS = NO
447
448# If this flag is set to YES, the members of anonymous namespaces will be
449# extracted and appear in the documentation as a namespace called
450# 'anonymous_namespace{file}', where file will be replaced with the base name of
451# the file that contains the anonymous namespace. By default anonymous namespace
452# are hidden.
453# The default value is: NO.
454
455EXTRACT_ANON_NSPACES = NO
456
457# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
458# undocumented members inside documented classes or files. If set to NO these
459# members will be included in the various overviews, but no documentation
460# section is generated. This option has no effect if EXTRACT_ALL is enabled.
461# The default value is: NO.
462
463HIDE_UNDOC_MEMBERS = NO
464
465# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
466# undocumented classes that are normally visible in the class hierarchy. If set
36e6bf88 467# to NO, these classes will be included in the various overviews. This option
468# has no effect if EXTRACT_ALL is enabled.
a2a27b4c 469# The default value is: NO.
470
471HIDE_UNDOC_CLASSES = NO
472
473# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
36e6bf88 474# (class|struct|union) declarations. If set to NO, these declarations will be
a2a27b4c 475# included in the documentation.
476# The default value is: NO.
477
478HIDE_FRIEND_COMPOUNDS = NO
479
480# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
36e6bf88 481# documentation blocks found inside the body of a function. If set to NO, these
a2a27b4c 482# blocks will be appended to the function's detailed documentation block.
483# The default value is: NO.
484
485HIDE_IN_BODY_DOCS = NO
486
487# The INTERNAL_DOCS tag determines if documentation that is typed after a
488# \internal command is included. If the tag is set to NO then the documentation
489# will be excluded. Set it to YES to include the internal documentation.
490# The default value is: NO.
491
492INTERNAL_DOCS = NO
493
494# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
36e6bf88 495# names in lower-case letters. If set to YES, upper-case letters are also
a2a27b4c 496# allowed. This is useful if you have classes or files whose names only differ
497# in case and if your file system supports case sensitive file names. Windows
498# and Mac users are advised to set this option to NO.
499# The default value is: system dependent.
500
501CASE_SENSE_NAMES = NO
502
503# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
36e6bf88 504# their full class and namespace scopes in the documentation. If set to YES, the
a2a27b4c 505# scope will be hidden.
506# The default value is: NO.
507
508HIDE_SCOPE_NAMES = NO
509
36e6bf88 510# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
511# append additional text to a page's title, such as Class Reference. If set to
512# YES the compound reference will be hidden.
513# The default value is: NO.
514
515HIDE_COMPOUND_REFERENCE= NO
516
a2a27b4c 517# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
518# the files that are included by a file in the documentation of that file.
519# The default value is: YES.
520
521SHOW_INCLUDE_FILES = YES
522
523# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
524# grouped member an include statement to the documentation, telling the reader
525# which file to include in order to use the member.
526# The default value is: NO.
527
528SHOW_GROUPED_MEMB_INC = NO
529
530# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
531# files with double quotes in the documentation rather than with sharp brackets.
532# The default value is: NO.
533
534FORCE_LOCAL_INCLUDES = NO
535
536# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
537# documentation for inline members.
538# The default value is: YES.
539
540INLINE_INFO = YES
541
542# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
543# (detailed) documentation of file and class members alphabetically by member
36e6bf88 544# name. If set to NO, the members will appear in declaration order.
a2a27b4c 545# The default value is: YES.
546
547SORT_MEMBER_DOCS = YES
548
549# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
550# descriptions of file, namespace and class members alphabetically by member
36e6bf88 551# name. If set to NO, the members will appear in declaration order. Note that
a2a27b4c 552# this will also influence the order of the classes in the class list.
553# The default value is: NO.
554
555SORT_BRIEF_DOCS = NO
556
557# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
558# (brief and detailed) documentation of class members so that constructors and
559# destructors are listed first. If set to NO the constructors will appear in the
560# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
561# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
562# member documentation.
563# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
564# detailed member documentation.
565# The default value is: NO.
566
567SORT_MEMBERS_CTORS_1ST = NO
568
569# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
570# of group names into alphabetical order. If set to NO the group names will
571# appear in their defined order.
572# The default value is: NO.
573
574SORT_GROUP_NAMES = NO
575
576# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
577# fully-qualified names, including namespaces. If set to NO, the class list will
578# be sorted only by class name, not including the namespace part.
579# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
580# Note: This option applies only to the class list, not to the alphabetical
581# list.
582# The default value is: NO.
583
584SORT_BY_SCOPE_NAME = NO
585
586# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
587# type resolution of all parameters of a function it will reject a match between
588# the prototype and the implementation of a member function even if there is
589# only one candidate or it is obvious which candidate to choose by doing a
590# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
591# accept a match between prototype and implementation in such cases.
592# The default value is: NO.
593
594STRICT_PROTO_MATCHING = NO
595
36e6bf88 596# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
597# list. This list is created by putting \todo commands in the documentation.
a2a27b4c 598# The default value is: YES.
599
600GENERATE_TODOLIST = YES
601
36e6bf88 602# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
603# list. This list is created by putting \test commands in the documentation.
a2a27b4c 604# The default value is: YES.
605
606GENERATE_TESTLIST = YES
607
36e6bf88 608# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
a2a27b4c 609# list. This list is created by putting \bug commands in the documentation.
610# The default value is: YES.
611
612GENERATE_BUGLIST = YES
613
36e6bf88 614# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
a2a27b4c 615# the deprecated list. This list is created by putting \deprecated commands in
616# the documentation.
617# The default value is: YES.
618
619GENERATE_DEPRECATEDLIST= YES
620
621# The ENABLED_SECTIONS tag can be used to enable conditional documentation
622# sections, marked by \if <section_label> ... \endif and \cond <section_label>
623# ... \endcond blocks.
624
36e6bf88 625ENABLED_SECTIONS =
a2a27b4c 626
627# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
628# initial value of a variable or macro / define can have for it to appear in the
629# documentation. If the initializer consists of more lines than specified here
630# it will be hidden. Use a value of 0 to hide initializers completely. The
631# appearance of the value of individual variables and macros / defines can be
632# controlled using \showinitializer or \hideinitializer command in the
633# documentation regardless of this setting.
634# Minimum value: 0, maximum value: 10000, default value: 30.
635
636MAX_INITIALIZER_LINES = 30
637
638# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
36e6bf88 639# the bottom of the documentation of classes and structs. If set to YES, the
640# list will mention the files that were used to generate the documentation.
a2a27b4c 641# The default value is: YES.
642
643SHOW_USED_FILES = YES
644
645# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
646# will remove the Files entry from the Quick Index and from the Folder Tree View
647# (if specified).
648# The default value is: YES.
649
650SHOW_FILES = YES
651
652# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
653# page. This will remove the Namespaces entry from the Quick Index and from the
654# Folder Tree View (if specified).
655# The default value is: YES.
656
657SHOW_NAMESPACES = YES
658
659# The FILE_VERSION_FILTER tag can be used to specify a program or script that
660# doxygen should invoke to get the current version for each file (typically from
661# the version control system). Doxygen will invoke the program by executing (via
662# popen()) the command command input-file, where command is the value of the
663# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
664# by doxygen. Whatever the program writes to standard output is used as the file
665# version. For an example see the documentation.
666
36e6bf88 667FILE_VERSION_FILTER =
a2a27b4c 668
669# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
670# by doxygen. The layout file controls the global structure of the generated
671# output files in an output format independent way. To create the layout file
672# that represents doxygen's defaults, run doxygen with the -l option. You can
673# optionally specify a file name after the option, if omitted DoxygenLayout.xml
674# will be used as the name of the layout file.
675#
676# Note that if you run doxygen from a directory containing a file called
677# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
678# tag is left empty.
679
36e6bf88 680LAYOUT_FILE =
a2a27b4c 681
682# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
683# the reference definitions. This must be a list of .bib files. The .bib
684# extension is automatically appended if omitted. This requires the bibtex tool
685# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
686# For LaTeX the style of the bibliography can be controlled using
687# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
688# search path. See also \cite for info how to create references.
689
36e6bf88 690CITE_BIB_FILES =
a2a27b4c 691
692#---------------------------------------------------------------------------
693# Configuration options related to warning and progress messages
694#---------------------------------------------------------------------------
695
696# The QUIET tag can be used to turn on/off the messages that are generated to
697# standard output by doxygen. If QUIET is set to YES this implies that the
698# messages are off.
699# The default value is: NO.
700
701QUIET = NO
702
703# The WARNINGS tag can be used to turn on/off the warning messages that are
36e6bf88 704# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
a2a27b4c 705# this implies that the warnings are on.
706#
707# Tip: Turn warnings on while writing the documentation.
708# The default value is: YES.
709
710WARNINGS = YES
711
36e6bf88 712# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
a2a27b4c 713# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
714# will automatically be disabled.
715# The default value is: YES.
716
36e6bf88 717WARN_IF_UNDOCUMENTED = NO
a2a27b4c 718
719# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
720# potential errors in the documentation, such as not documenting some parameters
721# in a documented function, or documenting parameters that don't exist or using
722# markup commands wrongly.
723# The default value is: YES.
724
725WARN_IF_DOC_ERROR = YES
726
727# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
728# are documented, but have no documentation for their parameters or return
36e6bf88 729# value. If set to NO, doxygen will only warn about wrong or incomplete
730# parameter documentation, but not about the absence of documentation.
a2a27b4c 731# The default value is: NO.
732
733WARN_NO_PARAMDOC = NO
734
735# The WARN_FORMAT tag determines the format of the warning messages that doxygen
736# can produce. The string should contain the $file, $line, and $text tags, which
737# will be replaced by the file and line number from which the warning originated
738# and the warning text. Optionally the format may contain $version, which will
739# be replaced by the version of the file (if it could be obtained via
740# FILE_VERSION_FILTER)
741# The default value is: $file:$line: $text.
742
743WARN_FORMAT = "$file:$line: $text"
744
745# The WARN_LOGFILE tag can be used to specify a file to which warning and error
746# messages should be written. If left blank the output is written to standard
747# error (stderr).
748
36e6bf88 749WARN_LOGFILE =
a2a27b4c 750
751#---------------------------------------------------------------------------
752# Configuration options related to the input files
753#---------------------------------------------------------------------------
754
755# The INPUT tag is used to specify the files and/or directories that contain
756# documented source files. You may enter file names like myfile.cpp or
757# directories like /usr/src/myproject. Separate the files or directories with
758# spaces.
759# Note: If this tag is empty the current directory is searched.
760
67be9434 761INPUT = @CMAKE_SOURCE_DIR@/doxygen \
71531a24 762 @CMAKE_SOURCE_DIR@/TPC \
d687eb80 763 @CMAKE_SOURCE_DIR@/TPC/Attic \
f29f1f3d 764 @CMAKE_SOURCE_DIR@/TPC/Base/test \
35d81915 765 @CMAKE_SOURCE_DIR@/TPC/Cal \
17ad8c53 766 @CMAKE_SOURCE_DIR@/TPC/CalibMacros \
2530f897 767 @CMAKE_SOURCE_DIR@/TPC/DA \
457c0713 768 @CMAKE_SOURCE_DIR@/TPC/fastSimul \
04fcac58 769 @CMAKE_SOURCE_DIR@/TPC/macros \
0903a34c 770 @CMAKE_SOURCE_DIR@/TPC/macros/clusterMacros \
1db00cb5 771 @CMAKE_SOURCE_DIR@/TPC/macros/data2011 \
772 @CMAKE_SOURCE_DIR@/TPC/scripts \
773 @CMAKE_SOURCE_DIR@/TPC/scripts/OCDBscan \
30933baa 774 @CMAKE_SOURCE_DIR@/TPC/scripts/OCDBscan/jdl \
d37e991a 775 @CMAKE_SOURCE_DIR@/TPC/stressTest/testSparse \
9954d4a4 776 @CMAKE_SOURCE_DIR@/TPC/testMC \
772fa391 777 @CMAKE_SOURCE_DIR@/TPC/TPCbase \
778 @CMAKE_SOURCE_DIR@/MUON \
779 @CMAKE_SOURCE_DIR@/MUON/MUONgeometry \
780 @CMAKE_SOURCE_DIR@/MUON/MUONevaluation \
781 @CMAKE_SOURCE_DIR@/MUON/MUONcore \
782 @CMAKE_SOURCE_DIR@/MUON/MUONcalign \
783 @CMAKE_SOURCE_DIR@/MUON/MUONcalib \
784 @CMAKE_SOURCE_DIR@/MUON/MUONbase \
785 @CMAKE_SOURCE_DIR@/MUON/MUONraw \
786 @CMAKE_SOURCE_DIR@/MUON/MUONmpgraphics \
787 @CMAKE_SOURCE_DIR@/MUON/MUONmapping \
788 @CMAKE_SOURCE_DIR@/MUON/MUONgraphics \
789 @CMAKE_SOURCE_DIR@/MUON/MUONtrigger \
790 @CMAKE_SOURCE_DIR@/MUON/MUONsim \
791 @CMAKE_SOURCE_DIR@/MUON/MUONshuttle \
a02ada5f 792 @CMAKE_SOURCE_DIR@/MUON/MUONrec \
793 @CMAKE_SOURCE_DIR@/MUON/macros
a2a27b4c 794
795# This tag can be used to specify the character encoding of the source files
796# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
797# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
798# documentation (see: http://www.gnu.org/software/libiconv) for the list of
799# possible encodings.
800# The default value is: UTF-8.
801
802INPUT_ENCODING = UTF-8
803
804# If the value of the INPUT tag contains directories, you can use the
805# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
806# *.h) to filter out the source-files in the directories. If left blank the
807# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
808# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
809# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
810# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
811# *.qsf, *.as and *.js.
812
36e6bf88 813FILE_PATTERNS = *.h \
814 *.cxx \
67be9434 815 *.C \
772fa391 816 *.md \
817 README*.txt
a2a27b4c 818
819# The RECURSIVE tag can be used to specify whether or not subdirectories should
820# be searched for input files as well.
821# The default value is: NO.
822
70b3f518 823RECURSIVE = NO
a2a27b4c 824
825# The EXCLUDE tag can be used to specify files and/or directories that should be
826# excluded from the INPUT source files. This way you can easily exclude a
827# subdirectory from a directory tree whose root is specified with the INPUT tag.
828#
829# Note that relative paths are relative to the directory from which doxygen is
830# run.
831
36e6bf88 832EXCLUDE =
a2a27b4c 833
834# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
835# directories that are symbolic links (a Unix file system feature) are excluded
836# from the input.
837# The default value is: NO.
838
839EXCLUDE_SYMLINKS = NO
840
841# If the value of the INPUT tag contains directories, you can use the
842# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
843# certain files from those directories.
844#
845# Note that the wildcards are matched against the file with absolute path, so to
846# exclude all test directories for example use the pattern */test/*
847
36e6bf88 848EXCLUDE_PATTERNS =
a2a27b4c 849
850# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
851# (namespaces, classes, functions, etc.) that should be excluded from the
852# output. The symbol name can be a fully qualified name, a word, or if the
853# wildcard * is used, a substring. Examples: ANamespace, AClass,
854# AClass::ANamespace, ANamespace::*Test
855#
856# Note that the wildcards are matched against the file with absolute path, so to
857# exclude all test directories use the pattern */test/*
858
36e6bf88 859EXCLUDE_SYMBOLS =
a2a27b4c 860
861# The EXAMPLE_PATH tag can be used to specify one or more files or directories
862# that contain example code fragments that are included (see the \include
863# command).
864
36e6bf88 865EXAMPLE_PATH =
a2a27b4c 866
867# If the value of the EXAMPLE_PATH tag contains directories, you can use the
868# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
869# *.h) to filter out the source-files in the directories. If left blank all
870# files are included.
871
36e6bf88 872EXAMPLE_PATTERNS =
a2a27b4c 873
874# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
875# searched for input files to be used with the \include or \dontinclude commands
876# irrespective of the value of the RECURSIVE tag.
877# The default value is: NO.
878
879EXAMPLE_RECURSIVE = NO
880
881# The IMAGE_PATH tag can be used to specify one or more files or directories
882# that contain images that are to be included in the documentation (see the
883# \image command).
884
9954d4a4 885IMAGE_PATH = @CMAKE_SOURCE_DIR@/picts \
886 @CMAKE_SOURCE_DIR@/TPC/TPCbase/imgdoc
a2a27b4c 887
888# The INPUT_FILTER tag can be used to specify a program that doxygen should
889# invoke to filter for each input file. Doxygen will invoke the filter program
890# by executing (via popen()) the command:
891#
892# <filter> <input-file>
893#
894# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
895# name of an input file. Doxygen will then use the output that the filter
896# program writes to standard output. If FILTER_PATTERNS is specified, this tag
897# will be ignored.
898#
899# Note that the filter must not add or remove lines; it is applied before the
900# code is scanned, but not when the output code is generated. If lines are added
901# or removed, the anchors will not be placed correctly.
902
36e6bf88 903INPUT_FILTER =
a2a27b4c 904
905# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
906# basis. Doxygen will compare the file name with each pattern and apply the
907# filter if there is a match. The filters are a list of the form: pattern=filter
908# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
909# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
910# patterns match the file name, INPUT_FILTER is applied.
911
36e6bf88 912FILTER_PATTERNS =
a2a27b4c 913
914# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
36e6bf88 915# INPUT_FILTER) will also be used to filter the input files that are used for
a2a27b4c 916# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
917# The default value is: NO.
918
919FILTER_SOURCE_FILES = NO
920
921# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
922# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
923# it is also possible to disable source filtering for a specific pattern using
924# *.ext= (so without naming a filter).
925# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
926
36e6bf88 927FILTER_SOURCE_PATTERNS =
a2a27b4c 928
929# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
930# is part of the input, its contents will be placed on the main page
931# (index.html). This can be useful if you have a project on for instance GitHub
932# and want to reuse the introduction page also for the doxygen output.
933
863650ca 934USE_MDFILE_AS_MAINPAGE = mainpage.md
a2a27b4c 935
936#---------------------------------------------------------------------------
937# Configuration options related to source browsing
938#---------------------------------------------------------------------------
939
940# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
941# generated. Documented entities will be cross-referenced with these sources.
942#
943# Note: To get rid of all source code in the generated output, make sure that
944# also VERBATIM_HEADERS is set to NO.
945# The default value is: NO.
946
a02ada5f 947SOURCE_BROWSER = YES
a2a27b4c 948
949# Setting the INLINE_SOURCES tag to YES will include the body of functions,
950# classes and enums directly into the documentation.
951# The default value is: NO.
952
953INLINE_SOURCES = NO
954
955# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
956# special comment blocks from generated source code fragments. Normal C, C++ and
957# Fortran comments will always remain visible.
958# The default value is: YES.
959
960STRIP_CODE_COMMENTS = YES
961
962# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
963# function all documented functions referencing it will be listed.
964# The default value is: NO.
965
a02ada5f 966REFERENCED_BY_RELATION = YES
a2a27b4c 967
968# If the REFERENCES_RELATION tag is set to YES then for each documented function
969# all documented entities called/used by that function will be listed.
970# The default value is: NO.
971
972REFERENCES_RELATION = NO
973
974# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
36e6bf88 975# to YES then the hyperlinks from functions in REFERENCES_RELATION and
a2a27b4c 976# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
977# link to the documentation.
978# The default value is: YES.
979
980REFERENCES_LINK_SOURCE = YES
981
982# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
983# source code will show a tooltip with additional information such as prototype,
984# brief description and links to the definition and documentation. Since this
985# will make the HTML file larger and loading of large files a bit slower, you
986# can opt to disable this feature.
987# The default value is: YES.
988# This tag requires that the tag SOURCE_BROWSER is set to YES.
989
990SOURCE_TOOLTIPS = YES
991
992# If the USE_HTAGS tag is set to YES then the references to source code will
993# point to the HTML generated by the htags(1) tool instead of doxygen built-in
994# source browser. The htags tool is part of GNU's global source tagging system
995# (see http://www.gnu.org/software/global/global.html). You will need version
996# 4.8.6 or higher.
997#
998# To use it do the following:
999# - Install the latest version of global
1000# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1001# - Make sure the INPUT points to the root of the source tree
1002# - Run doxygen as normal
1003#
1004# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1005# tools must be available from the command line (i.e. in the search path).
1006#
1007# The result: instead of the source browser generated by doxygen, the links to
1008# source code will now point to the output of htags.
1009# The default value is: NO.
1010# This tag requires that the tag SOURCE_BROWSER is set to YES.
1011
1012USE_HTAGS = NO
1013
1014# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1015# verbatim copy of the header file for each class for which an include is
1016# specified. Set to NO to disable this.
1017# See also: Section \class.
1018# The default value is: YES.
1019
1020VERBATIM_HEADERS = YES
1021
36e6bf88 1022# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1023# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1024# cost of reduced performance. This can be particularly helpful with template
1025# rich C++ code for which doxygen's built-in parser lacks the necessary type
1026# information.
1027# Note: The availability of this option depends on whether or not doxygen was
1028# compiled with the --with-libclang option.
1029# The default value is: NO.
1030
1031CLANG_ASSISTED_PARSING = NO
1032
1033# If clang assisted parsing is enabled you can provide the compiler with command
1034# line options that you would normally use when invoking the compiler. Note that
1035# the include paths will already be set by doxygen for the files and directories
1036# specified with INPUT and INCLUDE_PATH.
1037# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1038
1039CLANG_OPTIONS =
1040
a2a27b4c 1041#---------------------------------------------------------------------------
1042# Configuration options related to the alphabetical class index
1043#---------------------------------------------------------------------------
1044
1045# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1046# compounds will be generated. Enable this if the project contains a lot of
1047# classes, structs, unions or interfaces.
1048# The default value is: YES.
1049
1050ALPHABETICAL_INDEX = YES
1051
1052# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1053# which the alphabetical index list will be split.
1054# Minimum value: 1, maximum value: 20, default value: 5.
1055# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1056
1057COLS_IN_ALPHA_INDEX = 5
1058
1059# In case all classes in a project start with a common prefix, all classes will
1060# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1061# can be used to specify a prefix (or a list of prefixes) that should be ignored
1062# while generating the index headers.
1063# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1064
36e6bf88 1065IGNORE_PREFIX =
a2a27b4c 1066
1067#---------------------------------------------------------------------------
1068# Configuration options related to the HTML output
1069#---------------------------------------------------------------------------
1070
36e6bf88 1071# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
a2a27b4c 1072# The default value is: YES.
1073
1074GENERATE_HTML = YES
1075
1076# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1077# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1078# it.
1079# The default directory is: html.
1080# This tag requires that the tag GENERATE_HTML is set to YES.
1081
1082HTML_OUTPUT = html
1083
1084# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1085# generated HTML page (for example: .htm, .php, .asp).
1086# The default value is: .html.
1087# This tag requires that the tag GENERATE_HTML is set to YES.
1088
1089HTML_FILE_EXTENSION = .html
1090
1091# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1092# each generated HTML page. If the tag is left blank doxygen will generate a
1093# standard header.
1094#
1095# To get valid HTML the header file that includes any scripts and style sheets
1096# that doxygen needs, which is dependent on the configuration options used (e.g.
1097# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1098# default header using
1099# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1100# YourConfigFile
1101# and then modify the file new_header.html. See also section "Doxygen usage"
1102# for information on how to generate the default header that doxygen normally
1103# uses.
1104# Note: The header is subject to change so you typically have to regenerate the
1105# default header when upgrading to a newer version of doxygen. For a description
1106# of the possible markers and block names see the documentation.
1107# This tag requires that the tag GENERATE_HTML is set to YES.
1108
36e6bf88 1109HTML_HEADER =
a2a27b4c 1110
1111# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1112# generated HTML page. If the tag is left blank doxygen will generate a standard
1113# footer. See HTML_HEADER for more information on how to generate a default
1114# footer and what special commands can be used inside the footer. See also
1115# section "Doxygen usage" for information on how to generate the default footer
1116# that doxygen normally uses.
1117# This tag requires that the tag GENERATE_HTML is set to YES.
1118
36e6bf88 1119HTML_FOOTER =
a2a27b4c 1120
1121# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1122# sheet that is used by each HTML page. It can be used to fine-tune the look of
1123# the HTML output. If left blank doxygen will generate a default style sheet.
1124# See also section "Doxygen usage" for information on how to generate the style
1125# sheet that doxygen normally uses.
1126# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1127# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1128# obsolete.
1129# This tag requires that the tag GENERATE_HTML is set to YES.
1130
36e6bf88 1131HTML_STYLESHEET =
a2a27b4c 1132
1133# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1134# cascading style sheets that are included after the standard style sheets
1135# created by doxygen. Using this option one can overrule certain style aspects.
1136# This is preferred over using HTML_STYLESHEET since it does not replace the
36e6bf88 1137# standard style sheet and is therefore more robust against future updates.
a2a27b4c 1138# Doxygen will copy the style sheet files to the output directory.
36e6bf88 1139# Note: The order of the extra style sheet files is of importance (e.g. the last
1140# style sheet in the list overrules the setting of the previous ones in the
a2a27b4c 1141# list). For an example see the documentation.
1142# This tag requires that the tag GENERATE_HTML is set to YES.
1143
36e6bf88 1144HTML_EXTRA_STYLESHEET =
a2a27b4c 1145
1146# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1147# other source files which should be copied to the HTML output directory. Note
1148# that these files will be copied to the base HTML output directory. Use the
1149# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1150# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1151# files will be copied as-is; there are no commands or markers available.
1152# This tag requires that the tag GENERATE_HTML is set to YES.
1153
36e6bf88 1154HTML_EXTRA_FILES =
a2a27b4c 1155
1156# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
36e6bf88 1157# will adjust the colors in the style sheet and background images according to
a2a27b4c 1158# this color. Hue is specified as an angle on a colorwheel, see
1159# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1160# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1161# purple, and 360 is red again.
1162# Minimum value: 0, maximum value: 359, default value: 220.
1163# This tag requires that the tag GENERATE_HTML is set to YES.
1164
36e6bf88 1165HTML_COLORSTYLE_HUE = 0
a2a27b4c 1166
1167# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1168# in the HTML output. For a value of 0 the output will use grayscales only. A
1169# value of 255 will produce the most vivid colors.
1170# Minimum value: 0, maximum value: 255, default value: 100.
1171# This tag requires that the tag GENERATE_HTML is set to YES.
1172
36e6bf88 1173HTML_COLORSTYLE_SAT = 73
a2a27b4c 1174
1175# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1176# luminance component of the colors in the HTML output. Values below 100
1177# gradually make the output lighter, whereas values above 100 make the output
1178# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1179# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1180# change the gamma.
1181# Minimum value: 40, maximum value: 240, default value: 80.
1182# This tag requires that the tag GENERATE_HTML is set to YES.
1183
36e6bf88 1184HTML_COLORSTYLE_GAMMA = 98
a2a27b4c 1185
1186# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1187# page will contain the date and time when the page was generated. Setting this
1188# to NO can help when comparing the output of multiple runs.
1189# The default value is: YES.
1190# This tag requires that the tag GENERATE_HTML is set to YES.
1191
1192HTML_TIMESTAMP = YES
1193
1194# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1195# documentation will contain sections that can be hidden and shown after the
1196# page has loaded.
1197# The default value is: NO.
1198# This tag requires that the tag GENERATE_HTML is set to YES.
1199
70b3f518 1200HTML_DYNAMIC_SECTIONS = NO
a2a27b4c 1201
1202# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1203# shown in the various tree structured indices initially; the user can expand
1204# and collapse entries dynamically later on. Doxygen will expand the tree to
1205# such a level that at most the specified number of entries are visible (unless
1206# a fully collapsed tree already exceeds this amount). So setting the number of
1207# entries 1 will produce a full collapsed tree by default. 0 is a special value
1208# representing an infinite number of entries and will result in a full expanded
1209# tree by default.
1210# Minimum value: 0, maximum value: 9999, default value: 100.
1211# This tag requires that the tag GENERATE_HTML is set to YES.
1212
1213HTML_INDEX_NUM_ENTRIES = 100
1214
1215# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1216# generated that can be used as input for Apple's Xcode 3 integrated development
1217# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1218# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1219# Makefile in the HTML output directory. Running make will produce the docset in
1220# that directory and running make install will install the docset in
1221# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1222# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1223# for more information.
1224# The default value is: NO.
1225# This tag requires that the tag GENERATE_HTML is set to YES.
1226
1227GENERATE_DOCSET = NO
1228
1229# This tag determines the name of the docset feed. A documentation feed provides
1230# an umbrella under which multiple documentation sets from a single provider
1231# (such as a company or product suite) can be grouped.
1232# The default value is: Doxygen generated docs.
1233# This tag requires that the tag GENERATE_DOCSET is set to YES.
1234
1235DOCSET_FEEDNAME = "Doxygen generated docs"
1236
1237# This tag specifies a string that should uniquely identify the documentation
1238# set bundle. This should be a reverse domain-name style string, e.g.
1239# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1240# The default value is: org.doxygen.Project.
1241# This tag requires that the tag GENERATE_DOCSET is set to YES.
1242
1243DOCSET_BUNDLE_ID = org.doxygen.Project
1244
1245# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1246# the documentation publisher. This should be a reverse domain-name style
1247# string, e.g. com.mycompany.MyDocSet.documentation.
1248# The default value is: org.doxygen.Publisher.
1249# This tag requires that the tag GENERATE_DOCSET is set to YES.
1250
1251DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1252
1253# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1254# The default value is: Publisher.
1255# This tag requires that the tag GENERATE_DOCSET is set to YES.
1256
1257DOCSET_PUBLISHER_NAME = Publisher
1258
1259# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1260# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1261# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1262# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1263# Windows.
1264#
1265# The HTML Help Workshop contains a compiler that can convert all HTML output
1266# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1267# files are now used as the Windows 98 help format, and will replace the old
1268# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1269# HTML files also contain an index, a table of contents, and you can search for
1270# words in the documentation. The HTML workshop also contains a viewer for
1271# compressed HTML files.
1272# The default value is: NO.
1273# This tag requires that the tag GENERATE_HTML is set to YES.
1274
1275GENERATE_HTMLHELP = NO
1276
1277# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1278# file. You can add a path in front of the file if the result should not be
1279# written to the html output directory.
1280# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1281
36e6bf88 1282CHM_FILE =
a2a27b4c 1283
1284# The HHC_LOCATION tag can be used to specify the location (absolute path
36e6bf88 1285# including file name) of the HTML help compiler (hhc.exe). If non-empty,
a2a27b4c 1286# doxygen will try to run the HTML help compiler on the generated index.hhp.
1287# The file has to be specified with full path.
1288# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1289
36e6bf88 1290HHC_LOCATION =
a2a27b4c 1291
36e6bf88 1292# The GENERATE_CHI flag controls if a separate .chi index file is generated
1293# (YES) or that it should be included in the master .chm file (NO).
a2a27b4c 1294# The default value is: NO.
1295# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1296
1297GENERATE_CHI = NO
1298
36e6bf88 1299# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
a2a27b4c 1300# and project file content.
1301# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1302
36e6bf88 1303CHM_INDEX_ENCODING =
a2a27b4c 1304
36e6bf88 1305# The BINARY_TOC flag controls whether a binary table of contents is generated
1306# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
a2a27b4c 1307# enables the Previous and Next buttons.
1308# The default value is: NO.
1309# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1310
1311BINARY_TOC = NO
1312
1313# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1314# the table of contents of the HTML help documentation and to the tree view.
1315# The default value is: NO.
1316# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1317
1318TOC_EXPAND = NO
1319
1320# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1321# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1322# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1323# (.qch) of the generated HTML documentation.
1324# The default value is: NO.
1325# This tag requires that the tag GENERATE_HTML is set to YES.
1326
1327GENERATE_QHP = NO
1328
1329# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1330# the file name of the resulting .qch file. The path specified is relative to
1331# the HTML output folder.
1332# This tag requires that the tag GENERATE_QHP is set to YES.
1333
36e6bf88 1334QCH_FILE =
a2a27b4c 1335
1336# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1337# Project output. For more information please see Qt Help Project / Namespace
1338# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1339# The default value is: org.doxygen.Project.
1340# This tag requires that the tag GENERATE_QHP is set to YES.
1341
1342QHP_NAMESPACE = org.doxygen.Project
1343
1344# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1345# Help Project output. For more information please see Qt Help Project / Virtual
1346# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1347# folders).
1348# The default value is: doc.
1349# This tag requires that the tag GENERATE_QHP is set to YES.
1350
1351QHP_VIRTUAL_FOLDER = doc
1352
1353# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1354# filter to add. For more information please see Qt Help Project / Custom
1355# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1356# filters).
1357# This tag requires that the tag GENERATE_QHP is set to YES.
1358
36e6bf88 1359QHP_CUST_FILTER_NAME =
a2a27b4c 1360
1361# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1362# custom filter to add. For more information please see Qt Help Project / Custom
1363# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1364# filters).
1365# This tag requires that the tag GENERATE_QHP is set to YES.
1366
36e6bf88 1367QHP_CUST_FILTER_ATTRS =
a2a27b4c 1368
1369# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1370# project's filter section matches. Qt Help Project / Filter Attributes (see:
1371# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1372# This tag requires that the tag GENERATE_QHP is set to YES.
1373
36e6bf88 1374QHP_SECT_FILTER_ATTRS =
a2a27b4c 1375
1376# The QHG_LOCATION tag can be used to specify the location of Qt's
1377# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1378# generated .qhp file.
1379# This tag requires that the tag GENERATE_QHP is set to YES.
1380
36e6bf88 1381QHG_LOCATION =
a2a27b4c 1382
1383# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1384# generated, together with the HTML files, they form an Eclipse help plugin. To
1385# install this plugin and make it available under the help contents menu in
1386# Eclipse, the contents of the directory containing the HTML and XML files needs
1387# to be copied into the plugins directory of eclipse. The name of the directory
1388# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1389# After copying Eclipse needs to be restarted before the help appears.
1390# The default value is: NO.
1391# This tag requires that the tag GENERATE_HTML is set to YES.
1392
1393GENERATE_ECLIPSEHELP = NO
1394
1395# A unique identifier for the Eclipse help plugin. When installing the plugin
1396# the directory name containing the HTML and XML files should also have this
1397# name. Each documentation set should have its own identifier.
1398# The default value is: org.doxygen.Project.
1399# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1400
1401ECLIPSE_DOC_ID = org.doxygen.Project
1402
1403# If you want full control over the layout of the generated HTML pages it might
1404# be necessary to disable the index and replace it with your own. The
1405# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1406# of each HTML page. A value of NO enables the index and the value YES disables
1407# it. Since the tabs in the index contain the same information as the navigation
1408# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1409# The default value is: NO.
1410# This tag requires that the tag GENERATE_HTML is set to YES.
1411
1412DISABLE_INDEX = NO
1413
1414# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1415# structure should be generated to display hierarchical information. If the tag
1416# value is set to YES, a side panel will be generated containing a tree-like
1417# index structure (just like the one that is generated for HTML Help). For this
1418# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1419# (i.e. any modern browser). Windows users are probably better off using the
36e6bf88 1420# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
a2a27b4c 1421# further fine-tune the look of the index. As an example, the default style
1422# sheet generated by doxygen has an example that shows how to put an image at
1423# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1424# the same information as the tab index, you could consider setting
1425# DISABLE_INDEX to YES when enabling this option.
1426# The default value is: NO.
1427# This tag requires that the tag GENERATE_HTML is set to YES.
1428
36e6bf88 1429GENERATE_TREEVIEW = YES
a2a27b4c 1430
1431# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1432# doxygen will group on one line in the generated HTML documentation.
1433#
1434# Note that a value of 0 will completely suppress the enum values from appearing
1435# in the overview section.
1436# Minimum value: 0, maximum value: 20, default value: 4.
1437# This tag requires that the tag GENERATE_HTML is set to YES.
1438
1439ENUM_VALUES_PER_LINE = 4
1440
1441# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1442# to set the initial width (in pixels) of the frame in which the tree is shown.
1443# Minimum value: 0, maximum value: 1500, default value: 250.
1444# This tag requires that the tag GENERATE_HTML is set to YES.
1445
1446TREEVIEW_WIDTH = 250
1447
36e6bf88 1448# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
a2a27b4c 1449# external symbols imported via tag files in a separate window.
1450# The default value is: NO.
1451# This tag requires that the tag GENERATE_HTML is set to YES.
1452
1453EXT_LINKS_IN_WINDOW = NO
1454
1455# Use this tag to change the font size of LaTeX formulas included as images in
1456# the HTML documentation. When you change the font size after a successful
1457# doxygen run you need to manually remove any form_*.png images from the HTML
1458# output directory to force them to be regenerated.
1459# Minimum value: 8, maximum value: 50, default value: 10.
1460# This tag requires that the tag GENERATE_HTML is set to YES.
1461
1462FORMULA_FONTSIZE = 10
1463
1464# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1465# generated for formulas are transparent PNGs. Transparent PNGs are not
1466# supported properly for IE 6.0, but are supported on all modern browsers.
1467#
1468# Note that when changing this option you need to delete any form_*.png files in
1469# the HTML output directory before the changes have effect.
1470# The default value is: YES.
1471# This tag requires that the tag GENERATE_HTML is set to YES.
1472
1473FORMULA_TRANSPARENT = YES
1474
1475# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1476# http://www.mathjax.org) which uses client side Javascript for the rendering
36e6bf88 1477# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
a2a27b4c 1478# installed or if you want to formulas look prettier in the HTML output. When
1479# enabled you may also need to install MathJax separately and configure the path
1480# to it using the MATHJAX_RELPATH option.
1481# The default value is: NO.
1482# This tag requires that the tag GENERATE_HTML is set to YES.
1483
1484USE_MATHJAX = YES
1485
1486# When MathJax is enabled you can set the default output format to be used for
1487# the MathJax output. See the MathJax site (see:
1488# http://docs.mathjax.org/en/latest/output.html) for more details.
1489# Possible values are: HTML-CSS (which is slower, but has the best
1490# compatibility), NativeMML (i.e. MathML) and SVG.
1491# The default value is: HTML-CSS.
1492# This tag requires that the tag USE_MATHJAX is set to YES.
1493
1494MATHJAX_FORMAT = HTML-CSS
1495
1496# When MathJax is enabled you need to specify the location relative to the HTML
1497# output directory using the MATHJAX_RELPATH option. The destination directory
1498# should contain the MathJax.js script. For instance, if the mathjax directory
1499# is located at the same level as the HTML output directory, then
1500# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1501# Content Delivery Network so you can quickly see the result without installing
1502# MathJax. However, it is strongly recommended to install a local copy of
1503# MathJax from http://www.mathjax.org before deployment.
1504# The default value is: http://cdn.mathjax.org/mathjax/latest.
1505# This tag requires that the tag USE_MATHJAX is set to YES.
1506
1507MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1508
1509# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1510# extension names that should be enabled during MathJax rendering. For example
1511# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1512# This tag requires that the tag USE_MATHJAX is set to YES.
1513
36e6bf88 1514MATHJAX_EXTENSIONS =
a2a27b4c 1515
1516# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1517# of code that will be used on startup of the MathJax code. See the MathJax site
1518# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1519# example see the documentation.
1520# This tag requires that the tag USE_MATHJAX is set to YES.
1521
36e6bf88 1522MATHJAX_CODEFILE =
a2a27b4c 1523
1524# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1525# the HTML output. The underlying search engine uses javascript and DHTML and
1526# should work on any modern browser. Note that when using HTML help
1527# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1528# there is already a search function so this one should typically be disabled.
1529# For large projects the javascript based search engine can be slow, then
1530# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1531# search using the keyboard; to jump to the search box use <access key> + S
1532# (what the <access key> is depends on the OS and browser, but it is typically
1533# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1534# key> to jump into the search results window, the results can be navigated
1535# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1536# the search. The filter options can be selected when the cursor is inside the
1537# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1538# to select a filter and <Enter> or <escape> to activate or cancel the filter
1539# option.
1540# The default value is: YES.
1541# This tag requires that the tag GENERATE_HTML is set to YES.
1542
1543SEARCHENGINE = YES
1544
1545# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1546# implemented using a web server instead of a web client using Javascript. There
1547# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1548# setting. When disabled, doxygen will generate a PHP script for searching and
1549# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1550# and searching needs to be provided by external tools. See the section
1551# "External Indexing and Searching" for details.
1552# The default value is: NO.
1553# This tag requires that the tag SEARCHENGINE is set to YES.
1554
1555SERVER_BASED_SEARCH = NO
1556
1557# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1558# script for searching. Instead the search results are written to an XML file
1559# which needs to be processed by an external indexer. Doxygen will invoke an
1560# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1561# search results.
1562#
36e6bf88 1563# Doxygen ships with an example indexer (doxyindexer) and search engine
a2a27b4c 1564# (doxysearch.cgi) which are based on the open source search engine library
1565# Xapian (see: http://xapian.org/).
1566#
1567# See the section "External Indexing and Searching" for details.
1568# The default value is: NO.
1569# This tag requires that the tag SEARCHENGINE is set to YES.
1570
1571EXTERNAL_SEARCH = NO
1572
1573# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1574# which will return the search results when EXTERNAL_SEARCH is enabled.
1575#
36e6bf88 1576# Doxygen ships with an example indexer (doxyindexer) and search engine
a2a27b4c 1577# (doxysearch.cgi) which are based on the open source search engine library
1578# Xapian (see: http://xapian.org/). See the section "External Indexing and
1579# Searching" for details.
1580# This tag requires that the tag SEARCHENGINE is set to YES.
1581
36e6bf88 1582SEARCHENGINE_URL =
a2a27b4c 1583
1584# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1585# search data is written to a file for indexing by an external tool. With the
1586# SEARCHDATA_FILE tag the name of this file can be specified.
1587# The default file is: searchdata.xml.
1588# This tag requires that the tag SEARCHENGINE is set to YES.
1589
1590SEARCHDATA_FILE = searchdata.xml
1591
1592# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1593# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1594# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1595# projects and redirect the results back to the right project.
1596# This tag requires that the tag SEARCHENGINE is set to YES.
1597
36e6bf88 1598EXTERNAL_SEARCH_ID =
a2a27b4c 1599
1600# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1601# projects other than the one defined by this configuration file, but that are
1602# all added to the same external search index. Each project needs to have a
1603# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1604# to a relative location where the documentation can be found. The format is:
1605# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1606# This tag requires that the tag SEARCHENGINE is set to YES.
1607
36e6bf88 1608EXTRA_SEARCH_MAPPINGS =
a2a27b4c 1609
1610#---------------------------------------------------------------------------
1611# Configuration options related to the LaTeX output
1612#---------------------------------------------------------------------------
1613
36e6bf88 1614# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
a2a27b4c 1615# The default value is: YES.
1616
1617GENERATE_LATEX = NO
1618
1619# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1620# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1621# it.
1622# The default directory is: latex.
1623# This tag requires that the tag GENERATE_LATEX is set to YES.
1624
1625LATEX_OUTPUT = latex
1626
1627# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1628# invoked.
1629#
1630# Note that when enabling USE_PDFLATEX this option is only used for generating
1631# bitmaps for formulas in the HTML output, but not in the Makefile that is
1632# written to the output directory.
1633# The default file is: latex.
1634# This tag requires that the tag GENERATE_LATEX is set to YES.
1635
1636LATEX_CMD_NAME = latex
1637
1638# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1639# index for LaTeX.
1640# The default file is: makeindex.
1641# This tag requires that the tag GENERATE_LATEX is set to YES.
1642
1643MAKEINDEX_CMD_NAME = makeindex
1644
36e6bf88 1645# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
a2a27b4c 1646# documents. This may be useful for small projects and may help to save some
1647# trees in general.
1648# The default value is: NO.
1649# This tag requires that the tag GENERATE_LATEX is set to YES.
1650
1651COMPACT_LATEX = NO
1652
1653# The PAPER_TYPE tag can be used to set the paper type that is used by the
1654# printer.
1655# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1656# 14 inches) and executive (7.25 x 10.5 inches).
1657# The default value is: a4.
1658# This tag requires that the tag GENERATE_LATEX is set to YES.
1659
1660PAPER_TYPE = a4
1661
1662# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1663# that should be included in the LaTeX output. To get the times font for
1664# instance you can specify
1665# EXTRA_PACKAGES=times
1666# If left blank no extra packages will be included.
1667# This tag requires that the tag GENERATE_LATEX is set to YES.
1668
36e6bf88 1669EXTRA_PACKAGES =
a2a27b4c 1670
1671# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1672# generated LaTeX document. The header should contain everything until the first
1673# chapter. If it is left blank doxygen will generate a standard header. See
1674# section "Doxygen usage" for information on how to let doxygen write the
1675# default header to a separate file.
1676#
1677# Note: Only use a user-defined header if you know what you are doing! The
1678# following commands have a special meaning inside the header: $title,
1679# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
36e6bf88 1680# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1681# string, for the replacement values of the other commands the user is referred
1682# to HTML_HEADER.
a2a27b4c 1683# This tag requires that the tag GENERATE_LATEX is set to YES.
1684
36e6bf88 1685LATEX_HEADER =
a2a27b4c 1686
1687# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1688# generated LaTeX document. The footer should contain everything after the last
1689# chapter. If it is left blank doxygen will generate a standard footer. See
1690# LATEX_HEADER for more information on how to generate a default footer and what
1691# special commands can be used inside the footer.
1692#
1693# Note: Only use a user-defined footer if you know what you are doing!
1694# This tag requires that the tag GENERATE_LATEX is set to YES.
1695
36e6bf88 1696LATEX_FOOTER =
1697
1698# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1699# LaTeX style sheets that are included after the standard style sheets created
1700# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1701# will copy the style sheet files to the output directory.
1702# Note: The order of the extra style sheet files is of importance (e.g. the last
1703# style sheet in the list overrules the setting of the previous ones in the
1704# list).
1705# This tag requires that the tag GENERATE_LATEX is set to YES.
1706
1707LATEX_EXTRA_STYLESHEET =
a2a27b4c 1708
1709# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1710# other source files which should be copied to the LATEX_OUTPUT output
1711# directory. Note that the files will be copied as-is; there are no commands or
1712# markers available.
1713# This tag requires that the tag GENERATE_LATEX is set to YES.
1714
36e6bf88 1715LATEX_EXTRA_FILES =
a2a27b4c 1716
1717# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1718# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1719# contain links (just like the HTML output) instead of page references. This
1720# makes the output suitable for online browsing using a PDF viewer.
1721# The default value is: YES.
1722# This tag requires that the tag GENERATE_LATEX is set to YES.
1723
1724PDF_HYPERLINKS = YES
1725
1726# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
36e6bf88 1727# the PDF file directly from the LaTeX files. Set this option to YES, to get a
a2a27b4c 1728# higher quality PDF documentation.
1729# The default value is: YES.
1730# This tag requires that the tag GENERATE_LATEX is set to YES.
1731
1732USE_PDFLATEX = YES
1733
1734# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1735# command to the generated LaTeX files. This will instruct LaTeX to keep running
1736# if errors occur, instead of asking the user for help. This option is also used
1737# when generating formulas in HTML.
1738# The default value is: NO.
1739# This tag requires that the tag GENERATE_LATEX is set to YES.
1740
1741LATEX_BATCHMODE = NO
1742
1743# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1744# index chapters (such as File Index, Compound Index, etc.) in the output.
1745# The default value is: NO.
1746# This tag requires that the tag GENERATE_LATEX is set to YES.
1747
1748LATEX_HIDE_INDICES = NO
1749
1750# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1751# code with syntax highlighting in the LaTeX output.
1752#
1753# Note that which sources are shown also depends on other settings such as
1754# SOURCE_BROWSER.
1755# The default value is: NO.
1756# This tag requires that the tag GENERATE_LATEX is set to YES.
1757
1758LATEX_SOURCE_CODE = NO
1759
1760# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1761# bibliography, e.g. plainnat, or ieeetr. See
1762# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1763# The default value is: plain.
1764# This tag requires that the tag GENERATE_LATEX is set to YES.
1765
1766LATEX_BIB_STYLE = plain
1767
1768#---------------------------------------------------------------------------
1769# Configuration options related to the RTF output
1770#---------------------------------------------------------------------------
1771
36e6bf88 1772# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
a2a27b4c 1773# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1774# readers/editors.
1775# The default value is: NO.
1776
1777GENERATE_RTF = NO
1778
1779# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1780# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1781# it.
1782# The default directory is: rtf.
1783# This tag requires that the tag GENERATE_RTF is set to YES.
1784
1785RTF_OUTPUT = rtf
1786
36e6bf88 1787# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
a2a27b4c 1788# documents. This may be useful for small projects and may help to save some
1789# trees in general.
1790# The default value is: NO.
1791# This tag requires that the tag GENERATE_RTF is set to YES.
1792
1793COMPACT_RTF = NO
1794
1795# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1796# contain hyperlink fields. The RTF file will contain links (just like the HTML
1797# output) instead of page references. This makes the output suitable for online
1798# browsing using Word or some other Word compatible readers that support those
1799# fields.
1800#
1801# Note: WordPad (write) and others do not support links.
1802# The default value is: NO.
1803# This tag requires that the tag GENERATE_RTF is set to YES.
1804
1805RTF_HYPERLINKS = NO
1806
1807# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1808# file, i.e. a series of assignments. You only have to provide replacements,
1809# missing definitions are set to their default value.
1810#
1811# See also section "Doxygen usage" for information on how to generate the
1812# default style sheet that doxygen normally uses.
1813# This tag requires that the tag GENERATE_RTF is set to YES.
1814
36e6bf88 1815RTF_STYLESHEET_FILE =
a2a27b4c 1816
1817# Set optional variables used in the generation of an RTF document. Syntax is
1818# similar to doxygen's config file. A template extensions file can be generated
1819# using doxygen -e rtf extensionFile.
1820# This tag requires that the tag GENERATE_RTF is set to YES.
1821
36e6bf88 1822RTF_EXTENSIONS_FILE =
1823
1824# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1825# with syntax highlighting in the RTF output.
1826#
1827# Note that which sources are shown also depends on other settings such as
1828# SOURCE_BROWSER.
1829# The default value is: NO.
1830# This tag requires that the tag GENERATE_RTF is set to YES.
1831
1832RTF_SOURCE_CODE = NO
a2a27b4c 1833
1834#---------------------------------------------------------------------------
1835# Configuration options related to the man page output
1836#---------------------------------------------------------------------------
1837
36e6bf88 1838# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
a2a27b4c 1839# classes and files.
1840# The default value is: NO.
1841
1842GENERATE_MAN = NO
1843
1844# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1845# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1846# it. A directory man3 will be created inside the directory specified by
1847# MAN_OUTPUT.
1848# The default directory is: man.
1849# This tag requires that the tag GENERATE_MAN is set to YES.
1850
1851MAN_OUTPUT = man
1852
1853# The MAN_EXTENSION tag determines the extension that is added to the generated
1854# man pages. In case the manual section does not start with a number, the number
1855# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1856# optional.
1857# The default value is: .3.
1858# This tag requires that the tag GENERATE_MAN is set to YES.
1859
1860MAN_EXTENSION = .3
1861
1862# The MAN_SUBDIR tag determines the name of the directory created within
1863# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1864# MAN_EXTENSION with the initial . removed.
1865# This tag requires that the tag GENERATE_MAN is set to YES.
1866
36e6bf88 1867MAN_SUBDIR =
a2a27b4c 1868
1869# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1870# will generate one additional man file for each entity documented in the real
1871# man page(s). These additional files only source the real man page, but without
1872# them the man command would be unable to find the correct page.
1873# The default value is: NO.
1874# This tag requires that the tag GENERATE_MAN is set to YES.
1875
1876MAN_LINKS = NO
1877
1878#---------------------------------------------------------------------------
1879# Configuration options related to the XML output
1880#---------------------------------------------------------------------------
1881
36e6bf88 1882# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
a2a27b4c 1883# captures the structure of the code including all documentation.
1884# The default value is: NO.
1885
1886GENERATE_XML = NO
1887
1888# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1889# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1890# it.
1891# The default directory is: xml.
1892# This tag requires that the tag GENERATE_XML is set to YES.
1893
1894XML_OUTPUT = xml
1895
36e6bf88 1896# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
a2a27b4c 1897# listings (including syntax highlighting and cross-referencing information) to
1898# the XML output. Note that enabling this will significantly increase the size
1899# of the XML output.
1900# The default value is: YES.
1901# This tag requires that the tag GENERATE_XML is set to YES.
1902
1903XML_PROGRAMLISTING = YES
1904
1905#---------------------------------------------------------------------------
1906# Configuration options related to the DOCBOOK output
1907#---------------------------------------------------------------------------
1908
36e6bf88 1909# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
a2a27b4c 1910# that can be used to generate PDF.
1911# The default value is: NO.
1912
1913GENERATE_DOCBOOK = NO
1914
1915# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1916# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1917# front of it.
1918# The default directory is: docbook.
1919# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1920
1921DOCBOOK_OUTPUT = docbook
1922
36e6bf88 1923# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
a2a27b4c 1924# program listings (including syntax highlighting and cross-referencing
1925# information) to the DOCBOOK output. Note that enabling this will significantly
1926# increase the size of the DOCBOOK output.
1927# The default value is: NO.
1928# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1929
1930DOCBOOK_PROGRAMLISTING = NO
1931
1932#---------------------------------------------------------------------------
1933# Configuration options for the AutoGen Definitions output
1934#---------------------------------------------------------------------------
1935
36e6bf88 1936# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1937# AutoGen Definitions (see http://autogen.sf.net) file that captures the
1938# structure of the code including all documentation. Note that this feature is
1939# still experimental and incomplete at the moment.
a2a27b4c 1940# The default value is: NO.
1941
1942GENERATE_AUTOGEN_DEF = NO
1943
1944#---------------------------------------------------------------------------
1945# Configuration options related to the Perl module output
1946#---------------------------------------------------------------------------
1947
36e6bf88 1948# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
a2a27b4c 1949# file that captures the structure of the code including all documentation.
1950#
1951# Note that this feature is still experimental and incomplete at the moment.
1952# The default value is: NO.
1953
1954GENERATE_PERLMOD = NO
1955
36e6bf88 1956# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
a2a27b4c 1957# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1958# output from the Perl module output.
1959# The default value is: NO.
1960# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1961
1962PERLMOD_LATEX = NO
1963
36e6bf88 1964# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
a2a27b4c 1965# formatted so it can be parsed by a human reader. This is useful if you want to
36e6bf88 1966# understand what is going on. On the other hand, if this tag is set to NO, the
a2a27b4c 1967# size of the Perl module output will be much smaller and Perl will parse it
1968# just the same.
1969# The default value is: YES.
1970# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1971
1972PERLMOD_PRETTY = YES
1973
1974# The names of the make variables in the generated doxyrules.make file are
1975# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1976# so different doxyrules.make files included by the same Makefile don't
1977# overwrite each other's variables.
1978# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1979
36e6bf88 1980PERLMOD_MAKEVAR_PREFIX =
a2a27b4c 1981
1982#---------------------------------------------------------------------------
1983# Configuration options related to the preprocessor
1984#---------------------------------------------------------------------------
1985
36e6bf88 1986# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
a2a27b4c 1987# C-preprocessor directives found in the sources and include files.
1988# The default value is: YES.
1989
1990ENABLE_PREPROCESSING = YES
1991
36e6bf88 1992# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1993# in the source code. If set to NO, only conditional compilation will be
a2a27b4c 1994# performed. Macro expansion can be done in a controlled way by setting
1995# EXPAND_ONLY_PREDEF to YES.
1996# The default value is: NO.
1997# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1998
1999MACRO_EXPANSION = NO
2000
2001# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2002# the macro expansion is limited to the macros specified with the PREDEFINED and
2003# EXPAND_AS_DEFINED tags.
2004# The default value is: NO.
2005# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2006
2007EXPAND_ONLY_PREDEF = NO
2008
36e6bf88 2009# If the SEARCH_INCLUDES tag is set to YES, the include files in the
a2a27b4c 2010# INCLUDE_PATH will be searched if a #include is found.
2011# The default value is: YES.
2012# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2013
2014SEARCH_INCLUDES = YES
2015
2016# The INCLUDE_PATH tag can be used to specify one or more directories that
2017# contain include files that are not input files but should be processed by the
2018# preprocessor.
2019# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2020
36e6bf88 2021INCLUDE_PATH =
a2a27b4c 2022
2023# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2024# patterns (like *.h and *.hpp) to filter out the header-files in the
2025# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2026# used.
2027# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2028
36e6bf88 2029INCLUDE_FILE_PATTERNS =
a2a27b4c 2030
2031# The PREDEFINED tag can be used to specify one or more macro names that are
2032# defined before the preprocessor is started (similar to the -D option of e.g.
2033# gcc). The argument of the tag is a list of macros of the form: name or
2034# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2035# is assumed. To prevent a macro definition from being undefined via #undef or
2036# recursively expanded use the := operator instead of the = operator.
2037# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2038
36e6bf88 2039PREDEFINED =
a2a27b4c 2040
2041# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2042# tag can be used to specify a list of macro names that should be expanded. The
2043# macro definition that is found in the sources will be used. Use the PREDEFINED
2044# tag if you want to use a different macro definition that overrules the
2045# definition found in the source code.
2046# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2047
36e6bf88 2048EXPAND_AS_DEFINED =
a2a27b4c 2049
2050# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2051# remove all references to function-like macros that are alone on a line, have
2052# an all uppercase name, and do not end with a semicolon. Such function macros
2053# are typically used for boiler-plate code, and will confuse the parser if not
2054# removed.
2055# The default value is: YES.
2056# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2057
2058SKIP_FUNCTION_MACROS = YES
2059
2060#---------------------------------------------------------------------------
2061# Configuration options related to external references
2062#---------------------------------------------------------------------------
2063
2064# The TAGFILES tag can be used to specify one or more tag files. For each tag
2065# file the location of the external documentation should be added. The format of
2066# a tag file without this location is as follows:
2067# TAGFILES = file1 file2 ...
2068# Adding location for the tag files is done as follows:
2069# TAGFILES = file1=loc1 "file2 = loc2" ...
2070# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2071# section "Linking to external documentation" for more information about the use
2072# of tag files.
2073# Note: Each tag file must have a unique name (where the name does NOT include
2074# the path). If a tag file is not located in the directory in which doxygen is
2075# run, you must also specify the path to the tagfile here.
2076
36e6bf88 2077TAGFILES =
a2a27b4c 2078
2079# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2080# tag file that is based on the input files it reads. See section "Linking to
2081# external documentation" for more information about the usage of tag files.
2082
36e6bf88 2083GENERATE_TAGFILE =
a2a27b4c 2084
36e6bf88 2085# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2086# the class index. If set to NO, only the inherited external classes will be
2087# listed.
a2a27b4c 2088# The default value is: NO.
2089
2090ALLEXTERNALS = NO
2091
36e6bf88 2092# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2093# in the modules index. If set to NO, only the current project's groups will be
a2a27b4c 2094# listed.
2095# The default value is: YES.
2096
2097EXTERNAL_GROUPS = YES
2098
36e6bf88 2099# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
a2a27b4c 2100# the related pages index. If set to NO, only the current project's pages will
2101# be listed.
2102# The default value is: YES.
2103
2104EXTERNAL_PAGES = YES
2105
2106# The PERL_PATH should be the absolute path and name of the perl script
2107# interpreter (i.e. the result of 'which perl').
2108# The default file (with absolute path) is: /usr/bin/perl.
2109
2110PERL_PATH = /usr/bin/perl
2111
2112#---------------------------------------------------------------------------
2113# Configuration options related to the dot tool
2114#---------------------------------------------------------------------------
2115
36e6bf88 2116# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
a2a27b4c 2117# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2118# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2119# disabled, but it is recommended to install and use dot, since it yields more
2120# powerful graphs.
2121# The default value is: YES.
2122
2123CLASS_DIAGRAMS = YES
2124
2125# You can define message sequence charts within doxygen comments using the \msc
2126# command. Doxygen will then run the mscgen tool (see:
2127# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2128# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2129# the mscgen tool resides. If left empty the tool is assumed to be found in the
2130# default search path.
2131
36e6bf88 2132MSCGEN_PATH =
a2a27b4c 2133
2134# You can include diagrams made with dia in doxygen documentation. Doxygen will
2135# then run dia to produce the diagram and insert it in the documentation. The
2136# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2137# If left empty dia is assumed to be found in the default search path.
2138
36e6bf88 2139DIA_PATH =
a2a27b4c 2140
36e6bf88 2141# If set to YES the inheritance and collaboration graphs will hide inheritance
a2a27b4c 2142# and usage relations if the target is undocumented or is not a class.
2143# The default value is: YES.
2144
b3fd2f9f 2145HIDE_UNDOC_RELATIONS = YES
a2a27b4c 2146
2147# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2148# available from the path. This tool is part of Graphviz (see:
2149# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2150# Bell Labs. The other options in this section have no effect if this option is
2151# set to NO
2152# The default value is: NO.
2153
2154HAVE_DOT = YES
2155
2156# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2157# to run in parallel. When set to 0 doxygen will base this on the number of
2158# processors available in the system. You can set it explicitly to a value
2159# larger than 0 to get control over the balance between CPU load and processing
2160# speed.
2161# Minimum value: 0, maximum value: 32, default value: 0.
2162# This tag requires that the tag HAVE_DOT is set to YES.
2163
2164DOT_NUM_THREADS = 0
2165
2166# When you want a differently looking font in the dot files that doxygen
2167# generates you can specify the font name using DOT_FONTNAME. You need to make
2168# sure dot is able to find the font, which can be done by putting it in a
2169# standard location or by setting the DOTFONTPATH environment variable or by
2170# setting DOT_FONTPATH to the directory containing the font.
2171# The default value is: Helvetica.
2172# This tag requires that the tag HAVE_DOT is set to YES.
2173
2174DOT_FONTNAME = Helvetica
2175
2176# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2177# dot graphs.
2178# Minimum value: 4, maximum value: 24, default value: 10.
2179# This tag requires that the tag HAVE_DOT is set to YES.
2180
2181DOT_FONTSIZE = 10
2182
2183# By default doxygen will tell dot to use the default font as specified with
2184# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2185# the path where dot can find it using this tag.
2186# This tag requires that the tag HAVE_DOT is set to YES.
2187
36e6bf88 2188DOT_FONTPATH =
a2a27b4c 2189
2190# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2191# each documented class showing the direct and indirect inheritance relations.
2192# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2193# The default value is: YES.
2194# This tag requires that the tag HAVE_DOT is set to YES.
2195
2196CLASS_GRAPH = YES
2197
2198# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2199# graph for each documented class showing the direct and indirect implementation
2200# dependencies (inheritance, containment, and class references variables) of the
2201# class with other documented classes.
2202# The default value is: YES.
2203# This tag requires that the tag HAVE_DOT is set to YES.
2204
a02ada5f 2205COLLABORATION_GRAPH = NO
a2a27b4c 2206
2207# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2208# groups, showing the direct groups dependencies.
2209# The default value is: YES.
2210# This tag requires that the tag HAVE_DOT is set to YES.
2211
2212GROUP_GRAPHS = YES
2213
36e6bf88 2214# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
a2a27b4c 2215# collaboration diagrams in a style similar to the OMG's Unified Modeling
2216# Language.
2217# The default value is: NO.
2218# This tag requires that the tag HAVE_DOT is set to YES.
2219
2220UML_LOOK = NO
2221
2222# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2223# class node. If there are many fields or methods and many nodes the graph may
2224# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2225# number of items for each type to make the size more manageable. Set this to 0
2226# for no limit. Note that the threshold may be exceeded by 50% before the limit
2227# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2228# but if the number exceeds 15, the total amount of fields shown is limited to
2229# 10.
2230# Minimum value: 0, maximum value: 100, default value: 10.
2231# This tag requires that the tag HAVE_DOT is set to YES.
2232
2233UML_LIMIT_NUM_FIELDS = 10
2234
2235# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2236# collaboration graphs will show the relations between templates and their
2237# instances.
2238# The default value is: NO.
2239# This tag requires that the tag HAVE_DOT is set to YES.
2240
2241TEMPLATE_RELATIONS = NO
2242
2243# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2244# YES then doxygen will generate a graph for each documented file showing the
2245# direct and indirect include dependencies of the file with other documented
2246# files.
2247# The default value is: YES.
2248# This tag requires that the tag HAVE_DOT is set to YES.
2249
2250INCLUDE_GRAPH = YES
2251
2252# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2253# set to YES then doxygen will generate a graph for each documented file showing
2254# the direct and indirect include dependencies of the file with other documented
2255# files.
2256# The default value is: YES.
2257# This tag requires that the tag HAVE_DOT is set to YES.
2258
2259INCLUDED_BY_GRAPH = YES
2260
2261# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2262# dependency graph for every global function or class method.
2263#
2264# Note that enabling this option will significantly increase the time of a run.
2265# So in most cases it will be better to enable call graphs for selected
2266# functions only using the \callgraph command.
2267# The default value is: NO.
2268# This tag requires that the tag HAVE_DOT is set to YES.
2269
2270CALL_GRAPH = NO
2271
2272# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2273# dependency graph for every global function or class method.
2274#
2275# Note that enabling this option will significantly increase the time of a run.
2276# So in most cases it will be better to enable caller graphs for selected
2277# functions only using the \callergraph command.
2278# The default value is: NO.
2279# This tag requires that the tag HAVE_DOT is set to YES.
2280
2281CALLER_GRAPH = NO
2282
2283# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2284# hierarchy of all classes instead of a textual one.
2285# The default value is: YES.
2286# This tag requires that the tag HAVE_DOT is set to YES.
2287
2288GRAPHICAL_HIERARCHY = YES
2289
2290# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2291# dependencies a directory has on other directories in a graphical way. The
2292# dependency relations are determined by the #include relations between the
2293# files in the directories.
2294# The default value is: YES.
2295# This tag requires that the tag HAVE_DOT is set to YES.
2296
2297DIRECTORY_GRAPH = YES
2298
2299# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2300# generated by dot.
2301# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2302# to make the SVG files visible in IE 9+ (other browsers do not have this
2303# requirement).
2304# Possible values are: png, jpg, gif and svg.
2305# The default value is: png.
2306# This tag requires that the tag HAVE_DOT is set to YES.
2307
2308DOT_IMAGE_FORMAT = png
2309
2310# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2311# enable generation of interactive SVG images that allow zooming and panning.
2312#
2313# Note that this requires a modern browser other than Internet Explorer. Tested
2314# and working are Firefox, Chrome, Safari, and Opera.
2315# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2316# the SVG files visible. Older versions of IE do not have SVG support.
2317# The default value is: NO.
2318# This tag requires that the tag HAVE_DOT is set to YES.
2319
2320INTERACTIVE_SVG = NO
2321
2322# The DOT_PATH tag can be used to specify the path where the dot tool can be
2323# found. If left blank, it is assumed the dot tool can be found in the path.
2324# This tag requires that the tag HAVE_DOT is set to YES.
2325
f2582ba8 2326DOT_PATH = @DOXYGEN_DOT_PATH@
a2a27b4c 2327
2328# The DOTFILE_DIRS tag can be used to specify one or more directories that
2329# contain dot files that are included in the documentation (see the \dotfile
2330# command).
2331# This tag requires that the tag HAVE_DOT is set to YES.
2332
36e6bf88 2333DOTFILE_DIRS =
a2a27b4c 2334
2335# The MSCFILE_DIRS tag can be used to specify one or more directories that
2336# contain msc files that are included in the documentation (see the \mscfile
2337# command).
2338
36e6bf88 2339MSCFILE_DIRS =
a2a27b4c 2340
2341# The DIAFILE_DIRS tag can be used to specify one or more directories that
2342# contain dia files that are included in the documentation (see the \diafile
2343# command).
2344
36e6bf88 2345DIAFILE_DIRS =
a2a27b4c 2346
2347# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2348# path where java can find the plantuml.jar file. If left blank, it is assumed
2349# PlantUML is not used or called during a preprocessing step. Doxygen will
2350# generate a warning when it encounters a \startuml command in this case and
2351# will not generate output for the diagram.
a2a27b4c 2352
36e6bf88 2353PLANTUML_JAR_PATH =
2354
2355# When using plantuml, the specified paths are searched for files specified by
2356# the !include statement in a plantuml block.
2357
2358PLANTUML_INCLUDE_PATH =
a2a27b4c 2359
2360# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2361# that will be shown in the graph. If the number of nodes in a graph becomes
2362# larger than this value, doxygen will truncate the graph, which is visualized
2363# by representing a node as a red box. Note that doxygen if the number of direct
2364# children of the root node in a graph is already larger than
2365# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2366# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2367# Minimum value: 0, maximum value: 10000, default value: 50.
2368# This tag requires that the tag HAVE_DOT is set to YES.
2369
2370DOT_GRAPH_MAX_NODES = 50
2371
2372# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2373# generated by dot. A depth value of 3 means that only nodes reachable from the
2374# root by following a path via at most 3 edges will be shown. Nodes that lay
2375# further from the root node will be omitted. Note that setting this option to 1
2376# or 2 may greatly reduce the computation time needed for large code bases. Also
2377# note that the size of a graph can be further restricted by
2378# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2379# Minimum value: 0, maximum value: 1000, default value: 0.
2380# This tag requires that the tag HAVE_DOT is set to YES.
2381
2382MAX_DOT_GRAPH_DEPTH = 0
2383
2384# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2385# background. This is disabled by default, because dot on Windows does not seem
2386# to support this out of the box.
2387#
2388# Warning: Depending on the platform used, enabling this option may lead to
2389# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2390# read).
2391# The default value is: NO.
2392# This tag requires that the tag HAVE_DOT is set to YES.
2393
2394DOT_TRANSPARENT = NO
2395
36e6bf88 2396# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
a2a27b4c 2397# files in one run (i.e. multiple -o and -T options on the command line). This
2398# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2399# this, this feature is disabled by default.
2400# The default value is: NO.
2401# This tag requires that the tag HAVE_DOT is set to YES.
2402
2403DOT_MULTI_TARGETS = NO
2404
2405# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2406# explaining the meaning of the various boxes and arrows in the dot generated
2407# graphs.
2408# The default value is: YES.
2409# This tag requires that the tag HAVE_DOT is set to YES.
2410
2411GENERATE_LEGEND = YES
2412
36e6bf88 2413# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
a2a27b4c 2414# files that are used to generate the various graphs.
2415# The default value is: YES.
2416# This tag requires that the tag HAVE_DOT is set to YES.
2417
2418DOT_CLEANUP = YES