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