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