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