]> git.uio.no Git - u/mrichter/AliRoot.git/blame - doxygen/Doxyfile.in
doxy: no more mainpage artifact on left menu
[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 \
792 @CMAKE_SOURCE_DIR@/MUON/MUONrec
a2a27b4c 793
794# This tag can be used to specify the character encoding of the source files
795# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
796# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
797# documentation (see: http://www.gnu.org/software/libiconv) for the list of
798# possible encodings.
799# The default value is: UTF-8.
800
801INPUT_ENCODING = UTF-8
802
803# If the value of the INPUT tag contains directories, you can use the
804# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
805# *.h) to filter out the source-files in the directories. If left blank the
806# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
807# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
808# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
809# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
810# *.qsf, *.as and *.js.
811
36e6bf88 812FILE_PATTERNS = *.h \
813 *.cxx \
67be9434 814 *.C \
772fa391 815 *.md \
816 README*.txt
a2a27b4c 817
818# The RECURSIVE tag can be used to specify whether or not subdirectories should
819# be searched for input files as well.
820# The default value is: NO.
821
70b3f518 822RECURSIVE = NO
a2a27b4c 823
824# The EXCLUDE tag can be used to specify files and/or directories that should be
825# excluded from the INPUT source files. This way you can easily exclude a
826# subdirectory from a directory tree whose root is specified with the INPUT tag.
827#
828# Note that relative paths are relative to the directory from which doxygen is
829# run.
830
36e6bf88 831EXCLUDE =
a2a27b4c 832
833# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
834# directories that are symbolic links (a Unix file system feature) are excluded
835# from the input.
836# The default value is: NO.
837
838EXCLUDE_SYMLINKS = NO
839
840# If the value of the INPUT tag contains directories, you can use the
841# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
842# certain files from those directories.
843#
844# Note that the wildcards are matched against the file with absolute path, so to
845# exclude all test directories for example use the pattern */test/*
846
36e6bf88 847EXCLUDE_PATTERNS =
a2a27b4c 848
849# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
850# (namespaces, classes, functions, etc.) that should be excluded from the
851# output. The symbol name can be a fully qualified name, a word, or if the
852# wildcard * is used, a substring. Examples: ANamespace, AClass,
853# AClass::ANamespace, ANamespace::*Test
854#
855# Note that the wildcards are matched against the file with absolute path, so to
856# exclude all test directories use the pattern */test/*
857
36e6bf88 858EXCLUDE_SYMBOLS =
a2a27b4c 859
860# The EXAMPLE_PATH tag can be used to specify one or more files or directories
861# that contain example code fragments that are included (see the \include
862# command).
863
36e6bf88 864EXAMPLE_PATH =
a2a27b4c 865
866# If the value of the EXAMPLE_PATH tag contains directories, you can use the
867# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
868# *.h) to filter out the source-files in the directories. If left blank all
869# files are included.
870
36e6bf88 871EXAMPLE_PATTERNS =
a2a27b4c 872
873# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
874# searched for input files to be used with the \include or \dontinclude commands
875# irrespective of the value of the RECURSIVE tag.
876# The default value is: NO.
877
878EXAMPLE_RECURSIVE = NO
879
880# The IMAGE_PATH tag can be used to specify one or more files or directories
881# that contain images that are to be included in the documentation (see the
882# \image command).
883
9954d4a4 884IMAGE_PATH = @CMAKE_SOURCE_DIR@/picts \
885 @CMAKE_SOURCE_DIR@/TPC/TPCbase/imgdoc
a2a27b4c 886
887# The INPUT_FILTER tag can be used to specify a program that doxygen should
888# invoke to filter for each input file. Doxygen will invoke the filter program
889# by executing (via popen()) the command:
890#
891# <filter> <input-file>
892#
893# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
894# name of an input file. Doxygen will then use the output that the filter
895# program writes to standard output. If FILTER_PATTERNS is specified, this tag
896# will be ignored.
897#
898# Note that the filter must not add or remove lines; it is applied before the
899# code is scanned, but not when the output code is generated. If lines are added
900# or removed, the anchors will not be placed correctly.
901
36e6bf88 902INPUT_FILTER =
a2a27b4c 903
904# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
905# basis. Doxygen will compare the file name with each pattern and apply the
906# filter if there is a match. The filters are a list of the form: pattern=filter
907# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
908# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
909# patterns match the file name, INPUT_FILTER is applied.
910
36e6bf88 911FILTER_PATTERNS =
a2a27b4c 912
913# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
36e6bf88 914# INPUT_FILTER) will also be used to filter the input files that are used for
a2a27b4c 915# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
916# The default value is: NO.
917
918FILTER_SOURCE_FILES = NO
919
920# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
921# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
922# it is also possible to disable source filtering for a specific pattern using
923# *.ext= (so without naming a filter).
924# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
925
36e6bf88 926FILTER_SOURCE_PATTERNS =
a2a27b4c 927
928# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
929# is part of the input, its contents will be placed on the main page
930# (index.html). This can be useful if you have a project on for instance GitHub
931# and want to reuse the introduction page also for the doxygen output.
932
863650ca 933USE_MDFILE_AS_MAINPAGE = mainpage.md
a2a27b4c 934
935#---------------------------------------------------------------------------
936# Configuration options related to source browsing
937#---------------------------------------------------------------------------
938
939# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
940# generated. Documented entities will be cross-referenced with these sources.
941#
942# Note: To get rid of all source code in the generated output, make sure that
943# also VERBATIM_HEADERS is set to NO.
944# The default value is: NO.
945
946SOURCE_BROWSER = NO
947
948# Setting the INLINE_SOURCES tag to YES will include the body of functions,
949# classes and enums directly into the documentation.
950# The default value is: NO.
951
952INLINE_SOURCES = NO
953
954# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
955# special comment blocks from generated source code fragments. Normal C, C++ and
956# Fortran comments will always remain visible.
957# The default value is: YES.
958
959STRIP_CODE_COMMENTS = YES
960
961# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
962# function all documented functions referencing it will be listed.
963# The default value is: NO.
964
965REFERENCED_BY_RELATION = NO
966
967# If the REFERENCES_RELATION tag is set to YES then for each documented function
968# all documented entities called/used by that function will be listed.
969# The default value is: NO.
970
971REFERENCES_RELATION = NO
972
973# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
36e6bf88 974# to YES then the hyperlinks from functions in REFERENCES_RELATION and
a2a27b4c 975# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
976# link to the documentation.
977# The default value is: YES.
978
979REFERENCES_LINK_SOURCE = YES
980
981# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
982# source code will show a tooltip with additional information such as prototype,
983# brief description and links to the definition and documentation. Since this
984# will make the HTML file larger and loading of large files a bit slower, you
985# can opt to disable this feature.
986# The default value is: YES.
987# This tag requires that the tag SOURCE_BROWSER is set to YES.
988
989SOURCE_TOOLTIPS = YES
990
991# If the USE_HTAGS tag is set to YES then the references to source code will
992# point to the HTML generated by the htags(1) tool instead of doxygen built-in
993# source browser. The htags tool is part of GNU's global source tagging system
994# (see http://www.gnu.org/software/global/global.html). You will need version
995# 4.8.6 or higher.
996#
997# To use it do the following:
998# - Install the latest version of global
999# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1000# - Make sure the INPUT points to the root of the source tree
1001# - Run doxygen as normal
1002#
1003# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1004# tools must be available from the command line (i.e. in the search path).
1005#
1006# The result: instead of the source browser generated by doxygen, the links to
1007# source code will now point to the output of htags.
1008# The default value is: NO.
1009# This tag requires that the tag SOURCE_BROWSER is set to YES.
1010
1011USE_HTAGS = NO
1012
1013# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1014# verbatim copy of the header file for each class for which an include is
1015# specified. Set to NO to disable this.
1016# See also: Section \class.
1017# The default value is: YES.
1018
1019VERBATIM_HEADERS = YES
1020
36e6bf88 1021# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1022# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1023# cost of reduced performance. This can be particularly helpful with template
1024# rich C++ code for which doxygen's built-in parser lacks the necessary type
1025# information.
1026# Note: The availability of this option depends on whether or not doxygen was
1027# compiled with the --with-libclang option.
1028# The default value is: NO.
1029
1030CLANG_ASSISTED_PARSING = NO
1031
1032# If clang assisted parsing is enabled you can provide the compiler with command
1033# line options that you would normally use when invoking the compiler. Note that
1034# the include paths will already be set by doxygen for the files and directories
1035# specified with INPUT and INCLUDE_PATH.
1036# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1037
1038CLANG_OPTIONS =
1039
a2a27b4c 1040#---------------------------------------------------------------------------
1041# Configuration options related to the alphabetical class index
1042#---------------------------------------------------------------------------
1043
1044# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1045# compounds will be generated. Enable this if the project contains a lot of
1046# classes, structs, unions or interfaces.
1047# The default value is: YES.
1048
1049ALPHABETICAL_INDEX = YES
1050
1051# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1052# which the alphabetical index list will be split.
1053# Minimum value: 1, maximum value: 20, default value: 5.
1054# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1055
1056COLS_IN_ALPHA_INDEX = 5
1057
1058# In case all classes in a project start with a common prefix, all classes will
1059# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1060# can be used to specify a prefix (or a list of prefixes) that should be ignored
1061# while generating the index headers.
1062# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1063
36e6bf88 1064IGNORE_PREFIX =
a2a27b4c 1065
1066#---------------------------------------------------------------------------
1067# Configuration options related to the HTML output
1068#---------------------------------------------------------------------------
1069
36e6bf88 1070# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
a2a27b4c 1071# The default value is: YES.
1072
1073GENERATE_HTML = YES
1074
1075# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1076# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1077# it.
1078# The default directory is: html.
1079# This tag requires that the tag GENERATE_HTML is set to YES.
1080
1081HTML_OUTPUT = html
1082
1083# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1084# generated HTML page (for example: .htm, .php, .asp).
1085# The default value is: .html.
1086# This tag requires that the tag GENERATE_HTML is set to YES.
1087
1088HTML_FILE_EXTENSION = .html
1089
1090# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1091# each generated HTML page. If the tag is left blank doxygen will generate a
1092# standard header.
1093#
1094# To get valid HTML the header file that includes any scripts and style sheets
1095# that doxygen needs, which is dependent on the configuration options used (e.g.
1096# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1097# default header using
1098# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1099# YourConfigFile
1100# and then modify the file new_header.html. See also section "Doxygen usage"
1101# for information on how to generate the default header that doxygen normally
1102# uses.
1103# Note: The header is subject to change so you typically have to regenerate the
1104# default header when upgrading to a newer version of doxygen. For a description
1105# of the possible markers and block names see the documentation.
1106# This tag requires that the tag GENERATE_HTML is set to YES.
1107
36e6bf88 1108HTML_HEADER =
a2a27b4c 1109
1110# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1111# generated HTML page. If the tag is left blank doxygen will generate a standard
1112# footer. See HTML_HEADER for more information on how to generate a default
1113# footer and what special commands can be used inside the footer. See also
1114# section "Doxygen usage" for information on how to generate the default footer
1115# that doxygen normally uses.
1116# This tag requires that the tag GENERATE_HTML is set to YES.
1117
36e6bf88 1118HTML_FOOTER =
a2a27b4c 1119
1120# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1121# sheet that is used by each HTML page. It can be used to fine-tune the look of
1122# the HTML output. If left blank doxygen will generate a default style sheet.
1123# See also section "Doxygen usage" for information on how to generate the style
1124# sheet that doxygen normally uses.
1125# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1126# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1127# obsolete.
1128# This tag requires that the tag GENERATE_HTML is set to YES.
1129
36e6bf88 1130HTML_STYLESHEET =
a2a27b4c 1131
1132# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1133# cascading style sheets that are included after the standard style sheets
1134# created by doxygen. Using this option one can overrule certain style aspects.
1135# This is preferred over using HTML_STYLESHEET since it does not replace the
36e6bf88 1136# standard style sheet and is therefore more robust against future updates.
a2a27b4c 1137# Doxygen will copy the style sheet files to the output directory.
36e6bf88 1138# Note: The order of the extra style sheet files is of importance (e.g. the last
1139# style sheet in the list overrules the setting of the previous ones in the
a2a27b4c 1140# list). For an example see the documentation.
1141# This tag requires that the tag GENERATE_HTML is set to YES.
1142
36e6bf88 1143HTML_EXTRA_STYLESHEET =
a2a27b4c 1144
1145# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1146# other source files which should be copied to the HTML output directory. Note
1147# that these files will be copied to the base HTML output directory. Use the
1148# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1149# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1150# files will be copied as-is; there are no commands or markers available.
1151# This tag requires that the tag GENERATE_HTML is set to YES.
1152
36e6bf88 1153HTML_EXTRA_FILES =
a2a27b4c 1154
1155# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
36e6bf88 1156# will adjust the colors in the style sheet and background images according to
a2a27b4c 1157# this color. Hue is specified as an angle on a colorwheel, see
1158# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1159# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1160# purple, and 360 is red again.
1161# Minimum value: 0, maximum value: 359, default value: 220.
1162# This tag requires that the tag GENERATE_HTML is set to YES.
1163
36e6bf88 1164HTML_COLORSTYLE_HUE = 0
a2a27b4c 1165
1166# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1167# in the HTML output. For a value of 0 the output will use grayscales only. A
1168# value of 255 will produce the most vivid colors.
1169# Minimum value: 0, maximum value: 255, default value: 100.
1170# This tag requires that the tag GENERATE_HTML is set to YES.
1171
36e6bf88 1172HTML_COLORSTYLE_SAT = 73
a2a27b4c 1173
1174# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1175# luminance component of the colors in the HTML output. Values below 100
1176# gradually make the output lighter, whereas values above 100 make the output
1177# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1178# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1179# change the gamma.
1180# Minimum value: 40, maximum value: 240, default value: 80.
1181# This tag requires that the tag GENERATE_HTML is set to YES.
1182
36e6bf88 1183HTML_COLORSTYLE_GAMMA = 98
a2a27b4c 1184
1185# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1186# page will contain the date and time when the page was generated. Setting this
1187# to NO can help when comparing the output of multiple runs.
1188# The default value is: YES.
1189# This tag requires that the tag GENERATE_HTML is set to YES.
1190
1191HTML_TIMESTAMP = YES
1192
1193# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1194# documentation will contain sections that can be hidden and shown after the
1195# page has loaded.
1196# The default value is: NO.
1197# This tag requires that the tag GENERATE_HTML is set to YES.
1198
70b3f518 1199HTML_DYNAMIC_SECTIONS = NO
a2a27b4c 1200
1201# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1202# shown in the various tree structured indices initially; the user can expand
1203# and collapse entries dynamically later on. Doxygen will expand the tree to
1204# such a level that at most the specified number of entries are visible (unless
1205# a fully collapsed tree already exceeds this amount). So setting the number of
1206# entries 1 will produce a full collapsed tree by default. 0 is a special value
1207# representing an infinite number of entries and will result in a full expanded
1208# tree by default.
1209# Minimum value: 0, maximum value: 9999, default value: 100.
1210# This tag requires that the tag GENERATE_HTML is set to YES.
1211
1212HTML_INDEX_NUM_ENTRIES = 100
1213
1214# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1215# generated that can be used as input for Apple's Xcode 3 integrated development
1216# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1217# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1218# Makefile in the HTML output directory. Running make will produce the docset in
1219# that directory and running make install will install the docset in
1220# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1221# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1222# for more information.
1223# The default value is: NO.
1224# This tag requires that the tag GENERATE_HTML is set to YES.
1225
1226GENERATE_DOCSET = NO
1227
1228# This tag determines the name of the docset feed. A documentation feed provides
1229# an umbrella under which multiple documentation sets from a single provider
1230# (such as a company or product suite) can be grouped.
1231# The default value is: Doxygen generated docs.
1232# This tag requires that the tag GENERATE_DOCSET is set to YES.
1233
1234DOCSET_FEEDNAME = "Doxygen generated docs"
1235
1236# This tag specifies a string that should uniquely identify the documentation
1237# set bundle. This should be a reverse domain-name style string, e.g.
1238# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1239# The default value is: org.doxygen.Project.
1240# This tag requires that the tag GENERATE_DOCSET is set to YES.
1241
1242DOCSET_BUNDLE_ID = org.doxygen.Project
1243
1244# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1245# the documentation publisher. This should be a reverse domain-name style
1246# string, e.g. com.mycompany.MyDocSet.documentation.
1247# The default value is: org.doxygen.Publisher.
1248# This tag requires that the tag GENERATE_DOCSET is set to YES.
1249
1250DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1251
1252# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1253# The default value is: Publisher.
1254# This tag requires that the tag GENERATE_DOCSET is set to YES.
1255
1256DOCSET_PUBLISHER_NAME = Publisher
1257
1258# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1259# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1260# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1261# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1262# Windows.
1263#
1264# The HTML Help Workshop contains a compiler that can convert all HTML output
1265# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1266# files are now used as the Windows 98 help format, and will replace the old
1267# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1268# HTML files also contain an index, a table of contents, and you can search for
1269# words in the documentation. The HTML workshop also contains a viewer for
1270# compressed HTML files.
1271# The default value is: NO.
1272# This tag requires that the tag GENERATE_HTML is set to YES.
1273
1274GENERATE_HTMLHELP = NO
1275
1276# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1277# file. You can add a path in front of the file if the result should not be
1278# written to the html output directory.
1279# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1280
36e6bf88 1281CHM_FILE =
a2a27b4c 1282
1283# The HHC_LOCATION tag can be used to specify the location (absolute path
36e6bf88 1284# including file name) of the HTML help compiler (hhc.exe). If non-empty,
a2a27b4c 1285# doxygen will try to run the HTML help compiler on the generated index.hhp.
1286# The file has to be specified with full path.
1287# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1288
36e6bf88 1289HHC_LOCATION =
a2a27b4c 1290
36e6bf88 1291# The GENERATE_CHI flag controls if a separate .chi index file is generated
1292# (YES) or that it should be included in the master .chm file (NO).
a2a27b4c 1293# The default value is: NO.
1294# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1295
1296GENERATE_CHI = NO
1297
36e6bf88 1298# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
a2a27b4c 1299# and project file content.
1300# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1301
36e6bf88 1302CHM_INDEX_ENCODING =
a2a27b4c 1303
36e6bf88 1304# The BINARY_TOC flag controls whether a binary table of contents is generated
1305# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
a2a27b4c 1306# enables the Previous and Next buttons.
1307# The default value is: NO.
1308# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1309
1310BINARY_TOC = NO
1311
1312# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1313# the table of contents of the HTML help documentation and to the tree view.
1314# The default value is: NO.
1315# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1316
1317TOC_EXPAND = NO
1318
1319# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1320# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1321# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1322# (.qch) of the generated HTML documentation.
1323# The default value is: NO.
1324# This tag requires that the tag GENERATE_HTML is set to YES.
1325
1326GENERATE_QHP = NO
1327
1328# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1329# the file name of the resulting .qch file. The path specified is relative to
1330# the HTML output folder.
1331# This tag requires that the tag GENERATE_QHP is set to YES.
1332
36e6bf88 1333QCH_FILE =
a2a27b4c 1334
1335# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1336# Project output. For more information please see Qt Help Project / Namespace
1337# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1338# The default value is: org.doxygen.Project.
1339# This tag requires that the tag GENERATE_QHP is set to YES.
1340
1341QHP_NAMESPACE = org.doxygen.Project
1342
1343# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1344# Help Project output. For more information please see Qt Help Project / Virtual
1345# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1346# folders).
1347# The default value is: doc.
1348# This tag requires that the tag GENERATE_QHP is set to YES.
1349
1350QHP_VIRTUAL_FOLDER = doc
1351
1352# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1353# filter to add. For more information please see Qt Help Project / Custom
1354# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1355# filters).
1356# This tag requires that the tag GENERATE_QHP is set to YES.
1357
36e6bf88 1358QHP_CUST_FILTER_NAME =
a2a27b4c 1359
1360# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1361# custom filter to add. For more information please see Qt Help Project / Custom
1362# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1363# filters).
1364# This tag requires that the tag GENERATE_QHP is set to YES.
1365
36e6bf88 1366QHP_CUST_FILTER_ATTRS =
a2a27b4c 1367
1368# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1369# project's filter section matches. Qt Help Project / Filter Attributes (see:
1370# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1371# This tag requires that the tag GENERATE_QHP is set to YES.
1372
36e6bf88 1373QHP_SECT_FILTER_ATTRS =
a2a27b4c 1374
1375# The QHG_LOCATION tag can be used to specify the location of Qt's
1376# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1377# generated .qhp file.
1378# This tag requires that the tag GENERATE_QHP is set to YES.
1379
36e6bf88 1380QHG_LOCATION =
a2a27b4c 1381
1382# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1383# generated, together with the HTML files, they form an Eclipse help plugin. To
1384# install this plugin and make it available under the help contents menu in
1385# Eclipse, the contents of the directory containing the HTML and XML files needs
1386# to be copied into the plugins directory of eclipse. The name of the directory
1387# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1388# After copying Eclipse needs to be restarted before the help appears.
1389# The default value is: NO.
1390# This tag requires that the tag GENERATE_HTML is set to YES.
1391
1392GENERATE_ECLIPSEHELP = NO
1393
1394# A unique identifier for the Eclipse help plugin. When installing the plugin
1395# the directory name containing the HTML and XML files should also have this
1396# name. Each documentation set should have its own identifier.
1397# The default value is: org.doxygen.Project.
1398# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1399
1400ECLIPSE_DOC_ID = org.doxygen.Project
1401
1402# If you want full control over the layout of the generated HTML pages it might
1403# be necessary to disable the index and replace it with your own. The
1404# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1405# of each HTML page. A value of NO enables the index and the value YES disables
1406# it. Since the tabs in the index contain the same information as the navigation
1407# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1408# The default value is: NO.
1409# This tag requires that the tag GENERATE_HTML is set to YES.
1410
1411DISABLE_INDEX = NO
1412
1413# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1414# structure should be generated to display hierarchical information. If the tag
1415# value is set to YES, a side panel will be generated containing a tree-like
1416# index structure (just like the one that is generated for HTML Help). For this
1417# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1418# (i.e. any modern browser). Windows users are probably better off using the
36e6bf88 1419# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
a2a27b4c 1420# further fine-tune the look of the index. As an example, the default style
1421# sheet generated by doxygen has an example that shows how to put an image at
1422# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1423# the same information as the tab index, you could consider setting
1424# DISABLE_INDEX to YES when enabling this option.
1425# The default value is: NO.
1426# This tag requires that the tag GENERATE_HTML is set to YES.
1427
36e6bf88 1428GENERATE_TREEVIEW = YES
a2a27b4c 1429
1430# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1431# doxygen will group on one line in the generated HTML documentation.
1432#
1433# Note that a value of 0 will completely suppress the enum values from appearing
1434# in the overview section.
1435# Minimum value: 0, maximum value: 20, default value: 4.
1436# This tag requires that the tag GENERATE_HTML is set to YES.
1437
1438ENUM_VALUES_PER_LINE = 4
1439
1440# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1441# to set the initial width (in pixels) of the frame in which the tree is shown.
1442# Minimum value: 0, maximum value: 1500, default value: 250.
1443# This tag requires that the tag GENERATE_HTML is set to YES.
1444
1445TREEVIEW_WIDTH = 250
1446
36e6bf88 1447# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
a2a27b4c 1448# external symbols imported via tag files in a separate window.
1449# The default value is: NO.
1450# This tag requires that the tag GENERATE_HTML is set to YES.
1451
1452EXT_LINKS_IN_WINDOW = NO
1453
1454# Use this tag to change the font size of LaTeX formulas included as images in
1455# the HTML documentation. When you change the font size after a successful
1456# doxygen run you need to manually remove any form_*.png images from the HTML
1457# output directory to force them to be regenerated.
1458# Minimum value: 8, maximum value: 50, default value: 10.
1459# This tag requires that the tag GENERATE_HTML is set to YES.
1460
1461FORMULA_FONTSIZE = 10
1462
1463# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1464# generated for formulas are transparent PNGs. Transparent PNGs are not
1465# supported properly for IE 6.0, but are supported on all modern browsers.
1466#
1467# Note that when changing this option you need to delete any form_*.png files in
1468# the HTML output directory before the changes have effect.
1469# The default value is: YES.
1470# This tag requires that the tag GENERATE_HTML is set to YES.
1471
1472FORMULA_TRANSPARENT = YES
1473
1474# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1475# http://www.mathjax.org) which uses client side Javascript for the rendering
36e6bf88 1476# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
a2a27b4c 1477# installed or if you want to formulas look prettier in the HTML output. When
1478# enabled you may also need to install MathJax separately and configure the path
1479# to it using the MATHJAX_RELPATH option.
1480# The default value is: NO.
1481# This tag requires that the tag GENERATE_HTML is set to YES.
1482
1483USE_MATHJAX = YES
1484
1485# When MathJax is enabled you can set the default output format to be used for
1486# the MathJax output. See the MathJax site (see:
1487# http://docs.mathjax.org/en/latest/output.html) for more details.
1488# Possible values are: HTML-CSS (which is slower, but has the best
1489# compatibility), NativeMML (i.e. MathML) and SVG.
1490# The default value is: HTML-CSS.
1491# This tag requires that the tag USE_MATHJAX is set to YES.
1492
1493MATHJAX_FORMAT = HTML-CSS
1494
1495# When MathJax is enabled you need to specify the location relative to the HTML
1496# output directory using the MATHJAX_RELPATH option. The destination directory
1497# should contain the MathJax.js script. For instance, if the mathjax directory
1498# is located at the same level as the HTML output directory, then
1499# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1500# Content Delivery Network so you can quickly see the result without installing
1501# MathJax. However, it is strongly recommended to install a local copy of
1502# MathJax from http://www.mathjax.org before deployment.
1503# The default value is: http://cdn.mathjax.org/mathjax/latest.
1504# This tag requires that the tag USE_MATHJAX is set to YES.
1505
1506MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1507
1508# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1509# extension names that should be enabled during MathJax rendering. For example
1510# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1511# This tag requires that the tag USE_MATHJAX is set to YES.
1512
36e6bf88 1513MATHJAX_EXTENSIONS =
a2a27b4c 1514
1515# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1516# of code that will be used on startup of the MathJax code. See the MathJax site
1517# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1518# example see the documentation.
1519# This tag requires that the tag USE_MATHJAX is set to YES.
1520
36e6bf88 1521MATHJAX_CODEFILE =
a2a27b4c 1522
1523# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1524# the HTML output. The underlying search engine uses javascript and DHTML and
1525# should work on any modern browser. Note that when using HTML help
1526# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1527# there is already a search function so this one should typically be disabled.
1528# For large projects the javascript based search engine can be slow, then
1529# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1530# search using the keyboard; to jump to the search box use <access key> + S
1531# (what the <access key> is depends on the OS and browser, but it is typically
1532# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1533# key> to jump into the search results window, the results can be navigated
1534# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1535# the search. The filter options can be selected when the cursor is inside the
1536# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1537# to select a filter and <Enter> or <escape> to activate or cancel the filter
1538# option.
1539# The default value is: YES.
1540# This tag requires that the tag GENERATE_HTML is set to YES.
1541
1542SEARCHENGINE = YES
1543
1544# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1545# implemented using a web server instead of a web client using Javascript. There
1546# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1547# setting. When disabled, doxygen will generate a PHP script for searching and
1548# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1549# and searching needs to be provided by external tools. See the section
1550# "External Indexing and Searching" for details.
1551# The default value is: NO.
1552# This tag requires that the tag SEARCHENGINE is set to YES.
1553
1554SERVER_BASED_SEARCH = NO
1555
1556# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1557# script for searching. Instead the search results are written to an XML file
1558# which needs to be processed by an external indexer. Doxygen will invoke an
1559# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1560# search results.
1561#
36e6bf88 1562# Doxygen ships with an example indexer (doxyindexer) and search engine
a2a27b4c 1563# (doxysearch.cgi) which are based on the open source search engine library
1564# Xapian (see: http://xapian.org/).
1565#
1566# See the section "External Indexing and Searching" for details.
1567# The default value is: NO.
1568# This tag requires that the tag SEARCHENGINE is set to YES.
1569
1570EXTERNAL_SEARCH = NO
1571
1572# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1573# which will return the search results when EXTERNAL_SEARCH is enabled.
1574#
36e6bf88 1575# Doxygen ships with an example indexer (doxyindexer) and search engine
a2a27b4c 1576# (doxysearch.cgi) which are based on the open source search engine library
1577# Xapian (see: http://xapian.org/). See the section "External Indexing and
1578# Searching" for details.
1579# This tag requires that the tag SEARCHENGINE is set to YES.
1580
36e6bf88 1581SEARCHENGINE_URL =
a2a27b4c 1582
1583# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1584# search data is written to a file for indexing by an external tool. With the
1585# SEARCHDATA_FILE tag the name of this file can be specified.
1586# The default file is: searchdata.xml.
1587# This tag requires that the tag SEARCHENGINE is set to YES.
1588
1589SEARCHDATA_FILE = searchdata.xml
1590
1591# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1592# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1593# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1594# projects and redirect the results back to the right project.
1595# This tag requires that the tag SEARCHENGINE is set to YES.
1596
36e6bf88 1597EXTERNAL_SEARCH_ID =
a2a27b4c 1598
1599# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1600# projects other than the one defined by this configuration file, but that are
1601# all added to the same external search index. Each project needs to have a
1602# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1603# to a relative location where the documentation can be found. The format is:
1604# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1605# This tag requires that the tag SEARCHENGINE is set to YES.
1606
36e6bf88 1607EXTRA_SEARCH_MAPPINGS =
a2a27b4c 1608
1609#---------------------------------------------------------------------------
1610# Configuration options related to the LaTeX output
1611#---------------------------------------------------------------------------
1612
36e6bf88 1613# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
a2a27b4c 1614# The default value is: YES.
1615
1616GENERATE_LATEX = NO
1617
1618# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1619# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1620# it.
1621# The default directory is: latex.
1622# This tag requires that the tag GENERATE_LATEX is set to YES.
1623
1624LATEX_OUTPUT = latex
1625
1626# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1627# invoked.
1628#
1629# Note that when enabling USE_PDFLATEX this option is only used for generating
1630# bitmaps for formulas in the HTML output, but not in the Makefile that is
1631# written to the output directory.
1632# The default file is: latex.
1633# This tag requires that the tag GENERATE_LATEX is set to YES.
1634
1635LATEX_CMD_NAME = latex
1636
1637# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1638# index for LaTeX.
1639# The default file is: makeindex.
1640# This tag requires that the tag GENERATE_LATEX is set to YES.
1641
1642MAKEINDEX_CMD_NAME = makeindex
1643
36e6bf88 1644# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
a2a27b4c 1645# documents. This may be useful for small projects and may help to save some
1646# trees in general.
1647# The default value is: NO.
1648# This tag requires that the tag GENERATE_LATEX is set to YES.
1649
1650COMPACT_LATEX = NO
1651
1652# The PAPER_TYPE tag can be used to set the paper type that is used by the
1653# printer.
1654# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1655# 14 inches) and executive (7.25 x 10.5 inches).
1656# The default value is: a4.
1657# This tag requires that the tag GENERATE_LATEX is set to YES.
1658
1659PAPER_TYPE = a4
1660
1661# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1662# that should be included in the LaTeX output. To get the times font for
1663# instance you can specify
1664# EXTRA_PACKAGES=times
1665# If left blank no extra packages will be included.
1666# This tag requires that the tag GENERATE_LATEX is set to YES.
1667
36e6bf88 1668EXTRA_PACKAGES =
a2a27b4c 1669
1670# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1671# generated LaTeX document. The header should contain everything until the first
1672# chapter. If it is left blank doxygen will generate a standard header. See
1673# section "Doxygen usage" for information on how to let doxygen write the
1674# default header to a separate file.
1675#
1676# Note: Only use a user-defined header if you know what you are doing! The
1677# following commands have a special meaning inside the header: $title,
1678# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
36e6bf88 1679# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1680# string, for the replacement values of the other commands the user is referred
1681# to HTML_HEADER.
a2a27b4c 1682# This tag requires that the tag GENERATE_LATEX is set to YES.
1683
36e6bf88 1684LATEX_HEADER =
a2a27b4c 1685
1686# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1687# generated LaTeX document. The footer should contain everything after the last
1688# chapter. If it is left blank doxygen will generate a standard footer. See
1689# LATEX_HEADER for more information on how to generate a default footer and what
1690# special commands can be used inside the footer.
1691#
1692# Note: Only use a user-defined footer if you know what you are doing!
1693# This tag requires that the tag GENERATE_LATEX is set to YES.
1694
36e6bf88 1695LATEX_FOOTER =
1696
1697# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1698# LaTeX style sheets that are included after the standard style sheets created
1699# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1700# will copy the style sheet files to the output directory.
1701# Note: The order of the extra style sheet files is of importance (e.g. the last
1702# style sheet in the list overrules the setting of the previous ones in the
1703# list).
1704# This tag requires that the tag GENERATE_LATEX is set to YES.
1705
1706LATEX_EXTRA_STYLESHEET =
a2a27b4c 1707
1708# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1709# other source files which should be copied to the LATEX_OUTPUT output
1710# directory. Note that the files will be copied as-is; there are no commands or
1711# markers available.
1712# This tag requires that the tag GENERATE_LATEX is set to YES.
1713
36e6bf88 1714LATEX_EXTRA_FILES =
a2a27b4c 1715
1716# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1717# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1718# contain links (just like the HTML output) instead of page references. This
1719# makes the output suitable for online browsing using a PDF viewer.
1720# The default value is: YES.
1721# This tag requires that the tag GENERATE_LATEX is set to YES.
1722
1723PDF_HYPERLINKS = YES
1724
1725# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
36e6bf88 1726# the PDF file directly from the LaTeX files. Set this option to YES, to get a
a2a27b4c 1727# higher quality PDF documentation.
1728# The default value is: YES.
1729# This tag requires that the tag GENERATE_LATEX is set to YES.
1730
1731USE_PDFLATEX = YES
1732
1733# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1734# command to the generated LaTeX files. This will instruct LaTeX to keep running
1735# if errors occur, instead of asking the user for help. This option is also used
1736# when generating formulas in HTML.
1737# The default value is: NO.
1738# This tag requires that the tag GENERATE_LATEX is set to YES.
1739
1740LATEX_BATCHMODE = NO
1741
1742# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1743# index chapters (such as File Index, Compound Index, etc.) in the output.
1744# The default value is: NO.
1745# This tag requires that the tag GENERATE_LATEX is set to YES.
1746
1747LATEX_HIDE_INDICES = NO
1748
1749# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1750# code with syntax highlighting in the LaTeX output.
1751#
1752# Note that which sources are shown also depends on other settings such as
1753# SOURCE_BROWSER.
1754# The default value is: NO.
1755# This tag requires that the tag GENERATE_LATEX is set to YES.
1756
1757LATEX_SOURCE_CODE = NO
1758
1759# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1760# bibliography, e.g. plainnat, or ieeetr. See
1761# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1762# The default value is: plain.
1763# This tag requires that the tag GENERATE_LATEX is set to YES.
1764
1765LATEX_BIB_STYLE = plain
1766
1767#---------------------------------------------------------------------------
1768# Configuration options related to the RTF output
1769#---------------------------------------------------------------------------
1770
36e6bf88 1771# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
a2a27b4c 1772# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1773# readers/editors.
1774# The default value is: NO.
1775
1776GENERATE_RTF = NO
1777
1778# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1779# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1780# it.
1781# The default directory is: rtf.
1782# This tag requires that the tag GENERATE_RTF is set to YES.
1783
1784RTF_OUTPUT = rtf
1785
36e6bf88 1786# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
a2a27b4c 1787# documents. This may be useful for small projects and may help to save some
1788# trees in general.
1789# The default value is: NO.
1790# This tag requires that the tag GENERATE_RTF is set to YES.
1791
1792COMPACT_RTF = NO
1793
1794# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1795# contain hyperlink fields. The RTF file will contain links (just like the HTML
1796# output) instead of page references. This makes the output suitable for online
1797# browsing using Word or some other Word compatible readers that support those
1798# fields.
1799#
1800# Note: WordPad (write) and others do not support links.
1801# The default value is: NO.
1802# This tag requires that the tag GENERATE_RTF is set to YES.
1803
1804RTF_HYPERLINKS = NO
1805
1806# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1807# file, i.e. a series of assignments. You only have to provide replacements,
1808# missing definitions are set to their default value.
1809#
1810# See also section "Doxygen usage" for information on how to generate the
1811# default style sheet that doxygen normally uses.
1812# This tag requires that the tag GENERATE_RTF is set to YES.
1813
36e6bf88 1814RTF_STYLESHEET_FILE =
a2a27b4c 1815
1816# Set optional variables used in the generation of an RTF document. Syntax is
1817# similar to doxygen's config file. A template extensions file can be generated
1818# using doxygen -e rtf extensionFile.
1819# This tag requires that the tag GENERATE_RTF is set to YES.
1820
36e6bf88 1821RTF_EXTENSIONS_FILE =
1822
1823# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1824# with syntax highlighting in the RTF output.
1825#
1826# Note that which sources are shown also depends on other settings such as
1827# SOURCE_BROWSER.
1828# The default value is: NO.
1829# This tag requires that the tag GENERATE_RTF is set to YES.
1830
1831RTF_SOURCE_CODE = NO
a2a27b4c 1832
1833#---------------------------------------------------------------------------
1834# Configuration options related to the man page output
1835#---------------------------------------------------------------------------
1836
36e6bf88 1837# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
a2a27b4c 1838# classes and files.
1839# The default value is: NO.
1840
1841GENERATE_MAN = NO
1842
1843# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1844# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1845# it. A directory man3 will be created inside the directory specified by
1846# MAN_OUTPUT.
1847# The default directory is: man.
1848# This tag requires that the tag GENERATE_MAN is set to YES.
1849
1850MAN_OUTPUT = man
1851
1852# The MAN_EXTENSION tag determines the extension that is added to the generated
1853# man pages. In case the manual section does not start with a number, the number
1854# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1855# optional.
1856# The default value is: .3.
1857# This tag requires that the tag GENERATE_MAN is set to YES.
1858
1859MAN_EXTENSION = .3
1860
1861# The MAN_SUBDIR tag determines the name of the directory created within
1862# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1863# MAN_EXTENSION with the initial . removed.
1864# This tag requires that the tag GENERATE_MAN is set to YES.
1865
36e6bf88 1866MAN_SUBDIR =
a2a27b4c 1867
1868# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1869# will generate one additional man file for each entity documented in the real
1870# man page(s). These additional files only source the real man page, but without
1871# them the man command would be unable to find the correct page.
1872# The default value is: NO.
1873# This tag requires that the tag GENERATE_MAN is set to YES.
1874
1875MAN_LINKS = NO
1876
1877#---------------------------------------------------------------------------
1878# Configuration options related to the XML output
1879#---------------------------------------------------------------------------
1880
36e6bf88 1881# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
a2a27b4c 1882# captures the structure of the code including all documentation.
1883# The default value is: NO.
1884
1885GENERATE_XML = NO
1886
1887# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1888# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1889# it.
1890# The default directory is: xml.
1891# This tag requires that the tag GENERATE_XML is set to YES.
1892
1893XML_OUTPUT = xml
1894
36e6bf88 1895# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
a2a27b4c 1896# listings (including syntax highlighting and cross-referencing information) to
1897# the XML output. Note that enabling this will significantly increase the size
1898# of the XML output.
1899# The default value is: YES.
1900# This tag requires that the tag GENERATE_XML is set to YES.
1901
1902XML_PROGRAMLISTING = YES
1903
1904#---------------------------------------------------------------------------
1905# Configuration options related to the DOCBOOK output
1906#---------------------------------------------------------------------------
1907
36e6bf88 1908# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
a2a27b4c 1909# that can be used to generate PDF.
1910# The default value is: NO.
1911
1912GENERATE_DOCBOOK = NO
1913
1914# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1915# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1916# front of it.
1917# The default directory is: docbook.
1918# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1919
1920DOCBOOK_OUTPUT = docbook
1921
36e6bf88 1922# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
a2a27b4c 1923# program listings (including syntax highlighting and cross-referencing
1924# information) to the DOCBOOK output. Note that enabling this will significantly
1925# increase the size of the DOCBOOK output.
1926# The default value is: NO.
1927# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1928
1929DOCBOOK_PROGRAMLISTING = NO
1930
1931#---------------------------------------------------------------------------
1932# Configuration options for the AutoGen Definitions output
1933#---------------------------------------------------------------------------
1934
36e6bf88 1935# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1936# AutoGen Definitions (see http://autogen.sf.net) file that captures the
1937# structure of the code including all documentation. Note that this feature is
1938# still experimental and incomplete at the moment.
a2a27b4c 1939# The default value is: NO.
1940
1941GENERATE_AUTOGEN_DEF = NO
1942
1943#---------------------------------------------------------------------------
1944# Configuration options related to the Perl module output
1945#---------------------------------------------------------------------------
1946
36e6bf88 1947# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
a2a27b4c 1948# file that captures the structure of the code including all documentation.
1949#
1950# Note that this feature is still experimental and incomplete at the moment.
1951# The default value is: NO.
1952
1953GENERATE_PERLMOD = NO
1954
36e6bf88 1955# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
a2a27b4c 1956# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1957# output from the Perl module output.
1958# The default value is: NO.
1959# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1960
1961PERLMOD_LATEX = NO
1962
36e6bf88 1963# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
a2a27b4c 1964# formatted so it can be parsed by a human reader. This is useful if you want to
36e6bf88 1965# understand what is going on. On the other hand, if this tag is set to NO, the
a2a27b4c 1966# size of the Perl module output will be much smaller and Perl will parse it
1967# just the same.
1968# The default value is: YES.
1969# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1970
1971PERLMOD_PRETTY = YES
1972
1973# The names of the make variables in the generated doxyrules.make file are
1974# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1975# so different doxyrules.make files included by the same Makefile don't
1976# overwrite each other's variables.
1977# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1978
36e6bf88 1979PERLMOD_MAKEVAR_PREFIX =
a2a27b4c 1980
1981#---------------------------------------------------------------------------
1982# Configuration options related to the preprocessor
1983#---------------------------------------------------------------------------
1984
36e6bf88 1985# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
a2a27b4c 1986# C-preprocessor directives found in the sources and include files.
1987# The default value is: YES.
1988
1989ENABLE_PREPROCESSING = YES
1990
36e6bf88 1991# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1992# in the source code. If set to NO, only conditional compilation will be
a2a27b4c 1993# performed. Macro expansion can be done in a controlled way by setting
1994# EXPAND_ONLY_PREDEF to YES.
1995# The default value is: NO.
1996# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1997
1998MACRO_EXPANSION = NO
1999
2000# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2001# the macro expansion is limited to the macros specified with the PREDEFINED and
2002# EXPAND_AS_DEFINED tags.
2003# The default value is: NO.
2004# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2005
2006EXPAND_ONLY_PREDEF = NO
2007
36e6bf88 2008# If the SEARCH_INCLUDES tag is set to YES, the include files in the
a2a27b4c 2009# INCLUDE_PATH will be searched if a #include is found.
2010# The default value is: YES.
2011# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2012
2013SEARCH_INCLUDES = YES
2014
2015# The INCLUDE_PATH tag can be used to specify one or more directories that
2016# contain include files that are not input files but should be processed by the
2017# preprocessor.
2018# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2019
36e6bf88 2020INCLUDE_PATH =
a2a27b4c 2021
2022# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2023# patterns (like *.h and *.hpp) to filter out the header-files in the
2024# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2025# used.
2026# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2027
36e6bf88 2028INCLUDE_FILE_PATTERNS =
a2a27b4c 2029
2030# The PREDEFINED tag can be used to specify one or more macro names that are
2031# defined before the preprocessor is started (similar to the -D option of e.g.
2032# gcc). The argument of the tag is a list of macros of the form: name or
2033# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2034# is assumed. To prevent a macro definition from being undefined via #undef or
2035# recursively expanded use the := operator instead of the = operator.
2036# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2037
36e6bf88 2038PREDEFINED =
a2a27b4c 2039
2040# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2041# tag can be used to specify a list of macro names that should be expanded. The
2042# macro definition that is found in the sources will be used. Use the PREDEFINED
2043# tag if you want to use a different macro definition that overrules the
2044# definition found in the source code.
2045# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2046
36e6bf88 2047EXPAND_AS_DEFINED =
a2a27b4c 2048
2049# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2050# remove all references to function-like macros that are alone on a line, have
2051# an all uppercase name, and do not end with a semicolon. Such function macros
2052# are typically used for boiler-plate code, and will confuse the parser if not
2053# removed.
2054# The default value is: YES.
2055# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2056
2057SKIP_FUNCTION_MACROS = YES
2058
2059#---------------------------------------------------------------------------
2060# Configuration options related to external references
2061#---------------------------------------------------------------------------
2062
2063# The TAGFILES tag can be used to specify one or more tag files. For each tag
2064# file the location of the external documentation should be added. The format of
2065# a tag file without this location is as follows:
2066# TAGFILES = file1 file2 ...
2067# Adding location for the tag files is done as follows:
2068# TAGFILES = file1=loc1 "file2 = loc2" ...
2069# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2070# section "Linking to external documentation" for more information about the use
2071# of tag files.
2072# Note: Each tag file must have a unique name (where the name does NOT include
2073# the path). If a tag file is not located in the directory in which doxygen is
2074# run, you must also specify the path to the tagfile here.
2075
36e6bf88 2076TAGFILES =
a2a27b4c 2077
2078# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2079# tag file that is based on the input files it reads. See section "Linking to
2080# external documentation" for more information about the usage of tag files.
2081
36e6bf88 2082GENERATE_TAGFILE =
a2a27b4c 2083
36e6bf88 2084# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2085# the class index. If set to NO, only the inherited external classes will be
2086# listed.
a2a27b4c 2087# The default value is: NO.
2088
2089ALLEXTERNALS = NO
2090
36e6bf88 2091# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2092# in the modules index. If set to NO, only the current project's groups will be
a2a27b4c 2093# listed.
2094# The default value is: YES.
2095
2096EXTERNAL_GROUPS = YES
2097
36e6bf88 2098# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
a2a27b4c 2099# the related pages index. If set to NO, only the current project's pages will
2100# be listed.
2101# The default value is: YES.
2102
2103EXTERNAL_PAGES = YES
2104
2105# The PERL_PATH should be the absolute path and name of the perl script
2106# interpreter (i.e. the result of 'which perl').
2107# The default file (with absolute path) is: /usr/bin/perl.
2108
2109PERL_PATH = /usr/bin/perl
2110
2111#---------------------------------------------------------------------------
2112# Configuration options related to the dot tool
2113#---------------------------------------------------------------------------
2114
36e6bf88 2115# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
a2a27b4c 2116# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2117# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2118# disabled, but it is recommended to install and use dot, since it yields more
2119# powerful graphs.
2120# The default value is: YES.
2121
2122CLASS_DIAGRAMS = YES
2123
2124# You can define message sequence charts within doxygen comments using the \msc
2125# command. Doxygen will then run the mscgen tool (see:
2126# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2127# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2128# the mscgen tool resides. If left empty the tool is assumed to be found in the
2129# default search path.
2130
36e6bf88 2131MSCGEN_PATH =
a2a27b4c 2132
2133# You can include diagrams made with dia in doxygen documentation. Doxygen will
2134# then run dia to produce the diagram and insert it in the documentation. The
2135# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2136# If left empty dia is assumed to be found in the default search path.
2137
36e6bf88 2138DIA_PATH =
a2a27b4c 2139
36e6bf88 2140# If set to YES the inheritance and collaboration graphs will hide inheritance
a2a27b4c 2141# and usage relations if the target is undocumented or is not a class.
2142# The default value is: YES.
2143
b3fd2f9f 2144HIDE_UNDOC_RELATIONS = YES
a2a27b4c 2145
2146# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2147# available from the path. This tool is part of Graphviz (see:
2148# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2149# Bell Labs. The other options in this section have no effect if this option is
2150# set to NO
2151# The default value is: NO.
2152
2153HAVE_DOT = YES
2154
2155# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2156# to run in parallel. When set to 0 doxygen will base this on the number of
2157# processors available in the system. You can set it explicitly to a value
2158# larger than 0 to get control over the balance between CPU load and processing
2159# speed.
2160# Minimum value: 0, maximum value: 32, default value: 0.
2161# This tag requires that the tag HAVE_DOT is set to YES.
2162
2163DOT_NUM_THREADS = 0
2164
2165# When you want a differently looking font in the dot files that doxygen
2166# generates you can specify the font name using DOT_FONTNAME. You need to make
2167# sure dot is able to find the font, which can be done by putting it in a
2168# standard location or by setting the DOTFONTPATH environment variable or by
2169# setting DOT_FONTPATH to the directory containing the font.
2170# The default value is: Helvetica.
2171# This tag requires that the tag HAVE_DOT is set to YES.
2172
2173DOT_FONTNAME = Helvetica
2174
2175# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2176# dot graphs.
2177# Minimum value: 4, maximum value: 24, default value: 10.
2178# This tag requires that the tag HAVE_DOT is set to YES.
2179
2180DOT_FONTSIZE = 10
2181
2182# By default doxygen will tell dot to use the default font as specified with
2183# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2184# the path where dot can find it using this tag.
2185# This tag requires that the tag HAVE_DOT is set to YES.
2186
36e6bf88 2187DOT_FONTPATH =
a2a27b4c 2188
2189# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2190# each documented class showing the direct and indirect inheritance relations.
2191# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2192# The default value is: YES.
2193# This tag requires that the tag HAVE_DOT is set to YES.
2194
2195CLASS_GRAPH = YES
2196
2197# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2198# graph for each documented class showing the direct and indirect implementation
2199# dependencies (inheritance, containment, and class references variables) of the
2200# class with other documented classes.
2201# The default value is: YES.
2202# This tag requires that the tag HAVE_DOT is set to YES.
2203
2204COLLABORATION_GRAPH = YES
2205
2206# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2207# groups, showing the direct groups dependencies.
2208# The default value is: YES.
2209# This tag requires that the tag HAVE_DOT is set to YES.
2210
2211GROUP_GRAPHS = YES
2212
36e6bf88 2213# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
a2a27b4c 2214# collaboration diagrams in a style similar to the OMG's Unified Modeling
2215# Language.
2216# The default value is: NO.
2217# This tag requires that the tag HAVE_DOT is set to YES.
2218
2219UML_LOOK = NO
2220
2221# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2222# class node. If there are many fields or methods and many nodes the graph may
2223# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2224# number of items for each type to make the size more manageable. Set this to 0
2225# for no limit. Note that the threshold may be exceeded by 50% before the limit
2226# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2227# but if the number exceeds 15, the total amount of fields shown is limited to
2228# 10.
2229# Minimum value: 0, maximum value: 100, default value: 10.
2230# This tag requires that the tag HAVE_DOT is set to YES.
2231
2232UML_LIMIT_NUM_FIELDS = 10
2233
2234# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2235# collaboration graphs will show the relations between templates and their
2236# instances.
2237# The default value is: NO.
2238# This tag requires that the tag HAVE_DOT is set to YES.
2239
2240TEMPLATE_RELATIONS = NO
2241
2242# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2243# YES then doxygen will generate a graph for each documented file showing the
2244# direct and indirect include dependencies of the file with other documented
2245# files.
2246# The default value is: YES.
2247# This tag requires that the tag HAVE_DOT is set to YES.
2248
2249INCLUDE_GRAPH = YES
2250
2251# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2252# set to YES then doxygen will generate a graph for each documented file showing
2253# the direct and indirect include dependencies of the file with other documented
2254# files.
2255# The default value is: YES.
2256# This tag requires that the tag HAVE_DOT is set to YES.
2257
2258INCLUDED_BY_GRAPH = YES
2259
2260# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2261# dependency graph for every global function or class method.
2262#
2263# Note that enabling this option will significantly increase the time of a run.
2264# So in most cases it will be better to enable call graphs for selected
2265# functions only using the \callgraph command.
2266# The default value is: NO.
2267# This tag requires that the tag HAVE_DOT is set to YES.
2268
2269CALL_GRAPH = NO
2270
2271# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2272# dependency graph for every global function or class method.
2273#
2274# Note that enabling this option will significantly increase the time of a run.
2275# So in most cases it will be better to enable caller graphs for selected
2276# functions only using the \callergraph command.
2277# The default value is: NO.
2278# This tag requires that the tag HAVE_DOT is set to YES.
2279
2280CALLER_GRAPH = NO
2281
2282# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2283# hierarchy of all classes instead of a textual one.
2284# The default value is: YES.
2285# This tag requires that the tag HAVE_DOT is set to YES.
2286
2287GRAPHICAL_HIERARCHY = YES
2288
2289# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2290# dependencies a directory has on other directories in a graphical way. The
2291# dependency relations are determined by the #include relations between the
2292# files in the directories.
2293# The default value is: YES.
2294# This tag requires that the tag HAVE_DOT is set to YES.
2295
2296DIRECTORY_GRAPH = YES
2297
2298# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2299# generated by dot.
2300# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2301# to make the SVG files visible in IE 9+ (other browsers do not have this
2302# requirement).
2303# Possible values are: png, jpg, gif and svg.
2304# The default value is: png.
2305# This tag requires that the tag HAVE_DOT is set to YES.
2306
2307DOT_IMAGE_FORMAT = png
2308
2309# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2310# enable generation of interactive SVG images that allow zooming and panning.
2311#
2312# Note that this requires a modern browser other than Internet Explorer. Tested
2313# and working are Firefox, Chrome, Safari, and Opera.
2314# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2315# the SVG files visible. Older versions of IE do not have SVG support.
2316# The default value is: NO.
2317# This tag requires that the tag HAVE_DOT is set to YES.
2318
2319INTERACTIVE_SVG = NO
2320
2321# The DOT_PATH tag can be used to specify the path where the dot tool can be
2322# found. If left blank, it is assumed the dot tool can be found in the path.
2323# This tag requires that the tag HAVE_DOT is set to YES.
2324
f2582ba8 2325DOT_PATH = @DOXYGEN_DOT_PATH@
a2a27b4c 2326
2327# The DOTFILE_DIRS tag can be used to specify one or more directories that
2328# contain dot files that are included in the documentation (see the \dotfile
2329# command).
2330# This tag requires that the tag HAVE_DOT is set to YES.
2331
36e6bf88 2332DOTFILE_DIRS =
a2a27b4c 2333
2334# The MSCFILE_DIRS tag can be used to specify one or more directories that
2335# contain msc files that are included in the documentation (see the \mscfile
2336# command).
2337
36e6bf88 2338MSCFILE_DIRS =
a2a27b4c 2339
2340# The DIAFILE_DIRS tag can be used to specify one or more directories that
2341# contain dia files that are included in the documentation (see the \diafile
2342# command).
2343
36e6bf88 2344DIAFILE_DIRS =
a2a27b4c 2345
2346# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2347# path where java can find the plantuml.jar file. If left blank, it is assumed
2348# PlantUML is not used or called during a preprocessing step. Doxygen will
2349# generate a warning when it encounters a \startuml command in this case and
2350# will not generate output for the diagram.
a2a27b4c 2351
36e6bf88 2352PLANTUML_JAR_PATH =
2353
2354# When using plantuml, the specified paths are searched for files specified by
2355# the !include statement in a plantuml block.
2356
2357PLANTUML_INCLUDE_PATH =
a2a27b4c 2358
2359# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2360# that will be shown in the graph. If the number of nodes in a graph becomes
2361# larger than this value, doxygen will truncate the graph, which is visualized
2362# by representing a node as a red box. Note that doxygen if the number of direct
2363# children of the root node in a graph is already larger than
2364# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2365# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2366# Minimum value: 0, maximum value: 10000, default value: 50.
2367# This tag requires that the tag HAVE_DOT is set to YES.
2368
2369DOT_GRAPH_MAX_NODES = 50
2370
2371# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2372# generated by dot. A depth value of 3 means that only nodes reachable from the
2373# root by following a path via at most 3 edges will be shown. Nodes that lay
2374# further from the root node will be omitted. Note that setting this option to 1
2375# or 2 may greatly reduce the computation time needed for large code bases. Also
2376# note that the size of a graph can be further restricted by
2377# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2378# Minimum value: 0, maximum value: 1000, default value: 0.
2379# This tag requires that the tag HAVE_DOT is set to YES.
2380
2381MAX_DOT_GRAPH_DEPTH = 0
2382
2383# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2384# background. This is disabled by default, because dot on Windows does not seem
2385# to support this out of the box.
2386#
2387# Warning: Depending on the platform used, enabling this option may lead to
2388# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2389# read).
2390# The default value is: NO.
2391# This tag requires that the tag HAVE_DOT is set to YES.
2392
2393DOT_TRANSPARENT = NO
2394
36e6bf88 2395# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
a2a27b4c 2396# files in one run (i.e. multiple -o and -T options on the command line). This
2397# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2398# this, this feature is disabled by default.
2399# The default value is: NO.
2400# This tag requires that the tag HAVE_DOT is set to YES.
2401
2402DOT_MULTI_TARGETS = NO
2403
2404# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2405# explaining the meaning of the various boxes and arrows in the dot generated
2406# graphs.
2407# The default value is: YES.
2408# This tag requires that the tag HAVE_DOT is set to YES.
2409
2410GENERATE_LEGEND = YES
2411
36e6bf88 2412# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
a2a27b4c 2413# files that are used to generate the various graphs.
2414# The default value is: YES.
2415# This tag requires that the tag HAVE_DOT is set to YES.
2416
2417DOT_CLEANUP = YES