source: XIOS/dev/dev_olga/Doxyfile @ 1054

Last change on this file since 1054 was 1054, checked in by oabramkina, 4 years ago

dev: intermediate commit.

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