Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 6692 was 6085, checked in by rgrieder, 15 years ago

Not including the whole binary director for the doxygen documentation. OrxonoxConfig.h and SpecialConfig.h should be enough.

  • 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# 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
[2874]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
[2633]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
[2891]103INLINE_INHERITED_MEMB  = NO
[2633]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
[2656]118STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@
[2633]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
[2656]128STRIP_FROM_INC_PATH    = @CMAKE_SOURCE_DIR@
[2633]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
[5967]142JAVADOC_AUTOBRIEF      = YES
[2633]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
[2874]174TAB_SIZE               = 4
[2633]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
[2874]206BUILTIN_STL_SUPPORT    = NO
[2633]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
[3196]369ENABLED_SECTIONS       = YES
[2633]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
[3196]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
[2633]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
[3196]464WARN_LOGFILE           = @DOXY_LOGFILE@
[2633]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 \
[3196]476                         @CMAKE_CURRENT_SOURCE_DIR@ \
[6085]477                         @CMAKE_BINARY_DIR@/src/OrxonoxConfig.h \
478                         @CMAKE_BINARY_DIR@/src/SpecialConfig.h
[2633]479
480# If the value of the INPUT tag contains directories, you can use the
481# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
482# and *.h) to filter out the source-files in the directories. If left
483# blank the following patterns are tested:
484# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
485# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
486
487FILE_PATTERNS          = *.cpp \
488                         *.cc \
489                         *.h \
490                         *.hh \
491                         *.hpp \
492                         *.dox
493
494# The RECURSIVE tag can be used to turn specify whether or not subdirectories
495# should be searched for input files as well. Possible values are YES and NO.
496# If left blank NO is used.
497
498RECURSIVE              = YES
499
500# The EXCLUDE tag can be used to specify files and/or directories that should
501# excluded from the INPUT source files. This way you can easily exclude a
502# subdirectory from a directory tree whose root is specified with the INPUT tag.
503
[6085]504EXCLUDE                = @CMAKE_SOURCE_DIR@/src/external/bullet/
[2633]505
506# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
507# directories that are symbolic links (a Unix filesystem feature) are excluded
508# from the input.
509
510EXCLUDE_SYMLINKS       = NO
511
512# If the value of the INPUT tag contains directories, you can use the
513# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
514# certain files from those directories. Note that the wildcards are matched
515# against the file with absolute path, so to exclude all test directories
516# for example use the pattern */test/*
517
[2876]518EXCLUDE_PATTERNS       = */.svn/*
[2633]519
520# The EXAMPLE_PATH tag can be used to specify one or more files or
521# directories that contain example code fragments that are included (see
522# the \include command).
523
[3196]524EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@/examples/
[2633]525
526# If the value of the EXAMPLE_PATH tag contains directories, you can use the
527# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
528# and *.h) to filter out the source-files in the directories. If left
529# blank all files are included.
530
531EXAMPLE_PATTERNS       = *.cpp \
532                         *.cc \
533                         *.h \
534                         *.hh \
535                         INSTALL DEPENDENCIES CHANGELOG LICENSE LGPL
536
537# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
538# searched for input files to be used with the \include or \dontinclude
539# commands irrespective of the value of the RECURSIVE tag.
540# Possible values are YES and NO. If left blank NO is used.
541
542EXAMPLE_RECURSIVE      = YES
543
544# The IMAGE_PATH tag can be used to specify one or more files or
545# directories that contain image that are included in the documentation (see
546# the \image command).
547
[3196]548IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images/
[2633]549
550
551# The INPUT_FILTER tag can be used to specify a program that doxygen should
552# invoke to filter for each input file. Doxygen will invoke the filter program
553# by executing (via popen()) the command <filter> <input-file>, where <filter>
554# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
555# input file. Doxygen will then use the output that the filter program writes
556# to standard output.  If FILTER_PATTERNS is specified, this tag will be
557# ignored.
558
559INPUT_FILTER           =
560
561# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
562# basis.  Doxygen will compare the file name with each pattern and apply the
563# filter if there is a match.  The filters are a list of the form:
564# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
565# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
566# is applied to all files.
567
568FILTER_PATTERNS        =
569
570# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
571# INPUT_FILTER) will be used to filter the input files when producing source
572# files to browse (i.e. when SOURCE_BROWSER is set to YES).
573
574FILTER_SOURCE_FILES    = NO
575
576#---------------------------------------------------------------------------
577# configuration options related to source browsing
578#---------------------------------------------------------------------------
579
580# If the SOURCE_BROWSER tag is set to YES then a list of source files will
581# be generated. Documented entities will be cross-referenced with these sources.
582# Note: To get rid of all source code in the generated output, make sure also
583# VERBATIM_HEADERS is set to NO.
584
[2874]585SOURCE_BROWSER         = NO
[2633]586
587# Setting the INLINE_SOURCES tag to YES will include the body
588# of functions and classes directly in the documentation.
589
590INLINE_SOURCES         = NO
591
592# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
593# doxygen to hide any special comment blocks from generated source code
594# fragments. Normal C and C++ comments will always remain visible.
595
[2874]596STRIP_CODE_COMMENTS    = YES
[2633]597
598# If the REFERENCED_BY_RELATION tag is set to YES (the default)
599# then for each documented function all documented
600# functions referencing it will be listed.
601
602REFERENCED_BY_RELATION = YES
603
604# If the REFERENCES_RELATION tag is set to YES (the default)
605# then for each documented function all documented entities
606# called/used by that function will be listed.
607
608REFERENCES_RELATION    = YES
609
610# If the USE_HTAGS tag is set to YES then the references to source code
611# will point to the HTML generated by the htags(1) tool instead of doxygen
612# built-in source browser. The htags tool is part of GNU's global source
613# tagging system (see http://www.gnu.org/software/global/global.html). You
614# will need version 4.8.6 or higher.
615
616USE_HTAGS              = NO
617
618# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
619# will generate a verbatim copy of the header file for each class for
620# which an include is specified. Set to NO to disable this.
621
622VERBATIM_HEADERS       = YES
623
624#---------------------------------------------------------------------------
625# configuration options related to the alphabetical class index
626#---------------------------------------------------------------------------
627
628# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
629# of all compounds will be generated. Enable this if the project
630# contains a lot of classes, structs, unions or interfaces.
631
632ALPHABETICAL_INDEX     = YES
633
634# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
635# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
636# in which this list will be split (can be a number in the range [1..20])
637
638COLS_IN_ALPHA_INDEX    = 2
639
640# In case all classes in a project start with a common prefix, all
641# classes will be put under the same header in the alphabetical index.
642# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
643# should be ignored while generating the index headers.
644
645IGNORE_PREFIX          =
646
647#---------------------------------------------------------------------------
648# configuration options related to the HTML output
649#---------------------------------------------------------------------------
650
651# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
652# generate HTML output.
653
654GENERATE_HTML          = YES
655
656# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
657# If a relative path is entered the value of OUTPUT_DIRECTORY will be
658# put in front of it. If left blank `html' will be used as the default path.
659
660HTML_OUTPUT            = html
661
662# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
663# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
664# doxygen will generate files with .html extension.
665
666HTML_FILE_EXTENSION    = .html
667
668# The HTML_HEADER tag can be used to specify a personal HTML header for
669# each generated HTML page. If it is left blank doxygen will generate a
670# standard header.
[2879]671HTML_HEADER            =
[2633]672
673
674# The HTML_FOOTER tag can be used to specify a personal HTML footer for
675# each generated HTML page. If it is left blank doxygen will generate a
676# standard footer.
677
[2879]678HTML_FOOTER            =
[2633]679
680# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
681# style sheet that is used by each HTML page. It can be used to
682# fine-tune the look of the HTML output. If the tag is left blank doxygen
683# will generate a default style sheet. Note that doxygen will try to copy
684# the style sheet file to the HTML output directory, so don't put your own
685# stylesheet in the HTML output directory as well, or it will be erased!
686
[2879]687HTML_STYLESHEET        =
[2633]688
689# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
690# files or namespaces will be aligned in HTML using tables. If set to
691# NO a bullet list will be used.
692
693HTML_ALIGN_MEMBERS     = YES
694
695# If the GENERATE_HTMLHELP tag is set to YES, additional index files
696# will be generated that can be used as input for tools like the
697# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
698# of the generated HTML documentation.
699
700GENERATE_HTMLHELP      = YES
701
702# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
703# be used to specify the file name of the resulting .chm file. You
704# can add a path in front of the file if the result should not be
705# written to the html output directory.
706
707CHM_FILE               =
708
709# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
710# be used to specify the location (absolute path including file name) of
711# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
712# the HTML help compiler on the generated index.hhp.
713
714HHC_LOCATION           =
715
716# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
717# controls if a separate .chi index file is generated (YES) or that
718# it should be included in the master .chm file (NO).
719
720GENERATE_CHI           = NO
721
722# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
723# controls whether a binary table of contents is generated (YES) or a
724# normal table of contents (NO) in the .chm file.
725
726BINARY_TOC             = NO
727
728# The TOC_EXPAND flag can be set to YES to add extra items for group members
729# to the contents of the HTML help documentation and to the tree view.
730
731TOC_EXPAND             = NO
732
733# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
734# top of each HTML page. The value NO (the default) enables the index and
735# the value YES disables it.
736
737DISABLE_INDEX          = NO
738
739# This tag can be used to set the number of enum values (range [1..20])
740# that doxygen will group on one line in the generated HTML documentation.
741
742ENUM_VALUES_PER_LINE   = 4
743
744# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
745# generated containing a tree-like index structure (just like the one that
746# is generated for HTML Help). For this to work a browser that supports
747# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
748# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
749# probably better off using the HTML help feature.
750
[2874]751GENERATE_TREEVIEW      = NO
[2633]752
753# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
754# used to set the initial width (in pixels) of the frame in which the tree
755# is shown.
756
757TREEVIEW_WIDTH         = 250
758
759#---------------------------------------------------------------------------
760# configuration options related to the LaTeX output
761#---------------------------------------------------------------------------
762
763# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
764# generate Latex output.
765
766GENERATE_LATEX         = NO
767
768# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
769# If a relative path is entered the value of OUTPUT_DIRECTORY will be
770# put in front of it. If left blank `latex' will be used as the default path.
771
772LATEX_OUTPUT           = latex
773
774# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
775# invoked. If left blank `latex' will be used as the default command name.
776
777#LATEX_CMD_NAME         = latex
778LATEX_CMD_NAME          = @LATEX_COMPILER@
779
780# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
781# generate index for LaTeX. If left blank `makeindex' will be used as the
782# default command name.
783
784#MAKEINDEX_CMD_NAME     = makeindex
785MAKEINDEX_CMD_NAME     = @MAKEINDEX_COMPILER@
786
787# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
788# LaTeX documents. This may be useful for small projects and may help to
789# save some trees in general.
790
791COMPACT_LATEX          = NO
792
793# The PAPER_TYPE tag can be used to set the paper type that is used
794# by the printer. Possible values are: a4, a4wide, letter, legal and
795# executive. If left blank a4wide will be used.
796
[2874]797PAPER_TYPE             = a4wide
[2633]798
799# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
800# packages that should be included in the LaTeX output.
801
802EXTRA_PACKAGES         =
803
804# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
805# the generated latex document. The header should contain everything until
806# the first chapter. If it is left blank doxygen will generate a
807# standard header. Notice: only use this tag if you know what you are doing!
808
809LATEX_HEADER           =
810
811# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
812# is prepared for conversion to pdf (using ps2pdf). The pdf file will
813# contain links (just like the HTML output) instead of page references
814# This makes the output suitable for online browsing using a pdf viewer.
815
816PDF_HYPERLINKS         = YES
817
818# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
819# plain latex in the generated Makefile. Set this option to YES to get a
820# higher quality PDF documentation.
821
822USE_PDFLATEX           = YES
823
824# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
825# command to the generated LaTeX files. This will instruct LaTeX to keep
826# running if errors occur, instead of asking the user for help.
827# This option is also used when generating formulas in HTML.
828
829LATEX_BATCHMODE        = YES
830
831# If LATEX_HIDE_INDICES is set to YES then doxygen will not
832# include the index chapters (such as File Index, Compound Index, etc.)
833# in the output.
834
835LATEX_HIDE_INDICES     = NO
836
837#---------------------------------------------------------------------------
838# configuration options related to the RTF output
839#---------------------------------------------------------------------------
840
841# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
842# The RTF output is optimized for Word 97 and may not look very pretty with
843# other RTF readers or editors.
844
845GENERATE_RTF           = NO
846
847# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
848# If a relative path is entered the value of OUTPUT_DIRECTORY will be
849# put in front of it. If left blank `rtf' will be used as the default path.
850
851RTF_OUTPUT             = rtf
852
853# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
854# RTF documents. This may be useful for small projects and may help to
855# save some trees in general.
856
857COMPACT_RTF            = NO
858
859# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
860# will contain hyperlink fields. The RTF file will
861# contain links (just like the HTML output) instead of page references.
862# This makes the output suitable for online browsing using WORD or other
863# programs which support those fields.
864# Note: wordpad (write) and others do not support links.
865
866RTF_HYPERLINKS         = NO
867
868# Load stylesheet definitions from file. Syntax is similar to doxygen's
869# config file, i.e. a series of assignments. You only have to provide
870# replacements, missing definitions are set to their default value.
871
872RTF_STYLESHEET_FILE    =
873
874# Set optional variables used in the generation of an rtf document.
875# Syntax is similar to doxygen's config file.
876
877RTF_EXTENSIONS_FILE    =
878
879#---------------------------------------------------------------------------
880# configuration options related to the man page output
881#---------------------------------------------------------------------------
882
883# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
884# generate man pages
885
886GENERATE_MAN           = NO
887
888# The MAN_OUTPUT tag is used to specify where the man pages will be put.
889# If a relative path is entered the value of OUTPUT_DIRECTORY will be
890# put in front of it. If left blank `man' will be used as the default path.
891
892MAN_OUTPUT             = man
893
894# The MAN_EXTENSION tag determines the extension that is added to
895# the generated man pages (default is the subroutine's section .3)
896
897MAN_EXTENSION          = .3
898
899# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
900# then it will generate one additional man file for each entity
901# documented in the real man page(s). These additional files
902# only source the real man page, but without them the man command
903# would be unable to find the correct page. The default is NO.
904
905MAN_LINKS              = NO
906
907#---------------------------------------------------------------------------
908# configuration options related to the XML output
909#---------------------------------------------------------------------------
910
911# If the GENERATE_XML tag is set to YES Doxygen will
912# generate an XML file that captures the structure of
913# the code including all documentation.
914
915GENERATE_XML           = NO
916
917# The XML_OUTPUT tag is used to specify where the XML pages will be put.
918# If a relative path is entered the value of OUTPUT_DIRECTORY will be
919# put in front of it. If left blank `xml' will be used as the default path.
920
921XML_OUTPUT             = xml
922
923# The XML_SCHEMA tag can be used to specify an XML schema,
924# which can be used by a validating XML parser to check the
925# syntax of the XML files.
926
927XML_SCHEMA             =
928
929# The XML_DTD tag can be used to specify an XML DTD,
930# which can be used by a validating XML parser to check the
931# syntax of the XML files.
932
933XML_DTD                =
934
935# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
936# dump the program listings (including syntax highlighting
937# and cross-referencing information) to the XML output. Note that
938# enabling this will significantly increase the size of the XML output.
939
940XML_PROGRAMLISTING     = YES
941
942#---------------------------------------------------------------------------
943# configuration options for the AutoGen Definitions output
944#---------------------------------------------------------------------------
945
946# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
947# generate an AutoGen Definitions (see autogen.sf.net) file
948# that captures the structure of the code including all
949# documentation. Note that this feature is still experimental
950# and incomplete at the moment.
951
952GENERATE_AUTOGEN_DEF   = NO
953
954#---------------------------------------------------------------------------
955# configuration options related to the Perl module output
956#---------------------------------------------------------------------------
957
958# If the GENERATE_PERLMOD tag is set to YES Doxygen will
959# generate a Perl module file that captures the structure of
960# the code including all documentation. Note that this
961# feature is still experimental and incomplete at the
962# moment.
963
964GENERATE_PERLMOD       = NO
965
966# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
967# the necessary Makefile rules, Perl scripts and LaTeX code to be able
968# to generate PDF and DVI output from the Perl module output.
969
970PERLMOD_LATEX          = NO
971
972# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
973# nicely formatted so it can be parsed by a human reader.  This is useful
974# if you want to understand what is going on.  On the other hand, if this
975# tag is set to NO the size of the Perl module output will be much smaller
976# and Perl will parse it just the same.
977
978PERLMOD_PRETTY         = YES
979
980# The names of the make variables in the generated doxyrules.make file
981# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
982# This is useful so different doxyrules.make files included by the same
983# Makefile don't overwrite each other's variables.
984
985PERLMOD_MAKEVAR_PREFIX =
986
987#---------------------------------------------------------------------------
988# Configuration options related to the preprocessor   
989#---------------------------------------------------------------------------
990
991# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
992# evaluate all C-preprocessor directives found in the sources and include
993# files.
994
995ENABLE_PREPROCESSING   = YES
996
997# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
998# names in the source code. If set to NO (the default) only conditional
999# compilation will be performed. Macro expansion can be done in a controlled
1000# way by setting EXPAND_ONLY_PREDEF to YES.
1001
1002MACRO_EXPANSION        = YES
1003
1004# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1005# then the macro expansion is limited to the macros specified with the
1006# PREDEFINED and EXPAND_AS_DEFINED tags.
1007
1008EXPAND_ONLY_PREDEF     = YES
1009
1010# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1011# in the INCLUDE_PATH (see below) will be search if a #include is found.
1012
1013SEARCH_INCLUDES        = YES
1014
1015# The INCLUDE_PATH tag can be used to specify one or more directories that
1016# contain include files that are not input files but should be processed by
1017# the preprocessor.
1018
1019INCLUDE_PATH           =
1020
1021# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1022# patterns (like *.h and *.hpp) to filter out the header-files in the
1023# directories. If left blank, the patterns specified with FILE_PATTERNS will
1024# be used.
1025
1026INCLUDE_FILE_PATTERNS  =
1027
1028# The PREDEFINED tag can be used to specify one or more macro names that
1029# are defined before the preprocessor is started (similar to the -D option of
1030# gcc). The argument of the tag is a list of macros of the form: name
1031# or name=definition (no spaces). If the definition and the = are
1032# omitted =1 is assumed. To prevent a macro definition from being
1033# undefined via #undef or recursively expanded use the := operator
1034# instead of the = operator.
1035
[3196]1036PREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS
[2633]1037
1038# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1039# this tag can be used to specify a list of macro names that should be expanded.
1040# The macro definition that is found in the sources will be used.
1041# Use the PREDEFINED tag if you want to use a different macro definition.
1042
1043EXPAND_AS_DEFINED      =
1044
1045# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1046# doxygen's preprocessor will remove all function-like macros that are alone
1047# on a line, have an all uppercase name, and do not end with a semicolon. Such
1048# function macros are typically used for boiler-plate code, and will confuse
1049# the parser if not removed.
1050
1051SKIP_FUNCTION_MACROS   = YES
1052
1053#---------------------------------------------------------------------------
1054# Configuration::additions related to external references   
1055#---------------------------------------------------------------------------
1056
1057# The TAGFILES option can be used to specify one or more tagfiles.
1058# Optionally an initial location of the external documentation
1059# can be added for each tagfile. The format of a tag file without
1060# this location is as follows:
1061#   TAGFILES = file1 file2 ...
1062# Adding location for the tag files is done as follows:
1063#   TAGFILES = file1=loc1 "file2 = loc2" ...
1064# where "loc1" and "loc2" can be relative or absolute paths or
1065# URLs. If a location is present for each tag, the installdox tool
1066# does not have to be run to correct the links.
1067# Note that each tag file must have a unique name
1068# (where the name does NOT include the path)
1069# If a tag file is not located in the directory in which doxygen
1070# is run, you must also specify the path to the tagfile here.
1071
1072TAGFILES               =
1073
1074# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1075# a tag file that is based on the input files it reads.
1076
[2656]1077GENERATE_TAGFILE       = @DOXY_OUTPUT_DIR@/html/@PROJECT_NAME@.TAGFILE
[2633]1078
1079# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1080# in the class index. If set to NO only the inherited external classes
1081# will be listed.
1082
[2874]1083ALLEXTERNALS           = NO
[2633]1084
1085# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1086# in the modules index. If set to NO, only the current project's groups will
1087# be listed.
1088
1089EXTERNAL_GROUPS        = YES
1090
1091# The PERL_PATH should be the absolute path and name of the perl script
1092# interpreter (i.e. the result of `which perl').
1093
1094PERL_PATH              = /usr/bin/perl
1095
1096#---------------------------------------------------------------------------
1097# Configuration options related to the dot tool   
1098#---------------------------------------------------------------------------
1099
1100# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1101# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1102# or super classes. Setting the tag to NO turns the diagrams off. Note that
1103# this option is superseded by the HAVE_DOT option below. This is only a
1104# fallback. It is recommended to install and use dot, since it yields more
1105# powerful graphs.
1106
1107CLASS_DIAGRAMS         = YES
1108
1109# If set to YES, the inheritance and collaboration graphs will hide
1110# inheritance and usage relations if the target is undocumented
1111# or is not a class.
1112
1113HIDE_UNDOC_RELATIONS   = YES
1114
1115# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1116# available from the path. This tool is part of Graphviz, a graph visualization
1117# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1118# have no effect if this option is set to NO (the default)
1119
[6085]1120HAVE_DOT               = NO
[2633]1121
1122# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1123# will generate a graph for each documented class showing the direct and
1124# indirect inheritance relations. Setting this tag to YES will force the
1125# the CLASS_DIAGRAMS tag to NO.
1126
1127CLASS_GRAPH            = YES
1128
1129# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1130# will generate a graph for each documented class showing the direct and
1131# indirect implementation dependencies (inheritance, containment, and
1132# class references variables) of the class with other documented classes.
1133
1134COLLABORATION_GRAPH    = YES
1135
1136# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1137# will generate a graph for groups, showing the direct groups dependencies
1138
1139GROUP_GRAPHS           = YES
1140
1141# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1142# collaboration diagrams in a style similar to the OMG's Unified Modeling
1143# Language.
1144
1145UML_LOOK               = NO
1146
1147# If set to YES, the inheritance and collaboration graphs will show the
1148# relations between templates and their instances.
1149
[2874]1150TEMPLATE_RELATIONS     = NO
[2633]1151
1152# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1153# tags are set to YES then doxygen will generate a graph for each documented
1154# file showing the direct and indirect include dependencies of the file with
1155# other documented files.
1156
1157INCLUDE_GRAPH          = YES
1158
1159# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1160# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1161# documented header file showing the documented files that directly or
1162# indirectly include this file.
1163
1164INCLUDED_BY_GRAPH      = YES
1165
1166# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1167# generate a call dependency graph for every global function or class method.
1168# Note that enabling this option will significantly increase the time of a run.
1169# So in most cases it will be better to enable call graphs for selected
1170# functions only using the \callgraph command.
1171
1172CALL_GRAPH             = NO
1173
1174# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1175# will graphical hierarchy of all classes instead of a textual one.
1176
1177GRAPHICAL_HIERARCHY    = YES
1178
1179# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1180# then doxygen will show the dependencies a directory has on other directories
1181# in a graphical way. The dependency relations are determined by the #include
1182# relations between the files in the directories.
1183
1184DIRECTORY_GRAPH        = YES
1185
1186# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1187# generated by dot. Possible values are png, jpg, or gif
1188# If left blank png will be used.
1189
1190DOT_IMAGE_FORMAT       = png
1191
1192# The tag DOT_PATH can be used to specify the path where the dot tool can be
1193# found. If left blank, it is assumed the dot tool can be found in the path.
1194
1195DOT_PATH               = @DOXYGEN_DOT_EXECUTABLE_PATH@
1196
1197# The DOTFILE_DIRS tag can be used to specify one or more directories that
1198# contain dot files that are included in the documentation (see the
1199# \dotfile command).
1200
[3196]1201DOTFILE_DIRS           = @CMAKE_CURRENT_SOURCE_DIR@/dot
[2633]1202
1203# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1204# graphs generated by dot. A depth value of 3 means that only nodes reachable
1205# from the root by following a path via at most 3 edges will be shown. Nodes
1206# that lay further from the root node will be omitted. Note that setting this
1207# option to 1 or 2 may greatly reduce the computation time needed for large
1208# code bases. Also note that a graph may be further truncated if the graph's
1209# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
1210# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
1211# the graph is not depth-constrained.
1212
[2874]1213MAX_DOT_GRAPH_DEPTH    = 1000
[2633]1214
1215# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1216# background. This is disabled by default, which results in a white background.
1217# Warning: Depending on the platform used, enabling this option may lead to
1218# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1219# read).
1220
1221DOT_TRANSPARENT        = NO
1222
1223# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1224# files in one run (i.e. multiple -o and -T options on the command line). This
1225# makes dot run faster, but since only newer versions of dot (>1.8.10)
1226# support this, this feature is disabled by default.
[3196]1227
[2874]1228DOT_MULTI_TARGETS      = NO
[2633]1229
1230# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1231# generate a legend page explaining the meaning of the various boxes and
1232# arrows in the dot generated graphs.
1233
1234GENERATE_LEGEND        = YES
1235
1236# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1237# remove the intermediate dot files that are used to generate
1238# the various graphs.
1239
1240DOT_CLEANUP            = YES
1241
1242#---------------------------------------------------------------------------
1243# Configuration::additions related to the search engine   
1244#---------------------------------------------------------------------------
1245
1246# The SEARCHENGINE tag specifies whether or not a search engine should be
1247# used. If set to NO the values of all tags below this one will be ignored.
1248
1249SEARCHENGINE           = YES
Note: See TracBrowser for help on using the repository browser.