source: vscpl/doc/Doxyfile@ 28:9b3c2d3ea9f3

Last change on this file since 28:9b3c2d3ea9f3 was 24:f60eded155f3, checked in by István Váradi <ivaradi@…>, 7 years ago

Update Doxyfile to be compatible with the current doxygen version

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