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

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [gnu-dev/] [or1k-gcc/] [libstdc++-v3/] [doc/] [doxygen/] [user.cfg.in] - Blame information for rev 764

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 742 jeremybenn
# Doxyfile 1.7.6.1
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
# This tag specifies the encoding used for all characters in the config file
18
# that follow. The default is UTF-8 which is also the encoding used for all
19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20
# iconv built into libc) for the transcoding. See
21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
 
23
DOXYFILE_ENCODING      = UTF-8
24
 
25
# The PROJECT_NAME tag is a single word (or sequence of words) that should
26
# identify the project. Note that if you do not use Doxywizard you need
27
# to put quotes around the project name if it contains spaces.
28
 
29
PROJECT_NAME           = libstdc++
30
 
31
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
32
# This could be handy for archiving the generated documentation or
33
# if some version control system is used.
34
 
35
PROJECT_NUMBER         =
36
 
37
# Using the PROJECT_BRIEF tag one can provide an optional one line description
38
# for a project that appears at the top of each page and should give viewer
39
# a quick idea about the purpose of the project. Keep the description short.
40
 
41
PROJECT_BRIEF          =
42
 
43
# With the PROJECT_LOGO tag one can specify an logo or icon that is
44
# included in the documentation. The maximum height of the logo should not
45
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
46
# Doxygen will copy the logo to the output directory.
47
 
48
PROJECT_LOGO           =
49
 
50
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51
# base path where the generated documentation will be put.
52
# If a relative path is entered, it will be relative to the location
53
# where doxygen was started. If left blank the current directory will be used.
54
 
55
OUTPUT_DIRECTORY       = @outdir@
56
 
57
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58
# 4096 sub-directories (in 2 levels) under the output directory of each output
59
# format and will distribute the generated files over these directories.
60
# Enabling this option can be useful when feeding doxygen a huge amount of
61
# source files, where putting all generated files in the same directory would
62
# otherwise cause performance problems for the file system.
63
 
64
CREATE_SUBDIRS         = NO
65
 
66
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
67
# documentation generated by doxygen is written. Doxygen will use this
68
# information to generate all constant output in the proper language.
69
# The default language is English, other supported languages are:
70
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76
 
77
OUTPUT_LANGUAGE        = English
78
 
79
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80
# include brief member descriptions after the members that are listed in
81
# the file and class documentation (similar to JavaDoc).
82
# Set to NO to disable this.
83
 
84
BRIEF_MEMBER_DESC      = NO
85
 
86
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87
# the brief description of a member or function before the detailed description.
88
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89
# brief descriptions will be completely suppressed.
90
 
91
REPEAT_BRIEF           = YES
92
 
93
# This tag implements a quasi-intelligent brief description abbreviator
94
# that is used to form the text in various listings. Each string
95
# in this list, if found as the leading text of the brief description, will be
96
# stripped from the text and the result after processing the whole list, is
97
# used as the annotated text. Otherwise, the brief description is used as-is.
98
# If left blank, the following values are used ("$name" is automatically
99
# replaced with the name of the entity): "The $name class" "The $name widget"
100
# "The $name file" "is" "provides" "specifies" "contains"
101
# "represents" "a" "an" "the"
102
 
103
ABBREVIATE_BRIEF       =
104
 
105
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
106
# Doxygen will generate a detailed section even if there is only a brief
107
# description.
108
 
109
ALWAYS_DETAILED_SEC    = YES
110
 
111
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
112
# inherited members of a class in the documentation of that class as if those
113
# members were ordinary class members. Constructors, destructors and assignment
114
# operators of the base classes will not be shown.
115
 
116
INLINE_INHERITED_MEMB  = YES
117
 
118
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
119
# path before files name in the file list and in the header files. If set
120
# to NO the shortest path that makes the file name unique will be used.
121
 
122
FULL_PATH_NAMES        = NO
123
 
124
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
125
# can be used to strip a user-defined part of the path. Stripping is
126
# only done if one of the specified strings matches the left-hand part of
127
# the path. The tag can be used to show relative paths in the file list.
128
# If left blank the directory from which doxygen is run is used as the
129
# path to strip.
130
 
131
STRIP_FROM_PATH        =
132
 
133
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
134
# the path mentioned in the documentation of a class, which tells
135
# the reader which header file to include in order to use a class.
136
# If left blank only the name of the header file containing the class
137
# definition is used. Otherwise one should specify the include paths that
138
# are normally passed to the compiler using the -I flag.
139
 
140
STRIP_FROM_INC_PATH    =
141
 
142
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
143
# (but less readable) file names. This can be useful if your file system
144
# doesn't support long names like on DOS, Mac, or CD-ROM.
145
 
146
SHORT_NAMES            = @shortname@
147
 
148
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
149
# will interpret the first line (until the first dot) of a JavaDoc-style
150
# comment as the brief description. If set to NO, the JavaDoc
151
# comments will behave just like regular Qt-style comments
152
# (thus requiring an explicit @brief command for a brief description.)
153
 
154
JAVADOC_AUTOBRIEF      = NO
155
 
156
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
157
# interpret the first line (until the first dot) of a Qt-style
158
# comment as the brief description. If set to NO, the comments
159
# will behave just like regular Qt-style comments (thus requiring
160
# an explicit \brief command for a brief description.)
161
 
162
QT_AUTOBRIEF           = NO
163
 
164
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
165
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
166
# comments) as a brief description. This used to be the default behaviour.
167
# The new default is to treat a multi-line C++ comment block as a detailed
168
# description. Set this tag to YES if you prefer the old behaviour instead.
169
 
170
MULTILINE_CPP_IS_BRIEF = YES
171
 
172
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
173
# member inherits the documentation from any documented member that it
174
# re-implements.
175
 
176
INHERIT_DOCS           = YES
177
 
178
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
179
# a new page for each member. If set to NO, the documentation of a member will
180
# be part of the file/class/namespace that contains it.
181
 
182
SEPARATE_MEMBER_PAGES  = NO
183
 
184
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
185
# Doxygen uses this value to replace tabs by spaces in code fragments.
186
 
187
TAB_SIZE               = 4
188
 
189
# This tag can be used to specify a number of aliases that acts
190
# as commands in the documentation. An alias has the form "name=value".
191
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
192
# put the command \sideeffect (or @sideeffect) in the documentation, which
193
# will result in a user-defined paragraph with heading "Side Effects:".
194
# You can put \n's in the value part of an alias to insert newlines.
195
 
196
ALIASES                = "doctodo=@todo\nNeeds documentation! See http://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_style.html" \
197
                         "headername{1}=Instead, include <\1>." \
198
                         "headername{2}=Instead, include <\1> or <\2>."
199
 
200
# This tag can be used to specify a number of word-keyword mappings (TCL only).
201
# A mapping has the form "name=value". For example adding
202
# "class=itcl::class" will allow you to use the command class in the
203
# itcl::class meaning.
204
 
205
TCL_SUBST              =
206
 
207
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
208
# sources only. Doxygen will then generate output that is more tailored for C.
209
# For instance, some of the names that are used will be different. The list
210
# of all members will be omitted, etc.
211
 
212
OPTIMIZE_OUTPUT_FOR_C  = NO
213
 
214
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
215
# sources only. Doxygen will then generate output that is more tailored for
216
# Java. For instance, namespaces will be presented as packages, qualified
217
# scopes will look different, etc.
218
 
219
OPTIMIZE_OUTPUT_JAVA   = NO
220
 
221
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
222
# sources only. Doxygen will then generate output that is more tailored for
223
# Fortran.
224
 
225
OPTIMIZE_FOR_FORTRAN   = NO
226
 
227
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
228
# sources. Doxygen will then generate output that is tailored for
229
# VHDL.
230
 
231
OPTIMIZE_OUTPUT_VHDL   = NO
232
 
233
# Doxygen selects the parser to use depending on the extension of the files it
234
# parses. With this tag you can assign which parser to use for a given extension.
235
# Doxygen has a built-in mapping, but you can override or extend it using this
236
# tag. The format is ext=language, where ext is a file extension, and language
237
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
238
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
239
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
240
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
241
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
242
 
243
EXTENSION_MAPPING      =
244
 
245
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
246
# to include (a tag file for) the STL sources as input, then you should
247
# set this tag to YES in order to let doxygen match functions declarations and
248
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
249
# func(std::string) {}). This also makes the inheritance and collaboration
250
# diagrams that involve STL classes more complete and accurate.
251
 
252
BUILTIN_STL_SUPPORT    = NO
253
 
254
# If you use Microsoft's C++/CLI language, you should set this option to YES to
255
# enable parsing support.
256
 
257
CPP_CLI_SUPPORT        = NO
258
 
259
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
260
# Doxygen will parse them like normal C++ but will assume all classes use public
261
# instead of private inheritance when no explicit protection keyword is present.
262
 
263
SIP_SUPPORT            = NO
264
 
