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