~vcs-imports-ii/global/trunk

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