source: doc/Doxyfile@ 640:93acd05a8c64

Last change on this file since 640:93acd05a8c64 was 581:68cc554b5ca5, checked in by István Váradi <ivaradi@…>, 10 years ago

Yet another update to the Doxygen configuration file to be compatible with the slightly older version of Doxygen on the server

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