265
# For Microsoft's IDL there are propget and propput attributes to indicate getter
266
# and setter methods for a property. Setting this option to YES (the default)
267
# will make doxygen replace the get and set methods by a property in the
268
# documentation. This will only work if the methods are indeed getting or
269
# setting a simple type. If this is not the case, or you want to show the
270
# methods anyway, you should set this option to NO.
271
 
272
IDL_PROPERTY_SUPPORT   = NO
273
 
274
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
275
# tag is set to YES, then doxygen will reuse the documentation of the first
276
# member in the group (if any) for the other members of the group. By default
277
# all members of a group must be documented explicitly.
278
 
279
DISTRIBUTE_GROUP_DOC   = YES
280
 
281
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
282
# the same type (for instance a group of public functions) to be put as a
283
# subgroup of that type (e.g. under the Public Functions section). Set it to
284
# NO to prevent subgrouping. Alternatively, this can be done per class using
285
# the \nosubgrouping command.
286
 
287
SUBGROUPING            = YES
288
 
289
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
290
# unions are shown inside the group in which they are included (e.g. using
291
# @ingroup) instead of on a separate page (for HTML and Man pages) or
292
# section (for LaTeX and RTF).
293
 
294
INLINE_GROUPED_CLASSES = NO
295
 
296
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
297
# unions with only public data fields will be shown inline in the documentation
298
# of the scope in which they are defined (i.e. file, namespace, or group
299
# documentation), provided this scope is documented. If set to NO (the default),
300
# structs, classes, and unions are shown on a separate page (for HTML and Man
301
# pages) or section (for LaTeX and RTF).
302
 
303
INLINE_SIMPLE_STRUCTS  = NO
304
 
305
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
306
# is documented as struct, union, or enum with the name of the typedef. So
307
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
308
# with name TypeT. When disabled the typedef will appear as a member of a file,
309
# namespace, or class. And the struct will be named TypeS. This can typically
310
# be useful for C code in case the coding convention dictates that all compound
311
# types are typedef'ed and only the typedef is referenced, never the tag name.
312
 
313
TYPEDEF_HIDES_STRUCT   = NO
314
 
315
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
316
# determine which symbols to keep in memory and which to flush to disk.
317
# When the cache is full, less often used symbols will be written to disk.
318
# For small to medium size projects (<1000 input files) the default value is
319
# probably good enough. For larger projects a too small cache size can cause
320
# doxygen to be busy swapping symbols to and from disk most of the time
321
# causing a significant performance penalty.
322
# If the system has enough physical memory increasing the cache will improve the
323
# performance by keeping more symbols in memory. Note that the value works on
324
# a logarithmic scale so increasing the size by one will roughly double the
325
# memory usage. The cache size is given by this formula:
326
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
327
# corresponding to a cache size of 2^16 = 65536 symbols.
328
 
329
SYMBOL_CACHE_SIZE      = 0
330
 
331
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
332
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
333
# their name and scope. Since this can be an expensive process and often the
334
# same symbol appear multiple times in the code, doxygen keeps a cache of
335
# pre-resolved symbols. If the cache is too small doxygen will become slower.
336
# If the cache is too large, memory is wasted. The cache size is given by this
337
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
338
# corresponding to a cache size of 2^16 = 65536 symbols.
339
 
340
LOOKUP_CACHE_SIZE      = 0
341
 
342
#---------------------------------------------------------------------------
343
# Build related configuration options
344
#---------------------------------------------------------------------------
345
 
346
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
347
# documentation are documented, even if no documentation was available.
348
# Private class members and static file members will be hidden unless
349
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
350
 
351
EXTRACT_ALL            = NO
352
 
353
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
354
# will be included in the documentation.
355
 
356
EXTRACT_PRIVATE        = NO
357
 
358
# If the EXTRACT_STATIC tag is set to YES all static members of a file
359
# will be included in the documentation.
360
 
361
EXTRACT_STATIC         = YES
362
 
363
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
364
# defined locally in source files will be included in the documentation.
365
# If set to NO only classes defined in header files are included.
366
 
367
EXTRACT_LOCAL_CLASSES  = YES
368
 
369
# This flag is only useful for Objective-C code. When set to YES local
370
# methods, which are defined in the implementation section but not in
371
# the interface are included in the documentation.
372
# If set to NO (the default) only methods in the interface are included.
373
 
374
EXTRACT_LOCAL_METHODS  = YES
375
 
376
# If this flag is set to YES, the members of anonymous namespaces will be
377
# extracted and appear in the documentation as a namespace called
378
# 'anonymous_namespace{file}', where file will be replaced with the base
379
# name of the file that contains the anonymous namespace. By default
380
# anonymous namespaces are hidden.
381
 
382
EXTRACT_ANON_NSPACES   = NO
383
 
384
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
385
# undocumented members of documented classes, files or namespaces.
386
# If set to NO (the default) these members will be included in the
387
# various overviews, but no documentation section is generated.
388
# This option has no effect if EXTRACT_ALL is enabled.
389
 
390
HIDE_UNDOC_MEMBERS     = NO
391
 
392
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
393
# undocumented classes that are normally visible in the class hierarchy.
394
# If set to NO (the default) these classes will be included in the various
395
# overviews. This option has no effect if EXTRACT_ALL is enabled.
396
 
397
HIDE_UNDOC_CLASSES     = YES
398
 
399
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
400
# friend (class|struct|union) declarations.
401
# If set to NO (the default) these declarations will be included in the
402
# documentation.
403
 
404
HIDE_FRIEND_COMPOUNDS  = NO
405
 
406
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
407
# documentation blocks found inside the body of a function.
408
# If set to NO (the default) these blocks will be appended to the
409
# function's detailed documentation block.
410
 
411
HIDE_IN_BODY_DOCS      = NO
412
 
413
# The INTERNAL_DOCS tag determines if documentation
414
# that is typed after a \internal command is included. If the tag is set
415
# to NO (the default) then the documentation will be excluded.
416
# Set it to YES to include the internal documentation.
417
 
418
INTERNAL_DOCS          = NO
419
 
420
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
421
# file names in lower-case letters. If set to YES upper-case letters are also
422
# allowed. This is useful if you have classes or files whose names only differ
423
# in case and if your file system supports case sensitive file names. Windows
424
# and Mac users are advised to set this option to NO.
425
 
426
CASE_SENSE_NAMES       = NO
427
 
428
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
429
# will show members with their full class and namespace scopes in the
430
# documentation. If set to YES the scope will be hidden.
431
 
432
HIDE_SCOPE_NAMES       = NO
433
 
434
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
435
# will put a list of the files that are included by a file in the documentation
436
# of that file.
437
 
438
SHOW_INCLUDE_FILES     = NO
439
 
440
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
441
# will list include files with double quotes in the documentation
442
# rather than with sharp brackets.
443
 
444
FORCE_LOCAL_INCLUDES   = NO
445
 
446
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
447
# is inserted in the documentation for inline members.
448
 
449
INLINE_INFO            = YES
450
 
451
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
452
# will sort the (detailed) documentation of file and class members
453
# alphabetically by member name. If set to NO the members will appear in
454
# declaration order.
455
 
456
SORT_MEMBER_DOCS       = YES
457
 
458
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
459
# brief documentation of file, namespace and class members alphabetically
460
# by member name. If set to NO (the default) the members will appear in
461
# declaration order.
462
 
463
SORT_BRIEF_DOCS        = YES
464
 
465
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
466
# will sort the (brief and detailed) documentation of class members so that
467
# constructors and destructors are listed first. If set to NO (the default)
468
# the constructors will appear in the respective orders defined by
469
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
470
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
471
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
472
 
473
SORT_MEMBERS_CTORS_1ST = YES
474
 
475
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
476
# hierarchy of group names into alphabetical order. If set to NO (the default)
477
# the group names will appear in their defined order.
478
 
479
SORT_GROUP_NAMES       = YES
480
 
481
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
482
# sorted by fully-qualified names, including namespaces. If set to
483
# NO (the default), the class list will be sorted only by class name,
484
# not including the namespace part.
485
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
486
# Note: This option applies only to the class list, not to the
487
# alphabetical list.
488
 
489
SORT_BY_SCOPE_NAME     = YES
490
 
491
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
492
# do proper type resolution of all parameters of a function it will reject a
493
# match between the prototype and the implementation of a member function even
494
# if there is only one candidate or it is obvious which candidate to choose
495
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
496
# will still accept a match between prototype and implementation in such cases.
497
 
498
STRICT_PROTO_MATCHING  = NO
499
 
500
# The GENERATE_TODOLIST tag can be used to enable (YES) or
501
# disable (NO) the todo list. This list is created by putting \todo
502
# commands in the documentation.
503
 
504
GENERATE_TODOLIST      = YES
505
 
506
# The GENERATE_TESTLIST tag can be used to enable (YES) or
507
# disable (NO) the test list. This list is created by putting \test
508
# commands in the documentation.
509
 
510
GENERATE_TESTLIST      = NO
511
 
