blob: 8eb6fd1133f62cf8b8dbdadc80d997c4feee4580 [file] [log] [blame]
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001# Doxyfile 1.8.11
Michal Vasko51cda3c2016-01-29 14:41:26 +01002
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 = libnetconf2
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 = @LIBNETCONF2_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 = "NETCONF library for clients and servers"
48
Radek Krejcif56c6ea2017-05-19 09:43:57 +020049# 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.
Michal Vasko51cda3c2016-01-29 14:41:26 +010053
Radek Krejcif56c6ea2017-05-19 09:43:57 +020054PROJECT_LOGO =
Michal Vasko51cda3c2016-01-29 14:41:26 +010055
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
Radek Krejcif56c6ea2017-05-19 09:43:57 +020063# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
Michal Vasko51cda3c2016-01-29 14:41:26 +010064# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +020096# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
Michal Vasko51cda3c2016-01-29 14:41:26 +010097# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200103# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
Michal Vasko51cda3c2016-01-29 14:41:26 +0100104# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200148# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
Michal Vasko51cda3c2016-01-29 14:41:26 +0100149# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200218# 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.
Michal Vasko51cda3c2016-01-29 14:41:26 +0100221# 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 =
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#
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200289# Note: For files without extension you can use no_extension as a placeholder.
Michal Vasko51cda3c2016-01-29 14:41:26 +0100290#
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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200308# be prevented in individual cases by putting a % sign in front of the word or
309# globally by setting AUTOLINK_SUPPORT to NO.
Michal Vasko51cda3c2016-01-29 14:41:26 +0100310# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200349# tag is set to YES then doxygen will reuse the documentation of the first
Michal Vasko51cda3c2016-01-29 14:41:26 +0100350# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200356# 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
Michal Vasko51cda3c2016-01-29 14:41:26 +0100363# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200421# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
Michal Vasko51cda3c2016-01-29 14:41:26 +0100422# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200431# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
Michal Vasko51cda3c2016-01-29 14:41:26 +0100432# be included in the documentation.
433# The default value is: NO.
434
435EXTRACT_PRIVATE = NO
436
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200437# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
Michal Vasko51cda3c2016-01-29 14:41:26 +0100438# scope will be included in the documentation.
439# The default value is: NO.
440
441EXTRACT_PACKAGE = NO
442
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200443# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
Michal Vasko51cda3c2016-01-29 14:41:26 +0100444# included in the documentation.
445# The default value is: NO.
446
447EXTRACT_STATIC = NO
448
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200449# 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,
Michal Vasko51cda3c2016-01-29 14:41:26 +0100451# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200457# This flag is only useful for Objective-C code. If set to YES, local methods,
Michal Vasko51cda3c2016-01-29 14:41:26 +0100458# which are defined in the implementation section but not in the interface are
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200459# included in the documentation. If set to NO, only methods in the interface are
Michal Vasko51cda3c2016-01-29 14:41:26 +0100460# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200484# to NO, these classes will be included in the various overviews. This option
485# has no effect if EXTRACT_ALL is enabled.
Michal Vasko51cda3c2016-01-29 14:41:26 +0100486# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200491# (class|struct|union) declarations. If set to NO, these declarations will be
Michal Vasko51cda3c2016-01-29 14:41:26 +0100492# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200498# documentation blocks found inside the body of a function. If set to NO, these
Michal Vasko51cda3c2016-01-29 14:41:26 +0100499# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200512# names in lower-case letters. If set to YES, upper-case letters are also
Michal Vasko51cda3c2016-01-29 14:41:26 +0100513# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200521# their full class and namespace scopes in the documentation. If set to YES, the
Michal Vasko51cda3c2016-01-29 14:41:26 +0100522# scope will be hidden.
523# The default value is: NO.
524
525HIDE_SCOPE_NAMES = YES
526
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200527# 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
Michal Vasko51cda3c2016-01-29 14:41:26 +0100534# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200561# name. If set to NO, the members will appear in declaration order.
Michal Vasko51cda3c2016-01-29 14:41:26 +0100562# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200568# name. If set to NO, the members will appear in declaration order. Note that
Michal Vasko51cda3c2016-01-29 14:41:26 +0100569# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200613# 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.
Michal Vasko51cda3c2016-01-29 14:41:26 +0100615# The default value is: YES.
616
617GENERATE_TODOLIST = YES
618
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200619# 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.
Michal Vasko51cda3c2016-01-29 14:41:26 +0100621# The default value is: YES.
622
623GENERATE_TESTLIST = YES
624
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200625# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
Michal Vasko51cda3c2016-01-29 14:41:26 +0100626# list. This list is created by putting \bug commands in the documentation.
627# The default value is: YES.
628
629GENERATE_BUGLIST = YES
630
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200631# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
Michal Vasko51cda3c2016-01-29 14:41:26 +0100632# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200656# 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.
Michal Vasko51cda3c2016-01-29 14:41:26 +0100658# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200721# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
Michal Vasko51cda3c2016-01-29 14:41:26 +0100722# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200729# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
Michal Vasko51cda3c2016-01-29 14:41:26 +0100730# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200746# value. If set to NO, doxygen will only warn about wrong or incomplete
747# parameter documentation, but not about the absence of documentation.
Michal Vasko51cda3c2016-01-29 14:41:26 +0100748# The default value is: NO.
749
750WARN_NO_PARAMDOC = NO
751
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200752# 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
Michal Vasko51cda3c2016-01-29 14:41:26 +0100758# 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
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200781# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
Michal Vasko51cda3c2016-01-29 14:41:26 +0100782# Note: If this tag is empty the current directory is searched.
783
Michal Vaskofdfd9dd2016-02-29 10:18:46 +0100784INPUT = ./src/libnetconf.h \
785 ./src/netconf.h \
Michal Vasko51cda3c2016-01-29 14:41:26 +0100786 ./src/log.h \
787 ./src/messages_client.h \
788 ./src/messages_server.h \
789 ./src/session.h \
790 ./src/session_client.h \
791 ./src/session_client_ch.h \
792 ./src/session_server.h \
793 ./src/session_server_ch.h
794
795# This tag can be used to specify the character encoding of the source files
796# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
797# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
798# documentation (see: http://www.gnu.org/software/libiconv) for the list of
799# possible encodings.
800# The default value is: UTF-8.
801
802INPUT_ENCODING = UTF-8
803
804# If the value of the INPUT tag contains directories, you can use the
805# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200806# *.h) to filter out the source-files in the directories.
807#
808# Note that for custom extensions or not directly supported extensions you also
809# need to set EXTENSION_MAPPING for the extension otherwise the files are not
810# read by doxygen.
811#
812# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
813# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
814# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
815# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
816# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
Michal Vasko51cda3c2016-01-29 14:41:26 +0100817
818FILE_PATTERNS = *.c \
819 *.cc \
820 *.cxx \
821 *.cpp \
822 *.c++ \
823 *.java \
824 *.ii \
825 *.ixx \
826 *.ipp \
827 *.i++ \
828 *.inl \
829 *.idl \
830 *.ddl \
831 *.odl \
832 *.h \
833 *.hh \
834 *.hxx \
835 *.hpp \
836 *.h++ \
837 *.cs \
838 *.d \
839 *.php \
840 *.php4 \
841 *.php5 \
842 *.phtml \
843 *.inc \
844 *.m \
845 *.markdown \
846 *.md \
847 *.mm \
848 *.dox \
849 *.py \
850 *.f90 \
851 *.f \
852 *.for \
853 *.tcl \
854 *.vhd \
855 *.vhdl \
856 *.ucf \
857 *.qsf \
858 *.as \
859 *.js
860
861# The RECURSIVE tag can be used to specify whether or not subdirectories should
862# be searched for input files as well.
863# The default value is: NO.
864
865RECURSIVE = YES
866
867# The EXCLUDE tag can be used to specify files and/or directories that should be
868# excluded from the INPUT source files. This way you can easily exclude a
869# subdirectory from a directory tree whose root is specified with the INPUT tag.
870#
871# Note that relative paths are relative to the directory from which doxygen is
872# run.
873
874EXCLUDE =
875
876# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
877# directories that are symbolic links (a Unix file system feature) are excluded
878# from the input.
879# The default value is: NO.
880
881EXCLUDE_SYMLINKS = NO
882
883# If the value of the INPUT tag contains directories, you can use the
884# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
885# certain files from those directories.
886#
887# Note that the wildcards are matched against the file with absolute path, so to
888# exclude all test directories for example use the pattern */test/*
889
890EXCLUDE_PATTERNS =
891
892# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
893# (namespaces, classes, functions, etc.) that should be excluded from the
894# output. The symbol name can be a fully qualified name, a word, or if the
895# wildcard * is used, a substring. Examples: ANamespace, AClass,
896# AClass::ANamespace, ANamespace::*Test
897#
898# Note that the wildcards are matched against the file with absolute path, so to
899# exclude all test directories use the pattern */test/*
900
901EXCLUDE_SYMBOLS =
902
903# The EXAMPLE_PATH tag can be used to specify one or more files or directories
904# that contain example code fragments that are included (see the \include
905# command).
906
907EXAMPLE_PATH =
908
909# If the value of the EXAMPLE_PATH tag contains directories, you can use the
910# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
911# *.h) to filter out the source-files in the directories. If left blank all
912# files are included.
913
914EXAMPLE_PATTERNS = *
915
916# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
917# searched for input files to be used with the \include or \dontinclude commands
918# irrespective of the value of the RECURSIVE tag.
919# The default value is: NO.
920
921EXAMPLE_RECURSIVE = NO
922
923# The IMAGE_PATH tag can be used to specify one or more files or directories
924# that contain images that are to be included in the documentation (see the
925# \image command).
926
927IMAGE_PATH =
928
929# The INPUT_FILTER tag can be used to specify a program that doxygen should
930# invoke to filter for each input file. Doxygen will invoke the filter program
931# by executing (via popen()) the command:
932#
933# <filter> <input-file>
934#
935# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
936# name of an input file. Doxygen will then use the output that the filter
937# program writes to standard output. If FILTER_PATTERNS is specified, this tag
938# will be ignored.
939#
940# Note that the filter must not add or remove lines; it is applied before the
941# code is scanned, but not when the output code is generated. If lines are added
942# or removed, the anchors will not be placed correctly.
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200943#
944# Note that for custom extensions or not directly supported extensions you also
945# need to set EXTENSION_MAPPING for the extension otherwise the files are not
946# properly processed by doxygen.
Michal Vasko51cda3c2016-01-29 14:41:26 +0100947
948INPUT_FILTER =
949
950# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
951# basis. Doxygen will compare the file name with each pattern and apply the
952# filter if there is a match. The filters are a list of the form: pattern=filter
953# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
954# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
955# patterns match the file name, INPUT_FILTER is applied.
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200956#
957# Note that for custom extensions or not directly supported extensions you also
958# need to set EXTENSION_MAPPING for the extension otherwise the files are not
959# properly processed by doxygen.
Michal Vasko51cda3c2016-01-29 14:41:26 +0100960
961FILTER_PATTERNS =
962
963# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
Radek Krejcif56c6ea2017-05-19 09:43:57 +0200964# INPUT_FILTER) will also be used to filter the input files that are used for
Michal Vasko51cda3c2016-01-29 14:41:26 +0100965# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
966# The default value is: NO.
967
968FILTER_SOURCE_FILES = NO
969
970# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
971# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
972# it is also possible to disable source filtering for a specific pattern using
973# *.ext= (so without naming a filter).
974# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
975
976FILTER_SOURCE_PATTERNS =
977
978# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
979# is part of the input, its contents will be placed on the main page
980# (index.html). This can be useful if you have a project on for instance GitHub
981# and want to reuse the introduction page also for the doxygen output.
982
983USE_MDFILE_AS_MAINPAGE =
984
985#---------------------------------------------------------------------------
986# Configuration options related to source browsing
987#---------------------------------------------------------------------------
988
989# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
990# generated. Documented entities will be cross-referenced with these sources.
991#
992# Note: To get rid of all source code in the generated output, make sure that
993# also VERBATIM_HEADERS is set to NO.
994# The default value is: NO.
995
996SOURCE_BROWSER = YES
997
998# Setting the INLINE_SOURCES tag to YES will include the body of functions,
999# classes and enums directly into the documentation.
1000# The default value is: NO.
1001
1002INLINE_SOURCES = NO
1003
1004# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1005# special comment blocks from generated source code fragments. Normal C, C++ and
1006# Fortran comments will always remain visible.
1007# The default value is: YES.
1008
1009STRIP_CODE_COMMENTS = YES
1010
1011# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1012# function all documented functions referencing it will be listed.
1013# The default value is: NO.
1014
1015REFERENCED_BY_RELATION = NO
1016
1017# If the REFERENCES_RELATION tag is set to YES then for each documented function
1018# all documented entities called/used by that function will be listed.
1019# The default value is: NO.
1020
1021REFERENCES_RELATION = NO
1022
1023# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001024# to YES then the hyperlinks from functions in REFERENCES_RELATION and
Michal Vasko51cda3c2016-01-29 14:41:26 +01001025# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1026# link to the documentation.
1027# The default value is: YES.
1028
1029REFERENCES_LINK_SOURCE = YES
1030
1031# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1032# source code will show a tooltip with additional information such as prototype,
1033# brief description and links to the definition and documentation. Since this
1034# will make the HTML file larger and loading of large files a bit slower, you
1035# can opt to disable this feature.
1036# The default value is: YES.
1037# This tag requires that the tag SOURCE_BROWSER is set to YES.
1038
1039SOURCE_TOOLTIPS = YES
1040
1041# If the USE_HTAGS tag is set to YES then the references to source code will
1042# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1043# source browser. The htags tool is part of GNU's global source tagging system
1044# (see http://www.gnu.org/software/global/global.html). You will need version
1045# 4.8.6 or higher.
1046#
1047# To use it do the following:
1048# - Install the latest version of global
1049# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1050# - Make sure the INPUT points to the root of the source tree
1051# - Run doxygen as normal
1052#
1053# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1054# tools must be available from the command line (i.e. in the search path).
1055#
1056# The result: instead of the source browser generated by doxygen, the links to
1057# source code will now point to the output of htags.
1058# The default value is: NO.
1059# This tag requires that the tag SOURCE_BROWSER is set to YES.
1060
1061USE_HTAGS = NO
1062
1063# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1064# verbatim copy of the header file for each class for which an include is
1065# specified. Set to NO to disable this.
1066# See also: Section \class.
1067# The default value is: YES.
1068
1069VERBATIM_HEADERS = YES
1070
1071#---------------------------------------------------------------------------
1072# Configuration options related to the alphabetical class index
1073#---------------------------------------------------------------------------
1074
1075# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1076# compounds will be generated. Enable this if the project contains a lot of
1077# classes, structs, unions or interfaces.
1078# The default value is: YES.
1079
1080ALPHABETICAL_INDEX = YES
1081
1082# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1083# which the alphabetical index list will be split.
1084# Minimum value: 1, maximum value: 20, default value: 5.
1085# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1086
1087COLS_IN_ALPHA_INDEX = 5
1088
1089# In case all classes in a project start with a common prefix, all classes will
1090# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1091# can be used to specify a prefix (or a list of prefixes) that should be ignored
1092# while generating the index headers.
1093# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1094
1095IGNORE_PREFIX =
1096
1097#---------------------------------------------------------------------------
1098# Configuration options related to the HTML output
1099#---------------------------------------------------------------------------
1100
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001101# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
Michal Vasko51cda3c2016-01-29 14:41:26 +01001102# The default value is: YES.
1103
1104GENERATE_HTML = YES
1105
1106# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1107# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1108# it.
1109# The default directory is: html.
1110# This tag requires that the tag GENERATE_HTML is set to YES.
1111
1112HTML_OUTPUT = html
1113
1114# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1115# generated HTML page (for example: .htm, .php, .asp).
1116# The default value is: .html.
1117# This tag requires that the tag GENERATE_HTML is set to YES.
1118
1119HTML_FILE_EXTENSION = .html
1120
1121# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1122# each generated HTML page. If the tag is left blank doxygen will generate a
1123# standard header.
1124#
1125# To get valid HTML the header file that includes any scripts and style sheets
1126# that doxygen needs, which is dependent on the configuration options used (e.g.
1127# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1128# default header using
1129# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1130# YourConfigFile
1131# and then modify the file new_header.html. See also section "Doxygen usage"
1132# for information on how to generate the default header that doxygen normally
1133# uses.
1134# Note: The header is subject to change so you typically have to regenerate the
1135# default header when upgrading to a newer version of doxygen. For a description
1136# of the possible markers and block names see the documentation.
1137# This tag requires that the tag GENERATE_HTML is set to YES.
1138
1139HTML_HEADER =
1140
1141# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1142# generated HTML page. If the tag is left blank doxygen will generate a standard
1143# footer. See HTML_HEADER for more information on how to generate a default
1144# footer and what special commands can be used inside the footer. See also
1145# section "Doxygen usage" for information on how to generate the default footer
1146# that doxygen normally uses.
1147# This tag requires that the tag GENERATE_HTML is set to YES.
1148
1149HTML_FOOTER =
1150
1151# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1152# sheet that is used by each HTML page. It can be used to fine-tune the look of
1153# the HTML output. If left blank doxygen will generate a default style sheet.
1154# See also section "Doxygen usage" for information on how to generate the style
1155# sheet that doxygen normally uses.
1156# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1157# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1158# obsolete.
1159# This tag requires that the tag GENERATE_HTML is set to YES.
1160
1161HTML_STYLESHEET =
1162
1163# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1164# cascading style sheets that are included after the standard style sheets
1165# created by doxygen. Using this option one can overrule certain style aspects.
1166# This is preferred over using HTML_STYLESHEET since it does not replace the
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001167# standard style sheet and is therefore more robust against future updates.
Michal Vasko51cda3c2016-01-29 14:41:26 +01001168# Doxygen will copy the style sheet files to the output directory.
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001169# Note: The order of the extra style sheet files is of importance (e.g. the last
1170# style sheet in the list overrules the setting of the previous ones in the
Michal Vasko51cda3c2016-01-29 14:41:26 +01001171# list). For an example see the documentation.
1172# This tag requires that the tag GENERATE_HTML is set to YES.
1173
1174HTML_EXTRA_STYLESHEET =
1175
1176# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1177# other source files which should be copied to the HTML output directory. Note
1178# that these files will be copied to the base HTML output directory. Use the
1179# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1180# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1181# files will be copied as-is; there are no commands or markers available.
1182# This tag requires that the tag GENERATE_HTML is set to YES.
1183
1184HTML_EXTRA_FILES =
1185
1186# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001187# will adjust the colors in the style sheet and background images according to
Michal Vasko51cda3c2016-01-29 14:41:26 +01001188# this color. Hue is specified as an angle on a colorwheel, see
1189# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1190# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1191# purple, and 360 is red again.
1192# Minimum value: 0, maximum value: 359, default value: 220.
1193# This tag requires that the tag GENERATE_HTML is set to YES.
1194
1195HTML_COLORSTYLE_HUE = 220
1196
1197# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1198# in the HTML output. For a value of 0 the output will use grayscales only. A
1199# value of 255 will produce the most vivid colors.
1200# Minimum value: 0, maximum value: 255, default value: 100.
1201# This tag requires that the tag GENERATE_HTML is set to YES.
1202
1203HTML_COLORSTYLE_SAT = 100
1204
1205# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1206# luminance component of the colors in the HTML output. Values below 100
1207# gradually make the output lighter, whereas values above 100 make the output
1208# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1209# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1210# change the gamma.
1211# Minimum value: 40, maximum value: 240, default value: 80.
1212# This tag requires that the tag GENERATE_HTML is set to YES.
1213
1214HTML_COLORSTYLE_GAMMA = 80
1215
1216# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1217# page will contain the date and time when the page was generated. Setting this
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001218# to YES can help to show when doxygen was last run and thus if the
1219# documentation is up to date.
1220# The default value is: NO.
Michal Vasko51cda3c2016-01-29 14:41:26 +01001221# This tag requires that the tag GENERATE_HTML is set to YES.
1222
1223HTML_TIMESTAMP = YES
1224
1225# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1226# documentation will contain sections that can be hidden and shown after the
1227# page has loaded.
1228# The default value is: NO.
1229# This tag requires that the tag GENERATE_HTML is set to YES.
1230
1231HTML_DYNAMIC_SECTIONS = NO
1232
1233# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1234# shown in the various tree structured indices initially; the user can expand
1235# and collapse entries dynamically later on. Doxygen will expand the tree to
1236# such a level that at most the specified number of entries are visible (unless
1237# a fully collapsed tree already exceeds this amount). So setting the number of
1238# entries 1 will produce a full collapsed tree by default. 0 is a special value
1239# representing an infinite number of entries and will result in a full expanded
1240# tree by default.
1241# Minimum value: 0, maximum value: 9999, default value: 100.
1242# This tag requires that the tag GENERATE_HTML is set to YES.
1243
1244HTML_INDEX_NUM_ENTRIES = 100
1245
1246# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1247# generated that can be used as input for Apple's Xcode 3 integrated development
1248# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1249# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1250# Makefile in the HTML output directory. Running make will produce the docset in
1251# that directory and running make install will install the docset in
1252# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1253# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1254# for more information.
1255# The default value is: NO.
1256# This tag requires that the tag GENERATE_HTML is set to YES.
1257
1258GENERATE_DOCSET = NO
1259
1260# This tag determines the name of the docset feed. A documentation feed provides
1261# an umbrella under which multiple documentation sets from a single provider
1262# (such as a company or product suite) can be grouped.
1263# The default value is: Doxygen generated docs.
1264# This tag requires that the tag GENERATE_DOCSET is set to YES.
1265
1266DOCSET_FEEDNAME = "Doxygen generated docs"
1267
1268# This tag specifies a string that should uniquely identify the documentation
1269# set bundle. This should be a reverse domain-name style string, e.g.
1270# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1271# The default value is: org.doxygen.Project.
1272# This tag requires that the tag GENERATE_DOCSET is set to YES.
1273
1274DOCSET_BUNDLE_ID = org.doxygen.Project
1275
1276# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1277# the documentation publisher. This should be a reverse domain-name style
1278# string, e.g. com.mycompany.MyDocSet.documentation.
1279# The default value is: org.doxygen.Publisher.
1280# This tag requires that the tag GENERATE_DOCSET is set to YES.
1281
1282DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1283
1284# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1285# The default value is: Publisher.
1286# This tag requires that the tag GENERATE_DOCSET is set to YES.
1287
1288DOCSET_PUBLISHER_NAME = Publisher
1289
1290# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1291# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1292# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1293# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1294# Windows.
1295#
1296# The HTML Help Workshop contains a compiler that can convert all HTML output
1297# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1298# files are now used as the Windows 98 help format, and will replace the old
1299# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1300# HTML files also contain an index, a table of contents, and you can search for
1301# words in the documentation. The HTML workshop also contains a viewer for
1302# compressed HTML files.
1303# The default value is: NO.
1304# This tag requires that the tag GENERATE_HTML is set to YES.
1305
1306GENERATE_HTMLHELP = NO
1307
1308# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1309# file. You can add a path in front of the file if the result should not be
1310# written to the html output directory.
1311# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1312
1313CHM_FILE =
1314
1315# The HHC_LOCATION tag can be used to specify the location (absolute path
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001316# including file name) of the HTML help compiler (hhc.exe). If non-empty,
Michal Vasko51cda3c2016-01-29 14:41:26 +01001317# doxygen will try to run the HTML help compiler on the generated index.hhp.
1318# The file has to be specified with full path.
1319# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1320
1321HHC_LOCATION =
1322
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001323# The GENERATE_CHI flag controls if a separate .chi index file is generated
1324# (YES) or that it should be included in the master .chm file (NO).
Michal Vasko51cda3c2016-01-29 14:41:26 +01001325# The default value is: NO.
1326# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1327
1328GENERATE_CHI = NO
1329
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001330# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
Michal Vasko51cda3c2016-01-29 14:41:26 +01001331# and project file content.
1332# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1333
1334CHM_INDEX_ENCODING =
1335
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001336# The BINARY_TOC flag controls whether a binary table of contents is generated
1337# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
Michal Vasko51cda3c2016-01-29 14:41:26 +01001338# enables the Previous and Next buttons.
1339# The default value is: NO.
1340# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1341
1342BINARY_TOC = NO
1343
1344# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1345# the table of contents of the HTML help documentation and to the tree view.
1346# The default value is: NO.
1347# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1348
1349TOC_EXPAND = NO
1350
1351# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1352# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1353# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1354# (.qch) of the generated HTML documentation.
1355# The default value is: NO.
1356# This tag requires that the tag GENERATE_HTML is set to YES.
1357
1358GENERATE_QHP = NO
1359
1360# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1361# the file name of the resulting .qch file. The path specified is relative to
1362# the HTML output folder.
1363# This tag requires that the tag GENERATE_QHP is set to YES.
1364
1365QCH_FILE =
1366
1367# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1368# Project output. For more information please see Qt Help Project / Namespace
1369# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1370# The default value is: org.doxygen.Project.
1371# This tag requires that the tag GENERATE_QHP is set to YES.
1372
1373QHP_NAMESPACE = org.doxygen.Project
1374
1375# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1376# Help Project output. For more information please see Qt Help Project / Virtual
1377# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1378# folders).
1379# The default value is: doc.
1380# This tag requires that the tag GENERATE_QHP is set to YES.
1381
1382QHP_VIRTUAL_FOLDER = doc
1383
1384# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1385# filter to add. For more information please see Qt Help Project / Custom
1386# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1387# filters).
1388# This tag requires that the tag GENERATE_QHP is set to YES.
1389
1390QHP_CUST_FILTER_NAME =
1391
1392# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1393# custom filter to add. For more information please see Qt Help Project / Custom
1394# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1395# filters).
1396# This tag requires that the tag GENERATE_QHP is set to YES.
1397
1398QHP_CUST_FILTER_ATTRS =
1399
1400# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1401# project's filter section matches. Qt Help Project / Filter Attributes (see:
1402# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1403# This tag requires that the tag GENERATE_QHP is set to YES.
1404
1405QHP_SECT_FILTER_ATTRS =
1406
1407# The QHG_LOCATION tag can be used to specify the location of Qt's
1408# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1409# generated .qhp file.
1410# This tag requires that the tag GENERATE_QHP is set to YES.
1411
1412QHG_LOCATION =
1413
1414# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1415# generated, together with the HTML files, they form an Eclipse help plugin. To
1416# install this plugin and make it available under the help contents menu in
1417# Eclipse, the contents of the directory containing the HTML and XML files needs
1418# to be copied into the plugins directory of eclipse. The name of the directory
1419# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1420# After copying Eclipse needs to be restarted before the help appears.
1421# The default value is: NO.
1422# This tag requires that the tag GENERATE_HTML is set to YES.
1423
1424GENERATE_ECLIPSEHELP = NO
1425
1426# A unique identifier for the Eclipse help plugin. When installing the plugin
1427# the directory name containing the HTML and XML files should also have this
1428# name. Each documentation set should have its own identifier.
1429# The default value is: org.doxygen.Project.
1430# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1431
1432ECLIPSE_DOC_ID = org.doxygen.Project
1433
1434# If you want full control over the layout of the generated HTML pages it might
1435# be necessary to disable the index and replace it with your own. The
1436# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1437# of each HTML page. A value of NO enables the index and the value YES disables
1438# it. Since the tabs in the index contain the same information as the navigation
1439# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1440# The default value is: NO.
1441# This tag requires that the tag GENERATE_HTML is set to YES.
1442
1443DISABLE_INDEX = NO
1444
1445# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1446# structure should be generated to display hierarchical information. If the tag
1447# value is set to YES, a side panel will be generated containing a tree-like
1448# index structure (just like the one that is generated for HTML Help). For this
1449# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1450# (i.e. any modern browser). Windows users are probably better off using the
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001451# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
Michal Vasko51cda3c2016-01-29 14:41:26 +01001452# further fine-tune the look of the index. As an example, the default style
1453# sheet generated by doxygen has an example that shows how to put an image at
1454# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1455# the same information as the tab index, you could consider setting
1456# DISABLE_INDEX to YES when enabling this option.
1457# The default value is: NO.
1458# This tag requires that the tag GENERATE_HTML is set to YES.
1459
1460GENERATE_TREEVIEW = YES
1461
1462# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1463# doxygen will group on one line in the generated HTML documentation.
1464#
1465# Note that a value of 0 will completely suppress the enum values from appearing
1466# in the overview section.
1467# Minimum value: 0, maximum value: 20, default value: 4.
1468# This tag requires that the tag GENERATE_HTML is set to YES.
1469
1470ENUM_VALUES_PER_LINE = 4
1471
1472# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1473# to set the initial width (in pixels) of the frame in which the tree is shown.
1474# Minimum value: 0, maximum value: 1500, default value: 250.
1475# This tag requires that the tag GENERATE_HTML is set to YES.
1476
1477TREEVIEW_WIDTH = 250
1478
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001479# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
Michal Vasko51cda3c2016-01-29 14:41:26 +01001480# external symbols imported via tag files in a separate window.
1481# The default value is: NO.
1482# This tag requires that the tag GENERATE_HTML is set to YES.
1483
1484EXT_LINKS_IN_WINDOW = NO
1485
1486# Use this tag to change the font size of LaTeX formulas included as images in
1487# the HTML documentation. When you change the font size after a successful
1488# doxygen run you need to manually remove any form_*.png images from the HTML
1489# output directory to force them to be regenerated.
1490# Minimum value: 8, maximum value: 50, default value: 10.
1491# This tag requires that the tag GENERATE_HTML is set to YES.
1492
1493FORMULA_FONTSIZE = 10
1494
1495# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1496# generated for formulas are transparent PNGs. Transparent PNGs are not
1497# supported properly for IE 6.0, but are supported on all modern browsers.
1498#
1499# Note that when changing this option you need to delete any form_*.png files in
1500# the HTML output directory before the changes have effect.
1501# The default value is: YES.
1502# This tag requires that the tag GENERATE_HTML is set to YES.
1503
1504FORMULA_TRANSPARENT = YES
1505
1506# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1507# http://www.mathjax.org) which uses client side Javascript for the rendering
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001508# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
Michal Vasko51cda3c2016-01-29 14:41:26 +01001509# installed or if you want to formulas look prettier in the HTML output. When
1510# enabled you may also need to install MathJax separately and configure the path
1511# to it using the MATHJAX_RELPATH option.
1512# The default value is: NO.
1513# This tag requires that the tag GENERATE_HTML is set to YES.
1514
1515USE_MATHJAX = NO
1516
1517# When MathJax is enabled you can set the default output format to be used for
1518# the MathJax output. See the MathJax site (see:
1519# http://docs.mathjax.org/en/latest/output.html) for more details.
1520# Possible values are: HTML-CSS (which is slower, but has the best
1521# compatibility), NativeMML (i.e. MathML) and SVG.
1522# The default value is: HTML-CSS.
1523# This tag requires that the tag USE_MATHJAX is set to YES.
1524
1525MATHJAX_FORMAT = HTML-CSS
1526
1527# When MathJax is enabled you need to specify the location relative to the HTML
1528# output directory using the MATHJAX_RELPATH option. The destination directory
1529# should contain the MathJax.js script. For instance, if the mathjax directory
1530# is located at the same level as the HTML output directory, then
1531# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1532# Content Delivery Network so you can quickly see the result without installing
1533# MathJax. However, it is strongly recommended to install a local copy of
1534# MathJax from http://www.mathjax.org before deployment.
1535# The default value is: http://cdn.mathjax.org/mathjax/latest.
1536# This tag requires that the tag USE_MATHJAX is set to YES.
1537
1538MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1539
1540# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1541# extension names that should be enabled during MathJax rendering. For example
1542# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1543# This tag requires that the tag USE_MATHJAX is set to YES.
1544
1545MATHJAX_EXTENSIONS =
1546
1547# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1548# of code that will be used on startup of the MathJax code. See the MathJax site
1549# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1550# example see the documentation.
1551# This tag requires that the tag USE_MATHJAX is set to YES.
1552
1553MATHJAX_CODEFILE =
1554
1555# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1556# the HTML output. The underlying search engine uses javascript and DHTML and
1557# should work on any modern browser. Note that when using HTML help
1558# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1559# there is already a search function so this one should typically be disabled.
1560# For large projects the javascript based search engine can be slow, then
1561# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1562# search using the keyboard; to jump to the search box use <access key> + S
1563# (what the <access key> is depends on the OS and browser, but it is typically
1564# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1565# key> to jump into the search results window, the results can be navigated
1566# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1567# the search. The filter options can be selected when the cursor is inside the
1568# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1569# to select a filter and <Enter> or <escape> to activate or cancel the filter
1570# option.
1571# The default value is: YES.
1572# This tag requires that the tag GENERATE_HTML is set to YES.
1573
1574SEARCHENGINE = YES
1575
1576# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1577# implemented using a web server instead of a web client using Javascript. There
1578# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1579# setting. When disabled, doxygen will generate a PHP script for searching and
1580# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1581# and searching needs to be provided by external tools. See the section
1582# "External Indexing and Searching" for details.
1583# The default value is: NO.
1584# This tag requires that the tag SEARCHENGINE is set to YES.
1585
1586SERVER_BASED_SEARCH = NO
1587
1588# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1589# script for searching. Instead the search results are written to an XML file
1590# which needs to be processed by an external indexer. Doxygen will invoke an
1591# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1592# search results.
1593#
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001594# Doxygen ships with an example indexer (doxyindexer) and search engine
Michal Vasko51cda3c2016-01-29 14:41:26 +01001595# (doxysearch.cgi) which are based on the open source search engine library
1596# Xapian (see: http://xapian.org/).
1597#
1598# See the section "External Indexing and Searching" for details.
1599# The default value is: NO.
1600# This tag requires that the tag SEARCHENGINE is set to YES.
1601
1602EXTERNAL_SEARCH = NO
1603
1604# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1605# which will return the search results when EXTERNAL_SEARCH is enabled.
1606#
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001607# Doxygen ships with an example indexer (doxyindexer) and search engine
Michal Vasko51cda3c2016-01-29 14:41:26 +01001608# (doxysearch.cgi) which are based on the open source search engine library
1609# Xapian (see: http://xapian.org/). See the section "External Indexing and
1610# Searching" for details.
1611# This tag requires that the tag SEARCHENGINE is set to YES.
1612
1613SEARCHENGINE_URL =
1614
1615# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1616# search data is written to a file for indexing by an external tool. With the
1617# SEARCHDATA_FILE tag the name of this file can be specified.
1618# The default file is: searchdata.xml.
1619# This tag requires that the tag SEARCHENGINE is set to YES.
1620
1621SEARCHDATA_FILE = searchdata.xml
1622
1623# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1624# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1625# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1626# projects and redirect the results back to the right project.
1627# This tag requires that the tag SEARCHENGINE is set to YES.
1628
1629EXTERNAL_SEARCH_ID =
1630
1631# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1632# projects other than the one defined by this configuration file, but that are
1633# all added to the same external search index. Each project needs to have a
1634# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1635# to a relative location where the documentation can be found. The format is:
1636# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1637# This tag requires that the tag SEARCHENGINE is set to YES.
1638
1639EXTRA_SEARCH_MAPPINGS =
1640
1641#---------------------------------------------------------------------------
1642# Configuration options related to the LaTeX output
1643#---------------------------------------------------------------------------
1644
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001645# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
Michal Vasko51cda3c2016-01-29 14:41:26 +01001646# The default value is: YES.
1647
1648GENERATE_LATEX = NO
1649
1650# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1651# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1652# it.
1653# The default directory is: latex.
1654# This tag requires that the tag GENERATE_LATEX is set to YES.
1655
1656LATEX_OUTPUT = latex
1657
1658# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1659# invoked.
1660#
1661# Note that when enabling USE_PDFLATEX this option is only used for generating
1662# bitmaps for formulas in the HTML output, but not in the Makefile that is
1663# written to the output directory.
1664# The default file is: latex.
1665# This tag requires that the tag GENERATE_LATEX is set to YES.
1666
1667LATEX_CMD_NAME = latex
1668
1669# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1670# index for LaTeX.
1671# The default file is: makeindex.
1672# This tag requires that the tag GENERATE_LATEX is set to YES.
1673
1674MAKEINDEX_CMD_NAME = makeindex
1675
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001676# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
Michal Vasko51cda3c2016-01-29 14:41:26 +01001677# documents. This may be useful for small projects and may help to save some
1678# trees in general.
1679# The default value is: NO.
1680# This tag requires that the tag GENERATE_LATEX is set to YES.
1681
1682COMPACT_LATEX = NO
1683
1684# The PAPER_TYPE tag can be used to set the paper type that is used by the
1685# printer.
1686# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1687# 14 inches) and executive (7.25 x 10.5 inches).
1688# The default value is: a4.
1689# This tag requires that the tag GENERATE_LATEX is set to YES.
1690
1691PAPER_TYPE = a4
1692
1693# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001694# that should be included in the LaTeX output. The package can be specified just
1695# by its name or with the correct syntax as to be used with the LaTeX
1696# \usepackage command. To get the times font for instance you can specify :
1697# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1698# To use the option intlimits with the amsmath package you can specify:
1699# EXTRA_PACKAGES=[intlimits]{amsmath}
Michal Vasko51cda3c2016-01-29 14:41:26 +01001700# If left blank no extra packages will be included.
1701# This tag requires that the tag GENERATE_LATEX is set to YES.
1702
1703EXTRA_PACKAGES =
1704
1705# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1706# generated LaTeX document. The header should contain everything until the first
1707# chapter. If it is left blank doxygen will generate a standard header. See
1708# section "Doxygen usage" for information on how to let doxygen write the
1709# default header to a separate file.
1710#
1711# Note: Only use a user-defined header if you know what you are doing! The
1712# following commands have a special meaning inside the header: $title,
1713# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001714# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1715# string, for the replacement values of the other commands the user is referred
1716# to HTML_HEADER.
Michal Vasko51cda3c2016-01-29 14:41:26 +01001717# This tag requires that the tag GENERATE_LATEX is set to YES.
1718
1719LATEX_HEADER =
1720
1721# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1722# generated LaTeX document. The footer should contain everything after the last
1723# chapter. If it is left blank doxygen will generate a standard footer. See
1724# LATEX_HEADER for more information on how to generate a default footer and what
1725# special commands can be used inside the footer.
1726#
1727# Note: Only use a user-defined footer if you know what you are doing!
1728# This tag requires that the tag GENERATE_LATEX is set to YES.
1729
1730LATEX_FOOTER =
1731
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001732# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1733# LaTeX style sheets that are included after the standard style sheets created
1734# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1735# will copy the style sheet files to the output directory.
1736# Note: The order of the extra style sheet files is of importance (e.g. the last
1737# style sheet in the list overrules the setting of the previous ones in the
1738# list).
1739# This tag requires that the tag GENERATE_LATEX is set to YES.
1740
1741LATEX_EXTRA_STYLESHEET =
1742
Michal Vasko51cda3c2016-01-29 14:41:26 +01001743# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1744# other source files which should be copied to the LATEX_OUTPUT output
1745# directory. Note that the files will be copied as-is; there are no commands or
1746# markers available.
1747# This tag requires that the tag GENERATE_LATEX is set to YES.
1748
1749LATEX_EXTRA_FILES =
1750
1751# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1752# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1753# contain links (just like the HTML output) instead of page references. This
1754# makes the output suitable for online browsing using a PDF viewer.
1755# The default value is: YES.
1756# This tag requires that the tag GENERATE_LATEX is set to YES.
1757
1758PDF_HYPERLINKS = YES
1759
1760# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001761# the PDF file directly from the LaTeX files. Set this option to YES, to get a
Michal Vasko51cda3c2016-01-29 14:41:26 +01001762# higher quality PDF documentation.
1763# The default value is: YES.
1764# This tag requires that the tag GENERATE_LATEX is set to YES.
1765
1766USE_PDFLATEX = YES
1767
1768# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1769# command to the generated LaTeX files. This will instruct LaTeX to keep running
1770# if errors occur, instead of asking the user for help. This option is also used
1771# when generating formulas in HTML.
1772# The default value is: NO.
1773# This tag requires that the tag GENERATE_LATEX is set to YES.
1774
1775LATEX_BATCHMODE = NO
1776
1777# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1778# index chapters (such as File Index, Compound Index, etc.) in the output.
1779# The default value is: NO.
1780# This tag requires that the tag GENERATE_LATEX is set to YES.
1781
1782LATEX_HIDE_INDICES = NO
1783
1784# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1785# code with syntax highlighting in the LaTeX output.
1786#
1787# Note that which sources are shown also depends on other settings such as
1788# SOURCE_BROWSER.
1789# The default value is: NO.
1790# This tag requires that the tag GENERATE_LATEX is set to YES.
1791
1792LATEX_SOURCE_CODE = NO
1793
1794# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1795# bibliography, e.g. plainnat, or ieeetr. See
1796# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1797# The default value is: plain.
1798# This tag requires that the tag GENERATE_LATEX is set to YES.
1799
1800LATEX_BIB_STYLE = plain
1801
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001802# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1803# page will contain the date and time when the page was generated. Setting this
1804# to NO can help when comparing the output of multiple runs.
1805# The default value is: NO.
1806# This tag requires that the tag GENERATE_LATEX is set to YES.
1807
1808LATEX_TIMESTAMP = NO
1809
Michal Vasko51cda3c2016-01-29 14:41:26 +01001810#---------------------------------------------------------------------------
1811# Configuration options related to the RTF output
1812#---------------------------------------------------------------------------
1813
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001814# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
Michal Vasko51cda3c2016-01-29 14:41:26 +01001815# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1816# readers/editors.
1817# The default value is: NO.
1818
1819GENERATE_RTF = NO
1820
1821# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1822# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1823# it.
1824# The default directory is: rtf.
1825# This tag requires that the tag GENERATE_RTF is set to YES.
1826
1827RTF_OUTPUT = rtf
1828
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001829# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
Michal Vasko51cda3c2016-01-29 14:41:26 +01001830# documents. This may be useful for small projects and may help to save some
1831# trees in general.
1832# The default value is: NO.
1833# This tag requires that the tag GENERATE_RTF is set to YES.
1834
1835COMPACT_RTF = NO
1836
1837# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1838# contain hyperlink fields. The RTF file will contain links (just like the HTML
1839# output) instead of page references. This makes the output suitable for online
1840# browsing using Word or some other Word compatible readers that support those
1841# fields.
1842#
1843# Note: WordPad (write) and others do not support links.
1844# The default value is: NO.
1845# This tag requires that the tag GENERATE_RTF is set to YES.
1846
1847RTF_HYPERLINKS = NO
1848
1849# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1850# file, i.e. a series of assignments. You only have to provide replacements,
1851# missing definitions are set to their default value.
1852#
1853# See also section "Doxygen usage" for information on how to generate the
1854# default style sheet that doxygen normally uses.
1855# This tag requires that the tag GENERATE_RTF is set to YES.
1856
1857RTF_STYLESHEET_FILE =
1858
1859# Set optional variables used in the generation of an RTF document. Syntax is
1860# similar to doxygen's config file. A template extensions file can be generated
1861# using doxygen -e rtf extensionFile.
1862# This tag requires that the tag GENERATE_RTF is set to YES.
1863
1864RTF_EXTENSIONS_FILE =
1865
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001866# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1867# with syntax highlighting in the RTF output.
1868#
1869# Note that which sources are shown also depends on other settings such as
1870# SOURCE_BROWSER.
1871# The default value is: NO.
1872# This tag requires that the tag GENERATE_RTF is set to YES.
1873
1874RTF_SOURCE_CODE = NO
1875
Michal Vasko51cda3c2016-01-29 14:41:26 +01001876#---------------------------------------------------------------------------
1877# Configuration options related to the man page output
1878#---------------------------------------------------------------------------
1879
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001880# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
Michal Vasko51cda3c2016-01-29 14:41:26 +01001881# classes and files.
1882# The default value is: NO.
1883
1884GENERATE_MAN = NO
1885
1886# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1887# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1888# it. A directory man3 will be created inside the directory specified by
1889# MAN_OUTPUT.
1890# The default directory is: man.
1891# This tag requires that the tag GENERATE_MAN is set to YES.
1892
1893MAN_OUTPUT = man
1894
1895# The MAN_EXTENSION tag determines the extension that is added to the generated
1896# man pages. In case the manual section does not start with a number, the number
1897# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1898# optional.
1899# The default value is: .3.
1900# This tag requires that the tag GENERATE_MAN is set to YES.
1901
1902MAN_EXTENSION = .3
1903
1904# The MAN_SUBDIR tag determines the name of the directory created within
1905# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1906# MAN_EXTENSION with the initial . removed.
1907# This tag requires that the tag GENERATE_MAN is set to YES.
1908
1909MAN_SUBDIR =
1910
1911# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1912# will generate one additional man file for each entity documented in the real
1913# man page(s). These additional files only source the real man page, but without
1914# them the man command would be unable to find the correct page.
1915# The default value is: NO.
1916# This tag requires that the tag GENERATE_MAN is set to YES.
1917
1918MAN_LINKS = NO
1919
1920#---------------------------------------------------------------------------
1921# Configuration options related to the XML output
1922#---------------------------------------------------------------------------
1923
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001924# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
Michal Vasko51cda3c2016-01-29 14:41:26 +01001925# captures the structure of the code including all documentation.
1926# The default value is: NO.
1927
1928GENERATE_XML = NO
1929
1930# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1931# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1932# it.
1933# The default directory is: xml.
1934# This tag requires that the tag GENERATE_XML is set to YES.
1935
1936XML_OUTPUT = xml
1937
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001938# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
Michal Vasko51cda3c2016-01-29 14:41:26 +01001939# listings (including syntax highlighting and cross-referencing information) to
1940# the XML output. Note that enabling this will significantly increase the size
1941# of the XML output.
1942# The default value is: YES.
1943# This tag requires that the tag GENERATE_XML is set to YES.
1944
1945XML_PROGRAMLISTING = YES
1946
1947#---------------------------------------------------------------------------
1948# Configuration options related to the DOCBOOK output
1949#---------------------------------------------------------------------------
1950
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001951# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
Michal Vasko51cda3c2016-01-29 14:41:26 +01001952# that can be used to generate PDF.
1953# The default value is: NO.
1954
1955GENERATE_DOCBOOK = NO
1956
1957# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1958# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1959# front of it.
1960# The default directory is: docbook.
1961# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1962
1963DOCBOOK_OUTPUT = docbook
1964
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001965# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
Michal Vasko51cda3c2016-01-29 14:41:26 +01001966# program listings (including syntax highlighting and cross-referencing
1967# information) to the DOCBOOK output. Note that enabling this will significantly
1968# increase the size of the DOCBOOK output.
1969# The default value is: NO.
1970# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1971
1972DOCBOOK_PROGRAMLISTING = NO
1973
1974#---------------------------------------------------------------------------
1975# Configuration options for the AutoGen Definitions output
1976#---------------------------------------------------------------------------
1977
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001978# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1979# AutoGen Definitions (see http://autogen.sf.net) file that captures the
1980# structure of the code including all documentation. Note that this feature is
1981# still experimental and incomplete at the moment.
Michal Vasko51cda3c2016-01-29 14:41:26 +01001982# The default value is: NO.
1983
1984GENERATE_AUTOGEN_DEF = NO
1985
1986#---------------------------------------------------------------------------
1987# Configuration options related to the Perl module output
1988#---------------------------------------------------------------------------
1989
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001990# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
Michal Vasko51cda3c2016-01-29 14:41:26 +01001991# file that captures the structure of the code including all documentation.
1992#
1993# Note that this feature is still experimental and incomplete at the moment.
1994# The default value is: NO.
1995
1996GENERATE_PERLMOD = NO
1997
Radek Krejcif56c6ea2017-05-19 09:43:57 +02001998# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
Michal Vasko51cda3c2016-01-29 14:41:26 +01001999# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2000# output from the Perl module output.
2001# The default value is: NO.
2002# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2003
2004PERLMOD_LATEX = NO
2005
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002006# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
Michal Vasko51cda3c2016-01-29 14:41:26 +01002007# formatted so it can be parsed by a human reader. This is useful if you want to
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002008# understand what is going on. On the other hand, if this tag is set to NO, the
Michal Vasko51cda3c2016-01-29 14:41:26 +01002009# size of the Perl module output will be much smaller and Perl will parse it
2010# just the same.
2011# The default value is: YES.
2012# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2013
2014PERLMOD_PRETTY = YES
2015
2016# The names of the make variables in the generated doxyrules.make file are
2017# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2018# so different doxyrules.make files included by the same Makefile don't
2019# overwrite each other's variables.
2020# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2021
2022PERLMOD_MAKEVAR_PREFIX =
2023
2024#---------------------------------------------------------------------------
2025# Configuration options related to the preprocessor
2026#---------------------------------------------------------------------------
2027
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002028# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
Michal Vasko51cda3c2016-01-29 14:41:26 +01002029# C-preprocessor directives found in the sources and include files.
2030# The default value is: YES.
2031
2032ENABLE_PREPROCESSING = YES
2033
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002034# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2035# in the source code. If set to NO, only conditional compilation will be
Michal Vasko51cda3c2016-01-29 14:41:26 +01002036# performed. Macro expansion can be done in a controlled way by setting
2037# EXPAND_ONLY_PREDEF to YES.
2038# The default value is: NO.
2039# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2040
2041MACRO_EXPANSION = NO
2042
2043# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2044# the macro expansion is limited to the macros specified with the PREDEFINED and
2045# EXPAND_AS_DEFINED tags.
2046# The default value is: NO.
2047# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2048
2049EXPAND_ONLY_PREDEF = NO
2050
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002051# If the SEARCH_INCLUDES tag is set to YES, the include files in the
Michal Vasko51cda3c2016-01-29 14:41:26 +01002052# INCLUDE_PATH will be searched if a #include is found.
2053# The default value is: YES.
2054# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2055
2056SEARCH_INCLUDES = YES
2057
2058# The INCLUDE_PATH tag can be used to specify one or more directories that
2059# contain include files that are not input files but should be processed by the
2060# preprocessor.
2061# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2062
2063INCLUDE_PATH =
2064
2065# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2066# patterns (like *.h and *.hpp) to filter out the header-files in the
2067# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2068# used.
2069# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2070
2071INCLUDE_FILE_PATTERNS =
2072
2073# The PREDEFINED tag can be used to specify one or more macro names that are
2074# defined before the preprocessor is started (similar to the -D option of e.g.
2075# gcc). The argument of the tag is a list of macros of the form: name or
2076# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2077# is assumed. To prevent a macro definition from being undefined via #undef or
2078# recursively expanded use the := operator instead of the = operator.
2079# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2080
Michal Vaskofdfd9dd2016-02-29 10:18:46 +01002081PREDEFINED = NC_ENABLED_SSH NC_ENABLED_TLS
Michal Vasko51cda3c2016-01-29 14:41:26 +01002082
2083# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2084# tag can be used to specify a list of macro names that should be expanded. The
2085# macro definition that is found in the sources will be used. Use the PREDEFINED
2086# tag if you want to use a different macro definition that overrules the
2087# definition found in the source code.
2088# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2089
2090EXPAND_AS_DEFINED =
2091
2092# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2093# remove all references to function-like macros that are alone on a line, have
2094# an all uppercase name, and do not end with a semicolon. Such function macros
2095# are typically used for boiler-plate code, and will confuse the parser if not
2096# removed.
2097# The default value is: YES.
2098# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2099
2100SKIP_FUNCTION_MACROS = YES
2101
2102#---------------------------------------------------------------------------
2103# Configuration options related to external references
2104#---------------------------------------------------------------------------
2105
2106# The TAGFILES tag can be used to specify one or more tag files. For each tag
2107# file the location of the external documentation should be added. The format of
2108# a tag file without this location is as follows:
2109# TAGFILES = file1 file2 ...
2110# Adding location for the tag files is done as follows:
2111# TAGFILES = file1=loc1 "file2 = loc2" ...
2112# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2113# section "Linking to external documentation" for more information about the use
2114# of tag files.
2115# Note: Each tag file must have a unique name (where the name does NOT include
2116# the path). If a tag file is not located in the directory in which doxygen is
2117# run, you must also specify the path to the tagfile here.
2118
2119TAGFILES =
2120
2121# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2122# tag file that is based on the input files it reads. See section "Linking to
2123# external documentation" for more information about the usage of tag files.
2124
2125GENERATE_TAGFILE =
2126
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002127# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2128# the class index. If set to NO, only the inherited external classes will be
2129# listed.
Michal Vasko51cda3c2016-01-29 14:41:26 +01002130# The default value is: NO.
2131
2132ALLEXTERNALS = NO
2133
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002134# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2135# in the modules index. If set to NO, only the current project's groups will be
Michal Vasko51cda3c2016-01-29 14:41:26 +01002136# listed.
2137# The default value is: YES.
2138
2139EXTERNAL_GROUPS = YES
2140
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002141# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
Michal Vasko51cda3c2016-01-29 14:41:26 +01002142# the related pages index. If set to NO, only the current project's pages will
2143# be listed.
2144# The default value is: YES.
2145
2146EXTERNAL_PAGES = YES
2147
2148# The PERL_PATH should be the absolute path and name of the perl script
2149# interpreter (i.e. the result of 'which perl').
2150# The default file (with absolute path) is: /usr/bin/perl.
2151
2152PERL_PATH = /usr/bin/perl
2153
2154#---------------------------------------------------------------------------
2155# Configuration options related to the dot tool
2156#---------------------------------------------------------------------------
2157
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002158# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
Michal Vasko51cda3c2016-01-29 14:41:26 +01002159# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2160# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2161# disabled, but it is recommended to install and use dot, since it yields more
2162# powerful graphs.
2163# The default value is: YES.
2164
2165CLASS_DIAGRAMS = YES
2166
2167# You can define message sequence charts within doxygen comments using the \msc
2168# command. Doxygen will then run the mscgen tool (see:
2169# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2170# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2171# the mscgen tool resides. If left empty the tool is assumed to be found in the
2172# default search path.
2173
2174MSCGEN_PATH =
2175
2176# You can include diagrams made with dia in doxygen documentation. Doxygen will
2177# then run dia to produce the diagram and insert it in the documentation. The
2178# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2179# If left empty dia is assumed to be found in the default search path.
2180
2181DIA_PATH =
2182
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002183# If set to YES the inheritance and collaboration graphs will hide inheritance
Michal Vasko51cda3c2016-01-29 14:41:26 +01002184# and usage relations if the target is undocumented or is not a class.
2185# The default value is: YES.
2186
2187HIDE_UNDOC_RELATIONS = YES
2188
2189# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2190# available from the path. This tool is part of Graphviz (see:
2191# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2192# Bell Labs. The other options in this section have no effect if this option is
2193# set to NO
2194# The default value is: NO.
2195
2196HAVE_DOT = NO
2197
2198# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2199# to run in parallel. When set to 0 doxygen will base this on the number of
2200# processors available in the system. You can set it explicitly to a value
2201# larger than 0 to get control over the balance between CPU load and processing
2202# speed.
2203# Minimum value: 0, maximum value: 32, default value: 0.
2204# This tag requires that the tag HAVE_DOT is set to YES.
2205
2206DOT_NUM_THREADS = 0
2207
2208# When you want a differently looking font in the dot files that doxygen
2209# generates you can specify the font name using DOT_FONTNAME. You need to make
2210# sure dot is able to find the font, which can be done by putting it in a
2211# standard location or by setting the DOTFONTPATH environment variable or by
2212# setting DOT_FONTPATH to the directory containing the font.
2213# The default value is: Helvetica.
2214# This tag requires that the tag HAVE_DOT is set to YES.
2215
2216DOT_FONTNAME = Helvetica
2217
2218# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2219# dot graphs.
2220# Minimum value: 4, maximum value: 24, default value: 10.
2221# This tag requires that the tag HAVE_DOT is set to YES.
2222
2223DOT_FONTSIZE = 10
2224
2225# By default doxygen will tell dot to use the default font as specified with
2226# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2227# the path where dot can find it using this tag.
2228# This tag requires that the tag HAVE_DOT is set to YES.
2229
2230DOT_FONTPATH =
2231
2232# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2233# each documented class showing the direct and indirect inheritance relations.
2234# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2235# The default value is: YES.
2236# This tag requires that the tag HAVE_DOT is set to YES.
2237
2238CLASS_GRAPH = YES
2239
2240# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2241# graph for each documented class showing the direct and indirect implementation
2242# dependencies (inheritance, containment, and class references variables) of the
2243# class with other documented classes.
2244# The default value is: YES.
2245# This tag requires that the tag HAVE_DOT is set to YES.
2246
2247COLLABORATION_GRAPH = YES
2248
2249# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2250# groups, showing the direct groups dependencies.
2251# The default value is: YES.
2252# This tag requires that the tag HAVE_DOT is set to YES.
2253
2254GROUP_GRAPHS = YES
2255
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002256# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
Michal Vasko51cda3c2016-01-29 14:41:26 +01002257# collaboration diagrams in a style similar to the OMG's Unified Modeling
2258# Language.
2259# The default value is: NO.
2260# This tag requires that the tag HAVE_DOT is set to YES.
2261
2262UML_LOOK = NO
2263
2264# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2265# class node. If there are many fields or methods and many nodes the graph may
2266# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2267# number of items for each type to make the size more manageable. Set this to 0
2268# for no limit. Note that the threshold may be exceeded by 50% before the limit
2269# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2270# but if the number exceeds 15, the total amount of fields shown is limited to
2271# 10.
2272# Minimum value: 0, maximum value: 100, default value: 10.
2273# This tag requires that the tag HAVE_DOT is set to YES.
2274
2275UML_LIMIT_NUM_FIELDS = 10
2276
2277# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2278# collaboration graphs will show the relations between templates and their
2279# instances.
2280# The default value is: NO.
2281# This tag requires that the tag HAVE_DOT is set to YES.
2282
2283TEMPLATE_RELATIONS = NO
2284
2285# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2286# YES then doxygen will generate a graph for each documented file showing the
2287# direct and indirect include dependencies of the file with other documented
2288# files.
2289# The default value is: YES.
2290# This tag requires that the tag HAVE_DOT is set to YES.
2291
2292INCLUDE_GRAPH = YES
2293
2294# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2295# set to YES then doxygen will generate a graph for each documented file showing
2296# the direct and indirect include dependencies of the file with other documented
2297# files.
2298# The default value is: YES.
2299# This tag requires that the tag HAVE_DOT is set to YES.
2300
2301INCLUDED_BY_GRAPH = YES
2302
2303# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2304# dependency graph for every global function or class method.
2305#
2306# Note that enabling this option will significantly increase the time of a run.
2307# So in most cases it will be better to enable call graphs for selected
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002308# functions only using the \callgraph command. Disabling a call graph can be
2309# accomplished by means of the command \hidecallgraph.
Michal Vasko51cda3c2016-01-29 14:41:26 +01002310# The default value is: NO.
2311# This tag requires that the tag HAVE_DOT is set to YES.
2312
2313CALL_GRAPH = NO
2314
2315# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2316# dependency graph for every global function or class method.
2317#
2318# Note that enabling this option will significantly increase the time of a run.
2319# So in most cases it will be better to enable caller graphs for selected
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002320# functions only using the \callergraph command. Disabling a caller graph can be
2321# accomplished by means of the command \hidecallergraph.
Michal Vasko51cda3c2016-01-29 14:41:26 +01002322# The default value is: NO.
2323# This tag requires that the tag HAVE_DOT is set to YES.
2324
2325CALLER_GRAPH = NO
2326
2327# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2328# hierarchy of all classes instead of a textual one.
2329# The default value is: YES.
2330# This tag requires that the tag HAVE_DOT is set to YES.
2331
2332GRAPHICAL_HIERARCHY = YES
2333
2334# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2335# dependencies a directory has on other directories in a graphical way. The
2336# dependency relations are determined by the #include relations between the
2337# files in the directories.
2338# The default value is: YES.
2339# This tag requires that the tag HAVE_DOT is set to YES.
2340
2341DIRECTORY_GRAPH = YES
2342
2343# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002344# generated by dot. For an explanation of the image formats see the section
2345# output formats in the documentation of the dot tool (Graphviz (see:
2346# http://www.graphviz.org/)).
Michal Vasko51cda3c2016-01-29 14:41:26 +01002347# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2348# to make the SVG files visible in IE 9+ (other browsers do not have this
2349# requirement).
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002350# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2351# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2352# png:gdiplus:gdiplus.
Michal Vasko51cda3c2016-01-29 14:41:26 +01002353# The default value is: png.
2354# This tag requires that the tag HAVE_DOT is set to YES.
2355
2356DOT_IMAGE_FORMAT = png
2357
2358# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2359# enable generation of interactive SVG images that allow zooming and panning.
2360#
2361# Note that this requires a modern browser other than Internet Explorer. Tested
2362# and working are Firefox, Chrome, Safari, and Opera.
2363# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2364# the SVG files visible. Older versions of IE do not have SVG support.
2365# The default value is: NO.
2366# This tag requires that the tag HAVE_DOT is set to YES.
2367
2368INTERACTIVE_SVG = NO
2369
2370# The DOT_PATH tag can be used to specify the path where the dot tool can be
2371# found. If left blank, it is assumed the dot tool can be found in the path.
2372# This tag requires that the tag HAVE_DOT is set to YES.
2373
2374DOT_PATH =
2375
2376# The DOTFILE_DIRS tag can be used to specify one or more directories that
2377# contain dot files that are included in the documentation (see the \dotfile
2378# command).
2379# This tag requires that the tag HAVE_DOT is set to YES.
2380
2381DOTFILE_DIRS =
2382
2383# The MSCFILE_DIRS tag can be used to specify one or more directories that
2384# contain msc files that are included in the documentation (see the \mscfile
2385# command).
2386
2387MSCFILE_DIRS =
2388
2389# The DIAFILE_DIRS tag can be used to specify one or more directories that
2390# contain dia files that are included in the documentation (see the \diafile
2391# command).
2392
2393DIAFILE_DIRS =
2394
2395# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2396# path where java can find the plantuml.jar file. If left blank, it is assumed
2397# PlantUML is not used or called during a preprocessing step. Doxygen will
2398# generate a warning when it encounters a \startuml command in this case and
2399# will not generate output for the diagram.
Michal Vasko51cda3c2016-01-29 14:41:26 +01002400
2401PLANTUML_JAR_PATH =
2402
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002403# When using plantuml, the specified paths are searched for files specified by
2404# the !include statement in a plantuml block.
2405
2406PLANTUML_INCLUDE_PATH =
2407
Michal Vasko51cda3c2016-01-29 14:41:26 +01002408# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2409# that will be shown in the graph. If the number of nodes in a graph becomes
2410# larger than this value, doxygen will truncate the graph, which is visualized
2411# by representing a node as a red box. Note that doxygen if the number of direct
2412# children of the root node in a graph is already larger than
2413# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2414# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2415# Minimum value: 0, maximum value: 10000, default value: 50.
2416# This tag requires that the tag HAVE_DOT is set to YES.
2417
2418DOT_GRAPH_MAX_NODES = 50
2419
2420# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2421# generated by dot. A depth value of 3 means that only nodes reachable from the
2422# root by following a path via at most 3 edges will be shown. Nodes that lay
2423# further from the root node will be omitted. Note that setting this option to 1
2424# or 2 may greatly reduce the computation time needed for large code bases. Also
2425# note that the size of a graph can be further restricted by
2426# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2427# Minimum value: 0, maximum value: 1000, default value: 0.
2428# This tag requires that the tag HAVE_DOT is set to YES.
2429
2430MAX_DOT_GRAPH_DEPTH = 0
2431
2432# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2433# background. This is disabled by default, because dot on Windows does not seem
2434# to support this out of the box.
2435#
2436# Warning: Depending on the platform used, enabling this option may lead to
2437# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2438# read).
2439# The default value is: NO.
2440# This tag requires that the tag HAVE_DOT is set to YES.
2441
2442DOT_TRANSPARENT = NO
2443
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002444# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
Michal Vasko51cda3c2016-01-29 14:41:26 +01002445# files in one run (i.e. multiple -o and -T options on the command line). This
2446# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2447# this, this feature is disabled by default.
2448# The default value is: NO.
2449# This tag requires that the tag HAVE_DOT is set to YES.
2450
2451DOT_MULTI_TARGETS = NO
2452
2453# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2454# explaining the meaning of the various boxes and arrows in the dot generated
2455# graphs.
2456# The default value is: YES.
2457# This tag requires that the tag HAVE_DOT is set to YES.
2458
2459GENERATE_LEGEND = YES
2460
Radek Krejcif56c6ea2017-05-19 09:43:57 +02002461# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
Michal Vasko51cda3c2016-01-29 14:41:26 +01002462# files that are used to generate the various graphs.
2463# The default value is: YES.
2464# This tag requires that the tag HAVE_DOT is set to YES.
2465
2466DOT_CLEANUP = YES