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