source: branches/stable/Doxyfile

Last change on this file was 17645, checked in by westram, 6 years ago

update doxygen docs:

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