/alps/pcitool

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