source: libcaca/trunk/doc/doxygen.cfg.in @ 1369

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