512
# The GENERATE_BUGLIST tag can be used to enable (YES) or
513
# disable (NO) the bug list. This list is created by putting \bug
514
# commands in the documentation.
515
 
516
GENERATE_BUGLIST       = YES
517
 
518
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
519
# disable (NO) the deprecated list. This list is created by putting
520
# \deprecated commands in the documentation.
521
 
522
GENERATE_DEPRECATEDLIST= YES
523
 
524
# The ENABLED_SECTIONS tag can be used to enable conditional
525
# documentation sections, marked by \if sectionname ... \endif.
526
 
527
ENABLED_SECTIONS       = @enabled_sections@
528
 
529
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
530
# the initial value of a variable or macro consists of for it to appear in
531
# the documentation. If the initializer consists of more lines than specified
532
# here it will be hidden. Use a value of 0 to hide initializers completely.
533
# The appearance of the initializer of individual variables and macros in the
534
# documentation can be controlled using \showinitializer or \hideinitializer
535
# command in the documentation regardless of this setting.
536
 
537
MAX_INITIALIZER_LINES  = 0
538
 
539
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
540
# at the bottom of the documentation of classes and structs. If set to YES the
541
# list will mention the files that were used to generate the documentation.
542
 
543
SHOW_USED_FILES        = YES
544
 
545
# If the sources in your project are distributed over multiple directories
546
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
547
# in the documentation. The default is NO.
548
 
549
SHOW_DIRECTORIES       = YES
550
 
551
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
552
# This will remove the Files entry from the Quick Index and from the
553
# Folder Tree View (if specified). The default is YES.
554
 
555
SHOW_FILES             = YES
556
 
557
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
558
# Namespaces page.
559
# This will remove the Namespaces entry from the Quick Index
560
# and from the Folder Tree View (if specified). The default is YES.
561
 
562
SHOW_NAMESPACES        = YES
563
 
564
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
565
# doxygen should invoke to get the current version for each file (typically from
566
# the version control system). Doxygen will invoke the program by executing (via
567
# popen()) the command  , where  is the value of
568
# the FILE_VERSION_FILTER tag, and  is the name of an input file
569
# provided by doxygen. Whatever the program writes to standard output
570
# is used as the file version. See the manual for examples.
571
 
572
FILE_VERSION_FILTER    =
573
 
574
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
575
# by doxygen. The layout file controls the global structure of the generated
576
# output files in an output format independent way. The create the layout file
577
# that represents doxygen's defaults, run doxygen with the -l option.
578
# You can optionally specify a file name after the option, if omitted
579
# DoxygenLayout.xml will be used as the name of the layout file.
580
 
581
LAYOUT_FILE            =
582
 
583
# The CITE_BIB_FILES tag can be used to specify one or more bib files
584
# containing the references data. This must be a list of .bib files. The
585
# .bib extension is automatically appended if omitted. Using this command
586
# requires the bibtex tool to be installed. See also
587
# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
588
# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
589
# feature you need bibtex and perl available in the search path.
590
 
591
CITE_BIB_FILES         =
592
 
593
#---------------------------------------------------------------------------
594
# configuration options related to warning and progress messages
595
#---------------------------------------------------------------------------
596
 
597
# The QUIET tag can be used to turn on/off the messages that are generated
598
# by doxygen. Possible values are YES and NO. If left blank NO is used.
599
 
600
QUIET                  = NO
601
 
602
# The WARNINGS tag can be used to turn on/off the warning messages that are
603
# generated by doxygen. Possible values are YES and NO. If left blank
604
# NO is used.
605
 
606
WARNINGS               = YES
607
 
608
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
609
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
610
# automatically be disabled.
611
 
612
WARN_IF_UNDOCUMENTED   = NO
613
 
614
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
615
# potential errors in the documentation, such as not documenting some
616
# parameters in a documented function, or documenting parameters that
617
# don't exist or using markup commands wrongly.
618
 
619
WARN_IF_DOC_ERROR      = YES
620
 
621
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
622
# functions that are documented, but have no documentation for their parameters
623
# or return value. If set to NO (the default) doxygen will only warn about
624
# wrong or incomplete parameter documentation, but not about the absence of
625
# documentation.
626
 
627
WARN_NO_PARAMDOC       = NO
628
 
629
# The WARN_FORMAT tag determines the format of the warning messages that
630
# doxygen can produce. The string should contain the $file, $line, and $text
631
# tags, which will be replaced by the file and line number from which the
632
# warning originated and the warning text. Optionally the format may contain
633
# $version, which will be replaced by the version of the file (if it could
634
# be obtained via FILE_VERSION_FILTER)
635
 
636
WARN_FORMAT            = "$file:$line: $text  "
637
 
638
# The WARN_LOGFILE tag can be used to specify a file to which warning
639
# and error messages should be written. If left blank the output is written
640
# to stderr.
641
 
642
WARN_LOGFILE           =
643
 
644
#---------------------------------------------------------------------------
645
# configuration options related to the input files
646
#---------------------------------------------------------------------------
647
 
648
# The INPUT tag can be used to specify the files and/or directories that contain
649
# documented source files. You may enter file names like "myfile.cpp" or
650
# directories like "/usr/src/myproject". Separate the files or directories
651
# with spaces.
652
 
653
INPUT                  = @srcdir@/doc/doxygen/doxygroups.cc \
654
                         @srcdir@/libsupc++/cxxabi.h \
655
                         @srcdir@/libsupc++/exception \
656
                         @srcdir@/libsupc++/initializer_list \
657
                         @srcdir@/libsupc++/new \
658
                         @srcdir@/libsupc++/typeinfo \
659
                         include/algorithm \
660
                         include/array \
661
                         include/atomic \
662
                         include/bitset \
663
                         include/chrono \
664
                         include/complex \
665
                         include/condition_variable \
666
                         include/deque \
667
                         include/forward_list \
668
                         include/fstream \
669
                         include/functional \
670
                         include/future \
671
                         include/iomanip \
672
                         include/ios \
673
                         include/iosfwd \
674
                         include/iostream \
675
                         include/istream \
676
                         include/iterator \
677
                         include/limits \
678
                         include/list \
679
                         include/locale \
680
                         include/map \
681
                         include/memory \
682
                         include/mutex \
683
                         include/numeric \
684
                         include/ostream \
685
                         include/queue \
686
                         include/random \
687
                         include/ratio \
688
                         include/regex \
689
                         include/scoped_allocator \
690
                         include/set \
691
                         include/sstream \
692
                         include/stack \
693
                         include/stdexcept \
694
                         include/streambuf \
695
                         include/string \
696
                         include/system_error \
697
                         include/thread \
698
                         include/tuple \
699
                         include/typeindex \
700
                         include/type_traits \
701
                         include/unordered_map \
702
                         include/unordered_set \
703
                         include/utility \
704
                         include/valarray \
705
                         include/vector \
706
                         include/cassert \
707
                         include/ccomplex \
708
                         include/cctype \
709
                         include/cerrno \
710
                         include/cfenv \
711
                         include/cfloat \
712
                         include/cinttypes \
713
                         include/ciso646 \
714
                         include/climits \
715
                         include/clocale \
716
                         include/cmath \
717
                         include/csetjmp \
718
                         include/csignal \
719
                         include/cstdarg \
720
                         include/cstdbool \
721
                         include/cstddef \
722
                         include/cstdint \
723
                         include/cstdio \
724
                         include/cstdlib \
725
                         include/cstring \
726
                         include/ctgmath \
727
                         include/ctime \
728
                         include/cwchar \
729
                         include/cwctype \
730
                         include/ \
731
                         include/bits \
732
                         include/@host_alias@/bits \
733
                         include/backward \
734
                         include/backward/hash_map \
735
                         include/backward/hash_set \
736
                         include/backward/strstream \
737
                         include/debug \
738
                         include/debug/bitset \
739
                         include/debug/deque \
740
                         include/debug/forward_list \
741
                         include/debug/list \
742
                         include/debug/map \
743
                         include/debug/set \
744
                         include/debug/string \
745
                         include/debug/unordered_map \
746
                         include/debug/unordered_set \
747
                         include/debug/vector \
748
                         include/profile \
749
                         include/profile/impl \
750
                         include/profile/bitset \
751
                         include/profile/deque \
752
                         include/profile/forward_list \
753
                         include/profile/list \
754
                         include/profile/map \
755
                         include/profile/set \
756
                         include/profile/unordered_map \
757
                         include/profile/unordered_set \
758
                         include/profile/vector \
759
                         include/ext/algorithm \
760
                         include/ext/functional \
761
                         include/ext/iterator \
762
                         include/ext/memory \
763
                         include/ext/numeric \
764
                         include/ext/rb_tree \
765
                         include/ext/rope \
766
                         include/ext/slist \
767
                         include/parallel \
768
                         include/parallel/algorithm \
769
                         include/parallel/numeric \
770
                         include/tr1/ccomplex \
