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