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