771
                         include/tr1/cctype \
772
                         include/tr1/cfenv \
773
                         include/tr1/cfloat \
774
                         include/tr1/cinttypes \
775
                         include/tr1/climits \
776
                         include/tr1/cmath \
777
                         include/tr1/complex \
778
                         include/tr1/cstdarg \
779
                         include/tr1/cstdbool \
780
                         include/tr1/cstdint \
781
                         include/tr1/cstdio \
782
                         include/tr1/cstdlib \
783
                         include/tr1/ctgmath \
784
                         include/tr1/ctime \
785
                         include/tr1/cwchar \
786
                         include/tr1/cwctype \
787
                         include/tr2/ \
788
                         include/tr2/bool_set \
789
                         include/tr2/dynamic_bitset \
790
                         include/tr2/ratio \
791
                         include/tr2/type_traits \
792
                         include/decimal/decimal \
793
                         include/ext \
794
                         include/ext/pb_ds \
795
                         include/ext/pb_ds/detail \
796
                         include/ext/pb_ds/detail/binary_heap_ \
797
                         include/ext/pb_ds/detail/binomial_heap_ \
798
                         include/ext/pb_ds/detail/binomial_heap_base_ \
799
                         include/ext/pb_ds/detail/bin_search_tree_ \
800
                         include/ext/pb_ds/detail/branch_policy \
801
                         include/ext/pb_ds/detail/cc_hash_table_map_ \
802
                         include/ext/pb_ds/detail/eq_fn \
803
                         include/ext/pb_ds/detail/gp_hash_table_map_ \
804
                         include/ext/pb_ds/detail/hash_fn \
805
                         include/ext/pb_ds/detail/left_child_next_sibling_heap_ \
806
                         include/ext/pb_ds/detail/list_update_map_ \
807
                         include/ext/pb_ds/detail/list_update_policy \
808
                         include/ext/pb_ds/detail/ov_tree_map_ \
809
                         include/ext/pb_ds/detail/pairing_heap_ \
810
                         include/ext/pb_ds/detail/pat_trie_ \
811
                         include/ext/pb_ds/detail/rb_tree_map_ \
812
                         include/ext/pb_ds/detail/rc_binomial_heap_ \
813
                         include/ext/pb_ds/detail/resize_policy \
814
                         include/ext/pb_ds/detail/splay_tree_ \
815
                         include/ext/pb_ds/detail/thin_heap_ \
816
                         include/ext/pb_ds/detail/tree_policy \
817
                         include/ext/pb_ds/detail/trie_policy \
818
                         include/ext/pb_ds/detail/unordered_iterator
819
 
820
# This tag can be used to specify the character encoding of the source files
821
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
822
# also the default input encoding. Doxygen uses libiconv (or the iconv built
823
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
824
# the list of possible encodings.
825
 
826
INPUT_ENCODING         = UTF-8
827
 
828
# If the value of the INPUT tag contains directories, you can use the
829
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
830
# and *.h) to filter out the source-files in the directories. If left
831
# blank the following patterns are tested:
832
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
833
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
834
# *.f90 *.f *.for *.vhd *.vhdl
835
 
836
FILE_PATTERNS          = *.h \
837
                         *.hpp \
838
                         *.tcc
839
 
840
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
841
# should be searched for input files as well. Possible values are YES and NO.
842
# If left blank NO is used.
843
 
844
RECURSIVE              = NO
845
 
846
# The EXCLUDE tag can be used to specify files and/or directories that should be
847
# excluded from the INPUT source files. This way you can easily exclude a
848
# subdirectory from a directory tree whose root is specified with the INPUT tag.
849
# Note that relative paths are relative to the directory from which doxygen is
850
# run.
851
 
852
EXCLUDE                = Makefile
853
 
854
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
855
# directories that are symbolic links (a Unix file system feature) are excluded
856
# from the input.
857
 
858
EXCLUDE_SYMLINKS       = NO
859
 
860
# If the value of the INPUT tag contains directories, you can use the
861
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
862
# certain files from those directories. Note that the wildcards are matched
863
# against the file with absolute path, so to exclude all test directories
864
# for example use the pattern */test/*
865
 
866
EXCLUDE_PATTERNS       = stamp-* \
867
                         doxygroups.cc \
868
                         *.gch \
