blob: 76645f9caaf1109bba7400970ab81ce8aeb7c580 [file] [log] [blame]
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02001# Doxyfile 1.8.18
Martin Turon51a2ec72020-05-12 14:57:53 -07002
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02003# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project.
Martin Turon51a2ec72020-05-12 14:57:53 -07005#
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02006# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
Martin Turon51a2ec72020-05-12 14:57:53 -07008#
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02009# 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 (\" \").
Martin Turon51a2ec72020-05-12 14:57:53 -070015
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
19
Martin Turon1c325c42020-06-29 09:06:55 -070020# 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.
Martin Turon51a2ec72020-05-12 14:57:53 -070025# 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
Vivien Nicolas9754e3d2020-09-18 19:53:58 +020035PROJECT_NAME = $(CHIP_NAME)
Martin Turon51a2ec72020-05-12 14:57:53 -070036
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
Vivien Nicolas9754e3d2020-09-18 19:53:58 +020041PROJECT_NUMBER = $(CHIP_VERSION)
Martin Turon51a2ec72020-05-12 14:57:53 -070042
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
Vivien Nicolas9754e3d2020-09-18 19:53:58 +020047PROJECT_BRIEF =
Martin Turon51a2ec72020-05-12 14:57:53 -070048
Martin Turon1c325c42020-06-29 09:06:55 -070049# 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.
Martin Turon51a2ec72020-05-12 14:57:53 -070053
Vivien Nicolas9754e3d2020-09-18 19:53:58 +020054PROJECT_LOGO = docs/images/logo.svg
Martin Turon51a2ec72020-05-12 14:57:53 -070055
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
Vivien Nicolas9754e3d2020-09-18 19:53:58 +020061OUTPUT_DIRECTORY = docs
Martin Turon51a2ec72020-05-12 14:57:53 -070062
Martin Turon1c325c42020-06-29 09:06:55 -070063# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
Martin Turon51a2ec72020-05-12 14:57:53 -070064# 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
Martin Turon1c325c42020-06-29 09:06:55 -070073# 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
Martin Turon51a2ec72020-05-12 14:57:53 -070081# 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
Martin Turon1c325c42020-06-29 09:06:55 -070096# 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
Martin Turon51a2ec72020-05-12 14:57:53 -0700105# 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
Martin Turon1c325c42020-06-29 09:06:55 -0700111# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
Martin Turon51a2ec72020-05-12 14:57:53 -0700112# 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 = "The $name class" \
130 "The $name widget" \
131 "The $name file" \
132 is \
133 provides \
134 specifies \
135 contains \
136 represents \
137 a \
138 an \
139 the
140
141# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
142# doxygen will generate a detailed section even if there is only a brief
143# description.
144# The default value is: NO.
145
146ALWAYS_DETAILED_SEC = NO
147
148# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
149# inherited members of a class in the documentation of that class as if those
150# members were ordinary class members. Constructors, destructors and assignment
151# operators of the base classes will not be shown.
152# The default value is: NO.
153
154INLINE_INHERITED_MEMB = NO
155
Martin Turon1c325c42020-06-29 09:06:55 -0700156# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
Martin Turon51a2ec72020-05-12 14:57:53 -0700157# before files name in the file list and in the header files. If set to NO the
158# shortest path that makes the file name unique will be used
159# The default value is: YES.
160
161FULL_PATH_NAMES = YES
162
163# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
164# Stripping is only done if one of the specified strings matches the left-hand
165# part of the path. The tag can be used to show relative paths in the file list.
166# If left blank the directory from which doxygen is run is used as the path to
167# strip.
168#
169# Note that you can specify absolute paths here, but also relative paths, which
170# will be relative from the directory where doxygen is started.
171# This tag requires that the tag FULL_PATH_NAMES is set to YES.
172
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200173STRIP_FROM_PATH = src
Martin Turon51a2ec72020-05-12 14:57:53 -0700174
175# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
176# path mentioned in the documentation of a class, which tells the reader which
177# header file to include in order to use a class. If left blank only the name of
178# the header file containing the class definition is used. Otherwise one should
179# specify the list of include paths that are normally passed to the compiler
180# using the -I flag.
181
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200182STRIP_FROM_INC_PATH = src
Martin Turon51a2ec72020-05-12 14:57:53 -0700183
184# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
185# less readable) file names. This can be useful is your file systems doesn't
186# support long names like on DOS, Mac, or CD-ROM.
187# The default value is: NO.
188
189SHORT_NAMES = NO
190
191# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
192# first line (until the first dot) of a Javadoc-style comment as the brief
193# description. If set to NO, the Javadoc-style will behave just like regular Qt-
194# style comments (thus requiring an explicit @brief command for a brief
195# description.)
196# The default value is: NO.
197
198JAVADOC_AUTOBRIEF = YES
199
Martin Turon1c325c42020-06-29 09:06:55 -0700200# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
201# such as
202# /***************
203# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
204# Javadoc-style will behave just like regular comments and it will not be
205# interpreted by doxygen.
206# The default value is: NO.
207
208JAVADOC_BANNER = NO
209
Martin Turon51a2ec72020-05-12 14:57:53 -0700210# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
211# line (until the first dot) of a Qt-style comment as the brief description. If
212# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
213# requiring an explicit \brief command for a brief description.)
214# The default value is: NO.
215
216QT_AUTOBRIEF = NO
217
218# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
219# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
220# a brief description. This used to be the default behavior. The new default is
221# to treat a multi-line C++ comment block as a detailed description. Set this
222# tag to YES if you prefer the old behavior instead.
223#
224# Note that setting this tag to YES also means that rational rose comments are
225# not recognized any more.
226# The default value is: NO.
227
228MULTILINE_CPP_IS_BRIEF = NO
229
230# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
231# documentation from any documented member that it re-implements.
232# The default value is: YES.
233
234INHERIT_DOCS = YES
235
Martin Turon1c325c42020-06-29 09:06:55 -0700236# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
237# page for each member. If set to NO, the documentation of a member will be part
238# of the file/class/namespace that contains it.
Martin Turon51a2ec72020-05-12 14:57:53 -0700239# The default value is: NO.
240
241SEPARATE_MEMBER_PAGES = NO
242
243# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
244# uses this value to replace tabs by spaces in code fragments.
245# Minimum value: 1, maximum value: 16, default value: 4.
246
247TAB_SIZE = 4
248
249# This tag can be used to specify a number of aliases that act as commands in
250# the documentation. An alias has the form:
251# name=value
252# For example adding
253# "sideeffect=@par Side Effects:\n"
254# will allow you to put the command \sideeffect (or @sideeffect) in the
255# documentation, which will result in a user-defined paragraph with heading
256# "Side Effects:". You can put \n's in the value part of an alias to insert
Martin Turon1c325c42020-06-29 09:06:55 -0700257# newlines (in the resulting output). You can put ^^ in the value part of an
258# alias to insert a newline as if a physical newline was in the original file.
259# When you need a literal { or } or , in the value part of an alias you have to
260# escape them by means of a backslash (\), this can lead to conflicts with the
261# commands \{ and \} for these it is advised to use the version @{ and @} or use
262# a double escape (\\{ and \\})
Martin Turon51a2ec72020-05-12 14:57:53 -0700263
264ALIASES =
265
Martin Turon51a2ec72020-05-12 14:57:53 -0700266# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
267# only. Doxygen will then generate output that is more tailored for C. For
268# instance, some of the names that are used will be different. The list of all
269# members will be omitted, etc.
270# The default value is: NO.
271
272OPTIMIZE_OUTPUT_FOR_C = NO
273
274# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
275# Python sources only. Doxygen will then generate output that is more tailored
276# for that language. For instance, namespaces will be presented as packages,
277# qualified scopes will look different, etc.
278# The default value is: NO.
279
280OPTIMIZE_OUTPUT_JAVA = NO
281
282# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
283# sources. Doxygen will then generate output that is tailored for Fortran.
284# The default value is: NO.
285
286OPTIMIZE_FOR_FORTRAN = NO
287
288# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
289# sources. Doxygen will then generate output that is tailored for VHDL.
290# The default value is: NO.
291
292OPTIMIZE_OUTPUT_VHDL = NO
293
Martin Turon1c325c42020-06-29 09:06:55 -0700294# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
295# sources only. Doxygen will then generate output that is more tailored for that
296# language. For instance, namespaces will be presented as modules, types will be
297# separated into more groups, etc.
298# The default value is: NO.
299
300OPTIMIZE_OUTPUT_SLICE = NO
301
Martin Turon51a2ec72020-05-12 14:57:53 -0700302# Doxygen selects the parser to use depending on the extension of the files it
303# parses. With this tag you can assign which parser to use for a given
304# extension. Doxygen has a built-in mapping, but you can override or extend it
305# using this tag. The format is ext=language, where ext is a file extension, and
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200306# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
307# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
Martin Turon1c325c42020-06-29 09:06:55 -0700308# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
309# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
310# tries to guess whether the code is fixed or free formatted code, this is the
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200311# default for Fortran type files). For instance to make doxygen treat .inc files
312# as Fortran files (default is PHP), and .f files as C (default is Fortran),
313# use: inc=Fortran f=C.
Martin Turon51a2ec72020-05-12 14:57:53 -0700314#
Martin Turon1c325c42020-06-29 09:06:55 -0700315# Note: For files without extension you can use no_extension as a placeholder.
Martin Turon51a2ec72020-05-12 14:57:53 -0700316#
317# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
318# the files are not read by doxygen.
319
320EXTENSION_MAPPING = h=C++
321
322# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
323# according to the Markdown format, which allows for more readable
Martin Turon1c325c42020-06-29 09:06:55 -0700324# documentation. See https://daringfireball.net/projects/markdown/ for details.
Martin Turon51a2ec72020-05-12 14:57:53 -0700325# The output of markdown processing is further processed by doxygen, so you can
326# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
327# case of backward compatibilities issues.
328# The default value is: YES.
329
330MARKDOWN_SUPPORT = YES
331
Martin Turon1c325c42020-06-29 09:06:55 -0700332# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
333# to that level are automatically included in the table of contents, even if
334# they do not have an id attribute.
335# Note: This feature currently applies only to Markdown headings.
336# Minimum value: 0, maximum value: 99, default value: 5.
337# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
338
339TOC_INCLUDE_HEADINGS = 5
340
Martin Turon51a2ec72020-05-12 14:57:53 -0700341# When enabled doxygen tries to link words that correspond to documented
342# classes, or namespaces to their corresponding documentation. Such a link can
Martin Turon1c325c42020-06-29 09:06:55 -0700343# be prevented in individual cases by putting a % sign in front of the word or
344# globally by setting AUTOLINK_SUPPORT to NO.
Martin Turon51a2ec72020-05-12 14:57:53 -0700345# The default value is: YES.
346
347AUTOLINK_SUPPORT = YES
348
349# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
350# to include (a tag file for) the STL sources as input, then you should set this
351# tag to YES in order to let doxygen match functions declarations and
352# definitions whose arguments contain STL classes (e.g. func(std::string);
353# versus func(std::string) {}). This also make the inheritance and collaboration
354# diagrams that involve STL classes more complete and accurate.
355# The default value is: NO.
356
Vivien Nicolas9393ee82020-09-22 18:26:04 +0200357BUILTIN_STL_SUPPORT = YES
Martin Turon51a2ec72020-05-12 14:57:53 -0700358
359# If you use Microsoft's C++/CLI language, you should set this option to YES to
360# enable parsing support.
361# The default value is: NO.
362
363CPP_CLI_SUPPORT = NO
364
365# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
Martin Turon1c325c42020-06-29 09:06:55 -0700366# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
Martin Turon51a2ec72020-05-12 14:57:53 -0700367# will parse them like normal C++ but will assume all classes use public instead
368# of private inheritance when no explicit protection keyword is present.
369# The default value is: NO.
370
371SIP_SUPPORT = NO
372
373# For Microsoft's IDL there are propget and propput attributes to indicate
374# getter and setter methods for a property. Setting this option to YES will make
375# doxygen to replace the get and set methods by a property in the documentation.
376# This will only work if the methods are indeed getting or setting a simple
377# type. If this is not the case, or you want to show the methods anyway, you
378# should set this option to NO.
379# The default value is: YES.
380
381IDL_PROPERTY_SUPPORT = YES
382
383# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
Martin Turon1c325c42020-06-29 09:06:55 -0700384# tag is set to YES then doxygen will reuse the documentation of the first
Martin Turon51a2ec72020-05-12 14:57:53 -0700385# member in the group (if any) for the other members of the group. By default
386# all members of a group must be documented explicitly.
387# The default value is: NO.
388
389DISTRIBUTE_GROUP_DOC = NO
390
Martin Turon1c325c42020-06-29 09:06:55 -0700391# If one adds a struct or class to a group and this option is enabled, then also
392# any nested class or struct is added to the same group. By default this option
393# is disabled and one has to add nested compounds explicitly via \ingroup.
394# The default value is: NO.
395
396GROUP_NESTED_COMPOUNDS = NO
397
Martin Turon51a2ec72020-05-12 14:57:53 -0700398# Set the SUBGROUPING tag to YES to allow class member groups of the same type
399# (for instance a group of public functions) to be put as a subgroup of that
400# type (e.g. under the Public Functions section). Set it to NO to prevent
401# subgrouping. Alternatively, this can be done per class using the
402# \nosubgrouping command.
403# The default value is: YES.
404
405SUBGROUPING = YES
406
407# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
408# are shown inside the group in which they are included (e.g. using \ingroup)
409# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
410# and RTF).
411#
412# Note that this feature does not work in combination with
413# SEPARATE_MEMBER_PAGES.
414# The default value is: NO.
415
416INLINE_GROUPED_CLASSES = NO
417
418# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
419# with only public data fields or simple typedef fields will be shown inline in
420# the documentation of the scope in which they are defined (i.e. file,
421# namespace, or group documentation), provided this scope is documented. If set
422# to NO, structs, classes, and unions are shown on a separate page (for HTML and
423# Man pages) or section (for LaTeX and RTF).
424# The default value is: NO.
425
426INLINE_SIMPLE_STRUCTS = NO
427
428# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
429# enum is documented as struct, union, or enum with the name of the typedef. So
430# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
431# with name TypeT. When disabled the typedef will appear as a member of a file,
432# namespace, or class. And the struct will be named TypeS. This can typically be
433# useful for C code in case the coding convention dictates that all compound
434# types are typedef'ed and only the typedef is referenced, never the tag name.
435# The default value is: NO.
436
437TYPEDEF_HIDES_STRUCT = NO
438
439# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
440# cache is used to resolve symbols given their name and scope. Since this can be
441# an expensive process and often the same symbol appears multiple times in the
442# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
443# doxygen will become slower. If the cache is too large, memory is wasted. The
444# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
445# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
446# symbols. At the end of a run doxygen will report the cache usage and suggest
447# the optimal cache size from a speed point of view.
448# Minimum value: 0, maximum value: 9, default value: 0.
449
450LOOKUP_CACHE_SIZE = 0
451
452#---------------------------------------------------------------------------
453# Build related configuration options
454#---------------------------------------------------------------------------
455
Martin Turon1c325c42020-06-29 09:06:55 -0700456# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
Martin Turon51a2ec72020-05-12 14:57:53 -0700457# documentation are documented, even if no documentation was available. Private
458# class members and static file members will be hidden unless the
459# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
460# Note: This will also disable the warnings about undocumented members that are
461# normally produced when WARNINGS is set to YES.
462# The default value is: NO.
463
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200464EXTRACT_ALL = YES
Martin Turon51a2ec72020-05-12 14:57:53 -0700465
Martin Turon1c325c42020-06-29 09:06:55 -0700466# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
Martin Turon51a2ec72020-05-12 14:57:53 -0700467# be included in the documentation.
468# The default value is: NO.
469
470EXTRACT_PRIVATE = NO
471
Martin Turon1c325c42020-06-29 09:06:55 -0700472# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
473# methods of a class will be included in the documentation.
474# The default value is: NO.
475
476EXTRACT_PRIV_VIRTUAL = NO
477
478# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
Martin Turon51a2ec72020-05-12 14:57:53 -0700479# scope will be included in the documentation.
480# The default value is: NO.
481
482EXTRACT_PACKAGE = NO
483
Martin Turon1c325c42020-06-29 09:06:55 -0700484# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
Martin Turon51a2ec72020-05-12 14:57:53 -0700485# included in the documentation.
486# The default value is: NO.
487
Vivien Nicolas9393ee82020-09-22 18:26:04 +0200488EXTRACT_STATIC = YES
Martin Turon51a2ec72020-05-12 14:57:53 -0700489
Martin Turon1c325c42020-06-29 09:06:55 -0700490# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
491# locally in source files will be included in the documentation. If set to NO,
Martin Turon51a2ec72020-05-12 14:57:53 -0700492# only classes defined in header files are included. Does not have any effect
493# for Java sources.
494# The default value is: YES.
495
496EXTRACT_LOCAL_CLASSES = YES
497
Martin Turon1c325c42020-06-29 09:06:55 -0700498# This flag is only useful for Objective-C code. If set to YES, local methods,
Martin Turon51a2ec72020-05-12 14:57:53 -0700499# which are defined in the implementation section but not in the interface are
Martin Turon1c325c42020-06-29 09:06:55 -0700500# included in the documentation. If set to NO, only methods in the interface are
Martin Turon51a2ec72020-05-12 14:57:53 -0700501# included.
502# The default value is: NO.
503
504EXTRACT_LOCAL_METHODS = NO
505
506# If this flag is set to YES, the members of anonymous namespaces will be
507# extracted and appear in the documentation as a namespace called
508# 'anonymous_namespace{file}', where file will be replaced with the base name of
509# the file that contains the anonymous namespace. By default anonymous namespace
510# are hidden.
511# The default value is: NO.
512
513EXTRACT_ANON_NSPACES = NO
514
515# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
516# undocumented members inside documented classes or files. If set to NO these
517# members will be included in the various overviews, but no documentation
518# section is generated. This option has no effect if EXTRACT_ALL is enabled.
519# The default value is: NO.
520
521HIDE_UNDOC_MEMBERS = NO
522
523# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
524# undocumented classes that are normally visible in the class hierarchy. If set
Martin Turon1c325c42020-06-29 09:06:55 -0700525# to NO, these classes will be included in the various overviews. This option
526# has no effect if EXTRACT_ALL is enabled.
Martin Turon51a2ec72020-05-12 14:57:53 -0700527# The default value is: NO.
528
529HIDE_UNDOC_CLASSES = NO
530
531# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200532# declarations. If set to NO, these declarations will be included in the
533# documentation.
Martin Turon51a2ec72020-05-12 14:57:53 -0700534# The default value is: NO.
535
536HIDE_FRIEND_COMPOUNDS = NO
537
538# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
Martin Turon1c325c42020-06-29 09:06:55 -0700539# documentation blocks found inside the body of a function. If set to NO, these
Martin Turon51a2ec72020-05-12 14:57:53 -0700540# blocks will be appended to the function's detailed documentation block.
541# The default value is: NO.
542
543HIDE_IN_BODY_DOCS = NO
544
545# The INTERNAL_DOCS tag determines if documentation that is typed after a
546# \internal command is included. If the tag is set to NO then the documentation
547# will be excluded. Set it to YES to include the internal documentation.
548# The default value is: NO.
549
550INTERNAL_DOCS = NO
551
552# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
Martin Turon1c325c42020-06-29 09:06:55 -0700553# names in lower-case letters. If set to YES, upper-case letters are also
Martin Turon51a2ec72020-05-12 14:57:53 -0700554# allowed. This is useful if you have classes or files whose names only differ
555# in case and if your file system supports case sensitive file names. Windows
Martin Turon1c325c42020-06-29 09:06:55 -0700556# (including Cygwin) ands Mac users are advised to set this option to NO.
Martin Turon51a2ec72020-05-12 14:57:53 -0700557# The default value is: system dependent.
558
559CASE_SENSE_NAMES = NO
560
561# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
Martin Turon1c325c42020-06-29 09:06:55 -0700562# their full class and namespace scopes in the documentation. If set to YES, the
Martin Turon51a2ec72020-05-12 14:57:53 -0700563# scope will be hidden.
564# The default value is: NO.
565
566HIDE_SCOPE_NAMES = NO
567
Martin Turon1c325c42020-06-29 09:06:55 -0700568# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
569# append additional text to a page's title, such as Class Reference. If set to
570# YES the compound reference will be hidden.
571# The default value is: NO.
572
573HIDE_COMPOUND_REFERENCE= NO
574
Martin Turon51a2ec72020-05-12 14:57:53 -0700575# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
576# the files that are included by a file in the documentation of that file.
577# The default value is: YES.
578
579SHOW_INCLUDE_FILES = YES
580
581# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
582# grouped member an include statement to the documentation, telling the reader
583# which file to include in order to use the member.
584# The default value is: NO.
585
586SHOW_GROUPED_MEMB_INC = NO
587
588# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
589# files with double quotes in the documentation rather than with sharp brackets.
590# The default value is: NO.
591
592FORCE_LOCAL_INCLUDES = NO
593
594# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
595# documentation for inline members.
596# The default value is: YES.
597
598INLINE_INFO = YES
599
600# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
601# (detailed) documentation of file and class members alphabetically by member
Martin Turon1c325c42020-06-29 09:06:55 -0700602# name. If set to NO, the members will appear in declaration order.
Martin Turon51a2ec72020-05-12 14:57:53 -0700603# The default value is: YES.
604
605SORT_MEMBER_DOCS = YES
606
607# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
608# descriptions of file, namespace and class members alphabetically by member
Martin Turon1c325c42020-06-29 09:06:55 -0700609# name. If set to NO, the members will appear in declaration order. Note that
Martin Turon51a2ec72020-05-12 14:57:53 -0700610# this will also influence the order of the classes in the class list.
611# The default value is: NO.
612
613SORT_BRIEF_DOCS = NO
614
615# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
616# (brief and detailed) documentation of class members so that constructors and
617# destructors are listed first. If set to NO the constructors will appear in the
618# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
619# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
620# member documentation.
621# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
622# detailed member documentation.
623# The default value is: NO.
624
625SORT_MEMBERS_CTORS_1ST = NO
626
627# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
628# of group names into alphabetical order. If set to NO the group names will
629# appear in their defined order.
630# The default value is: NO.
631
632SORT_GROUP_NAMES = NO
633
634# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
635# fully-qualified names, including namespaces. If set to NO, the class list will
636# be sorted only by class name, not including the namespace part.
637# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
638# Note: This option applies only to the class list, not to the alphabetical
639# list.
640# The default value is: NO.
641
642SORT_BY_SCOPE_NAME = NO
643
644# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
645# type resolution of all parameters of a function it will reject a match between
646# the prototype and the implementation of a member function even if there is
647# only one candidate or it is obvious which candidate to choose by doing a
648# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
649# accept a match between prototype and implementation in such cases.
650# The default value is: NO.
651
652STRICT_PROTO_MATCHING = NO
653
Martin Turon1c325c42020-06-29 09:06:55 -0700654# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
655# list. This list is created by putting \todo commands in the documentation.
Martin Turon51a2ec72020-05-12 14:57:53 -0700656# The default value is: YES.
657
658GENERATE_TODOLIST = YES
659
Martin Turon1c325c42020-06-29 09:06:55 -0700660# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
661# list. This list is created by putting \test commands in the documentation.
Martin Turon51a2ec72020-05-12 14:57:53 -0700662# The default value is: YES.
663
664GENERATE_TESTLIST = YES
665
Martin Turon1c325c42020-06-29 09:06:55 -0700666# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
Martin Turon51a2ec72020-05-12 14:57:53 -0700667# list. This list is created by putting \bug commands in the documentation.
668# The default value is: YES.
669
670GENERATE_BUGLIST = YES
671
Martin Turon1c325c42020-06-29 09:06:55 -0700672# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
Martin Turon51a2ec72020-05-12 14:57:53 -0700673# the deprecated list. This list is created by putting \deprecated commands in
674# the documentation.
675# The default value is: YES.
676
677GENERATE_DEPRECATEDLIST= YES
678
679# The ENABLED_SECTIONS tag can be used to enable conditional documentation
680# sections, marked by \if <section_label> ... \endif and \cond <section_label>
681# ... \endcond blocks.
682
683ENABLED_SECTIONS =
684
685# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
686# initial value of a variable or macro / define can have for it to appear in the
687# documentation. If the initializer consists of more lines than specified here
688# it will be hidden. Use a value of 0 to hide initializers completely. The
689# appearance of the value of individual variables and macros / defines can be
690# controlled using \showinitializer or \hideinitializer command in the
691# documentation regardless of this setting.
692# Minimum value: 0, maximum value: 10000, default value: 30.
693
694MAX_INITIALIZER_LINES = 30
695
696# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
Martin Turon1c325c42020-06-29 09:06:55 -0700697# the bottom of the documentation of classes and structs. If set to YES, the
698# list will mention the files that were used to generate the documentation.
Martin Turon51a2ec72020-05-12 14:57:53 -0700699# The default value is: YES.
700
701SHOW_USED_FILES = YES
702
703# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
704# will remove the Files entry from the Quick Index and from the Folder Tree View
705# (if specified).
706# The default value is: YES.
707
708SHOW_FILES = YES
709
710# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
711# page. This will remove the Namespaces entry from the Quick Index and from the
712# Folder Tree View (if specified).
713# The default value is: YES.
714
715SHOW_NAMESPACES = YES
716
717# The FILE_VERSION_FILTER tag can be used to specify a program or script that
718# doxygen should invoke to get the current version for each file (typically from
719# the version control system). Doxygen will invoke the program by executing (via
720# popen()) the command command input-file, where command is the value of the
721# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
722# by doxygen. Whatever the program writes to standard output is used as the file
723# version. For an example see the documentation.
724
725FILE_VERSION_FILTER =
726
727# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
728# by doxygen. The layout file controls the global structure of the generated
729# output files in an output format independent way. To create the layout file
730# that represents doxygen's defaults, run doxygen with the -l option. You can
731# optionally specify a file name after the option, if omitted DoxygenLayout.xml
732# will be used as the name of the layout file.
733#
734# Note that if you run doxygen from a directory containing a file called
735# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
736# tag is left empty.
737
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200738LAYOUT_FILE = docs/ChipDoxygenLayout.xml
Martin Turon51a2ec72020-05-12 14:57:53 -0700739
740# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
741# the reference definitions. This must be a list of .bib files. The .bib
742# extension is automatically appended if omitted. This requires the bibtex tool
Martin Turon1c325c42020-06-29 09:06:55 -0700743# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
Martin Turon51a2ec72020-05-12 14:57:53 -0700744# For LaTeX the style of the bibliography can be controlled using
745# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
Martin Turon1c325c42020-06-29 09:06:55 -0700746# search path. See also \cite for info how to create references.
Martin Turon51a2ec72020-05-12 14:57:53 -0700747
748CITE_BIB_FILES =
749
750#---------------------------------------------------------------------------
751# Configuration options related to warning and progress messages
752#---------------------------------------------------------------------------
753
754# The QUIET tag can be used to turn on/off the messages that are generated to
755# standard output by doxygen. If QUIET is set to YES this implies that the
756# messages are off.
757# The default value is: NO.
758
759QUIET = NO
760
761# The WARNINGS tag can be used to turn on/off the warning messages that are
Martin Turon1c325c42020-06-29 09:06:55 -0700762# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
Martin Turon51a2ec72020-05-12 14:57:53 -0700763# this implies that the warnings are on.
764#
765# Tip: Turn warnings on while writing the documentation.
766# The default value is: YES.
767
768WARNINGS = YES
769
Martin Turon1c325c42020-06-29 09:06:55 -0700770# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
Martin Turon51a2ec72020-05-12 14:57:53 -0700771# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
772# will automatically be disabled.
773# The default value is: YES.
774
775WARN_IF_UNDOCUMENTED = NO
776
777# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
778# potential errors in the documentation, such as not documenting some parameters
779# in a documented function, or documenting parameters that don't exist or using
780# markup commands wrongly.
781# The default value is: YES.
782
783WARN_IF_DOC_ERROR = YES
784
785# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
786# are documented, but have no documentation for their parameters or return
Martin Turon1c325c42020-06-29 09:06:55 -0700787# value. If set to NO, doxygen will only warn about wrong or incomplete
788# parameter documentation, but not about the absence of documentation. If
789# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
Martin Turon51a2ec72020-05-12 14:57:53 -0700790# The default value is: NO.
791
792WARN_NO_PARAMDOC = NO
793
Martin Turon1c325c42020-06-29 09:06:55 -0700794# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
795# a warning is encountered.
796# The default value is: NO.
797
achsoftathome0b437632022-08-30 23:03:53 +0200798WARN_AS_ERROR = NO
Martin Turon1c325c42020-06-29 09:06:55 -0700799
Martin Turon51a2ec72020-05-12 14:57:53 -0700800# The WARN_FORMAT tag determines the format of the warning messages that doxygen
801# can produce. The string should contain the $file, $line, and $text tags, which
802# will be replaced by the file and line number from which the warning originated
803# and the warning text. Optionally the format may contain $version, which will
804# be replaced by the version of the file (if it could be obtained via
805# FILE_VERSION_FILTER)
806# The default value is: $file:$line: $text.
807
808WARN_FORMAT = "$file:$line: $text"
809
810# The WARN_LOGFILE tag can be used to specify a file to which warning and error
811# messages should be written. If left blank the output is written to standard
812# error (stderr).
813
814WARN_LOGFILE =
815
816#---------------------------------------------------------------------------
817# Configuration options related to the input files
818#---------------------------------------------------------------------------
819
820# The INPUT tag is used to specify the files and/or directories that contain
821# documented source files. You may enter file names like myfile.cpp or
822# directories like /usr/src/myproject. Separate the files or directories with
Martin Turon1c325c42020-06-29 09:06:55 -0700823# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
Martin Turon51a2ec72020-05-12 14:57:53 -0700824# Note: If this tag is empty the current directory is searched.
825
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200826INPUT = README.md \
Vivien Nicolas9393ee82020-09-22 18:26:04 +0200827 CODE_OF_CONDUCT.md \
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200828 CONTRIBUTING.md \
829 docs/README.md \
Grzegorz Ferenc8a4f2f12021-08-16 15:53:49 +0200830 docs/guides/BUILDING.md \
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200831 docs/VSCODE_DEVELOPMENT.md \
832 docs/PROJECT_FLOW.md \
Gaute Svanes Lundee7347ea2023-01-09 19:43:07 +0100833 docs/style/style_guide.md \
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200834 src/ble \
835 src/controller \
836 src/crypto \
837 src/include \
838 src/inet \
Kamil Kasperczykd9e02a02021-10-12 09:19:23 +0200839 src/lib/dnssd \
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200840 src/lib/core \
841 src/lib/support \
842 src/lib/shell \
843 src/platform \
844 src/setup_payload \
845 src/system \
Song Guo2090fbe2020-12-11 00:26:35 +0800846 src/transport \
847 src/test_driver/linux-cirque/README.md
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200848
849USE_MDFILE_AS_MAINPAGE = README.md
Martin Turon51a2ec72020-05-12 14:57:53 -0700850
851# This tag can be used to specify the character encoding of the source files
852# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
853# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
Martin Turon1c325c42020-06-29 09:06:55 -0700854# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
Martin Turon51a2ec72020-05-12 14:57:53 -0700855# possible encodings.
856# The default value is: UTF-8.
857
858INPUT_ENCODING = UTF-8
859
860# If the value of the INPUT tag contains directories, you can use the
861# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
Martin Turon1c325c42020-06-29 09:06:55 -0700862# *.h) to filter out the source-files in the directories.
863#
864# Note that for custom extensions or not directly supported extensions you also
865# need to set EXTENSION_MAPPING for the extension otherwise the files are not
866# read by doxygen.
867#
868# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
869# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
870# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200871# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
872# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
873# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
874# *.vhdl, *.ucf, *.qsf and *.ice.
Martin Turon51a2ec72020-05-12 14:57:53 -0700875
876FILE_PATTERNS = *.c \
877 *.cc \
878 *.cxx \
879 *.cpp \
880 *.c++ \
881 *.d \
882 *.java \
883 *.ii \
884 *.ixx \
885 *.ipp \
886 *.i++ \
887 *.inl \
888 *.h \
889 *.hh \
890 *.hxx \
891 *.hpp \
892 *.h++ \
893 *.idl \
894 *.odl \
895 *.cs \
896 *.php \
897 *.php3 \
898 *.inc \
899 *.m \
900 *.mm \
901 *.dox \
902 *.py \
903 *.f90 \
904 *.f \
905 *.for \
906 *.vhd \
907 *.vhdl
908
909# The RECURSIVE tag can be used to specify whether or not subdirectories should
910# be searched for input files as well.
911# The default value is: NO.
912
913RECURSIVE = YES
914
915# The EXCLUDE tag can be used to specify files and/or directories that should be
916# excluded from the INPUT source files. This way you can easily exclude a
917# subdirectory from a directory tree whose root is specified with the INPUT tag.
918#
919# Note that relative paths are relative to the directory from which doxygen is
920# run.
921
achsoftathome0b437632022-08-30 23:03:53 +0200922EXCLUDE = third_party
Martin Turon51a2ec72020-05-12 14:57:53 -0700923
924# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
925# directories that are symbolic links (a Unix file system feature) are excluded
926# from the input.
927# The default value is: NO.
928
achsoftathome0b437632022-08-30 23:03:53 +0200929EXCLUDE_SYMLINKS = YES
Martin Turon51a2ec72020-05-12 14:57:53 -0700930
931# If the value of the INPUT tag contains directories, you can use the
932# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
933# certain files from those directories.
934#
935# Note that the wildcards are matched against the file with absolute path, so to
936# exclude all test directories for example use the pattern */test/*
937
Vivien Nicolas9393ee82020-09-22 18:26:04 +0200938EXCLUDE_PATTERNS = NetworkProvisioningServer* \
939 */tests/* \
Damian Królikdada1be2021-04-12 22:56:05 +0200940 */dbus/* \
Andrei Litvin0fcf1732021-08-20 17:50:27 -0400941 */gen/* \
942 */zap-generated/*
Martin Turon51a2ec72020-05-12 14:57:53 -0700943
944# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
945# (namespaces, classes, functions, etc.) that should be excluded from the
946# output. The symbol name can be a fully qualified name, a word, or if the
947# wildcard * is used, a substring. Examples: ANamespace, AClass,
948# AClass::ANamespace, ANamespace::*Test
949#
950# Note that the wildcards are matched against the file with absolute path, so to
951# exclude all test directories use the pattern */test/*
952
Vivien Nicolasfbbf1272020-10-02 20:08:13 +0200953EXCLUDE_SYMBOLS = VerifyOrExit \
954 SuccessOrExit \
955 ExitNow \
956 */dbus/*
Martin Turon51a2ec72020-05-12 14:57:53 -0700957
958# The EXAMPLE_PATH tag can be used to specify one or more files or directories
959# that contain example code fragments that are included (see the \include
960# command).
961
962EXAMPLE_PATH =
963
964# If the value of the EXAMPLE_PATH tag contains directories, you can use the
965# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
966# *.h) to filter out the source-files in the directories. If left blank all
967# files are included.
968
969EXAMPLE_PATTERNS = *
970
971# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
972# searched for input files to be used with the \include or \dontinclude commands
973# irrespective of the value of the RECURSIVE tag.
974# The default value is: NO.
975
976EXAMPLE_RECURSIVE = NO
977
978# The IMAGE_PATH tag can be used to specify one or more files or directories
979# that contain images that are to be included in the documentation (see the
980# \image command).
981
Vivien Nicolas9754e3d2020-09-18 19:53:58 +0200982IMAGE_PATH = docs/images
Martin Turon51a2ec72020-05-12 14:57:53 -0700983
984# The INPUT_FILTER tag can be used to specify a program that doxygen should
985# invoke to filter for each input file. Doxygen will invoke the filter program
986# by executing (via popen()) the command:
987#
988# <filter> <input-file>
989#
990# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
991# name of an input file. Doxygen will then use the output that the filter
992# program writes to standard output. If FILTER_PATTERNS is specified, this tag
993# will be ignored.
994#
995# Note that the filter must not add or remove lines; it is applied before the
996# code is scanned, but not when the output code is generated. If lines are added
997# or removed, the anchors will not be placed correctly.
Martin Turon1c325c42020-06-29 09:06:55 -0700998#
999# Note that for custom extensions or not directly supported extensions you also
1000# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1001# properly processed by doxygen.
Martin Turon51a2ec72020-05-12 14:57:53 -07001002
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02001003INPUT_FILTER =
Martin Turon51a2ec72020-05-12 14:57:53 -07001004
1005# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1006# basis. Doxygen will compare the file name with each pattern and apply the
1007# filter if there is a match. The filters are a list of the form: pattern=filter
1008# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1009# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1010# patterns match the file name, INPUT_FILTER is applied.
Martin Turon1c325c42020-06-29 09:06:55 -07001011#
1012# Note that for custom extensions or not directly supported extensions you also
1013# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1014# properly processed by doxygen.
Martin Turon51a2ec72020-05-12 14:57:53 -07001015
1016FILTER_PATTERNS =
1017
1018# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Martin Turon1c325c42020-06-29 09:06:55 -07001019# INPUT_FILTER) will also be used to filter the input files that are used for
Martin Turon51a2ec72020-05-12 14:57:53 -07001020# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1021# The default value is: NO.
1022
1023FILTER_SOURCE_FILES = NO
1024
1025# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1026# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1027# it is also possible to disable source filtering for a specific pattern using
1028# *.ext= (so without naming a filter).
1029# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1030
1031FILTER_SOURCE_PATTERNS =
1032
1033# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1034# is part of the input, its contents will be placed on the main page
1035# (index.html). This can be useful if you have a project on for instance GitHub
1036# and want to reuse the introduction page also for the doxygen output.
1037
1038USE_MDFILE_AS_MAINPAGE =
1039
1040#---------------------------------------------------------------------------
1041# Configuration options related to source browsing
1042#---------------------------------------------------------------------------
1043
1044# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1045# generated. Documented entities will be cross-referenced with these sources.
1046#
1047# Note: To get rid of all source code in the generated output, make sure that
1048# also VERBATIM_HEADERS is set to NO.
1049# The default value is: NO.
1050
1051SOURCE_BROWSER = NO
1052
1053# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1054# classes and enums directly into the documentation.
1055# The default value is: NO.
1056
1057INLINE_SOURCES = NO
1058
1059# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1060# special comment blocks from generated source code fragments. Normal C, C++ and
1061# Fortran comments will always remain visible.
1062# The default value is: YES.
1063
1064STRIP_CODE_COMMENTS = YES
1065
1066# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
Martin Turon1c325c42020-06-29 09:06:55 -07001067# entity all documented functions referencing it will be listed.
Martin Turon51a2ec72020-05-12 14:57:53 -07001068# The default value is: NO.
1069
1070REFERENCED_BY_RELATION = NO
1071
1072# If the REFERENCES_RELATION tag is set to YES then for each documented function
1073# all documented entities called/used by that function will be listed.
1074# The default value is: NO.
1075
1076REFERENCES_RELATION = NO
1077
1078# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
Martin Turon1c325c42020-06-29 09:06:55 -07001079# to YES then the hyperlinks from functions in REFERENCES_RELATION and
Martin Turon51a2ec72020-05-12 14:57:53 -07001080# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1081# link to the documentation.
1082# The default value is: YES.
1083
1084REFERENCES_LINK_SOURCE = YES
1085
1086# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1087# source code will show a tooltip with additional information such as prototype,
1088# brief description and links to the definition and documentation. Since this
1089# will make the HTML file larger and loading of large files a bit slower, you
1090# can opt to disable this feature.
1091# The default value is: YES.
1092# This tag requires that the tag SOURCE_BROWSER is set to YES.
1093
1094SOURCE_TOOLTIPS = YES
1095
1096# If the USE_HTAGS tag is set to YES then the references to source code will
1097# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1098# source browser. The htags tool is part of GNU's global source tagging system
Martin Turon1c325c42020-06-29 09:06:55 -07001099# (see https://www.gnu.org/software/global/global.html). You will need version
Martin Turon51a2ec72020-05-12 14:57:53 -07001100# 4.8.6 or higher.
1101#
1102# To use it do the following:
1103# - Install the latest version of global
Martin Turon1c325c42020-06-29 09:06:55 -07001104# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
Martin Turon51a2ec72020-05-12 14:57:53 -07001105# - Make sure the INPUT points to the root of the source tree
1106# - Run doxygen as normal
1107#
1108# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1109# tools must be available from the command line (i.e. in the search path).
1110#
1111# The result: instead of the source browser generated by doxygen, the links to
1112# source code will now point to the output of htags.
1113# The default value is: NO.
1114# This tag requires that the tag SOURCE_BROWSER is set to YES.
1115
1116USE_HTAGS = NO
1117
1118# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1119# verbatim copy of the header file for each class for which an include is
1120# specified. Set to NO to disable this.
1121# See also: Section \class.
1122# The default value is: YES.
1123
1124VERBATIM_HEADERS = YES
1125
1126#---------------------------------------------------------------------------
1127# Configuration options related to the alphabetical class index
1128#---------------------------------------------------------------------------
1129
1130# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1131# compounds will be generated. Enable this if the project contains a lot of
1132# classes, structs, unions or interfaces.
1133# The default value is: YES.
1134
1135ALPHABETICAL_INDEX = YES
1136
1137# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1138# which the alphabetical index list will be split.
1139# Minimum value: 1, maximum value: 20, default value: 5.
1140# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1141
1142COLS_IN_ALPHA_INDEX = 5
1143
1144# In case all classes in a project start with a common prefix, all classes will
1145# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1146# can be used to specify a prefix (or a list of prefixes) that should be ignored
1147# while generating the index headers.
1148# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1149
1150IGNORE_PREFIX =
1151
1152#---------------------------------------------------------------------------
1153# Configuration options related to the HTML output
1154#---------------------------------------------------------------------------
1155
Martin Turon1c325c42020-06-29 09:06:55 -07001156# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
Martin Turon51a2ec72020-05-12 14:57:53 -07001157# The default value is: YES.
1158
1159GENERATE_HTML = YES
1160
1161# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1162# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1163# it.
1164# The default directory is: html.
1165# This tag requires that the tag GENERATE_HTML is set to YES.
1166
1167HTML_OUTPUT = html
1168
1169# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1170# generated HTML page (for example: .htm, .php, .asp).
1171# The default value is: .html.
1172# This tag requires that the tag GENERATE_HTML is set to YES.
1173
1174HTML_FILE_EXTENSION = .html
1175
1176# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1177# each generated HTML page. If the tag is left blank doxygen will generate a
1178# standard header.
1179#
1180# To get valid HTML the header file that includes any scripts and style sheets
1181# that doxygen needs, which is dependent on the configuration options used (e.g.
1182# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1183# default header using
1184# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1185# YourConfigFile
1186# and then modify the file new_header.html. See also section "Doxygen usage"
1187# for information on how to generate the default header that doxygen normally
1188# uses.
1189# Note: The header is subject to change so you typically have to regenerate the
1190# default header when upgrading to a newer version of doxygen. For a description
1191# of the possible markers and block names see the documentation.
1192# This tag requires that the tag GENERATE_HTML is set to YES.
1193
1194HTML_HEADER =
1195
1196# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1197# generated HTML page. If the tag is left blank doxygen will generate a standard
1198# footer. See HTML_HEADER for more information on how to generate a default
1199# footer and what special commands can be used inside the footer. See also
1200# section "Doxygen usage" for information on how to generate the default footer
1201# that doxygen normally uses.
1202# This tag requires that the tag GENERATE_HTML is set to YES.
1203
1204HTML_FOOTER =
1205
1206# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1207# sheet that is used by each HTML page. It can be used to fine-tune the look of
1208# the HTML output. If left blank doxygen will generate a default style sheet.
1209# See also section "Doxygen usage" for information on how to generate the style
1210# sheet that doxygen normally uses.
1211# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1212# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1213# obsolete.
1214# This tag requires that the tag GENERATE_HTML is set to YES.
1215
1216HTML_STYLESHEET =
1217
Martin Turon1c325c42020-06-29 09:06:55 -07001218# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1219# cascading style sheets that are included after the standard style sheets
Martin Turon51a2ec72020-05-12 14:57:53 -07001220# created by doxygen. Using this option one can overrule certain style aspects.
1221# This is preferred over using HTML_STYLESHEET since it does not replace the
Martin Turon1c325c42020-06-29 09:06:55 -07001222# standard style sheet and is therefore more robust against future updates.
1223# Doxygen will copy the style sheet files to the output directory.
1224# Note: The order of the extra style sheet files is of importance (e.g. the last
1225# style sheet in the list overrules the setting of the previous ones in the
1226# list). For an example see the documentation.
Martin Turon51a2ec72020-05-12 14:57:53 -07001227# This tag requires that the tag GENERATE_HTML is set to YES.
1228
1229HTML_EXTRA_STYLESHEET =
1230
1231# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1232# other source files which should be copied to the HTML output directory. Note
1233# that these files will be copied to the base HTML output directory. Use the
1234# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1235# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1236# files will be copied as-is; there are no commands or markers available.
1237# This tag requires that the tag GENERATE_HTML is set to YES.
1238
1239HTML_EXTRA_FILES =
1240
1241# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
Martin Turon1c325c42020-06-29 09:06:55 -07001242# will adjust the colors in the style sheet and background images according to
Martin Turon51a2ec72020-05-12 14:57:53 -07001243# this color. Hue is specified as an angle on a colorwheel, see
Martin Turon1c325c42020-06-29 09:06:55 -07001244# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
Martin Turon51a2ec72020-05-12 14:57:53 -07001245# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1246# purple, and 360 is red again.
1247# Minimum value: 0, maximum value: 359, default value: 220.
1248# This tag requires that the tag GENERATE_HTML is set to YES.
1249
1250HTML_COLORSTYLE_HUE = 220
1251
1252# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1253# in the HTML output. For a value of 0 the output will use grayscales only. A
1254# value of 255 will produce the most vivid colors.
1255# Minimum value: 0, maximum value: 255, default value: 100.
1256# This tag requires that the tag GENERATE_HTML is set to YES.
1257
1258HTML_COLORSTYLE_SAT = 100
1259
1260# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1261# luminance component of the colors in the HTML output. Values below 100
1262# gradually make the output lighter, whereas values above 100 make the output
1263# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1264# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1265# change the gamma.
1266# Minimum value: 40, maximum value: 240, default value: 80.
1267# This tag requires that the tag GENERATE_HTML is set to YES.
1268
1269HTML_COLORSTYLE_GAMMA = 80
1270
1271# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1272# page will contain the date and time when the page was generated. Setting this
Martin Turon1c325c42020-06-29 09:06:55 -07001273# to YES can help to show when doxygen was last run and thus if the
1274# documentation is up to date.
1275# The default value is: NO.
Martin Turon51a2ec72020-05-12 14:57:53 -07001276# This tag requires that the tag GENERATE_HTML is set to YES.
1277
1278HTML_TIMESTAMP = YES
1279
Martin Turon1c325c42020-06-29 09:06:55 -07001280# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1281# documentation will contain a main index with vertical navigation menus that
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02001282# are dynamically created via JavaScript. If disabled, the navigation index will
Martin Turon1c325c42020-06-29 09:06:55 -07001283# consists of multiple levels of tabs that are statically embedded in every HTML
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02001284# page. Disable this option to support browsers that do not have JavaScript,
Martin Turon1c325c42020-06-29 09:06:55 -07001285# like the Qt help browser.
1286# The default value is: YES.
1287# This tag requires that the tag GENERATE_HTML is set to YES.
1288
1289HTML_DYNAMIC_MENUS = YES
1290
Martin Turon51a2ec72020-05-12 14:57:53 -07001291# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1292# documentation will contain sections that can be hidden and shown after the
1293# page has loaded.
1294# The default value is: NO.
1295# This tag requires that the tag GENERATE_HTML is set to YES.
1296
1297HTML_DYNAMIC_SECTIONS = NO
1298
1299# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1300# shown in the various tree structured indices initially; the user can expand
1301# and collapse entries dynamically later on. Doxygen will expand the tree to
1302# such a level that at most the specified number of entries are visible (unless
1303# a fully collapsed tree already exceeds this amount). So setting the number of
1304# entries 1 will produce a full collapsed tree by default. 0 is a special value
1305# representing an infinite number of entries and will result in a full expanded
1306# tree by default.
1307# Minimum value: 0, maximum value: 9999, default value: 100.
1308# This tag requires that the tag GENERATE_HTML is set to YES.
1309
1310HTML_INDEX_NUM_ENTRIES = 100
1311
1312# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1313# generated that can be used as input for Apple's Xcode 3 integrated development
Martin Turon1c325c42020-06-29 09:06:55 -07001314# environment (see: https://developer.apple.com/xcode/), introduced with OSX
1315# 10.5 (Leopard). To create a documentation set, doxygen will generate a
Martin Turon51a2ec72020-05-12 14:57:53 -07001316# Makefile in the HTML output directory. Running make will produce the docset in
1317# that directory and running make install will install the docset in
1318# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
Martin Turon1c325c42020-06-29 09:06:55 -07001319# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1320# genXcode/_index.html for more information.
Martin Turon51a2ec72020-05-12 14:57:53 -07001321# The default value is: NO.
1322# This tag requires that the tag GENERATE_HTML is set to YES.
1323
1324GENERATE_DOCSET = NO
1325
1326# This tag determines the name of the docset feed. A documentation feed provides
1327# an umbrella under which multiple documentation sets from a single provider
1328# (such as a company or product suite) can be grouped.
1329# The default value is: Doxygen generated docs.
1330# This tag requires that the tag GENERATE_DOCSET is set to YES.
1331
1332DOCSET_FEEDNAME = "Doxygen generated docs"
1333
1334# This tag specifies a string that should uniquely identify the documentation
1335# set bundle. This should be a reverse domain-name style string, e.g.
1336# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1337# The default value is: org.doxygen.Project.
1338# This tag requires that the tag GENERATE_DOCSET is set to YES.
1339
1340DOCSET_BUNDLE_ID = org.doxygen.Project
1341
1342# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1343# the documentation publisher. This should be a reverse domain-name style
1344# string, e.g. com.mycompany.MyDocSet.documentation.
1345# The default value is: org.doxygen.Publisher.
1346# This tag requires that the tag GENERATE_DOCSET is set to YES.
1347
1348DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1349
1350# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1351# The default value is: Publisher.
1352# This tag requires that the tag GENERATE_DOCSET is set to YES.
1353
1354DOCSET_PUBLISHER_NAME = Publisher
1355
1356# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1357# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1358# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
Martin Turon1c325c42020-06-29 09:06:55 -07001359# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
Martin Turon51a2ec72020-05-12 14:57:53 -07001360# Windows.
1361#
1362# The HTML Help Workshop contains a compiler that can convert all HTML output
1363# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1364# files are now used as the Windows 98 help format, and will replace the old
1365# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1366# HTML files also contain an index, a table of contents, and you can search for
1367# words in the documentation. The HTML workshop also contains a viewer for
1368# compressed HTML files.
1369# The default value is: NO.
1370# This tag requires that the tag GENERATE_HTML is set to YES.
1371
1372GENERATE_HTMLHELP = NO
1373
1374# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1375# file. You can add a path in front of the file if the result should not be
1376# written to the html output directory.
1377# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1378
1379CHM_FILE =
1380
1381# The HHC_LOCATION tag can be used to specify the location (absolute path
Martin Turon1c325c42020-06-29 09:06:55 -07001382# including file name) of the HTML help compiler (hhc.exe). If non-empty,
Martin Turon51a2ec72020-05-12 14:57:53 -07001383# doxygen will try to run the HTML help compiler on the generated index.hhp.
1384# The file has to be specified with full path.
1385# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1386
1387HHC_LOCATION =
1388
Martin Turon1c325c42020-06-29 09:06:55 -07001389# The GENERATE_CHI flag controls if a separate .chi index file is generated
1390# (YES) or that it should be included in the master .chm file (NO).
Martin Turon51a2ec72020-05-12 14:57:53 -07001391# The default value is: NO.
1392# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1393
1394GENERATE_CHI = NO
1395
Martin Turon1c325c42020-06-29 09:06:55 -07001396# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
Martin Turon51a2ec72020-05-12 14:57:53 -07001397# and project file content.
1398# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1399
1400CHM_INDEX_ENCODING =
1401
Martin Turon1c325c42020-06-29 09:06:55 -07001402# The BINARY_TOC flag controls whether a binary table of contents is generated
1403# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1404# enables the Previous and Next buttons.
Martin Turon51a2ec72020-05-12 14:57:53 -07001405# The default value is: NO.
1406# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1407
1408BINARY_TOC = NO
1409
1410# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1411# the table of contents of the HTML help documentation and to the tree view.
1412# The default value is: NO.
1413# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1414
1415TOC_EXPAND = NO
1416
1417# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1418# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1419# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1420# (.qch) of the generated HTML documentation.
1421# The default value is: NO.
1422# This tag requires that the tag GENERATE_HTML is set to YES.
1423
1424GENERATE_QHP = NO
1425
1426# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1427# the file name of the resulting .qch file. The path specified is relative to
1428# the HTML output folder.
1429# This tag requires that the tag GENERATE_QHP is set to YES.
1430
1431QCH_FILE =
1432
1433# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1434# Project output. For more information please see Qt Help Project / Namespace
Martin Turon1c325c42020-06-29 09:06:55 -07001435# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
Martin Turon51a2ec72020-05-12 14:57:53 -07001436# The default value is: org.doxygen.Project.
1437# This tag requires that the tag GENERATE_QHP is set to YES.
1438
1439QHP_NAMESPACE = org.doxygen.Project
1440
1441# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1442# Help Project output. For more information please see Qt Help Project / Virtual
Martin Turon1c325c42020-06-29 09:06:55 -07001443# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
Martin Turon51a2ec72020-05-12 14:57:53 -07001444# folders).
1445# The default value is: doc.
1446# This tag requires that the tag GENERATE_QHP is set to YES.
1447
1448QHP_VIRTUAL_FOLDER = doc
1449
1450# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1451# filter to add. For more information please see Qt Help Project / Custom
Martin Turon1c325c42020-06-29 09:06:55 -07001452# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
Martin Turon51a2ec72020-05-12 14:57:53 -07001453# filters).
1454# This tag requires that the tag GENERATE_QHP is set to YES.
1455
1456QHP_CUST_FILTER_NAME =
1457
1458# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1459# custom filter to add. For more information please see Qt Help Project / Custom
Martin Turon1c325c42020-06-29 09:06:55 -07001460# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
Martin Turon51a2ec72020-05-12 14:57:53 -07001461# filters).
1462# This tag requires that the tag GENERATE_QHP is set to YES.
1463
1464QHP_CUST_FILTER_ATTRS =
1465
1466# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1467# project's filter section matches. Qt Help Project / Filter Attributes (see:
Martin Turon1c325c42020-06-29 09:06:55 -07001468# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
Martin Turon51a2ec72020-05-12 14:57:53 -07001469# This tag requires that the tag GENERATE_QHP is set to YES.
1470
1471QHP_SECT_FILTER_ATTRS =
1472
1473# The QHG_LOCATION tag can be used to specify the location of Qt's
1474# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1475# generated .qhp file.
1476# This tag requires that the tag GENERATE_QHP is set to YES.
1477
1478QHG_LOCATION =
1479
1480# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1481# generated, together with the HTML files, they form an Eclipse help plugin. To
1482# install this plugin and make it available under the help contents menu in
1483# Eclipse, the contents of the directory containing the HTML and XML files needs
1484# to be copied into the plugins directory of eclipse. The name of the directory
1485# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1486# After copying Eclipse needs to be restarted before the help appears.
1487# The default value is: NO.
1488# This tag requires that the tag GENERATE_HTML is set to YES.
1489
1490GENERATE_ECLIPSEHELP = NO
1491
1492# A unique identifier for the Eclipse help plugin. When installing the plugin
1493# the directory name containing the HTML and XML files should also have this
1494# name. Each documentation set should have its own identifier.
1495# The default value is: org.doxygen.Project.
1496# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1497
1498ECLIPSE_DOC_ID = org.doxygen.Project
1499
1500# If you want full control over the layout of the generated HTML pages it might
1501# be necessary to disable the index and replace it with your own. The
1502# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1503# of each HTML page. A value of NO enables the index and the value YES disables
1504# it. Since the tabs in the index contain the same information as the navigation
1505# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1506# The default value is: NO.
1507# This tag requires that the tag GENERATE_HTML is set to YES.
1508
1509DISABLE_INDEX = NO
1510
1511# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1512# structure should be generated to display hierarchical information. If the tag
1513# value is set to YES, a side panel will be generated containing a tree-like
1514# index structure (just like the one that is generated for HTML Help). For this
1515# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1516# (i.e. any modern browser). Windows users are probably better off using the
Martin Turon1c325c42020-06-29 09:06:55 -07001517# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
Martin Turon51a2ec72020-05-12 14:57:53 -07001518# further fine-tune the look of the index. As an example, the default style
1519# sheet generated by doxygen has an example that shows how to put an image at
1520# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1521# the same information as the tab index, you could consider setting
1522# DISABLE_INDEX to YES when enabling this option.
1523# The default value is: NO.
1524# This tag requires that the tag GENERATE_HTML is set to YES.
1525
1526GENERATE_TREEVIEW = YES
1527
1528# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1529# doxygen will group on one line in the generated HTML documentation.
1530#
1531# Note that a value of 0 will completely suppress the enum values from appearing
1532# in the overview section.
1533# Minimum value: 0, maximum value: 20, default value: 4.
1534# This tag requires that the tag GENERATE_HTML is set to YES.
1535
1536ENUM_VALUES_PER_LINE = 1
1537
1538# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1539# to set the initial width (in pixels) of the frame in which the tree is shown.
1540# Minimum value: 0, maximum value: 1500, default value: 250.
1541# This tag requires that the tag GENERATE_HTML is set to YES.
1542
1543TREEVIEW_WIDTH = 250
1544
Martin Turon1c325c42020-06-29 09:06:55 -07001545# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
Martin Turon51a2ec72020-05-12 14:57:53 -07001546# external symbols imported via tag files in a separate window.
1547# The default value is: NO.
1548# This tag requires that the tag GENERATE_HTML is set to YES.
1549
1550EXT_LINKS_IN_WINDOW = NO
1551
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02001552# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1553# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1554# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1555# the HTML output. These images will generally look nicer at scaled resolutions.
1556# Possible values are: png The default and svg Looks nicer but requires the
1557# pdf2svg tool.
1558# The default value is: png.
1559# This tag requires that the tag GENERATE_HTML is set to YES.
1560
1561HTML_FORMULA_FORMAT = png
1562
Martin Turon51a2ec72020-05-12 14:57:53 -07001563# Use this tag to change the font size of LaTeX formulas included as images in
1564# the HTML documentation. When you change the font size after a successful
1565# doxygen run you need to manually remove any form_*.png images from the HTML
1566# output directory to force them to be regenerated.
1567# Minimum value: 8, maximum value: 50, default value: 10.
1568# This tag requires that the tag GENERATE_HTML is set to YES.
1569
1570FORMULA_FONTSIZE = 10
1571
Martin Turon1c325c42020-06-29 09:06:55 -07001572# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
Martin Turon51a2ec72020-05-12 14:57:53 -07001573# generated for formulas are transparent PNGs. Transparent PNGs are not
1574# supported properly for IE 6.0, but are supported on all modern browsers.
1575#
1576# Note that when changing this option you need to delete any form_*.png files in
1577# the HTML output directory before the changes have effect.
1578# The default value is: YES.
1579# This tag requires that the tag GENERATE_HTML is set to YES.
1580
1581FORMULA_TRANSPARENT = YES
1582
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02001583# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1584# to create new LaTeX commands to be used in formulas as building blocks. See
1585# the section "Including formulas" for details.
1586
1587FORMULA_MACROFILE =
1588
Martin Turon51a2ec72020-05-12 14:57:53 -07001589# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02001590# https://www.mathjax.org) which uses client side JavaScript for the rendering
Martin Turon1c325c42020-06-29 09:06:55 -07001591# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
Martin Turon51a2ec72020-05-12 14:57:53 -07001592# installed or if you want to formulas look prettier in the HTML output. When
1593# enabled you may also need to install MathJax separately and configure the path
1594# to it using the MATHJAX_RELPATH option.
1595# The default value is: NO.
1596# This tag requires that the tag GENERATE_HTML is set to YES.
1597
1598USE_MATHJAX = NO
1599
1600# When MathJax is enabled you can set the default output format to be used for
1601# the MathJax output. See the MathJax site (see:
1602# http://docs.mathjax.org/en/latest/output.html) for more details.
1603# Possible values are: HTML-CSS (which is slower, but has the best
1604# compatibility), NativeMML (i.e. MathML) and SVG.
1605# The default value is: HTML-CSS.
1606# This tag requires that the tag USE_MATHJAX is set to YES.
1607
1608MATHJAX_FORMAT = HTML-CSS
1609
1610# When MathJax is enabled you need to specify the location relative to the HTML
1611# output directory using the MATHJAX_RELPATH option. The destination directory
1612# should contain the MathJax.js script. For instance, if the mathjax directory
1613# is located at the same level as the HTML output directory, then
1614# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1615# Content Delivery Network so you can quickly see the result without installing
1616# MathJax. However, it is strongly recommended to install a local copy of
Martin Turon1c325c42020-06-29 09:06:55 -07001617# MathJax from https://www.mathjax.org before deployment.
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02001618# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
Martin Turon51a2ec72020-05-12 14:57:53 -07001619# This tag requires that the tag USE_MATHJAX is set to YES.
1620
1621MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1622
1623# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1624# extension names that should be enabled during MathJax rendering. For example
1625# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1626# This tag requires that the tag USE_MATHJAX is set to YES.
1627
1628MATHJAX_EXTENSIONS =
1629
1630# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1631# of code that will be used on startup of the MathJax code. See the MathJax site
1632# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1633# example see the documentation.
1634# This tag requires that the tag USE_MATHJAX is set to YES.
1635
1636MATHJAX_CODEFILE =
1637
1638# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1639# the HTML output. The underlying search engine uses javascript and DHTML and
1640# should work on any modern browser. Note that when using HTML help
1641# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1642# there is already a search function so this one should typically be disabled.
1643# For large projects the javascript based search engine can be slow, then
1644# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1645# search using the keyboard; to jump to the search box use <access key> + S
1646# (what the <access key> is depends on the OS and browser, but it is typically
1647# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1648# key> to jump into the search results window, the results can be navigated
1649# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1650# the search. The filter options can be selected when the cursor is inside the
1651# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1652# to select a filter and <Enter> or <escape> to activate or cancel the filter
1653# option.
1654# The default value is: YES.
1655# This tag requires that the tag GENERATE_HTML is set to YES.
1656
1657SEARCHENGINE = YES
1658
1659# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02001660# implemented using a web server instead of a web client using JavaScript. There
Martin Turon1c325c42020-06-29 09:06:55 -07001661# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1662# setting. When disabled, doxygen will generate a PHP script for searching and
1663# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1664# and searching needs to be provided by external tools. See the section
1665# "External Indexing and Searching" for details.
Martin Turon51a2ec72020-05-12 14:57:53 -07001666# The default value is: NO.
1667# This tag requires that the tag SEARCHENGINE is set to YES.
1668
1669SERVER_BASED_SEARCH = NO
1670
1671# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1672# script for searching. Instead the search results are written to an XML file
1673# which needs to be processed by an external indexer. Doxygen will invoke an
1674# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1675# search results.
1676#
Martin Turon1c325c42020-06-29 09:06:55 -07001677# Doxygen ships with an example indexer (doxyindexer) and search engine
Martin Turon51a2ec72020-05-12 14:57:53 -07001678# (doxysearch.cgi) which are based on the open source search engine library
Martin Turon1c325c42020-06-29 09:06:55 -07001679# Xapian (see: https://xapian.org/).
Martin Turon51a2ec72020-05-12 14:57:53 -07001680#
1681# See the section "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
1685EXTERNAL_SEARCH = NO
1686
1687# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1688# which will return the search results when EXTERNAL_SEARCH is enabled.
1689#
Martin Turon1c325c42020-06-29 09:06:55 -07001690# Doxygen ships with an example indexer (doxyindexer) and search engine
Martin Turon51a2ec72020-05-12 14:57:53 -07001691# (doxysearch.cgi) which are based on the open source search engine library
Martin Turon1c325c42020-06-29 09:06:55 -07001692# Xapian (see: https://xapian.org/). See the section "External Indexing and
Martin Turon51a2ec72020-05-12 14:57:53 -07001693# Searching" for details.
1694# This tag requires that the tag SEARCHENGINE is set to YES.
1695
1696SEARCHENGINE_URL =
1697
1698# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1699# search data is written to a file for indexing by an external tool. With the
1700# SEARCHDATA_FILE tag the name of this file can be specified.
1701# The default file is: searchdata.xml.
1702# This tag requires that the tag SEARCHENGINE is set to YES.
1703
1704SEARCHDATA_FILE = searchdata.xml
1705
1706# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1707# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1708# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1709# projects and redirect the results back to the right project.
1710# This tag requires that the tag SEARCHENGINE is set to YES.
1711
1712EXTERNAL_SEARCH_ID =
1713
1714# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1715# projects other than the one defined by this configuration file, but that are
1716# all added to the same external search index. Each project needs to have a
1717# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1718# to a relative location where the documentation can be found. The format is:
1719# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1720# This tag requires that the tag SEARCHENGINE is set to YES.
1721
1722EXTRA_SEARCH_MAPPINGS =
1723
1724#---------------------------------------------------------------------------
1725# Configuration options related to the LaTeX output
1726#---------------------------------------------------------------------------
1727
Martin Turon1c325c42020-06-29 09:06:55 -07001728# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
Martin Turon51a2ec72020-05-12 14:57:53 -07001729# The default value is: YES.
1730
1731GENERATE_LATEX = NO
1732
1733# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1734# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1735# it.
1736# The default directory is: latex.
1737# This tag requires that the tag GENERATE_LATEX is set to YES.
1738
1739LATEX_OUTPUT = latex
1740
1741# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1742# invoked.
1743#
Martin Turon1c325c42020-06-29 09:06:55 -07001744# Note that when not enabling USE_PDFLATEX the default is latex when enabling
1745# USE_PDFLATEX the default is pdflatex and when in the later case latex is
1746# chosen this is overwritten by pdflatex. For specific output languages the
1747# default can have been set differently, this depends on the implementation of
1748# the output language.
Martin Turon51a2ec72020-05-12 14:57:53 -07001749# This tag requires that the tag GENERATE_LATEX is set to YES.
1750
1751LATEX_CMD_NAME = latex
1752
1753# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1754# index for LaTeX.
Martin Turon1c325c42020-06-29 09:06:55 -07001755# Note: This tag is used in the Makefile / make.bat.
1756# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1757# (.tex).
Martin Turon51a2ec72020-05-12 14:57:53 -07001758# The default file is: makeindex.
1759# This tag requires that the tag GENERATE_LATEX is set to YES.
1760
1761MAKEINDEX_CMD_NAME = makeindex
1762
Martin Turon1c325c42020-06-29 09:06:55 -07001763# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1764# generate index for LaTeX. In case there is no backslash (\) as first character
1765# it will be automatically added in the LaTeX code.
1766# Note: This tag is used in the generated output file (.tex).
1767# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1768# The default value is: makeindex.
1769# This tag requires that the tag GENERATE_LATEX is set to YES.
1770
1771LATEX_MAKEINDEX_CMD = makeindex
1772
1773# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
Martin Turon51a2ec72020-05-12 14:57:53 -07001774# documents. This may be useful for small projects and may help to save some
1775# trees in general.
1776# The default value is: NO.
1777# This tag requires that the tag GENERATE_LATEX is set to YES.
1778
1779COMPACT_LATEX = NO
1780
1781# The PAPER_TYPE tag can be used to set the paper type that is used by the
1782# printer.
1783# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1784# 14 inches) and executive (7.25 x 10.5 inches).
1785# The default value is: a4.
1786# This tag requires that the tag GENERATE_LATEX is set to YES.
1787
1788PAPER_TYPE = letter
1789
1790# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
Martin Turon1c325c42020-06-29 09:06:55 -07001791# that should be included in the LaTeX output. The package can be specified just
1792# by its name or with the correct syntax as to be used with the LaTeX
1793# \usepackage command. To get the times font for instance you can specify :
1794# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1795# To use the option intlimits with the amsmath package you can specify:
1796# EXTRA_PACKAGES=[intlimits]{amsmath}
Martin Turon51a2ec72020-05-12 14:57:53 -07001797# If left blank no extra packages will be included.
1798# This tag requires that the tag GENERATE_LATEX is set to YES.
1799
1800EXTRA_PACKAGES =
1801
1802# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1803# generated LaTeX document. The header should contain everything until the first
1804# chapter. If it is left blank doxygen will generate a standard header. See
1805# section "Doxygen usage" for information on how to let doxygen write the
1806# default header to a separate file.
1807#
1808# Note: Only use a user-defined header if you know what you are doing! The
1809# following commands have a special meaning inside the header: $title,
Martin Turon1c325c42020-06-29 09:06:55 -07001810# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1811# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1812# string, for the replacement values of the other commands the user is referred
1813# to HTML_HEADER.
Martin Turon51a2ec72020-05-12 14:57:53 -07001814# This tag requires that the tag GENERATE_LATEX is set to YES.
1815
1816LATEX_HEADER =
1817
1818# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1819# generated LaTeX document. The footer should contain everything after the last
Martin Turon1c325c42020-06-29 09:06:55 -07001820# chapter. If it is left blank doxygen will generate a standard footer. See
1821# LATEX_HEADER for more information on how to generate a default footer and what
1822# special commands can be used inside the footer.
Martin Turon51a2ec72020-05-12 14:57:53 -07001823#
1824# Note: Only use a user-defined footer if you know what you are doing!
1825# This tag requires that the tag GENERATE_LATEX is set to YES.
1826
1827LATEX_FOOTER =
1828
Martin Turon1c325c42020-06-29 09:06:55 -07001829# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1830# LaTeX style sheets that are included after the standard style sheets created
1831# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1832# will copy the style sheet files to the output directory.
1833# Note: The order of the extra style sheet files is of importance (e.g. the last
1834# style sheet in the list overrules the setting of the previous ones in the
1835# list).
1836# This tag requires that the tag GENERATE_LATEX is set to YES.
1837
1838LATEX_EXTRA_STYLESHEET =
1839
Martin Turon51a2ec72020-05-12 14:57:53 -07001840# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1841# other source files which should be copied to the LATEX_OUTPUT output
1842# directory. Note that the files will be copied as-is; there are no commands or
1843# markers available.
1844# This tag requires that the tag GENERATE_LATEX is set to YES.
1845
1846LATEX_EXTRA_FILES =
1847
1848# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1849# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1850# contain links (just like the HTML output) instead of page references. This
1851# makes the output suitable for online browsing using a PDF viewer.
1852# The default value is: YES.
1853# This tag requires that the tag GENERATE_LATEX is set to YES.
1854
1855PDF_HYPERLINKS = YES
1856
Martin Turon1c325c42020-06-29 09:06:55 -07001857# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1858# the PDF file directly from the LaTeX files. Set this option to YES, to get a
Martin Turon51a2ec72020-05-12 14:57:53 -07001859# higher quality PDF documentation.
1860# The default value is: YES.
1861# This tag requires that the tag GENERATE_LATEX is set to YES.
1862
1863USE_PDFLATEX = YES
1864
1865# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1866# command to the generated LaTeX files. This will instruct LaTeX to keep running
1867# if errors occur, instead of asking the user for help. This option is also used
1868# when generating formulas in HTML.
1869# The default value is: NO.
1870# This tag requires that the tag GENERATE_LATEX is set to YES.
1871
1872LATEX_BATCHMODE = NO
1873
1874# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1875# index chapters (such as File Index, Compound Index, etc.) in the output.
1876# The default value is: NO.
1877# This tag requires that the tag GENERATE_LATEX is set to YES.
1878
1879LATEX_HIDE_INDICES = NO
1880
1881# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1882# code with syntax highlighting in the LaTeX output.
1883#
1884# Note that which sources are shown also depends on other settings such as
1885# SOURCE_BROWSER.
1886# The default value is: NO.
1887# This tag requires that the tag GENERATE_LATEX is set to YES.
1888
1889LATEX_SOURCE_CODE = NO
1890
1891# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1892# bibliography, e.g. plainnat, or ieeetr. See
Martin Turon1c325c42020-06-29 09:06:55 -07001893# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
Martin Turon51a2ec72020-05-12 14:57:53 -07001894# The default value is: plain.
1895# This tag requires that the tag GENERATE_LATEX is set to YES.
1896
1897LATEX_BIB_STYLE = plain
1898
Martin Turon1c325c42020-06-29 09:06:55 -07001899# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1900# page will contain the date and time when the page was generated. Setting this
1901# to NO can help when comparing the output of multiple runs.
1902# The default value is: NO.
1903# This tag requires that the tag GENERATE_LATEX is set to YES.
1904
1905LATEX_TIMESTAMP = NO
1906
1907# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1908# path from which the emoji images will be read. If a relative path is entered,
1909# it will be relative to the LATEX_OUTPUT directory. If left blank the
1910# LATEX_OUTPUT directory will be used.
1911# This tag requires that the tag GENERATE_LATEX is set to YES.
1912
1913LATEX_EMOJI_DIRECTORY =
1914
Martin Turon51a2ec72020-05-12 14:57:53 -07001915#---------------------------------------------------------------------------
1916# Configuration options related to the RTF output
1917#---------------------------------------------------------------------------
1918
Martin Turon1c325c42020-06-29 09:06:55 -07001919# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
Martin Turon51a2ec72020-05-12 14:57:53 -07001920# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1921# readers/editors.
1922# The default value is: NO.
1923
1924GENERATE_RTF = NO
1925
1926# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1927# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1928# it.
1929# The default directory is: rtf.
1930# This tag requires that the tag GENERATE_RTF is set to YES.
1931
1932RTF_OUTPUT = rtf
1933
Martin Turon1c325c42020-06-29 09:06:55 -07001934# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
Martin Turon51a2ec72020-05-12 14:57:53 -07001935# documents. This may be useful for small projects and may help to save some
1936# trees in general.
1937# The default value is: NO.
1938# This tag requires that the tag GENERATE_RTF is set to YES.
1939
1940COMPACT_RTF = NO
1941
1942# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1943# contain hyperlink fields. The RTF file will contain links (just like the HTML
1944# output) instead of page references. This makes the output suitable for online
1945# browsing using Word or some other Word compatible readers that support those
1946# fields.
1947#
1948# Note: WordPad (write) and others do not support links.
1949# The default value is: NO.
1950# This tag requires that the tag GENERATE_RTF is set to YES.
1951
1952RTF_HYPERLINKS = NO
1953
Martin Turon1c325c42020-06-29 09:06:55 -07001954# Load stylesheet definitions from file. Syntax is similar to doxygen's
1955# configuration file, i.e. a series of assignments. You only have to provide
1956# replacements, missing definitions are set to their default value.
Martin Turon51a2ec72020-05-12 14:57:53 -07001957#
1958# See also section "Doxygen usage" for information on how to generate the
1959# default style sheet that doxygen normally uses.
1960# This tag requires that the tag GENERATE_RTF is set to YES.
1961
1962RTF_STYLESHEET_FILE =
1963
1964# Set optional variables used in the generation of an RTF document. Syntax is
Martin Turon1c325c42020-06-29 09:06:55 -07001965# similar to doxygen's configuration file. A template extensions file can be
1966# generated using doxygen -e rtf extensionFile.
Martin Turon51a2ec72020-05-12 14:57:53 -07001967# This tag requires that the tag GENERATE_RTF is set to YES.
1968
1969RTF_EXTENSIONS_FILE =
1970
Martin Turon1c325c42020-06-29 09:06:55 -07001971# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1972# with syntax highlighting in the RTF output.
1973#
1974# Note that which sources are shown also depends on other settings such as
1975# SOURCE_BROWSER.
1976# The default value is: NO.
1977# This tag requires that the tag GENERATE_RTF is set to YES.
1978
1979RTF_SOURCE_CODE = NO
1980
Martin Turon51a2ec72020-05-12 14:57:53 -07001981#---------------------------------------------------------------------------
1982# Configuration options related to the man page output
1983#---------------------------------------------------------------------------
1984
Martin Turon1c325c42020-06-29 09:06:55 -07001985# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
Martin Turon51a2ec72020-05-12 14:57:53 -07001986# classes and files.
1987# The default value is: NO.
1988
1989GENERATE_MAN = NO
1990
1991# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1992# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1993# it. A directory man3 will be created inside the directory specified by
1994# MAN_OUTPUT.
1995# The default directory is: man.
1996# This tag requires that the tag GENERATE_MAN is set to YES.
1997
1998MAN_OUTPUT = man
1999
2000# The MAN_EXTENSION tag determines the extension that is added to the generated
2001# man pages. In case the manual section does not start with a number, the number
2002# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2003# optional.
2004# The default value is: .3.
2005# This tag requires that the tag GENERATE_MAN is set to YES.
2006
2007MAN_EXTENSION = .3
2008
Martin Turon1c325c42020-06-29 09:06:55 -07002009# The MAN_SUBDIR tag determines the name of the directory created within
2010# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2011# MAN_EXTENSION with the initial . removed.
2012# This tag requires that the tag GENERATE_MAN is set to YES.
2013
2014MAN_SUBDIR =
2015
Martin Turon51a2ec72020-05-12 14:57:53 -07002016# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2017# will generate one additional man file for each entity documented in the real
2018# man page(s). These additional files only source the real man page, but without
2019# them the man command would be unable to find the correct page.
2020# The default value is: NO.
2021# This tag requires that the tag GENERATE_MAN is set to YES.
2022
2023MAN_LINKS = NO
2024
2025#---------------------------------------------------------------------------
2026# Configuration options related to the XML output
2027#---------------------------------------------------------------------------
2028
Martin Turon1c325c42020-06-29 09:06:55 -07002029# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
Martin Turon51a2ec72020-05-12 14:57:53 -07002030# captures the structure of the code including all documentation.
2031# The default value is: NO.
2032
2033GENERATE_XML = NO
2034
2035# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2036# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2037# it.
2038# The default directory is: xml.
2039# This tag requires that the tag GENERATE_XML is set to YES.
2040
2041XML_OUTPUT = xml
2042
Martin Turon1c325c42020-06-29 09:06:55 -07002043# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
Martin Turon51a2ec72020-05-12 14:57:53 -07002044# listings (including syntax highlighting and cross-referencing information) to
2045# the XML output. Note that enabling this will significantly increase the size
2046# of the XML output.
2047# The default value is: YES.
2048# This tag requires that the tag GENERATE_XML is set to YES.
2049
2050XML_PROGRAMLISTING = YES
2051
Martin Turon1c325c42020-06-29 09:06:55 -07002052# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2053# namespace members in file scope as well, matching the HTML output.
2054# The default value is: NO.
2055# This tag requires that the tag GENERATE_XML is set to YES.
2056
2057XML_NS_MEMB_FILE_SCOPE = NO
2058
Martin Turon51a2ec72020-05-12 14:57:53 -07002059#---------------------------------------------------------------------------
2060# Configuration options related to the DOCBOOK output
2061#---------------------------------------------------------------------------
2062
Martin Turon1c325c42020-06-29 09:06:55 -07002063# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
Martin Turon51a2ec72020-05-12 14:57:53 -07002064# that can be used to generate PDF.
2065# The default value is: NO.
2066
2067GENERATE_DOCBOOK = NO
2068
2069# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2070# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2071# front of it.
2072# The default directory is: docbook.
2073# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2074
2075DOCBOOK_OUTPUT = docbook
2076
Martin Turon1c325c42020-06-29 09:06:55 -07002077# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2078# program listings (including syntax highlighting and cross-referencing
2079# information) to the DOCBOOK output. Note that enabling this will significantly
2080# increase the size of the DOCBOOK output.
2081# The default value is: NO.
2082# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2083
2084DOCBOOK_PROGRAMLISTING = NO
2085
Martin Turon51a2ec72020-05-12 14:57:53 -07002086#---------------------------------------------------------------------------
2087# Configuration options for the AutoGen Definitions output
2088#---------------------------------------------------------------------------
2089
Martin Turon1c325c42020-06-29 09:06:55 -07002090# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2091# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2092# the structure of the code including all documentation. Note that this feature
2093# is still experimental and incomplete at the moment.
Martin Turon51a2ec72020-05-12 14:57:53 -07002094# The default value is: NO.
2095
2096GENERATE_AUTOGEN_DEF = NO
2097
2098#---------------------------------------------------------------------------
2099# Configuration options related to the Perl module output
2100#---------------------------------------------------------------------------
2101
Martin Turon1c325c42020-06-29 09:06:55 -07002102# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
Martin Turon51a2ec72020-05-12 14:57:53 -07002103# file that captures the structure of the code including all documentation.
2104#
2105# Note that this feature is still experimental and incomplete at the moment.
2106# The default value is: NO.
2107
2108GENERATE_PERLMOD = NO
2109
Martin Turon1c325c42020-06-29 09:06:55 -07002110# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
Martin Turon51a2ec72020-05-12 14:57:53 -07002111# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2112# output from the Perl module output.
2113# The default value is: NO.
2114# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2115
2116PERLMOD_LATEX = NO
2117
Martin Turon1c325c42020-06-29 09:06:55 -07002118# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
Martin Turon51a2ec72020-05-12 14:57:53 -07002119# formatted so it can be parsed by a human reader. This is useful if you want to
Martin Turon1c325c42020-06-29 09:06:55 -07002120# understand what is going on. On the other hand, if this tag is set to NO, the
Martin Turon51a2ec72020-05-12 14:57:53 -07002121# size of the Perl module output will be much smaller and Perl will parse it
2122# just the same.
2123# The default value is: YES.
2124# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2125
2126PERLMOD_PRETTY = YES
2127
2128# The names of the make variables in the generated doxyrules.make file are
2129# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2130# so different doxyrules.make files included by the same Makefile don't
2131# overwrite each other's variables.
2132# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2133
2134PERLMOD_MAKEVAR_PREFIX =
2135
2136#---------------------------------------------------------------------------
2137# Configuration options related to the preprocessor
2138#---------------------------------------------------------------------------
2139
Martin Turon1c325c42020-06-29 09:06:55 -07002140# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
Martin Turon51a2ec72020-05-12 14:57:53 -07002141# C-preprocessor directives found in the sources and include files.
2142# The default value is: YES.
2143
2144ENABLE_PREPROCESSING = YES
2145
Martin Turon1c325c42020-06-29 09:06:55 -07002146# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2147# in the source code. If set to NO, only conditional compilation will be
Martin Turon51a2ec72020-05-12 14:57:53 -07002148# performed. Macro expansion can be done in a controlled way by setting
2149# EXPAND_ONLY_PREDEF to YES.
2150# The default value is: NO.
2151# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2152
2153MACRO_EXPANSION = YES
2154
2155# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2156# the macro expansion is limited to the macros specified with the PREDEFINED and
2157# EXPAND_AS_DEFINED tags.
2158# The default value is: NO.
2159# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2160
2161EXPAND_ONLY_PREDEF = YES
2162
Martin Turon1c325c42020-06-29 09:06:55 -07002163# If the SEARCH_INCLUDES tag is set to YES, the include files in the
Martin Turon51a2ec72020-05-12 14:57:53 -07002164# INCLUDE_PATH will be searched if a #include is found.
2165# The default value is: YES.
2166# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2167
2168SEARCH_INCLUDES = YES
2169
2170# The INCLUDE_PATH tag can be used to specify one or more directories that
2171# contain include files that are not input files but should be processed by the
2172# preprocessor.
2173# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2174
achsoftathome0b437632022-08-30 23:03:53 +02002175INCLUDE_PATH =
Martin Turon51a2ec72020-05-12 14:57:53 -07002176
2177# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2178# patterns (like *.h and *.hpp) to filter out the header-files in the
2179# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2180# used.
2181# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2182
2183INCLUDE_FILE_PATTERNS =
2184
2185# The PREDEFINED tag can be used to specify one or more macro names that are
2186# defined before the preprocessor is started (similar to the -D option of e.g.
2187# gcc). The argument of the tag is a list of macros of the form: name or
2188# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2189# is assumed. To prevent a macro definition from being undefined via #undef or
2190# recursively expanded use the := operator instead of the = operator.
2191# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2192
Vivien Nicolas9393ee82020-09-22 18:26:04 +02002193PREDEFINED = DOXYGEN=1 \
Vivien Nicolasfbbf1272020-10-02 20:08:13 +02002194 DOXYGEN_SHOULD_SKIP_THIS=1 \
Vivien Nicolas9393ee82020-09-22 18:26:04 +02002195 NO_INLINE= \
Vivien Nicolasfbbf1272020-10-02 20:08:13 +02002196 CONFIG_NETWORK_LAYER_BLE=1 \
Vivien Nicolas9393ee82020-09-22 18:26:04 +02002197 CHIP_SYSTEM_CONFIG_USE_SOCKETS=1 \
Martin Turon1c325c42020-06-29 09:06:55 -07002198 CHIP_SYSTEM_CONFIG_USE_LWIP=1 \
2199 INET_CONFIG_ENABLE_IPV4=1 \
2200 CHIP_CONFIG_SECURITY_TEST_MODE=1 \
2201 DEPRECATED_MSG_ATTRIBUTE(x)=
Martin Turon51a2ec72020-05-12 14:57:53 -07002202
2203# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2204# tag can be used to specify a list of macro names that should be expanded. The
2205# macro definition that is found in the sources will be used. Use the PREDEFINED
2206# tag if you want to use a different macro definition that overrules the
2207# definition found in the source code.
2208# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2209
2210EXPAND_AS_DEFINED =
2211
2212# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
Martin Turon1c325c42020-06-29 09:06:55 -07002213# remove all references to function-like macros that are alone on a line, have
2214# an all uppercase name, and do not end with a semicolon. Such function macros
2215# are typically used for boiler-plate code, and will confuse the parser if not
Martin Turon51a2ec72020-05-12 14:57:53 -07002216# removed.
2217# The default value is: YES.
2218# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2219
2220SKIP_FUNCTION_MACROS = YES
2221
2222#---------------------------------------------------------------------------
2223# Configuration options related to external references
2224#---------------------------------------------------------------------------
2225
2226# The TAGFILES tag can be used to specify one or more tag files. For each tag
2227# file the location of the external documentation should be added. The format of
2228# a tag file without this location is as follows:
2229# TAGFILES = file1 file2 ...
2230# Adding location for the tag files is done as follows:
2231# TAGFILES = file1=loc1 "file2 = loc2" ...
2232# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2233# section "Linking to external documentation" for more information about the use
2234# of tag files.
Martin Turon1c325c42020-06-29 09:06:55 -07002235# Note: Each tag file must have a unique name (where the name does NOT include
Martin Turon51a2ec72020-05-12 14:57:53 -07002236# the path). If a tag file is not located in the directory in which doxygen is
2237# run, you must also specify the path to the tagfile here.
2238
2239TAGFILES =
2240
2241# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2242# tag file that is based on the input files it reads. See section "Linking to
2243# external documentation" for more information about the usage of tag files.
2244
2245GENERATE_TAGFILE =
2246
Martin Turon1c325c42020-06-29 09:06:55 -07002247# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2248# the class index. If set to NO, only the inherited external classes will be
2249# listed.
Martin Turon51a2ec72020-05-12 14:57:53 -07002250# The default value is: NO.
2251
2252ALLEXTERNALS = NO
2253
Martin Turon1c325c42020-06-29 09:06:55 -07002254# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2255# in the modules index. If set to NO, only the current project's groups will be
Martin Turon51a2ec72020-05-12 14:57:53 -07002256# listed.
2257# The default value is: YES.
2258
2259EXTERNAL_GROUPS = YES
2260
Martin Turon1c325c42020-06-29 09:06:55 -07002261# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
Martin Turon51a2ec72020-05-12 14:57:53 -07002262# the related pages index. If set to NO, only the current project's pages will
2263# be listed.
2264# The default value is: YES.
2265
2266EXTERNAL_PAGES = YES
2267
Martin Turon51a2ec72020-05-12 14:57:53 -07002268#---------------------------------------------------------------------------
2269# Configuration options related to the dot tool
2270#---------------------------------------------------------------------------
2271
Martin Turon1c325c42020-06-29 09:06:55 -07002272# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
Martin Turon51a2ec72020-05-12 14:57:53 -07002273# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2274# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2275# disabled, but it is recommended to install and use dot, since it yields more
2276# powerful graphs.
2277# The default value is: YES.
2278
2279CLASS_DIAGRAMS = YES
2280
Martin Turon51a2ec72020-05-12 14:57:53 -07002281# You can include diagrams made with dia in doxygen documentation. Doxygen will
2282# then run dia to produce the diagram and insert it in the documentation. The
2283# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2284# If left empty dia is assumed to be found in the default search path.
2285
2286DIA_PATH =
2287
Martin Turon1c325c42020-06-29 09:06:55 -07002288# If set to YES the inheritance and collaboration graphs will hide inheritance
Martin Turon51a2ec72020-05-12 14:57:53 -07002289# and usage relations if the target is undocumented or is not a class.
2290# The default value is: YES.
2291
2292HIDE_UNDOC_RELATIONS = YES
2293
2294# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2295# available from the path. This tool is part of Graphviz (see:
2296# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2297# Bell Labs. The other options in this section have no effect if this option is
2298# set to NO
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02002299# The default value is: NO.
Martin Turon51a2ec72020-05-12 14:57:53 -07002300
Michael Spang82049882021-04-05 04:05:24 -04002301HAVE_DOT = NO
Martin Turon51a2ec72020-05-12 14:57:53 -07002302
2303# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2304# to run in parallel. When set to 0 doxygen will base this on the number of
2305# processors available in the system. You can set it explicitly to a value
2306# larger than 0 to get control over the balance between CPU load and processing
2307# speed.
2308# Minimum value: 0, maximum value: 32, default value: 0.
2309# This tag requires that the tag HAVE_DOT is set to YES.
2310
2311DOT_NUM_THREADS = 0
2312
Martin Turon1c325c42020-06-29 09:06:55 -07002313# When you want a differently looking font in the dot files that doxygen
Martin Turon51a2ec72020-05-12 14:57:53 -07002314# generates you can specify the font name using DOT_FONTNAME. You need to make
2315# sure dot is able to find the font, which can be done by putting it in a
2316# standard location or by setting the DOTFONTPATH environment variable or by
2317# setting DOT_FONTPATH to the directory containing the font.
2318# The default value is: Helvetica.
2319# This tag requires that the tag HAVE_DOT is set to YES.
2320
2321DOT_FONTNAME = Helvetica
2322
2323# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2324# dot graphs.
2325# Minimum value: 4, maximum value: 24, default value: 10.
2326# This tag requires that the tag HAVE_DOT is set to YES.
2327
2328DOT_FONTSIZE = 10
2329
2330# By default doxygen will tell dot to use the default font as specified with
2331# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2332# the path where dot can find it using this tag.
2333# This tag requires that the tag HAVE_DOT is set to YES.
2334
2335DOT_FONTPATH =
2336
2337# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2338# each documented class showing the direct and indirect inheritance relations.
2339# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2340# The default value is: YES.
2341# This tag requires that the tag HAVE_DOT is set to YES.
2342
2343CLASS_GRAPH = YES
2344
2345# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2346# graph for each documented class showing the direct and indirect implementation
2347# dependencies (inheritance, containment, and class references variables) of the
2348# class with other documented classes.
2349# The default value is: YES.
2350# This tag requires that the tag HAVE_DOT is set to YES.
2351
2352COLLABORATION_GRAPH = YES
2353
2354# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2355# groups, showing the direct groups dependencies.
2356# The default value is: YES.
2357# This tag requires that the tag HAVE_DOT is set to YES.
2358
2359GROUP_GRAPHS = YES
2360
Martin Turon1c325c42020-06-29 09:06:55 -07002361# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
Martin Turon51a2ec72020-05-12 14:57:53 -07002362# collaboration diagrams in a style similar to the OMG's Unified Modeling
2363# Language.
2364# The default value is: NO.
2365# This tag requires that the tag HAVE_DOT is set to YES.
2366
2367UML_LOOK = NO
2368
2369# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2370# class node. If there are many fields or methods and many nodes the graph may
2371# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2372# number of items for each type to make the size more manageable. Set this to 0
2373# for no limit. Note that the threshold may be exceeded by 50% before the limit
2374# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2375# but if the number exceeds 15, the total amount of fields shown is limited to
2376# 10.
2377# Minimum value: 0, maximum value: 100, default value: 10.
2378# This tag requires that the tag HAVE_DOT is set to YES.
2379
2380UML_LIMIT_NUM_FIELDS = 10
2381
2382# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2383# collaboration graphs will show the relations between templates and their
2384# instances.
2385# The default value is: NO.
2386# This tag requires that the tag HAVE_DOT is set to YES.
2387
2388TEMPLATE_RELATIONS = NO
2389
2390# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2391# YES then doxygen will generate a graph for each documented file showing the
2392# direct and indirect include dependencies of the file with other documented
2393# files.
2394# The default value is: YES.
2395# This tag requires that the tag HAVE_DOT is set to YES.
2396
2397INCLUDE_GRAPH = YES
2398
2399# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2400# set to YES then doxygen will generate a graph for each documented file showing
2401# the direct and indirect include dependencies of the file with other documented
2402# files.
2403# The default value is: YES.
2404# This tag requires that the tag HAVE_DOT is set to YES.
2405
2406INCLUDED_BY_GRAPH = YES
2407
2408# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2409# dependency graph for every global function or class method.
2410#
2411# Note that enabling this option will significantly increase the time of a run.
2412# So in most cases it will be better to enable call graphs for selected
Martin Turon1c325c42020-06-29 09:06:55 -07002413# functions only using the \callgraph command. Disabling a call graph can be
2414# accomplished by means of the command \hidecallgraph.
Martin Turon51a2ec72020-05-12 14:57:53 -07002415# The default value is: NO.
2416# This tag requires that the tag HAVE_DOT is set to YES.
2417
2418CALL_GRAPH = YES
2419
2420# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2421# dependency graph for every global function or class method.
2422#
2423# Note that enabling this option will significantly increase the time of a run.
2424# So in most cases it will be better to enable caller graphs for selected
Martin Turon1c325c42020-06-29 09:06:55 -07002425# functions only using the \callergraph command. Disabling a caller graph can be
2426# accomplished by means of the command \hidecallergraph.
Martin Turon51a2ec72020-05-12 14:57:53 -07002427# The default value is: NO.
2428# This tag requires that the tag HAVE_DOT is set to YES.
2429
2430CALLER_GRAPH = YES
2431
2432# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2433# hierarchy of all classes instead of a textual one.
2434# The default value is: YES.
2435# This tag requires that the tag HAVE_DOT is set to YES.
2436
2437GRAPHICAL_HIERARCHY = YES
2438
2439# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2440# dependencies a directory has on other directories in a graphical way. The
2441# dependency relations are determined by the #include relations between the
2442# files in the directories.
2443# The default value is: YES.
2444# This tag requires that the tag HAVE_DOT is set to YES.
2445
2446DIRECTORY_GRAPH = YES
2447
2448# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
Martin Turon1c325c42020-06-29 09:06:55 -07002449# generated by dot. For an explanation of the image formats see the section
2450# output formats in the documentation of the dot tool (Graphviz (see:
2451# http://www.graphviz.org/)).
Martin Turon51a2ec72020-05-12 14:57:53 -07002452# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2453# to make the SVG files visible in IE 9+ (other browsers do not have this
2454# requirement).
Vivien Nicolas9754e3d2020-09-18 19:53:58 +02002455# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
Martin Turon1c325c42020-06-29 09:06:55 -07002456# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2457# png:gdiplus:gdiplus.
Martin Turon51a2ec72020-05-12 14:57:53 -07002458# The default value is: png.
2459# This tag requires that the tag HAVE_DOT is set to YES.
2460
2461DOT_IMAGE_FORMAT = png
2462
2463# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2464# enable generation of interactive SVG images that allow zooming and panning.
2465#
2466# Note that this requires a modern browser other than Internet Explorer. Tested
2467# and working are Firefox, Chrome, Safari, and Opera.
2468# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2469# the SVG files visible. Older versions of IE do not have SVG support.
2470# The default value is: NO.
2471# This tag requires that the tag HAVE_DOT is set to YES.
2472
2473INTERACTIVE_SVG = NO
2474
2475# The DOT_PATH tag can be used to specify the path where the dot tool can be
2476# found. If left blank, it is assumed the dot tool can be found in the path.
2477# This tag requires that the tag HAVE_DOT is set to YES.
2478
2479DOT_PATH =
2480
2481# The DOTFILE_DIRS tag can be used to specify one or more directories that
2482# contain dot files that are included in the documentation (see the \dotfile
2483# command).
2484# This tag requires that the tag HAVE_DOT is set to YES.
2485
Vivien Nicolas6781feb2020-09-23 17:45:47 +02002486DOTFILE_DIRS = docs/dots/
Martin Turon51a2ec72020-05-12 14:57:53 -07002487
2488# The MSCFILE_DIRS tag can be used to specify one or more directories that
2489# contain msc files that are included in the documentation (see the \mscfile
2490# command).
2491
2492MSCFILE_DIRS =
2493
2494# The DIAFILE_DIRS tag can be used to specify one or more directories that
2495# contain dia files that are included in the documentation (see the \diafile
2496# command).
2497
2498DIAFILE_DIRS =
2499
Martin Turon1c325c42020-06-29 09:06:55 -07002500# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2501# path where java can find the plantuml.jar file. If left blank, it is assumed
2502# PlantUML is not used or called during a preprocessing step. Doxygen will
2503# generate a warning when it encounters a \startuml command in this case and
2504# will not generate output for the diagram.
2505
2506PLANTUML_JAR_PATH =
2507
2508# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2509# configuration file for plantuml.
2510
2511PLANTUML_CFG_FILE =
2512
2513# When using plantuml, the specified paths are searched for files specified by
2514# the !include statement in a plantuml block.
2515
2516PLANTUML_INCLUDE_PATH =
2517
Martin Turon51a2ec72020-05-12 14:57:53 -07002518# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2519# that will be shown in the graph. If the number of nodes in a graph becomes
2520# larger than this value, doxygen will truncate the graph, which is visualized
2521# by representing a node as a red box. Note that doxygen if the number of direct
2522# children of the root node in a graph is already larger than
2523# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2524# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2525# Minimum value: 0, maximum value: 10000, default value: 50.
2526# This tag requires that the tag HAVE_DOT is set to YES.
2527
Justin Wood9d87afe2021-03-10 05:58:07 -08002528DOT_GRAPH_MAX_NODES = 400
Martin Turon51a2ec72020-05-12 14:57:53 -07002529
2530# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2531# generated by dot. A depth value of 3 means that only nodes reachable from the
2532# root by following a path via at most 3 edges will be shown. Nodes that lay
2533# further from the root node will be omitted. Note that setting this option to 1
2534# or 2 may greatly reduce the computation time needed for large code bases. Also
2535# note that the size of a graph can be further restricted by
2536# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2537# Minimum value: 0, maximum value: 1000, default value: 0.
2538# This tag requires that the tag HAVE_DOT is set to YES.
2539
2540MAX_DOT_GRAPH_DEPTH = 0
2541
2542# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2543# background. This is disabled by default, because dot on Windows does not seem
2544# to support this out of the box.
2545#
2546# Warning: Depending on the platform used, enabling this option may lead to
2547# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2548# read).
2549# The default value is: NO.
2550# This tag requires that the tag HAVE_DOT is set to YES.
2551
2552DOT_TRANSPARENT = NO
2553
Martin Turon1c325c42020-06-29 09:06:55 -07002554# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
Martin Turon51a2ec72020-05-12 14:57:53 -07002555# files in one run (i.e. multiple -o and -T options on the command line). This
2556# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2557# this, this feature is disabled by default.
2558# The default value is: NO.
2559# This tag requires that the tag HAVE_DOT is set to YES.
2560
2561DOT_MULTI_TARGETS = YES
2562
2563# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2564# explaining the meaning of the various boxes and arrows in the dot generated
2565# graphs.
2566# The default value is: YES.
2567# This tag requires that the tag HAVE_DOT is set to YES.
2568
2569GENERATE_LEGEND = YES
2570
Martin Turon1c325c42020-06-29 09:06:55 -07002571# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
Martin Turon51a2ec72020-05-12 14:57:53 -07002572# files that are used to generate the various graphs.
2573# The default value is: YES.
2574# This tag requires that the tag HAVE_DOT is set to YES.
2575
2576DOT_CLEANUP = YES