« back to all changes in this revision
Viewing changes to docs/Doxyfile1.8.11
- browse files at revision 10
- compare with another revision
- download diff
- download tarball
- view history from revision 10
- Committer: Viktor Bursian
- Date: 2020-07-16 22:38:41 UTC
- mfrom: (9.25.2 DIST) (9.16.21 VB)
- Revision ID: vik@pryanik-20200716223841-0gp0sf6m5imdjtb3
Tags: version_1.5.0
releasing version 1.5.0, closing v.1.4 development
- files added:
- MSDN_LUFA/ISP32U4.BAT
- RAPlugins/FSDminispectro
- RAPlugins/Nelson/MSDN204D Termostat
- RAPlugins/Nelson/MSDN204E DRV8825 StepMotor
- RATests/test32vs64
- help/RANetURI_syntax
- help/RANetURI_syntax/diagram
- shelf
- files removed:
- RANet/GlobalTimeIntervals.h
- RAPlugins/Nelson/MSDN204D CryoRegulator
- files renamed:
- RANet/BasicNet.cpp => shelf/BasicNet.cpp
- RANet/BasicNet.h => shelf/BasicNet.h
- RANet/ProtoNet.cpp => shelf/ProtoNet.cpp
- RANet/ProtoNet.h => shelf/ProtoNet.h
- RANet/SingleFileNet.cpp => shelf/SingleFileNet.cpp
- RANet/SingleFileNet.h => shelf/SingleFileNet.h
- files modified:
- .bzrignore
added
removed
docs/Doxyfile1.8.11
1
# Doxyfile 1.8.11
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 double hash (##) is considered a comment and is placed in
7
# front of the TAG it is preceding.
8
#
9
# All text after a single hash (#) is considered a comment and will be ignored.
10
# The format is:
11
# TAG = value [value, ...]
12
# For lists, items can also be appended using:
13
# TAG += value [value, ...]
14
# Values that contain spaces should be placed between quotes (\" \").
15
16
#---------------------------------------------------------------------------
17
# Project related configuration options
18
#---------------------------------------------------------------------------
19
20
# This tag specifies the encoding used for all characters in the config file
21
# that follow. The default is UTF-8 which is also the encoding used for all text
22
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24
# for the list of possible encodings.
25
# The default value is: UTF-8.
26
27
DOXYFILE_ENCODING = UTF-8
28
29
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30
# double-quotes, unless you are using Doxywizard) that should identify the
31
# project for which the documentation is generated. This name is used in the
32
# title of most generated pages and in a few other places.
33
# The default value is: My Project.
34
35
PROJECT_NAME = RA
36
37
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38
# could be handy for archiving the generated documentation or if some version
39
# control system is used.
40
41
PROJECT_NUMBER =
42
43
# Using the PROJECT_BRIEF tag one can provide an optional one line description
44
# for a project that appears at the top of each page and should give viewer a
45
# quick idea about the purpose of the project. Keep the description short.
46
47
PROJECT_BRIEF = "Research Assistant: source code documentation"
48
49
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50
# in the documentation. The maximum height of the logo should not exceed 55
51
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52
# the logo to the output directory.
53
54
PROJECT_LOGO = RaEye_71x43.png
55
56
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57
# into which the generated documentation will be written. If a relative path is
58
# entered, it will be relative to the location where doxygen was started. If
59
# left blank the current directory will be used.
60
61
OUTPUT_DIRECTORY =
62
63
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64
# directories (in 2 levels) under the output directory of each output format and
65
# will distribute the generated files over these directories. Enabling this
66
# option can be useful when feeding doxygen a huge amount of source files, where
67
# putting all generated files in the same directory would otherwise causes
68
# performance problems for the file system.
69
# The default value is: NO.
70
71
CREATE_SUBDIRS = NO
72
73
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74
# characters to appear in the names of generated files. If set to NO, non-ASCII
75
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76
# U+3044.
77
# The default value is: NO.
78
79
ALLOW_UNICODE_NAMES = NO
80
81
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
82
# documentation generated by doxygen is written. Doxygen will use this
83
# information to generate all constant output in the proper language.
84
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91
# Ukrainian and Vietnamese.
92
# The default value is: English.
93
94
OUTPUT_LANGUAGE = English
95
96
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
97
# descriptions after the members that are listed in the file and class
98
# documentation (similar to Javadoc). Set to NO to disable this.
99
# The default value is: YES.
100
101
BRIEF_MEMBER_DESC = YES
102
103
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104
# description of a member or function before the detailed description
105
#
106
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107
# brief descriptions will be completely suppressed.
108
# The default value is: YES.
109
110
REPEAT_BRIEF = YES
111
112
# This tag implements a quasi-intelligent brief description abbreviator that is
113
# used to form the text in various listings. Each string in this list, if found
114
# as the leading text of the brief description, will be stripped from the text
115
# and the result, after processing the whole list, is used as the annotated
116
# text. Otherwise, the brief description is used as-is. If left blank, the
117
# following values are used ($name is automatically replaced with the name of
118
# the entity):The $name class, The $name widget, The $name file, is, provides,
119
# specifies, contains, represents, a, an and the.
120
121
ABBREVIATE_BRIEF =
122
123
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124
# doxygen will generate a detailed section even if there is only a brief
125
# description.
126
# The default value is: NO.
127
128
ALWAYS_DETAILED_SEC = NO
129
130
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131
# inherited members of a class in the documentation of that class as if those
132
# members were ordinary class members. Constructors, destructors and assignment
133
# operators of the base classes will not be shown.
134
# The default value is: NO.
135
136
INLINE_INHERITED_MEMB = NO
137
138
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
139
# before files name in the file list and in the header files. If set to NO the
140
# shortest path that makes the file name unique will be used
141
# The default value is: YES.
142
143
FULL_PATH_NAMES = YES
144
145
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
146
# Stripping is only done if one of the specified strings matches the left-hand
147
# part of the path. The tag can be used to show relative paths in the file list.
148
# If left blank the directory from which doxygen is run is used as the path to
149
# strip.
150
#
151
# Note that you can specify absolute paths here, but also relative paths, which
152
# will be relative from the directory where doxygen is started.
153
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
154
155
STRIP_FROM_PATH = ../
156
157
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158
# path mentioned in the documentation of a class, which tells the reader which
159
# header file to include in order to use a class. If left blank only the name of
160
# the header file containing the class definition is used. Otherwise one should
161
# specify the list of include paths that are normally passed to the compiler
162
# 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 (but
167
# less readable) file names. This can be useful is your file systems doesn't
168
# support long names like on DOS, Mac, or CD-ROM.
169
# The default value is: NO.
170
171
SHORT_NAMES = NO
172
173
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
174
# first line (until the first dot) of a Javadoc-style comment as the brief
175
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
176
# style comments (thus requiring an explicit @brief command for a brief
177
# description.)
178
# The default value is: NO.
179
180
JAVADOC_AUTOBRIEF = NO
181
182
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183
# line (until the first dot) of a Qt-style comment as the brief description. If
184
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
185
# requiring an explicit \brief command for a brief description.)
186
# The default value is: NO.
187
188
QT_AUTOBRIEF = YES
189
190
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
191
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
192
# a brief description. This used to be the default behavior. The new default is
193
# to treat a multi-line C++ comment block as a detailed description. Set this
194
# tag to YES if you prefer the old behavior instead.
195
#
196
# Note that setting this tag to YES also means that rational rose comments are
197
# not recognized any more.
198
# The default value is: NO.
199
200
MULTILINE_CPP_IS_BRIEF = YES
201
202
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
203
# documentation from any documented member that it re-implements.
204
# The default value is: YES.
205
206
INHERIT_DOCS = YES
207
208
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
209
# page for each member. If set to NO, the documentation of a member will be part
210
# of the file/class/namespace that contains it.
211
# The default value is: NO.
212
213
SEPARATE_MEMBER_PAGES = NO
214
215
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
216
# uses this value to replace tabs by spaces in code fragments.
217
# Minimum value: 1, maximum value: 16, default value: 4.
218
219
TAB_SIZE = 8
220
221
# This tag can be used to specify a number of aliases that act as commands in
222
# the documentation. An alias has the form:
223
# name=value
224
# For example adding
225
# "sideeffect=@par Side Effects:\n"
226
# will allow you to put the command \sideeffect (or @sideeffect) in the
227
# documentation, which will result in a user-defined paragraph with heading
228
# "Side Effects:". You can put \n's in the value part of an alias to insert
229
# newlines.
230
231
ALIASES = "sotovarischam=@xrefitem sotovarischamkey \"Коментарий для со-разработчика\" \"Коментарии для сотоварищей по разработке\"" \
232
"macro=@xrefitem macrodefs \"Macro\" \"Macro list\"" \
233
"todo{1}=@xrefitem todo_\1 \"Todo [\1]\" \"Todo list for category [\1]\"" \
234
"patch{1}=@xrefitem patch_\1 \"Patch [\1]\" \"Patch list for category [\1]\"" \
235
"patch=@xrefitem patchitem \"Patch\" \"Patch list\""
236
237
# This tag can be used to specify a number of word-keyword mappings (TCL only).
238
# A mapping has the form "name=value". For example adding "class=itcl::class"
239
# will allow you to use the command class in the itcl::class meaning.
240
241
TCL_SUBST =
242
243
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
244
# only. Doxygen will then generate output that is more tailored for C. For
245
# instance, some of the names that are used will be different. The list of all
246
# members will be omitted, etc.
247
# The default value is: NO.
248
249
OPTIMIZE_OUTPUT_FOR_C = NO
250
251
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
252
# Python sources only. Doxygen will then generate output that is more tailored
253
# for that language. For instance, namespaces will be presented as packages,
254
# qualified scopes will look different, etc.
255
# The default value is: NO.
256
257
OPTIMIZE_OUTPUT_JAVA = NO
258
259
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
260
# sources. Doxygen will then generate output that is tailored for Fortran.
261
# The default value is: NO.
262
263
OPTIMIZE_FOR_FORTRAN = NO
264
265
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
266
# sources. Doxygen will then generate output that is tailored for VHDL.
267
# The default value is: NO.
268
269
OPTIMIZE_OUTPUT_VHDL = NO
270
271
# Doxygen selects the parser to use depending on the extension of the files it
272
# parses. With this tag you can assign which parser to use for a given
273
# extension. Doxygen has a built-in mapping, but you can override or extend it
274
# using this tag. The format is ext=language, where ext is a file extension, and
275
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
276
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
277
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
278
# Fortran. In the later case the parser tries to guess whether the code is fixed
279
# or free formatted code, this is the default for Fortran type files), VHDL. For
280
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
281
# and .f files as C (default is Fortran), use: inc=Fortran f=C.
282
#
283
# Note: For files without extension you can use no_extension as a placeholder.
284
#
285
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
286
# the files are not read by doxygen.
287
288
EXTENSION_MAPPING =
289
290
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
291
# according to the Markdown format, which allows for more readable
292
# documentation. See http://daringfireball.net/projects/markdown/ for details.
293
# The output of markdown processing is further processed by doxygen, so you can
294
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
295
# case of backward compatibilities issues.
296
# The default value is: YES.
297
298
MARKDOWN_SUPPORT = YES
299
300
# When enabled doxygen tries to link words that correspond to documented
301
# classes, or namespaces to their corresponding documentation. Such a link can
302
# be prevented in individual cases by putting a % sign in front of the word or
303
# globally by setting AUTOLINK_SUPPORT to NO.
304
# The default value is: YES.
305
306
AUTOLINK_SUPPORT = YES
307
308
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
309
# to include (a tag file for) the STL sources as input, then you should set this
310
# tag to YES in order to let doxygen match functions declarations and
311
# definitions whose arguments contain STL classes (e.g. func(std::string);
312
# versus func(std::string) {}). This also make the inheritance and collaboration
313
# diagrams that involve STL classes more complete and accurate.
314
# The default value is: NO.
315
316
BUILTIN_STL_SUPPORT = YES
317
318
# If you use Microsoft's C++/CLI language, you should set this option to YES to
319
# enable parsing support.
320
# The default value is: NO.
321
322
CPP_CLI_SUPPORT = NO
323
324
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
325
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
326
# will parse them like normal C++ but will assume all classes use public instead
327
# of private inheritance when no explicit protection keyword is present.
328
# The default value is: NO.
329
330
SIP_SUPPORT = NO
331
332
# For Microsoft's IDL there are propget and propput attributes to indicate
333
# getter and setter methods for a property. Setting this option to YES will make
334
# doxygen to replace the get and set methods by a property in the documentation.
335
# This will only work if the methods are indeed getting or setting a simple
336
# type. If this is not the case, or you want to show the methods anyway, you
337
# should set this option to NO.
338
# The default value is: YES.
339
340
IDL_PROPERTY_SUPPORT = YES
341
342
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
343
# tag is set to YES then doxygen will reuse the documentation of the first
344
# member in the group (if any) for the other members of the group. By default
345
# all members of a group must be documented explicitly.
346
# The default value is: NO.
347
348
DISTRIBUTE_GROUP_DOC = NO
349
350
# If one adds a struct or class to a group and this option is enabled, then also
351
# any nested class or struct is added to the same group. By default this option
352
# is disabled and one has to add nested compounds explicitly via \ingroup.
353
# The default value is: NO.
354
355
GROUP_NESTED_COMPOUNDS = NO
356
357
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
358
# (for instance a group of public functions) to be put as a subgroup of that
359
# type (e.g. under the Public Functions section). Set it to NO to prevent
360
# subgrouping. Alternatively, this can be done per class using the
361
# \nosubgrouping command.
362
# The default value is: YES.
363
364
SUBGROUPING = YES
365
366
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
367
# are shown inside the group in which they are included (e.g. using \ingroup)
368
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
369
# and RTF).
370
#
371
# Note that this feature does not work in combination with
372
# SEPARATE_MEMBER_PAGES.
373
# The default value is: NO.
374
375
INLINE_GROUPED_CLASSES = NO
376
377
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
378
# with only public data fields or simple typedef fields will be shown inline in
379
# the documentation of the scope in which they are defined (i.e. file,
380
# namespace, or group documentation), provided this scope is documented. If set
381
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
382
# Man pages) or section (for LaTeX and RTF).
383
# The default value is: NO.
384
385
INLINE_SIMPLE_STRUCTS = NO
386
387
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
388
# enum is documented as struct, union, or enum with the name of the typedef. So
389
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
390
# with name TypeT. When disabled the typedef will appear as a member of a file,
391
# namespace, or class. And the struct will be named TypeS. This can typically be
392
# useful for C code in case the coding convention dictates that all compound
393
# types are typedef'ed and only the typedef is referenced, never the tag name.
394
# The default value is: NO.
395
396
TYPEDEF_HIDES_STRUCT = NO
397
398
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
399
# cache is used to resolve symbols given their name and scope. Since this can be
400
# an expensive process and often the same symbol appears multiple times in the
401
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
402
# doxygen will become slower. If the cache is too large, memory is wasted. The
403
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
404
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
405
# symbols. At the end of a run doxygen will report the cache usage and suggest
406
# the optimal cache size from a speed point of view.
407
# Minimum value: 0, maximum value: 9, default value: 0.
408
409
LOOKUP_CACHE_SIZE = 0
410
411
#---------------------------------------------------------------------------
412
# Build related configuration options
413
#---------------------------------------------------------------------------
414
415
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
416
# documentation are documented, even if no documentation was available. Private
417
# class members and static file members will be hidden unless the
418
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
419
# Note: This will also disable the warnings about undocumented members that are
420
# normally produced when WARNINGS is set to YES.
421
# The default value is: NO.
422
423
EXTRACT_ALL = YES
424
425
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
426
# be included in the documentation.
427
# The default value is: NO.
428
429
EXTRACT_PRIVATE = YES
430
431
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
432
# scope will be included in the documentation.
433
# The default value is: NO.
434
435
EXTRACT_PACKAGE = NO
436
437
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
438
# included in the documentation.
439
# The default value is: NO.
440
441
EXTRACT_STATIC = YES
442
443
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
444
# locally in source files will be included in the documentation. If set to NO,
445
# only classes defined in header files are included. Does not have any effect
446
# for Java sources.
447
# The default value is: YES.
448
449
EXTRACT_LOCAL_CLASSES = YES
450
451
# This flag is only useful for Objective-C code. If set to YES, local methods,
452
# which are defined in the implementation section but not in the interface are
453
# included in the documentation. If set to NO, only methods in the interface are
454
# included.
455
# The default value is: NO.
456
457
EXTRACT_LOCAL_METHODS = NO
458
459
# If this flag is set to YES, the members of anonymous namespaces will be
460
# extracted and appear in the documentation as a namespace called
461
# 'anonymous_namespace{file}', where file will be replaced with the base name of
462
# the file that contains the anonymous namespace. By default anonymous namespace
463
# are hidden.
464
# The default value is: NO.
465
466
EXTRACT_ANON_NSPACES = NO
467
468
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
469
# undocumented members inside documented classes or files. If set to NO these
470
# members will be included in the various overviews, but no documentation
471
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
472
# The default value is: NO.
473
474
HIDE_UNDOC_MEMBERS = NO
475
476
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
477
# undocumented classes that are normally visible in the class hierarchy. If set
478
# to NO, these classes will be included in the various overviews. This option
479
# has no effect if EXTRACT_ALL is enabled.
480
# The default value is: NO.
481
482
HIDE_UNDOC_CLASSES = NO
483
484
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
485
# (class|struct|union) declarations. If set to NO, these declarations will be
486
# included in the documentation.
487
# The default value is: NO.
488
489
HIDE_FRIEND_COMPOUNDS = NO
490
491
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
492
# documentation blocks found inside the body of a function. If set to NO, these
493
# blocks will be appended to the function's detailed documentation block.
494
# The default value is: NO.
495
496
HIDE_IN_BODY_DOCS = NO
497
498
# The INTERNAL_DOCS tag determines if documentation that is typed after a
499
# \internal command is included. If the tag is set to NO then the documentation
500
# will be excluded. Set it to YES to include the internal documentation.
501
# The default value is: NO.
502
503
INTERNAL_DOCS = NO
504
505
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
506
# names in lower-case letters. If set to YES, upper-case letters are also
507
# allowed. This is useful if you have classes or files whose names only differ
508
# in case and if your file system supports case sensitive file names. Windows
509
# and Mac users are advised to set this option to NO.
510
# The default value is: system dependent.
511
512
CASE_SENSE_NAMES = YES
513
514
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
515
# their full class and namespace scopes in the documentation. If set to YES, the
516
# scope will be hidden.
517
# The default value is: NO.
518
519
HIDE_SCOPE_NAMES = NO
520
521
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
522
# append additional text to a page's title, such as Class Reference. If set to
523
# YES the compound reference will be hidden.
524
# The default value is: NO.
525
526
HIDE_COMPOUND_REFERENCE= NO
527
528
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
529
# the files that are included by a file in the documentation of that file.
530
# The default value is: YES.
531
532
SHOW_INCLUDE_FILES = YES
533
534
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
535
# grouped member an include statement to the documentation, telling the reader
536
# which file to include in order to use the member.
537
# The default value is: NO.
538
539
SHOW_GROUPED_MEMB_INC = NO
540
541
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
542
# files with double quotes in the documentation rather than with sharp brackets.
543
# The default value is: NO.
544
545
FORCE_LOCAL_INCLUDES = NO
546
547
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
548
# documentation for inline members.
549
# The default value is: YES.
550
551
INLINE_INFO = YES
552
553
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
554
# (detailed) documentation of file and class members alphabetically by member
555
# name. If set to NO, the members will appear in declaration order.
556
# The default value is: YES.
557
558
SORT_MEMBER_DOCS = YES
559
560
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
561
# descriptions of file, namespace and class members alphabetically by member
562
# name. If set to NO, the members will appear in declaration order. Note that
563
# this will also influence the order of the classes in the class list.
564
# The default value is: NO.
565
566
SORT_BRIEF_DOCS = NO
567
568
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
569
# (brief and detailed) documentation of class members so that constructors and
570
# destructors are listed first. If set to NO the constructors will appear in the
571
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
572
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
573
# member documentation.
574
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
575
# detailed member documentation.
576
# The default value is: NO.
577
578
SORT_MEMBERS_CTORS_1ST = NO
579
580
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
581
# of group names into alphabetical order. If set to NO the group names will
582
# appear in their defined order.
583
# The default value is: NO.
584
585
SORT_GROUP_NAMES = NO
586
587
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
588
# fully-qualified names, including namespaces. If set to NO, the class list will
589
# be sorted only by class name, not including the namespace part.
590
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
591
# Note: This option applies only to the class list, not to the alphabetical
592
# list.
593
# The default value is: NO.
594
595
SORT_BY_SCOPE_NAME = NO
596
597
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
598
# type resolution of all parameters of a function it will reject a match between
599
# the prototype and the implementation of a member function even if there is
600
# only one candidate or it is obvious which candidate to choose by doing a
601
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
602
# accept a match between prototype and implementation in such cases.
603
# The default value is: NO.
604
605
STRICT_PROTO_MATCHING = NO
606
607
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
608
# list. This list is created by putting \todo commands in the documentation.
609
# The default value is: YES.
610
611
GENERATE_TODOLIST = YES
612
613
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
614
# list. This list is created by putting \test commands in the documentation.
615
# The default value is: YES.
616
617
GENERATE_TESTLIST = YES
618
619
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
620
# list. This list is created by putting \bug commands in the documentation.
621
# The default value is: YES.
622
623
GENERATE_BUGLIST = YES
624
625
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
626
# the deprecated list. This list is created by putting \deprecated commands in
627
# the documentation.
628
# The default value is: YES.
629
630
GENERATE_DEPRECATEDLIST= YES
631
632
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
633
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
634
# ... \endcond blocks.
635
636
ENABLED_SECTIONS =
637
638
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
639
# initial value of a variable or macro / define can have for it to appear in the
640
# documentation. If the initializer consists of more lines than specified here
641
# it will be hidden. Use a value of 0 to hide initializers completely. The
642
# appearance of the value of individual variables and macros / defines can be
643
# controlled using \showinitializer or \hideinitializer command in the
644
# documentation regardless of this setting.
645
# Minimum value: 0, maximum value: 10000, default value: 30.
646
647
MAX_INITIALIZER_LINES = 30
648
649
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
650
# the bottom of the documentation of classes and structs. If set to YES, the
651
# list will mention the files that were used to generate the documentation.
652
# The default value is: YES.
653
654
SHOW_USED_FILES = YES
655
656
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
657
# will remove the Files entry from the Quick Index and from the Folder Tree View
658
# (if specified).
659
# The default value is: YES.
660
661
SHOW_FILES = YES
662
663
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
664
# page. This will remove the Namespaces entry from the Quick Index and from the
665
# Folder Tree View (if specified).
666
# The default value is: YES.
667
668
SHOW_NAMESPACES = YES
669
670
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
671
# doxygen should invoke to get the current version for each file (typically from
672
# the version control system). Doxygen will invoke the program by executing (via
673
# popen()) the command command input-file, where command is the value of the
674
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
675
# by doxygen. Whatever the program writes to standard output is used as the file
676
# version. For an example see the documentation.
677
678
FILE_VERSION_FILTER =
679
680
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
681
# by doxygen. The layout file controls the global structure of the generated
682
# output files in an output format independent way. To create the layout file
683
# that represents doxygen's defaults, run doxygen with the -l option. You can
684
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
685
# will be used as the name of the layout file.
686
#
687
# Note that if you run doxygen from a directory containing a file called
688
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
689
# tag is left empty.
690
691
LAYOUT_FILE =
692
693
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
694
# the reference definitions. This must be a list of .bib files. The .bib
695
# extension is automatically appended if omitted. This requires the bibtex tool
696
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
697
# For LaTeX the style of the bibliography can be controlled using
698
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
699
# search path. See also \cite for info how to create references.
700
701
CITE_BIB_FILES =
702
703
#---------------------------------------------------------------------------
704
# Configuration options related to warning and progress messages
705
#---------------------------------------------------------------------------
706
707
# The QUIET tag can be used to turn on/off the messages that are generated to
708
# standard output by doxygen. If QUIET is set to YES this implies that the
709
# messages are off.
710
# The default value is: NO.
711
712
QUIET = YES
713
714
# The WARNINGS tag can be used to turn on/off the warning messages that are
715
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
716
# this implies that the warnings are on.
717
#
718
# Tip: Turn warnings on while writing the documentation.
719
# The default value is: YES.
720
721
WARNINGS = NO
722
723
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
724
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
725
# will automatically be disabled.
726
# The default value is: YES.
727
728
WARN_IF_UNDOCUMENTED = YES
729
730
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
731
# potential errors in the documentation, such as not documenting some parameters
732
# in a documented function, or documenting parameters that don't exist or using
733
# markup commands wrongly.
734
# The default value is: YES.
735
736
WARN_IF_DOC_ERROR = YES
737
738
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
739
# are documented, but have no documentation for their parameters or return
740
# value. If set to NO, doxygen will only warn about wrong or incomplete
741
# parameter documentation, but not about the absence of documentation.
742
# The default value is: NO.
743
744
WARN_NO_PARAMDOC = NO
745
746
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
747
# a warning is encountered.
748
# The default value is: NO.
749
750
WARN_AS_ERROR = NO
751
752
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
753
# can produce. The string should contain the $file, $line, and $text tags, which
754
# will be replaced by the file and line number from which the warning originated
755
# and the warning text. Optionally the format may contain $version, which will
756
# be replaced by the version of the file (if it could be obtained via
757
# FILE_VERSION_FILTER)
758
# The default value is: $file:$line: $text.
759
760
WARN_FORMAT = "$file:$line: $text"
761
762
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
763
# messages should be written. If left blank the output is written to standard
764
# error (stderr).
765
766
WARN_LOGFILE =
767
768
#---------------------------------------------------------------------------
769
# Configuration options related to the input files
770
#---------------------------------------------------------------------------
771
772
# The INPUT tag is used to specify the files and/or directories that contain
773
# documented source files. You may enter file names like myfile.cpp or
774
# directories like /usr/src/myproject. Separate the files or directories with
775
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
776
# Note: If this tag is empty the current directory is searched.
777
778
INPUT = ../
779
780
# This tag can be used to specify the character encoding of the source files
781
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
782
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
783
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
784
# possible encodings.
785
# The default value is: UTF-8.
786
787
INPUT_ENCODING = UTF-8
788
789
# If the value of the INPUT tag contains directories, you can use the
790
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
791
# *.h) to filter out the source-files in the directories.
792
#
793
# Note that for custom extensions or not directly supported extensions you also
794
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
795
# read by doxygen.
796
#
797
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
798
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
799
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
800
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
801
# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
802
803
FILE_PATTERNS = *.h \
804
*.hpp \
805
*.cpp \
806
*.dox \
807
HistoryLog.txt
808
809
# The RECURSIVE tag can be used to specify whether or not subdirectories should
810
# be searched for input files as well.
811
# The default value is: NO.
812
813
RECURSIVE = YES
814
815
# The EXCLUDE tag can be used to specify files and/or directories that should be
816
# excluded from the INPUT source files. This way you can easily exclude a
817
# subdirectory from a directory tree whose root is specified with the INPUT tag.
818
#
819
# Note that relative paths are relative to the directory from which doxygen is
820
# run.
821
822
EXCLUDE = ../RATests/ \
823
../shelf/ \
824
../what-not/
825
826
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
827
# directories that are symbolic links (a Unix file system feature) are excluded
828
# from the input.
829
# The default value is: NO.
830
831
EXCLUDE_SYMLINKS = NO
832
833
# If the value of the INPUT tag contains directories, you can use the
834
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
835
# certain files from those directories.
836
#
837
# Note that the wildcards are matched against the file with absolute path, so to
838
# exclude all test directories for example use the pattern */test/*
839
840
EXCLUDE_PATTERNS = moc_* \
841
qrc_*
842
843
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
844
# (namespaces, classes, functions, etc.) that should be excluded from the
845
# output. The symbol name can be a fully qualified name, a word, or if the
846
# wildcard * is used, a substring. Examples: ANamespace, AClass,
847
# AClass::ANamespace, ANamespace::*Test
848
#
849
# Note that the wildcards are matched against the file with absolute path, so to
850
# exclude all test directories use the pattern */test/*
851
852
EXCLUDE_SYMBOLS =
853
854
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
855
# that contain example code fragments that are included (see the \include
856
# command).
857
858
EXAMPLE_PATH =
859
860
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
861
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
862
# *.h) to filter out the source-files in the directories. If left blank all
863
# files are included.
864
865
EXAMPLE_PATTERNS =
866
867
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
868
# searched for input files to be used with the \include or \dontinclude commands
869
# irrespective of the value of the RECURSIVE tag.
870
# The default value is: NO.
871
872
EXAMPLE_RECURSIVE = NO
873
874
# The IMAGE_PATH tag can be used to specify one or more files or directories
875
# that contain images that are to be included in the documentation (see the
876
# \image command).
877
878
IMAGE_PATH =
879
880
# The INPUT_FILTER tag can be used to specify a program that doxygen should
881
# invoke to filter for each input file. Doxygen will invoke the filter program
882
# by executing (via popen()) the command:
883
#
884
# <filter> <input-file>
885
#
886
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
887
# name of an input file. Doxygen will then use the output that the filter
888
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
889
# will be ignored.
890
#
891
# Note that the filter must not add or remove lines; it is applied before the
892
# code is scanned, but not when the output code is generated. If lines are added
893
# or removed, the anchors will not be placed correctly.
894
#
895
# Note that for custom extensions or not directly supported extensions you also
896
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
897
# properly processed by doxygen.
898
899
INPUT_FILTER =
900
901
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
902
# basis. Doxygen will compare the file name with each pattern and apply the
903
# filter if there is a match. The filters are a list of the form: pattern=filter
904
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
905
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
906
# patterns match the file name, INPUT_FILTER is applied.
907
#
908
# Note that for custom extensions or not directly supported extensions you also
909
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
910
# properly processed by doxygen.
911
912
FILTER_PATTERNS =
913
914
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
915
# INPUT_FILTER) will also be used to filter the input files that are used for
916
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
917
# The default value is: NO.
918
919
FILTER_SOURCE_FILES = NO
920
921
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
922
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
923
# it is also possible to disable source filtering for a specific pattern using
924
# *.ext= (so without naming a filter).
925
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
926
927
FILTER_SOURCE_PATTERNS =
928
929
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
930
# is part of the input, its contents will be placed on the main page
931
# (index.html). This can be useful if you have a project on for instance GitHub
932
# and want to reuse the introduction page also for the doxygen output.
933
934
USE_MDFILE_AS_MAINPAGE =
935
936
#---------------------------------------------------------------------------
937
# Configuration options related to source browsing
938
#---------------------------------------------------------------------------
939
940
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
941
# generated. Documented entities will be cross-referenced with these sources.
942
#
943
# Note: To get rid of all source code in the generated output, make sure that
944
# also VERBATIM_HEADERS is set to NO.
945
# The default value is: NO.
946
947
SOURCE_BROWSER = NO
948
949
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
950
# classes and enums directly into the documentation.
951
# The default value is: NO.
952
953
INLINE_SOURCES = NO
954
955
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
956
# special comment blocks from generated source code fragments. Normal C, C++ and
957
# Fortran comments will always remain visible.
958
# The default value is: YES.
959
960
STRIP_CODE_COMMENTS = YES
961
962
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
963
# function all documented functions referencing it will be listed.
964
# The default value is: NO.
965
966
REFERENCED_BY_RELATION = NO
967
968
# If the REFERENCES_RELATION tag is set to YES then for each documented function
969
# all documented entities called/used by that function will be listed.
970
# The default value is: NO.
971
972
REFERENCES_RELATION = NO
973
974
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
975
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
976
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
977
# link to the documentation.
978
# The default value is: YES.
979
980
REFERENCES_LINK_SOURCE = YES
981
982
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
983
# source code will show a tooltip with additional information such as prototype,
984
# brief description and links to the definition and documentation. Since this
985
# will make the HTML file larger and loading of large files a bit slower, you
986
# can opt to disable this feature.
987
# The default value is: YES.
988
# This tag requires that the tag SOURCE_BROWSER is set to YES.
989
990
SOURCE_TOOLTIPS = YES
991
992
# If the USE_HTAGS tag is set to YES then the references to source code will
993
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
994
# source browser. The htags tool is part of GNU's global source tagging system
995
# (see http://www.gnu.org/software/global/global.html). You will need version
996
# 4.8.6 or higher.
997
#
998
# To use it do the following:
999
# - Install the latest version of global
1000
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1001
# - Make sure the INPUT points to the root of the source tree
1002
# - Run doxygen as normal
1003
#
1004
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1005
# tools must be available from the command line (i.e. in the search path).
1006
#
1007
# The result: instead of the source browser generated by doxygen, the links to
1008
# source code will now point to the output of htags.
1009
# The default value is: NO.
1010
# This tag requires that the tag SOURCE_BROWSER is set to YES.
1011
1012
USE_HTAGS = NO
1013
1014
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1015
# verbatim copy of the header file for each class for which an include is
1016
# specified. Set to NO to disable this.
1017
# See also: Section \class.
1018
# The default value is: YES.
1019
1020
VERBATIM_HEADERS = NO
1021
1022
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1023
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1024
# cost of reduced performance. This can be particularly helpful with template
1025
# rich C++ code for which doxygen's built-in parser lacks the necessary type
1026
# information.
1027
# Note: The availability of this option depends on whether or not doxygen was
1028
# generated with the -Duse-libclang=ON option for CMake.
1029
# The default value is: NO.
1030
1031
CLANG_ASSISTED_PARSING = NO
1032
1033
# If clang assisted parsing is enabled you can provide the compiler with command
1034
# line options that you would normally use when invoking the compiler. Note that
1035
# the include paths will already be set by doxygen for the files and directories
1036
# specified with INPUT and INCLUDE_PATH.
1037
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1038
1039
CLANG_OPTIONS =
1040
1041
#---------------------------------------------------------------------------
1042
# Configuration options related to the alphabetical class index
1043
#---------------------------------------------------------------------------
1044
1045
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1046
# compounds will be generated. Enable this if the project contains a lot of
1047
# classes, structs, unions or interfaces.
1048
# The default value is: YES.
1049
1050
ALPHABETICAL_INDEX = YES
1051
1052
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1053
# which the alphabetical index list will be split.
1054
# Minimum value: 1, maximum value: 20, default value: 5.
1055
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1056
1057
COLS_IN_ALPHA_INDEX = 5
1058
1059
# In case all classes in a project start with a common prefix, all classes will
1060
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1061
# can be used to specify a prefix (or a list of prefixes) that should be ignored
1062
# while generating the index headers.
1063
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1064
1065
IGNORE_PREFIX = s
1066
1067
#---------------------------------------------------------------------------
1068
# Configuration options related to the HTML output
1069
#---------------------------------------------------------------------------
1070
1071
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1072
# The default value is: YES.
1073
1074
GENERATE_HTML = YES
1075
1076
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1077
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1078
# it.
1079
# The default directory is: html.
1080
# This tag requires that the tag GENERATE_HTML is set to YES.
1081
1082
HTML_OUTPUT = html
1083
1084
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1085
# generated HTML page (for example: .htm, .php, .asp).
1086
# The default value is: .html.
1087
# This tag requires that the tag GENERATE_HTML is set to YES.
1088
1089
HTML_FILE_EXTENSION = .html
1090
1091
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1092
# each generated HTML page. If the tag is left blank doxygen will generate a
1093
# standard header.
1094
#
1095
# To get valid HTML the header file that includes any scripts and style sheets
1096
# that doxygen needs, which is dependent on the configuration options used (e.g.
1097
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1098
# default header using
1099
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1100
# YourConfigFile
1101
# and then modify the file new_header.html. See also section "Doxygen usage"
1102
# for information on how to generate the default header that doxygen normally
1103
# uses.
1104
# Note: The header is subject to change so you typically have to regenerate the
1105
# default header when upgrading to a newer version of doxygen. For a description
1106
# of the possible markers and block names see the documentation.
1107
# This tag requires that the tag GENERATE_HTML is set to YES.
1108
1109
HTML_HEADER =
1110
1111
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1112
# generated HTML page. If the tag is left blank doxygen will generate a standard
1113
# footer. See HTML_HEADER for more information on how to generate a default
1114
# footer and what special commands can be used inside the footer. See also
1115
# section "Doxygen usage" for information on how to generate the default footer
1116
# that doxygen normally uses.
1117
# This tag requires that the tag GENERATE_HTML is set to YES.
1118
1119
HTML_FOOTER =
1120
1121
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1122
# sheet that is used by each HTML page. It can be used to fine-tune the look of
1123
# the HTML output. If left blank doxygen will generate a default style sheet.
1124
# See also section "Doxygen usage" for information on how to generate the style
1125
# sheet that doxygen normally uses.
1126
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1127
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1128
# obsolete.
1129
# This tag requires that the tag GENERATE_HTML is set to YES.
1130
1131
HTML_STYLESHEET =
1132
1133
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1134
# cascading style sheets that are included after the standard style sheets
1135
# created by doxygen. Using this option one can overrule certain style aspects.
1136
# This is preferred over using HTML_STYLESHEET since it does not replace the
1137
# standard style sheet and is therefore more robust against future updates.
1138
# Doxygen will copy the style sheet files to the output directory.
1139
# Note: The order of the extra style sheet files is of importance (e.g. the last
1140
# style sheet in the list overrules the setting of the previous ones in the
1141
# list). For an example see the documentation.
1142
# This tag requires that the tag GENERATE_HTML is set to YES.
1143
1144
HTML_EXTRA_STYLESHEET =
1145
1146
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1147
# other source files which should be copied to the HTML output directory. Note
1148
# that these files will be copied to the base HTML output directory. Use the
1149
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1150
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1151
# files will be copied as-is; there are no commands or markers available.
1152
# This tag requires that the tag GENERATE_HTML is set to YES.
1153
1154
HTML_EXTRA_FILES =
1155
1156
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1157
# will adjust the colors in the style sheet and background images according to
1158
# this color. Hue is specified as an angle on a colorwheel, see
1159
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1160
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1161
# purple, and 360 is red again.
1162
# Minimum value: 0, maximum value: 359, default value: 220.
1163
# This tag requires that the tag GENERATE_HTML is set to YES.
1164
1165
HTML_COLORSTYLE_HUE = 220
1166
1167
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1168
# in the HTML output. For a value of 0 the output will use grayscales only. A
1169
# value of 255 will produce the most vivid colors.
1170
# Minimum value: 0, maximum value: 255, default value: 100.
1171
# This tag requires that the tag GENERATE_HTML is set to YES.
1172
1173
HTML_COLORSTYLE_SAT = 100
1174
1175
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1176
# luminance component of the colors in the HTML output. Values below 100
1177
# gradually make the output lighter, whereas values above 100 make the output
1178
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1179
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1180
# change the gamma.
1181
# Minimum value: 40, maximum value: 240, default value: 80.
1182
# This tag requires that the tag GENERATE_HTML is set to YES.
1183
1184
HTML_COLORSTYLE_GAMMA = 80
1185
1186
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1187
# page will contain the date and time when the page was generated. Setting this
1188
# to YES can help to show when doxygen was last run and thus if the
1189
# documentation is up to date.
1190
# The default value is: NO.
1191
# This tag requires that the tag GENERATE_HTML is set to YES.
1192
1193
HTML_TIMESTAMP = YES
1194
1195
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1196
# documentation will contain sections that can be hidden and shown after the
1197
# page has loaded.
1198
# The default value is: NO.
1199
# This tag requires that the tag GENERATE_HTML is set to YES.
1200
1201
HTML_DYNAMIC_SECTIONS = NO
1202
1203
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1204
# shown in the various tree structured indices initially; the user can expand
1205
# and collapse entries dynamically later on. Doxygen will expand the tree to
1206
# such a level that at most the specified number of entries are visible (unless
1207
# a fully collapsed tree already exceeds this amount). So setting the number of
1208
# entries 1 will produce a full collapsed tree by default. 0 is a special value
1209
# representing an infinite number of entries and will result in a full expanded
1210
# tree by default.
1211
# Minimum value: 0, maximum value: 9999, default value: 100.
1212
# This tag requires that the tag GENERATE_HTML is set to YES.
1213
1214
HTML_INDEX_NUM_ENTRIES = 100
1215
1216
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1217
# generated that can be used as input for Apple's Xcode 3 integrated development
1218
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1219
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1220
# Makefile in the HTML output directory. Running make will produce the docset in
1221
# that directory and running make install will install the docset in
1222
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1223
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1224
# for more information.
1225
# The default value is: NO.
1226
# This tag requires that the tag GENERATE_HTML is set to YES.
1227
1228
GENERATE_DOCSET = NO
1229
1230
# This tag determines the name of the docset feed. A documentation feed provides
1231
# an umbrella under which multiple documentation sets from a single provider
1232
# (such as a company or product suite) can be grouped.
1233
# The default value is: Doxygen generated docs.
1234
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1235
1236
DOCSET_FEEDNAME = "Doxygen generated docs"
1237
1238
# This tag specifies a string that should uniquely identify the documentation
1239
# set bundle. This should be a reverse domain-name style string, e.g.
1240
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1241
# The default value is: org.doxygen.Project.
1242
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1243
1244
DOCSET_BUNDLE_ID = org.doxygen.Project
1245
1246
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1247
# the documentation publisher. This should be a reverse domain-name style
1248
# string, e.g. com.mycompany.MyDocSet.documentation.
1249
# The default value is: org.doxygen.Publisher.
1250
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1251
1252
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1253
1254
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1255
# The default value is: Publisher.
1256
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1257
1258
DOCSET_PUBLISHER_NAME = Publisher
1259
1260
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1261
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1262
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1263
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1264
# Windows.
1265
#
1266
# The HTML Help Workshop contains a compiler that can convert all HTML output
1267
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1268
# files are now used as the Windows 98 help format, and will replace the old
1269
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1270
# HTML files also contain an index, a table of contents, and you can search for
1271
# words in the documentation. The HTML workshop also contains a viewer for
1272
# compressed HTML files.
1273
# The default value is: NO.
1274
# This tag requires that the tag GENERATE_HTML is set to YES.
1275
1276
GENERATE_HTMLHELP = NO
1277
1278
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1279
# file. You can add a path in front of the file if the result should not be
1280
# written to the html output directory.
1281
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1282
1283
CHM_FILE =
1284
1285
# The HHC_LOCATION tag can be used to specify the location (absolute path
1286
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1287
# doxygen will try to run the HTML help compiler on the generated index.hhp.
1288
# The file has to be specified with full path.
1289
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1290
1291
HHC_LOCATION =
1292
1293
# The GENERATE_CHI flag controls if a separate .chi index file is generated
1294
# (YES) or that it should be included in the master .chm file (NO).
1295
# The default value is: NO.
1296
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1297
1298
GENERATE_CHI = NO
1299
1300
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1301
# and project file content.
1302
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1303
1304
CHM_INDEX_ENCODING =
1305
1306
# The BINARY_TOC flag controls whether a binary table of contents is generated
1307
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1308
# enables the Previous and Next buttons.
1309
# The default value is: NO.
1310
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1311
1312
BINARY_TOC = NO
1313
1314
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1315
# the table of contents of the HTML help documentation and to the tree view.
1316
# The default value is: NO.
1317
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1318
1319
TOC_EXPAND = NO
1320
1321
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1322
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1323
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1324
# (.qch) of the generated HTML documentation.
1325
# The default value is: NO.
1326
# This tag requires that the tag GENERATE_HTML is set to YES.
1327
1328
GENERATE_QHP = NO
1329
1330
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1331
# the file name of the resulting .qch file. The path specified is relative to
1332
# the HTML output folder.
1333
# This tag requires that the tag GENERATE_QHP is set to YES.
1334
1335
QCH_FILE =
1336
1337
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1338
# Project output. For more information please see Qt Help Project / Namespace
1339
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1340
# The default value is: org.doxygen.Project.
1341
# This tag requires that the tag GENERATE_QHP is set to YES.
1342
1343
QHP_NAMESPACE = org.doxygen.Project
1344
1345
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1346
# Help Project output. For more information please see Qt Help Project / Virtual
1347
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1348
# folders).
1349
# The default value is: doc.
1350
# This tag requires that the tag GENERATE_QHP is set to YES.
1351
1352
QHP_VIRTUAL_FOLDER = doc
1353
1354
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1355
# filter to add. For more information please see Qt Help Project / Custom
1356
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1357
# filters).
1358
# This tag requires that the tag GENERATE_QHP is set to YES.
1359
1360
QHP_CUST_FILTER_NAME =
1361
1362
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1363
# custom filter to add. For more information please see Qt Help Project / Custom
1364
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1365
# filters).
1366
# This tag requires that the tag GENERATE_QHP is set to YES.
1367
1368
QHP_CUST_FILTER_ATTRS =
1369
1370
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1371
# project's filter section matches. Qt Help Project / Filter Attributes (see:
1372
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1373
# This tag requires that the tag GENERATE_QHP is set to YES.
1374
1375
QHP_SECT_FILTER_ATTRS =
1376
1377
# The QHG_LOCATION tag can be used to specify the location of Qt's
1378
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1379
# generated .qhp file.
1380
# This tag requires that the tag GENERATE_QHP is set to YES.
1381
1382
QHG_LOCATION =
1383
1384
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1385
# generated, together with the HTML files, they form an Eclipse help plugin. To
1386
# install this plugin and make it available under the help contents menu in
1387
# Eclipse, the contents of the directory containing the HTML and XML files needs
1388
# to be copied into the plugins directory of eclipse. The name of the directory
1389
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1390
# After copying Eclipse needs to be restarted before the help appears.
1391
# The default value is: NO.
1392
# This tag requires that the tag GENERATE_HTML is set to YES.
1393
1394
GENERATE_ECLIPSEHELP = NO
1395
1396
# A unique identifier for the Eclipse help plugin. When installing the plugin
1397
# the directory name containing the HTML and XML files should also have this
1398
# name. Each documentation set should have its own identifier.
1399
# The default value is: org.doxygen.Project.
1400
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1401
1402
ECLIPSE_DOC_ID = org.doxygen.Project
1403
1404
# If you want full control over the layout of the generated HTML pages it might
1405
# be necessary to disable the index and replace it with your own. The
1406
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1407
# of each HTML page. A value of NO enables the index and the value YES disables
1408
# it. Since the tabs in the index contain the same information as the navigation
1409
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1410
# The default value is: NO.
1411
# This tag requires that the tag GENERATE_HTML is set to YES.
1412
1413
DISABLE_INDEX = NO
1414
1415
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1416
# structure should be generated to display hierarchical information. If the tag
1417
# value is set to YES, a side panel will be generated containing a tree-like
1418
# index structure (just like the one that is generated for HTML Help). For this
1419
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1420
# (i.e. any modern browser). Windows users are probably better off using the
1421
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1422
# further fine-tune the look of the index. As an example, the default style
1423
# sheet generated by doxygen has an example that shows how to put an image at
1424
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1425
# the same information as the tab index, you could consider setting
1426
# DISABLE_INDEX to YES when enabling this option.
1427
# The default value is: NO.
1428
# This tag requires that the tag GENERATE_HTML is set to YES.
1429
1430
GENERATE_TREEVIEW = NO
1431
1432
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1433
# doxygen will group on one line in the generated HTML documentation.
1434
#
1435
# Note that a value of 0 will completely suppress the enum values from appearing
1436
# in the overview section.
1437
# Minimum value: 0, maximum value: 20, default value: 4.
1438
# This tag requires that the tag GENERATE_HTML is set to YES.
1439
1440
ENUM_VALUES_PER_LINE = 4
1441
1442
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1443
# to set the initial width (in pixels) of the frame in which the tree is shown.
1444
# Minimum value: 0, maximum value: 1500, default value: 250.
1445
# This tag requires that the tag GENERATE_HTML is set to YES.
1446
1447
TREEVIEW_WIDTH = 250
1448
1449
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1450
# external symbols imported via tag files in a separate window.
1451
# The default value is: NO.
1452
# This tag requires that the tag GENERATE_HTML is set to YES.
1453
1454
EXT_LINKS_IN_WINDOW = NO
1455
1456
# Use this tag to change the font size of LaTeX formulas included as images in
1457
# the HTML documentation. When you change the font size after a successful
1458
# doxygen run you need to manually remove any form_*.png images from the HTML
1459
# output directory to force them to be regenerated.
1460
# Minimum value: 8, maximum value: 50, default value: 10.
1461
# This tag requires that the tag GENERATE_HTML is set to YES.
1462
1463
FORMULA_FONTSIZE = 10
1464
1465
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1466
# generated for formulas are transparent PNGs. Transparent PNGs are not
1467
# supported properly for IE 6.0, but are supported on all modern browsers.
1468
#
1469
# Note that when changing this option you need to delete any form_*.png files in
1470
# the HTML output directory before the changes have effect.
1471
# The default value is: YES.
1472
# This tag requires that the tag GENERATE_HTML is set to YES.
1473
1474
FORMULA_TRANSPARENT = YES
1475
1476
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1477
# http://www.mathjax.org) which uses client side Javascript for the rendering
1478
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1479
# installed or if you want to formulas look prettier in the HTML output. When
1480
# enabled you may also need to install MathJax separately and configure the path
1481
# to it using the MATHJAX_RELPATH option.
1482
# The default value is: NO.
1483
# This tag requires that the tag GENERATE_HTML is set to YES.
1484
1485
USE_MATHJAX = NO
1486
1487
# When MathJax is enabled you can set the default output format to be used for
1488
# the MathJax output. See the MathJax site (see:
1489
# http://docs.mathjax.org/en/latest/output.html) for more details.
1490
# Possible values are: HTML-CSS (which is slower, but has the best
1491
# compatibility), NativeMML (i.e. MathML) and SVG.
1492
# The default value is: HTML-CSS.
1493
# This tag requires that the tag USE_MATHJAX is set to YES.
1494
1495
MATHJAX_FORMAT = HTML-CSS
1496
1497
# When MathJax is enabled you need to specify the location relative to the HTML
1498
# output directory using the MATHJAX_RELPATH option. The destination directory
1499
# should contain the MathJax.js script. For instance, if the mathjax directory
1500
# is located at the same level as the HTML output directory, then
1501
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1502
# Content Delivery Network so you can quickly see the result without installing
1503
# MathJax. However, it is strongly recommended to install a local copy of
1504
# MathJax from http://www.mathjax.org before deployment.
1505
# The default value is: http://cdn.mathjax.org/mathjax/latest.
1506
# This tag requires that the tag USE_MATHJAX is set to YES.
1507
1508
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1509
1510
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1511
# extension names that should be enabled during MathJax rendering. For example
1512
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1513
# This tag requires that the tag USE_MATHJAX is set to YES.
1514
1515
MATHJAX_EXTENSIONS =
1516
1517
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1518
# of code that will be used on startup of the MathJax code. See the MathJax site
1519
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1520
# example see the documentation.
1521
# This tag requires that the tag USE_MATHJAX is set to YES.
1522
1523
MATHJAX_CODEFILE =
1524
1525
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1526
# the HTML output. The underlying search engine uses javascript and DHTML and
1527
# should work on any modern browser. Note that when using HTML help
1528
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1529
# there is already a search function so this one should typically be disabled.
1530
# For large projects the javascript based search engine can be slow, then
1531
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1532
# search using the keyboard; to jump to the search box use <access key> + S
1533
# (what the <access key> is depends on the OS and browser, but it is typically
1534
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1535
# key> to jump into the search results window, the results can be navigated
1536
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1537
# the search. The filter options can be selected when the cursor is inside the
1538
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1539
# to select a filter and <Enter> or <escape> to activate or cancel the filter
1540
# option.
1541
# The default value is: YES.
1542
# This tag requires that the tag GENERATE_HTML is set to YES.
1543
1544
SEARCHENGINE = NO
1545
1546
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1547
# implemented using a web server instead of a web client using Javascript. There
1548
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1549
# setting. When disabled, doxygen will generate a PHP script for searching and
1550
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1551
# and searching needs to be provided by external tools. See the section
1552
# "External Indexing and Searching" for details.
1553
# The default value is: NO.
1554
# This tag requires that the tag SEARCHENGINE is set to YES.
1555
1556
SERVER_BASED_SEARCH = NO
1557
1558
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1559
# script for searching. Instead the search results are written to an XML file
1560
# which needs to be processed by an external indexer. Doxygen will invoke an
1561
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1562
# search results.
1563
#
1564
# Doxygen ships with an example indexer (doxyindexer) and search engine
1565
# (doxysearch.cgi) which are based on the open source search engine library
1566
# Xapian (see: http://xapian.org/).
1567
#
1568
# See the section "External Indexing and Searching" for details.
1569
# The default value is: NO.
1570
# This tag requires that the tag SEARCHENGINE is set to YES.
1571
1572
EXTERNAL_SEARCH = NO
1573
1574
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1575
# which will return the search results when EXTERNAL_SEARCH is enabled.
1576
#
1577
# Doxygen ships with an example indexer (doxyindexer) and search engine
1578
# (doxysearch.cgi) which are based on the open source search engine library
1579
# Xapian (see: http://xapian.org/). See the section "External Indexing and
1580
# Searching" for details.
1581
# This tag requires that the tag SEARCHENGINE is set to YES.
1582
1583
SEARCHENGINE_URL =
1584
1585
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1586
# search data is written to a file for indexing by an external tool. With the
1587
# SEARCHDATA_FILE tag the name of this file can be specified.
1588
# The default file is: searchdata.xml.
1589
# This tag requires that the tag SEARCHENGINE is set to YES.
1590
1591
SEARCHDATA_FILE = searchdata.xml
1592
1593
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1594
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1595
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1596
# projects and redirect the results back to the right project.
1597
# This tag requires that the tag SEARCHENGINE is set to YES.
1598
1599
EXTERNAL_SEARCH_ID =
1600
1601
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1602
# projects other than the one defined by this configuration file, but that are
1603
# all added to the same external search index. Each project needs to have a
1604
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1605
# to a relative location where the documentation can be found. The format is:
1606
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1607
# This tag requires that the tag SEARCHENGINE is set to YES.
1608
1609
EXTRA_SEARCH_MAPPINGS =
1610
1611
#---------------------------------------------------------------------------
1612
# Configuration options related to the LaTeX output
1613
#---------------------------------------------------------------------------
1614
1615
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1616
# The default value is: YES.
1617
1618
GENERATE_LATEX = NO
1619
1620
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1621
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1622
# it.
1623
# The default directory is: latex.
1624
# This tag requires that the tag GENERATE_LATEX is set to YES.
1625
1626
LATEX_OUTPUT = latex
1627
1628
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1629
# invoked.
1630
#
1631
# Note that when enabling USE_PDFLATEX this option is only used for generating
1632
# bitmaps for formulas in the HTML output, but not in the Makefile that is
1633
# written to the output directory.
1634
# The default file is: latex.
1635
# This tag requires that the tag GENERATE_LATEX is set to YES.
1636
1637
LATEX_CMD_NAME = latex
1638
1639
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1640
# index for LaTeX.
1641
# The default file is: makeindex.
1642
# This tag requires that the tag GENERATE_LATEX is set to YES.
1643
1644
MAKEINDEX_CMD_NAME = makeindex
1645
1646
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1647
# documents. This may be useful for small projects and may help to save some
1648
# trees in general.
1649
# The default value is: NO.
1650
# This tag requires that the tag GENERATE_LATEX is set to YES.
1651
1652
COMPACT_LATEX = NO
1653
1654
# The PAPER_TYPE tag can be used to set the paper type that is used by the
1655
# printer.
1656
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1657
# 14 inches) and executive (7.25 x 10.5 inches).
1658
# The default value is: a4.
1659
# This tag requires that the tag GENERATE_LATEX is set to YES.
1660
1661
PAPER_TYPE = a4wide
1662
1663
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1664
# that should be included in the LaTeX output. The package can be specified just
1665
# by its name or with the correct syntax as to be used with the LaTeX
1666
# \usepackage command. To get the times font for instance you can specify :
1667
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1668
# To use the option intlimits with the amsmath package you can specify:
1669
# EXTRA_PACKAGES=[intlimits]{amsmath}
1670
# If left blank no extra packages will be included.
1671
# This tag requires that the tag GENERATE_LATEX is set to YES.
1672
1673
EXTRA_PACKAGES =
1674
1675
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1676
# generated LaTeX document. The header should contain everything until the first
1677
# chapter. If it is left blank doxygen will generate a standard header. See
1678
# section "Doxygen usage" for information on how to let doxygen write the
1679
# default header to a separate file.
1680
#
1681
# Note: Only use a user-defined header if you know what you are doing! The
1682
# following commands have a special meaning inside the header: $title,
1683
# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1684
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1685
# string, for the replacement values of the other commands the user is referred
1686
# to HTML_HEADER.
1687
# This tag requires that the tag GENERATE_LATEX is set to YES.
1688
1689
LATEX_HEADER =
1690
1691
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1692
# generated LaTeX document. The footer should contain everything after the last
1693
# chapter. If it is left blank doxygen will generate a standard footer. See
1694
# LATEX_HEADER for more information on how to generate a default footer and what
1695
# special commands can be used inside the footer.
1696
#
1697
# Note: Only use a user-defined footer if you know what you are doing!
1698
# This tag requires that the tag GENERATE_LATEX is set to YES.
1699
1700
LATEX_FOOTER =
1701
1702
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1703
# LaTeX style sheets that are included after the standard style sheets created
1704
# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1705
# will copy the style sheet files to the output directory.
1706
# Note: The order of the extra style sheet files is of importance (e.g. the last
1707
# style sheet in the list overrules the setting of the previous ones in the
1708
# list).
1709
# This tag requires that the tag GENERATE_LATEX is set to YES.
1710
1711
LATEX_EXTRA_STYLESHEET =
1712
1713
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1714
# other source files which should be copied to the LATEX_OUTPUT output
1715
# directory. Note that the files will be copied as-is; there are no commands or
1716
# markers available.
1717
# This tag requires that the tag GENERATE_LATEX is set to YES.
1718
1719
LATEX_EXTRA_FILES =
1720
1721
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1722
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1723
# contain links (just like the HTML output) instead of page references. This
1724
# makes the output suitable for online browsing using a PDF viewer.
1725
# The default value is: YES.
1726
# This tag requires that the tag GENERATE_LATEX is set to YES.
1727
1728
PDF_HYPERLINKS = YES
1729
1730
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1731
# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1732
# higher quality PDF documentation.
1733
# The default value is: YES.
1734
# This tag requires that the tag GENERATE_LATEX is set to YES.
1735
1736
USE_PDFLATEX = YES
1737
1738
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1739
# command to the generated LaTeX files. This will instruct LaTeX to keep running
1740
# if errors occur, instead of asking the user for help. This option is also used
1741
# when generating formulas in HTML.
1742
# The default value is: NO.
1743
# This tag requires that the tag GENERATE_LATEX is set to YES.
1744
1745
LATEX_BATCHMODE = NO
1746
1747
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1748
# index chapters (such as File Index, Compound Index, etc.) in the output.
1749
# The default value is: NO.
1750
# This tag requires that the tag GENERATE_LATEX is set to YES.
1751
1752
LATEX_HIDE_INDICES = NO
1753
1754
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1755
# code with syntax highlighting in the LaTeX output.
1756
#
1757
# Note that which sources are shown also depends on other settings such as
1758
# SOURCE_BROWSER.
1759
# The default value is: NO.
1760
# This tag requires that the tag GENERATE_LATEX is set to YES.
1761
1762
LATEX_SOURCE_CODE = NO
1763
1764
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1765
# bibliography, e.g. plainnat, or ieeetr. See
1766
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1767
# The default value is: plain.
1768
# This tag requires that the tag GENERATE_LATEX is set to YES.
1769
1770
LATEX_BIB_STYLE = plain
1771
1772
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1773
# page will contain the date and time when the page was generated. Setting this
1774
# to NO can help when comparing the output of multiple runs.
1775
# The default value is: NO.
1776
# This tag requires that the tag GENERATE_LATEX is set to YES.
1777
1778
LATEX_TIMESTAMP = NO
1779
1780
#---------------------------------------------------------------------------
1781
# Configuration options related to the RTF output
1782
#---------------------------------------------------------------------------
1783
1784
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1785
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1786
# readers/editors.
1787
# The default value is: NO.
1788
1789
GENERATE_RTF = NO
1790
1791
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1792
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1793
# it.
1794
# The default directory is: rtf.
1795
# This tag requires that the tag GENERATE_RTF is set to YES.
1796
1797
RTF_OUTPUT = rtf
1798
1799
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1800
# documents. This may be useful for small projects and may help to save some
1801
# trees in general.
1802
# The default value is: NO.
1803
# This tag requires that the tag GENERATE_RTF is set to YES.
1804
1805
COMPACT_RTF = NO
1806
1807
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1808
# contain hyperlink fields. The RTF file will contain links (just like the HTML
1809
# output) instead of page references. This makes the output suitable for online
1810
# browsing using Word or some other Word compatible readers that support those
1811
# fields.
1812
#
1813
# Note: WordPad (write) and others do not support links.
1814
# The default value is: NO.
1815
# This tag requires that the tag GENERATE_RTF is set to YES.
1816
1817
RTF_HYPERLINKS = NO
1818
1819
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1820
# file, i.e. a series of assignments. You only have to provide replacements,
1821
# missing definitions are set to their default value.
1822
#
1823
# See also section "Doxygen usage" for information on how to generate the
1824
# default style sheet that doxygen normally uses.
1825
# This tag requires that the tag GENERATE_RTF is set to YES.
1826
1827
RTF_STYLESHEET_FILE =
1828
1829
# Set optional variables used in the generation of an RTF document. Syntax is
1830
# similar to doxygen's config file. A template extensions file can be generated
1831
# using doxygen -e rtf extensionFile.
1832
# This tag requires that the tag GENERATE_RTF is set to YES.
1833
1834
RTF_EXTENSIONS_FILE =
1835
1836
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1837
# with syntax highlighting in the RTF output.
1838
#
1839
# Note that which sources are shown also depends on other settings such as
1840
# SOURCE_BROWSER.
1841
# The default value is: NO.
1842
# This tag requires that the tag GENERATE_RTF is set to YES.
1843
1844
RTF_SOURCE_CODE = NO
1845
1846
#---------------------------------------------------------------------------
1847
# Configuration options related to the man page output
1848
#---------------------------------------------------------------------------
1849
1850
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1851
# classes and files.
1852
# The default value is: NO.
1853
1854
GENERATE_MAN = NO
1855
1856
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1857
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1858
# it. A directory man3 will be created inside the directory specified by
1859
# MAN_OUTPUT.
1860
# The default directory is: man.
1861
# This tag requires that the tag GENERATE_MAN is set to YES.
1862
1863
MAN_OUTPUT = man
1864
1865
# The MAN_EXTENSION tag determines the extension that is added to the generated
1866
# man pages. In case the manual section does not start with a number, the number
1867
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1868
# optional.
1869
# The default value is: .3.
1870
# This tag requires that the tag GENERATE_MAN is set to YES.
1871
1872
MAN_EXTENSION = .3
1873
1874
# The MAN_SUBDIR tag determines the name of the directory created within
1875
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1876
# MAN_EXTENSION with the initial . removed.
1877
# This tag requires that the tag GENERATE_MAN is set to YES.
1878
1879
MAN_SUBDIR =
1880
1881
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1882
# will generate one additional man file for each entity documented in the real
1883
# man page(s). These additional files only source the real man page, but without
1884
# them the man command would be unable to find the correct page.
1885
# The default value is: NO.
1886
# This tag requires that the tag GENERATE_MAN is set to YES.
1887
1888
MAN_LINKS = NO
1889
1890
#---------------------------------------------------------------------------
1891
# Configuration options related to the XML output
1892
#---------------------------------------------------------------------------
1893
1894
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1895
# captures the structure of the code including all documentation.
1896
# The default value is: NO.
1897
1898
GENERATE_XML = NO
1899
1900
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1901
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1902
# it.
1903
# The default directory is: xml.
1904
# This tag requires that the tag GENERATE_XML is set to YES.
1905
1906
XML_OUTPUT = xml
1907
1908
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1909
# listings (including syntax highlighting and cross-referencing information) to
1910
# the XML output. Note that enabling this will significantly increase the size
1911
# of the XML output.
1912
# The default value is: YES.
1913
# This tag requires that the tag GENERATE_XML is set to YES.
1914
1915
XML_PROGRAMLISTING = YES
1916
1917
#---------------------------------------------------------------------------
1918
# Configuration options related to the DOCBOOK output
1919
#---------------------------------------------------------------------------
1920
1921
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1922
# that can be used to generate PDF.
1923
# The default value is: NO.
1924
1925
GENERATE_DOCBOOK = NO
1926
1927
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1928
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1929
# front of it.
1930
# The default directory is: docbook.
1931
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1932
1933
DOCBOOK_OUTPUT = docbook
1934
1935
# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1936
# program listings (including syntax highlighting and cross-referencing
1937
# information) to the DOCBOOK output. Note that enabling this will significantly
1938
# increase the size of the DOCBOOK output.
1939
# The default value is: NO.
1940
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1941
1942
DOCBOOK_PROGRAMLISTING = NO
1943
1944
#---------------------------------------------------------------------------
1945
# Configuration options for the AutoGen Definitions output
1946
#---------------------------------------------------------------------------
1947
1948
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1949
# AutoGen Definitions (see http://autogen.sf.net) file that captures the
1950
# structure of the code including all documentation. Note that this feature is
1951
# still experimental and incomplete at the moment.
1952
# The default value is: NO.
1953
1954
GENERATE_AUTOGEN_DEF = NO
1955
1956
#---------------------------------------------------------------------------
1957
# Configuration options related to the Perl module output
1958
#---------------------------------------------------------------------------
1959
1960
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1961
# file that captures the structure of the code including all documentation.
1962
#
1963
# Note that this feature is still experimental and incomplete at the moment.
1964
# The default value is: NO.
1965
1966
GENERATE_PERLMOD = NO
1967
1968
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1969
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1970
# output from the Perl module output.
1971
# The default value is: NO.
1972
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1973
1974
PERLMOD_LATEX = NO
1975
1976
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1977
# formatted so it can be parsed by a human reader. This is useful if you want to
1978
# understand what is going on. On the other hand, if this tag is set to NO, the
1979
# size of the Perl module output will be much smaller and Perl will parse it
1980
# just the same.
1981
# The default value is: YES.
1982
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1983
1984
PERLMOD_PRETTY = YES
1985
1986
# The names of the make variables in the generated doxyrules.make file are
1987
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1988
# so different doxyrules.make files included by the same Makefile don't
1989
# overwrite each other's variables.
1990
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1991
1992
PERLMOD_MAKEVAR_PREFIX =
1993
1994
#---------------------------------------------------------------------------
1995
# Configuration options related to the preprocessor
1996
#---------------------------------------------------------------------------
1997
1998
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1999
# C-preprocessor directives found in the sources and include files.
2000
# The default value is: YES.
2001
2002
ENABLE_PREPROCESSING = YES
2003
2004
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2005
# in the source code. If set to NO, only conditional compilation will be
2006
# performed. Macro expansion can be done in a controlled way by setting
2007
# EXPAND_ONLY_PREDEF to YES.
2008
# The default value is: NO.
2009
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2010
2011
MACRO_EXPANSION = NO
2012
2013
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2014
# the macro expansion is limited to the macros specified with the PREDEFINED and
2015
# EXPAND_AS_DEFINED tags.
2016
# The default value is: NO.
2017
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2018
2019
EXPAND_ONLY_PREDEF = NO
2020
2021
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2022
# INCLUDE_PATH will be searched if a #include is found.
2023
# The default value is: YES.
2024
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2025
2026
SEARCH_INCLUDES = YES
2027
2028
# The INCLUDE_PATH tag can be used to specify one or more directories that
2029
# contain include files that are not input files but should be processed by the
2030
# preprocessor.
2031
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2032
2033
INCLUDE_PATH =
2034
2035
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2036
# patterns (like *.h and *.hpp) to filter out the header-files in the
2037
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2038
# used.
2039
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2040
2041
INCLUDE_FILE_PATTERNS =
2042
2043
# The PREDEFINED tag can be used to specify one or more macro names that are
2044
# defined before the preprocessor is started (similar to the -D option of e.g.
2045
# gcc). The argument of the tag is a list of macros of the form: name or
2046
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2047
# is assumed. To prevent a macro definition from being undefined via #undef or
2048
# recursively expanded use the := operator instead of the = operator.
2049
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2050
2051
PREDEFINED =
2052
2053
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2054
# tag can be used to specify a list of macro names that should be expanded. The
2055
# macro definition that is found in the sources will be used. Use the PREDEFINED
2056
# tag if you want to use a different macro definition that overrules the
2057
# definition found in the source code.
2058
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2059
2060
EXPAND_AS_DEFINED =
2061
2062
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2063
# remove all references to function-like macros that are alone on a line, have
2064
# an all uppercase name, and do not end with a semicolon. Such function macros
2065
# are typically used for boiler-plate code, and will confuse the parser if not
2066
# removed.
2067
# The default value is: YES.
2068
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2069
2070
SKIP_FUNCTION_MACROS = YES
2071
2072
#---------------------------------------------------------------------------
2073
# Configuration options related to external references
2074
#---------------------------------------------------------------------------
2075
2076
# The TAGFILES tag can be used to specify one or more tag files. For each tag
2077
# file the location of the external documentation should be added. The format of
2078
# a tag file without this location is as follows:
2079
# TAGFILES = file1 file2 ...
2080
# Adding location for the tag files is done as follows:
2081
# TAGFILES = file1=loc1 "file2 = loc2" ...
2082
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2083
# section "Linking to external documentation" for more information about the use
2084
# of tag files.
2085
# Note: Each tag file must have a unique name (where the name does NOT include
2086
# the path). If a tag file is not located in the directory in which doxygen is
2087
# run, you must also specify the path to the tagfile here.
2088
2089
TAGFILES =
2090
2091
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2092
# tag file that is based on the input files it reads. See section "Linking to
2093
# external documentation" for more information about the usage of tag files.
2094
2095
GENERATE_TAGFILE =
2096
2097
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2098
# the class index. If set to NO, only the inherited external classes will be
2099
# listed.
2100
# The default value is: NO.
2101
2102
ALLEXTERNALS = NO
2103
2104
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2105
# in the modules index. If set to NO, only the current project's groups will be
2106
# listed.
2107
# The default value is: YES.
2108
2109
EXTERNAL_GROUPS = YES
2110
2111
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2112
# the related pages index. If set to NO, only the current project's pages will
2113
# be listed.
2114
# The default value is: YES.
2115
2116
EXTERNAL_PAGES = YES
2117
2118
# The PERL_PATH should be the absolute path and name of the perl script
2119
# interpreter (i.e. the result of 'which perl').
2120
# The default file (with absolute path) is: /usr/bin/perl.
2121
2122
PERL_PATH = /usr/bin/perl
2123
2124
#---------------------------------------------------------------------------
2125
# Configuration options related to the dot tool
2126
#---------------------------------------------------------------------------
2127
2128
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2129
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2130
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2131
# disabled, but it is recommended to install and use dot, since it yields more
2132
# powerful graphs.
2133
# The default value is: YES.
2134
2135
CLASS_DIAGRAMS = NO
2136
2137
# You can define message sequence charts within doxygen comments using the \msc
2138
# command. Doxygen will then run the mscgen tool (see:
2139
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2140
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2141
# the mscgen tool resides. If left empty the tool is assumed to be found in the
2142
# default search path.
2143
2144
MSCGEN_PATH =
2145
2146
# You can include diagrams made with dia in doxygen documentation. Doxygen will
2147
# then run dia to produce the diagram and insert it in the documentation. The
2148
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2149
# If left empty dia is assumed to be found in the default search path.
2150
2151
DIA_PATH =
2152
2153
# If set to YES the inheritance and collaboration graphs will hide inheritance
2154
# and usage relations if the target is undocumented or is not a class.
2155
# The default value is: YES.
2156
2157
HIDE_UNDOC_RELATIONS = YES
2158
2159
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2160
# available from the path. This tool is part of Graphviz (see:
2161
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2162
# Bell Labs. The other options in this section have no effect if this option is
2163
# set to NO
2164
# The default value is: YES.
2165
2166
HAVE_DOT = YES
2167
2168
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2169
# to run in parallel. When set to 0 doxygen will base this on the number of
2170
# processors available in the system. You can set it explicitly to a value
2171
# larger than 0 to get control over the balance between CPU load and processing
2172
# speed.
2173
# Minimum value: 0, maximum value: 32, default value: 0.
2174
# This tag requires that the tag HAVE_DOT is set to YES.
2175
2176
DOT_NUM_THREADS = 0
2177
2178
# When you want a differently looking font in the dot files that doxygen
2179
# generates you can specify the font name using DOT_FONTNAME. You need to make
2180
# sure dot is able to find the font, which can be done by putting it in a
2181
# standard location or by setting the DOTFONTPATH environment variable or by
2182
# setting DOT_FONTPATH to the directory containing the font.
2183
# The default value is: Helvetica.
2184
# This tag requires that the tag HAVE_DOT is set to YES.
2185
2186
DOT_FONTNAME = Helvetica
2187
2188
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2189
# dot graphs.
2190
# Minimum value: 4, maximum value: 24, default value: 10.
2191
# This tag requires that the tag HAVE_DOT is set to YES.
2192
2193
DOT_FONTSIZE = 10
2194
2195
# By default doxygen will tell dot to use the default font as specified with
2196
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2197
# the path where dot can find it using this tag.
2198
# This tag requires that the tag HAVE_DOT is set to YES.
2199
2200
DOT_FONTPATH =
2201
2202
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2203
# each documented class showing the direct and indirect inheritance relations.
2204
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2205
# The default value is: YES.
2206
# This tag requires that the tag HAVE_DOT is set to YES.
2207
2208
CLASS_GRAPH = YES
2209
2210
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2211
# graph for each documented class showing the direct and indirect implementation
2212
# dependencies (inheritance, containment, and class references variables) of the
2213
# class with other documented classes.
2214
# The default value is: YES.
2215
# This tag requires that the tag HAVE_DOT is set to YES.
2216
2217
COLLABORATION_GRAPH = YES
2218
2219
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2220
# groups, showing the direct groups dependencies.
2221
# The default value is: YES.
2222
# This tag requires that the tag HAVE_DOT is set to YES.
2223
2224
GROUP_GRAPHS = YES
2225
2226
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2227
# collaboration diagrams in a style similar to the OMG's Unified Modeling
2228
# Language.
2229
# The default value is: NO.
2230
# This tag requires that the tag HAVE_DOT is set to YES.
2231
2232
UML_LOOK = NO
2233
2234
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2235
# class node. If there are many fields or methods and many nodes the graph may
2236
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2237
# number of items for each type to make the size more manageable. Set this to 0
2238
# for no limit. Note that the threshold may be exceeded by 50% before the limit
2239
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2240
# but if the number exceeds 15, the total amount of fields shown is limited to
2241
# 10.
2242
# Minimum value: 0, maximum value: 100, default value: 10.
2243
# This tag requires that the tag HAVE_DOT is set to YES.
2244
2245
UML_LIMIT_NUM_FIELDS = 10
2246
2247
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2248
# collaboration graphs will show the relations between templates and their
2249
# instances.
2250
# The default value is: NO.
2251
# This tag requires that the tag HAVE_DOT is set to YES.
2252
2253
TEMPLATE_RELATIONS = NO
2254
2255
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2256
# YES then doxygen will generate a graph for each documented file showing the
2257
# direct and indirect include dependencies of the file with other documented
2258
# files.
2259
# The default value is: YES.
2260
# This tag requires that the tag HAVE_DOT is set to YES.
2261
2262
INCLUDE_GRAPH = YES
2263
2264
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2265
# set to YES then doxygen will generate a graph for each documented file showing
2266
# the direct and indirect include dependencies of the file with other documented
2267
# files.
2268
# The default value is: YES.
2269
# This tag requires that the tag HAVE_DOT is set to YES.
2270
2271
INCLUDED_BY_GRAPH = YES
2272
2273
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2274
# dependency graph for every global function or class method.
2275
#
2276
# Note that enabling this option will significantly increase the time of a run.
2277
# So in most cases it will be better to enable call graphs for selected
2278
# functions only using the \callgraph command. Disabling a call graph can be
2279
# accomplished by means of the command \hidecallgraph.
2280
# The default value is: NO.
2281
# This tag requires that the tag HAVE_DOT is set to YES.
2282
2283
CALL_GRAPH = NO
2284
2285
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2286
# dependency graph for every global function or class method.
2287
#
2288
# Note that enabling this option will significantly increase the time of a run.
2289
# So in most cases it will be better to enable caller graphs for selected
2290
# functions only using the \callergraph command. Disabling a caller graph can be
2291
# accomplished by means of the command \hidecallergraph.
2292
# The default value is: NO.
2293
# This tag requires that the tag HAVE_DOT is set to YES.
2294
2295
CALLER_GRAPH = NO
2296
2297
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2298
# hierarchy of all classes instead of a textual one.
2299
# The default value is: YES.
2300
# This tag requires that the tag HAVE_DOT is set to YES.
2301
2302
GRAPHICAL_HIERARCHY = YES
2303
2304
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2305
# dependencies a directory has on other directories in a graphical way. The
2306
# dependency relations are determined by the #include relations between the
2307
# files in the directories.
2308
# The default value is: YES.
2309
# This tag requires that the tag HAVE_DOT is set to YES.
2310
2311
DIRECTORY_GRAPH = YES
2312
2313
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2314
# generated by dot. For an explanation of the image formats see the section
2315
# output formats in the documentation of the dot tool (Graphviz (see:
2316
# http://www.graphviz.org/)).
2317
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2318
# to make the SVG files visible in IE 9+ (other browsers do not have this
2319
# requirement).
2320
# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2321
# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2322
# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2323
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2324
# png:gdiplus:gdiplus.
2325
# The default value is: png.
2326
# This tag requires that the tag HAVE_DOT is set to YES.
2327
2328
DOT_IMAGE_FORMAT = png
2329
2330
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2331
# enable generation of interactive SVG images that allow zooming and panning.
2332
#
2333
# Note that this requires a modern browser other than Internet Explorer. Tested
2334
# and working are Firefox, Chrome, Safari, and Opera.
2335
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2336
# the SVG files visible. Older versions of IE do not have SVG support.
2337
# The default value is: NO.
2338
# This tag requires that the tag HAVE_DOT is set to YES.
2339
2340
INTERACTIVE_SVG = NO
2341
2342
# The DOT_PATH tag can be used to specify the path where the dot tool can be
2343
# found. If left blank, it is assumed the dot tool can be found in the path.
2344
# This tag requires that the tag HAVE_DOT is set to YES.
2345
2346
DOT_PATH =
2347
2348
# The DOTFILE_DIRS tag can be used to specify one or more directories that
2349
# contain dot files that are included in the documentation (see the \dotfile
2350
# command).
2351
# This tag requires that the tag HAVE_DOT is set to YES.
2352
2353
DOTFILE_DIRS = ../
2354
2355
# The MSCFILE_DIRS tag can be used to specify one or more directories that
2356
# contain msc files that are included in the documentation (see the \mscfile
2357
# command).
2358
2359
MSCFILE_DIRS =
2360
2361
# The DIAFILE_DIRS tag can be used to specify one or more directories that
2362
# contain dia files that are included in the documentation (see the \diafile
2363
# command).
2364
2365
DIAFILE_DIRS =
2366
2367
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2368
# path where java can find the plantuml.jar file. If left blank, it is assumed
2369
# PlantUML is not used or called during a preprocessing step. Doxygen will
2370
# generate a warning when it encounters a \startuml command in this case and
2371
# will not generate output for the diagram.
2372
2373
PLANTUML_JAR_PATH =
2374
2375
# When using plantuml, the specified paths are searched for files specified by
2376
# the !include statement in a plantuml block.
2377
2378
PLANTUML_INCLUDE_PATH =
2379
2380
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2381
# that will be shown in the graph. If the number of nodes in a graph becomes
2382
# larger than this value, doxygen will truncate the graph, which is visualized
2383
# by representing a node as a red box. Note that doxygen if the number of direct
2384
# children of the root node in a graph is already larger than
2385
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2386
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2387
# Minimum value: 0, maximum value: 10000, default value: 50.
2388
# This tag requires that the tag HAVE_DOT is set to YES.
2389
2390
DOT_GRAPH_MAX_NODES = 110
2391
2392
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2393
# generated by dot. A depth value of 3 means that only nodes reachable from the
2394
# root by following a path via at most 3 edges will be shown. Nodes that lay
2395
# further from the root node will be omitted. Note that setting this option to 1
2396
# or 2 may greatly reduce the computation time needed for large code bases. Also
2397
# note that the size of a graph can be further restricted by
2398
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2399
# Minimum value: 0, maximum value: 1000, default value: 0.
2400
# This tag requires that the tag HAVE_DOT is set to YES.
2401
2402
MAX_DOT_GRAPH_DEPTH = 0
2403
2404
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2405
# background. This is disabled by default, because dot on Windows does not seem
2406
# to support this out of the box.
2407
#
2408
# Warning: Depending on the platform used, enabling this option may lead to
2409
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2410
# read).
2411
# The default value is: NO.
2412
# This tag requires that the tag HAVE_DOT is set to YES.
2413
2414
DOT_TRANSPARENT = YES
2415
2416
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2417
# files in one run (i.e. multiple -o and -T options on the command line). This
2418
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2419
# this, this feature is disabled by default.
2420
# The default value is: NO.
2421
# This tag requires that the tag HAVE_DOT is set to YES.
2422
2423
DOT_MULTI_TARGETS = NO
2424
2425
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2426
# explaining the meaning of the various boxes and arrows in the dot generated
2427
# graphs.
2428
# The default value is: YES.
2429
# This tag requires that the tag HAVE_DOT is set to YES.
2430
2431
GENERATE_LEGEND = YES
2432
2433
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2434
# files that are used to generate the various graphs.
2435
# The default value is: YES.
2436
# This tag requires that the tag HAVE_DOT is set to YES.
2437
2438
DOT_CLEANUP = YES
Loggerhead is a web-based interface for Breezy
Version: 2.0.1