869
                         */.svn/*
870
 
871
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
872
# (namespaces, classes, functions, etc.) that should be excluded from the
873
# output. The symbol name can be a fully qualified name, a word, or if the
874
# wildcard * is used, a substring. Examples: ANamespace, AClass,
875
# AClass::ANamespace, ANamespace::*Test
876
 
877
EXCLUDE_SYMBOLS        =
878
 
879
# The EXAMPLE_PATH tag can be used to specify one or more files or
880
# directories that contain example code fragments that are included (see
881
# the \include command).
882
 
883
EXAMPLE_PATH           =
884
 
885
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
886
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
887
# and *.h) to filter out the source-files in the directories. If left
888
# blank all files are included.
889
 
890
EXAMPLE_PATTERNS       =
891
 
892
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
893
# searched for input files to be used with the \include or \dontinclude
894
# commands irrespective of the value of the RECURSIVE tag.
895
# Possible values are YES and NO. If left blank NO is used.
896
 
897
EXAMPLE_RECURSIVE      = NO
898
 
899
# The IMAGE_PATH tag can be used to specify one or more files or
900
# directories that contain image that are included in the documentation (see
901
# the \image command).
902
 
903
IMAGE_PATH             =
904
 
905
# The INPUT_FILTER tag can be used to specify a program that doxygen should
906
# invoke to filter for each input file. Doxygen will invoke the filter program
907
# by executing (via popen()) the command  , where 
908
# is the value of the INPUT_FILTER tag, and  is the name of an
909
# input file. Doxygen will then use the output that the filter program writes
910
# to standard output.
911
# If FILTER_PATTERNS is specified, this tag will be
912
# ignored.
913
 
914
INPUT_FILTER           =
915
 
916
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
917
# basis.
918
# Doxygen will compare the file name with each pattern and apply the
919
# filter if there is a match.
920
# The filters are a list of the form:
921
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
922
# info on how filters are used. If FILTER_PATTERNS is empty or if
923
# non of the patterns match the file name, INPUT_FILTER is applied.
924
 
925
FILTER_PATTERNS        =
926
 
927
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
928
# INPUT_FILTER) will be used to filter the input files when producing source
929
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
930
 
931
FILTER_SOURCE_FILES    = NO
932
 
933
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
934
# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
935
# and it is also possible to disable source filtering for a specific pattern
936
# using *.ext= (so without naming a filter). This option only has effect when
937
# FILTER_SOURCE_FILES is enabled.
938
 
939
FILTER_SOURCE_PATTERNS =
940
 
941
#---------------------------------------------------------------------------
942
# configuration options related to source browsing
943
#---------------------------------------------------------------------------
944
 
945
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
946
# be generated. Documented entities will be cross-referenced with these sources.
947
# Note: To get rid of all source code in the generated output, make sure also
948
# VERBATIM_HEADERS is set to NO.
949
 
950
SOURCE_BROWSER         = YES
951
 
952
# Setting the INLINE_SOURCES tag to YES will include the body
953
# of functions and classes directly in the documentation.
954
 
955
INLINE_SOURCES         = NO
956
 
957
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
958
# doxygen to hide any special comment blocks from generated source code
959
# fragments. Normal C and C++ comments will always remain visible.
960
 
961
STRIP_CODE_COMMENTS    = NO
962
 
963
# If the REFERENCED_BY_RELATION tag is set to YES
964
# then for each documented function all documented
965
# functions referencing it will be listed.
966
 
967
REFERENCED_BY_RELATION = YES
968
 
969
# If the REFERENCES_RELATION tag is set to YES
970
# then for each documented function all documented entities
971
# called/used by that function will be listed.
972
 
973
REFERENCES_RELATION    = YES
974
 
975
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
976
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
977
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
978
# link to the source code.
979
# Otherwise they will link to the documentation.
980
 
981
REFERENCES_LINK_SOURCE = YES
982
 
983
# If the USE_HTAGS tag is set to YES then the references to source code
984
# will point to the HTML generated by the htags(1) tool instead of doxygen
985
# built-in source browser. The htags tool is part of GNU's global source
986
# tagging system (see http://www.gnu.org/software/global/global.html). You
987
# will need version 4.8.6 or higher.
988
 
989
USE_HTAGS              = NO
990
 
991
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
992
# will generate a verbatim copy of the header file for each class for
993
# which an include is specified. Set to NO to disable this.
994
 
995
VERBATIM_HEADERS       = NO
996
 
997
#---------------------------------------------------------------------------
998
# configuration options related to the alphabetical class index
999
#---------------------------------------------------------------------------
1000
 
1001
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
1002
# of all compounds will be generated. Enable this if the project
1003
# contains a lot of classes, structs, unions or interfaces.
1004
 
1005
ALPHABETICAL_INDEX     = YES
1006
 
1007
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
1008
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
1009
# in which this list will be split (can be a number in the range [1..20])
1010
 
1011
COLS_IN_ALPHA_INDEX    = 2
1012
 
1013
# In case all classes in a project start with a common prefix, all
1014
# classes will be put under the same header in the alphabetical index.
1015
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
1016
# should be ignored while generating the index headers.
1017
 
1018
IGNORE_PREFIX          =
1019
 
1020
#---------------------------------------------------------------------------
1021
# configuration options related to the HTML output
1022
#---------------------------------------------------------------------------
1023
 
1024
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
1025
# generate HTML output.
1026
 
1027
GENERATE_HTML          = @do_html@
1028
 
1029
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
1030
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1031
# put in front of it. If left blank `html' will be used as the default path.
1032
 
1033
HTML_OUTPUT            = html
1034
 
1035
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
1036
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
1037
# doxygen will generate files with .html extension.
1038
 
1039
HTML_FILE_EXTENSION    = .html
1040
 
1041
# The HTML_HEADER tag can be used to specify a personal HTML header for
1042
# each generated HTML page. If it is left blank doxygen will generate a
1043
# standard header. Note that when using a custom header you are responsible
1044
#  for the proper inclusion of any scripts and style sheets that doxygen
1045
# needs, which is dependent on the configuration options used.
1046
# It is advised to generate a default header using "doxygen -w html
1047
# header.html footer.html stylesheet.css YourConfigFile" and then modify
1048
# that header. Note that the header is subject to change so you typically
1049
# have to redo this when upgrading to a newer version of doxygen or when
1050
# changing the value of configuration settings such as GENERATE_TREEVIEW!
1051
 
1052
HTML_HEADER            =
1053
 
1054
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
1055
# each generated HTML page. If it is left blank doxygen will generate a
1056
# standard footer.
1057
 
1058
HTML_FOOTER            =
1059
 
1060
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
1061
# style sheet that is used by each HTML page. It can be used to
1062
# fine-tune the look of the HTML output. If the tag is left blank doxygen
1063
# will generate a default style sheet. Note that doxygen will try to copy
1064
# the style sheet file to the HTML output directory, so don't put your own
1065
# style sheet in the HTML output directory as well, or it will be erased!
1066
 
1067
HTML_STYLESHEET        =
1068
 
1069
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1070
# other source files which should be copied to the HTML output directory. Note
1071
# that these files will be copied to the base HTML output directory. Use the
1072
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1073
# files. In the HTML_STYLESHEET file, use the file name only. Also note that
1074
# the files will be copied as-is; there are no commands or markers available.
1075
 
1076
HTML_EXTRA_FILES       =
1077
 
1078
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
1079
# Doxygen will adjust the colors in the style sheet and background images
1080
# according to this color. Hue is specified as an angle on a colorwheel,
1081
# see http://en.wikipedia.org/wiki/Hue for more information.
1082
# For instance the value 0 represents red, 60 is yellow, 120 is green,
1083
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
1084
# The allowed range is 0 to 359.
1085
 
1086
HTML_COLORSTYLE_HUE    = 220
1087
 
1088
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
1089
# the colors in the HTML output. For a value of 0 the output will use
1090
# grayscales only. A value of 255 will produce the most vivid colors.
1091
 
1092
HTML_COLORSTYLE_SAT    = 100
1093
 
1094
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
1095
# the luminance component of the colors in the HTML output. Values below
1096
# 100 gradually make the output lighter, whereas values above 100 make
1097
# the output darker. The value divided by 100 is the actual gamma applied,
1098
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
1099
# and 100 does not change the gamma.
1100
 
1101
HTML_COLORSTYLE_GAMMA  = 80
1102
 
1103
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1104
# page will contain the date and time when the page was generated. Setting
1105
# this to NO can help when comparing the output of multiple runs.
1106
 
1107
HTML_TIMESTAMP         = NO
1108
 
1109
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
1110
# files or namespaces will be aligned in HTML using tables. If set to
1111
# NO a bullet list will be used.
1112
 
1113
HTML_ALIGN_MEMBERS     = NO
1114
 
1115
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1116
# documentation will contain sections that can be hidden and shown after the
1117
# page has loaded. For this to work a browser that supports
1118
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
1119
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
1120
 
1121
HTML_DYNAMIC_SECTIONS  = NO
1122
 
1123
# If the GENERATE_DOCSET tag is set to YES, additional index files
1124
# will be generated that can be used as input for Apple's Xcode 3
1125
# integrated development environment, introduced with OSX 10.5 (Leopard).
1126
# To create a documentation set, doxygen will generate a Makefile in the
1127
# HTML output directory. Running make will produce the docset in that
1128
# directory and running "make install" will install the docset in
1129
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1130
# it at startup.
1131
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1132
# for more information.
1133
 
1134
GENERATE_DOCSET        = NO
1135
 
1136
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1137
# feed. A documentation feed provides an umbrella under which multiple
1138
# documentation sets from a single provider (such as a company or product suite)
1139
# can be grouped.
1140
 
1141
DOCSET_FEEDNAME        = "Doxygen generated docs"
1142
 
1143
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1144
# should uniquely identify the documentation set bundle. This should be a
1145
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1146
# will append .docset to the name.
1147
 
1148
DOCSET_BUNDLE_ID       = org.gnu.libstdc++
1149
 
1150
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
1151
# the documentation publisher. This should be a reverse domain-name style
1152
# string, e.g. com.mycompany.MyDocSet.documentation.
1153
 
1154
DOCSET_PUBLISHER_ID    = org.fsf
1155
 
1156
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1157
 
1158
DOCSET_PUBLISHER_NAME  = libstdc++
1159
 
1160
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1161
# will be generated that can be used as input for tools like the
1162
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1163
# of the generated HTML documentation.
1164
 
1165
GENERATE_HTMLHELP      = NO
1166
 
1167
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1168
# be used to specify the file name of the resulting .chm file. You
1169
# can add a path in front of the file if the result should not be
1170
# written to the html output directory.
1171
 
1172
CHM_FILE               =
1173
 
1174
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1175
# be used to specify the location (absolute path including file name) of
1176
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1177
# the HTML help compiler on the generated index.hhp.
1178
 
1179
HHC_LOCATION           =
1180
 
1181
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1182
# controls if a separate .chi index file is generated (YES) or that
1183
# it should be included in the master .chm file (NO).
1184
 
1185
GENERATE_CHI           = NO
1186
 
1187
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1188
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1189
# content.
1190
 
1191
CHM_INDEX_ENCODING     =
1192
 
1193
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1194
# controls whether a binary table of contents is generated (YES) or a
1195
# normal table of contents (NO) in the .chm file.
1196
 
1197
BINARY_TOC             = NO
1198
 
1199
# The TOC_EXPAND flag can be set to YES to add extra items for group members
1200
# to the contents of the HTML help documentation and to the tree view.
1201
 
1202
TOC_EXPAND             = NO
1203
 
1204
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1205
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1206
# that can be used as input for Qt's qhelpgenerator to generate a
1207
# Qt Compressed Help (.qch) of the generated HTML documentation.
1208
 
1209
GENERATE_QHP           = NO
1210
 
1211
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1212
# be used to specify the file name of the resulting .qch file.
1213
# The path specified is relative to the HTML output folder.
1214
 
1215
QCH_FILE               =
1216
 
1217
# The QHP_NAMESPACE tag specifies the namespace to use when generating
1218
# Qt Help Project output. For more information please see
1219
# http://doc.trolltech.com/qthelpproject.html#namespace
1220
 
1221
QHP_NAMESPACE          = org.doxygen.Project
1222
 
1223
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1224
# Qt Help Project output. For more information please see
1225
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1226
 
1227
QHP_VIRTUAL_FOLDER     = doc
1228
 
1229
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1230
# add. For more information please see
1231
# http://doc.trolltech.com/qthelpproject.html#custom-filters
1232
 
1233
QHP_CUST_FILTER_NAME   =
1234
 
1235
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1236
# custom filter to add. For more information please see
1237
# 
1238
# Qt Help Project / Custom Filters.
1239
 
1240
QHP_CUST_FILTER_ATTRS  =
1241
 
1242
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1243
# project's
1244
# filter section matches.
1245
# 
1246
# Qt Help Project / Filter Attributes.
1247
 
1248
QHP_SECT_FILTER_ATTRS  =
1249
 
1250
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1251
# be used to specify the location of Qt's qhelpgenerator.
1252
# If non-empty doxygen will try to run qhelpgenerator on the generated
1253
# .qhp file.
1254
 
1255
QHG_LOCATION           =
1256
 
1257
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1258
#  will be generated, which together with the HTML files, form an Eclipse help
1259
# plugin. To install this plugin and make it available under the help contents
1260
# menu in Eclipse, the contents of the directory containing the HTML and XML
1261
# files needs to be copied into the plugins directory of eclipse. The name of
1262
# the directory within the plugins directory should be the same as
1263
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1264
# the help appears.
1265
 
1266
GENERATE_ECLIPSEHELP   = NO
1267
 
1268
# A unique identifier for the eclipse help plugin. When installing the plugin
1269
# the directory name containing the HTML and XML files should also have
1270
# this name.
1271
 
1272
ECLIPSE_DOC_ID         = org.doxygen.Project
1273
 
1274
# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1275
# at top of each HTML page. The value NO (the default) enables the index and
1276
# the value YES disables it. Since the tabs have the same information as the
1277
# navigation tree you can set this option to NO if you already set
1278
# GENERATE_TREEVIEW to YES.
1279
 
1280
DISABLE_INDEX          = YES
1281
 
1282
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1283
# structure should be generated to display hierarchical information.
1284
# If the tag value is set to YES, a side panel will be generated
1285
# containing a tree-like index structure (just like the one that
1286
# is generated for HTML Help). For this to work a browser that supports
1287
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1288
# Windows users are probably better off using the HTML help feature.
1289
# Since the tree basically has the same information as the tab index you
1290
# could consider to set DISABLE_INDEX to NO when enabling this option.
1291
 
1292
GENERATE_TREEVIEW      = YES
1293
 
1294
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1295
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1296
# documentation. Note that a value of 0 will completely suppress the enum
1297
# values from appearing in the overview section.
1298
 
1299
ENUM_VALUES_PER_LINE   = 4
1300
 
1301
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1302
# and Class Hierarchy pages using a tree view instead of an ordered list.
1303
 
1304
USE_INLINE_TREES       = NO
1305
 
1306
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1307
# used to set the initial width (in pixels) of the frame in which the tree
1308
# is shown.
1309
 
1310
TREEVIEW_WIDTH         = 250
1311
 
1312
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1313
# links to external symbols imported via tag files in a separate window.
1314
 
1315
EXT_LINKS_IN_WINDOW    = NO
1316
 
1317
# Use this tag to change the font size of Latex formulas included
1318
# as images in the HTML documentation. The default is 10. Note that
1319
# when you change the font size after a successful doxygen run you need
1320
# to manually remove any form_*.png images from the HTML output directory
1321
# to force them to be regenerated.
1322
 
1323
FORMULA_FONTSIZE       = 10
1324
 
1325
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1326
# generated for formulas are transparent PNGs. Transparent PNGs are
1327
# not supported properly for IE 6.0, but are supported on all modern browsers.
1328
# Note that when changing this option you need to delete any form_*.png files
1329
# in the HTML output before the changes have effect.
1330
 
1331
FORMULA_TRANSPARENT    = YES
1332
 
1333
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1334
# (see http://www.mathjax.org) which uses client side Javascript for the
1335
# rendering instead of using prerendered bitmaps. Use this if you do not
1336
# have LaTeX installed or if you want to formulas look prettier in the HTML
1337
# output. When enabled you also need to install MathJax separately and
1338
# configure the path to it using the MATHJAX_RELPATH option.
1339
 
1340
USE_MATHJAX            = NO
1341
 
1342
# When MathJax is enabled you need to specify the location relative to the
1343
# HTML output directory using the MATHJAX_RELPATH option. The destination
1344
# directory should contain the MathJax.js script. For instance, if the mathjax
1345
# directory is located at the same level as the HTML output directory, then
1346
# MATHJAX_RELPATH should be ../mathjax. The default value points to the
1347
# mathjax.org site, so you can quickly see the result without installing
1348
# MathJax, but it is strongly recommended to install a local copy of MathJax
1349
# before deployment.
1350
 
1351
MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1352
 
1353
# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1354
# names that should be enabled during MathJax rendering.
1355
 
1356
MATHJAX_EXTENSIONS     =
1357
 
1358
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1359
# for the HTML output. The underlying search engine uses javascript
1360
# and DHTML and should work on any modern browser. Note that when using
1361
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1362
# (GENERATE_DOCSET) there is already a search function so this one should
1363
# typically be disabled. For large projects the javascript based search engine
1364
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1365
 
1366
SEARCHENGINE           = NO
1367
 
1368
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1369
# implemented using a PHP enabled web server instead of at the web client
1370
# using Javascript. Doxygen will generate the search PHP script and index
1371
# file to put on the web server. The advantage of the server
1372
# based approach is that it scales better to large projects and allows
1373
# full text search. The disadvantages are that it is more difficult to setup
1374
# and does not have live searching capabilities.
1375
 
1376
SERVER_BASED_SEARCH    = NO
1377
 
1378
#---------------------------------------------------------------------------
1379
# configuration options related to the LaTeX output
1380
#---------------------------------------------------------------------------
1381
 
1382
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1383
# generate Latex output.
1384
 
1385
GENERATE_LATEX         = @do_latex@
1386
 
1387
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1388
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1389
# put in front of it. If left blank `latex' will be used as the default path.
1390
 
1391
LATEX_OUTPUT           = latex
1392
 
1393
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1394
# invoked. If left blank `latex' will be used as the default command name.
1395
# Note that when enabling USE_PDFLATEX this option is only used for
1396
# generating bitmaps for formulas in the HTML output, but not in the
1397
# Makefile that is written to the output directory.
1398
 
1399
LATEX_CMD_NAME         = latex
1400
 
1401
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1402
# generate index for LaTeX. If left blank `makeindex' will be used as the
1403
# default command name.
1404
 
1405
MAKEINDEX_CMD_NAME     = makeindex
1406
 
1407
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1408
# LaTeX documents. This may be useful for small projects and may help to
1409
# save some trees in general.
1410
 
1411
COMPACT_LATEX          = YES
1412
 
1413
# The PAPER_TYPE tag can be used to set the paper type that is used
1414
# by the printer. Possible values are: a4, letter, legal and
1415
# executive. If left blank a4wide will be used.
1416
 
1417
PAPER_TYPE             = letter
1418
 
1419
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1420
# packages that should be included in the LaTeX output.
1421
 
1422
EXTRA_PACKAGES         = amsmath
1423
 
1424
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1425
# the generated latex document. The header should contain everything until
1426
# the first chapter. If it is left blank doxygen will generate a
1427
# standard header. Notice: only use this tag if you know what you are doing!
1428
 
1429
LATEX_HEADER           =
1430
 
1431
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1432
# the generated latex document. The footer should contain everything after
1433
# the last chapter. If it is left blank doxygen will generate a
1434
# standard footer. Notice: only use this tag if you know what you are doing!
1435
 
1436
LATEX_FOOTER           =
1437
 
1438
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1439
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1440
# contain links (just like the HTML output) instead of page references
1441
# This makes the output suitable for online browsing using a pdf viewer.
1442
 
1443
PDF_HYPERLINKS         = YES
1444
 
1445
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1446
# plain latex in the generated Makefile. Set this option to YES to get a
1447
# higher quality PDF documentation.
1448
 
1449
USE_PDFLATEX           = YES
1450
 
1451
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1452
# command to the generated LaTeX files. This will instruct LaTeX to keep
1453
# running if errors occur, instead of asking the user for help.
1454
# This option is also used when generating formulas in HTML.
1455
 
1456
LATEX_BATCHMODE        = YES
1457
 
1458
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1459
# include the index chapters (such as File Index, Compound Index, etc.)
1460
# in the output.
1461
 
1462
LATEX_HIDE_INDICES     = YES
1463
 
1464
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1465
# source code with syntax highlighting in the LaTeX output.
1466
# Note that which sources are shown also depends on other settings
1467
# such as SOURCE_BROWSER.
1468
 
1469
LATEX_SOURCE_CODE      = NO
1470
 
1471
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1472
# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1473
# http://en.wikipedia.org/wiki/BibTeX for more info.
1474
 
1475
LATEX_BIB_STYLE        = plain
1476
 
1477
#---------------------------------------------------------------------------
1478
# configuration options related to the RTF output
1479
#---------------------------------------------------------------------------
1480
 
1481
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1482
# The RTF output is optimized for Word 97 and may not look very pretty with
1483
# other RTF readers or editors.
1484
 
1485
GENERATE_RTF           = NO
1486
 
1487
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1488
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1489
# put in front of it. If left blank `rtf' will be used as the default path.
1490
 
1491
RTF_OUTPUT             = rtf
1492
 
1493
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1494
# RTF documents. This may be useful for small projects and may help to
1495
# save some trees in general.
1496
 
1497
COMPACT_RTF            = NO
1498
 
1499
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1500
# will contain hyperlink fields. The RTF file will
1501
# contain links (just like the HTML output) instead of page references.
1502
# This makes the output suitable for online browsing using WORD or other
1503
# programs which support those fields.
1504
# Note: wordpad (write) and others do not support links.
1505
 
1506
RTF_HYPERLINKS         = NO
1507
 
1508
# Load style sheet definitions from file. Syntax is similar to doxygen's
1509
# config file, i.e. a series of assignments. You only have to provide
1510
# replacements, missing definitions are set to their default value.
1511
 
1512
RTF_STYLESHEET_FILE    =
1513
 
1514
# Set optional variables used in the generation of an rtf document.
1515
# Syntax is similar to doxygen's config file.
1516
 
1517
RTF_EXTENSIONS_FILE    =
1518
 
1519
#---------------------------------------------------------------------------
1520
# configuration options related to the man page output
1521
#---------------------------------------------------------------------------
1522
 
1523
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1524
# generate man pages
1525
 
1526
GENERATE_MAN           = @do_man@
1527
 
1528
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1529
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1530
# put in front of it. If left blank `man' will be used as the default path.
1531
 
1532
MAN_OUTPUT             = man
1533
 
1534
# The MAN_EXTENSION tag determines the extension that is added to
1535
# the generated man pages (default is the subroutine's section .3)
1536
 
1537
MAN_EXTENSION          = .3
1538
 
1539
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1540
# then it will generate one additional man file for each entity
1541
# documented in the real man page(s). These additional files
1542
# only source the real man page, but without them the man command
1543
# would be unable to find the correct page. The default is NO.
1544
 
1545
MAN_LINKS              = NO
1546
 
1547
#---------------------------------------------------------------------------
1548
# configuration options related to the XML output
1549
#---------------------------------------------------------------------------
1550
 
1551
# If the GENERATE_XML tag is set to YES Doxygen will
1552
# generate an XML file that captures the structure of
1553
# the code including all documentation.
1554
 
1555
GENERATE_XML           = @do_xml@
1556
 
1557
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1558
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1559
# put in front of it. If left blank `xml' will be used as the default path.
1560
 
1561
XML_OUTPUT             = xml
1562
 
1563
# The XML_SCHEMA tag can be used to specify an XML schema,
1564
# which can be used by a validating XML parser to check the
1565
# syntax of the XML files.
1566
 
1567
XML_SCHEMA             =
1568
 
1569
# The XML_DTD tag can be used to specify an XML DTD,
1570
# which can be used by a validating XML parser to check the
1571
# syntax of the XML files.
1572
 
1573
XML_DTD                =
1574
 
1575
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1576
# dump the program listings (including syntax highlighting
1577
# and cross-referencing information) to the XML output. Note that
1578
# enabling this will significantly increase the size of the XML output.
1579
 
1580
XML_PROGRAMLISTING     = NO
1581
 
1582
#---------------------------------------------------------------------------
1583
# configuration options for the AutoGen Definitions output
1584
#---------------------------------------------------------------------------
1585
 
1586
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1587
# generate an AutoGen Definitions (see autogen.sf.net) file
1588
# that captures the structure of the code including all
1589
# documentation. Note that this feature is still experimental
1590
# and incomplete at the moment.
1591
 
1592
GENERATE_AUTOGEN_DEF   = NO
1593
 
1594
#---------------------------------------------------------------------------
1595
# configuration options related to the Perl module output
1596
#---------------------------------------------------------------------------
1597
 
1598
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1599
# generate a Perl module file that captures the structure of
1600
# the code including all documentation. Note that this
1601
# feature is still experimental and incomplete at the
1602
# moment.
1603
 
1604
GENERATE_PERLMOD       = NO
1605
 
1606
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1607
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1608
# to generate PDF and DVI output from the Perl module output.
1609
 
1610
PERLMOD_LATEX          = NO
1611
 
1612
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1613
# nicely formatted so it can be parsed by a human reader.
1614
# This is useful
1615
# if you want to understand what is going on.
1616
# On the other hand, if this
1617
# tag is set to NO the size of the Perl module output will be much smaller
1618
# and Perl will parse it just the same.
1619
 
1620
PERLMOD_PRETTY         = YES
1621
 
1622
# The names of the make variables in the generated doxyrules.make file
1623
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1624
# This is useful so different doxyrules.make files included by the same
1625
# Makefile don't overwrite each other's variables.
1626
 
1627
PERLMOD_MAKEVAR_PREFIX =
1628
 
1629
#---------------------------------------------------------------------------
1630
# Configuration options related to the preprocessor
1631
#---------------------------------------------------------------------------
1632
 
1633
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1634
# evaluate all C-preprocessor directives found in the sources and include
1635
# files.
1636
 
1637
ENABLE_PREPROCESSING   = YES
1638
 
1639
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1640
# names in the source code. If set to NO (the default) only conditional
1641
# compilation will be performed. Macro expansion can be done in a controlled
1642
# way by setting EXPAND_ONLY_PREDEF to YES.
1643
 
1644
MACRO_EXPANSION        = YES
1645
 
1646
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1647
# then the macro expansion is limited to the macros specified with the
1648
# PREDEFINED and EXPAND_AS_DEFINED tags.
1649
 
1650
EXPAND_ONLY_PREDEF     = NO
1651
 
1652
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1653
# pointed to by INCLUDE_PATH will be searched when a #include is found.
1654
 
1655
SEARCH_INCLUDES        = YES
1656
 
1657
# The INCLUDE_PATH tag can be used to specify one or more directories that
1658
# contain include files that are not input files but should be processed by
1659
# the preprocessor.
1660
 
1661
INCLUDE_PATH           = include
1662
 
1663
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1664
# patterns (like *.h and *.hpp) to filter out the header-files in the
1665
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1666
# be used.
1667
 
1668
INCLUDE_FILE_PATTERNS  =
1669
 
1670
# The PREDEFINED tag can be used to specify one or more macro names that
1671
# are defined before the preprocessor is started (similar to the -D option of
1672
# gcc). The argument of the tag is a list of macros of the form: name
1673
# or name=definition (no spaces). If the definition and the = are
1674
# omitted =1 is assumed. To prevent a macro definition from being
1675
# undefined via #undef or recursively expanded use the := operator
1676
# instead of the = operator.
1677
 
1678
PREDEFINED             = __cplusplus \
1679
                         __GTHREADS \
1680
                         _GLIBCXX_HAS_GTHREADS \
1681
                         __GXX_EXPERIMENTAL_CXX0X__ \
1682
                         _GLIBCXX_INCLUDE_AS_CXX0X \
1683
                         "_GLIBCXX_PURE= " \
1684
                         "_GLIBCXX_CONST= " \
1685
                         "_GLIBCXX_NORETURN= " \
1686
                         "_GLIBCXX_NOTHROW= " \
1687
                         "_GLIBCXX_STD_C= " \
1688
                         "_GLIBCXX_STD_A= " \
1689
                         "_GLIBCXX_VISIBILITY(V)= " \
1690
                         "_GLIBCXX_BEGIN_NAMESPACE_VERSION= " \
1691
                         "_GLIBCXX_BEGIN_NAMESPACE_ALGO= " \
1692
                         "_GLIBCXX_BEGIN_NAMESPACE_CONTAINER= " \
1693
                         "_GLIBCXX_BEGIN_NAMESPACE_LDBL= " \
1694
                         "_GLIBCXX_END_NAMESPACE_VERSION= " \
1695
                         "_GLIBCXX_END_NAMESPACE_ALGO= " \
1696
                         "_GLIBCXX_END_NAMESPACE_CONTAINER= " \
1697
                         "_GLIBCXX_END_NAMESPACE_LDBL= " \
1698
                         "_GLIBCXX_TEMPLATE_ARGS=...  " \
1699
                         _GLIBCXX_DEPRECATED \
1700
                         _GLIBCXX_CONSTEXPR=constexpr \
1701
                         _GLIBCXX_USE_CONSTEXPR=constexpr \
1702
                         _GLIBCXX_USE_WCHAR_T \
1703
                         _GLIBCXX_USE_LONG_LONG \
1704
                         _GLIBCXX_USE_C99_STDINT_TR1 \
1705
                         _GLIBCXX_USE_SCHED_YIELD \
1706
                         _GLIBCXX_USE_NANOSLEEP \
1707
                         __EXCEPTIONS \
1708
                         __GXX_RTTI \
1709
                         ATOMIC_INT_LOCK_FREE \
1710
                         PB_DS_DATA_TRUE_INDICATOR \
1711
                         __glibcxx_function_requires=// \
1712
                         __glibcxx_class_requires=// \
1713
                         __glibcxx_class_requires2=// \
1714
                         __glibcxx_class_requires3=// \
1715
                         __glibcxx_class_requires4=//
1716
 
1717
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1718
# this tag can be used to specify a list of macro names that should be expanded.
1719
# The macro definition that is found in the sources will be used.
1720
# Use the PREDEFINED tag if you want to use a different macro definition that
1721
# overrules the definition found in the source code.
1722
 
1723
EXPAND_AS_DEFINED      =
1724
 
1725
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1726
# doxygen's preprocessor will remove all references to function-like macros
1727
# that are alone on a line, have an all uppercase name, and do not end with a
1728
# semicolon, because these will confuse the parser if not removed.
1729
 
1730
SKIP_FUNCTION_MACROS   = YES
1731
 
1732
#---------------------------------------------------------------------------
1733
# Configuration::additions related to external references
1734
#---------------------------------------------------------------------------
1735
 
1736
# The TAGFILES option can be used to specify one or more tagfiles.
1737
# Optionally an initial location of the external documentation
1738
# can be added for each tagfile. The format of a tag file without
1739
# this location is as follows:
1740
#
1741
# TAGFILES = file1 file2 ...
1742
# Adding location for the tag files is done as follows:
1743
#
1744
# TAGFILES = file1=loc1 "file2 = loc2" ...
1745
# where "loc1" and "loc2" can be relative or absolute paths or
1746
# URLs. If a location is present for each tag, the installdox tool
1747
# does not have to be run to correct the links.
1748
# Note that each tag file must have a unique name
1749
# (where the name does NOT include the path)
1750
# If a tag file is not located in the directory in which doxygen
1751
# is run, you must also specify the path to the tagfile here.
1752
 
1753
TAGFILES               =
1754
 
1755
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1756
# a tag file that is based on the input files it reads.
1757
 
1758
GENERATE_TAGFILE       = @generate_tagfile@
1759
 
1760
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1761
# in the class index. If set to NO only the inherited external classes
1762
# will be listed.
1763
 
1764
ALLEXTERNALS           = YES
1765
 
1766
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1767
# in the modules index. If set to NO, only the current project's groups will
1768
# be listed.
1769
 
1770
EXTERNAL_GROUPS        = YES
1771
 
1772
# The PERL_PATH should be the absolute path and name of the perl script
1773
# interpreter (i.e. the result of `which perl').
1774
 
1775
PERL_PATH              = /usr/bin/perl
1776
 
1777
#---------------------------------------------------------------------------
1778
# Configuration options related to the dot tool
1779
#---------------------------------------------------------------------------
1780
 
1781
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1782
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1783
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1784
# this option also works with HAVE_DOT disabled, but it is recommended to
1785
# install and use dot, since it yields more powerful graphs.
1786
 
1787
CLASS_DIAGRAMS         = YES
1788
 
1789
# You can define message sequence charts within doxygen comments using the \msc
1790
# command. Doxygen will then run the mscgen tool (see
1791
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1792
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1793
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1794
# default search path.
1795
 
1796
MSCGEN_PATH            =
1797
 
1798
# If set to YES, the inheritance and collaboration graphs will hide
1799
# inheritance and usage relations if the target is undocumented
1800
# or is not a class.
1801
 
1802
HIDE_UNDOC_RELATIONS   = NO
1803
 
1804
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1805
# available from the path. This tool is part of Graphviz, a graph visualization
1806
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1807
# have no effect if this option is set to NO (the default)
1808
 
1809
HAVE_DOT               = YES
1810
 
1811
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1812
# allowed to run in parallel. When set to 0 (the default) doxygen will
1813
# base this on the number of processors available in the system. You can set it
1814
# explicitly to a value larger than 0 to get control over the balance
1815
# between CPU load and processing speed.
1816
 
1817
DOT_NUM_THREADS        = 0
1818
 
1819
# By default doxygen will use the Helvetica font for all dot files that
1820
# doxygen generates. When you want a differently looking font you can specify
1821
# the font name using DOT_FONTNAME. You need to make sure dot is able to find
1822
# the font, which can be done by putting it in a standard location or by setting
1823
# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1824
# directory containing the font.
1825
 
1826
DOT_FONTNAME           = FreeSans
1827
 
1828
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1829
# The default size is 10pt.
1830
 
1831
DOT_FONTSIZE           = 9
1832
 
1833
# By default doxygen will tell dot to use the Helvetica font.
1834
# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1835
# set the path where dot can find it.
1836
 
1837
DOT_FONTPATH           =
1838
 
1839
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1840
# will generate a graph for each documented class showing the direct and
1841
# indirect inheritance relations. Setting this tag to YES will force the
1842
# CLASS_DIAGRAMS tag to NO.
1843
 
1844
CLASS_GRAPH            = YES
1845
 
1846
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1847
# will generate a graph for each documented class showing the direct and
1848
# indirect implementation dependencies (inheritance, containment, and
1849
# class references variables) of the class with other documented classes.
1850
 
1851
COLLABORATION_GRAPH    = NO
1852
 
1853
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1854
# will generate a graph for groups, showing the direct groups dependencies
1855
 
1856
GROUP_GRAPHS           = YES
1857
 
1858
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1859
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1860
# Language.
1861
 
1862
UML_LOOK               = NO
1863
 
1864
# If set to YES, the inheritance and collaboration graphs will show the
1865
# relations between templates and their instances.
1866
 
1867
TEMPLATE_RELATIONS     = YES
1868
 
1869
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1870
# tags are set to YES then doxygen will generate a graph for each documented
1871
# file showing the direct and indirect include dependencies of the file with
1872
# other documented files.
1873
 
1874
INCLUDE_GRAPH          = NO
1875
 
1876
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1877
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1878
# documented header file showing the documented files that directly or
1879
# indirectly include this file.
1880
 
1881
INCLUDED_BY_GRAPH      = NO
1882
 
1883
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1884
# doxygen will generate a call dependency graph for every global function
1885
# or class method. Note that enabling this option will significantly increase
1886
# the time of a run. So in most cases it will be better to enable call graphs
1887
# for selected functions only using the \callgraph command.
1888
 
1889
CALL_GRAPH             = NO
1890
 
1891
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1892
# doxygen will generate a caller dependency graph for every global function
1893
# or class method. Note that enabling this option will significantly increase
1894
# the time of a run. So in most cases it will be better to enable caller
1895
# graphs for selected functions only using the \callergraph command.
1896
 
1897
CALLER_GRAPH           = NO
1898
 
1899
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1900
# will generate a graphical hierarchy of all classes instead of a textual one.
1901
 
1902
GRAPHICAL_HIERARCHY    = YES
1903
 
1904
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1905
# then doxygen will show the dependencies a directory has on other directories
1906
# in a graphical way. The dependency relations are determined by the #include
1907
# relations between the files in the directories.
1908
 
1909
DIRECTORY_GRAPH        = YES
1910
 
1911
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1912
# generated by dot. Possible values are svg, png, jpg, or gif.
1913
# If left blank png will be used. If you choose svg you need to set
1914
# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1915
# visible in IE 9+ (other browsers do not have this requirement).
1916
 
1917
DOT_IMAGE_FORMAT       = png
1918
 
1919
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1920
# enable generation of interactive SVG images that allow zooming and panning.
1921
# Note that this requires a modern browser other than Internet Explorer.
1922
# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1923
# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1924
# visible. Older versions of IE do not have SVG support.
1925
 
1926
INTERACTIVE_SVG        = NO
1927
 
1928
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1929
# found. If left blank, it is assumed the dot tool can be found in the path.
1930
 
1931
DOT_PATH               =
1932
 
1933
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1934
# contain dot files that are included in the documentation (see the
1935
# \dotfile command).
1936
 
1937
DOTFILE_DIRS           =
1938
 
1939
# The MSCFILE_DIRS tag can be used to specify one or more directories that
1940
# contain msc files that are included in the documentation (see the
1941
# \mscfile command).
1942
 
1943
MSCFILE_DIRS           =
1944
 
1945
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1946
# nodes that will be shown in the graph. If the number of nodes in a graph
1947
# becomes larger than this value, doxygen will truncate the graph, which is
1948
# visualized by representing a node as a red box. Note that doxygen if the
1949
# number of direct children of the root node in a graph is already larger than
1950
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1951
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1952
 
1953
DOT_GRAPH_MAX_NODES    = 50
1954
 
1955
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1956
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1957
# from the root by following a path via at most 3 edges will be shown. Nodes
1958
# that lay further from the root node will be omitted. Note that setting this
1959
# option to 1 or 2 may greatly reduce the computation time needed for large
1960
# code bases. Also note that the size of a graph can be further restricted by
1961
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1962
 
1963
MAX_DOT_GRAPH_DEPTH    = 0
1964
 
1965
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1966
# background. This is disabled by default, because dot on Windows does not
1967
# seem to support this out of the box. Warning: Depending on the platform used,
1968
# enabling this option may lead to badly anti-aliased labels on the edges of
1969
# a graph (i.e. they become hard to read).
1970
 
1971
DOT_TRANSPARENT        = NO
1972
 
1973
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1974
# files in one run (i.e. multiple -o and -T options on the command line). This
1975
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1976
# support this, this feature is disabled by default.
1977
 
1978
DOT_MULTI_TARGETS      = YES
1979
 
1980
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1981
# generate a legend page explaining the meaning of the various boxes and
1982
# arrows in the dot generated graphs.
1983
 
1984
GENERATE_LEGEND        = YES
1985
 
1986
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1987
# remove the intermediate dot files that are used to generate
1988
# the various graphs.
1989
 
1990
DOT_CLEANUP            = YES

powered by: WebSVN 2.1.0

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