Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/sound/doc/api/doxy.config.in @ 3051

Last change on this file since 3051 was 2710, checked in by rgrieder, 16 years ago

Merged buildsystem3 containing buildsystem2 containing Adi's buildsystem branch back to the trunk.
Please update the media directory if you were not using buildsystem3 before.

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