|
@@ -1,4 +1,4 @@
|
1
|
|
-# Doxyfile 1.4.4
|
|
1
|
+# Doxyfile 1.5.7.1
|
2
|
2
|
|
3
|
3
|
# This file describes the settings to be used by the documentation system
|
4
|
4
|
# doxygen (www.doxygen.org) for a project
|
|
@@ -14,6 +14,14 @@
|
14
|
14
|
# Project related configuration options
|
15
|
15
|
#---------------------------------------------------------------------------
|
16
|
16
|
|
|
17
|
+# This tag specifies the encoding used for all characters in the config file
|
|
18
|
+# that follow. The default is UTF-8 which is also the encoding used for all
|
|
19
|
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
|
|
20
|
+# iconv built into libc) for the transcoding. See
|
|
21
|
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
|
|
22
|
+
|
|
23
|
+DOXYFILE_ENCODING = UTF-8
|
|
24
|
+
|
17
|
25
|
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
|
18
|
26
|
# by quotes) that should identify the project.
|
19
|
27
|
|
|
@@ -45,24 +53,15 @@ CREATE_SUBDIRS = NO
|
45
|
53
|
# documentation generated by doxygen is written. Doxygen will use this
|
46
|
54
|
# information to generate all constant output in the proper language.
|
47
|
55
|
# The default language is English, other supported languages are:
|
48
|
|
-# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
|
49
|
|
-# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
|
50
|
|
-# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
|
51
|
|
-# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
|
52
|
|
-# Swedish, and Ukrainian.
|
|
56
|
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
|
|
57
|
+# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
|
|
58
|
+# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
|
|
59
|
+# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
|
|
60
|
+# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
|
|
61
|
+# Spanish, Swedish, and Ukrainian.
|
53
|
62
|
|
54
|
63
|
OUTPUT_LANGUAGE = English
|
55
|
64
|
|
56
|
|
-# This tag can be used to specify the encoding used in the generated output.
|
57
|
|
-# The encoding is not always determined by the language that is chosen,
|
58
|
|
-# but also whether or not the output is meant for Windows or non-Windows users.
|
59
|
|
-# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
|
60
|
|
-# forces the Windows encoding (this is the default for the Windows binary),
|
61
|
|
-# whereas setting the tag to NO uses a Unix-style encoding (the default for
|
62
|
|
-# all platforms other than Windows).
|
63
|
|
-
|
64
|
|
-USE_WINDOWS_ENCODING = NO
|
65
|
|
-
|
66
|
65
|
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
|
67
|
66
|
# include brief member descriptions after the members that are listed in
|
68
|
67
|
# the file and class documentation (similar to JavaDoc).
|
|
@@ -135,11 +134,19 @@ SHORT_NAMES = NO
|
135
|
134
|
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
|
136
|
135
|
# will interpret the first line (until the first dot) of a JavaDoc-style
|
137
|
136
|
# comment as the brief description. If set to NO, the JavaDoc
|
138
|
|
-# comments will behave just like the Qt-style comments (thus requiring an
|
139
|
|
-# explicit @brief command for a brief description.
|
|
137
|
+# comments will behave just like regular Qt-style comments
|
|
138
|
+# (thus requiring an explicit @brief command for a brief description.)
|
140
|
139
|
|
141
|
140
|
JAVADOC_AUTOBRIEF = YES
|
142
|
141
|
|
|
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.)
|
|
147
|
+
|
|
148
|
+QT_AUTOBRIEF = NO
|
|
149
|
+
|
143
|
150
|
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
|
144
|
151
|
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
|
145
|
152
|
# comments) as a brief description. This used to be the default behaviour.
|
|
@@ -148,26 +155,12 @@ JAVADOC_AUTOBRIEF = YES
|
148
|
155
|
|
149
|
156
|
MULTILINE_CPP_IS_BRIEF = NO
|
150
|
157
|
|
151
|
|
-# If the DETAILS_AT_TOP tag is set to YES then Doxygen
|
152
|
|
-# will output the detailed description near the top, like JavaDoc.
|
153
|
|
-# If set to NO, the detailed description appears after the member
|
154
|
|
-# documentation.
|
155
|
|
-
|
156
|
|
-DETAILS_AT_TOP = YES
|
157
|
|
-
|
158
|
158
|
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
|
159
|
159
|
# member inherits the documentation from any documented member that it
|
160
|
160
|
# re-implements.
|
161
|
161
|
|
162
|
162
|
INHERIT_DOCS = YES
|
163
|
163
|
|
164
|
|
-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
165
|
|
-# tag is set to YES, then doxygen will reuse the documentation of the first
|
166
|
|
-# member in the group (if any) for the other members of the group. By default
|
167
|
|
-# all members of a group must be documented explicitly.
|
168
|
|
-
|
169
|
|
-DISTRIBUTE_GROUP_DOC = NO
|
170
|
|
-
|
171
|
164
|
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
|
172
|
165
|
# a new page for each member. If set to NO, the documentation of a member will
|
173
|
166
|
# be part of the file/class/namespace that contains it.
|
|
@@ -197,13 +190,61 @@ ALIASES = v=@param \
|
197
|
190
|
|
198
|
191
|
OPTIMIZE_OUTPUT_FOR_C = YES
|
199
|
192
|
|
200
|
|
-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
|
201
|
|
-# only. Doxygen will then generate output that is more tailored for Java.
|
202
|
|
-# For instance, namespaces will be presented as packages, qualified scopes
|
203
|
|
-# will look different, etc.
|
|
193
|
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
|
|
194
|
+# sources only. Doxygen will then generate output that is more tailored for
|
|
195
|
+# Java. For instance, namespaces will be presented as packages, qualified
|
|
196
|
+# scopes will look different, etc.
|
204
|
197
|
|
205
|
198
|
OPTIMIZE_OUTPUT_JAVA = NO
|
206
|
199
|
|
|
200
|
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
|
|
201
|
+# sources only. Doxygen will then generate output that is more tailored for
|
|
202
|
+# Fortran.
|
|
203
|
+
|
|
204
|
+OPTIMIZE_FOR_FORTRAN = NO
|
|
205
|
+
|
|
206
|
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
|
|
207
|
+# sources. Doxygen will then generate output that is tailored for
|
|
208
|
+# VHDL.
|
|
209
|
+
|
|
210
|
+OPTIMIZE_OUTPUT_VHDL = NO
|
|
211
|
+
|
|
212
|
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
|
|
213
|
+# to include (a tag file for) the STL sources as input, then you should
|
|
214
|
+# set this tag to YES in order to let doxygen match functions declarations and
|
|
215
|
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
|
|
216
|
+# func(std::string) {}). This also make the inheritance and collaboration
|
|
217
|
+# diagrams that involve STL classes more complete and accurate.
|
|
218
|
+
|
|
219
|
+BUILTIN_STL_SUPPORT = NO
|
|
220
|
+
|
|
221
|
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
|
|
222
|
+# enable parsing support.
|
|
223
|
+
|
|
224
|
+CPP_CLI_SUPPORT = NO
|
|
225
|
+
|
|
226
|
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
|
|
227
|
+# Doxygen will parse them like normal C++ but will assume all classes use public
|
|
228
|
+# instead of private inheritance when no explicit protection keyword is present.
|
|
229
|
+
|
|
230
|
+SIP_SUPPORT = NO
|
|
231
|
+
|
|
232
|
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
|
|
233
|
+# and setter methods for a property. Setting this option to YES (the default)
|
|
234
|
+# will make doxygen to replace the get and set methods by a property in the
|
|
235
|
+# documentation. This will only work if the methods are indeed getting or
|
|
236
|
+# setting a simple type. If this is not the case, or you want to show the
|
|
237
|
+# methods anyway, you should set this option to NO.
|
|
238
|
+
|
|
239
|
+IDL_PROPERTY_SUPPORT = YES
|
|
240
|
+
|
|
241
|
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
|
242
|
+# tag is set to YES, then doxygen will reuse the documentation of the first
|
|
243
|
+# member in the group (if any) for the other members of the group. By default
|
|
244
|
+# all members of a group must be documented explicitly.
|
|
245
|
+
|
|
246
|
+DISTRIBUTE_GROUP_DOC = NO
|
|
247
|
+
|
207
|
248
|
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
|
208
|
249
|
# the same type (for instance a group of public functions) to be put as a
|
209
|
250
|
# subgroup of that type (e.g. under the Public Functions section). Set it to
|
|
@@ -212,6 +253,32 @@ OPTIMIZE_OUTPUT_JAVA = NO
|
212
|
253
|
|
213
|
254
|
SUBGROUPING = YES
|
214
|
255
|
|
|
256
|
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
|
|
257
|
+# is documented as struct, union, or enum with the name of the typedef. So
|
|
258
|
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
|
|
259
|
+# with name TypeT. When disabled the typedef will appear as a member of a file,
|
|
260
|
+# namespace, or class. And the struct will be named TypeS. This can typically
|
|
261
|
+# be useful for C code in case the coding convention dictates that all compound
|
|
262
|
+# types are typedef'ed and only the typedef is referenced, never the tag name.
|
|
263
|
+
|
|
264
|
+TYPEDEF_HIDES_STRUCT = NO
|
|
265
|
+
|
|
266
|
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
|
|
267
|
+# determine which symbols to keep in memory and which to flush to disk.
|
|
268
|
+# When the cache is full, less often used symbols will be written to disk.
|
|
269
|
+# For small to medium size projects (<1000 input files) the default value is
|
|
270
|
+# probably good enough. For larger projects a too small cache size can cause
|
|
271
|
+# doxygen to be busy swapping symbols to and from disk most of the time
|
|
272
|
+# causing a significant performance penality.
|
|
273
|
+# If the system has enough physical memory increasing the cache will improve the
|
|
274
|
+# performance by keeping more symbols in memory. Note that the value works on
|
|
275
|
+# a logarithmic scale so increasing the size by one will rougly double the
|
|
276
|
+# memory usage. The cache size is given by this formula:
|
|
277
|
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
|
|
278
|
+# corresponding to a cache size of 2^16 = 65536 symbols
|
|
279
|
+
|
|
280
|
+SYMBOL_CACHE_SIZE = 0
|
|
281
|
+
|
215
|
282
|
#---------------------------------------------------------------------------
|
216
|
283
|
# Build related configuration options
|
217
|
284
|
#---------------------------------------------------------------------------
|
|
@@ -246,6 +313,14 @@ EXTRACT_LOCAL_CLASSES = YES
|
246
|
313
|
|
247
|
314
|
EXTRACT_LOCAL_METHODS = NO
|
248
|
315
|
|
|
316
|
+# If this flag is set to YES, the members of anonymous namespaces will be
|
|
317
|
+# extracted and appear in the documentation as a namespace called
|
|
318
|
+# 'anonymous_namespace{file}', where file will be replaced with the base
|
|
319
|
+# name of the file that contains the anonymous namespace. By default
|
|
320
|
+# anonymous namespace are hidden.
|
|
321
|
+
|
|
322
|
+EXTRACT_ANON_NSPACES = NO
|
|
323
|
+
|
249
|
324
|
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
|
250
|
325
|
# undocumented members of documented classes, files or namespaces.
|
251
|
326
|
# If set to NO (the default) these members will be included in the
|
|
@@ -321,6 +396,12 @@ SORT_MEMBER_DOCS = NO
|
321
|
396
|
|
322
|
397
|
SORT_BRIEF_DOCS = NO
|
323
|
398
|
|
|
399
|
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
|
|
400
|
+# hierarchy of group names into alphabetical order. If set to NO (the default)
|
|
401
|
+# the group names will appear in their defined order.
|
|
402
|
+
|
|
403
|
+SORT_GROUP_NAMES = NO
|
|
404
|
+
|
324
|
405
|
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
|
325
|
406
|
# sorted by fully-qualified names, including namespaces. If set to
|
326
|
407
|
# NO (the default), the class list will be sorted only by class name,
|
|
@@ -378,20 +459,41 @@ SHOW_USED_FILES = YES
|
378
|
459
|
|
379
|
460
|
# If the sources in your project are distributed over multiple directories
|
380
|
461
|
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
|
381
|
|
-# in the documentation. The default is YES.
|
|
462
|
+# in the documentation. The default is NO.
|
382
|
463
|
|
383
|
464
|
SHOW_DIRECTORIES = YES
|
384
|
465
|
|
|
466
|
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
|
|
467
|
+# This will remove the Files entry from the Quick Index and from the
|
|
468
|
+# Folder Tree View (if specified). The default is YES.
|
|
469
|
+
|
|
470
|
+SHOW_FILES = YES
|
|
471
|
+
|
|
472
|
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
|
|
473
|
+# Namespaces page. This will remove the Namespaces entry from the Quick Index
|
|
474
|
+# and from the Folder Tree View (if specified). The default is YES.
|
|
475
|
+
|
|
476
|
+SHOW_NAMESPACES = YES
|
|
477
|
+
|
385
|
478
|
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
|
386
|
|
-# doxygen should invoke to get the current version for each file (typically from the
|
387
|
|
-# version control system). Doxygen will invoke the program by executing (via
|
|
479
|
+# doxygen should invoke to get the current version for each file (typically from
|
|
480
|
+# the version control system). Doxygen will invoke the program by executing (via
|
388
|
481
|
# popen()) the command <command> <input-file>, where <command> is the value of
|
389
|
482
|
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
|
390
|
|
-# provided by doxygen. Whatever the progam writes to standard output
|
|
483
|
+# provided by doxygen. Whatever the program writes to standard output
|
391
|
484
|
# is used as the file version. See the manual for examples.
|
392
|
485
|
|
393
|
486
|
FILE_VERSION_FILTER =
|
394
|
487
|
|
|
488
|
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
|
|
489
|
+# doxygen. The layout file controls the global structure of the generated output files
|
|
490
|
+# in an output format independent way. The create the layout file that represents
|
|
491
|
+# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
|
|
492
|
+# file name after the option, if omitted DoxygenLayout.xml will be used as the name
|
|
493
|
+# of the layout file.
|
|
494
|
+
|
|
495
|
+LAYOUT_FILE =
|
|
496
|
+
|
395
|
497
|
#---------------------------------------------------------------------------
|
396
|
498
|
# configuration options related to warning and progress messages
|
397
|
499
|
#---------------------------------------------------------------------------
|
|
@@ -458,12 +560,20 @@ INPUT = @SRCDIRS@ \
|
458
|
560
|
arch/@ARCH@/include \
|
459
|
561
|
doc
|
460
|
562
|
|
|
563
|
+# This tag can be used to specify the character encoding of the source files
|
|
564
|
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
|
|
565
|
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
|
|
566
|
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
|
|
567
|
+# the list of possible encodings.
|
|
568
|
+
|
|
569
|
+INPUT_ENCODING = UTF-8
|
|
570
|
+
|
461
|
571
|
# If the value of the INPUT tag contains directories, you can use the
|
462
|
572
|
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
463
|
573
|
# and *.h) to filter out the source-files in the directories. If left
|
464
|
574
|
# blank the following patterns are tested:
|
465
|
575
|
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
|
466
|
|
-# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
|
|
576
|
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
|
467
|
577
|
|
468
|
578
|
FILE_PATTERNS = *.c \
|
469
|
579
|
*.h \
|
|
@@ -496,6 +606,14 @@ EXCLUDE_SYMLINKS = NO
|
496
|
606
|
|
497
|
607
|
EXCLUDE_PATTERNS =
|
498
|
608
|
|
|
609
|
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
|
|
610
|
+# (namespaces, classes, functions, etc.) that should be excluded from the
|
|
611
|
+# output. The symbol name can be a fully qualified name, a word, or if the
|
|
612
|
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
|
|
613
|
+# AClass::ANamespace, ANamespace::*Test
|
|
614
|
+
|
|
615
|
+EXCLUDE_SYMBOLS =
|
|
616
|
+
|
499
|
617
|
# The EXAMPLE_PATH tag can be used to specify one or more files or
|
500
|
618
|
# directories that contain example code fragments that are included (see
|
501
|
619
|
# the \include command).
|
|
@@ -569,18 +687,25 @@ INLINE_SOURCES = NO
|
569
|
687
|
|
570
|
688
|
STRIP_CODE_COMMENTS = NO
|
571
|
689
|
|
572
|
|
-# If the REFERENCED_BY_RELATION tag is set to YES (the default)
|
|
690
|
+# If the REFERENCED_BY_RELATION tag is set to YES
|
573
|
691
|
# then for each documented function all documented
|
574
|
692
|
# functions referencing it will be listed.
|
575
|
693
|
|
576
|
694
|
REFERENCED_BY_RELATION = YES
|
577
|
695
|
|
578
|
|
-# If the REFERENCES_RELATION tag is set to YES (the default)
|
|
696
|
+# If the REFERENCES_RELATION tag is set to YES
|
579
|
697
|
# then for each documented function all documented entities
|
580
|
698
|
# called/used by that function will be listed.
|
581
|
699
|
|
582
|
700
|
REFERENCES_RELATION = NO
|
583
|
701
|
|
|
702
|
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
|
|
703
|
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
|
|
704
|
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
|
|
705
|
+# link to the source code. Otherwise they will link to the documentstion.
|
|
706
|
+
|
|
707
|
+REFERENCES_LINK_SOURCE = YES
|
|
708
|
+
|
584
|
709
|
# If the USE_HTAGS tag is set to YES then the references to source code
|
585
|
710
|
# will point to the HTML generated by the htags(1) tool instead of doxygen
|
586
|
711
|
# built-in source browser. The htags tool is part of GNU's global source
|
|
@@ -666,9 +791,43 @@ HTML_STYLESHEET =
|
666
|
791
|
|
667
|
792
|
HTML_ALIGN_MEMBERS = YES
|
668
|
793
|
|
|
794
|
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
|
|
795
|
+# documentation will contain sections that can be hidden and shown after the
|
|
796
|
+# page has loaded. For this to work a browser that supports
|
|
797
|
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
|
|
798
|
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
|
|
799
|
+
|
|
800
|
+HTML_DYNAMIC_SECTIONS = NO
|
|
801
|
+
|
|
802
|
+# If the GENERATE_DOCSET tag is set to YES, additional index files
|
|
803
|
+# will be generated that can be used as input for Apple's Xcode 3
|
|
804
|
+# integrated development environment, introduced with OSX 10.5 (Leopard).
|
|
805
|
+# To create a documentation set, doxygen will generate a Makefile in the
|
|
806
|
+# HTML output directory. Running make will produce the docset in that
|
|
807
|
+# directory and running "make install" will install the docset in
|
|
808
|
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
|
|
809
|
+# it at startup.
|
|
810
|
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
|
|
811
|
+
|
|
812
|
+GENERATE_DOCSET = NO
|
|
813
|
+
|
|
814
|
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
|
|
815
|
+# feed. A documentation feed provides an umbrella under which multiple
|
|
816
|
+# documentation sets from a single provider (such as a company or product suite)
|
|
817
|
+# can be grouped.
|
|
818
|
+
|
|
819
|
+DOCSET_FEEDNAME = "Doxygen generated docs"
|
|
820
|
+
|
|
821
|
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
|
|
822
|
+# should uniquely identify the documentation set bundle. This should be a
|
|
823
|
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
|
|
824
|
+# will append .docset to the name.
|
|
825
|
+
|
|
826
|
+DOCSET_BUNDLE_ID = org.doxygen.Project
|
|
827
|
+
|
669
|
828
|
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
|
670
|
829
|
# will be generated that can be used as input for tools like the
|
671
|
|
-# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
|
|
830
|
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
|
672
|
831
|
# of the generated HTML documentation.
|
673
|
832
|
|
674
|
833
|
GENERATE_HTMLHELP = NO
|
|
@@ -693,6 +852,12 @@ HHC_LOCATION =
|
693
|
852
|
|
694
|
853
|
GENERATE_CHI = NO
|
695
|
854
|
|
|
855
|
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
|
|
856
|
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
|
|
857
|
+# content.
|
|
858
|
+
|
|
859
|
+CHM_INDEX_ENCODING =
|
|
860
|
+
|
696
|
861
|
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
|
697
|
862
|
# controls whether a binary table of contents is generated (YES) or a
|
698
|
863
|
# normal table of contents (NO) in the .chm file.
|
|
@@ -704,6 +869,38 @@ BINARY_TOC = NO
|
704
|
869
|
|
705
|
870
|
TOC_EXPAND = NO
|
706
|
871
|
|
|
872
|
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
|
|
873
|
+# are set, an additional index file will be generated that can be used as input for
|
|
874
|
+# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
|
|
875
|
+# HTML documentation.
|
|
876
|
+
|
|
877
|
+GENERATE_QHP = NO
|
|
878
|
+
|
|
879
|
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
|
|
880
|
+# be used to specify the file name of the resulting .qch file.
|
|
881
|
+# The path specified is relative to the HTML output folder.
|
|
882
|
+
|
|
883
|
+QCH_FILE =
|
|
884
|
+
|
|
885
|
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
|
|
886
|
+# Qt Help Project output. For more information please see
|
|
887
|
+# <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
|
|
888
|
+
|
|
889
|
+QHP_NAMESPACE = org.doxygen.Project
|
|
890
|
+
|
|
891
|
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
|
|
892
|
+# Qt Help Project output. For more information please see
|
|
893
|
+# <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
|
|
894
|
+
|
|
895
|
+QHP_VIRTUAL_FOLDER = doc
|
|
896
|
+
|
|
897
|
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
|
|
898
|
+# be used to specify the location of Qt's qhelpgenerator.
|
|
899
|
+# If non-empty doxygen will try to run qhelpgenerator on the generated
|
|
900
|
+# .qhp file .
|
|
901
|
+
|
|
902
|
+QHG_LOCATION =
|
|
903
|
+
|
707
|
904
|
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
|
708
|
905
|
# top of each HTML page. The value NO (the default) enables the index and
|
709
|
906
|
# the value YES disables it.
|
|
@@ -715,12 +912,20 @@ DISABLE_INDEX = NO
|
715
|
912
|
|
716
|
913
|
ENUM_VALUES_PER_LINE = 4
|
717
|
914
|
|
718
|
|
-# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
|
719
|
|
-# generated containing a tree-like index structure (just like the one that
|
|
915
|
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
|
|
916
|
+# structure should be generated to display hierarchical information.
|
|
917
|
+# If the tag value is set to FRAME, a side panel will be generated
|
|
918
|
+# containing a tree-like index structure (just like the one that
|
720
|
919
|
# is generated for HTML Help). For this to work a browser that supports
|
721
|
920
|
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
|
722
|
921
|
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
|
723
|
|
-# probably better off using the HTML help feature.
|
|
922
|
+# probably better off using the HTML help feature. Other possible values
|
|
923
|
+# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
|
|
924
|
+# and Class Hierarchy pages using a tree view instead of an ordered list;
|
|
925
|
+# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
|
|
926
|
+# disables this behavior completely. For backwards compatibility with previous
|
|
927
|
+# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
|
|
928
|
+# respectively.
|
724
|
929
|
|
725
|
930
|
GENERATE_TREEVIEW = NO
|
726
|
931
|
|
|
@@ -730,6 +935,14 @@ GENERATE_TREEVIEW = NO
|
730
|
935
|
|
731
|
936
|
TREEVIEW_WIDTH = 250
|
732
|
937
|
|
|
938
|
+# Use this tag to change the font size of Latex formulas included
|
|
939
|
+# as images in the HTML documentation. The default is 10. Note that
|
|
940
|
+# when you change the font size after a successful doxygen run you need
|
|
941
|
+# to manually remove any form_*.png images from the HTML output directory
|
|
942
|
+# to force them to be regenerated.
|
|
943
|
+
|
|
944
|
+FORMULA_FONTSIZE = 10
|
|
945
|
+
|
733
|
946
|
#---------------------------------------------------------------------------
|
734
|
947
|
# configuration options related to the LaTeX output
|
735
|
948
|
#---------------------------------------------------------------------------
|
|
@@ -975,7 +1188,7 @@ MACRO_EXPANSION = YES
|
975
|
1188
|
|
976
|
1189
|
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
|
977
|
1190
|
# then the macro expansion is limited to the macros specified with the
|
978
|
|
-# PREDEFINED and EXPAND_AS_PREDEFINED tags.
|
|
1191
|
+# PREDEFINED and EXPAND_AS_DEFINED tags.
|
979
|
1192
|
|
980
|
1193
|
EXPAND_ONLY_PREDEF = YES
|
981
|
1194
|
|
|
@@ -1086,6 +1299,15 @@ PERL_PATH =
|
1086
|
1299
|
|
1087
|
1300
|
CLASS_DIAGRAMS = YES
|
1088
|
1301
|
|
|
1302
|
+# You can define message sequence charts within doxygen comments using the \msc
|
|
1303
|
+# command. Doxygen will then run the mscgen tool (see
|
|
1304
|
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
|
|
1305
|
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
|
|
1306
|
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
|
|
1307
|
+# default search path.
|
|
1308
|
+
|
|
1309
|
+MSCGEN_PATH =
|
|
1310
|
+
|
1089
|
1311
|
# If set to YES, the inheritance and collaboration graphs will hide
|
1090
|
1312
|
# inheritance and usage relations if the target is undocumented
|
1091
|
1313
|
# or is not a class.
|
|
@@ -1099,6 +1321,29 @@ HIDE_UNDOC_RELATIONS = YES
|
1099
|
1321
|
|
1100
|
1322
|
HAVE_DOT = NO
|
1101
|
1323
|
|
|
1324
|
+# By default doxygen will write a font called FreeSans.ttf to the output
|
|
1325
|
+# directory and reference it in all dot files that doxygen generates. This
|
|
1326
|
+# font does not include all possible unicode characters however, so when you need
|
|
1327
|
+# these (or just want a differently looking font) you can specify the font name
|
|
1328
|
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
|
|
1329
|
+# which can be done by putting it in a standard location or by setting the
|
|
1330
|
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
|
|
1331
|
+# containing the font.
|
|
1332
|
+
|
|
1333
|
+DOT_FONTNAME = FreeSans
|
|
1334
|
+
|
|
1335
|
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
|
|
1336
|
+# The default size is 10pt.
|
|
1337
|
+
|
|
1338
|
+DOT_FONTSIZE = 10
|
|
1339
|
+
|
|
1340
|
+# By default doxygen will tell dot to use the output directory to look for the
|
|
1341
|
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a
|
|
1342
|
+# different font using DOT_FONTNAME you can set the path where dot
|
|
1343
|
+# can find it using this tag.
|
|
1344
|
+
|
|
1345
|
+DOT_FONTPATH =
|
|
1346
|
+
|
1102
|
1347
|
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
1103
|
1348
|
# will generate a graph for each documented class showing the direct and
|
1104
|
1349
|
# indirect inheritance relations. Setting this tag to YES will force the
|
|
@@ -1143,14 +1388,22 @@ INCLUDE_GRAPH = YES
|
1143
|
1388
|
|
1144
|
1389
|
INCLUDED_BY_GRAPH = YES
|
1145
|
1390
|
|
1146
|
|
-# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
|
1147
|
|
-# generate a call dependency graph for every global function or class method.
|
1148
|
|
-# Note that enabling this option will significantly increase the time of a run.
|
1149
|
|
-# So in most cases it will be better to enable call graphs for selected
|
1150
|
|
-# functions only using the \callgraph command.
|
|
1391
|
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
|
|
1392
|
+# doxygen will generate a call dependency graph for every global function
|
|
1393
|
+# or class method. Note that enabling this option will significantly increase
|
|
1394
|
+# the time of a run. So in most cases it will be better to enable call graphs
|
|
1395
|
+# for selected functions only using the \callgraph command.
|
1151
|
1396
|
|
1152
|
1397
|
CALL_GRAPH = NO
|
1153
|
1398
|
|
|
1399
|
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
|
|
1400
|
+# doxygen will generate a caller dependency graph for every global function
|
|
1401
|
+# or class method. Note that enabling this option will significantly increase
|
|
1402
|
+# the time of a run. So in most cases it will be better to enable caller
|
|
1403
|
+# graphs for selected functions only using the \callergraph command.
|
|
1404
|
+
|
|
1405
|
+CALLER_GRAPH = NO
|
|
1406
|
+
|
1154
|
1407
|
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
1155
|
1408
|
# will graphical hierarchy of all classes instead of a textual one.
|
1156
|
1409
|
|
|
@@ -1180,39 +1433,31 @@ DOT_PATH =
|
1180
|
1433
|
|
1181
|
1434
|
DOTFILE_DIRS =
|
1182
|
1435
|
|
1183
|
|
-# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
|
1184
|
|
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than
|
1185
|
|
-# this value, doxygen will try to truncate the graph, so that it fits within
|
1186
|
|
-# the specified constraint. Beware that most browsers cannot cope with very
|
1187
|
|
-# large images.
|
1188
|
|
-
|
1189
|
|
-MAX_DOT_GRAPH_WIDTH = 1024
|
1190
|
|
-
|
1191
|
|
-# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
|
1192
|
|
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than
|
1193
|
|
-# this value, doxygen will try to truncate the graph, so that it fits within
|
1194
|
|
-# the specified constraint. Beware that most browsers cannot cope with very
|
1195
|
|
-# large images.
|
|
1436
|
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
|
|
1437
|
+# nodes that will be shown in the graph. If the number of nodes in a graph
|
|
1438
|
+# becomes larger than this value, doxygen will truncate the graph, which is
|
|
1439
|
+# visualized by representing a node as a red box. Note that doxygen if the
|
|
1440
|
+# number of direct children of the root node in a graph is already larger than
|
|
1441
|
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
|
|
1442
|
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
|
1196
|
1443
|
|
1197
|
|
-MAX_DOT_GRAPH_HEIGHT = 1024
|
|
1444
|
+DOT_GRAPH_MAX_NODES = 50
|
1198
|
1445
|
|
1199
|
1446
|
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
|
1200
|
1447
|
# graphs generated by dot. A depth value of 3 means that only nodes reachable
|
1201
|
1448
|
# from the root by following a path via at most 3 edges will be shown. Nodes
|
1202
|
1449
|
# that lay further from the root node will be omitted. Note that setting this
|
1203
|
1450
|
# option to 1 or 2 may greatly reduce the computation time needed for large
|
1204
|
|
-# code bases. Also note that a graph may be further truncated if the graph's
|
1205
|
|
-# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
|
1206
|
|
-# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
|
1207
|
|
-# the graph is not depth-constrained.
|
|
1451
|
+# code bases. Also note that the size of a graph can be further restricted by
|
|
1452
|
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
|
1208
|
1453
|
|
1209
|
1454
|
MAX_DOT_GRAPH_DEPTH = 0
|
1210
|
1455
|
|
1211
|
1456
|
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
|
1212
|
|
-# background. This is disabled by default, which results in a white background.
|
1213
|
|
-# Warning: Depending on the platform used, enabling this option may lead to
|
1214
|
|
-# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
|
1215
|
|
-# read).
|
|
1457
|
+# background. This is disabled by default, because dot on Windows does not
|
|
1458
|
+# seem to support this out of the box. Warning: Depending on the platform used,
|
|
1459
|
+# enabling this option may lead to badly anti-aliased labels on the edges of
|
|
1460
|
+# a graph (i.e. they become hard to read).
|
1216
|
1461
|
|
1217
|
1462
|
DOT_TRANSPARENT = NO
|
1218
|
1463
|
|