source: trunk/zoo-project/zoo-kernel/Doxyfile @ 695

Last change on this file since 695 was 608, checked in by djay, 5 years ago

Add Doxygen documentation configuration file and index.

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

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png