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