Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/resource/doc/api/doxy.config.in @ 3943

Last change on this file since 3943 was 3196, checked in by rgrieder, 15 years ago

Merged pch branch back to trunk.

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