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
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37
# base path where the generated documentation will be put.
38
# If a relative path is entered, it will be relative to the location
39
# where doxygen was started. If left blank the current directory will be used.
41
OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIR@
43
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44
# 4096 sub-directories (in 2 levels) under the output directory of each output
45
# format and will distribute the generated files over these directories.
46
# Enabling this option can be useful when feeding doxygen a huge amount of
47
# source files, where putting all generated files in the same directory would
48
# otherwise cause performance problems for the file system.
52
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53
# documentation generated by doxygen is written. Doxygen will use this
54
# information to generate all constant output in the proper language.
55
# The default language is English, other supported languages are:
56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
63
OUTPUT_LANGUAGE = English
65
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66
# include brief member descriptions after the members that are listed in
67
# the file and class documentation (similar to JavaDoc).
68
# Set to NO to disable this.
70
BRIEF_MEMBER_DESC = YES
72
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73
# the brief description of a member or function before the detailed description.
74
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75
# brief descriptions will be completely suppressed.
79
# This tag implements a quasi-intelligent brief description abbreviator
80
# that is used to form the text in various listings. Each string
81
# in this list, if found as the leading text of the brief description, will be
82
# stripped from the text and the result after processing the whole list, is
83
# used as the annotated text. Otherwise, the brief description is used as-is.
84
# If left blank, the following values are used ("$name" is automatically85
# replaced with the name of the entity): "The $name class" "The $name widget"
86
# "The $name file" "is" "provides" "specifies" "contains"
87
# "represents" "a" "an" "the"
91
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92
# Doxygen will generate a detailed section even if there is only a brief
95
ALWAYS_DETAILED_SEC = NO
97
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98
# inherited members of a class in the documentation of that class as if those
99
# members were ordinary class members. Constructors, destructors and assignment
100
# operators of the base classes will not be shown.
102
INLINE_INHERITED_MEMB = NO
104
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105
# path before files name in the file list and in the header files. If set
106
# to NO the shortest path that makes the file name unique will be used.
110
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111
# can be used to strip a user-defined part of the path. Stripping is
112
# only done if one of the specified strings matches the left-hand part of
113
# the path. The tag can be used to show relative paths in the file list.
114
# If left blank the directory from which doxygen is run is used as the
119
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120
# the path mentioned in the documentation of a class, which tells
121
# the reader which header file to include in order to use a class.
122
# If left blank only the name of the header file containing the class
123
# definition is used. Otherwise one should specify the include paths that
124
# are normally passed to the compiler using the -I flag.
128
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129
# (but less readable) file names. This can be useful is your file systems
130
# doesn't support long names like on DOS, Mac, or CD-ROM.
134
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135
# will interpret the first line (until the first dot) of a JavaDoc-style
136
# comment as the brief description. If set to NO, the JavaDoc
137
# comments will behave just like regular Qt-style comments
138
# (thus requiring an explicit @brief command for a brief description.)
140
JAVADOC_AUTOBRIEF = YES
142
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143
# interpret the first line (until the first dot) of a Qt-style
144
# comment as the brief description. If set to NO, the comments
145
# will behave just like regular Qt-style comments (thus requiring
146
# an explicit \brief command for a brief description.)
150
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
152
# comments) as a brief description. This used to be the default behaviour.
153
# The new default is to treat a multi-line C++ comment block as a detailed
154
# description. Set this tag to YES if you prefer the old behaviour instead.
156
MULTILINE_CPP_IS_BRIEF = NO
158
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159
# member inherits the documentation from any documented member that it
164
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165
# a new page for each member. If set to NO, the documentation of a member will
166
# be part of the file/class/namespace that contains it.
168
SEPARATE_MEMBER_PAGES = NO
170
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
171
# Doxygen uses this value to replace tabs by spaces in code fragments.
175
# This tag can be used to specify a number of aliases that acts
176
# as commands in the documentation. An alias has the form "name=value".
177
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
178
# put the command \sideeffect (or @sideeffect) in the documentation, which
179
# will result in a user-defined paragraph with heading "Side Effects:".
180
# You can put \n's in the value part of an alias to insert newlines.
184
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185
# sources only. Doxygen will then generate output that is more tailored for C.
186
# For instance, some of the names that are used will be different. The list
187
# of all members will be omitted, etc.
189
OPTIMIZE_OUTPUT_FOR_C = NO
191
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192
# sources only. Doxygen will then generate output that is more tailored for
193
# Java. For instance, namespaces will be presented as packages, qualified
194
# scopes will look different, etc.
196
OPTIMIZE_OUTPUT_JAVA = NO
198
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199
# sources only. Doxygen will then generate output that is more tailored for
202
OPTIMIZE_FOR_FORTRAN = NO
204
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205
# sources. Doxygen will then generate output that is tailored for
208
OPTIMIZE_OUTPUT_VHDL = NO
210
# Doxygen selects the parser to use depending on the extension of the files it
211
# parses. With this tag you can assign which parser to use for a given extension.
212
# Doxygen has a built-in mapping, but you can override or extend it using this
213
# tag. The format is ext=language, where ext is a file extension, and language
214
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
215
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
216
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
217
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
218
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
222
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
223
# to include (a tag file for) the STL sources as input, then you should
224
# set this tag to YES in order to let doxygen match functions declarations and
225
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
226
# func(std::string) {}). This also make the inheritance and collaboration227
# diagrams that involve STL classes more complete and accurate.
229
BUILTIN_STL_SUPPORT = YES
231
# If you use Microsoft's C++/CLI language, you should set this option to YES to
232
# enable parsing support.
236
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
237
# Doxygen will parse them like normal C++ but will assume all classes use public
238
# instead of private inheritance when no explicit protection keyword is present.
242
# For Microsoft's IDL there are propget and propput attributes to indicate getter
243
# and setter methods for a property. Setting this option to YES (the default)
244
# will make doxygen to replace the get and set methods by a property in the
245
# documentation. This will only work if the methods are indeed getting or
246
# setting a simple type. If this is not the case, or you want to show the
247
# methods anyway, you should set this option to NO.
249
IDL_PROPERTY_SUPPORT = YES
251
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
252
# tag is set to YES, then doxygen will reuse the documentation of the first
253
# member in the group (if any) for the other members of the group. By default
254
# all members of a group must be documented explicitly.
256
DISTRIBUTE_GROUP_DOC = NO
258
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
259
# the same type (for instance a group of public functions) to be put as a
260
# subgroup of that type (e.g. under the Public Functions section). Set it to
261
# NO to prevent subgrouping. Alternatively, this can be done per class using
262
# the \nosubgrouping command.
266
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
267
# is documented as struct, union, or enum with the name of the typedef. So
268
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct269
# with name TypeT. When disabled the typedef will appear as a member of a file,
270
# namespace, or class. And the struct will be named TypeS. This can typically
271
# be useful for C code in case the coding convention dictates that all compound
272
# types are typedef'ed and only the typedef is referenced, never the tag name.
274
TYPEDEF_HIDES_STRUCT = NO
276
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
277
# determine which symbols to keep in memory and which to flush to disk.
278
# When the cache is full, less often used symbols will be written to disk.
279
# For small to medium size projects (<1000 input files) the default value is
280
# probably good enough. For larger projects a too small cache size can cause
281
# doxygen to be busy swapping symbols to and from disk most of the time
282
# causing a significant performance penalty.
283
# If the system has enough physical memory increasing the cache will improve the
284
# performance by keeping more symbols in memory. Note that the value works on
285
# a logarithmic scale so increasing the size by one will rougly double the
286
# memory usage. The cache size is given by this formula:
287
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
288
# corresponding to a cache size of 2^16 = 65536 symbols
290
# SYMBOL_CACHE_SIZE = 0
293
#---------------------------------------------------------------------------
294
# Build related configuration options
295
#---------------------------------------------------------------------------
297
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
298
# documentation are documented, even if no documentation was available.
299
# Private class members and static file members will be hidden unless
300
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
304
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
305
# will be included in the documentation.
309
# If the EXTRACT_STATIC tag is set to YES all static members of a file
310
# will be included in the documentation.
314
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
315
# defined locally in source files will be included in the documentation.
316
# If set to NO only classes defined in header files are included.
318
EXTRACT_LOCAL_CLASSES = YES
320
# This flag is only useful for Objective-C code. When set to YES local
321
# methods, which are defined in the implementation section but not in
322
# the interface are included in the documentation.
323
# If set to NO (the default) only methods in the interface are included.
325
EXTRACT_LOCAL_METHODS = YES
327
# If this flag is set to YES, the members of anonymous namespaces will be
328
# extracted and appear in the documentation as a namespace called
329
# 'anonymous_namespace{file}', where file will be replaced with the base330
# name of the file that contains the anonymous namespace. By default
331
# anonymous namespace are hidden.
333
EXTRACT_ANON_NSPACES = NO
335
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
336
# undocumented members of documented classes, files or namespaces.
337
# If set to NO (the default) these members will be included in the
338
# various overviews, but no documentation section is generated.
339
# This option has no effect if EXTRACT_ALL is enabled.
341
HIDE_UNDOC_MEMBERS = NO
343
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
344
# undocumented classes that are normally visible in the class hierarchy.
345
# If set to NO (the default) these classes will be included in the various
346
# overviews. This option has no effect if EXTRACT_ALL is enabled.
348
HIDE_UNDOC_CLASSES = YES
350
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
351
# friend (class|struct|union) declarations.
352
# If set to NO (the default) these declarations will be included in the
355
HIDE_FRIEND_COMPOUNDS = NO
357
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
358
# documentation blocks found inside the body of a function.
359
# If set to NO (the default) these blocks will be appended to the
360
# function's detailed documentation block.
362
HIDE_IN_BODY_DOCS = NO
364
# The INTERNAL_DOCS tag determines if documentation
365
# that is typed after a \internal command is included. If the tag is set
366
# to NO (the default) then the documentation will be excluded.
367
# Set it to YES to include the internal documentation.
371
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
372
# file names in lower-case letters. If set to YES upper-case letters are also
373
# allowed. This is useful if you have classes or files whose names only differ
374
# in case and if your file system supports case sensitive file names. Windows
375
# and Mac users are advised to set this option to NO.
377
CASE_SENSE_NAMES = YES
379
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
380
# will show members with their full class and namespace scopes in the
381
# documentation. If set to YES the scope will be hidden.
385
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
386
# will put a list of the files that are included by a file in the documentation
389
SHOW_INCLUDE_FILES = YES
391
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
392
# will list include files with double quotes in the documentation
393
# rather than with sharp brackets.
395
FORCE_LOCAL_INCLUDES = NO
397
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
398
# is inserted in the documentation for inline members.
402
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
403
# will sort the (detailed) documentation of file and class members
404
# alphabetically by member name. If set to NO the members will appear in
407
SORT_MEMBER_DOCS = YES
409
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
410
# brief documentation of file, namespace and class members alphabetically
411
# by member name. If set to NO (the default) the members will appear in
416
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
417
# will sort the (brief and detailed) documentation of class members so that
418
# constructors and destructors are listed first. If set to NO (the default)
419
# the constructors will appear in the respective orders defined by
420
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
421
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
422
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
424
SORT_MEMBERS_CTORS_1ST = NO
426
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
427
# hierarchy of group names into alphabetical order. If set to NO (the default)
428
# the group names will appear in their defined order.
432
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
433
# sorted by fully-qualified names, including namespaces. If set to
434
# NO (the default), the class list will be sorted only by class name,
435
# not including the namespace part.
436
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
437
# Note: This option applies only to the class list, not to the
440
SORT_BY_SCOPE_NAME = YES
442
# The GENERATE_TODOLIST tag can be used to enable (YES) or
443
# disable (NO) the todo list. This list is created by putting \todo
444
# commands in the documentation.
446
GENERATE_TODOLIST = YES
448
# The GENERATE_TESTLIST tag can be used to enable (YES) or
449
# disable (NO) the test list. This list is created by putting \test
450
# commands in the documentation.
452
GENERATE_TESTLIST = YES
454
# The GENERATE_BUGLIST tag can be used to enable (YES) or
455
# disable (NO) the bug list. This list is created by putting \bug
456
# commands in the documentation.
458
GENERATE_BUGLIST = YES
460
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
461
# disable (NO) the deprecated list. This list is created by putting
462
# \deprecated commands in the documentation.
464
GENERATE_DEPRECATEDLIST= YES
466
# The ENABLED_SECTIONS tag can be used to enable conditional
467
# documentation sections, marked by \if sectionname ... \endif.
469
ENABLED_SECTIONS = DEV_DOCUMENTATION
471
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
472
# the initial value of a variable or define consists of for it to appear in
473
# the documentation. If the initializer consists of more lines than specified
474
# here it will be hidden. Use a value of 0 to hide initializers completely.
475
# The appearance of the initializer of individual variables and defines in the
476
# documentation can be controlled using \showinitializer or \hideinitializer
477
# command in the documentation regardless of this setting.
479
MAX_INITIALIZER_LINES = 30
481
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
482
# at the bottom of the documentation of classes and structs. If set to YES the
483
# list will mention the files that were used to generate the documentation.
487
# If the sources in your project are distributed over multiple directories
488
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
489
# in the documentation. The default is NO.
491
# SHOW_DIRECTORIES = YES
493
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
494
# This will remove the Files entry from the Quick Index and from the
495
# Folder Tree View (if specified). The default is YES.
499
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
501
# This will remove the Namespaces entry from the Quick Index
502
# and from the Folder Tree View (if specified). The default is YES.
506
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
507
# doxygen should invoke to get the current version for each file (typically from
508
# the version control system). Doxygen will invoke the program by executing (via
509
# popen()) the command <command> <input-file>, where <command> is the value of
510
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
511
# provided by doxygen. Whatever the program writes to standard output
512
# is used as the file version. See the manual for examples.
516
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
517
# by doxygen. The layout file controls the global structure of the generated
518
# output files in an output format independent way. The create the layout file
519
# that represents doxygen's defaults, run doxygen with the -l option.
520
# You can optionally specify a file name after the option, if omitted
521
# DoxygenLayout.xml will be used as the name of the layout file.
523
LAYOUT_FILE = @DOXYGEN_LAYOUT_FILE@
525
#---------------------------------------------------------------------------
526
# configuration options related to warning and progress messages
527
#---------------------------------------------------------------------------
529
# The QUIET tag can be used to turn on/off the messages that are generated
530
# by doxygen. Possible values are YES and NO. If left blank NO is used.
534
# The WARNINGS tag can be used to turn on/off the warning messages that are
535
# generated by doxygen. Possible values are YES and NO. If left blank
540
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
541
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
542
# automatically be disabled.
544
WARN_IF_UNDOCUMENTED = NO
546
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
547
# potential errors in the documentation, such as not documenting some
548
# parameters in a documented function, or documenting parameters that
549
# don't exist or using markup commands wrongly.
551
WARN_IF_DOC_ERROR = YES
553
# This WARN_NO_PARAMDOC option can be abled to get warnings for
554
# functions that are documented, but have no documentation for their parameters
555
# or return value. If set to NO (the default) doxygen will only warn about
556
# wrong or incomplete parameter documentation, but not about the absence of
561
# The WARN_FORMAT tag determines the format of the warning messages that
562
# doxygen can produce. The string should contain the $file, $line, and $text
563
# tags, which will be replaced by the file and line number from which the
564
# warning originated and the warning text. Optionally the format may contain
565
# $version, which will be replaced by the version of the file (if it could
566
# be obtained via FILE_VERSION_FILTER)
568
WARN_FORMAT = "$file:$line: $text"
570
# The WARN_LOGFILE tag can be used to specify a file to which warning
571
# and error messages should be written. If left blank the output is written
576
#---------------------------------------------------------------------------
577
# configuration options related to the input files
578
#---------------------------------------------------------------------------
580
# The INPUT tag can be used to specify the files and/or directories that contain
581
# documented source files. You may enter file names like "myfile.cpp" or
582
# directories like "/usr/src/myproject". Separate the files or directories
585
INPUT = @DOXYGEN_INPUT_LIST@
587
# This tag can be used to specify the character encoding of the source files
588
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
589
# also the default input encoding. Doxygen uses libiconv (or the iconv built
590
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
591
# the list of possible encodings.
593
INPUT_ENCODING = UTF-8
595
# If the value of the INPUT tag contains directories, you can use the
596
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
597
# and *.h) to filter out the source-files in the directories. If left
598
# blank the following patterns are tested:
599
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
600
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
612
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
613
# should be searched for input files as well. Possible values are YES and NO.
614
# If left blank NO is used.
618
# The EXCLUDE tag can be used to specify files and/or directories that should
619
# excluded from the INPUT source files. This way you can easily exclude a
620
# subdirectory from a directory tree whose root is specified with the INPUT tag.
622
EXCLUDE = @DOXYGEN_EXCLUDE_LIST@
624
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
625
# directories that are symbolic links (a Unix filesystem feature) are excluded
630
# If the value of the INPUT tag contains directories, you can use the
631
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
632
# certain files from those directories. Note that the wildcards are matched
633
# against the file with absolute path, so to exclude all test directories
634
# for example use the pattern */test/*
636
EXCLUDE_PATTERNS =*.moc.* \
649
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
650
# (namespaces, classes, functions, etc.) that should be excluded from the
651
# output. The symbol name can be a fully qualified name, a word, or if the
652
# wildcard * is used, a substring. Examples: ANamespace, AClass,
653
# AClass::ANamespace, ANamespace::*Test
657
# The EXAMPLE_PATH tag can be used to specify one or more files or
658
# directories that contain example code fragments that are included (see
659
# the \include command).
663
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
664
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
665
# and *.h) to filter out the source-files in the directories. If left
666
# blank all files are included.
670
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
671
# searched for input files to be used with the \include or \dontinclude
672
# commands irrespective of the value of the RECURSIVE tag.
673
# Possible values are YES and NO. If left blank NO is used.
675
EXAMPLE_RECURSIVE = NO
677
# The IMAGE_PATH tag can be used to specify one or more files or
678
# directories that contain image that are included in the documentation (see
679
# the \image command).
681
IMAGE_PATH = @DOXYGEN_IMAGE_PATH@
683
# The INPUT_FILTER tag can be used to specify a program that doxygen should
684
# invoke to filter for each input file. Doxygen will invoke the filter program
685
# by executing (via popen()) the command <filter> <input-file>, where <filter>
686
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
687
# input file. Doxygen will then use the output that the filter program writes
689
# If FILTER_PATTERNS is specified, this tag will be
694
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
696
# Doxygen will compare the file name with each pattern and apply the
697
# filter if there is a match.
698
# The filters are a list of the form:
699
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
700
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
701
# is applied to all files.
705
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
706
# INPUT_FILTER) will be used to filter the input files when producing source
707
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
709
FILTER_SOURCE_FILES = NO
711
#---------------------------------------------------------------------------
712
# configuration options related to source browsing
713
#---------------------------------------------------------------------------
715
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
716
# be generated. Documented entities will be cross-referenced with these sources.
717
# Note: To get rid of all source code in the generated output, make sure also
718
# VERBATIM_HEADERS is set to NO.
722
# Setting the INLINE_SOURCES tag to YES will include the body
723
# of functions and classes directly in the documentation.
727
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
728
# doxygen to hide any special comment blocks from generated source code
729
# fragments. Normal C and C++ comments will always remain visible.
731
STRIP_CODE_COMMENTS = YES
733
# If the REFERENCED_BY_RELATION tag is set to YES
734
# then for each documented function all documented
735
# functions referencing it will be listed.
737
REFERENCED_BY_RELATION = YES
739
# If the REFERENCES_RELATION tag is set to YES
740
# then for each documented function all documented entities
741
# called/used by that function will be listed.
743
REFERENCES_RELATION = YES
745
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
746
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
747
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
748
# link to the source code.
749
# Otherwise they will link to the documentation.
751
REFERENCES_LINK_SOURCE = YES
753
# If the USE_HTAGS tag is set to YES then the references to source code
754
# will point to the HTML generated by the htags(1) tool instead of doxygen
755
# built-in source browser. The htags tool is part of GNU's global source
756
# tagging system (see http://www.gnu.org/software/global/global.html). You
757
# will need version 4.8.6 or higher.
761
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
762
# will generate a verbatim copy of the header file for each class for
763
# which an include is specified. Set to NO to disable this.
767
#---------------------------------------------------------------------------
768
# configuration options related to the alphabetical class index
769
#---------------------------------------------------------------------------
771
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
772
# of all compounds will be generated. Enable this if the project
773
# contains a lot of classes, structs, unions or interfaces.
775
ALPHABETICAL_INDEX = YES
777
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
778
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
779
# in which this list will be split (can be a number in the range [1..20])
781
COLS_IN_ALPHA_INDEX = 5
783
# In case all classes in a project start with a common prefix, all
784
# classes will be put under the same header in the alphabetical index.
785
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
786
# should be ignored while generating the index headers.
790
#---------------------------------------------------------------------------
791
# configuration options related to the HTML output
792
#---------------------------------------------------------------------------
794
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
795
# generate HTML output.
799
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
800
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
801
# put in front of it. If left blank `html' will be used as the default path.
805
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
806
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
807
# doxygen will generate files with .html extension.
809
HTML_FILE_EXTENSION = .html
811
# The HTML_HEADER tag can be used to specify a personal HTML header for
812
# each generated HTML page. If it is left blank doxygen will generate a
817
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
818
# each generated HTML page. If it is left blank doxygen will generate a
823
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
824
# style sheet that is used by each HTML page. It can be used to
825
# fine-tune the look of the HTML output. If the tag is left blank doxygen
826
# will generate a default style sheet. Note that doxygen will try to copy
827
# the style sheet file to the HTML output directory, so don't put your own
828
# stylesheet in the HTML output directory as well, or it will be erased!
832
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
833
# Doxygen will adjust the colors in the stylesheet and background images
834
# according to this color. Hue is specified as an angle on a colorwheel,
835
# see http://en.wikipedia.org/wiki/Hue for more information.
836
# For instance the value 0 represents red, 60 is yellow, 120 is green,
837
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
838
# The allowed range is 0 to 359.
840
HTML_COLORSTYLE_HUE = 220
842
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
843
# the colors in the HTML output. For a value of 0 the output will use
844
# grayscales only. A value of 255 will produce the most vivid colors.
846
HTML_COLORSTYLE_SAT = 100
848
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
849
# the luminance component of the colors in the HTML output. Values below
850
# 100 gradually make the output lighter, whereas values above 100 make
851
# the output darker. The value divided by 100 is the actual gamma applied,
852
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
853
# and 100 does not change the gamma.
855
HTML_COLORSTYLE_GAMMA = 80
857
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
858
# page will contain the date and time when the page was generated. Setting
859
# this to NO can help when comparing the output of multiple runs.
863
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
864
# files or namespaces will be aligned in HTML using tables. If set to
865
# NO a bullet list will be used.
867
# HTML_ALIGN_MEMBERS = YES
869
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
870
# documentation will contain sections that can be hidden and shown after the
871
# page has loaded. For this to work a browser that supports
872
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
873
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
875
HTML_DYNAMIC_SECTIONS = NO
877
# If the GENERATE_DOCSET tag is set to YES, additional index files
878
# will be generated that can be used as input for Apple's Xcode 3
879
# integrated development environment, introduced with OSX 10.5 (Leopard).
880
# To create a documentation set, doxygen will generate a Makefile in the
881
# HTML output directory. Running make will produce the docset in that
882
# directory and running "make install" will install the docset in
883
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
885
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
886
# for more information.
890
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
891
# feed. A documentation feed provides an umbrella under which multiple
892
# documentation sets from a single provider (such as a company or product suite)
895
DOCSET_FEEDNAME = "Doxygen generated docs"
897
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
898
# should uniquely identify the documentation set bundle. This should be a
899
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
900
# will append .docset to the name.
902
DOCSET_BUNDLE_ID = org.doxygen.Project
904
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
905
# the documentation publisher. This should be a reverse domain-name style
906
# string, e.g. com.mycompany.MyDocSet.documentation.
908
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
910
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
912
DOCSET_PUBLISHER_NAME = Publisher
914
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
915
# will be generated that can be used as input for tools like the
916
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
917
# of the generated HTML documentation.
919
GENERATE_HTMLHELP = NO
921
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
922
# be used to specify the file name of the resulting .chm file. You
923
# can add a path in front of the file if the result should not be
924
# written to the html output directory.
928
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
929
# be used to specify the location (absolute path including file name) of
930
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
931
# the HTML help compiler on the generated index.hhp.
935
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
936
# controls if a separate .chi index file is generated (YES) or that
937
# it should be included in the master .chm file (NO).
941
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
942
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
947
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
948
# controls whether a binary table of contents is generated (YES) or a
949
# normal table of contents (NO) in the .chm file.
956
# The TOC_EXPAND flag can be set to YES to add extra items for group members
957
# to the contents of the HTML help documentation and to the tree view.
961
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
962
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
963
# that can be used as input for Qt's qhelpgenerator to generate a
964
# Qt Compressed Help (.qch) of the generated HTML documentation.
968
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
969
# be used to specify the file name of the resulting .qch file.
970
# The path specified is relative to the HTML output folder.
972
QCH_FILE = FreeCADSourceDocu
974
# The QHP_NAMESPACE tag specifies the namespace to use when generating
975
# Qt Help Project output. For more information please see
976
# http://doc.trolltech.com/qthelpproject.html#namespace
978
QHP_NAMESPACE = "FreeCADSourceDocu"
980
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
981
# Qt Help Project output. For more information please see
982
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
984
QHP_VIRTUAL_FOLDER = doc
986
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
987
# add. For more information please see
988
# http://doc.trolltech.com/qthelpproject.html#custom-filters
990
QHP_CUST_FILTER_NAME =
992
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
993
# custom filter to add. For more information please see
994
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
995
# Qt Help Project / Custom Filters</a>.
997
QHP_CUST_FILTER_ATTRS =
999
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1001
# filter section matches.
1002
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1003
# Qt Help Project / Filter Attributes</a>.
1005
QHP_SECT_FILTER_ATTRS =
1007
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1008
# be used to specify the location of Qt's qhelpgenerator.
1009
# If non-empty doxygen will try to run qhelpgenerator on the generated
1014
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1015
# will be generated, which together with the HTML files, form an Eclipse help
1016
# plugin. To install this plugin and make it available under the help contents
1017
# menu in Eclipse, the contents of the directory containing the HTML and XML
1018
# files needs to be copied into the plugins directory of eclipse. The name of
1019
# the directory within the plugins directory should be the same as
1020
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1023
GENERATE_ECLIPSEHELP = NO
1025
# A unique identifier for the eclipse help plugin. When installing the plugin
1026
# the directory name containing the HTML and XML files should also have
1029
ECLIPSE_DOC_ID = org.doxygen.Project
1031
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1032
# top of each HTML page. The value NO (the default) enables the index and
1033
# the value YES disables it.
1037
# This tag can be used to set the number of enum values (range [1..20])
1038
# that doxygen will group on one line in the generated HTML documentation.
1040
ENUM_VALUES_PER_LINE = 4
1042
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1043
# structure should be generated to display hierarchical information.
1044
# If the tag value is set to YES, a side panel will be generated
1045
# containing a tree-like index structure (just like the one that
1046
# is generated for HTML Help). For this to work a browser that supports
1047
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1048
# Windows users are probably better off using the HTML help feature.
1050
GENERATE_TREEVIEW = NO
1052
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1053
# and Class Hierarchy pages using a tree view instead of an ordered list.
1055
# USE_INLINE_TREES = NO
1057
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1058
# used to set the initial width (in pixels) of the frame in which the tree
1063
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1064
# links to external symbols imported via tag files in a separate window.
1066
EXT_LINKS_IN_WINDOW = NO
1068
# Use this tag to change the font size of Latex formulas included
1069
# as images in the HTML documentation. The default is 10. Note that
1070
# when you change the font size after a successful doxygen run you need
1071
# to manually remove any form_*.png images from the HTML output directory
1072
# to force them to be regenerated.
1074
FORMULA_FONTSIZE = 10
1076
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1077
# generated for formulas are transparent PNGs. Transparent PNGs are
1078
# not supported properly for IE 6.0, but are supported on all modern browsers.
1079
# Note that when changing this option you need to delete any form_*.png files
1080
# in the HTML output before the changes have effect.
1082
FORMULA_TRANSPARENT = YES
1084
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1085
# for the HTML output. The underlying search engine uses javascript
1086
# and DHTML and should work on any modern browser. Note that when using
1087
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1088
# (GENERATE_DOCSET) there is already a search function so this one should
1089
# typically be disabled. For large projects the javascript based search engine
1090
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1094
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1095
# implemented using a PHP enabled web server instead of at the web client
1096
# using Javascript. Doxygen will generate the search PHP script and index
1097
# file to put on the web server. The advantage of the server
1098
# based approach is that it scales better to large projects and allows
1099
# full text search. The disadvances is that it is more difficult to setup
1100
# and does not have live searching capabilities.
1102
SERVER_BASED_SEARCH = NO
1104
#---------------------------------------------------------------------------
1105
# configuration options related to the LaTeX output
1106
#---------------------------------------------------------------------------
1108
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1109
# generate Latex output.
1113
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1114
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1115
# put in front of it. If left blank `latex' will be used as the default path.
1119
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1120
# invoked. If left blank `latex' will be used as the default command name.
1121
# Note that when enabling USE_PDFLATEX this option is only used for
1122
# generating bitmaps for formulas in the HTML output, but not in the
1123
# Makefile that is written to the output directory.
1125
LATEX_CMD_NAME = latex
1127
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1128
# generate index for LaTeX. If left blank `makeindex' will be used as the
1129
# default command name.
1131
MAKEINDEX_CMD_NAME = makeindex
1133
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1134
# LaTeX documents. This may be useful for small projects and may help to
1135
# save some trees in general.
1139
# The PAPER_TYPE tag can be used to set the paper type that is used
1140
# by the printer. Possible values are: a4, a4wide, letter, legal and
1141
# executive. If left blank a4wide will be used.
1145
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1146
# packages that should be included in the LaTeX output.
1148
EXTRA_PACKAGES = amsmath
1150
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1151
# the generated latex document. The header should contain everything until
1152
# the first chapter. If it is left blank doxygen will generate a
1154
# standard header. Notice: only use this tag if you know what you are doing!
1158
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1159
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1160
# contain links (just like the HTML output) instead of page references
1161
# This makes the output suitable for online browsing using a pdf viewer.
1165
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1166
# plain latex in the generated Makefile. Set this option to YES to get a
1167
# higher quality PDF documentation.
1171
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1172
# command to the generated LaTeX files. This will instruct LaTeX to keep
1173
# running if errors occur, instead of asking the user for help.
1174
# This option is also used when generating formulas in HTML.
1178
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1179
# include the index chapters (such as File Index, Compound Index, etc.)
1182
LATEX_HIDE_INDICES = NO
1184
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1185
# source code with syntax highlighting in the LaTeX output.
1186
# Note that which sources are shown also depends on other settings
1187
# such as SOURCE_BROWSER.
1189
LATEX_SOURCE_CODE = NO
1191
#---------------------------------------------------------------------------
1192
# configuration options related to the RTF output
1193
#---------------------------------------------------------------------------
1195
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1196
# The RTF output is optimized for Word 97 and may not look very pretty with
1197
# other RTF readers or editors.
1201
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1202
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1203
# put in front of it. If left blank `rtf' will be used as the default path.
1207
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1208
# RTF documents. This may be useful for small projects and may help to
1209
# save some trees in general.
1213
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1214
# will contain hyperlink fields. The RTF file will
1215
# contain links (just like the HTML output) instead of page references.
1216
# This makes the output suitable for online browsing using WORD or other
1217
# programs which support those fields.
1218
# Note: wordpad (write) and others do not support links.
1222
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1223
# config file, i.e. a series of assignments. You only have to provide
1224
# replacements, missing definitions are set to their default value.
1226
RTF_STYLESHEET_FILE =
1228
# Set optional variables used in the generation of an rtf document.
1229
# Syntax is similar to doxygen's config file.
1231
RTF_EXTENSIONS_FILE =
1233
#---------------------------------------------------------------------------
1234
# configuration options related to the man page output
1235
#---------------------------------------------------------------------------
1237
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1242
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1243
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1244
# put in front of it. If left blank `man' will be used as the default path.
1248
# The MAN_EXTENSION tag determines the extension that is added to
1249
# the generated man pages (default is the subroutine's section .3)
1253
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1254
# then it will generate one additional man file for each entity
1255
# documented in the real man page(s). These additional files
1256
# only source the real man page, but without them the man command
1257
# would be unable to find the correct page. The default is NO.
1261
#---------------------------------------------------------------------------
1262
# configuration options related to the XML output
1263
#---------------------------------------------------------------------------
1265
# If the GENERATE_XML tag is set to YES Doxygen will
1266
# generate an XML file that captures the structure of
1267
# the code including all documentation.
1271
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1272
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1273
# put in front of it. If left blank `xml' will be used as the default path.
1277
# The XML_SCHEMA tag can be used to specify an XML schema,
1278
# which can be used by a validating XML parser to check the
1279
# syntax of the XML files.
1283
# The XML_DTD tag can be used to specify an XML DTD,
1284
# which can be used by a validating XML parser to check the
1285
# syntax of the XML files.
1289
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1290
# dump the program listings (including syntax highlighting
1291
# and cross-referencing information) to the XML output. Note that
1292
# enabling this will significantly increase the size of the XML output.
1294
XML_PROGRAMLISTING = YES
1296
#---------------------------------------------------------------------------
1297
# configuration options for the AutoGen Definitions output
1298
#---------------------------------------------------------------------------
1300
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1301
# generate an AutoGen Definitions (see autogen.sf.net) file
1302
# that captures the structure of the code including all
1303
# documentation. Note that this feature is still experimental
1304
# and incomplete at the moment.
1306
GENERATE_AUTOGEN_DEF = NO
1308
#---------------------------------------------------------------------------
1309
# configuration options related to the Perl module output
1310
#---------------------------------------------------------------------------
1312
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1313
# generate a Perl module file that captures the structure of
1314
# the code including all documentation. Note that this
1315
# feature is still experimental and incomplete at the
1318
GENERATE_PERLMOD = NO
1320
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1321
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1322
# to generate PDF and DVI output from the Perl module output.
1326
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1327
# nicely formatted so it can be parsed by a human reader.
1329
# if you want to understand what is going on.
1330
# On the other hand, if this
1331
# tag is set to NO the size of the Perl module output will be much smaller
1332
# and Perl will parse it just the same.
1336
# The names of the make variables in the generated doxyrules.make file
1337
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1338
# This is useful so different doxyrules.make files included by the same
1339
# Makefile don't overwrite each other's variables.
1341
PERLMOD_MAKEVAR_PREFIX =
1343
#---------------------------------------------------------------------------
1344
# Configuration options related to the preprocessor
1345
#---------------------------------------------------------------------------
1347
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1348
# evaluate all C-preprocessor directives found in the sources and include
1351
ENABLE_PREPROCESSING = YES
1353
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1354
# names in the source code. If set to NO (the default) only conditional
1355
# compilation will be performed. Macro expansion can be done in a controlled
1356
# way by setting EXPAND_ONLY_PREDEF to YES.
1358
MACRO_EXPANSION = YES
1360
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1361
# then the macro expansion is limited to the macros specified with the
1362
# PREDEFINED and EXPAND_AS_DEFINED tags.
1364
EXPAND_ONLY_PREDEF = YES
1366
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1367
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1369
SEARCH_INCLUDES = YES
1371
# The INCLUDE_PATH tag can be used to specify one or more directories that
1372
# contain include files that are not input files but should be processed by
1375
INCLUDE_PATH = @DOXYGEN_INCLUDE_PATH@
1377
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1378
# patterns (like *.h and *.hpp) to filter out the header-files in the
1379
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1382
INCLUDE_FILE_PATTERNS = *.h
1384
# The PREDEFINED tag can be used to specify one or more macro names that
1385
# are defined before the preprocessor is started (similar to the -D option of
1386
# gcc). The argument of the tag is a list of macros of the form: name
1387
# or name=definition (no spaces). If the definition and the = are
1388
# omitted =1 is assumed. To prevent a macro definition from being
1389
# undefined via #undef or recursively expanded use the := operator
1390
# instead of the = operator.
1392
PREDEFINED = HAVE_SWIG \
1393
AppAssemblyExport= \
1396
AppCompleteExport= \
1400
AppJtReaderExport= \
1401
AppMeshPartExport= \
1402
AppPartDesignExport= \
1406
AppSketcherExport= \
1409
AssemblyGuiExport= \
1411
CompleteGuiExport= \
1420
MeshPartGuiExport= \
1422
PartDesignGuiExport= \
1432
SketcherGuiExport= \
1435
WM4_MEMORY_MANAGER \
1436
WM4_FOUNDATION_ITEM= \
1443
DOXYGEN_SHOULD_SKIP_THIS
1446
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1447
# this tag can be used to specify a list of macro names that should be expanded.
1448
# The macro definition that is found in the sources will be used.
1449
# Use the PREDEFINED tag if you want to use a different macro definition.
1451
EXPAND_AS_DEFINED = Py_Header \
1458
TYPESYSTEM_SOURCE_P \
1459
TYPESYSTEM_SOURCE_ABSTRACT_P \
1461
TYPESYSTEM_SOURCE_ABSTRACT \
1472
PROPERTY_SOURCE_ABSTRACT \
1473
TYPESYSTEM_SOURCE_TEMPLATE \
1474
PROPERTY_SOURCE_TEMPLATE \
1476
SO_SFIELD_CONSTRUCTOR_SOURCE \
1477
SO_SFIELD_VALUE_SOURCE \
1478
SO_SFIELD_REQUIRED_SOURCE \
1480
SO_SFIELD_CONSTRUCTOR_HEADER \
1481
SO_SFIELD_REQUIRED_HEADER \
1482
SO_SFIELD_VALUE_HEADER \
1483
PRIVATE_SFIELD_IO_HEADER \
1484
PRIVATE_TYPEID_SOURCE \
1485
PRIVATE_EQUALITY_SOURCE \
1486
USING_PART_OF_NAMESPACE_EIGEN
1488
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1489
# doxygen's preprocessor will remove all function-like macros that are alone
1490
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1491
# function macros are typically used for boiler-plate code, and will confuse
1492
# the parser if not removed.
1494
SKIP_FUNCTION_MACROS = YES
1496
#---------------------------------------------------------------------------
1497
# Configuration::additions related to external references
1498
#---------------------------------------------------------------------------
1500
# The TAGFILES option can be used to specify one or more tagfiles.
1501
# Optionally an initial location of the external documentation
1502
# can be added for each tagfile. The format of a tag file without
1503
# this location is as follows:
1505
# TAGFILES = file1 file2 ...
1506
# Adding location for the tag files is done as follows:
1508
# TAGFILES = file1=loc1 "file2 = loc2" ...
1509
# where "loc1" and "loc2" can be relative or absolute paths or
1510
# URLs. If a location is present for each tag, the installdox tool
1511
# does not have to be run to correct the links.
1512
# Note that each tag file must have a unique name
1513
# (where the name does NOT include the path)
1514
# If a tag file is not located in the directory in which doxygen
1515
# is run, you must also specify the path to the tagfile here.
1517
TAGFILES = @DOXYGEN_TAGFILES@
1519
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1520
# a tag file that is based on the input files it reads.
1524
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1525
# in the class index. If set to NO only the inherited external classes
1530
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1531
# in the modules index. If set to NO, only the current project's groups will
1534
EXTERNAL_GROUPS = YES
1536
# The PERL_PATH should be the absolute path and name of the perl script
1537
# interpreter (i.e. the result of `which perl').
1539
PERL_PATH = /usr/bin/perl
1541
#---------------------------------------------------------------------------
1542
# Configuration options related to the dot tool
1543
#---------------------------------------------------------------------------
1545
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1546
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1547
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1548
# this option is superseded by the HAVE_DOT option below. This is only a
1549
# fallback. It is recommended to install and use dot, since it yields more
1554
# You can define message sequence charts within doxygen comments using the \msc
1555
# command. Doxygen will then run the mscgen tool (see
1556
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1557
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1558
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1559
# default search path.
1563
# If set to YES, the inheritance and collaboration graphs will hide
1564
# inheritance and usage relations if the target is undocumented
1567
HIDE_UNDOC_RELATIONS = NO
1569
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1570
# available from the path. This tool is part of Graphviz, a graph visualization
1571
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1572
# have no effect if this option is set to NO (the default)
1574
HAVE_DOT = @HAVE_DOT@
1576
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1577
# allowed to run in parallel. When set to 0 (the default) doxygen will
1578
# base this on the number of processors available in the system. You can set it
1579
# explicitly to a value larger than 0 to get control over the balance
1580
# between CPU load and processing speed.
1584
# By default doxygen will write a font called FreeSans.ttf to the output
1585
# directory and reference it in all dot files that doxygen generates. This
1586
# font does not include all possible unicode characters however, so when you need
1587
# these (or just want a differently looking font) you can specify the font name
1588
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1589
# which can be done by putting it in a standard location or by setting the
1590
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1591
# containing the font.
1595
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1596
# The default size is 10pt.
1600
# By default doxygen will tell dot to use the output directory to look for the
1601
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1602
# different font using DOT_FONTNAME you can set the path where dot
1603
# can find it using this tag.
1607
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1608
# will generate a graph for each documented class showing the direct and
1609
# indirect inheritance relations. Setting this tag to YES will force the
1610
# the CLASS_DIAGRAMS tag to NO.
1614
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1615
# will generate a graph for each documented class showing the direct and
1616
# indirect implementation dependencies (inheritance, containment, and
1617
# class references variables) of the class with other documented classes.
1619
COLLABORATION_GRAPH = YES
1621
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1622
# will generate a graph for groups, showing the direct groups dependencies
1626
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1627
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1632
# If set to YES, the inheritance and collaboration graphs will show the
1633
# relations between templates and their instances.
1635
TEMPLATE_RELATIONS = YES
1637
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1638
# tags are set to YES then doxygen will generate a graph for each documented
1639
# file showing the direct and indirect include dependencies of the file with
1640
# other documented files.
1644
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1645
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1646
# documented header file showing the documented files that directly or
1647
# indirectly include this file.
1649
INCLUDED_BY_GRAPH = YES
1651
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1652
# doxygen will generate a call dependency graph for every global function
1653
# or class method. Note that enabling this option will significantly increase
1654
# the time of a run. So in most cases it will be better to enable call graphs
1655
# for selected functions only using the \callgraph command.
1659
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1660
# doxygen will generate a caller dependency graph for every global function
1661
# or class method. Note that enabling this option will significantly increase
1662
# the time of a run. So in most cases it will be better to enable caller
1663
# graphs for selected functions only using the \callergraph command.
1667
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1668
# will graphical hierarchy of all classes instead of a textual one.
1670
GRAPHICAL_HIERARCHY = YES
1672
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1673
# then doxygen will show the dependencies a directory has on other directories
1674
# in a graphical way. The dependency relations are determined by the #include
1675
# relations between the files in the directories.
1677
DIRECTORY_GRAPH = YES
1679
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1680
# generated by dot. Possible values are png, jpg, or gif
1681
# If left blank png will be used.
1683
DOT_IMAGE_FORMAT = png
1685
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1686
# found. If left blank, it is assumed the dot tool can be found in the path.
1688
DOT_PATH = @DOT_PATH@
1690
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1691
# contain dot files that are included in the documentation (see the
1696
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1697
# nodes that will be shown in the graph. If the number of nodes in a graph
1698
# becomes larger than this value, doxygen will truncate the graph, which is
1699
# visualized by representing a node as a red box. Note that doxygen if the
1700
# number of direct children of the root node in a graph is already larger than
1701
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1702
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1704
DOT_GRAPH_MAX_NODES = 130
1706
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1707
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1708
# from the root by following a path via at most 3 edges will be shown. Nodes
1709
# that lay further from the root node will be omitted. Note that setting this
1710
# option to 1 or 2 may greatly reduce the computation time needed for large
1711
# code bases. Also note that the size of a graph can be further restricted by
1712
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1714
MAX_DOT_GRAPH_DEPTH = 0
1716
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1717
# background. This is disabled by default, because dot on Windows does not
1718
# seem to support this out of the box. Warning: Depending on the platform used,
1719
# enabling this option may lead to badly anti-aliased labels on the edges of
1720
# a graph (i.e. they become hard to read).
1724
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1725
# files in one run (i.e. multiple -o and -T options on the command line). This
1726
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1728
# support this, this feature is disabled by default.
1730
DOT_MULTI_TARGETS = YES
1732
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1733
# generate a legend page explaining the meaning of the various boxes and
1734
# arrows in the dot generated graphs.
1736
GENERATE_LEGEND = YES
1738
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1739
# remove the intermediate dot files that are used to generate
1740
# the various graphs.