source: rtems/Doxyfile

Last change on this file was ab85383, checked in by Sebastian Huber <sebastian.huber@…>, on Dec 2, 2020 at 12:03:49 PM

nfsclient: Remove from Doxygen output

The libnetworking is excluded from the Doxygen output. Exclude also the
nfsclient source code, otherwise there are some orphaned Doxygen groups.

Update #3706.

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