Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/doc/api/doxy.config.in @ 3004

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