source: 3DVCSoftware/trunk/doc/Doxyfile @ 1314

Last change on this file since 1314 was 1313, checked in by tech, 9 years ago

Merged 14.1-update-dev1@1312.

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