we do not want to ship .svn directories
[libt2n] / doc / Doxyfile.in
CommitLineData
59adb9e2
TJ
1# Doxyfile 1.4.7-4
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# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18# by quotes) that should identify the project.
19
20PROJECT_NAME = @PACKAGE@
21
22# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or
24# if some version control system is used.
25
26PROJECT_NUMBER = @VERSION@
27
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29# base path where the generated documentation will be put.
30# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.
32
33OUTPUT_DIRECTORY =
34
35# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36# 4096 sub-directories (in 2 levels) under the output directory of each output
37# format and will distribute the generated files over these directories.
38# Enabling this option can be useful when feeding doxygen a huge amount of
39# source files, where putting all generated files in the same directory would
40# otherwise cause performance problems for the file system.
41
42CREATE_SUBDIRS = NO
43
44# The OUTPUT_LANGUAGE tag is used to specify the language in which all
45# documentation generated by doxygen is written. Doxygen will use this
46# information to generate all constant output in the proper language.
47# The default language is English, other supported languages are:
48# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
49# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
50# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
51# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
52# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
53
54OUTPUT_LANGUAGE = English
55
56# This tag can be used to specify the encoding used in the generated output.
57# The encoding is not always determined by the language that is chosen,
58# but also whether or not the output is meant for Windows or non-Windows users.
59# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
60# forces the Windows encoding (this is the default for the Windows binary),
61# whereas setting the tag to NO uses a Unix-style encoding (the default for
62# all platforms other than Windows).
63
64USE_WINDOWS_ENCODING = NO
65
66# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
67# include brief member descriptions after the members that are listed in
68# the file and class documentation (similar to JavaDoc).
69# Set to NO to disable this.
70
71BRIEF_MEMBER_DESC = YES
72
73# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
74# the brief description of a member or function before the detailed description.
75# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
76# brief descriptions will be completely suppressed.
77
78REPEAT_BRIEF = YES
79
80# This tag implements a quasi-intelligent brief description abbreviator
81# that is used to form the text in various listings. Each string
82# in this list, if found as the leading text of the brief description, will be
83# stripped from the text and the result after processing the whole list, is
84# used as the annotated text. Otherwise, the brief description is used as-is.
85# If left blank, the following values are used ("$name" is automatically
86# replaced with the name of the entity): "The $name class" "The $name widget"
87# "The $name file" "is" "provides" "specifies" "contains"
88# "represents" "a" "an" "the"
89
90ABBREVIATE_BRIEF =
91
92# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
93# Doxygen will generate a detailed section even if there is only a brief
94# description.
95
96ALWAYS_DETAILED_SEC = NO
97
98# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
99# inherited members of a class in the documentation of that class as if those
100# members were ordinary class members. Constructors, destructors and assignment
101# operators of the base classes will not be shown.
102
103INLINE_INHERITED_MEMB = NO
104
105# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
106# path before files name in the file list and in the header files. If set
107# to NO the shortest path that makes the file name unique will be used.
108
109FULL_PATH_NAMES = NO
110
111# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
112# can be used to strip a user-defined part of the path. Stripping is
113# only done if one of the specified strings matches the left-hand part of
114# the path. The tag can be used to show relative paths in the file list.
115# If left blank the directory from which doxygen is run is used as the
116# path to strip.
117
118STRIP_FROM_PATH =
119
120# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
121# the path mentioned in the documentation of a class, which tells
122# the reader which header file to include in order to use a class.
123# If left blank only the name of the header file containing the class
124# definition is used. Otherwise one should specify the include paths that
125# are normally passed to the compiler using the -I flag.
126
127STRIP_FROM_INC_PATH =
128
129# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
130# (but less readable) file names. This can be useful is your file systems
131# doesn't support long names like on DOS, Mac, or CD-ROM.
132
133SHORT_NAMES = NO
134
135# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
136# will interpret the first line (until the first dot) of a JavaDoc-style
137# comment as the brief description. If set to NO, the JavaDoc
138# comments will behave just like the Qt-style comments (thus requiring an
139# explicit @brief command for a brief description.
140
141JAVADOC_AUTOBRIEF = NO
142
143# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
144# treat a multi-line C++ special comment block (i.e. a block of //! or ///
145# comments) as a brief description. This used to be the default behaviour.
146# The new default is to treat a multi-line C++ comment block as a detailed
147# description. Set this tag to YES if you prefer the old behaviour instead.
148
149MULTILINE_CPP_IS_BRIEF = NO
150
151# If the DETAILS_AT_TOP tag is set to YES then Doxygen
152# will output the detailed description near the top, like JavaDoc.
153# If set to NO, the detailed description appears after the member
154# documentation.
155
156DETAILS_AT_TOP = NO
157
158# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159# member inherits the documentation from any documented member that it
160# re-implements.
161
162INHERIT_DOCS = YES
163
164# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165# a new page for each member. If set to NO, the documentation of a member will
166# be part of the file/class/namespace that contains it.
167
168SEPARATE_MEMBER_PAGES = NO
169
170# The TAB_SIZE tag can be used to set the number of spaces in a tab.
171# Doxygen uses this value to replace tabs by spaces in code fragments.
172
173TAB_SIZE = 4
174
175# This tag can be used to specify a number of aliases that acts
176# as commands in the documentation. An alias has the form "name=value".
177# For example adding "sideeffect=\par Side Effects:\n" will allow you to
178# put the command \sideeffect (or @sideeffect) in the documentation, which
179# will result in a user-defined paragraph with heading "Side Effects:".
180# You can put \n's in the value part of an alias to insert newlines.
181
182ALIASES =
183
184# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185# sources only. Doxygen will then generate output that is more tailored for C.
186# For instance, some of the names that are used will be different. The list
187# of all members will be omitted, etc.
188
189OPTIMIZE_OUTPUT_FOR_C = NO
190
191# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192# sources only. Doxygen will then generate output that is more tailored for Java.
193# For instance, namespaces will be presented as packages, qualified scopes
194# will look different, etc.
195
196OPTIMIZE_OUTPUT_JAVA = NO
197
198# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
199# include (a tag file for) the STL sources as input, then you should
200# set this tag to YES in order to let doxygen match functions declarations and
201# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
202# func(std::string) {}). This also make the inheritance and collaboration
203# diagrams that involve STL classes more complete and accurate.
204
205BUILTIN_STL_SUPPORT = NO
206
207# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
208# tag is set to YES, then doxygen will reuse the documentation of the first
209# member in the group (if any) for the other members of the group. By default
210# all members of a group must be documented explicitly.
211
212DISTRIBUTE_GROUP_DOC = NO
213
214# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
215# the same type (for instance a group of public functions) to be put as a
216# subgroup of that type (e.g. under the Public Functions section). Set it to
217# NO to prevent subgrouping. Alternatively, this can be done per class using
218# the \nosubgrouping command.
219
220SUBGROUPING = YES
221
222#---------------------------------------------------------------------------
223# Build related configuration options
224#---------------------------------------------------------------------------
225
226# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
227# documentation are documented, even if no documentation was available.
228# Private class members and static file members will be hidden unless
229# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
230
231EXTRACT_ALL = NO
232
233# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
234# will be included in the documentation.
235
236EXTRACT_PRIVATE = NO
237
238# If the EXTRACT_STATIC tag is set to YES all static members of a file
239# will be included in the documentation.
240
241EXTRACT_STATIC = NO
242
243# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
244# defined locally in source files will be included in the documentation.
245# If set to NO only classes defined in header files are included.
246
247EXTRACT_LOCAL_CLASSES = YES
248
249# This flag is only useful for Objective-C code. When set to YES local
250# methods, which are defined in the implementation section but not in
251# the interface are included in the documentation.
252# If set to NO (the default) only methods in the interface are included.
253
254EXTRACT_LOCAL_METHODS = NO
255
256# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
257# undocumented members of documented classes, files or namespaces.
258# If set to NO (the default) these members will be included in the
259# various overviews, but no documentation section is generated.
260# This option has no effect if EXTRACT_ALL is enabled.
261
262HIDE_UNDOC_MEMBERS = NO
263
264# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
265# undocumented classes that are normally visible in the class hierarchy.
266# If set to NO (the default) these classes will be included in the various
267# overviews. This option has no effect if EXTRACT_ALL is enabled.
268
269HIDE_UNDOC_CLASSES = NO
270
271# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
272# friend (class|struct|union) declarations.
273# If set to NO (the default) these declarations will be included in the
274# documentation.
275
276HIDE_FRIEND_COMPOUNDS = NO
277
278# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
279# documentation blocks found inside the body of a function.
280# If set to NO (the default) these blocks will be appended to the
281# function's detailed documentation block.
282
283HIDE_IN_BODY_DOCS = NO
284
285# The INTERNAL_DOCS tag determines if documentation
286# that is typed after a \internal command is included. If the tag is set
287# to NO (the default) then the documentation will be excluded.
288# Set it to YES to include the internal documentation.
289
290INTERNAL_DOCS = NO
291
292# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
293# file names in lower-case letters. If set to YES upper-case letters are also
294# allowed. This is useful if you have classes or files whose names only differ
295# in case and if your file system supports case sensitive file names. Windows
296# and Mac users are advised to set this option to NO.
297
298CASE_SENSE_NAMES = YES
299
300# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
301# will show members with their full class and namespace scopes in the
302# documentation. If set to YES the scope will be hidden.
303
304HIDE_SCOPE_NAMES = NO
305
306# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
307# will put a list of the files that are included by a file in the documentation
308# of that file.
309
310SHOW_INCLUDE_FILES = YES
311
312# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
313# is inserted in the documentation for inline members.
314
315INLINE_INFO = YES
316
317# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
318# will sort the (detailed) documentation of file and class members
319# alphabetically by member name. If set to NO the members will appear in
320# declaration order.
321
322SORT_MEMBER_DOCS = YES
323
324# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
325# brief documentation of file, namespace and class members alphabetically
326# by member name. If set to NO (the default) the members will appear in
327# declaration order.
328
329SORT_BRIEF_DOCS = NO
330
331# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
332# sorted by fully-qualified names, including namespaces. If set to
333# NO (the default), the class list will be sorted only by class name,
334# not including the namespace part.
335# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
336# Note: This option applies only to the class list, not to the
337# alphabetical list.
338
339SORT_BY_SCOPE_NAME = NO
340
341# The GENERATE_TODOLIST tag can be used to enable (YES) or
342# disable (NO) the todo list. This list is created by putting \todo
343# commands in the documentation.
344
345GENERATE_TODOLIST = YES
346
347# The GENERATE_TESTLIST tag can be used to enable (YES) or
348# disable (NO) the test list. This list is created by putting \test
349# commands in the documentation.
350
351GENERATE_TESTLIST = YES
352
353# The GENERATE_BUGLIST tag can be used to enable (YES) or
354# disable (NO) the bug list. This list is created by putting \bug
355# commands in the documentation.
356
357GENERATE_BUGLIST = YES
358
359# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
360# disable (NO) the deprecated list. This list is created by putting
361# \deprecated commands in the documentation.
362
363GENERATE_DEPRECATEDLIST= YES
364
365# The ENABLED_SECTIONS tag can be used to enable conditional
366# documentation sections, marked by \if sectionname ... \endif.
367
368ENABLED_SECTIONS =
369
370# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
371# the initial value of a variable or define consists of for it to appear in
372# the documentation. If the initializer consists of more lines than specified
373# here it will be hidden. Use a value of 0 to hide initializers completely.
374# The appearance of the initializer of individual variables and defines in the
375# documentation can be controlled using \showinitializer or \hideinitializer
376# command in the documentation regardless of this setting.
377
378MAX_INITIALIZER_LINES = 30
379
380# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
381# at the bottom of the documentation of classes and structs. If set to YES the
382# list will mention the files that were used to generate the documentation.
383
384SHOW_USED_FILES = YES
385
386# If the sources in your project are distributed over multiple directories
387# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
388# in the documentation. The default is NO.
389
390SHOW_DIRECTORIES = NO
391
392# The FILE_VERSION_FILTER tag can be used to specify a program or script that
393# doxygen should invoke to get the current version for each file (typically from the
394# version control system). Doxygen will invoke the program by executing (via
395# popen()) the command <command> <input-file>, where <command> is the value of
396# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
397# provided by doxygen. Whatever the program writes to standard output
398# is used as the file version. See the manual for examples.
399
400FILE_VERSION_FILTER =
401
402#---------------------------------------------------------------------------
403# configuration options related to warning and progress messages
404#---------------------------------------------------------------------------
405
406# The QUIET tag can be used to turn on/off the messages that are generated
407# by doxygen. Possible values are YES and NO. If left blank NO is used.
408
409QUIET = NO
410
411# The WARNINGS tag can be used to turn on/off the warning messages that are
412# generated by doxygen. Possible values are YES and NO. If left blank
413# NO is used.
414
415WARNINGS = YES
416
417# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
418# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
419# automatically be disabled.
420
421WARN_IF_UNDOCUMENTED = YES
422
423# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
424# potential errors in the documentation, such as not documenting some
425# parameters in a documented function, or documenting parameters that
426# don't exist or using markup commands wrongly.
427
428WARN_IF_DOC_ERROR = YES
429
430# This WARN_NO_PARAMDOC option can be abled to get warnings for
431# functions that are documented, but have no documentation for their parameters
432# or return value. If set to NO (the default) doxygen will only warn about
433# wrong or incomplete parameter documentation, but not about the absence of
434# documentation.
435
436WARN_NO_PARAMDOC = NO
437
438# The WARN_FORMAT tag determines the format of the warning messages that
439# doxygen can produce. The string should contain the $file, $line, and $text
440# tags, which will be replaced by the file and line number from which the
441# warning originated and the warning text. Optionally the format may contain
442# $version, which will be replaced by the version of the file (if it could
443# be obtained via FILE_VERSION_FILTER)
444
445WARN_FORMAT = "$file:$line: $text"
446
447# The WARN_LOGFILE tag can be used to specify a file to which warning
448# and error messages should be written. If left blank the output is written
449# to stderr.
450
451WARN_LOGFILE =
452
453#---------------------------------------------------------------------------
454# configuration options related to the input files
455#---------------------------------------------------------------------------
456
457# The INPUT tag can be used to specify the files and/or directories that contain
458# documented source files. You may enter file names like "myfile.cpp" or
459# directories like "/usr/src/myproject". Separate the files or directories
460# with spaces.
461
fc922d87
JT
462# todo: is it possible to use shell variables here?
463
464INPUT = . ../src ../codegen
59adb9e2
TJ
465
466# If the value of the INPUT tag contains directories, you can use the
467# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
468# and *.h) to filter out the source-files in the directories. If left
469# blank the following patterns are tested:
470# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
471# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
472
fc922d87 473FILE_PATTERNS = *.hxx *.cpp *.doc
59adb9e2
TJ
474
475# The RECURSIVE tag can be used to turn specify whether or not subdirectories
476# should be searched for input files as well. Possible values are YES and NO.
477# If left blank NO is used.
478
479RECURSIVE = NO
480
481# The EXCLUDE tag can be used to specify files and/or directories that should
482# excluded from the INPUT source files. This way you can easily exclude a
483# subdirectory from a directory tree whose root is specified with the INPUT tag.
484
485EXCLUDE =
486
487# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
488# directories that are symbolic links (a Unix filesystem feature) are excluded
489# from the input.
490
491EXCLUDE_SYMLINKS = NO
492
493# If the value of the INPUT tag contains directories, you can use the
494# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
495# certain files from those directories. Note that the wildcards are matched
496# against the file with absolute path, so to exclude all test directories
497# for example use the pattern */test/*
498
499EXCLUDE_PATTERNS =
500
501# The EXAMPLE_PATH tag can be used to specify one or more files or
502# directories that contain example code fragments that are included (see
503# the \include command).
504
6e434d1f 505EXAMPLE_PATH = ../examples-codegen/example1/ ../examples-codegen/example1-client/
59adb9e2
TJ
506
507# If the value of the EXAMPLE_PATH tag contains directories, you can use the
508# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
509# and *.h) to filter out the source-files in the directories. If left
510# blank all files are included.
511
512EXAMPLE_PATTERNS =
513
514# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
515# searched for input files to be used with the \include or \dontinclude
516# commands irrespective of the value of the RECURSIVE tag.
517# Possible values are YES and NO. If left blank NO is used.
518
519EXAMPLE_RECURSIVE = NO
520
521# The IMAGE_PATH tag can be used to specify one or more files or
522# directories that contain image that are included in the documentation (see
523# the \image command).
524
525IMAGE_PATH =
526
527# The INPUT_FILTER tag can be used to specify a program that doxygen should
528# invoke to filter for each input file. Doxygen will invoke the filter program
529# by executing (via popen()) the command <filter> <input-file>, where <filter>
530# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
531# input file. Doxygen will then use the output that the filter program writes
532# to standard output. If FILTER_PATTERNS is specified, this tag will be
533# ignored.
534
535INPUT_FILTER =
536
537# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
538# basis. Doxygen will compare the file name with each pattern and apply the
539# filter if there is a match. The filters are a list of the form:
540# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
541# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
542# is applied to all files.
543
544FILTER_PATTERNS =
545
546# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
547# INPUT_FILTER) will be used to filter the input files when producing source
548# files to browse (i.e. when SOURCE_BROWSER is set to YES).
549
550FILTER_SOURCE_FILES = NO
551
552#---------------------------------------------------------------------------
553# configuration options related to source browsing
554#---------------------------------------------------------------------------
555
556# If the SOURCE_BROWSER tag is set to YES then a list of source files will
557# be generated. Documented entities will be cross-referenced with these sources.
558# Note: To get rid of all source code in the generated output, make sure also
559# VERBATIM_HEADERS is set to NO.
560
561SOURCE_BROWSER = NO
562
563# Setting the INLINE_SOURCES tag to YES will include the body
564# of functions and classes directly in the documentation.
565
566INLINE_SOURCES = NO
567
568# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
569# doxygen to hide any special comment blocks from generated source code
570# fragments. Normal C and C++ comments will always remain visible.
571
572STRIP_CODE_COMMENTS = YES
573
574# If the REFERENCED_BY_RELATION tag is set to YES (the default)
575# then for each documented function all documented
576# functions referencing it will be listed.
577
578REFERENCED_BY_RELATION = YES
579
580# If the REFERENCES_RELATION tag is set to YES (the default)
581# then for each documented function all documented entities
582# called/used by that function will be listed.
583
584REFERENCES_RELATION = YES
585
586# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
587# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
588# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
589# link to the source code. Otherwise they will link to the documentstion.
590
591REFERENCES_LINK_SOURCE = YES
592
593# If the USE_HTAGS tag is set to YES then the references to source code
594# will point to the HTML generated by the htags(1) tool instead of doxygen
595# built-in source browser. The htags tool is part of GNU's global source
596# tagging system (see http://www.gnu.org/software/global/global.html). You
597# will need version 4.8.6 or higher.
598
599USE_HTAGS = NO
600
601# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
602# will generate a verbatim copy of the header file for each class for
603# which an include is specified. Set to NO to disable this.
604
605VERBATIM_HEADERS = YES
606
607#---------------------------------------------------------------------------
608# configuration options related to the alphabetical class index
609#---------------------------------------------------------------------------
610
611# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
612# of all compounds will be generated. Enable this if the project
613# contains a lot of classes, structs, unions or interfaces.
614
615ALPHABETICAL_INDEX = NO
616
617# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
618# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
619# in which this list will be split (can be a number in the range [1..20])
620
621COLS_IN_ALPHA_INDEX = 5
622
623# In case all classes in a project start with a common prefix, all
624# classes will be put under the same header in the alphabetical index.
625# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
626# should be ignored while generating the index headers.
627
628IGNORE_PREFIX =
629
630#---------------------------------------------------------------------------
631# configuration options related to the HTML output
632#---------------------------------------------------------------------------
633
634# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
635# generate HTML output.
636
637GENERATE_HTML = YES
638
639# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
640# If a relative path is entered the value of OUTPUT_DIRECTORY will be
641# put in front of it. If left blank `html' will be used as the default path.
642
643HTML_OUTPUT = html
644
645# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
646# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
647# doxygen will generate files with .html extension.
648
649HTML_FILE_EXTENSION = .html
650
651# The HTML_HEADER tag can be used to specify a personal HTML header for
652# each generated HTML page. If it is left blank doxygen will generate a
653# standard header.
654
655HTML_HEADER =
656
657# The HTML_FOOTER tag can be used to specify a personal HTML footer for
658# each generated HTML page. If it is left blank doxygen will generate a
659# standard footer.
660
661HTML_FOOTER =
662
663# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
664# style sheet that is used by each HTML page. It can be used to
665# fine-tune the look of the HTML output. If the tag is left blank doxygen
666# will generate a default style sheet. Note that doxygen will try to copy
667# the style sheet file to the HTML output directory, so don't put your own
668# stylesheet in the HTML output directory as well, or it will be erased!
669
670HTML_STYLESHEET =
671
672# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
673# files or namespaces will be aligned in HTML using tables. If set to
674# NO a bullet list will be used.
675
676HTML_ALIGN_MEMBERS = YES
677
678# If the GENERATE_HTMLHELP tag is set to YES, additional index files
679# will be generated that can be used as input for tools like the
680# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
681# of the generated HTML documentation.
682
683GENERATE_HTMLHELP = NO
684
685# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
686# be used to specify the file name of the resulting .chm file. You
687# can add a path in front of the file if the result should not be
688# written to the html output directory.
689
690CHM_FILE =
691
692# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
693# be used to specify the location (absolute path including file name) of
694# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
695# the HTML help compiler on the generated index.hhp.
696
697HHC_LOCATION =
698
699# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
700# controls if a separate .chi index file is generated (YES) or that
701# it should be included in the master .chm file (NO).
702
703GENERATE_CHI = NO
704
705# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
706# controls whether a binary table of contents is generated (YES) or a
707# normal table of contents (NO) in the .chm file.
708
709BINARY_TOC = NO
710
711# The TOC_EXPAND flag can be set to YES to add extra items for group members
712# to the contents of the HTML help documentation and to the tree view.
713
714TOC_EXPAND = NO
715
716# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
717# top of each HTML page. The value NO (the default) enables the index and
718# the value YES disables it.
719
720DISABLE_INDEX = NO
721
722# This tag can be used to set the number of enum values (range [1..20])
723# that doxygen will group on one line in the generated HTML documentation.
724
725ENUM_VALUES_PER_LINE = 4
726
727# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
728# generated containing a tree-like index structure (just like the one that
729# is generated for HTML Help). For this to work a browser that supports
730# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
731# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
732# probably better off using the HTML help feature.
733
734GENERATE_TREEVIEW = NO
735
736# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
737# used to set the initial width (in pixels) of the frame in which the tree
738# is shown.
739
740TREEVIEW_WIDTH = 250
741
742#---------------------------------------------------------------------------
743# configuration options related to the LaTeX output
744#---------------------------------------------------------------------------
745
746# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
747# generate Latex output.
748
749GENERATE_LATEX = NO
750
751# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
752# If a relative path is entered the value of OUTPUT_DIRECTORY will be
753# put in front of it. If left blank `latex' will be used as the default path.
754
755LATEX_OUTPUT = latex
756
757# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
758# invoked. If left blank `latex' will be used as the default command name.
759
760LATEX_CMD_NAME = latex
761
762# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
763# generate index for LaTeX. If left blank `makeindex' will be used as the
764# default command name.
765
766MAKEINDEX_CMD_NAME = makeindex
767
768# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
769# LaTeX documents. This may be useful for small projects and may help to
770# save some trees in general.
771
772COMPACT_LATEX = NO
773
774# The PAPER_TYPE tag can be used to set the paper type that is used
775# by the printer. Possible values are: a4, a4wide, letter, legal and
776# executive. If left blank a4wide will be used.
777
778PAPER_TYPE = a4wide
779
780# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
781# packages that should be included in the LaTeX output.
782
783EXTRA_PACKAGES =
784
785# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
786# the generated latex document. The header should contain everything until
787# the first chapter. If it is left blank doxygen will generate a
788# standard header. Notice: only use this tag if you know what you are doing!
789
790LATEX_HEADER =
791
792# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
793# is prepared for conversion to pdf (using ps2pdf). The pdf file will
794# contain links (just like the HTML output) instead of page references
795# This makes the output suitable for online browsing using a pdf viewer.
796
797PDF_HYPERLINKS = NO
798
799# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
800# plain latex in the generated Makefile. Set this option to YES to get a
801# higher quality PDF documentation.
802
803USE_PDFLATEX = NO
804
805# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
806# command to the generated LaTeX files. This will instruct LaTeX to keep
807# running if errors occur, instead of asking the user for help.
808# This option is also used when generating formulas in HTML.
809
810LATEX_BATCHMODE = NO
811
812# If LATEX_HIDE_INDICES is set to YES then doxygen will not
813# include the index chapters (such as File Index, Compound Index, etc.)
814# in the output.
815
816LATEX_HIDE_INDICES = NO
817
818#---------------------------------------------------------------------------
819# configuration options related to the RTF output
820#---------------------------------------------------------------------------
821
822# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
823# The RTF output is optimized for Word 97 and may not look very pretty with
824# other RTF readers or editors.
825
826GENERATE_RTF = NO
827
828# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
829# If a relative path is entered the value of OUTPUT_DIRECTORY will be
830# put in front of it. If left blank `rtf' will be used as the default path.
831
832RTF_OUTPUT = rtf
833
834# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
835# RTF documents. This may be useful for small projects and may help to
836# save some trees in general.
837
838COMPACT_RTF = NO
839
840# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
841# will contain hyperlink fields. The RTF file will
842# contain links (just like the HTML output) instead of page references.
843# This makes the output suitable for online browsing using WORD or other
844# programs which support those fields.
845# Note: wordpad (write) and others do not support links.
846
847RTF_HYPERLINKS = NO
848
849# Load stylesheet definitions from file. Syntax is similar to doxygen's
850# config file, i.e. a series of assignments. You only have to provide
851# replacements, missing definitions are set to their default value.
852
853RTF_STYLESHEET_FILE =
854
855# Set optional variables used in the generation of an rtf document.
856# Syntax is similar to doxygen's config file.
857
858RTF_EXTENSIONS_FILE =
859
860#---------------------------------------------------------------------------
861# configuration options related to the man page output
862#---------------------------------------------------------------------------
863
864# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
865# generate man pages
866
867GENERATE_MAN = NO
868
869# The MAN_OUTPUT tag is used to specify where the man pages will be put.
870# If a relative path is entered the value of OUTPUT_DIRECTORY will be
871# put in front of it. If left blank `man' will be used as the default path.
872
873MAN_OUTPUT = man
874
875# The MAN_EXTENSION tag determines the extension that is added to
876# the generated man pages (default is the subroutine's section .3)
877
878MAN_EXTENSION = .3
879
880# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
881# then it will generate one additional man file for each entity
882# documented in the real man page(s). These additional files
883# only source the real man page, but without them the man command
884# would be unable to find the correct page. The default is NO.
885
886MAN_LINKS = NO
887
888#---------------------------------------------------------------------------
889# configuration options related to the XML output
890#---------------------------------------------------------------------------
891
892# If the GENERATE_XML tag is set to YES Doxygen will
893# generate an XML file that captures the structure of
894# the code including all documentation.
895
896GENERATE_XML = NO
897
898# The XML_OUTPUT tag is used to specify where the XML pages will be put.
899# If a relative path is entered the value of OUTPUT_DIRECTORY will be
900# put in front of it. If left blank `xml' will be used as the default path.
901
902XML_OUTPUT = xml
903
904# The XML_SCHEMA tag can be used to specify an XML schema,
905# which can be used by a validating XML parser to check the
906# syntax of the XML files.
907
908XML_SCHEMA =
909
910# The XML_DTD tag can be used to specify an XML DTD,
911# which can be used by a validating XML parser to check the
912# syntax of the XML files.
913
914XML_DTD =
915
916# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
917# dump the program listings (including syntax highlighting
918# and cross-referencing information) to the XML output. Note that
919# enabling this will significantly increase the size of the XML output.
920
921XML_PROGRAMLISTING = YES
922
923#---------------------------------------------------------------------------
924# configuration options for the AutoGen Definitions output
925#---------------------------------------------------------------------------
926
927# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
928# generate an AutoGen Definitions (see autogen.sf.net) file
929# that captures the structure of the code including all
930# documentation. Note that this feature is still experimental
931# and incomplete at the moment.
932
933GENERATE_AUTOGEN_DEF = NO
934
935#---------------------------------------------------------------------------
936# configuration options related to the Perl module output
937#---------------------------------------------------------------------------
938
939# If the GENERATE_PERLMOD tag is set to YES Doxygen will
940# generate a Perl module file that captures the structure of
941# the code including all documentation. Note that this
942# feature is still experimental and incomplete at the
943# moment.
944
945GENERATE_PERLMOD = NO
946
947# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
948# the necessary Makefile rules, Perl scripts and LaTeX code to be able
949# to generate PDF and DVI output from the Perl module output.
950
951PERLMOD_LATEX = NO
952
953# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
954# nicely formatted so it can be parsed by a human reader. This is useful
955# if you want to understand what is going on. On the other hand, if this
956# tag is set to NO the size of the Perl module output will be much smaller
957# and Perl will parse it just the same.
958
959PERLMOD_PRETTY = YES
960
961# The names of the make variables in the generated doxyrules.make file
962# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
963# This is useful so different doxyrules.make files included by the same
964# Makefile don't overwrite each other's variables.
965
966PERLMOD_MAKEVAR_PREFIX =
967
968#---------------------------------------------------------------------------
969# Configuration options related to the preprocessor
970#---------------------------------------------------------------------------
971
972# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
973# evaluate all C-preprocessor directives found in the sources and include
974# files.
975
976ENABLE_PREPROCESSING = YES
977
978# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
979# names in the source code. If set to NO (the default) only conditional
980# compilation will be performed. Macro expansion can be done in a controlled
981# way by setting EXPAND_ONLY_PREDEF to YES.
982
983MACRO_EXPANSION = NO
984
985# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
986# then the macro expansion is limited to the macros specified with the
987# PREDEFINED and EXPAND_AS_DEFINED tags.
988
989EXPAND_ONLY_PREDEF = NO
990
991# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
992# in the INCLUDE_PATH (see below) will be search if a #include is found.
993
994SEARCH_INCLUDES = YES
995
996# The INCLUDE_PATH tag can be used to specify one or more directories that
997# contain include files that are not input files but should be processed by
998# the preprocessor.
999
1000INCLUDE_PATH =
1001
1002# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1003# patterns (like *.h and *.hpp) to filter out the header-files in the
1004# directories. If left blank, the patterns specified with FILE_PATTERNS will
1005# be used.
1006
1007INCLUDE_FILE_PATTERNS =
1008
1009# The PREDEFINED tag can be used to specify one or more macro names that
1010# are defined before the preprocessor is started (similar to the -D option of
1011# gcc). The argument of the tag is a list of macros of the form: name
1012# or name=definition (no spaces). If the definition and the = are
1013# omitted =1 is assumed. To prevent a macro definition from being
1014# undefined via #undef or recursively expanded use the := operator
1015# instead of the = operator.
1016
1017PREDEFINED =
1018
1019# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1020# this tag can be used to specify a list of macro names that should be expanded.
1021# The macro definition that is found in the sources will be used.
1022# Use the PREDEFINED tag if you want to use a different macro definition.
1023
1024EXPAND_AS_DEFINED =
1025
1026# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1027# doxygen's preprocessor will remove all function-like macros that are alone
1028# on a line, have an all uppercase name, and do not end with a semicolon. Such
1029# function macros are typically used for boiler-plate code, and will confuse
1030# the parser if not removed.
1031
1032SKIP_FUNCTION_MACROS = YES
1033
1034#---------------------------------------------------------------------------
1035# Configuration::additions related to external references
1036#---------------------------------------------------------------------------
1037
1038# The TAGFILES option can be used to specify one or more tagfiles.
1039# Optionally an initial location of the external documentation
1040# can be added for each tagfile. The format of a tag file without
1041# this location is as follows:
1042# TAGFILES = file1 file2 ...
1043# Adding location for the tag files is done as follows:
1044# TAGFILES = file1=loc1 "file2 = loc2" ...
1045# where "loc1" and "loc2" can be relative or absolute paths or
1046# URLs. If a location is present for each tag, the installdox tool
1047# does not have to be run to correct the links.
1048# Note that each tag file must have a unique name
1049# (where the name does NOT include the path)
1050# If a tag file is not located in the directory in which doxygen
1051# is run, you must also specify the path to the tagfile here.
1052
1053TAGFILES =
1054
1055# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1056# a tag file that is based on the input files it reads.
1057
6e434d1f 1058# GENERATE_TAGFILE = libt2n.tag
59adb9e2
TJ
1059
1060# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1061# in the class index. If set to NO only the inherited external classes
1062# will be listed.
1063
1064ALLEXTERNALS = NO
1065
1066# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1067# in the modules index. If set to NO, only the current project's groups will
1068# be listed.
1069
1070EXTERNAL_GROUPS = YES
1071
1072# The PERL_PATH should be the absolute path and name of the perl script
1073# interpreter (i.e. the result of `which perl').
1074
1075PERL_PATH = /usr/bin/perl
1076
1077#---------------------------------------------------------------------------
1078# Configuration options related to the dot tool
1079#---------------------------------------------------------------------------
1080
1081# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1082# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1083# or super classes. Setting the tag to NO turns the diagrams off. Note that
1084# this option is superseded by the HAVE_DOT option below. This is only a
1085# fallback. It is recommended to install and use dot, since it yields more
1086# powerful graphs.
1087
1088CLASS_DIAGRAMS = YES
1089
1090# If set to YES, the inheritance and collaboration graphs will hide
1091# inheritance and usage relations if the target is undocumented
1092# or is not a class.
1093
1094HIDE_UNDOC_RELATIONS = YES
1095
1096# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1097# available from the path. This tool is part of Graphviz, a graph visualization
1098# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1099# have no effect if this option is set to NO (the default)
1100
1101HAVE_DOT = NO
1102
1103# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1104# will generate a graph for each documented class showing the direct and
1105# indirect inheritance relations. Setting this tag to YES will force the
1106# the CLASS_DIAGRAMS tag to NO.
1107
1108CLASS_GRAPH = YES
1109
1110# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1111# will generate a graph for each documented class showing the direct and
1112# indirect implementation dependencies (inheritance, containment, and
1113# class references variables) of the class with other documented classes.
1114
1115COLLABORATION_GRAPH = YES
1116
1117# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1118# will generate a graph for groups, showing the direct groups dependencies
1119
1120GROUP_GRAPHS = YES
1121
1122# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1123# collaboration diagrams in a style similar to the OMG's Unified Modeling
1124# Language.
1125
1126UML_LOOK = NO
1127
1128# If set to YES, the inheritance and collaboration graphs will show the
1129# relations between templates and their instances.
1130
1131TEMPLATE_RELATIONS = NO
1132
1133# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1134# tags are set to YES then doxygen will generate a graph for each documented
1135# file showing the direct and indirect include dependencies of the file with
1136# other documented files.
1137
1138INCLUDE_GRAPH = YES
1139
1140# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1141# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1142# documented header file showing the documented files that directly or
1143# indirectly include this file.
1144
1145INCLUDED_BY_GRAPH = YES
1146
1147# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1148# generate a call dependency graph for every global function or class method.
1149# Note that enabling this option will significantly increase the time of a run.
1150# So in most cases it will be better to enable call graphs for selected
1151# functions only using the \callgraph command.
1152
1153CALL_GRAPH = NO
1154
1155# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1156# generate a caller dependency graph for every global function or class method.
1157# Note that enabling this option will significantly increase the time of a run.
1158# So in most cases it will be better to enable caller graphs for selected
1159# functions only using the \callergraph command.
1160
1161CALLER_GRAPH = NO
1162
1163# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1164# will graphical hierarchy of all classes instead of a textual one.
1165
1166GRAPHICAL_HIERARCHY = YES
1167
1168# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1169# then doxygen will show the dependencies a directory has on other directories
1170# in a graphical way. The dependency relations are determined by the #include
1171# relations between the files in the directories.
1172
1173DIRECTORY_GRAPH = YES
1174
1175# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1176# generated by dot. Possible values are png, jpg, or gif
1177# If left blank png will be used.
1178
1179DOT_IMAGE_FORMAT = png
1180
1181# The tag DOT_PATH can be used to specify the path where the dot tool can be
1182# found. If left blank, it is assumed the dot tool can be found in the path.
1183
1184DOT_PATH =
1185
1186# The DOTFILE_DIRS tag can be used to specify one or more directories that
1187# contain dot files that are included in the documentation (see the
1188# \dotfile command).
1189
1190DOTFILE_DIRS =
1191
1192# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
1193# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1194# this value, doxygen will try to truncate the graph, so that it fits within
1195# the specified constraint. Beware that most browsers cannot cope with very
1196# large images.
1197
1198MAX_DOT_GRAPH_WIDTH = 1024
1199
1200# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
1201# (in pixels) of the graphs generated by dot. If a graph becomes larger than
1202# this value, doxygen will try to truncate the graph, so that it fits within
1203# the specified constraint. Beware that most browsers cannot cope with very
1204# large images.
1205
1206MAX_DOT_GRAPH_HEIGHT = 1024
1207
1208# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1209# graphs generated by dot. A depth value of 3 means that only nodes reachable
1210# from the root by following a path via at most 3 edges will be shown. Nodes
1211# that lay further from the root node will be omitted. Note that setting this
1212# option to 1 or 2 may greatly reduce the computation time needed for large
1213# code bases. Also note that a graph may be further truncated if the graph's
1214# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1215# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1216# the graph is not depth-constrained.
1217
1218MAX_DOT_GRAPH_DEPTH = 0
1219
1220# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1221# background. This is disabled by default, which results in a white background.
1222# Warning: Depending on the platform used, enabling this option may lead to
1223# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1224# read).
1225
1226DOT_TRANSPARENT = NO
1227
1228# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1229# files in one run (i.e. multiple -o and -T options on the command line). This
1230# makes dot run faster, but since only newer versions of dot (>1.8.10)
1231# support this, this feature is disabled by default.
1232
1233DOT_MULTI_TARGETS = NO
1234
1235# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1236# generate a legend page explaining the meaning of the various boxes and
1237# arrows in the dot generated graphs.
1238
1239GENERATE_LEGEND = YES
1240
1241# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1242# remove the intermediate dot files that are used to generate
1243# the various graphs.
1244
1245DOT_CLEANUP = YES
1246
1247#---------------------------------------------------------------------------
1248# Configuration::additions related to the search engine
1249#---------------------------------------------------------------------------
1250
1251# The SEARCHENGINE tag specifies whether or not a search engine should be
1252# used. If set to NO the values of all tags below this one will be ignored.
1253
1254SEARCHENGINE = NO