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