3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
6
# All text after a hash (#) is considered a comment and will be ignored
8
# TAG = value [value, ...]
9
# For lists items can also be appended using:
10
# TAG += value [value, ...]
11
# Values that contain spaces should be placed between quotes (" ")
13
#---------------------------------------------------------------------------
14
# Project related configuration options
15
#---------------------------------------------------------------------------
17
# This tag specifies the encoding used for all characters in the config file
18
# that follow. The default is UTF-8 which is also the encoding used for all
19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20
# iconv built into libc) for the transcoding. See
21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
23
DOXYFILE_ENCODING = UTF-8
25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26
# by quotes) that should identify the project.
30
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31
# This could be handy for archiving the generated documentation or
32
# if some version control system is used.
36
# Using the PROJECT_BRIEF tag one can provide an optional one line description
37
# for a project that appears at the top of each page and should give viewer
38
# a quick idea about the purpose of the project. Keep the description short.
40
PROJECT_BRIEF = "Parallel Location and Exchange"
42
# With the PROJECT_LOGO tag one can specify an logo or icon that is
43
# included in the documentation. The maximum height of the logo should not
44
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
45
# Doxygen will copy the logo to the output directory.
49
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
50
# base path where the generated documentation will be put.
51
# If a relative path is entered, it will be relative to the location
52
# where doxygen was started. If left blank the current directory will be used.
54
OUTPUT_DIRECTORY = $(builddir)/doc/doxygen
56
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
57
# 4096 sub-directories (in 2 levels) under the output directory of each output
58
# format and will distribute the generated files over these directories.
59
# Enabling this option can be useful when feeding doxygen a huge amount of
60
# source files, where putting all generated files in the same directory would
61
# otherwise cause performance problems for the file system.
65
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
66
# documentation generated by doxygen is written. Doxygen will use this
67
# information to generate all constant output in the proper language.
68
# The default language is English, other supported languages are:
69
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
70
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
71
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
72
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
73
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
74
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
76
OUTPUT_LANGUAGE = English
78
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
79
# include brief member descriptions after the members that are listed in
80
# the file and class documentation (similar to JavaDoc).
81
# Set to NO to disable this.
83
BRIEF_MEMBER_DESC = YES
85
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
86
# the brief description of a member or function before the detailed description.
87
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
88
# brief descriptions will be completely suppressed.
92
# This tag implements a quasi-intelligent brief description abbreviator
93
# that is used to form the text in various listings. Each string
94
# in this list, if found as the leading text of the brief description, will be
95
# stripped from the text and the result after processing the whole list, is
96
# used as the annotated text. Otherwise, the brief description is used as-is.
97
# If left blank, the following values are used ("$name" is automatically
98
# replaced with the name of the entity): "The $name class" "The $name widget"
99
# "The $name file" "is" "provides" "specifies" "contains"
100
# "represents" "a" "an" "the"
102
ABBREVIATE_BRIEF = "The $name class" \
114
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
115
# Doxygen will generate a detailed section even if there is only a brief
118
ALWAYS_DETAILED_SEC = NO
120
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
121
# inherited members of a class in the documentation of that class as if those
122
# members were ordinary class members. Constructors, destructors and assignment
123
# operators of the base classes will not be shown.
125
INLINE_INHERITED_MEMB = NO
127
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
128
# path before files name in the file list and in the header files. If set
129
# to NO the shortest path that makes the file name unique will be used.
131
FULL_PATH_NAMES = YES
133
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
134
# can be used to strip a user-defined part of the path. Stripping is
135
# only done if one of the specified strings matches the left-hand part of
136
# the path. The tag can be used to show relative paths in the file list.
137
# If left blank the directory from which doxygen is run is used as the
142
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
143
# the path mentioned in the documentation of a class, which tells
144
# the reader which header file to include in order to use a class.
145
# If left blank only the name of the header file containing the class
146
# definition is used. Otherwise one should specify the include paths that
147
# are normally passed to the compiler using the -I flag.
149
STRIP_FROM_INC_PATH =
151
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
152
# (but less readable) file names. This can be useful if your file system
153
# doesn't support long names like on DOS, Mac, or CD-ROM.
157
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
158
# will interpret the first line (until the first dot) of a JavaDoc-style
159
# comment as the brief description. If set to NO, the JavaDoc
160
# comments will behave just like regular Qt-style comments
161
# (thus requiring an explicit @brief command for a brief description.)
163
JAVADOC_AUTOBRIEF = NO
165
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
166
# interpret the first line (until the first dot) of a Qt-style
167
# comment as the brief description. If set to NO, the comments
168
# will behave just like regular Qt-style comments (thus requiring
169
# an explicit \brief command for a brief description.)
173
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
174
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
175
# comments) as a brief description. This used to be the default behaviour.
176
# The new default is to treat a multi-line C++ comment block as a detailed
177
# description. Set this tag to YES if you prefer the old behaviour instead.
179
MULTILINE_CPP_IS_BRIEF = NO
181
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
182
# member inherits the documentation from any documented member that it
187
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
188
# a new page for each member. If set to NO, the documentation of a member will
189
# be part of the file/class/namespace that contains it.
191
SEPARATE_MEMBER_PAGES = NO
193
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
194
# Doxygen uses this value to replace tabs by spaces in code fragments.
198
# This tag can be used to specify a number of aliases that acts
199
# as commands in the documentation. An alias has the form "name=value".
200
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
201
# put the command \sideeffect (or @sideeffect) in the documentation, which
202
# will result in a user-defined paragraph with heading "Side Effects:".
203
# You can put \n's in the value part of an alias to insert newlines.
207
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
208
# sources only. Doxygen will then generate output that is more tailored for C.
209
# For instance, some of the names that are used will be different. The list
210
# of all members will be omitted, etc.
212
OPTIMIZE_OUTPUT_FOR_C = YES
214
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
215
# sources only. Doxygen will then generate output that is more tailored for
216
# Java. For instance, namespaces will be presented as packages, qualified
217
# scopes will look different, etc.
219
OPTIMIZE_OUTPUT_JAVA = NO
221
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
222
# sources only. Doxygen will then generate output that is more tailored for
225
OPTIMIZE_FOR_FORTRAN = NO
227
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
228
# sources. Doxygen will then generate output that is tailored for
231
OPTIMIZE_OUTPUT_VHDL = NO
233
# Doxygen selects the parser to use depending on the extension of the files it
234
# parses. With this tag you can assign which parser to use for a given extension.
235
# Doxygen has a built-in mapping, but you can override or extend it using this
236
# tag. The format is ext=language, where ext is a file extension, and language
237
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
238
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
239
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
240
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
241
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
245
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
246
# to include (a tag file for) the STL sources as input, then you should
247
# set this tag to YES in order to let doxygen match functions declarations and
248
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
249
# func(std::string) {}). This also makes the inheritance and collaboration
250
# diagrams that involve STL classes more complete and accurate.
252
BUILTIN_STL_SUPPORT = NO
254
# If you use Microsoft's C++/CLI language, you should set this option to YES to
255
# enable parsing support.
259
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
260
# Doxygen will parse them like normal C++ but will assume all classes use public
261
# instead of private inheritance when no explicit protection keyword is present.
265
# For Microsoft's IDL there are propget and propput attributes to indicate getter
266
# and setter methods for a property. Setting this option to YES (the default)
267
# will make doxygen replace the get and set methods by a property in the
268
# documentation. This will only work if the methods are indeed getting or
269
# setting a simple type. If this is not the case, or you want to show the
270
# methods anyway, you should set this option to NO.
272
IDL_PROPERTY_SUPPORT = YES
274
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
275
# tag is set to YES, then doxygen will reuse the documentation of the first
276
# member in the group (if any) for the other members of the group. By default
277
# all members of a group must be documented explicitly.
279
DISTRIBUTE_GROUP_DOC = NO
281
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
282
# the same type (for instance a group of public functions) to be put as a
283
# subgroup of that type (e.g. under the Public Functions section). Set it to
284
# NO to prevent subgrouping. Alternatively, this can be done per class using
285
# the \nosubgrouping command.
289
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
290
# is documented as struct, union, or enum with the name of the typedef. So
291
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
292
# with name TypeT. When disabled the typedef will appear as a member of a file,
293
# namespace, or class. And the struct will be named TypeS. This can typically
294
# be useful for C code in case the coding convention dictates that all compound
295
# types are typedef'ed and only the typedef is referenced, never the tag name.
297
TYPEDEF_HIDES_STRUCT = NO
299
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
300
# determine which symbols to keep in memory and which to flush to disk.
301
# When the cache is full, less often used symbols will be written to disk.
302
# For small to medium size projects (<1000 input files) the default value is
303
# probably good enough. For larger projects a too small cache size can cause
304
# doxygen to be busy swapping symbols to and from disk most of the time
305
# causing a significant performance penalty.
306
# If the system has enough physical memory increasing the cache will improve the
307
# performance by keeping more symbols in memory. Note that the value works on
308
# a logarithmic scale so increasing the size by one will roughly double the
309
# memory usage. The cache size is given by this formula:
310
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
311
# corresponding to a cache size of 2^16 = 65536 symbols
313
SYMBOL_CACHE_SIZE = 0
315
#---------------------------------------------------------------------------
316
# Build related configuration options
317
#---------------------------------------------------------------------------
319
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
320
# documentation are documented, even if no documentation was available.
321
# Private class members and static file members will be hidden unless
322
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
326
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
327
# will be included in the documentation.
331
# If the EXTRACT_STATIC tag is set to YES all static members of a file
332
# will be included in the documentation.
336
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
337
# defined locally in source files will be included in the documentation.
338
# If set to NO only classes defined in header files are included.
340
EXTRACT_LOCAL_CLASSES = YES
342
# This flag is only useful for Objective-C code. When set to YES local
343
# methods, which are defined in the implementation section but not in
344
# the interface are included in the documentation.
345
# If set to NO (the default) only methods in the interface are included.
347
EXTRACT_LOCAL_METHODS = NO
349
# If this flag is set to YES, the members of anonymous namespaces will be
350
# extracted and appear in the documentation as a namespace called
351
# 'anonymous_namespace{file}', where file will be replaced with the base
352
# name of the file that contains the anonymous namespace. By default
353
# anonymous namespaces are hidden.
355
EXTRACT_ANON_NSPACES = NO
357
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
358
# undocumented members of documented classes, files or namespaces.
359
# If set to NO (the default) these members will be included in the
360
# various overviews, but no documentation section is generated.
361
# This option has no effect if EXTRACT_ALL is enabled.
363
HIDE_UNDOC_MEMBERS = YES
365
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
366
# undocumented classes that are normally visible in the class hierarchy.
367
# If set to NO (the default) these classes will be included in the various
368
# overviews. This option has no effect if EXTRACT_ALL is enabled.
370
HIDE_UNDOC_CLASSES = YES
372
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
373
# friend (class|struct|union) declarations.
374
# If set to NO (the default) these declarations will be included in the
377
HIDE_FRIEND_COMPOUNDS = NO
379
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
380
# documentation blocks found inside the body of a function.
381
# If set to NO (the default) these blocks will be appended to the
382
# function's detailed documentation block.
384
HIDE_IN_BODY_DOCS = NO
386
# The INTERNAL_DOCS tag determines if documentation
387
# that is typed after a \internal command is included. If the tag is set
388
# to NO (the default) then the documentation will be excluded.
389
# Set it to YES to include the internal documentation.
393
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
394
# file names in lower-case letters. If set to YES upper-case letters are also
395
# allowed. This is useful if you have classes or files whose names only differ
396
# in case and if your file system supports case sensitive file names. Windows
397
# and Mac users are advised to set this option to NO.
399
CASE_SENSE_NAMES = NO
401
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
402
# will show members with their full class and namespace scopes in the
403
# documentation. If set to YES the scope will be hidden.
405
HIDE_SCOPE_NAMES = YES
407
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
408
# will put a list of the files that are included by a file in the documentation
411
SHOW_INCLUDE_FILES = YES
413
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
414
# will list include files with double quotes in the documentation
415
# rather than with sharp brackets.
417
FORCE_LOCAL_INCLUDES = NO
419
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
420
# is inserted in the documentation for inline members.
424
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
425
# will sort the (detailed) documentation of file and class members
426
# alphabetically by member name. If set to NO the members will appear in
429
SORT_MEMBER_DOCS = YES
431
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
432
# brief documentation of file, namespace and class members alphabetically
433
# by member name. If set to NO (the default) the members will appear in
438
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
439
# will sort the (brief and detailed) documentation of class members so that
440
# constructors and destructors are listed first. If set to NO (the default)
441
# the constructors will appear in the respective orders defined by
442
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
443
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
444
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
446
SORT_MEMBERS_CTORS_1ST = NO
448
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
449
# hierarchy of group names into alphabetical order. If set to NO (the default)
450
# the group names will appear in their defined order.
452
SORT_GROUP_NAMES = NO
454
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
455
# sorted by fully-qualified names, including namespaces. If set to
456
# NO (the default), the class list will be sorted only by class name,
457
# not including the namespace part.
458
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
459
# Note: This option applies only to the class list, not to the
462
SORT_BY_SCOPE_NAME = NO
464
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
465
# do proper type resolution of all parameters of a function it will reject a
466
# match between the prototype and the implementation of a member function even
467
# if there is only one candidate or it is obvious which candidate to choose
468
# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
469
# will still accept a match between prototype and implementation in such cases.
471
STRICT_PROTO_MATCHING = NO
473
# The GENERATE_TODOLIST tag can be used to enable (YES) or
474
# disable (NO) the todo list. This list is created by putting \todo
475
# commands in the documentation.
477
GENERATE_TODOLIST = YES
479
# The GENERATE_TESTLIST tag can be used to enable (YES) or
480
# disable (NO) the test list. This list is created by putting \test
481
# commands in the documentation.
483
GENERATE_TESTLIST = YES
485
# The GENERATE_BUGLIST tag can be used to enable (YES) or
486
# disable (NO) the bug list. This list is created by putting \bug
487
# commands in the documentation.
489
GENERATE_BUGLIST = YES
491
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
492
# disable (NO) the deprecated list. This list is created by putting
493
# \deprecated commands in the documentation.
495
GENERATE_DEPRECATEDLIST= YES
497
# The ENABLED_SECTIONS tag can be used to enable conditional
498
# documentation sections, marked by \if sectionname ... \endif.
502
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
503
# the initial value of a variable or macro consists of for it to appear in
504
# the documentation. If the initializer consists of more lines than specified
505
# here it will be hidden. Use a value of 0 to hide initializers completely.
506
# The appearance of the initializer of individual variables and macros in the
507
# documentation can be controlled using \showinitializer or \hideinitializer
508
# command in the documentation regardless of this setting.
510
MAX_INITIALIZER_LINES = 30
512
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
513
# at the bottom of the documentation of classes and structs. If set to YES the
514
# list will mention the files that were used to generate the documentation.
516
SHOW_USED_FILES = YES
518
# If the sources in your project are distributed over multiple directories
519
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
520
# in the documentation. The default is NO.
522
SHOW_DIRECTORIES = YES
524
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
525
# This will remove the Files entry from the Quick Index and from the
526
# Folder Tree View (if specified). The default is YES.
530
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
531
# Namespaces page. This will remove the Namespaces entry from the Quick Index
532
# and from the Folder Tree View (if specified). The default is YES.
534
SHOW_NAMESPACES = YES
536
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
537
# doxygen should invoke to get the current version for each file (typically from
538
# the version control system). Doxygen will invoke the program by executing (via
539
# popen()) the command <command> <input-file>, where <command> is the value of
540
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
541
# provided by doxygen. Whatever the program writes to standard output
542
# is used as the file version. See the manual for examples.
544
FILE_VERSION_FILTER =
546
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
547
# by doxygen. The layout file controls the global structure of the generated
548
# output files in an output format independent way. The create the layout file
549
# that represents doxygen's defaults, run doxygen with the -l option.
550
# You can optionally specify a file name after the option, if omitted
551
# DoxygenLayout.xml will be used as the name of the layout file.
555
#---------------------------------------------------------------------------
556
# configuration options related to warning and progress messages
557
#---------------------------------------------------------------------------
559
# The QUIET tag can be used to turn on/off the messages that are generated
560
# by doxygen. Possible values are YES and NO. If left blank NO is used.
564
# The WARNINGS tag can be used to turn on/off the warning messages that are
565
# generated by doxygen. Possible values are YES and NO. If left blank
570
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
571
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
572
# automatically be disabled.
574
WARN_IF_UNDOCUMENTED = YES
576
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
577
# potential errors in the documentation, such as not documenting some
578
# parameters in a documented function, or documenting parameters that
579
# don't exist or using markup commands wrongly.
581
WARN_IF_DOC_ERROR = YES
583
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
584
# functions that are documented, but have no documentation for their parameters
585
# or return value. If set to NO (the default) doxygen will only warn about
586
# wrong or incomplete parameter documentation, but not about the absence of
589
WARN_NO_PARAMDOC = NO
591
# The WARN_FORMAT tag determines the format of the warning messages that
592
# doxygen can produce. The string should contain the $file, $line, and $text
593
# tags, which will be replaced by the file and line number from which the
594
# warning originated and the warning text. Optionally the format may contain
595
# $version, which will be replaced by the version of the file (if it could
596
# be obtained via FILE_VERSION_FILTER)
598
WARN_FORMAT = "$file:$line: $text"
600
# The WARN_LOGFILE tag can be used to specify a file to which warning
601
# and error messages should be written. If left blank the output is written
606
#---------------------------------------------------------------------------
607
# configuration options related to the input files
608
#---------------------------------------------------------------------------
610
# The INPUT tag can be used to specify the files and/or directories that contain
611
# documented source files. You may enter file names like "myfile.cpp" or
612
# directories like "/usr/src/myproject". Separate the files or directories
615
INPUT = $(srcdir)/src \
616
$(srcdir)/doc/doxygen
618
# This tag can be used to specify the character encoding of the source files
619
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
620
# also the default input encoding. Doxygen uses libiconv (or the iconv built
621
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
622
# the list of possible encodings.
624
INPUT_ENCODING = UTF-8
626
# If the value of the INPUT tag contains directories, you can use the
627
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
628
# and *.h) to filter out the source-files in the directories. If left
629
# blank the following patterns are tested:
630
# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
631
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
632
# *.f90 *.f *.for *.vhd *.vhdl
634
FILE_PATTERNS = *.c \
638
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
639
# should be searched for input files as well. Possible values are YES and NO.
640
# If left blank NO is used.
644
# The EXCLUDE tag can be used to specify files and/or directories that should
645
# excluded from the INPUT source files. This way you can easily exclude a
646
# subdirectory from a directory tree whose root is specified with the INPUT tag.
650
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
651
# directories that are symbolic links (a Unix file system feature) are excluded
654
EXCLUDE_SYMLINKS = NO
656
# If the value of the INPUT tag contains directories, you can use the
657
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
658
# certain files from those directories. Note that the wildcards are matched
659
# against the file with absolute path, so to exclude all test directories
660
# for example use the pattern */test/*
664
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
665
# (namespaces, classes, functions, etc.) that should be excluded from the
666
# output. The symbol name can be a fully qualified name, a word, or if the
667
# wildcard * is used, a substring. Examples: ANamespace, AClass,
668
# AClass::ANamespace, ANamespace::*Test
672
# The EXAMPLE_PATH tag can be used to specify one or more files or
673
# directories that contain example code fragments that are included (see
674
# the \include command).
676
EXAMPLE_PATH = $(srcdir)/examples/
678
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
679
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
680
# and *.h) to filter out the source-files in the directories. If left
681
# blank all files are included.
685
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
686
# searched for input files to be used with the \include or \dontinclude
687
# commands irrespective of the value of the RECURSIVE tag.
688
# Possible values are YES and NO. If left blank NO is used.
690
EXAMPLE_RECURSIVE = NO
692
# The IMAGE_PATH tag can be used to specify one or more files or
693
# directories that contain image that are included in the documentation (see
694
# the \image command).
698
# The INPUT_FILTER tag can be used to specify a program that doxygen should
699
# invoke to filter for each input file. Doxygen will invoke the filter program
700
# by executing (via popen()) the command <filter> <input-file>, where <filter>
701
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
702
# input file. Doxygen will then use the output that the filter program writes
703
# to standard output. If FILTER_PATTERNS is specified, this tag will be
708
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
709
# basis. Doxygen will compare the file name with each pattern and apply the
710
# filter if there is a match. The filters are a list of the form:
711
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
712
# info on how filters are used. If FILTER_PATTERNS is empty or if
713
# non of the patterns match the file name, INPUT_FILTER is applied.
717
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
718
# INPUT_FILTER) will be used to filter the input files when producing source
719
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
721
FILTER_SOURCE_FILES = NO
723
#---------------------------------------------------------------------------
724
# configuration options related to source browsing
725
#---------------------------------------------------------------------------
727
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
728
# be generated. Documented entities will be cross-referenced with these sources.
729
# Note: To get rid of all source code in the generated output, make sure also
730
# VERBATIM_HEADERS is set to NO.
734
# Setting the INLINE_SOURCES tag to YES will include the body
735
# of functions and classes directly in the documentation.
739
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
740
# doxygen to hide any special comment blocks from generated source code
741
# fragments. Normal C and C++ comments will always remain visible.
743
STRIP_CODE_COMMENTS = YES
745
# If the REFERENCED_BY_RELATION tag is set to YES
746
# then for each documented function all documented
747
# functions referencing it will be listed.
749
REFERENCED_BY_RELATION = NO
751
# If the REFERENCES_RELATION tag is set to YES
752
# then for each documented function all documented entities
753
# called/used by that function will be listed.
755
REFERENCES_RELATION = NO
757
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
758
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
759
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
760
# link to the source code. Otherwise they will link to the documentation.
762
REFERENCES_LINK_SOURCE = YES
764
# If the USE_HTAGS tag is set to YES then the references to source code
765
# will point to the HTML generated by the htags(1) tool instead of doxygen
766
# built-in source browser. The htags tool is part of GNU's global source
767
# tagging system (see http://www.gnu.org/software/global/global.html). You
768
# will need version 4.8.6 or higher.
772
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
773
# will generate a verbatim copy of the header file for each class for
774
# which an include is specified. Set to NO to disable this.
776
VERBATIM_HEADERS = YES
778
#---------------------------------------------------------------------------
779
# configuration options related to the alphabetical class index
780
#---------------------------------------------------------------------------
782
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
783
# of all compounds will be generated. Enable this if the project
784
# contains a lot of classes, structs, unions or interfaces.
786
ALPHABETICAL_INDEX = YES
788
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
789
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
790
# in which this list will be split (can be a number in the range [1..20])
792
COLS_IN_ALPHA_INDEX = 5
794
# In case all classes in a project start with a common prefix, all
795
# classes will be put under the same header in the alphabetical index.
796
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
797
# should be ignored while generating the index headers.
801
#---------------------------------------------------------------------------
802
# configuration options related to the HTML output
803
#---------------------------------------------------------------------------
805
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
806
# generate HTML output.
810
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
811
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
812
# put in front of it. If left blank `html' will be used as the default path.
816
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
817
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
818
# doxygen will generate files with .html extension.
820
HTML_FILE_EXTENSION = .html
822
# The HTML_HEADER tag can be used to specify a personal HTML header for
823
# each generated HTML page. If it is left blank doxygen will generate a
828
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
829
# each generated HTML page. If it is left blank doxygen will generate a
834
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
835
# style sheet that is used by each HTML page. It can be used to
836
# fine-tune the look of the HTML output. If the tag is left blank doxygen
837
# will generate a default style sheet. Note that doxygen will try to copy
838
# the style sheet file to the HTML output directory, so don't put your own
839
# stylesheet in the HTML output directory as well, or it will be erased!
843
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
844
# Doxygen will adjust the colors in the stylesheet and background images
845
# according to this color. Hue is specified as an angle on a colorwheel,
846
# see http://en.wikipedia.org/wiki/Hue for more information.
847
# For instance the value 0 represents red, 60 is yellow, 120 is green,
848
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
849
# The allowed range is 0 to 359.
851
HTML_COLORSTYLE_HUE = 220
853
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
854
# the colors in the HTML output. For a value of 0 the output will use
855
# grayscales only. A value of 255 will produce the most vivid colors.
857
HTML_COLORSTYLE_SAT = 100
859
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
860
# the luminance component of the colors in the HTML output. Values below
861
# 100 gradually make the output lighter, whereas values above 100 make
862
# the output darker. The value divided by 100 is the actual gamma applied,
863
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
864
# and 100 does not change the gamma.
866
HTML_COLORSTYLE_GAMMA = 80
868
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
869
# page will contain the date and time when the page was generated. Setting
870
# this to NO can help when comparing the output of multiple runs.
874
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
875
# files or namespaces will be aligned in HTML using tables. If set to
876
# NO a bullet list will be used.
878
HTML_ALIGN_MEMBERS = YES
880
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
881
# documentation will contain sections that can be hidden and shown after the
882
# page has loaded. For this to work a browser that supports
883
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
884
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
886
HTML_DYNAMIC_SECTIONS = NO
888
# If the GENERATE_DOCSET tag is set to YES, additional index files
889
# will be generated that can be used as input for Apple's Xcode 3
890
# integrated development environment, introduced with OSX 10.5 (Leopard).
891
# To create a documentation set, doxygen will generate a Makefile in the
892
# HTML output directory. Running make will produce the docset in that
893
# directory and running "make install" will install the docset in
894
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
896
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
897
# for more information.
901
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
902
# feed. A documentation feed provides an umbrella under which multiple
903
# documentation sets from a single provider (such as a company or product suite)
906
DOCSET_FEEDNAME = "Doxygen generated docs"
908
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
909
# should uniquely identify the documentation set bundle. This should be a
910
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
911
# will append .docset to the name.
913
DOCSET_BUNDLE_ID = org.doxygen.Project
915
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
916
# the documentation publisher. This should be a reverse domain-name style
917
# string, e.g. com.mycompany.MyDocSet.documentation.
919
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
921
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
923
DOCSET_PUBLISHER_NAME = Publisher
925
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
926
# will be generated that can be used as input for tools like the
927
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
928
# of the generated HTML documentation.
930
GENERATE_HTMLHELP = NO
932
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
933
# be used to specify the file name of the resulting .chm file. You
934
# can add a path in front of the file if the result should not be
935
# written to the html output directory.
939
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
940
# be used to specify the location (absolute path including file name) of
941
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
942
# the HTML help compiler on the generated index.hhp.
946
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
947
# controls if a separate .chi index file is generated (YES) or that
948
# it should be included in the master .chm file (NO).
952
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
953
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
958
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
959
# controls whether a binary table of contents is generated (YES) or a
960
# normal table of contents (NO) in the .chm file.
964
# The TOC_EXPAND flag can be set to YES to add extra items for group members
965
# to the contents of the HTML help documentation and to the tree view.
969
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
970
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
971
# that can be used as input for Qt's qhelpgenerator to generate a
972
# Qt Compressed Help (.qch) of the generated HTML documentation.
976
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
977
# be used to specify the file name of the resulting .qch file.
978
# The path specified is relative to the HTML output folder.
982
# The QHP_NAMESPACE tag specifies the namespace to use when generating
983
# Qt Help Project output. For more information please see
984
# http://doc.trolltech.com/qthelpproject.html#namespace
986
QHP_NAMESPACE = org.doxygen.Project
988
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
989
# Qt Help Project output. For more information please see
990
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
992
QHP_VIRTUAL_FOLDER = doc
994
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
995
# add. For more information please see
996
# http://doc.trolltech.com/qthelpproject.html#custom-filters
998
QHP_CUST_FILTER_NAME =
1000
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1001
# custom filter to add. For more information please see
1002
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1003
# Qt Help Project / Custom Filters</a>.
1005
QHP_CUST_FILTER_ATTRS =
1007
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1009
# filter section matches.
1010
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1011
# Qt Help Project / Filter Attributes</a>.
1013
QHP_SECT_FILTER_ATTRS =
1015
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1016
# be used to specify the location of Qt's qhelpgenerator.
1017
# If non-empty doxygen will try to run qhelpgenerator on the generated
1022
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1023
# will be generated, which together with the HTML files, form an Eclipse help
1024
# plugin. To install this plugin and make it available under the help contents
1025
# menu in Eclipse, the contents of the directory containing the HTML and XML
1026
# files needs to be copied into the plugins directory of eclipse. The name of
1027
# the directory within the plugins directory should be the same as
1028
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1031
GENERATE_ECLIPSEHELP = NO
1033
# A unique identifier for the eclipse help plugin. When installing the plugin
1034
# the directory name containing the HTML and XML files should also have
1037
ECLIPSE_DOC_ID = org.doxygen.Project
1039
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1040
# top of each HTML page. The value NO (the default) enables the index and
1041
# the value YES disables it.
1045
# This tag can be used to set the number of enum values (range [0,1..20])
1046
# that doxygen will group on one line in the generated HTML documentation.
1047
# Note that a value of 0 will completely suppress the enum values from
1048
# appearing in the overview section.
1050
ENUM_VALUES_PER_LINE = 4
1052
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1053
# structure should be generated to display hierarchical information.
1054
# If the tag value is set to YES, a side panel will be generated
1055
# containing a tree-like index structure (just like the one that
1056
# is generated for HTML Help). For this to work a browser that supports
1057
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1058
# Windows users are probably better off using the HTML help feature.
1060
GENERATE_TREEVIEW = NO
1062
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1063
# and Class Hierarchy pages using a tree view instead of an ordered list.
1065
USE_INLINE_TREES = NO
1067
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1068
# used to set the initial width (in pixels) of the frame in which the tree
1071
TREEVIEW_WIDTH = 250
1073
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1074
# links to external symbols imported via tag files in a separate window.
1076
EXT_LINKS_IN_WINDOW = NO
1078
# Use this tag to change the font size of Latex formulas included
1079
# as images in the HTML documentation. The default is 10. Note that
1080
# when you change the font size after a successful doxygen run you need
1081
# to manually remove any form_*.png images from the HTML output directory
1082
# to force them to be regenerated.
1084
FORMULA_FONTSIZE = 10
1086
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1087
# generated for formulas are transparent PNGs. Transparent PNGs are
1088
# not supported properly for IE 6.0, but are supported on all modern browsers.
1089
# Note that when changing this option you need to delete any form_*.png files
1090
# in the HTML output before the changes have effect.
1092
FORMULA_TRANSPARENT = YES
1094
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1095
# for the HTML output. The underlying search engine uses javascript
1096
# and DHTML and should work on any modern browser. Note that when using
1097
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1098
# (GENERATE_DOCSET) there is already a search function so this one should
1099
# typically be disabled. For large projects the javascript based search engine
1100
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1104
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1105
# implemented using a PHP enabled web server instead of at the web client
1106
# using Javascript. Doxygen will generate the search PHP script and index
1107
# file to put on the web server. The advantage of the server
1108
# based approach is that it scales better to large projects and allows
1109
# full text search. The disadvantages are that it is more difficult to setup
1110
# and does not have live searching capabilities.
1112
SERVER_BASED_SEARCH = NO
1114
#---------------------------------------------------------------------------
1115
# configuration options related to the LaTeX output
1116
#---------------------------------------------------------------------------
1118
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1119
# generate Latex output.
1123
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1124
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1125
# put in front of it. If left blank `latex' will be used as the default path.
1127
LATEX_OUTPUT = latex
1129
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1130
# invoked. If left blank `latex' will be used as the default command name.
1131
# Note that when enabling USE_PDFLATEX this option is only used for
1132
# generating bitmaps for formulas in the HTML output, but not in the
1133
# Makefile that is written to the output directory.
1135
LATEX_CMD_NAME = latex
1137
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1138
# generate index for LaTeX. If left blank `makeindex' will be used as the
1139
# default command name.
1141
MAKEINDEX_CMD_NAME = makeindex
1143
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1144
# LaTeX documents. This may be useful for small projects and may help to
1145
# save some trees in general.
1149
# The PAPER_TYPE tag can be used to set the paper type that is used
1150
# by the printer. Possible values are: a4, letter, legal and
1151
# executive. If left blank a4wide will be used.
1155
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1156
# packages that should be included in the LaTeX output.
1160
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1161
# the generated latex document. The header should contain everything until
1162
# the first chapter. If it is left blank doxygen will generate a
1163
# standard header. Notice: only use this tag if you know what you are doing!
1167
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1168
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1169
# contain links (just like the HTML output) instead of page references
1170
# This makes the output suitable for online browsing using a pdf viewer.
1172
PDF_HYPERLINKS = YES
1174
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1175
# plain latex in the generated Makefile. Set this option to YES to get a
1176
# higher quality PDF documentation.
1180
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1181
# command to the generated LaTeX files. This will instruct LaTeX to keep
1182
# running if errors occur, instead of asking the user for help.
1183
# This option is also used when generating formulas in HTML.
1185
LATEX_BATCHMODE = NO
1187
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1188
# include the index chapters (such as File Index, Compound Index, etc.)
1191
LATEX_HIDE_INDICES = NO
1193
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1194
# source code with syntax highlighting in the LaTeX output.
1195
# Note that which sources are shown also depends on other settings
1196
# such as SOURCE_BROWSER.
1198
LATEX_SOURCE_CODE = NO
1200
#---------------------------------------------------------------------------
1201
# configuration options related to the RTF output
1202
#---------------------------------------------------------------------------
1204
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1205
# The RTF output is optimized for Word 97 and may not look very pretty with
1206
# other RTF readers or editors.
1210
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1211
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1212
# put in front of it. If left blank `rtf' will be used as the default path.
1216
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1217
# RTF documents. This may be useful for small projects and may help to
1218
# save some trees in general.
1222
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1223
# will contain hyperlink fields. The RTF file will
1224
# contain links (just like the HTML output) instead of page references.
1225
# This makes the output suitable for online browsing using WORD or other
1226
# programs which support those fields.
1227
# Note: wordpad (write) and others do not support links.
1231
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1232
# config file, i.e. a series of assignments. You only have to provide
1233
# replacements, missing definitions are set to their default value.
1235
RTF_STYLESHEET_FILE =
1237
# Set optional variables used in the generation of an rtf document.
1238
# Syntax is similar to doxygen's config file.
1240
RTF_EXTENSIONS_FILE =
1242
#---------------------------------------------------------------------------
1243
# configuration options related to the man page output
1244
#---------------------------------------------------------------------------
1246
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1247
# generate man pages
1251
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1252
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1253
# put in front of it. If left blank `man' will be used as the default path.
1257
# The MAN_EXTENSION tag determines the extension that is added to
1258
# the generated man pages (default is the subroutine's section .3)
1262
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1263
# then it will generate one additional man file for each entity
1264
# documented in the real man page(s). These additional files
1265
# only source the real man page, but without them the man command
1266
# would be unable to find the correct page. The default is NO.
1270
#---------------------------------------------------------------------------
1271
# configuration options related to the XML output
1272
#---------------------------------------------------------------------------
1274
# If the GENERATE_XML tag is set to YES Doxygen will
1275
# generate an XML file that captures the structure of
1276
# the code including all documentation.
1280
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1281
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1282
# put in front of it. If left blank `xml' will be used as the default path.
1286
# The XML_SCHEMA tag can be used to specify an XML schema,
1287
# which can be used by a validating XML parser to check the
1288
# syntax of the XML files.
1292
# The XML_DTD tag can be used to specify an XML DTD,
1293
# which can be used by a validating XML parser to check the
1294
# syntax of the XML files.
1298
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1299
# dump the program listings (including syntax highlighting
1300
# and cross-referencing information) to the XML output. Note that
1301
# enabling this will significantly increase the size of the XML output.
1303
XML_PROGRAMLISTING = YES
1305
#---------------------------------------------------------------------------
1306
# configuration options for the AutoGen Definitions output
1307
#---------------------------------------------------------------------------
1309
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1310
# generate an AutoGen Definitions (see autogen.sf.net) file
1311
# that captures the structure of the code including all
1312
# documentation. Note that this feature is still experimental
1313
# and incomplete at the moment.
1315
GENERATE_AUTOGEN_DEF = NO
1317
#---------------------------------------------------------------------------
1318
# configuration options related to the Perl module output
1319
#---------------------------------------------------------------------------
1321
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1322
# generate a Perl module file that captures the structure of
1323
# the code including all documentation. Note that this
1324
# feature is still experimental and incomplete at the
1327
GENERATE_PERLMOD = NO
1329
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1330
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1331
# to generate PDF and DVI output from the Perl module output.
1335
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1336
# nicely formatted so it can be parsed by a human reader. This is useful
1337
# if you want to understand what is going on. On the other hand, if this
1338
# tag is set to NO the size of the Perl module output will be much smaller
1339
# and Perl will parse it just the same.
1341
PERLMOD_PRETTY = YES
1343
# The names of the make variables in the generated doxyrules.make file
1344
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1345
# This is useful so different doxyrules.make files included by the same
1346
# Makefile don't overwrite each other's variables.
1348
PERLMOD_MAKEVAR_PREFIX =
1350
#---------------------------------------------------------------------------
1351
# Configuration options related to the preprocessor
1352
#---------------------------------------------------------------------------
1354
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1355
# evaluate all C-preprocessor directives found in the sources and include
1358
ENABLE_PREPROCESSING = YES
1360
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1361
# names in the source code. If set to NO (the default) only conditional
1362
# compilation will be performed. Macro expansion can be done in a controlled
1363
# way by setting EXPAND_ONLY_PREDEF to YES.
1365
MACRO_EXPANSION = YES
1367
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1368
# then the macro expansion is limited to the macros specified with the
1369
# PREDEFINED and EXPAND_AS_DEFINED tags.
1371
EXPAND_ONLY_PREDEF = YES
1373
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1374
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1376
SEARCH_INCLUDES = YES
1378
# The INCLUDE_PATH tag can be used to specify one or more directories that
1379
# contain include files that are not input files but should be processed by
1382
INCLUDE_PATH = $(builddir)
1384
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1385
# patterns (like *.h and *.hpp) to filter out the header-files in the
1386
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1389
INCLUDE_FILE_PATTERNS = *.h
1391
# The PREDEFINED tag can be used to specify one or more macro names that
1392
# are defined before the preprocessor is started (similar to the -D option of
1393
# gcc). The argument of the tag is a list of macros of the form: name
1394
# or name=definition (no spaces). If the definition and the = are
1395
# omitted =1 is assumed. To prevent a macro definition from being
1396
# undefined via #undef or recursively expanded use the := operator
1397
# instead of the = operator.
1399
PREDEFINED = CS_PROCF(x,y)=x DOXYGEN_ONLY
1401
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1402
# this tag can be used to specify a list of macro names that should be expanded.
1403
# The macro definition that is found in the sources will be used.
1404
# Use the PREDEFINED tag if you want to use a different macro definition that
1405
# overrules the definition found in the source code.
1409
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1410
# doxygen's preprocessor will remove all references to function-like macros
1411
# that are alone on a line, have an all uppercase name, and do not end with a
1412
# semicolon, because these will confuse the parser if not removed.
1414
SKIP_FUNCTION_MACROS = YES
1416
#---------------------------------------------------------------------------
1417
# Configuration::additions related to external references
1418
#---------------------------------------------------------------------------
1420
# The TAGFILES option can be used to specify one or more tagfiles.
1421
# Optionally an initial location of the external documentation
1422
# can be added for each tagfile. The format of a tag file without
1423
# this location is as follows:
1424
# TAGFILES = file1 file2 ...
1425
# Adding location for the tag files is done as follows:
1426
# TAGFILES = file1=loc1 "file2 = loc2" ...
1427
# where "loc1" and "loc2" can be relative or absolute paths or
1428
# URLs. If a location is present for each tag, the installdox tool
1429
# does not have to be run to correct the links.
1430
# Note that each tag file must have a unique name
1431
# (where the name does NOT include the path)
1432
# If a tag file is not located in the directory in which doxygen
1433
# is run, you must also specify the path to the tagfile here.
1437
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1438
# a tag file that is based on the input files it reads.
1442
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1443
# in the class index. If set to NO only the inherited external classes
1448
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1449
# in the modules index. If set to NO, only the current project's groups will
1452
EXTERNAL_GROUPS = YES
1454
# The PERL_PATH should be the absolute path and name of the perl script
1455
# interpreter (i.e. the result of `which perl').
1457
PERL_PATH = /usr/bin/perl
1459
#---------------------------------------------------------------------------
1460
# Configuration options related to the dot tool
1461
#---------------------------------------------------------------------------
1463
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1464
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1465
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1466
# this option also works with HAVE_DOT disabled, but it is recommended to
1467
# install and use dot, since it yields more powerful graphs.
1469
CLASS_DIAGRAMS = YES
1471
# You can define message sequence charts within doxygen comments using the \msc
1472
# command. Doxygen will then run the mscgen tool (see
1473
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1474
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1475
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1476
# default search path.
1480
# If set to YES, the inheritance and collaboration graphs will hide
1481
# inheritance and usage relations if the target is undocumented
1482
# or is not a class.
1484
HIDE_UNDOC_RELATIONS = YES
1486
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1487
# available from the path. This tool is part of Graphviz, a graph visualization
1488
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1489
# have no effect if this option is set to NO (the default)
1493
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1494
# allowed to run in parallel. When set to 0 (the default) doxygen will
1495
# base this on the number of processors available in the system. You can set it
1496
# explicitly to a value larger than 0 to get control over the balance
1497
# between CPU load and processing speed.
1501
# By default doxygen will write a font called Helvetica to the output
1502
# directory and reference it in all dot files that doxygen generates.
1503
# When you want a differently looking font you can specify the font name
1504
# using DOT_FONTNAME. You need to make sure dot is able to find the font,
1505
# which can be done by putting it in a standard location or by setting the
1506
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1507
# containing the font.
1509
DOT_FONTNAME = Helvetica
1511
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1512
# The default size is 10pt.
1516
# By default doxygen will tell dot to use the output directory to look for the
1517
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1518
# different font using DOT_FONTNAME you can set the path where dot
1519
# can find it using this tag.
1523
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1524
# will generate a graph for each documented class showing the direct and
1525
# indirect inheritance relations. Setting this tag to YES will force the
1526
# the CLASS_DIAGRAMS tag to NO.
1530
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1531
# will generate a graph for each documented class showing the direct and
1532
# indirect implementation dependencies (inheritance, containment, and
1533
# class references variables) of the class with other documented classes.
1535
COLLABORATION_GRAPH = YES
1537
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1538
# will generate a graph for groups, showing the direct groups dependencies
1542
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1543
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1548
# If set to YES, the inheritance and collaboration graphs will show the
1549
# relations between templates and their instances.
1551
TEMPLATE_RELATIONS = NO
1553
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1554
# tags are set to YES then doxygen will generate a graph for each documented
1555
# file showing the direct and indirect include dependencies of the file with
1556
# other documented files.
1560
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1561
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1562
# documented header file showing the documented files that directly or
1563
# indirectly include this file.
1565
INCLUDED_BY_GRAPH = YES
1567
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1568
# doxygen will generate a call dependency graph for every global function
1569
# or class method. Note that enabling this option will significantly increase
1570
# the time of a run. So in most cases it will be better to enable call graphs
1571
# for selected functions only using the \callgraph command.
1575
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1576
# doxygen will generate a caller dependency graph for every global function
1577
# or class method. Note that enabling this option will significantly increase
1578
# the time of a run. So in most cases it will be better to enable caller
1579
# graphs for selected functions only using the \callergraph command.
1583
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1584
# will generate a graphical hierarchy of all classes instead of a textual one.
1586
GRAPHICAL_HIERARCHY = YES
1588
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1589
# then doxygen will show the dependencies a directory has on other directories
1590
# in a graphical way. The dependency relations are determined by the #include
1591
# relations between the files in the directories.
1593
DIRECTORY_GRAPH = YES
1595
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1596
# generated by dot. Possible values are png, svg, gif or svg.
1597
# If left blank png will be used.
1599
DOT_IMAGE_FORMAT = png
1601
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1602
# found. If left blank, it is assumed the dot tool can be found in the path.
1606
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1607
# contain dot files that are included in the documentation (see the
1608
# \dotfile command).
1612
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1613
# nodes that will be shown in the graph. If the number of nodes in a graph
1614
# becomes larger than this value, doxygen will truncate the graph, which is
1615
# visualized by representing a node as a red box. Note that doxygen if the
1616
# number of direct children of the root node in a graph is already larger than
1617
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1618
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1620
DOT_GRAPH_MAX_NODES = 85
1622
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1623
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1624
# from the root by following a path via at most 3 edges will be shown. Nodes
1625
# that lay further from the root node will be omitted. Note that setting this
1626
# option to 1 or 2 may greatly reduce the computation time needed for large
1627
# code bases. Also note that the size of a graph can be further restricted by
1628
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1630
MAX_DOT_GRAPH_DEPTH = 3
1632
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1633
# background. This is disabled by default, because dot on Windows does not
1634
# seem to support this out of the box. Warning: Depending on the platform used,
1635
# enabling this option may lead to badly anti-aliased labels on the edges of
1636
# a graph (i.e. they become hard to read).
1638
DOT_TRANSPARENT = NO
1640
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1641
# files in one run (i.e. multiple -o and -T options on the command line). This
1642
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1643
# support this, this feature is disabled by default.
1645
DOT_MULTI_TARGETS = NO
1647
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1648
# generate a legend page explaining the meaning of the various boxes and
1649
# arrows in the dot generated graphs.
1651
GENERATE_LEGEND = YES
1653
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1654
# remove the intermediate dot files that are used to generate
1655
# the various graphs.