OpenCores
URL https://opencores.org/ocsvn/scarts/scarts/trunk

Subversion Repositories scarts

[/] [scarts/] [trunk/] [toolchain/] [scarts-gcc/] [gcc-4.1.1/] [libstdc++-v3/] [docs/] [doxygen/] [user.cfg.in] - Blame information for rev 20

Details | Compare with Previous | View Log

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

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.