• R/O
  • SSH

YSLib: Commit

The YSLib project - main repository


Commit MetaInfo

Revisione5f859ac3f2c2889b400a3396fcbf3f19d44d783 (tree)
Time2014-05-30 01:38:19
AuthorFrankHB <frankhb1989@gmai...>
CommiterFrankHB

Log Message

更新主分支版本: build 500 rev 25 。

Change Summary

Incremental Difference

diff -r ecd9d86036cc -r e5f859ac3f2c Doxyfile
--- a/Doxyfile Tue May 27 19:56:38 2014 +0800
+++ b/Doxyfile Fri May 30 00:38:19 2014 +0800
@@ -1,104 +1,122 @@
1-# Doxyfile 1.8.2
1+# Doxyfile 1.8.7
22
33 # This file describes the settings to be used by the documentation system
4-# doxygen (www.doxygen.org) for a project
4+# doxygen (www.doxygen.org) for a project.
55 #
6-# All text after a hash (#) is considered a comment and will be ignored
6+# All text after a double hash (##) is considered a comment and is placed in
7+# front of the TAG it is preceding.
8+#
9+# All text after a single hash (#) is considered a comment and will be ignored.
710 # The format is:
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 (" ")
11+# TAG = value [value, ...]
12+# For lists, items can also be appended using:
13+# TAG += value [value, ...]
14+# Values that contain spaces should be placed between quotes (\" \").
1215
1316 #---------------------------------------------------------------------------
1417 # Project related configuration options
1518 #---------------------------------------------------------------------------
1619
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.
20+# This tag specifies the encoding used for all characters in the config file
21+# that follow. The default is UTF-8 which is also the encoding used for all text
22+# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23+# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24+# for the list of possible encodings.
25+# The default value is: UTF-8.
2226
2327 DOXYFILE_ENCODING = UTF-8
2428
25-# The PROJECT_NAME tag is a single word (or sequence of words) that should
26-# identify the project. Note that if you do not use Doxywizard you need
27-# to put quotes around the project name if it contains spaces.
29+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30+# double-quotes, unless you are using Doxywizard) that should identify the
31+# project for which the documentation is generated. This name is used in the
32+# title of most generated pages and in a few other places.
33+# The default value is: My Project.
2834
2935 PROJECT_NAME = YSTest
3036
31-# The PROJECT_NUMBER tag can be used to enter a project or revision number.
32-# This could be handy for archiving the generated documentation or
33-# if some version control system is used.
34-
35-PROJECT_NUMBER = PreAlpha_b400_20130424
36-
37-# Using the PROJECT_BRIEF tag one can provide an optional one line description
38-# for a project that appears at the top of each page and should give viewer
39-# a quick idea about the purpose of the project. Keep the description short.
37+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38+# could be handy for archiving the generated documentation or if some version
39+# control system is used.
40+
41+PROJECT_NUMBER = PreAlpha_b500_20140530
42+
43+# Using the PROJECT_BRIEF tag one can provide an optional one line description
44+# for a project that appears at the top of each page and should give viewer a
45+# quick idea about the purpose of the project. Keep the description short.
4046
4147 PROJECT_BRIEF = "The YSLib Test Project"
4248
43-# With the PROJECT_LOGO tag one can specify an logo or icon that is
44-# included in the documentation. The maximum height of the logo should not
45-# exceed 55 pixels and the maximum width should not exceed 200 pixels.
46-# Doxygen will copy the logo to the output directory.
49+# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50+# the documentation. The maximum height of the logo should not exceed 55 pixels
51+# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52+# to the output directory.
4753
4854 PROJECT_LOGO =
4955
50-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51-# base path where the generated documentation will be put.
52-# If a relative path is entered, it will be relative to the location
53-# where doxygen was started. If left blank the current directory will be used.
56+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57+# into which the generated documentation will be written. If a relative path is
58+# entered, it will be relative to the location where doxygen was started. If
59+# left blank the current directory will be used.
5460
5561 OUTPUT_DIRECTORY = ./doc
5662
57-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58-# 4096 sub-directories (in 2 levels) under the output directory of each output
59-# format and will distribute the generated files over these directories.
60-# Enabling this option can be useful when feeding doxygen a huge amount of
61-# source files, where putting all generated files in the same directory would
62-# otherwise cause performance problems for the file system.
63+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
64+# directories (in 2 levels) under the output directory of each output format and
65+# will distribute the generated files over these directories. Enabling this
66+# option can be useful when feeding doxygen a huge amount of source files, where
67+# putting all generated files in the same directory would otherwise causes
68+# performance problems for the file system.
69+# The default value is: NO.
6370
6471 CREATE_SUBDIRS = YES
6572
66-# The OUTPUT_LANGUAGE tag is used to specify the language in which all
67-# documentation generated by doxygen is written. Doxygen will use this
68-# information to generate all constant output in the proper language.
69-# The default language is English, other supported languages are:
70-# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71-# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72-# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73-# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74-# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75-# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
73+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74+# characters to appear in the names of generated files. If set to NO, non-ASCII
75+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76+# U+3044.
77+# The default value is: NO.
78+
79+ALLOW_UNICODE_NAMES = NO
80+
81+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
82+# documentation generated by doxygen is written. Doxygen will use this
83+# information to generate all constant output in the proper language.
84+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91+# Ukrainian and Vietnamese.
92+# The default value is: English.
7693
7794 OUTPUT_LANGUAGE = Chinese
7895
79-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80-# include brief member descriptions after the members that are listed in
81-# the file and class documentation (similar to JavaDoc).
82-# Set to NO to disable this.
96+# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
97+# descriptions after the members that are listed in the file and class
98+# documentation (similar to Javadoc). Set to NO to disable this.
99+# The default value is: YES.
83100
84101 BRIEF_MEMBER_DESC = YES
85102
86-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87-# the brief description of a member or function before the detailed description.
88-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
103+# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
104+# description of a member or function before the detailed description
105+#
106+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
89107 # brief descriptions will be completely suppressed.
108+# The default value is: YES.
90109
91110 REPEAT_BRIEF = YES
92111
93-# This tag implements a quasi-intelligent brief description abbreviator
94-# that is used to form the text in various listings. Each string
95-# in this list, if found as the leading text of the brief description, will be
96-# stripped from the text and the result after processing the whole list, is
97-# used as the annotated text. Otherwise, the brief description is used as-is.
98-# If left blank, the following values are used ("$name" is automatically
99-# replaced with the name of the entity): "The $name class" "The $name widget"
100-# "The $name file" "is" "provides" "specifies" "contains"
101-# "represents" "a" "an" "the"
112+# This tag implements a quasi-intelligent brief description abbreviator that is
113+# used to form the text in various listings. Each string in this list, if found
114+# as the leading text of the brief description, will be stripped from the text
115+# and the result, after processing the whole list, is used as the annotated
116+# text. Otherwise, the brief description is used as-is. If left blank, the
117+# following values are used ($name is automatically replaced with the name of
118+# the entity):The $name class, The $name widget, The $name file, is, provides,
119+# specifies, contains, represents, a, an and the.
102120
103121 ABBREVIATE_BRIEF = "The $name class" \
104122 "The $name widget" \
@@ -112,257 +130,280 @@
112130 an \
113131 the
114132
115-# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
116-# Doxygen will generate a detailed section even if there is only a brief
133+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
134+# doxygen will generate a detailed section even if there is only a brief
117135 # description.
136+# The default value is: NO.
118137
119138 ALWAYS_DETAILED_SEC = NO
120139
121-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
122-# inherited members of a class in the documentation of that class as if those
123-# members were ordinary class members. Constructors, destructors and assignment
140+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
141+# inherited members of a class in the documentation of that class as if those
142+# members were ordinary class members. Constructors, destructors and assignment
124143 # operators of the base classes will not be shown.
144+# The default value is: NO.
125145
126146 INLINE_INHERITED_MEMB = NO
127147
128-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
129-# path before files name in the file list and in the header files. If set
130-# to NO the shortest path that makes the file name unique will be used.
148+# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
149+# before files name in the file list and in the header files. If set to NO the
150+# shortest path that makes the file name unique will be used
151+# The default value is: YES.
131152
132153 FULL_PATH_NAMES = NO
133154
134-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
135-# can be used to strip a user-defined part of the path. Stripping is
136-# only done if one of the specified strings matches the left-hand part of
137-# the path. The tag can be used to show relative paths in the file list.
138-# If left blank the directory from which doxygen is run is used as the
139-# path to strip. Note that you specify absolute paths here, but also
140-# relative paths, which will be relative from the directory where doxygen is
141-# started.
155+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
156+# Stripping is only done if one of the specified strings matches the left-hand
157+# part of the path. The tag can be used to show relative paths in the file list.
158+# If left blank the directory from which doxygen is run is used as the path to
159+# strip.
160+#
161+# Note that you can specify absolute paths here, but also relative paths, which
162+# will be relative from the directory where doxygen is started.
163+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
142164
143165 STRIP_FROM_PATH =
144166
145-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
146-# the path mentioned in the documentation of a class, which tells
147-# the reader which header file to include in order to use a class.
148-# If left blank only the name of the header file containing the class
149-# definition is used. Otherwise one should specify the include paths that
150-# are normally passed to the compiler using the -I flag.
167+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
168+# path mentioned in the documentation of a class, which tells the reader which
169+# header file to include in order to use a class. If left blank only the name of
170+# the header file containing the class definition is used. Otherwise one should
171+# specify the list of include paths that are normally passed to the compiler
172+# using the -I flag.
151173
152174 STRIP_FROM_INC_PATH =
153175
154-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
155-# (but less readable) file names. This can be useful if your file system
156-# doesn't support long names like on DOS, Mac, or CD-ROM.
157-
158-SHORT_NAMES = NO
159-
160-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
161-# will interpret the first line (until the first dot) of a JavaDoc-style
162-# comment as the brief description. If set to NO, the JavaDoc
163-# comments will behave just like regular Qt-style comments
164-# (thus requiring an explicit @brief command for a brief description.)
176+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
177+# less readable) file names. This can be useful is your file systems doesn't
178+# support long names like on DOS, Mac, or CD-ROM.
179+# The default value is: NO.
180+
181+SHORT_NAMES = YES
182+
183+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
184+# first line (until the first dot) of a Javadoc-style comment as the brief
185+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
186+# style comments (thus requiring an explicit @brief command for a brief
187+# description.)
188+# The default value is: NO.
165189
166190 JAVADOC_AUTOBRIEF = NO
167191
168-# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
169-# interpret the first line (until the first dot) of a Qt-style
170-# comment as the brief description. If set to NO, the comments
171-# will behave just like regular Qt-style comments (thus requiring
172-# an explicit \brief command for a brief description.)
192+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
193+# line (until the first dot) of a Qt-style comment as the brief description. If
194+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
195+# requiring an explicit \brief command for a brief description.)
196+# The default value is: NO.
173197
174198 QT_AUTOBRIEF = NO
175199
176-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
177-# treat a multi-line C++ special comment block (i.e. a block of //! or ///
178-# comments) as a brief description. This used to be the default behaviour.
179-# The new default is to treat a multi-line C++ comment block as a detailed
180-# description. Set this tag to YES if you prefer the old behaviour instead.
200+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
201+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
202+# a brief description. This used to be the default behavior. The new default is
203+# to treat a multi-line C++ comment block as a detailed description. Set this
204+# tag to YES if you prefer the old behavior instead.
205+#
206+# Note that setting this tag to YES also means that rational rose comments are
207+# not recognized any more.
208+# The default value is: NO.
181209
182210 MULTILINE_CPP_IS_BRIEF = NO
183211
184-# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
185-# member inherits the documentation from any documented member that it
186-# re-implements.
212+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
213+# documentation from any documented member that it re-implements.
214+# The default value is: YES.
187215
188216 INHERIT_DOCS = YES
189217
190-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
191-# a new page for each member. If set to NO, the documentation of a member will
192-# be part of the file/class/namespace that contains it.
218+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
219+# new page for each member. If set to NO, the documentation of a member will be
220+# part of the file/class/namespace that contains it.
221+# The default value is: NO.
193222
194223 SEPARATE_MEMBER_PAGES = NO
195224
196-# The TAB_SIZE tag can be used to set the number of spaces in a tab.
197-# Doxygen uses this value to replace tabs by spaces in code fragments.
225+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
226+# uses this value to replace tabs by spaces in code fragments.
227+# Minimum value: 1, maximum value: 16, default value: 4.
198228
199229 TAB_SIZE = 4
200230
201-# This tag can be used to specify a number of aliases that acts
202-# as commands in the documentation. An alias has the form "name=value".
203-# For example adding "sideeffect=\par Side Effects:\n" will allow you to
204-# put the command \sideeffect (or @sideeffect) in the documentation, which
205-# will result in a user-defined paragraph with heading "Side Effects:".
206-# You can put \n's in the value part of an alias to insert newlines.
231+# This tag can be used to specify a number of aliases that act as commands in
232+# the documentation. An alias has the form:
233+# name=value
234+# For example adding
235+# "sideeffect=@par Side Effects:\n"
236+# will allow you to put the command \sideeffect (or @sideeffect) in the
237+# documentation, which will result in a user-defined paragraph with heading
238+# "Side Effects:". You can put \n's in the value part of an alias to insert
239+# newlines.
207240
208241 ALIASES =
209242
210-# This tag can be used to specify a number of word-keyword mappings (TCL only).
211-# A mapping has the form "name=value". For example adding
212-# "class=itcl::class" will allow you to use the command class in the
213-# itcl::class meaning.
243+# This tag can be used to specify a number of word-keyword mappings (TCL only).
244+# A mapping has the form "name=value". For example adding "class=itcl::class"
245+# will allow you to use the command class in the itcl::class meaning.
214246
215247 TCL_SUBST =
216248
217-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
218-# sources only. Doxygen will then generate output that is more tailored for C.
219-# For instance, some of the names that are used will be different. The list
220-# of all members will be omitted, etc.
249+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
250+# only. Doxygen will then generate output that is more tailored for C. For
251+# instance, some of the names that are used will be different. The list of all
252+# members will be omitted, etc.
253+# The default value is: NO.
221254
222255 OPTIMIZE_OUTPUT_FOR_C = NO
223256
224-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
225-# sources only. Doxygen will then generate output that is more tailored for
226-# Java. For instance, namespaces will be presented as packages, qualified
227-# scopes will look different, etc.
257+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
258+# Python sources only. Doxygen will then generate output that is more tailored
259+# for that language. For instance, namespaces will be presented as packages,
260+# qualified scopes will look different, etc.
261+# The default value is: NO.
228262
229263 OPTIMIZE_OUTPUT_JAVA = NO
230264
231-# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
232-# sources only. Doxygen will then generate output that is more tailored for
233-# Fortran.
265+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
266+# sources. Doxygen will then generate output that is tailored for Fortran.
267+# The default value is: NO.
234268
235269 OPTIMIZE_FOR_FORTRAN = NO
236270
237-# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
238-# sources. Doxygen will then generate output that is tailored for
239-# VHDL.
271+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
272+# sources. Doxygen will then generate output that is tailored for VHDL.
273+# The default value is: NO.
240274
241275 OPTIMIZE_OUTPUT_VHDL = NO
242276
243-# Doxygen selects the parser to use depending on the extension of the files it
244-# parses. With this tag you can assign which parser to use for a given
245-# extension. Doxygen has a built-in mapping, but you can override or extend it
246-# using this tag. The format is ext=language, where ext is a file extension,
247-# and language is one of the parsers supported by doxygen: IDL, Java,
248-# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
249-# C++. For instance to make doxygen treat .inc files as Fortran files (default
250-# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
251-# that for custom extensions you also need to set FILE_PATTERNS otherwise the
252-# files are not read by doxygen.
277+# Doxygen selects the parser to use depending on the extension of the files it
278+# parses. With this tag you can assign which parser to use for a given
279+# extension. Doxygen has a built-in mapping, but you can override or extend it
280+# using this tag. The format is ext=language, where ext is a file extension, and
281+# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
282+# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
283+# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
284+# Fortran. In the later case the parser tries to guess whether the code is fixed
285+# or free formatted code, this is the default for Fortran type files), VHDL. For
286+# instance to make doxygen treat .inc files as Fortran files (default is PHP),
287+# and .f files as C (default is Fortran), use: inc=Fortran f=C.
288+#
289+# Note For files without extension you can use no_extension as a placeholder.
290+#
291+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
292+# the files are not read by doxygen.
253293
254294 EXTENSION_MAPPING =
255295
256-# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
257-# comments according to the Markdown format, which allows for more readable
258-# documentation. See http://daringfireball.net/projects/markdown/ for details.
259-# The output of markdown processing is further processed by doxygen, so you
260-# can mix doxygen, HTML, and XML commands with Markdown formatting.
261-# Disable only in case of backward compatibilities issues.
296+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
297+# according to the Markdown format, which allows for more readable
298+# documentation. See http://daringfireball.net/projects/markdown/ for details.
299+# The output of markdown processing is further processed by doxygen, so you can
300+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
301+# case of backward compatibilities issues.
302+# The default value is: YES.
262303
263304 MARKDOWN_SUPPORT = YES
264305
265-# When enabled doxygen tries to link words that correspond to documented classes,
266-# or namespaces to their corresponding documentation. Such a link can be
267-# prevented in individual cases by by putting a % sign in front of the word or
268-# globally by setting AUTOLINK_SUPPORT to NO.
306+# When enabled doxygen tries to link words that correspond to documented
307+# classes, or namespaces to their corresponding documentation. Such a link can
308+# be prevented in individual cases by by putting a % sign in front of the word
309+# or globally by setting AUTOLINK_SUPPORT to NO.
310+# The default value is: YES.
269311
270312 AUTOLINK_SUPPORT = YES
271313
272-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
273-# to include (a tag file for) the STL sources as input, then you should
274-# set this tag to YES in order to let doxygen match functions declarations and
275-# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
276-# func(std::string) {}). This also makes the inheritance and collaboration
314+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
315+# to include (a tag file for) the STL sources as input, then you should set this
316+# tag to YES in order to let doxygen match functions declarations and
317+# definitions whose arguments contain STL classes (e.g. func(std::string);
318+# versus func(std::string) {}). This also make the inheritance and collaboration
277319 # diagrams that involve STL classes more complete and accurate.
320+# The default value is: NO.
278321
279322 BUILTIN_STL_SUPPORT = NO
280323
281-# If you use Microsoft's C++/CLI language, you should set this option to YES to
324+# If you use Microsoft's C++/CLI language, you should set this option to YES to
282325 # enable parsing support.
326+# The default value is: NO.
283327
284328 CPP_CLI_SUPPORT = NO
285329
286-# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
287-# Doxygen will parse them like normal C++ but will assume all classes use public
288-# instead of private inheritance when no explicit protection keyword is present.
330+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
331+# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
332+# will parse them like normal C++ but will assume all classes use public instead
333+# of private inheritance when no explicit protection keyword is present.
334+# The default value is: NO.
289335
290336 SIP_SUPPORT = NO
291337
292338 # For Microsoft's IDL there are propget and propput attributes to indicate
293-# getter and setter methods for a property. Setting this option to YES (the
294-# default) will make doxygen replace the get and set methods by a property in
295-# the documentation. This will only work if the methods are indeed getting or
296-# setting a simple type. If this is not the case, or you want to show the
297-# methods anyway, you should set this option to NO.
339+# getter and setter methods for a property. Setting this option to YES will make
340+# doxygen to replace the get and set methods by a property in the documentation.
341+# This will only work if the methods are indeed getting or setting a simple
342+# type. If this is not the case, or you want to show the methods anyway, you
343+# should set this option to NO.
344+# The default value is: YES.
298345
299346 IDL_PROPERTY_SUPPORT = YES
300347
301-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
302-# tag is set to YES, then doxygen will reuse the documentation of the first
303-# member in the group (if any) for the other members of the group. By default
348+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
349+# tag is set to YES, then doxygen will reuse the documentation of the first
350+# member in the group (if any) for the other members of the group. By default
304351 # all members of a group must be documented explicitly.
352+# The default value is: NO.
305353
306354 DISTRIBUTE_GROUP_DOC = NO
307355
308-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
309-# the same type (for instance a group of public functions) to be put as a
310-# subgroup of that type (e.g. under the Public Functions section). Set it to
311-# NO to prevent subgrouping. Alternatively, this can be done per class using
312-# the \nosubgrouping command.
356+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
357+# (for instance a group of public functions) to be put as a subgroup of that
358+# type (e.g. under the Public Functions section). Set it to NO to prevent
359+# subgrouping. Alternatively, this can be done per class using the
360+# \nosubgrouping command.
361+# The default value is: YES.
313362
314363 SUBGROUPING = YES
315364
316-# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
317-# unions are shown inside the group in which they are included (e.g. using
318-# @ingroup) instead of on a separate page (for HTML and Man pages) or
319-# section (for LaTeX and RTF).
365+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
366+# are shown inside the group in which they are included (e.g. using \ingroup)
367+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
368+# and RTF).
369+#
370+# Note that this feature does not work in combination with
371+# SEPARATE_MEMBER_PAGES.
372+# The default value is: NO.
320373
321374 INLINE_GROUPED_CLASSES = NO
322375
323-# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
324-# unions with only public data fields will be shown inline in the documentation
325-# of the scope in which they are defined (i.e. file, namespace, or group
326-# documentation), provided this scope is documented. If set to NO (the default),
327-# structs, classes, and unions are shown on a separate page (for HTML and Man
328-# pages) or section (for LaTeX and RTF).
376+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
377+# with only public data fields or simple typedef fields will be shown inline in
378+# the documentation of the scope in which they are defined (i.e. file,
379+# namespace, or group documentation), provided this scope is documented. If set
380+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
381+# Man pages) or section (for LaTeX and RTF).
382+# The default value is: NO.
329383
330384 INLINE_SIMPLE_STRUCTS = NO
331385
332-# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
333-# is documented as struct, union, or enum with the name of the typedef. So
334-# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
335-# with name TypeT. When disabled the typedef will appear as a member of a file,
336-# namespace, or class. And the struct will be named TypeS. This can typically
337-# be useful for C code in case the coding convention dictates that all compound
386+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
387+# enum is documented as struct, union, or enum with the name of the typedef. So
388+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
389+# with name TypeT. When disabled the typedef will appear as a member of a file,
390+# namespace, or class. And the struct will be named TypeS. This can typically be
391+# useful for C code in case the coding convention dictates that all compound
338392 # types are typedef'ed and only the typedef is referenced, never the tag name.
393+# The default value is: NO.
339394
340395 TYPEDEF_HIDES_STRUCT = NO
341396
342-# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
343-# determine which symbols to keep in memory and which to flush to disk.
344-# When the cache is full, less often used symbols will be written to disk.
345-# For small to medium size projects (<1000 input files) the default value is
346-# probably good enough. For larger projects a too small cache size can cause
347-# doxygen to be busy swapping symbols to and from disk most of the time
348-# causing a significant performance penalty.
349-# If the system has enough physical memory increasing the cache will improve the
350-# performance by keeping more symbols in memory. Note that the value works on
351-# a logarithmic scale so increasing the size by one will roughly double the
352-# memory usage. The cache size is given by this formula:
353-# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
354-# corresponding to a cache size of 2^16 = 65536 symbols.
355-
356-SYMBOL_CACHE_SIZE = 0
357-
358-# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
359-# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
360-# their name and scope. Since this can be an expensive process and often the
361-# same symbol appear multiple times in the code, doxygen keeps a cache of
362-# pre-resolved symbols. If the cache is too small doxygen will become slower.
363-# If the cache is too large, memory is wasted. The cache size is given by this
364-# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
365-# corresponding to a cache size of 2^16 = 65536 symbols.
397+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
398+# cache is used to resolve symbols given their name and scope. Since this can be
399+# an expensive process and often the same symbol appears multiple times in the
400+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
401+# doxygen will become slower. If the cache is too large, memory is wasted. The
402+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
403+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
404+# symbols. At the end of a run doxygen will report the cache usage and suggest
405+# the optimal cache size from a speed point of view.
406+# Minimum value: 0, maximum value: 9, default value: 0.
366407
367408 LOOKUP_CACHE_SIZE = 0
368409
@@ -370,328 +411,378 @@
370411 # Build related configuration options
371412 #---------------------------------------------------------------------------
372413
373-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
374-# documentation are documented, even if no documentation was available.
375-# Private class members and static file members will be hidden unless
376-# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
414+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
415+# documentation are documented, even if no documentation was available. Private
416+# class members and static file members will be hidden unless the
417+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
418+# Note: This will also disable the warnings about undocumented members that are
419+# normally produced when WARNINGS is set to YES.
420+# The default value is: NO.
377421
378422 EXTRACT_ALL = YES
379423
380-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
381-# will be included in the documentation.
424+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
425+# be included in the documentation.
426+# The default value is: NO.
382427
383428 EXTRACT_PRIVATE = YES
384429
385-# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
430+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
386431 # scope will be included in the documentation.
432+# The default value is: NO.
387433
388434 EXTRACT_PACKAGE = NO
389435
390-# If the EXTRACT_STATIC tag is set to YES all static members of a file
391-# will be included in the documentation.
436+# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
437+# included in the documentation.
438+# The default value is: NO.
392439
393440 EXTRACT_STATIC = YES
394441
395-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
396-# defined locally in source files will be included in the documentation.
397-# If set to NO only classes defined in header files are included.
442+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
443+# locally in source files will be included in the documentation. If set to NO
444+# only classes defined in header files are included. Does not have any effect
445+# for Java sources.
446+# The default value is: YES.
398447
399448 EXTRACT_LOCAL_CLASSES = YES
400449
401-# This flag is only useful for Objective-C code. When set to YES local
402-# methods, which are defined in the implementation section but not in
403-# the interface are included in the documentation.
404-# If set to NO (the default) only methods in the interface are included.
450+# This flag is only useful for Objective-C code. When set to YES local methods,
451+# which are defined in the implementation section but not in the interface are
452+# included in the documentation. If set to NO only methods in the interface are
453+# included.
454+# The default value is: NO.
405455
406456 EXTRACT_LOCAL_METHODS = NO
407457
408-# If this flag is set to YES, the members of anonymous namespaces will be
409-# extracted and appear in the documentation as a namespace called
410-# 'anonymous_namespace{file}', where file will be replaced with the base
411-# name of the file that contains the anonymous namespace. By default
412-# anonymous namespaces are hidden.
458+# If this flag is set to YES, the members of anonymous namespaces will be
459+# extracted and appear in the documentation as a namespace called
460+# 'anonymous_namespace{file}', where file will be replaced with the base name of
461+# the file that contains the anonymous namespace. By default anonymous namespace
462+# are hidden.
463+# The default value is: NO.
413464
414465 EXTRACT_ANON_NSPACES = NO
415466
416-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
417-# undocumented members of documented classes, files or namespaces.
418-# If set to NO (the default) these members will be included in the
419-# various overviews, but no documentation section is generated.
420-# This option has no effect if EXTRACT_ALL is enabled.
467+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
468+# undocumented members inside documented classes or files. If set to NO these
469+# members will be included in the various overviews, but no documentation
470+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
471+# The default value is: NO.
421472
422473 HIDE_UNDOC_MEMBERS = NO
423474
424-# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
425-# undocumented classes that are normally visible in the class hierarchy.
426-# If set to NO (the default) these classes will be included in the various
427-# overviews. This option has no effect if EXTRACT_ALL is enabled.
475+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
476+# undocumented classes that are normally visible in the class hierarchy. If set
477+# to NO these classes will be included in the various overviews. This option has
478+# no effect if EXTRACT_ALL is enabled.
479+# The default value is: NO.
428480
429481 HIDE_UNDOC_CLASSES = NO
430482
431-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
432-# friend (class|struct|union) declarations.
433-# If set to NO (the default) these declarations will be included in the
434-# documentation.
483+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
484+# (class|struct|union) declarations. If set to NO these declarations will be
485+# included in the documentation.
486+# The default value is: NO.
435487
436488 HIDE_FRIEND_COMPOUNDS = NO
437489
438-# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
439-# documentation blocks found inside the body of a function.
440-# If set to NO (the default) these blocks will be appended to the
441-# function's detailed documentation block.
490+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
491+# documentation blocks found inside the body of a function. If set to NO these
492+# blocks will be appended to the function's detailed documentation block.
493+# The default value is: NO.
442494
443495 HIDE_IN_BODY_DOCS = NO
444496
445-# The INTERNAL_DOCS tag determines if documentation
446-# that is typed after a \internal command is included. If the tag is set
447-# to NO (the default) then the documentation will be excluded.
448-# Set it to YES to include the internal documentation.
497+# The INTERNAL_DOCS tag determines if documentation that is typed after a
498+# \internal command is included. If the tag is set to NO then the documentation
499+# will be excluded. Set it to YES to include the internal documentation.
500+# The default value is: NO.
449501
450502 INTERNAL_DOCS = NO
451503
452-# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
453-# file names in lower-case letters. If set to YES upper-case letters are also
454-# allowed. This is useful if you have classes or files whose names only differ
455-# in case and if your file system supports case sensitive file names. Windows
504+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
505+# names in lower-case letters. If set to YES upper-case letters are also
506+# allowed. This is useful if you have classes or files whose names only differ
507+# in case and if your file system supports case sensitive file names. Windows
456508 # and Mac users are advised to set this option to NO.
509+# The default value is: system dependent.
457510
458511 CASE_SENSE_NAMES = NO
459512
460-# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
461-# will show members with their full class and namespace scopes in the
462-# documentation. If set to YES the scope will be hidden.
513+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
514+# their full class and namespace scopes in the documentation. If set to YES the
515+# scope will be hidden.
516+# The default value is: NO.
463517
464518 HIDE_SCOPE_NAMES = NO
465519
466-# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
467-# will put a list of the files that are included by a file in the documentation
468-# of that file.
520+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
521+# the files that are included by a file in the documentation of that file.
522+# The default value is: YES.
469523
470524 SHOW_INCLUDE_FILES = YES
471525
472-# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
473-# will list include files with double quotes in the documentation
474-# rather than with sharp brackets.
526+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
527+# grouped member an include statement to the documentation, telling the reader
528+# which file to include in order to use the member.
529+# The default value is: NO.
530+
531+SHOW_GROUPED_MEMB_INC = NO
532+
533+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
534+# files with double quotes in the documentation rather than with sharp brackets.
535+# The default value is: NO.
475536
476537 FORCE_LOCAL_INCLUDES = NO
477538
478-# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
479-# is inserted in the documentation for inline members.
539+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
540+# documentation for inline members.
541+# The default value is: YES.
480542
481543 INLINE_INFO = YES
482544
483-# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
484-# will sort the (detailed) documentation of file and class members
485-# alphabetically by member name. If set to NO the members will appear in
486-# declaration order.
545+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
546+# (detailed) documentation of file and class members alphabetically by member
547+# name. If set to NO the members will appear in declaration order.
548+# The default value is: YES.
487549
488550 SORT_MEMBER_DOCS = YES
489551
490-# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
491-# brief documentation of file, namespace and class members alphabetically
492-# by member name. If set to NO (the default) the members will appear in
493-# declaration order.
552+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
553+# descriptions of file, namespace and class members alphabetically by member
554+# name. If set to NO the members will appear in declaration order. Note that
555+# this will also influence the order of the classes in the class list.
556+# The default value is: NO.
494557
495558 SORT_BRIEF_DOCS = NO
496559
497-# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
498-# will sort the (brief and detailed) documentation of class members so that
499-# constructors and destructors are listed first. If set to NO (the default)
500-# the constructors will appear in the respective orders defined by
501-# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
502-# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
503-# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
560+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
561+# (brief and detailed) documentation of class members so that constructors and
562+# destructors are listed first. If set to NO the constructors will appear in the
563+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
564+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
565+# member documentation.
566+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
567+# detailed member documentation.
568+# The default value is: NO.
504569
505570 SORT_MEMBERS_CTORS_1ST = NO
506571
507-# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
508-# hierarchy of group names into alphabetical order. If set to NO (the default)
509-# the group names will appear in their defined order.
572+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
573+# of group names into alphabetical order. If set to NO the group names will
574+# appear in their defined order.
575+# The default value is: NO.
510576
511577 SORT_GROUP_NAMES = NO
512578
513-# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
514-# sorted by fully-qualified names, including namespaces. If set to
515-# NO (the default), the class list will be sorted only by class name,
516-# not including the namespace part.
517-# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
518-# Note: This option applies only to the class list, not to the
519-# alphabetical list.
579+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
580+# fully-qualified names, including namespaces. If set to NO, the class list will
581+# be sorted only by class name, not including the namespace part.
582+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
583+# Note: This option applies only to the class list, not to the alphabetical
584+# list.
585+# The default value is: NO.
520586
521587 SORT_BY_SCOPE_NAME = NO
522588
523-# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
524-# do proper type resolution of all parameters of a function it will reject a
525-# match between the prototype and the implementation of a member function even
526-# if there is only one candidate or it is obvious which candidate to choose
527-# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
528-# will still accept a match between prototype and implementation in such cases.
589+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
590+# type resolution of all parameters of a function it will reject a match between
591+# the prototype and the implementation of a member function even if there is
592+# only one candidate or it is obvious which candidate to choose by doing a
593+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
594+# accept a match between prototype and implementation in such cases.
595+# The default value is: NO.
529596
530597 STRICT_PROTO_MATCHING = NO
531598
532-# The GENERATE_TODOLIST tag can be used to enable (YES) or
533-# disable (NO) the todo list. This list is created by putting \todo
534-# commands in the documentation.
599+# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
600+# todo list. This list is created by putting \todo commands in the
601+# documentation.
602+# The default value is: YES.
535603
536604 GENERATE_TODOLIST = YES
537605
538-# The GENERATE_TESTLIST tag can be used to enable (YES) or
539-# disable (NO) the test list. This list is created by putting \test
540-# commands in the documentation.
606+# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
607+# test list. This list is created by putting \test commands in the
608+# documentation.
609+# The default value is: YES.
541610
542611 GENERATE_TESTLIST = YES
543612
544-# The GENERATE_BUGLIST tag can be used to enable (YES) or
545-# disable (NO) the bug list. This list is created by putting \bug
546-# commands in the documentation.
613+# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
614+# list. This list is created by putting \bug commands in the documentation.
615+# The default value is: YES.
547616
548617 GENERATE_BUGLIST = YES
549618
550-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
551-# disable (NO) the deprecated list. This list is created by putting
552-# \deprecated commands in the documentation.
619+# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
620+# the deprecated list. This list is created by putting \deprecated commands in
621+# the documentation.
622+# The default value is: YES.
553623
554624 GENERATE_DEPRECATEDLIST= YES
555625
556-# The ENABLED_SECTIONS tag can be used to enable conditional
557-# documentation sections, marked by \if sectionname ... \endif.
626+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
627+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
628+# ... \endcond blocks.
558629
559630 ENABLED_SECTIONS =
560631
561-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
562-# the initial value of a variable or macro consists of for it to appear in
563-# the documentation. If the initializer consists of more lines than specified
564-# here it will be hidden. Use a value of 0 to hide initializers completely.
565-# The appearance of the initializer of individual variables and macros in the
566-# documentation can be controlled using \showinitializer or \hideinitializer
567-# command in the documentation regardless of this setting.
632+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
633+# initial value of a variable or macro / define can have for it to appear in the
634+# documentation. If the initializer consists of more lines than specified here
635+# it will be hidden. Use a value of 0 to hide initializers completely. The
636+# appearance of the value of individual variables and macros / defines can be
637+# controlled using \showinitializer or \hideinitializer command in the
638+# documentation regardless of this setting.
639+# Minimum value: 0, maximum value: 10000, default value: 30.
568640
569641 MAX_INITIALIZER_LINES = 30
570642
571-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
572-# at the bottom of the documentation of classes and structs. If set to YES the
573-# list will mention the files that were used to generate the documentation.
643+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
644+# the bottom of the documentation of classes and structs. If set to YES the list
645+# will mention the files that were used to generate the documentation.
646+# The default value is: YES.
574647
575648 SHOW_USED_FILES = YES
576649
577-# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
578-# This will remove the Files entry from the Quick Index and from the
579-# Folder Tree View (if specified). The default is YES.
650+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
651+# will remove the Files entry from the Quick Index and from the Folder Tree View
652+# (if specified).
653+# The default value is: YES.
580654
581655 SHOW_FILES = YES
582656
583-# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
584-# Namespaces page. This will remove the Namespaces entry from the Quick Index
585-# and from the Folder Tree View (if specified). The default is YES.
657+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
658+# page. This will remove the Namespaces entry from the Quick Index and from the
659+# Folder Tree View (if specified).
660+# The default value is: YES.
586661
587662 SHOW_NAMESPACES = YES
588663
589-# The FILE_VERSION_FILTER tag can be used to specify a program or script that
590-# doxygen should invoke to get the current version for each file (typically from
591-# the version control system). Doxygen will invoke the program by executing (via
592-# popen()) the command <command> <input-file>, where <command> is the value of
593-# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
594-# provided by doxygen. Whatever the program writes to standard output
595-# is used as the file version. See the manual for examples.
664+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
665+# doxygen should invoke to get the current version for each file (typically from
666+# the version control system). Doxygen will invoke the program by executing (via
667+# popen()) the command command input-file, where command is the value of the
668+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
669+# by doxygen. Whatever the program writes to standard output is used as the file
670+# version. For an example see the documentation.
596671
597672 FILE_VERSION_FILTER =
598673
599-# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
600-# by doxygen. The layout file controls the global structure of the generated
601-# output files in an output format independent way. To create the layout file
602-# that represents doxygen's defaults, run doxygen with the -l option.
603-# You can optionally specify a file name after the option, if omitted
604-# DoxygenLayout.xml will be used as the name of the layout file.
674+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
675+# by doxygen. The layout file controls the global structure of the generated
676+# output files in an output format independent way. To create the layout file
677+# that represents doxygen's defaults, run doxygen with the -l option. You can
678+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
679+# will be used as the name of the layout file.
680+#
681+# Note that if you run doxygen from a directory containing a file called
682+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
683+# tag is left empty.
605684
606685 LAYOUT_FILE =
607686
608-# The CITE_BIB_FILES tag can be used to specify one or more bib files
609-# containing the references data. This must be a list of .bib files. The
610-# .bib extension is automatically appended if omitted. Using this command
611-# requires the bibtex tool to be installed. See also
612-# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
613-# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
614-# feature you need bibtex and perl available in the search path.
687+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
688+# the reference definitions. This must be a list of .bib files. The .bib
689+# extension is automatically appended if omitted. This requires the bibtex tool
690+# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
691+# For LaTeX the style of the bibliography can be controlled using
692+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
693+# search path. Do not use file names with spaces, bibtex cannot handle them. See
694+# also \cite for info how to create references.
615695
616696 CITE_BIB_FILES =
617697
618698 #---------------------------------------------------------------------------
619-# configuration options related to warning and progress messages
699+# Configuration options related to warning and progress messages
620700 #---------------------------------------------------------------------------
621701
622-# The QUIET tag can be used to turn on/off the messages that are generated
623-# by doxygen. Possible values are YES and NO. If left blank NO is used.
702+# The QUIET tag can be used to turn on/off the messages that are generated to
703+# standard output by doxygen. If QUIET is set to YES this implies that the
704+# messages are off.
705+# The default value is: NO.
624706
625707 QUIET = NO
626708
627-# The WARNINGS tag can be used to turn on/off the warning messages that are
628-# generated by doxygen. Possible values are YES and NO. If left blank
629-# NO is used.
709+# The WARNINGS tag can be used to turn on/off the warning messages that are
710+# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
711+# this implies that the warnings are on.
712+#
713+# Tip: Turn warnings on while writing the documentation.
714+# The default value is: YES.
630715
631716 WARNINGS = YES
632717
633-# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
634-# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
635-# automatically be disabled.
718+# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
719+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
720+# will automatically be disabled.
721+# The default value is: YES.
636722
637723 WARN_IF_UNDOCUMENTED = YES
638724
639-# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
640-# potential errors in the documentation, such as not documenting some
641-# parameters in a documented function, or documenting parameters that
642-# don't exist or using markup commands wrongly.
725+# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
726+# potential errors in the documentation, such as not documenting some parameters
727+# in a documented function, or documenting parameters that don't exist or using
728+# markup commands wrongly.
729+# The default value is: YES.
643730
644731 WARN_IF_DOC_ERROR = YES
645732
646-# The WARN_NO_PARAMDOC option can be enabled to get warnings for
647-# functions that are documented, but have no documentation for their parameters
648-# or return value. If set to NO (the default) doxygen will only warn about
649-# wrong or incomplete parameter documentation, but not about the absence of
650-# documentation.
733+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
734+# are documented, but have no documentation for their parameters or return
735+# value. If set to NO doxygen will only warn about wrong or incomplete parameter
736+# documentation, but not about the absence of documentation.
737+# The default value is: NO.
651738
652739 WARN_NO_PARAMDOC = NO
653740
654-# The WARN_FORMAT tag determines the format of the warning messages that
655-# doxygen can produce. The string should contain the $file, $line, and $text
656-# tags, which will be replaced by the file and line number from which the
657-# warning originated and the warning text. Optionally the format may contain
658-# $version, which will be replaced by the version of the file (if it could
659-# be obtained via FILE_VERSION_FILTER)
741+# The WARN_FORMAT tag determines the format of the warning messages that doxygen
742+# can produce. The string should contain the $file, $line, and $text tags, which
743+# will be replaced by the file and line number from which the warning originated
744+# and the warning text. Optionally the format may contain $version, which will
745+# be replaced by the version of the file (if it could be obtained via
746+# FILE_VERSION_FILTER)
747+# The default value is: $file:$line: $text.
660748
661749 WARN_FORMAT = "$file:$line: $text"
662750
663-# The WARN_LOGFILE tag can be used to specify a file to which warning
664-# and error messages should be written. If left blank the output is written
665-# to stderr.
751+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
752+# messages should be written. If left blank the output is written to standard
753+# error (stderr).
666754
667755 WARN_LOGFILE =
668756
669757 #---------------------------------------------------------------------------
670-# configuration options related to the input files
758+# Configuration options related to the input files
671759 #---------------------------------------------------------------------------
672760
673-# The INPUT tag can be used to specify the files and/or directories that contain
674-# documented source files. You may enter file names like "myfile.cpp" or
675-# directories like "/usr/src/myproject". Separate the files or directories
676-# with spaces.
761+# The INPUT tag is used to specify the files and/or directories that contain
762+# documented source files. You may enter file names like myfile.cpp or
763+# directories like /usr/src/myproject. Separate the files or directories with
764+# spaces.
765+# Note: If this tag is empty the current directory is searched.
677766
678767 INPUT = .
679768
680-# This tag can be used to specify the character encoding of the source files
681-# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
682-# also the default input encoding. Doxygen uses libiconv (or the iconv built
683-# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
684-# the list of possible encodings.
769+# This tag can be used to specify the character encoding of the source files
770+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
771+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
772+# documentation (see: http://www.gnu.org/software/libiconv) for the list of
773+# possible encodings.
774+# The default value is: UTF-8.
685775
686776 INPUT_ENCODING = UTF-8
687777
688-# If the value of the INPUT tag contains directories, you can use the
689-# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
690-# and *.h) to filter out the source-files in the directories. If left
691-# blank the following patterns are tested:
692-# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
693-# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
694-# *.f90 *.f *.for *.vhd *.vhdl
778+# If the value of the INPUT tag contains directories, you can use the
779+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
780+# *.h) to filter out the source-files in the directories. If left blank the
781+# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
782+# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
783+# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
784+# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
785+# *.qsf, *.as and *.js.
695786
696787 FILE_PATTERNS = *.c \
697788 *.cc \
@@ -725,33 +816,38 @@
725816 *.vhd \
726817 *.vhdl
727818
728-# The RECURSIVE tag can be used to turn specify whether or not subdirectories
729-# should be searched for input files as well. Possible values are YES and NO.
730-# If left blank NO is used.
819+# The RECURSIVE tag can be used to specify whether or not subdirectories should
820+# be searched for input files as well.
821+# The default value is: NO.
731822
732823 RECURSIVE = YES
733824
734-# The EXCLUDE tag can be used to specify files and/or directories that should be
735-# excluded from the INPUT source files. This way you can easily exclude a
736-# subdirectory from a directory tree whose root is specified with the INPUT tag.
737-# Note that relative paths are relative to the directory from which doxygen is
825+# The EXCLUDE tag can be used to specify files and/or directories that should be
826+# excluded from the INPUT source files. This way you can easily exclude a
827+# subdirectory from a directory tree whose root is specified with the INPUT tag.
828+#
829+# Note that relative paths are relative to the directory from which doxygen is
738830 # run.
739831
740832 EXCLUDE = .hg \
741- YFramework/include/freetype \
742- YFramework/include/ft2build.h
743-
744-# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
745-# directories that are symbolic links (a Unix file system feature) are excluded
833+ .git \
834+ Data \
835+ 3rdparty \
836+ Tools
837+
838+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
839+# directories that are symbolic links (a Unix file system feature) are excluded
746840 # from the input.
841+# The default value is: NO.
747842
748843 EXCLUDE_SYMLINKS = NO
749844
750-# If the value of the INPUT tag contains directories, you can use the
751-# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
752-# certain files from those directories. Note that the wildcards are matched
753-# against the file with absolute path, so to exclude all test directories
754-# for example use the pattern */test/*
845+# If the value of the INPUT tag contains directories, you can use the
846+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
847+# certain files from those directories.
848+#
849+# Note that the wildcards are matched against the file with absolute path, so to
850+# exclude all test directories for example use the pattern */test/*
755851
756852 EXCLUDE_PATTERNS = *.o \
757853 *.d \
@@ -762,763 +858,1100 @@
762858 */Release/* \
763859 */doc/*
764860
765-# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
766-# (namespaces, classes, functions, etc.) that should be excluded from the
767-# output. The symbol name can be a fully qualified name, a word, or if the
768-# wildcard * is used, a substring. Examples: ANamespace, AClass,
861+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
862+# (namespaces, classes, functions, etc.) that should be excluded from the
863+# output. The symbol name can be a fully qualified name, a word, or if the
864+# wildcard * is used, a substring. Examples: ANamespace, AClass,
769865 # AClass::ANamespace, ANamespace::*Test
866+#
867+# Note that the wildcards are matched against the file with absolute path, so to
868+# exclude all test directories use the pattern */test/*
770869
771870 EXCLUDE_SYMBOLS =
772871
773-# The EXAMPLE_PATH tag can be used to specify one or more files or
774-# directories that contain example code fragments that are included (see
775-# the \include command).
872+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
873+# that contain example code fragments that are included (see the \include
874+# command).
776875
777876 EXAMPLE_PATH =
778877
779-# If the value of the EXAMPLE_PATH tag contains directories, you can use the
780-# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
781-# and *.h) to filter out the source-files in the directories. If left
782-# blank all files are included.
878+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
879+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
880+# *.h) to filter out the source-files in the directories. If left blank all
881+# files are included.
783882
784883 EXAMPLE_PATTERNS = *
785884
786-# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
787-# searched for input files to be used with the \include or \dontinclude
788-# commands irrespective of the value of the RECURSIVE tag.
789-# Possible values are YES and NO. If left blank NO is used.
885+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
886+# searched for input files to be used with the \include or \dontinclude commands
887+# irrespective of the value of the RECURSIVE tag.
888+# The default value is: NO.
790889
791890 EXAMPLE_RECURSIVE = NO
792891
793-# The IMAGE_PATH tag can be used to specify one or more files or
794-# directories that contain image that are included in the documentation (see
795-# the \image command).
892+# The IMAGE_PATH tag can be used to specify one or more files or directories
893+# that contain images that are to be included in the documentation (see the
894+# \image command).
796895
797896 IMAGE_PATH =
798897
799-# The INPUT_FILTER tag can be used to specify a program that doxygen should
800-# invoke to filter for each input file. Doxygen will invoke the filter program
801-# by executing (via popen()) the command <filter> <input-file>, where <filter>
802-# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
803-# input file. Doxygen will then use the output that the filter program writes
804-# to standard output. If FILTER_PATTERNS is specified, this tag will be
805-# ignored.
898+# The INPUT_FILTER tag can be used to specify a program that doxygen should
899+# invoke to filter for each input file. Doxygen will invoke the filter program
900+# by executing (via popen()) the command:
901+#
902+# <filter> <input-file>
903+#
904+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
905+# name of an input file. Doxygen will then use the output that the filter
906+# program writes to standard output. If FILTER_PATTERNS is specified, this tag
907+# will be ignored.
908+#
909+# Note that the filter must not add or remove lines; it is applied before the
910+# code is scanned, but not when the output code is generated. If lines are added
911+# or removed, the anchors will not be placed correctly.
806912
807913 INPUT_FILTER =
808914
809-# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
810-# basis. Doxygen will compare the file name with each pattern and apply the
811-# filter if there is a match. The filters are a list of the form:
812-# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
813-# info on how filters are used. If FILTER_PATTERNS is empty or if
814-# non of the patterns match the file name, INPUT_FILTER is applied.
915+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
916+# basis. Doxygen will compare the file name with each pattern and apply the
917+# filter if there is a match. The filters are a list of the form: pattern=filter
918+# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
919+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
920+# patterns match the file name, INPUT_FILTER is applied.
815921
816922 FILTER_PATTERNS =
817923
818-# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
819-# INPUT_FILTER) will be used to filter the input files when producing source
820-# files to browse (i.e. when SOURCE_BROWSER is set to YES).
924+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
925+# INPUT_FILTER ) will also be used to filter the input files that are used for
926+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
927+# The default value is: NO.
821928
822929 FILTER_SOURCE_FILES = NO
823930
824-# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
825-# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
826-# and it is also possible to disable source filtering for a specific pattern
827-# using *.ext= (so without naming a filter). This option only has effect when
828-# FILTER_SOURCE_FILES is enabled.
931+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
932+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
933+# it is also possible to disable source filtering for a specific pattern using
934+# *.ext= (so without naming a filter).
935+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
829936
830937 FILTER_SOURCE_PATTERNS =
831938
939+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
940+# is part of the input, its contents will be placed on the main page
941+# (index.html). This can be useful if you have a project on for instance GitHub
942+# and want to reuse the introduction page also for the doxygen output.
943+
944+USE_MDFILE_AS_MAINPAGE =
945+
832946 #---------------------------------------------------------------------------
833-# configuration options related to source browsing
947+# Configuration options related to source browsing
834948 #---------------------------------------------------------------------------
835949
836-# If the SOURCE_BROWSER tag is set to YES then a list of source files will
837-# be generated. Documented entities will be cross-referenced with these sources.
838-# Note: To get rid of all source code in the generated output, make sure also
839-# VERBATIM_HEADERS is set to NO.
950+# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
951+# generated. Documented entities will be cross-referenced with these sources.
952+#
953+# Note: To get rid of all source code in the generated output, make sure that
954+# also VERBATIM_HEADERS is set to NO.
955+# The default value is: NO.
840956
841957 SOURCE_BROWSER = YES
842958
843-# Setting the INLINE_SOURCES tag to YES will include the body
844-# of functions and classes directly in the documentation.
959+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
960+# classes and enums directly into the documentation.
961+# The default value is: NO.
845962
846963 INLINE_SOURCES = NO
847964
848-# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
849-# doxygen to hide any special comment blocks from generated source code
850-# fragments. Normal C, C++ and Fortran comments will always remain visible.
965+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
966+# special comment blocks from generated source code fragments. Normal C, C++ and
967+# Fortran comments will always remain visible.
968+# The default value is: YES.
851969
852970 STRIP_CODE_COMMENTS = YES
853971
854-# If the REFERENCED_BY_RELATION tag is set to YES
855-# then for each documented function all documented
856-# functions referencing it will be listed.
972+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
973+# function all documented functions referencing it will be listed.
974+# The default value is: NO.
857975
858976 REFERENCED_BY_RELATION = YES
859977
860-# If the REFERENCES_RELATION tag is set to YES
861-# then for each documented function all documented entities
862-# called/used by that function will be listed.
978+# If the REFERENCES_RELATION tag is set to YES then for each documented function
979+# all documented entities called/used by that function will be listed.
980+# The default value is: NO.
863981
864982 REFERENCES_RELATION = YES
865983
866-# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
867-# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
868-# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
869-# link to the source code. Otherwise they will link to the documentation.
984+# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
985+# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
986+# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
987+# link to the documentation.
988+# The default value is: YES.
870989
871990 REFERENCES_LINK_SOURCE = YES
872991
873-# If the USE_HTAGS tag is set to YES then the references to source code
874-# will point to the HTML generated by the htags(1) tool instead of doxygen
875-# built-in source browser. The htags tool is part of GNU's global source
876-# tagging system (see http://www.gnu.org/software/global/global.html). You
877-# will need version 4.8.6 or higher.
992+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
993+# source code will show a tooltip with additional information such as prototype,
994+# brief description and links to the definition and documentation. Since this
995+# will make the HTML file larger and loading of large files a bit slower, you
996+# can opt to disable this feature.
997+# The default value is: YES.
998+# This tag requires that the tag SOURCE_BROWSER is set to YES.
999+
1000+SOURCE_TOOLTIPS = YES
1001+
1002+# If the USE_HTAGS tag is set to YES then the references to source code will
1003+# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1004+# source browser. The htags tool is part of GNU's global source tagging system
1005+# (see http://www.gnu.org/software/global/global.html). You will need version
1006+# 4.8.6 or higher.
1007+#
1008+# To use it do the following:
1009+# - Install the latest version of global
1010+# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1011+# - Make sure the INPUT points to the root of the source tree
1012+# - Run doxygen as normal
1013+#
1014+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1015+# tools must be available from the command line (i.e. in the search path).
1016+#
1017+# The result: instead of the source browser generated by doxygen, the links to
1018+# source code will now point to the output of htags.
1019+# The default value is: NO.
1020+# This tag requires that the tag SOURCE_BROWSER is set to YES.
8781021
8791022 USE_HTAGS = NO
8801023
881-# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
882-# will generate a verbatim copy of the header file for each class for
883-# which an include is specified. Set to NO to disable this.
1024+# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1025+# verbatim copy of the header file for each class for which an include is
1026+# specified. Set to NO to disable this.
1027+# See also: Section \class.
1028+# The default value is: YES.
8841029
8851030 VERBATIM_HEADERS = YES
8861031
887-#---------------------------------------------------------------------------
888-# configuration options related to the alphabetical class index
1032+# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
1033+# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1034+# cost of reduced performance. This can be particularly helpful with template
1035+# rich C++ code for which doxygen's built-in parser lacks the necessary type
1036+# information.
1037+# Note: The availability of this option depends on whether or not doxygen was
1038+# compiled with the --with-libclang option.
1039+# The default value is: NO.
1040+
1041+CLANG_ASSISTED_PARSING = NO
1042+
1043+# If clang assisted parsing is enabled you can provide the compiler with command
1044+# line options that you would normally use when invoking the compiler. Note that
1045+# the include paths will already be set by doxygen for the files and directories
1046+# specified with INPUT and INCLUDE_PATH.
1047+# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1048+
1049+CLANG_OPTIONS =
1050+
8891051 #---------------------------------------------------------------------------
890-
891-# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
892-# of all compounds will be generated. Enable this if the project
893-# contains a lot of classes, structs, unions or interfaces.
1052+# Configuration options related to the alphabetical class index
1053+#---------------------------------------------------------------------------
1054+
1055+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1056+# compounds will be generated. Enable this if the project contains a lot of
1057+# classes, structs, unions or interfaces.
1058+# The default value is: YES.
8941059
8951060 ALPHABETICAL_INDEX = YES
8961061
897-# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
898-# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
899-# in which this list will be split (can be a number in the range [1..20])
1062+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1063+# which the alphabetical index list will be split.
1064+# Minimum value: 1, maximum value: 20, default value: 5.
1065+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
9001066
9011067 COLS_IN_ALPHA_INDEX = 5
9021068
903-# In case all classes in a project start with a common prefix, all
904-# classes will be put under the same header in the alphabetical index.
905-# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
906-# should be ignored while generating the index headers.
1069+# In case all classes in a project start with a common prefix, all classes will
1070+# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1071+# can be used to specify a prefix (or a list of prefixes) that should be ignored
1072+# while generating the index headers.
1073+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
9071074
9081075 IGNORE_PREFIX =
9091076
9101077 #---------------------------------------------------------------------------
911-# configuration options related to the HTML output
1078+# Configuration options related to the HTML output
9121079 #---------------------------------------------------------------------------
9131080
914-# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
915-# generate HTML output.
1081+# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1082+# The default value is: YES.
9161083
9171084 GENERATE_HTML = YES
9181085
919-# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
920-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
921-# put in front of it. If left blank `html' will be used as the default path.
1086+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1087+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1088+# it.
1089+# The default directory is: html.
1090+# This tag requires that the tag GENERATE_HTML is set to YES.
9221091
9231092 HTML_OUTPUT = html
9241093
925-# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
926-# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
927-# doxygen will generate files with .html extension.
1094+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1095+# generated HTML page (for example: .htm, .php, .asp).
1096+# The default value is: .html.
1097+# This tag requires that the tag GENERATE_HTML is set to YES.
9281098
9291099 HTML_FILE_EXTENSION = .html
9301100
931-# The HTML_HEADER tag can be used to specify a personal HTML header for
932-# each generated HTML page. If it is left blank doxygen will generate a
933-# standard header. Note that when using a custom header you are responsible
934-# for the proper inclusion of any scripts and style sheets that doxygen
935-# needs, which is dependent on the configuration options used.
936-# It is advised to generate a default header using "doxygen -w html
937-# header.html footer.html stylesheet.css YourConfigFile" and then modify
938-# that header. Note that the header is subject to change so you typically
939-# have to redo this when upgrading to a newer version of doxygen or when
940-# changing the value of configuration settings such as GENERATE_TREEVIEW!
1101+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1102+# each generated HTML page. If the tag is left blank doxygen will generate a
1103+# standard header.
1104+#
1105+# To get valid HTML the header file that includes any scripts and style sheets
1106+# that doxygen needs, which is dependent on the configuration options used (e.g.
1107+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1108+# default header using
1109+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1110+# YourConfigFile
1111+# and then modify the file new_header.html. See also section "Doxygen usage"
1112+# for information on how to generate the default header that doxygen normally
1113+# uses.
1114+# Note: The header is subject to change so you typically have to regenerate the
1115+# default header when upgrading to a newer version of doxygen. For a description
1116+# of the possible markers and block names see the documentation.
1117+# This tag requires that the tag GENERATE_HTML is set to YES.
9411118
9421119 HTML_HEADER =
9431120
944-# The HTML_FOOTER tag can be used to specify a personal HTML footer for
945-# each generated HTML page. If it is left blank doxygen will generate a
946-# standard footer.
1121+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1122+# generated HTML page. If the tag is left blank doxygen will generate a standard
1123+# footer. See HTML_HEADER for more information on how to generate a default
1124+# footer and what special commands can be used inside the footer. See also
1125+# section "Doxygen usage" for information on how to generate the default footer
1126+# that doxygen normally uses.
1127+# This tag requires that the tag GENERATE_HTML is set to YES.
9471128
9481129 HTML_FOOTER =
9491130
950-# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
951-# style sheet that is used by each HTML page. It can be used to
952-# fine-tune the look of the HTML output. If left blank doxygen will
953-# generate a default style sheet. Note that it is recommended to use
954-# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
955-# tag will in the future become obsolete.
1131+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1132+# sheet that is used by each HTML page. It can be used to fine-tune the look of
1133+# the HTML output. If left blank doxygen will generate a default style sheet.
1134+# See also section "Doxygen usage" for information on how to generate the style
1135+# sheet that doxygen normally uses.
1136+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1137+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1138+# obsolete.
1139+# This tag requires that the tag GENERATE_HTML is set to YES.
9561140
9571141 HTML_STYLESHEET =
9581142
959-# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
960-# user-defined cascading style sheet that is included after the standard
961-# style sheets created by doxygen. Using this option one can overrule
962-# certain style aspects. This is preferred over using HTML_STYLESHEET
963-# since it does not replace the standard style sheet and is therefor more
964-# robust against future updates. Doxygen will copy the style sheet file to
965-# the output directory.
1143+# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1144+# defined cascading style sheet that is included after the standard style sheets
1145+# created by doxygen. Using this option one can overrule certain style aspects.
1146+# This is preferred over using HTML_STYLESHEET since it does not replace the
1147+# standard style sheet and is therefor more robust against future updates.
1148+# Doxygen will copy the style sheet file to the output directory. For an example
1149+# see the documentation.
1150+# This tag requires that the tag GENERATE_HTML is set to YES.
9661151
9671152 HTML_EXTRA_STYLESHEET =
9681153
969-# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
970-# other source files which should be copied to the HTML output directory. Note
971-# that these files will be copied to the base HTML output directory. Use the
972-# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
973-# files. In the HTML_STYLESHEET file, use the file name only. Also note that
974-# the files will be copied as-is; there are no commands or markers available.
1154+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1155+# other source files which should be copied to the HTML output directory. Note
1156+# that these files will be copied to the base HTML output directory. Use the
1157+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1158+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1159+# files will be copied as-is; there are no commands or markers available.
1160+# This tag requires that the tag GENERATE_HTML is set to YES.
9751161
9761162 HTML_EXTRA_FILES =
9771163
978-# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
979-# Doxygen will adjust the colors in the style sheet and background images
980-# according to this color. Hue is specified as an angle on a colorwheel,
981-# see http://en.wikipedia.org/wiki/Hue for more information.
982-# For instance the value 0 represents red, 60 is yellow, 120 is green,
983-# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
984-# The allowed range is 0 to 359.
1164+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1165+# will adjust the colors in the stylesheet and background images according to
1166+# this color. Hue is specified as an angle on a colorwheel, see
1167+# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1168+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1169+# purple, and 360 is red again.
1170+# Minimum value: 0, maximum value: 359, default value: 220.
1171+# This tag requires that the tag GENERATE_HTML is set to YES.
9851172
9861173 HTML_COLORSTYLE_HUE = 220
9871174
988-# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
989-# the colors in the HTML output. For a value of 0 the output will use
990-# grayscales only. A value of 255 will produce the most vivid colors.
1175+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1176+# in the HTML output. For a value of 0 the output will use grayscales only. A
1177+# value of 255 will produce the most vivid colors.
1178+# Minimum value: 0, maximum value: 255, default value: 100.
1179+# This tag requires that the tag GENERATE_HTML is set to YES.
9911180
9921181 HTML_COLORSTYLE_SAT = 100
9931182
994-# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
995-# the luminance component of the colors in the HTML output. Values below
996-# 100 gradually make the output lighter, whereas values above 100 make
997-# the output darker. The value divided by 100 is the actual gamma applied,
998-# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
999-# and 100 does not change the gamma.
1183+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1184+# luminance component of the colors in the HTML output. Values below 100
1185+# gradually make the output lighter, whereas values above 100 make the output
1186+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1187+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1188+# change the gamma.
1189+# Minimum value: 40, maximum value: 240, default value: 80.
1190+# This tag requires that the tag GENERATE_HTML is set to YES.
10001191
10011192 HTML_COLORSTYLE_GAMMA = 80
10021193
1003-# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1004-# page will contain the date and time when the page was generated. Setting
1005-# this to NO can help when comparing the output of multiple runs.
1194+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1195+# page will contain the date and time when the page was generated. Setting this
1196+# to NO can help when comparing the output of multiple runs.
1197+# The default value is: YES.
1198+# This tag requires that the tag GENERATE_HTML is set to YES.
10061199
10071200 HTML_TIMESTAMP = YES
10081201
1009-# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1010-# documentation will contain sections that can be hidden and shown after the
1202+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1203+# documentation will contain sections that can be hidden and shown after the
10111204 # page has loaded.
1205+# The default value is: NO.
1206+# This tag requires that the tag GENERATE_HTML is set to YES.
10121207
10131208 HTML_DYNAMIC_SECTIONS = NO
10141209
1015-# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
1016-# entries shown in the various tree structured indices initially; the user
1017-# can expand and collapse entries dynamically later on. Doxygen will expand
1018-# the tree to such a level that at most the specified number of entries are
1019-# visible (unless a fully collapsed tree already exceeds this amount).
1020-# So setting the number of entries 1 will produce a full collapsed tree by
1021-# default. 0 is a special value representing an infinite number of entries
1022-# and will result in a full expanded tree by default.
1210+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1211+# shown in the various tree structured indices initially; the user can expand
1212+# and collapse entries dynamically later on. Doxygen will expand the tree to
1213+# such a level that at most the specified number of entries are visible (unless
1214+# a fully collapsed tree already exceeds this amount). So setting the number of
1215+# entries 1 will produce a full collapsed tree by default. 0 is a special value
1216+# representing an infinite number of entries and will result in a full expanded
1217+# tree by default.
1218+# Minimum value: 0, maximum value: 9999, default value: 100.
1219+# This tag requires that the tag GENERATE_HTML is set to YES.
10231220
10241221 HTML_INDEX_NUM_ENTRIES = 100
10251222
1026-# If the GENERATE_DOCSET tag is set to YES, additional index files
1027-# will be generated that can be used as input for Apple's Xcode 3
1028-# integrated development environment, introduced with OSX 10.5 (Leopard).
1029-# To create a documentation set, doxygen will generate a Makefile in the
1030-# HTML output directory. Running make will produce the docset in that
1031-# directory and running "make install" will install the docset in
1032-# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1033-# it at startup.
1034-# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1223+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1224+# generated that can be used as input for Apple's Xcode 3 integrated development
1225+# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1226+# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1227+# Makefile in the HTML output directory. Running make will produce the docset in
1228+# that directory and running make install will install the docset in
1229+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1230+# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
10351231 # for more information.
1232+# The default value is: NO.
1233+# This tag requires that the tag GENERATE_HTML is set to YES.
10361234
10371235 GENERATE_DOCSET = NO
10381236
1039-# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1040-# feed. A documentation feed provides an umbrella under which multiple
1041-# documentation sets from a single provider (such as a company or product suite)
1042-# can be grouped.
1237+# This tag determines the name of the docset feed. A documentation feed provides
1238+# an umbrella under which multiple documentation sets from a single provider
1239+# (such as a company or product suite) can be grouped.
1240+# The default value is: Doxygen generated docs.
1241+# This tag requires that the tag GENERATE_DOCSET is set to YES.
10431242
10441243 DOCSET_FEEDNAME = "Doxygen generated docs"
10451244
1046-# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1047-# should uniquely identify the documentation set bundle. This should be a
1048-# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1049-# will append .docset to the name.
1245+# This tag specifies a string that should uniquely identify the documentation
1246+# set bundle. This should be a reverse domain-name style string, e.g.
1247+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1248+# The default value is: org.doxygen.Project.
1249+# This tag requires that the tag GENERATE_DOCSET is set to YES.
10501250
10511251 DOCSET_BUNDLE_ID = org.doxygen.Project
10521252
1053-# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
1054-# identify the documentation publisher. This should be a reverse domain-name
1055-# style string, e.g. com.mycompany.MyDocSet.documentation.
1253+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1254+# the documentation publisher. This should be a reverse domain-name style
1255+# string, e.g. com.mycompany.MyDocSet.documentation.
1256+# The default value is: org.doxygen.Publisher.
1257+# This tag requires that the tag GENERATE_DOCSET is set to YES.
10561258
10571259 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
10581260
1059-# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1261+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1262+# The default value is: Publisher.
1263+# This tag requires that the tag GENERATE_DOCSET is set to YES.
10601264
10611265 DOCSET_PUBLISHER_NAME = Publisher
10621266
1063-# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1064-# will be generated that can be used as input for tools like the
1065-# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1066-# of the generated HTML documentation.
1267+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1268+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1269+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1270+# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1271+# Windows.
1272+#
1273+# The HTML Help Workshop contains a compiler that can convert all HTML output
1274+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1275+# files are now used as the Windows 98 help format, and will replace the old
1276+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1277+# HTML files also contain an index, a table of contents, and you can search for
1278+# words in the documentation. The HTML workshop also contains a viewer for
1279+# compressed HTML files.
1280+# The default value is: NO.
1281+# This tag requires that the tag GENERATE_HTML is set to YES.
10671282
10681283 GENERATE_HTMLHELP = NO
10691284
1070-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1071-# be used to specify the file name of the resulting .chm file. You
1072-# can add a path in front of the file if the result should not be
1285+# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1286+# file. You can add a path in front of the file if the result should not be
10731287 # written to the html output directory.
1288+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
10741289
10751290 CHM_FILE =
10761291
1077-# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1078-# be used to specify the location (absolute path including file name) of
1079-# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1080-# the HTML help compiler on the generated index.hhp.
1292+# The HHC_LOCATION tag can be used to specify the location (absolute path
1293+# including file name) of the HTML help compiler ( hhc.exe). If non-empty
1294+# doxygen will try to run the HTML help compiler on the generated index.hhp.
1295+# The file has to be specified with full path.
1296+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
10811297
10821298 HHC_LOCATION =
10831299
1084-# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1085-# controls if a separate .chi index file is generated (YES) or that
1086-# it should be included in the master .chm file (NO).
1300+# The GENERATE_CHI flag controls if a separate .chi index file is generated (
1301+# YES) or that it should be included in the master .chm file ( NO).
1302+# The default value is: NO.
1303+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
10871304
10881305 GENERATE_CHI = NO
10891306
1090-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1091-# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1092-# content.
1307+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1308+# and project file content.
1309+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
10931310
10941311 CHM_INDEX_ENCODING =
10951312
1096-# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1097-# controls whether a binary table of contents is generated (YES) or a
1098-# normal table of contents (NO) in the .chm file.
1313+# The BINARY_TOC flag controls whether a binary table of contents is generated (
1314+# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
1315+# enables the Previous and Next buttons.
1316+# The default value is: NO.
1317+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
10991318
11001319 BINARY_TOC = NO
11011320
1102-# The TOC_EXPAND flag can be set to YES to add extra items for group members
1103-# to the contents of the HTML help documentation and to the tree view.
1321+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1322+# the table of contents of the HTML help documentation and to the tree view.
1323+# The default value is: NO.
1324+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
11041325
11051326 TOC_EXPAND = NO
11061327
1107-# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1108-# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1109-# that can be used as input for Qt's qhelpgenerator to generate a
1110-# Qt Compressed Help (.qch) of the generated HTML documentation.
1328+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1329+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1330+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1331+# (.qch) of the generated HTML documentation.
1332+# The default value is: NO.
1333+# This tag requires that the tag GENERATE_HTML is set to YES.
11111334
11121335 GENERATE_QHP = NO
11131336
1114-# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1115-# be used to specify the file name of the resulting .qch file.
1116-# The path specified is relative to the HTML output folder.
1337+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1338+# the file name of the resulting .qch file. The path specified is relative to
1339+# the HTML output folder.
1340+# This tag requires that the tag GENERATE_QHP is set to YES.
11171341
11181342 QCH_FILE =
11191343
1120-# The QHP_NAMESPACE tag specifies the namespace to use when generating
1121-# Qt Help Project output. For more information please see
1122-# http://doc.trolltech.com/qthelpproject.html#namespace
1344+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1345+# Project output. For more information please see Qt Help Project / Namespace
1346+# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1347+# The default value is: org.doxygen.Project.
1348+# This tag requires that the tag GENERATE_QHP is set to YES.
11231349
11241350 QHP_NAMESPACE = org.doxygen.Project
11251351
1126-# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1127-# Qt Help Project output. For more information please see
1128-# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1352+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1353+# Help Project output. For more information please see Qt Help Project / Virtual
1354+# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1355+# folders).
1356+# The default value is: doc.
1357+# This tag requires that the tag GENERATE_QHP is set to YES.
11291358
11301359 QHP_VIRTUAL_FOLDER = doc
11311360
1132-# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1133-# add. For more information please see
1134-# http://doc.trolltech.com/qthelpproject.html#custom-filters
1361+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1362+# filter to add. For more information please see Qt Help Project / Custom
1363+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1364+# filters).
1365+# This tag requires that the tag GENERATE_QHP is set to YES.
11351366
11361367 QHP_CUST_FILTER_NAME =
11371368
1138-# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1139-# custom filter to add. For more information please see
1140-# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1141-# Qt Help Project / Custom Filters</a>.
1369+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1370+# custom filter to add. For more information please see Qt Help Project / Custom
1371+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1372+# filters).
1373+# This tag requires that the tag GENERATE_QHP is set to YES.
11421374
11431375 QHP_CUST_FILTER_ATTRS =
11441376
1145-# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1146-# project's
1147-# filter section matches.
1148-# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1149-# Qt Help Project / Filter Attributes</a>.
1377+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1378+# project's filter section matches. Qt Help Project / Filter Attributes (see:
1379+# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1380+# This tag requires that the tag GENERATE_QHP is set to YES.
11501381
11511382 QHP_SECT_FILTER_ATTRS =
11521383
1153-# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1154-# be used to specify the location of Qt's qhelpgenerator.
1155-# If non-empty doxygen will try to run qhelpgenerator on the generated
1156-# .qhp file.
1384+# The QHG_LOCATION tag can be used to specify the location of Qt's
1385+# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1386+# generated .qhp file.
1387+# This tag requires that the tag GENERATE_QHP is set to YES.
11571388
11581389 QHG_LOCATION =
11591390
1160-# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1161-# will be generated, which together with the HTML files, form an Eclipse help
1162-# plugin. To install this plugin and make it available under the help contents
1163-# menu in Eclipse, the contents of the directory containing the HTML and XML
1164-# files needs to be copied into the plugins directory of eclipse. The name of
1165-# the directory within the plugins directory should be the same as
1166-# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1167-# the help appears.
1391+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1392+# generated, together with the HTML files, they form an Eclipse help plugin. To
1393+# install this plugin and make it available under the help contents menu in
1394+# Eclipse, the contents of the directory containing the HTML and XML files needs
1395+# to be copied into the plugins directory of eclipse. The name of the directory
1396+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1397+# After copying Eclipse needs to be restarted before the help appears.
1398+# The default value is: NO.
1399+# This tag requires that the tag GENERATE_HTML is set to YES.
11681400
11691401 GENERATE_ECLIPSEHELP = NO
11701402
1171-# A unique identifier for the eclipse help plugin. When installing the plugin
1172-# the directory name containing the HTML and XML files should also have
1173-# this name.
1403+# A unique identifier for the Eclipse help plugin. When installing the plugin
1404+# the directory name containing the HTML and XML files should also have this
1405+# name. Each documentation set should have its own identifier.
1406+# The default value is: org.doxygen.Project.
1407+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
11741408
11751409 ECLIPSE_DOC_ID = org.doxygen.Project
11761410
1177-# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
1178-# at top of each HTML page. The value NO (the default) enables the index and
1179-# the value YES disables it. Since the tabs have the same information as the
1180-# navigation tree you can set this option to NO if you already set
1181-# GENERATE_TREEVIEW to YES.
1411+# If you want full control over the layout of the generated HTML pages it might
1412+# be necessary to disable the index and replace it with your own. The
1413+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1414+# of each HTML page. A value of NO enables the index and the value YES disables
1415+# it. Since the tabs in the index contain the same information as the navigation
1416+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1417+# The default value is: NO.
1418+# This tag requires that the tag GENERATE_HTML is set to YES.
11821419
11831420 DISABLE_INDEX = NO
11841421
1185-# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1186-# structure should be generated to display hierarchical information.
1187-# If the tag value is set to YES, a side panel will be generated
1188-# containing a tree-like index structure (just like the one that
1189-# is generated for HTML Help). For this to work a browser that supports
1190-# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1191-# Windows users are probably better off using the HTML help feature.
1192-# Since the tree basically has the same information as the tab index you
1193-# could consider to set DISABLE_INDEX to NO when enabling this option.
1422+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1423+# structure should be generated to display hierarchical information. If the tag
1424+# value is set to YES, a side panel will be generated containing a tree-like
1425+# index structure (just like the one that is generated for HTML Help). For this
1426+# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1427+# (i.e. any modern browser). Windows users are probably better off using the
1428+# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1429+# further fine-tune the look of the index. As an example, the default style
1430+# sheet generated by doxygen has an example that shows how to put an image at
1431+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1432+# the same information as the tab index, you could consider setting
1433+# DISABLE_INDEX to YES when enabling this option.
1434+# The default value is: NO.
1435+# This tag requires that the tag GENERATE_HTML is set to YES.
11941436
11951437 GENERATE_TREEVIEW = YES
11961438
1197-# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1198-# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1199-# documentation. Note that a value of 0 will completely suppress the enum
1200-# values from appearing in the overview section.
1439+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1440+# doxygen will group on one line in the generated HTML documentation.
1441+#
1442+# Note that a value of 0 will completely suppress the enum values from appearing
1443+# in the overview section.
1444+# Minimum value: 0, maximum value: 20, default value: 4.
1445+# This tag requires that the tag GENERATE_HTML is set to YES.
12011446
12021447 ENUM_VALUES_PER_LINE = 4
12031448
1204-# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1205-# used to set the initial width (in pixels) of the frame in which the tree
1206-# is shown.
1449+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1450+# to set the initial width (in pixels) of the frame in which the tree is shown.
1451+# Minimum value: 0, maximum value: 1500, default value: 250.
1452+# This tag requires that the tag GENERATE_HTML is set to YES.
12071453
12081454 TREEVIEW_WIDTH = 250
12091455
1210-# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1211-# links to external symbols imported via tag files in a separate window.
1456+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1457+# external symbols imported via tag files in a separate window.
1458+# The default value is: NO.
1459+# This tag requires that the tag GENERATE_HTML is set to YES.
12121460
12131461 EXT_LINKS_IN_WINDOW = NO
12141462
1215-# Use this tag to change the font size of Latex formulas included
1216-# as images in the HTML documentation. The default is 10. Note that
1217-# when you change the font size after a successful doxygen run you need
1218-# to manually remove any form_*.png images from the HTML output directory
1219-# to force them to be regenerated.
1463+# Use this tag to change the font size of LaTeX formulas included as images in
1464+# the HTML documentation. When you change the font size after a successful
1465+# doxygen run you need to manually remove any form_*.png images from the HTML
1466+# output directory to force them to be regenerated.
1467+# Minimum value: 8, maximum value: 50, default value: 10.
1468+# This tag requires that the tag GENERATE_HTML is set to YES.
12201469
12211470 FORMULA_FONTSIZE = 10
12221471
1223-# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1224-# generated for formulas are transparent PNGs. Transparent PNGs are
1225-# not supported properly for IE 6.0, but are supported on all modern browsers.
1226-# Note that when changing this option you need to delete any form_*.png files
1227-# in the HTML output before the changes have effect.
1472+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1473+# generated for formulas are transparent PNGs. Transparent PNGs are not
1474+# supported properly for IE 6.0, but are supported on all modern browsers.
1475+#
1476+# Note that when changing this option you need to delete any form_*.png files in
1477+# the HTML output directory before the changes have effect.
1478+# The default value is: YES.
1479+# This tag requires that the tag GENERATE_HTML is set to YES.
12281480
12291481 FORMULA_TRANSPARENT = YES
12301482
1231-# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1232-# (see http://www.mathjax.org) which uses client side Javascript for the
1233-# rendering instead of using prerendered bitmaps. Use this if you do not
1234-# have LaTeX installed or if you want to formulas look prettier in the HTML
1235-# output. When enabled you may also need to install MathJax separately and
1236-# configure the path to it using the MATHJAX_RELPATH option.
1483+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1484+# http://www.mathjax.org) which uses client side Javascript for the rendering
1485+# instead of using prerendered bitmaps. Use this if you do not have LaTeX
1486+# installed or if you want to formulas look prettier in the HTML output. When
1487+# enabled you may also need to install MathJax separately and configure the path
1488+# to it using the MATHJAX_RELPATH option.
1489+# The default value is: NO.
1490+# This tag requires that the tag GENERATE_HTML is set to YES.
12371491
12381492 USE_MATHJAX = NO
12391493
1240-# When MathJax is enabled you need to specify the location relative to the
1241-# HTML output directory using the MATHJAX_RELPATH option. The destination
1242-# directory should contain the MathJax.js script. For instance, if the mathjax
1243-# directory is located at the same level as the HTML output directory, then
1244-# MATHJAX_RELPATH should be ../mathjax. The default value points to
1245-# the MathJax Content Delivery Network so you can quickly see the result without
1246-# installing MathJax. However, it is strongly recommended to install a local
1247-# copy of MathJax from http://www.mathjax.org before deployment.
1494+# When MathJax is enabled you can set the default output format to be used for
1495+# the MathJax output. See the MathJax site (see:
1496+# http://docs.mathjax.org/en/latest/output.html) for more details.
1497+# Possible values are: HTML-CSS (which is slower, but has the best
1498+# compatibility), NativeMML (i.e. MathML) and SVG.
1499+# The default value is: HTML-CSS.
1500+# This tag requires that the tag USE_MATHJAX is set to YES.
1501+
1502+MATHJAX_FORMAT = HTML-CSS
1503+
1504+# When MathJax is enabled you need to specify the location relative to the HTML
1505+# output directory using the MATHJAX_RELPATH option. The destination directory
1506+# should contain the MathJax.js script. For instance, if the mathjax directory
1507+# is located at the same level as the HTML output directory, then
1508+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1509+# Content Delivery Network so you can quickly see the result without installing
1510+# MathJax. However, it is strongly recommended to install a local copy of
1511+# MathJax from http://www.mathjax.org before deployment.
1512+# The default value is: http://cdn.mathjax.org/mathjax/latest.
1513+# This tag requires that the tag USE_MATHJAX is set to YES.
12481514
12491515 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
12501516
1251-# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1252-# names that should be enabled during MathJax rendering.
1517+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1518+# extension names that should be enabled during MathJax rendering. For example
1519+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1520+# This tag requires that the tag USE_MATHJAX is set to YES.
12531521
12541522 MATHJAX_EXTENSIONS =
12551523
1256-# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1257-# for the HTML output. The underlying search engine uses javascript
1258-# and DHTML and should work on any modern browser. Note that when using
1259-# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1260-# (GENERATE_DOCSET) there is already a search function so this one should
1261-# typically be disabled. For large projects the javascript based search engine
1262-# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1524+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1525+# of code that will be used on startup of the MathJax code. See the MathJax site
1526+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1527+# example see the documentation.
1528+# This tag requires that the tag USE_MATHJAX is set to YES.
1529+
1530+MATHJAX_CODEFILE =
1531+
1532+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1533+# the HTML output. The underlying search engine uses javascript and DHTML and
1534+# should work on any modern browser. Note that when using HTML help
1535+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1536+# there is already a search function so this one should typically be disabled.
1537+# For large projects the javascript based search engine can be slow, then
1538+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1539+# search using the keyboard; to jump to the search box use <access key> + S
1540+# (what the <access key> is depends on the OS and browser, but it is typically
1541+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1542+# key> to jump into the search results window, the results can be navigated
1543+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1544+# the search. The filter options can be selected when the cursor is inside the
1545+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1546+# to select a filter and <Enter> or <escape> to activate or cancel the filter
1547+# option.
1548+# The default value is: YES.
1549+# This tag requires that the tag GENERATE_HTML is set to YES.
12631550
12641551 SEARCHENGINE = YES
12651552
1266-# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1267-# implemented using a PHP enabled web server instead of at the web client
1268-# using Javascript. Doxygen will generate the search PHP script and index
1269-# file to put on the web server. The advantage of the server
1270-# based approach is that it scales better to large projects and allows
1271-# full text search. The disadvantages are that it is more difficult to setup
1272-# and does not have live searching capabilities.
1553+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1554+# implemented using a web server instead of a web client using Javascript. There
1555+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1556+# setting. When disabled, doxygen will generate a PHP script for searching and
1557+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1558+# and searching needs to be provided by external tools. See the section
1559+# "External Indexing and Searching" for details.
1560+# The default value is: NO.
1561+# This tag requires that the tag SEARCHENGINE is set to YES.
12731562
12741563 SERVER_BASED_SEARCH = NO
12751564
1565+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1566+# script for searching. Instead the search results are written to an XML file
1567+# which needs to be processed by an external indexer. Doxygen will invoke an
1568+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1569+# search results.
1570+#
1571+# Doxygen ships with an example indexer ( doxyindexer) and search engine
1572+# (doxysearch.cgi) which are based on the open source search engine library
1573+# Xapian (see: http://xapian.org/).
1574+#
1575+# See the section "External Indexing and Searching" for details.
1576+# The default value is: NO.
1577+# This tag requires that the tag SEARCHENGINE is set to YES.
1578+
1579+EXTERNAL_SEARCH = NO
1580+
1581+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1582+# which will return the search results when EXTERNAL_SEARCH is enabled.
1583+#
1584+# Doxygen ships with an example indexer ( doxyindexer) and search engine
1585+# (doxysearch.cgi) which are based on the open source search engine library
1586+# Xapian (see: http://xapian.org/). See the section "External Indexing and
1587+# Searching" for details.
1588+# This tag requires that the tag SEARCHENGINE is set to YES.
1589+
1590+SEARCHENGINE_URL =
1591+
1592+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1593+# search data is written to a file for indexing by an external tool. With the
1594+# SEARCHDATA_FILE tag the name of this file can be specified.
1595+# The default file is: searchdata.xml.
1596+# This tag requires that the tag SEARCHENGINE is set to YES.
1597+
1598+SEARCHDATA_FILE = searchdata.xml
1599+
1600+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1601+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1602+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1603+# projects and redirect the results back to the right project.
1604+# This tag requires that the tag SEARCHENGINE is set to YES.
1605+
1606+EXTERNAL_SEARCH_ID =
1607+
1608+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1609+# projects other than the one defined by this configuration file, but that are
1610+# all added to the same external search index. Each project needs to have a
1611+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1612+# to a relative location where the documentation can be found. The format is:
1613+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1614+# This tag requires that the tag SEARCHENGINE is set to YES.
1615+
1616+EXTRA_SEARCH_MAPPINGS =
1617+
12761618 #---------------------------------------------------------------------------
1277-# configuration options related to the LaTeX output
1619+# Configuration options related to the LaTeX output
12781620 #---------------------------------------------------------------------------
12791621
1280-# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1281-# generate Latex output.
1622+# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1623+# The default value is: YES.
12821624
12831625 GENERATE_LATEX = NO
12841626
1285-# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1286-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1287-# put in front of it. If left blank `latex' will be used as the default path.
1627+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1628+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1629+# it.
1630+# The default directory is: latex.
1631+# This tag requires that the tag GENERATE_LATEX is set to YES.
12881632
12891633 LATEX_OUTPUT = latex
12901634
1291-# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1292-# invoked. If left blank `latex' will be used as the default command name.
1293-# Note that when enabling USE_PDFLATEX this option is only used for
1294-# generating bitmaps for formulas in the HTML output, but not in the
1295-# Makefile that is written to the output directory.
1635+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1636+# invoked.
1637+#
1638+# Note that when enabling USE_PDFLATEX this option is only used for generating
1639+# bitmaps for formulas in the HTML output, but not in the Makefile that is
1640+# written to the output directory.
1641+# The default file is: latex.
1642+# This tag requires that the tag GENERATE_LATEX is set to YES.
12961643
12971644 LATEX_CMD_NAME = latex
12981645
1299-# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1300-# generate index for LaTeX. If left blank `makeindex' will be used as the
1301-# default command name.
1646+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1647+# index for LaTeX.
1648+# The default file is: makeindex.
1649+# This tag requires that the tag GENERATE_LATEX is set to YES.
13021650
13031651 MAKEINDEX_CMD_NAME = makeindex
13041652
1305-# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1306-# LaTeX documents. This may be useful for small projects and may help to
1307-# save some trees in general.
1653+# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1654+# documents. This may be useful for small projects and may help to save some
1655+# trees in general.
1656+# The default value is: NO.
1657+# This tag requires that the tag GENERATE_LATEX is set to YES.
13081658
13091659 COMPACT_LATEX = NO
13101660
1311-# The PAPER_TYPE tag can be used to set the paper type that is used
1312-# by the printer. Possible values are: a4, letter, legal and
1313-# executive. If left blank a4wide will be used.
1661+# The PAPER_TYPE tag can be used to set the paper type that is used by the
1662+# printer.
1663+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1664+# 14 inches) and executive (7.25 x 10.5 inches).
1665+# The default value is: a4.
1666+# This tag requires that the tag GENERATE_LATEX is set to YES.
13141667
13151668 PAPER_TYPE = a4
13161669
1317-# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1318-# packages that should be included in the LaTeX output.
1670+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1671+# that should be included in the LaTeX output. To get the times font for
1672+# instance you can specify
1673+# EXTRA_PACKAGES=times
1674+# If left blank no extra packages will be included.
1675+# This tag requires that the tag GENERATE_LATEX is set to YES.
13191676
13201677 EXTRA_PACKAGES =
13211678
1322-# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1323-# the generated latex document. The header should contain everything until
1324-# the first chapter. If it is left blank doxygen will generate a
1325-# standard header. Notice: only use this tag if you know what you are doing!
1679+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1680+# generated LaTeX document. The header should contain everything until the first
1681+# chapter. If it is left blank doxygen will generate a standard header. See
1682+# section "Doxygen usage" for information on how to let doxygen write the
1683+# default header to a separate file.
1684+#
1685+# Note: Only use a user-defined header if you know what you are doing! The
1686+# following commands have a special meaning inside the header: $title,
1687+# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1688+# replace them by respectively the title of the page, the current date and time,
1689+# only the current date, the version number of doxygen, the project name (see
1690+# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1691+# This tag requires that the tag GENERATE_LATEX is set to YES.
13261692
13271693 LATEX_HEADER =
13281694
1329-# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1330-# the generated latex document. The footer should contain everything after
1331-# the last chapter. If it is left blank doxygen will generate a
1332-# standard footer. Notice: only use this tag if you know what you are doing!
1695+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1696+# generated LaTeX document. The footer should contain everything after the last
1697+# chapter. If it is left blank doxygen will generate a standard footer.
1698+#
1699+# Note: Only use a user-defined footer if you know what you are doing!
1700+# This tag requires that the tag GENERATE_LATEX is set to YES.
13331701
13341702 LATEX_FOOTER =
13351703
1336-# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1337-# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1338-# contain links (just like the HTML output) instead of page references
1339-# This makes the output suitable for online browsing using a pdf viewer.
1704+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1705+# other source files which should be copied to the LATEX_OUTPUT output
1706+# directory. Note that the files will be copied as-is; there are no commands or
1707+# markers available.
1708+# This tag requires that the tag GENERATE_LATEX is set to YES.
1709+
1710+LATEX_EXTRA_FILES =
1711+
1712+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1713+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1714+# contain links (just like the HTML output) instead of page references. This
1715+# makes the output suitable for online browsing using a PDF viewer.
1716+# The default value is: YES.
1717+# This tag requires that the tag GENERATE_LATEX is set to YES.
13401718
13411719 PDF_HYPERLINKS = YES
13421720
1343-# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1344-# plain latex in the generated Makefile. Set this option to YES to get a
1721+# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1722+# the PDF file directly from the LaTeX files. Set this option to YES to get a
13451723 # higher quality PDF documentation.
1724+# The default value is: YES.
1725+# This tag requires that the tag GENERATE_LATEX is set to YES.
13461726
13471727 USE_PDFLATEX = YES
13481728
1349-# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1350-# command to the generated LaTeX files. This will instruct LaTeX to keep
1351-# running if errors occur, instead of asking the user for help.
1352-# This option is also used when generating formulas in HTML.
1729+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1730+# command to the generated LaTeX files. This will instruct LaTeX to keep running
1731+# if errors occur, instead of asking the user for help. This option is also used
1732+# when generating formulas in HTML.
1733+# The default value is: NO.
1734+# This tag requires that the tag GENERATE_LATEX is set to YES.
13531735
13541736 LATEX_BATCHMODE = NO
13551737
1356-# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1357-# include the index chapters (such as File Index, Compound Index, etc.)
1358-# in the output.
1738+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1739+# index chapters (such as File Index, Compound Index, etc.) in the output.
1740+# The default value is: NO.
1741+# This tag requires that the tag GENERATE_LATEX is set to YES.
13591742
13601743 LATEX_HIDE_INDICES = NO
13611744
1362-# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1363-# source code with syntax highlighting in the LaTeX output.
1364-# Note that which sources are shown also depends on other settings
1365-# such as SOURCE_BROWSER.
1745+# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1746+# code with syntax highlighting in the LaTeX output.
1747+#
1748+# Note that which sources are shown also depends on other settings such as
1749+# SOURCE_BROWSER.
1750+# The default value is: NO.
1751+# This tag requires that the tag GENERATE_LATEX is set to YES.
13661752
13671753 LATEX_SOURCE_CODE = NO
13681754
1369-# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1370-# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1371-# http://en.wikipedia.org/wiki/BibTeX for more info.
1755+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1756+# bibliography, e.g. plainnat, or ieeetr. See
1757+# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1758+# The default value is: plain.
1759+# This tag requires that the tag GENERATE_LATEX is set to YES.
13721760
13731761 LATEX_BIB_STYLE = plain
13741762
13751763 #---------------------------------------------------------------------------
1376-# configuration options related to the RTF output
1764+# Configuration options related to the RTF output
13771765 #---------------------------------------------------------------------------
13781766
1379-# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1380-# The RTF output is optimized for Word 97 and may not look very pretty with
1381-# other RTF readers or editors.
1767+# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1768+# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1769+# readers/editors.
1770+# The default value is: NO.
13821771
13831772 GENERATE_RTF = NO
13841773
1385-# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1386-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1387-# put in front of it. If left blank `rtf' will be used as the default path.
1774+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1775+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1776+# it.
1777+# The default directory is: rtf.
1778+# This tag requires that the tag GENERATE_RTF is set to YES.
13881779
13891780 RTF_OUTPUT = rtf
13901781
1391-# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1392-# RTF documents. This may be useful for small projects and may help to
1393-# save some trees in general.
1782+# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1783+# documents. This may be useful for small projects and may help to save some
1784+# trees in general.
1785+# The default value is: NO.
1786+# This tag requires that the tag GENERATE_RTF is set to YES.
13941787
13951788 COMPACT_RTF = NO
13961789
1397-# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1398-# will contain hyperlink fields. The RTF file will
1399-# contain links (just like the HTML output) instead of page references.
1400-# This makes the output suitable for online browsing using WORD or other
1401-# programs which support those fields.
1402-# Note: wordpad (write) and others do not support links.
1790+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1791+# contain hyperlink fields. The RTF file will contain links (just like the HTML
1792+# output) instead of page references. This makes the output suitable for online
1793+# browsing using Word or some other Word compatible readers that support those
1794+# fields.
1795+#
1796+# Note: WordPad (write) and others do not support links.
1797+# The default value is: NO.
1798+# This tag requires that the tag GENERATE_RTF is set to YES.
14031799
14041800 RTF_HYPERLINKS = NO
14051801
1406-# Load style sheet definitions from file. Syntax is similar to doxygen's
1407-# config file, i.e. a series of assignments. You only have to provide
1408-# replacements, missing definitions are set to their default value.
1802+# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1803+# file, i.e. a series of assignments. You only have to provide replacements,
1804+# missing definitions are set to their default value.
1805+#
1806+# See also section "Doxygen usage" for information on how to generate the
1807+# default style sheet that doxygen normally uses.
1808+# This tag requires that the tag GENERATE_RTF is set to YES.
14091809
14101810 RTF_STYLESHEET_FILE =
14111811
1412-# Set optional variables used in the generation of an rtf document.
1413-# Syntax is similar to doxygen's config file.
1812+# Set optional variables used in the generation of an RTF document. Syntax is
1813+# similar to doxygen's config file. A template extensions file can be generated
1814+# using doxygen -e rtf extensionFile.
1815+# This tag requires that the tag GENERATE_RTF is set to YES.
14141816
14151817 RTF_EXTENSIONS_FILE =
14161818
14171819 #---------------------------------------------------------------------------
1418-# configuration options related to the man page output
1820+# Configuration options related to the man page output
14191821 #---------------------------------------------------------------------------
14201822
1421-# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1422-# generate man pages
1823+# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1824+# classes and files.
1825+# The default value is: NO.
14231826
14241827 GENERATE_MAN = NO
14251828
1426-# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1427-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1428-# put in front of it. If left blank `man' will be used as the default path.
1829+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1830+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1831+# it. A directory man3 will be created inside the directory specified by
1832+# MAN_OUTPUT.
1833+# The default directory is: man.
1834+# This tag requires that the tag GENERATE_MAN is set to YES.
14291835
14301836 MAN_OUTPUT = man
14311837
1432-# The MAN_EXTENSION tag determines the extension that is added to
1433-# the generated man pages (default is the subroutine's section .3)
1838+# The MAN_EXTENSION tag determines the extension that is added to the generated
1839+# man pages. In case the manual section does not start with a number, the number
1840+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1841+# optional.
1842+# The default value is: .3.
1843+# This tag requires that the tag GENERATE_MAN is set to YES.
14341844
14351845 MAN_EXTENSION = .3
14361846
1437-# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1438-# then it will generate one additional man file for each entity
1439-# documented in the real man page(s). These additional files
1440-# only source the real man page, but without them the man command
1441-# would be unable to find the correct page. The default is NO.
1847+# The MAN_SUBDIR tag determines the name of the directory created within
1848+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1849+# MAN_EXTENSION with the initial . removed.
1850+# This tag requires that the tag GENERATE_MAN is set to YES.
1851+
1852+MAN_SUBDIR =
1853+
1854+# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1855+# will generate one additional man file for each entity documented in the real
1856+# man page(s). These additional files only source the real man page, but without
1857+# them the man command would be unable to find the correct page.
1858+# The default value is: NO.
1859+# This tag requires that the tag GENERATE_MAN is set to YES.
14421860
14431861 MAN_LINKS = NO
14441862
14451863 #---------------------------------------------------------------------------
1446-# configuration options related to the XML output
1864+# Configuration options related to the XML output
14471865 #---------------------------------------------------------------------------
14481866
1449-# If the GENERATE_XML tag is set to YES Doxygen will
1450-# generate an XML file that captures the structure of
1451-# the code including all documentation.
1867+# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1868+# captures the structure of the code including all documentation.
1869+# The default value is: NO.
14521870
14531871 GENERATE_XML = NO
14541872
1455-# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1456-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1457-# put in front of it. If left blank `xml' will be used as the default path.
1873+# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1874+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1875+# it.
1876+# The default directory is: xml.
1877+# This tag requires that the tag GENERATE_XML is set to YES.
14581878
14591879 XML_OUTPUT = xml
14601880
1461-# The XML_SCHEMA tag can be used to specify an XML schema,
1462-# which can be used by a validating XML parser to check the
1463-# syntax of the XML files.
1464-
1465-XML_SCHEMA =
1466-
1467-# The XML_DTD tag can be used to specify an XML DTD,
1468-# which can be used by a validating XML parser to check the
1469-# syntax of the XML files.
1470-
1471-XML_DTD =
1472-
1473-# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1474-# dump the program listings (including syntax highlighting
1475-# and cross-referencing information) to the XML output. Note that
1476-# enabling this will significantly increase the size of the XML output.
1881+# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1882+# listings (including syntax highlighting and cross-referencing information) to
1883+# the XML output. Note that enabling this will significantly increase the size
1884+# of the XML output.
1885+# The default value is: YES.
1886+# This tag requires that the tag GENERATE_XML is set to YES.
14771887
14781888 XML_PROGRAMLISTING = YES
14791889
14801890 #---------------------------------------------------------------------------
1481-# configuration options for the AutoGen Definitions output
1891+# Configuration options related to the DOCBOOK output
14821892 #---------------------------------------------------------------------------
14831893
1484-# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1485-# generate an AutoGen Definitions (see autogen.sf.net) file
1486-# that captures the structure of the code including all
1487-# documentation. Note that this feature is still experimental
1488-# and incomplete at the moment.
1894+# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1895+# that can be used to generate PDF.
1896+# The default value is: NO.
1897+
1898+GENERATE_DOCBOOK = NO
1899+
1900+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1901+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1902+# front of it.
1903+# The default directory is: docbook.
1904+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1905+
1906+DOCBOOK_OUTPUT = docbook
1907+
1908+#---------------------------------------------------------------------------
1909+# Configuration options for the AutoGen Definitions output
1910+#---------------------------------------------------------------------------
1911+
1912+# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1913+# Definitions (see http://autogen.sf.net) file that captures the structure of
1914+# the code including all documentation. Note that this feature is still
1915+# experimental and incomplete at the moment.
1916+# The default value is: NO.
14891917
14901918 GENERATE_AUTOGEN_DEF = NO
14911919
14921920 #---------------------------------------------------------------------------
1493-# configuration options related to the Perl module output
1921+# Configuration options related to the Perl module output
14941922 #---------------------------------------------------------------------------
14951923
1496-# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1497-# generate a Perl module file that captures the structure of
1498-# the code including all documentation. Note that this
1499-# feature is still experimental and incomplete at the
1500-# moment.
1924+# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1925+# file that captures the structure of the code including all documentation.
1926+#
1927+# Note that this feature is still experimental and incomplete at the moment.
1928+# The default value is: NO.
15011929
15021930 GENERATE_PERLMOD = NO
15031931
1504-# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1505-# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1506-# to generate PDF and DVI output from the Perl module output.
1932+# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1933+# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1934+# output from the Perl module output.
1935+# The default value is: NO.
1936+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
15071937
15081938 PERLMOD_LATEX = NO
15091939
1510-# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1511-# nicely formatted so it can be parsed by a human reader. This is useful
1512-# if you want to understand what is going on. On the other hand, if this
1513-# tag is set to NO the size of the Perl module output will be much smaller
1514-# and Perl will parse it just the same.
1940+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1941+# formatted so it can be parsed by a human reader. This is useful if you want to
1942+# understand what is going on. On the other hand, if this tag is set to NO the
1943+# size of the Perl module output will be much smaller and Perl will parse it
1944+# just the same.
1945+# The default value is: YES.
1946+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
15151947
15161948 PERLMOD_PRETTY = YES
15171949
1518-# The names of the make variables in the generated doxyrules.make file
1519-# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1520-# This is useful so different doxyrules.make files included by the same
1521-# Makefile don't overwrite each other's variables.
1950+# The names of the make variables in the generated doxyrules.make file are
1951+# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1952+# so different doxyrules.make files included by the same Makefile don't
1953+# overwrite each other's variables.
1954+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
15221955
15231956 PERLMOD_MAKEVAR_PREFIX =
15241957
@@ -1526,104 +1959,128 @@
15261959 # Configuration options related to the preprocessor
15271960 #---------------------------------------------------------------------------
15281961
1529-# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1530-# evaluate all C-preprocessor directives found in the sources and include
1531-# files.
1962+# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1963+# C-preprocessor directives found in the sources and include files.
1964+# The default value is: YES.
15321965
15331966 ENABLE_PREPROCESSING = YES
15341967
1535-# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1536-# names in the source code. If set to NO (the default) only conditional
1537-# compilation will be performed. Macro expansion can be done in a controlled
1538-# way by setting EXPAND_ONLY_PREDEF to YES.
1968+# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1969+# in the source code. If set to NO only conditional compilation will be
1970+# performed. Macro expansion can be done in a controlled way by setting
1971+# EXPAND_ONLY_PREDEF to YES.
1972+# The default value is: NO.
1973+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
15391974
15401975 MACRO_EXPANSION = YES
15411976
1542-# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1543-# then the macro expansion is limited to the macros specified with the
1544-# PREDEFINED and EXPAND_AS_DEFINED tags.
1977+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1978+# the macro expansion is limited to the macros specified with the PREDEFINED and
1979+# EXPAND_AS_DEFINED tags.
1980+# The default value is: NO.
1981+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
15451982
15461983 EXPAND_ONLY_PREDEF = NO
15471984
1548-# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1549-# pointed to by INCLUDE_PATH will be searched when a #include is found.
1985+# If the SEARCH_INCLUDES tag is set to YES the includes files in the
1986+# INCLUDE_PATH will be searched if a #include is found.
1987+# The default value is: YES.
1988+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
15501989
15511990 SEARCH_INCLUDES = YES
15521991
1553-# The INCLUDE_PATH tag can be used to specify one or more directories that
1554-# contain include files that are not input files but should be processed by
1555-# the preprocessor.
1992+# The INCLUDE_PATH tag can be used to specify one or more directories that
1993+# contain include files that are not input files but should be processed by the
1994+# preprocessor.
1995+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
15561996
15571997 INCLUDE_PATH =
15581998
1559-# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1560-# patterns (like *.h and *.hpp) to filter out the header-files in the
1561-# directories. If left blank, the patterns specified with FILE_PATTERNS will
1562-# be used.
1999+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2000+# patterns (like *.h and *.hpp) to filter out the header-files in the
2001+# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2002+# used.
2003+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
15632004
15642005 INCLUDE_FILE_PATTERNS =
15652006
1566-# The PREDEFINED tag can be used to specify one or more macro names that
1567-# are defined before the preprocessor is started (similar to the -D option of
1568-# gcc). The argument of the tag is a list of macros of the form: name
1569-# or name=definition (no spaces). If the definition and the = are
1570-# omitted =1 is assumed. To prevent a macro definition from being
1571-# undefined via #undef or recursively expanded use the := operator
1572-# instead of the = operator.
2007+# The PREDEFINED tag can be used to specify one or more macro names that are
2008+# defined before the preprocessor is started (similar to the -D option of e.g.
2009+# gcc). The argument of the tag is a list of macros of the form: name or
2010+# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2011+# is assumed. To prevent a macro definition from being undefined via #undef or
2012+# recursively expanded use the := operator instead of the = operator.
2013+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
15732014
15742015 PREDEFINED =
15752016
1576-# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1577-# this tag can be used to specify a list of macro names that should be expanded.
1578-# The macro definition that is found in the sources will be used.
1579-# Use the PREDEFINED tag if you want to use a different macro definition that
1580-# overrules the definition found in the source code.
2017+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2018+# tag can be used to specify a list of macro names that should be expanded. The
2019+# macro definition that is found in the sources will be used. Use the PREDEFINED
2020+# tag if you want to use a different macro definition that overrules the
2021+# definition found in the source code.
2022+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
15812023
15822024 EXPAND_AS_DEFINED =
15832025
1584-# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1585-# doxygen's preprocessor will remove all references to function-like macros
1586-# that are alone on a line, have an all uppercase name, and do not end with a
1587-# semicolon, because these will confuse the parser if not removed.
2026+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2027+# remove all references to function-like macros that are alone on a line, have
2028+# an all uppercase name, and do not end with a semicolon. Such function macros
2029+# are typically used for boiler-plate code, and will confuse the parser if not
2030+# removed.
2031+# The default value is: YES.
2032+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
15882033
15892034 SKIP_FUNCTION_MACROS = YES
15902035
15912036 #---------------------------------------------------------------------------
1592-# Configuration::additions related to external references
2037+# Configuration options related to external references
15932038 #---------------------------------------------------------------------------
15942039
1595-# The TAGFILES option can be used to specify one or more tagfiles. For each
1596-# tag file the location of the external documentation should be added. The
1597-# format of a tag file without this location is as follows:
1598-# TAGFILES = file1 file2 ...
1599-# Adding location for the tag files is done as follows:
1600-# TAGFILES = file1=loc1 "file2 = loc2" ...
1601-# where "loc1" and "loc2" can be relative or absolute paths
1602-# or URLs. Note that each tag file must have a unique name (where the name does
1603-# NOT include the path). If a tag file is not located in the directory in which
1604-# doxygen is run, you must also specify the path to the tagfile here.
2040+# The TAGFILES tag can be used to specify one or more tag files. For each tag
2041+# file the location of the external documentation should be added. The format of
2042+# a tag file without this location is as follows:
2043+# TAGFILES = file1 file2 ...
2044+# Adding location for the tag files is done as follows:
2045+# TAGFILES = file1=loc1 "file2 = loc2" ...
2046+# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2047+# section "Linking to external documentation" for more information about the use
2048+# of tag files.
2049+# Note: Each tag file must have a unique name (where the name does NOT include
2050+# the path). If a tag file is not located in the directory in which doxygen is
2051+# run, you must also specify the path to the tagfile here.
16052052
16062053 TAGFILES =
16072054
1608-# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1609-# a tag file that is based on the input files it reads.
2055+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2056+# tag file that is based on the input files it reads. See section "Linking to
2057+# external documentation" for more information about the usage of tag files.
16102058
16112059 GENERATE_TAGFILE =
16122060
1613-# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1614-# in the class index. If set to NO only the inherited external classes
1615-# will be listed.
2061+# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2062+# class index. If set to NO only the inherited external classes will be listed.
2063+# The default value is: NO.
16162064
16172065 ALLEXTERNALS = NO
16182066
1619-# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1620-# in the modules index. If set to NO, only the current project's groups will
1621-# be listed.
2067+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2068+# the modules index. If set to NO, only the current project's groups will be
2069+# listed.
2070+# The default value is: YES.
16222071
16232072 EXTERNAL_GROUPS = YES
16242073
1625-# The PERL_PATH should be the absolute path and name of the perl script
1626-# interpreter (i.e. the result of `which perl').
2074+# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2075+# the related pages index. If set to NO, only the current project's pages will
2076+# be listed.
2077+# The default value is: YES.
2078+
2079+EXTERNAL_PAGES = YES
2080+
2081+# The PERL_PATH should be the absolute path and name of the perl script
2082+# interpreter (i.e. the result of 'which perl').
2083+# The default file (with absolute path) is: /usr/bin/perl.
16272084
16282085 PERL_PATH = /usr/bin/perl
16292086
@@ -1631,222 +2088,293 @@
16312088 # Configuration options related to the dot tool
16322089 #---------------------------------------------------------------------------
16332090
1634-# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1635-# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1636-# or super classes. Setting the tag to NO turns the diagrams off. Note that
1637-# this option also works with HAVE_DOT disabled, but it is recommended to
1638-# install and use dot, since it yields more powerful graphs.
2091+# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2092+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2093+# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2094+# disabled, but it is recommended to install and use dot, since it yields more
2095+# powerful graphs.
2096+# The default value is: YES.
16392097
16402098 CLASS_DIAGRAMS = YES
16412099
1642-# You can define message sequence charts within doxygen comments using the \msc
1643-# command. Doxygen will then run the mscgen tool (see
1644-# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1645-# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1646-# the mscgen tool resides. If left empty the tool is assumed to be found in the
2100+# You can define message sequence charts within doxygen comments using the \msc
2101+# command. Doxygen will then run the mscgen tool (see:
2102+# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2103+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2104+# the mscgen tool resides. If left empty the tool is assumed to be found in the
16472105 # default search path.
16482106
16492107 MSCGEN_PATH =
16502108
1651-# If set to YES, the inheritance and collaboration graphs will hide
1652-# inheritance and usage relations if the target is undocumented
1653-# or is not a class.
2109+# You can include diagrams made with dia in doxygen documentation. Doxygen will
2110+# then run dia to produce the diagram and insert it in the documentation. The
2111+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2112+# If left empty dia is assumed to be found in the default search path.
2113+
2114+DIA_PATH =
2115+
2116+# If set to YES, the inheritance and collaboration graphs will hide inheritance
2117+# and usage relations if the target is undocumented or is not a class.
2118+# The default value is: YES.
16542119
16552120 HIDE_UNDOC_RELATIONS = YES
16562121
1657-# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1658-# available from the path. This tool is part of Graphviz, a graph visualization
1659-# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1660-# have no effect if this option is set to NO (the default)
2122+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2123+# available from the path. This tool is part of Graphviz (see:
2124+# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2125+# Bell Labs. The other options in this section have no effect if this option is
2126+# set to NO
2127+# The default value is: NO.
16612128
16622129 HAVE_DOT = YES
16632130
1664-# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1665-# allowed to run in parallel. When set to 0 (the default) doxygen will
1666-# base this on the number of processors available in the system. You can set it
1667-# explicitly to a value larger than 0 to get control over the balance
1668-# between CPU load and processing speed.
2131+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2132+# to run in parallel. When set to 0 doxygen will base this on the number of
2133+# processors available in the system. You can set it explicitly to a value
2134+# larger than 0 to get control over the balance between CPU load and processing
2135+# speed.
2136+# Minimum value: 0, maximum value: 32, default value: 0.
2137+# This tag requires that the tag HAVE_DOT is set to YES.
16692138
16702139 DOT_NUM_THREADS = 0
16712140
1672-# By default doxygen will use the Helvetica font for all dot files that
1673-# doxygen generates. When you want a differently looking font you can specify
1674-# the font name using DOT_FONTNAME. You need to make sure dot is able to find
1675-# the font, which can be done by putting it in a standard location or by setting
1676-# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1677-# directory containing the font.
2141+# When you want a differently looking font n the dot files that doxygen
2142+# generates you can specify the font name using DOT_FONTNAME. You need to make
2143+# sure dot is able to find the font, which can be done by putting it in a
2144+# standard location or by setting the DOTFONTPATH environment variable or by
2145+# setting DOT_FONTPATH to the directory containing the font.
2146+# The default value is: Helvetica.
2147+# This tag requires that the tag HAVE_DOT is set to YES.
16782148
16792149 DOT_FONTNAME = FreeSans.ttf
16802150
1681-# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1682-# The default size is 10pt.
2151+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2152+# dot graphs.
2153+# Minimum value: 4, maximum value: 24, default value: 10.
2154+# This tag requires that the tag HAVE_DOT is set to YES.
16832155
16842156 DOT_FONTSIZE = 10
16852157
1686-# By default doxygen will tell dot to use the Helvetica font.
1687-# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1688-# set the path where dot can find it.
2158+# By default doxygen will tell dot to use the default font as specified with
2159+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2160+# the path where dot can find it using this tag.
2161+# This tag requires that the tag HAVE_DOT is set to YES.
16892162
16902163 DOT_FONTPATH =
16912164
1692-# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1693-# will generate a graph for each documented class showing the direct and
1694-# indirect inheritance relations. Setting this tag to YES will force the
1695-# CLASS_DIAGRAMS tag to NO.
2165+# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2166+# each documented class showing the direct and indirect inheritance relations.
2167+# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2168+# The default value is: YES.
2169+# This tag requires that the tag HAVE_DOT is set to YES.
16962170
16972171 CLASS_GRAPH = YES
16982172
1699-# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1700-# will generate a graph for each documented class showing the direct and
1701-# indirect implementation dependencies (inheritance, containment, and
1702-# class references variables) of the class with other documented classes.
2173+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2174+# graph for each documented class showing the direct and indirect implementation
2175+# dependencies (inheritance, containment, and class references variables) of the
2176+# class with other documented classes.
2177+# The default value is: YES.
2178+# This tag requires that the tag HAVE_DOT is set to YES.
17032179
17042180 COLLABORATION_GRAPH = YES
17052181
1706-# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1707-# will generate a graph for groups, showing the direct groups dependencies
2182+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2183+# groups, showing the direct groups dependencies.
2184+# The default value is: YES.
2185+# This tag requires that the tag HAVE_DOT is set to YES.
17082186
17092187 GROUP_GRAPHS = YES
17102188
1711-# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1712-# collaboration diagrams in a style similar to the OMG's Unified Modeling
2189+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2190+# collaboration diagrams in a style similar to the OMG's Unified Modeling
17132191 # Language.
2192+# The default value is: NO.
2193+# This tag requires that the tag HAVE_DOT is set to YES.
17142194
17152195 UML_LOOK = NO
17162196
1717-# If the UML_LOOK tag is enabled, the fields and methods are shown inside
1718-# the class node. If there are many fields or methods and many nodes the
1719-# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1720-# threshold limits the number of items for each type to make the size more
1721-# managable. Set this to 0 for no limit. Note that the threshold may be
1722-# exceeded by 50% before the limit is enforced.
2197+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2198+# class node. If there are many fields or methods and many nodes the graph may
2199+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2200+# number of items for each type to make the size more manageable. Set this to 0
2201+# for no limit. Note that the threshold may be exceeded by 50% before the limit
2202+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2203+# but if the number exceeds 15, the total amount of fields shown is limited to
2204+# 10.
2205+# Minimum value: 0, maximum value: 100, default value: 10.
2206+# This tag requires that the tag HAVE_DOT is set to YES.
17232207
17242208 UML_LIMIT_NUM_FIELDS = 10
17252209
1726-# If set to YES, the inheritance and collaboration graphs will show the
1727-# relations between templates and their instances.
2210+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2211+# collaboration graphs will show the relations between templates and their
2212+# instances.
2213+# The default value is: NO.
2214+# This tag requires that the tag HAVE_DOT is set to YES.
17282215
17292216 TEMPLATE_RELATIONS = NO
17302217
1731-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1732-# tags are set to YES then doxygen will generate a graph for each documented
1733-# file showing the direct and indirect include dependencies of the file with
1734-# other documented files.
2218+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2219+# YES then doxygen will generate a graph for each documented file showing the
2220+# direct and indirect include dependencies of the file with other documented
2221+# files.
2222+# The default value is: YES.
2223+# This tag requires that the tag HAVE_DOT is set to YES.
17352224
17362225 INCLUDE_GRAPH = YES
17372226
1738-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1739-# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1740-# documented header file showing the documented files that directly or
1741-# indirectly include this file.
2227+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2228+# set to YES then doxygen will generate a graph for each documented file showing
2229+# the direct and indirect include dependencies of the file with other documented
2230+# files.
2231+# The default value is: YES.
2232+# This tag requires that the tag HAVE_DOT is set to YES.
17422233
17432234 INCLUDED_BY_GRAPH = YES
17442235
1745-# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1746-# doxygen will generate a call dependency graph for every global function
1747-# or class method. Note that enabling this option will significantly increase
1748-# the time of a run. So in most cases it will be better to enable call graphs
1749-# for selected functions only using the \callgraph command.
2236+# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2237+# dependency graph for every global function or class method.
2238+#
2239+# Note that enabling this option will significantly increase the time of a run.
2240+# So in most cases it will be better to enable call graphs for selected
2241+# functions only using the \callgraph command.
2242+# The default value is: NO.
2243+# This tag requires that the tag HAVE_DOT is set to YES.
17502244
17512245 CALL_GRAPH = YES
17522246
1753-# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1754-# doxygen will generate a caller dependency graph for every global function
1755-# or class method. Note that enabling this option will significantly increase
1756-# the time of a run. So in most cases it will be better to enable caller
1757-# graphs for selected functions only using the \callergraph command.
2247+# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2248+# dependency graph for every global function or class method.
2249+#
2250+# Note that enabling this option will significantly increase the time of a run.
2251+# So in most cases it will be better to enable caller graphs for selected
2252+# functions only using the \callergraph command.
2253+# The default value is: NO.
2254+# This tag requires that the tag HAVE_DOT is set to YES.
17582255
17592256 CALLER_GRAPH = YES
17602257
1761-# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1762-# will generate a graphical hierarchy of all classes instead of a textual one.
2258+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2259+# hierarchy of all classes instead of a textual one.
2260+# The default value is: YES.
2261+# This tag requires that the tag HAVE_DOT is set to YES.
17632262
17642263 GRAPHICAL_HIERARCHY = YES
17652264
1766-# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
1767-# then doxygen will show the dependencies a directory has on other directories
1768-# in a graphical way. The dependency relations are determined by the #include
1769-# relations between the files in the directories.
2265+# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2266+# dependencies a directory has on other directories in a graphical way. The
2267+# dependency relations are determined by the #include relations between the
2268+# files in the directories.
2269+# The default value is: YES.
2270+# This tag requires that the tag HAVE_DOT is set to YES.
17702271
17712272 DIRECTORY_GRAPH = YES
17722273
1773-# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1774-# generated by dot. Possible values are svg, png, jpg, or gif.
1775-# If left blank png will be used. If you choose svg you need to set
1776-# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1777-# visible in IE 9+ (other browsers do not have this requirement).
2274+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2275+# generated by dot.
2276+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2277+# to make the SVG files visible in IE 9+ (other browsers do not have this
2278+# requirement).
2279+# Possible values are: png, jpg, gif and svg.
2280+# The default value is: png.
2281+# This tag requires that the tag HAVE_DOT is set to YES.
17782282
17792283 DOT_IMAGE_FORMAT = png
17802284
1781-# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1782-# enable generation of interactive SVG images that allow zooming and panning.
1783-# Note that this requires a modern browser other than Internet Explorer.
1784-# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1785-# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1786-# visible. Older versions of IE do not have SVG support.
2285+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2286+# enable generation of interactive SVG images that allow zooming and panning.
2287+#
2288+# Note that this requires a modern browser other than Internet Explorer. Tested
2289+# and working are Firefox, Chrome, Safari, and Opera.
2290+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2291+# the SVG files visible. Older versions of IE do not have SVG support.
2292+# The default value is: NO.
2293+# This tag requires that the tag HAVE_DOT is set to YES.
17872294
17882295 INTERACTIVE_SVG = NO
17892296
1790-# The tag DOT_PATH can be used to specify the path where the dot tool can be
2297+# The DOT_PATH tag can be used to specify the path where the dot tool can be
17912298 # found. If left blank, it is assumed the dot tool can be found in the path.
2299+# This tag requires that the tag HAVE_DOT is set to YES.
17922300
17932301 DOT_PATH = "D:/Program Files (x86)/Graphviz2.27/bin"
17942302
1795-# The DOTFILE_DIRS tag can be used to specify one or more directories that
1796-# contain dot files that are included in the documentation (see the
1797-# \dotfile command).
2303+# The DOTFILE_DIRS tag can be used to specify one or more directories that
2304+# contain dot files that are included in the documentation (see the \dotfile
2305+# command).
2306+# This tag requires that the tag HAVE_DOT is set to YES.
17982307
17992308 DOTFILE_DIRS =
18002309
1801-# The MSCFILE_DIRS tag can be used to specify one or more directories that
1802-# contain msc files that are included in the documentation (see the
1803-# \mscfile command).
2310+# The MSCFILE_DIRS tag can be used to specify one or more directories that
2311+# contain msc files that are included in the documentation (see the \mscfile
2312+# command).
18042313
18052314 MSCFILE_DIRS =
18062315
1807-# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1808-# nodes that will be shown in the graph. If the number of nodes in a graph
1809-# becomes larger than this value, doxygen will truncate the graph, which is
1810-# visualized by representing a node as a red box. Note that doxygen if the
1811-# number of direct children of the root node in a graph is already larger than
1812-# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1813-# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2316+# The DIAFILE_DIRS tag can be used to specify one or more directories that
2317+# contain dia files that are included in the documentation (see the \diafile
2318+# command).
2319+
2320+DIAFILE_DIRS =
2321+
2322+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2323+# that will be shown in the graph. If the number of nodes in a graph becomes
2324+# larger than this value, doxygen will truncate the graph, which is visualized
2325+# by representing a node as a red box. Note that doxygen if the number of direct
2326+# children of the root node in a graph is already larger than
2327+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2328+# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2329+# Minimum value: 0, maximum value: 10000, default value: 50.
2330+# This tag requires that the tag HAVE_DOT is set to YES.
18142331
18152332 DOT_GRAPH_MAX_NODES = 50
18162333
1817-# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1818-# graphs generated by dot. A depth value of 3 means that only nodes reachable
1819-# from the root by following a path via at most 3 edges will be shown. Nodes
1820-# that lay further from the root node will be omitted. Note that setting this
1821-# option to 1 or 2 may greatly reduce the computation time needed for large
1822-# code bases. Also note that the size of a graph can be further restricted by
2334+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2335+# generated by dot. A depth value of 3 means that only nodes reachable from the
2336+# root by following a path via at most 3 edges will be shown. Nodes that lay
2337+# further from the root node will be omitted. Note that setting this option to 1
2338+# or 2 may greatly reduce the computation time needed for large code bases. Also
2339+# note that the size of a graph can be further restricted by
18232340 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2341+# Minimum value: 0, maximum value: 1000, default value: 0.
2342+# This tag requires that the tag HAVE_DOT is set to YES.
18242343
18252344 MAX_DOT_GRAPH_DEPTH = 0
18262345
1827-# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1828-# background. This is disabled by default, because dot on Windows does not
1829-# seem to support this out of the box. Warning: Depending on the platform used,
1830-# enabling this option may lead to badly anti-aliased labels on the edges of
1831-# a graph (i.e. they become hard to read).
2346+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2347+# background. This is disabled by default, because dot on Windows does not seem
2348+# to support this out of the box.
2349+#
2350+# Warning: Depending on the platform used, enabling this option may lead to
2351+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2352+# read).
2353+# The default value is: NO.
2354+# This tag requires that the tag HAVE_DOT is set to YES.
18322355
18332356 DOT_TRANSPARENT = NO
18342357
1835-# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1836-# files in one run (i.e. multiple -o and -T options on the command line). This
1837-# makes dot run faster, but since only newer versions of dot (>1.8.10)
1838-# support this, this feature is disabled by default.
2358+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2359+# files in one run (i.e. multiple -o and -T options on the command line). This
2360+# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2361+# this, this feature is disabled by default.
2362+# The default value is: NO.
2363+# This tag requires that the tag HAVE_DOT is set to YES.
18392364
18402365 DOT_MULTI_TARGETS = NO
18412366
1842-# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1843-# generate a legend page explaining the meaning of the various boxes and
1844-# arrows in the dot generated graphs.
2367+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2368+# explaining the meaning of the various boxes and arrows in the dot generated
2369+# graphs.
2370+# The default value is: YES.
2371+# This tag requires that the tag HAVE_DOT is set to YES.
18452372
18462373 GENERATE_LEGEND = YES
18472374
1848-# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1849-# remove the intermediate dot files that are used to generate
1850-# the various graphs.
2375+# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2376+# files that are used to generate the various graphs.
2377+# The default value is: YES.
2378+# This tag requires that the tag HAVE_DOT is set to YES.
18512379
18522380 DOT_CLEANUP = YES
diff -r ecd9d86036cc -r e5f859ac3f2c Readme.zh-CN.txt
--- a/Readme.zh-CN.txt Tue May 27 19:56:38 2014 +0800
+++ b/Readme.zh-CN.txt Fri May 30 00:38:19 2014 +0800
@@ -8,14 +8,17 @@
88
99 > 根目录结构和文件说明
1010 ====
11+以下只包括一级目录和少数特定的二级目录说明。
1112 /.git
12- Git 目录
13+ Git 目录(可通过 hg-git 同步)
1314 /.hg
1415 Mercurial 目录
1516 /3rdparty
1617 第三方依赖项
1718 /Data
1819 最终用户环境中部署的数据目录
20+/build
21+默认生成文件目录
1922 /doc
2023 开发文档
2124 /doc/vsd
@@ -26,13 +29,15 @@
2629 顶级子项目 YBase
2730 /YFramework
2831 顶级子项目 YFramework
29-/YSTest_ARM7
32+/YSTest/Android
33+示例项目 YReader 的 Android 平台项目(未完成正式支持)
34+/YSTest/DS_ARM7
3035 示例项目 YReader 的 ARM7 项目(仅用于 DS 平台,用于生成 ARM7 ELF 二进制映像)
31-/YSTest_ARM9
36+/YSTest/DS_ARM9
3237 示例项目 YReader 的 ARM9 项目(包括 DS 平台 ARM9 部分,于生成 ARM9 ELF 二进制映像;源代码和其它平台共享)
33-/YSTest_DS
38+/YSTest/DS
3439 示例项目 YReader 的 DS 平台可执行文件项目(仅用于 DS 平台,用于生成 NDS 文件)
35-/YSTest_MinGW32
40+/YSTest/MinGW32
3641 示例项目 YReader 的 MinGW32 平台可执行文件项目(仅用于 MinGW32 平台,用于生成 EXE 文件)
3742 /.hgignore
3843 Mercurial 忽略文件
@@ -64,7 +69,7 @@
6469 > 构建说明
6570 ====
6671 构建平台/宿主平台: Windows 或类 UNIX 系统。
67-目标平台: DS 和 MinGW32 。
72+目标平台: DS 和 MinGW32 。非正式支持 Android 。
6873 详细参见 doc/Designation.txt @5.1 。
6974 按 doc/Designation.txt @5.2.2 或 @5.2.3 下载搭建目标平台对应的开发环境。
7075 使用 Microsoft Visual Studio 2012 或以上版本打开 .sln (仅 Windows ;当前仅用于生成 DS 平台文件);
@@ -77,7 +82,12 @@
7782 DEVKITPRO = /F/devkitPro
7883 使用 Microsoft Visual Studio 打开文件,还需要以下环境变量以保证路径解析正确:
7984 DKP_HOME = F:\devkitPro
80-需要保证有可用的 UNIX shell ; Windows 下可能需要另外加入 devkitPro 安装目录下 msys/bin 至 %PATH% 。
85+需要保证有可用的 UNIX shell ; Windows 下可能需要另外加入 devkitPro 安装目录下 msys/bin 至 %PATH% 。可使用 MSys2 替代。
86+
87+ Android
88+==
89+未正式支持。
90+开发环境配置详见 doc/Designation.txt @5.2.6 。
8191
8292 其它
8393 ==
@@ -85,6 +95,42 @@
8595
8696 > YSLib PreAlpha 更新说明
8797 ====
98+2014-05-30(PreAlpha 5)
99+更改输出目录结构:目标文件和源代码分离。
100+添加 MinGW.org 支持(不用于发布)。
101+添加非正式的 Android 支持( YBase 外未完成)。
102+更新 Doxygen 文档忽略列表,启用短文件名设置以避免含有制表符的文件名导致生成失败。
103+[YBase]
104+添加 Microsoft Visual Studio C++ 2013 支持。
105+[YFramework]
106+添加 MIME 类型和扩展名映射。
107+修整光栅化接口和实现,修复未显示右下边界线段和矩形右下角的点。
108+限制部件渲染区域保证绘制区域被渲染一次而正确显示。
109+调整消息宏命名风格。
110+添加基于界面无效化的简单逐帧动画支持。
111+添加多页面图像读取支持(基于 FreeImage 独立实现)。
112+添加 MRU 缓存并应用于字形缓存的实现。
113+在包含中使用模块标识宏代替文件名的直接使用。
114+添加 MinGW.org 运行时支持。
115+按钮和单选框增加悬停控件状态并修改对应状态的外观。
116+单选框禁用时渲染为灰色外观。
117+添加视觉样式支持。
118+添加图像缓冲区转换和保存为文件。
119+未启用或隐藏的部件不响应键盘焦点。
120+添加级联焦点缓冲(通过多级容器和部件的焦点确定键盘焦点)。
121+添加本机按键编码分类和相关操作;支持更多虚拟按键。
122+添加 TextBox 和 TabControl 控件。
123+增强日志输出接口。
124+[MinGW32]
125+修复终止时栈溢出。
126+本机窗口增加消息映射。
127+[YReader]
128+更改部分按键。
129+添加界面风格设置。
130+更改项目目录结构。
131+添加界面动画、文本框和标签页测试。
132+阅读器设置界面使用标签页。
133+====
88134 2013-10-12(build 449)
89135 build 449 起使用 2-Clause BSD 许可证风格的条款进行基本授权。
90136 [Config]
diff -r ecd9d86036cc -r e5f859ac3f2c YFramework/YFramework.vcxproj
--- a/YFramework/YFramework.vcxproj Tue May 27 19:56:38 2014 +0800
+++ b/YFramework/YFramework.vcxproj Fri May 30 00:38:19 2014 +0800
@@ -326,6 +326,7 @@
326326 </ItemGroup>
327327 <ItemGroup>
328328 <Text Include="..\doc\ChangeLog.PreAlpha4.txt" />
329+ <Text Include="..\doc\ChangeLog.PreAlpha5.txt" />
329330 <Text Include="..\doc\NPL.txt" />
330331 <Text Include="..\doc\Workflow.Annual2013.txt" />
331332 <Text Include="..\doc\Workflow.Annual2014.txt" />
diff -r ecd9d86036cc -r e5f859ac3f2c YFramework/YFramework.vcxproj.filters
--- a/YFramework/YFramework.vcxproj.filters Tue May 27 19:56:38 2014 +0800
+++ b/YFramework/YFramework.vcxproj.filters Fri May 30 00:38:19 2014 +0800
@@ -1076,5 +1076,8 @@
10761076 <Text Include="..\doc\Workflow.Annual2014.txt">
10771077 <Filter>doc</Filter>
10781078 </Text>
1079+ <Text Include="..\doc\ChangeLog.PreAlpha5.txt">
1080+ <Filter>doc</Filter>
1081+ </Text>
10791082 </ItemGroup>
10801083 </Project>
\ No newline at end of file
diff -r ecd9d86036cc -r e5f859ac3f2c YFramework/include/YSLib/UI/ywidget.h
--- a/YFramework/include/YSLib/UI/ywidget.h Tue May 27 19:56:38 2014 +0800
+++ b/YFramework/include/YSLib/UI/ywidget.h Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file ywidget.h
1212 \ingroup UI
1313 \brief 样式无关的 GUI 部件。
14-\version r5676
14+\version r5683
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since 早于 build 132
1717 \par 创建时间:
1818 2009-11-16 20:06:58 +0800
1919 \par 修改时间:
20- 2014-05-23 10:15 +0800
20+ 2014-05-28 22:54 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -227,14 +227,6 @@
227227 Close(IWidget&);
228228
229229 /*!
230-\brief 在指定部件中心画箭头。
231-\since build 302
232-*/
233-YF_API void
234-DrawArrow(PaintEventArgs&&, IWidget&, SDst = 4, Drawing::Rotation
235- = Drawing::RDeg0, Drawing::Color = Drawing::ColorSpace::Black);
236-
237-/*!
238230 \brief 隐藏部件。
239231 \since build 229
240232 依次释放部件焦点、设置部件不可见性和无效化。
diff -r ecd9d86036cc -r e5f859ac3f2c YFramework/source/Helper/Initialization.cpp
--- a/YFramework/source/Helper/Initialization.cpp Tue May 27 19:56:38 2014 +0800
+++ b/YFramework/source/Helper/Initialization.cpp Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file Initialization.cpp
1212 \ingroup Helper
1313 \brief 程序启动时的通用初始化。
14-\version r1903
14+\version r1907
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since 早于 build 132
1717 \par 创建时间:
1818 2009-10-21 23:15:08 +0800
1919 \par 修改时间:
20- 2014-02-09 01:29 +0800
20+ 2014-05-29 19:19 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -100,12 +100,12 @@
100100 # define DEF_FONT_PATH ROOTW "/Font/FZYTK.TTF"
101101 # define DEF_FONT_DIRECTORY ROOTW "/Font/"
102102 #else
103-# define ROOTW "H:\\NDS\\EFSRoot"
104-# define DATA_DIRECTORY ROOTW "\\Data\\"
103+# define ROOTW "."
104+# define DATA_DIRECTORY ROOTW "\\"
105105 //const char* DEF_FONT_NAME = "方正姚体";
106106 //const char* DEF_FONT_PATH = ROOTW "\\Font\\FZYTK.TTF";
107-# define DEF_FONT_PATH ROOTW "\\Font\\FZYTK.TTF"
108-# define DEF_FONT_DIRECTORY ROOTW "\\Font\\"
107+# define DEF_FONT_PATH "C:\\Windows\\Fonts\\SimSun.ttc"
108+# define DEF_FONT_DIRECTORY ROOTW "\\"
109109 #endif
110110 #define CONF_PATH "yconf.txt"
111111
diff -r ecd9d86036cc -r e5f859ac3f2c YFramework/source/YSLib/UI/ComboList.cpp
--- a/YFramework/source/YSLib/UI/ComboList.cpp Tue May 27 19:56:38 2014 +0800
+++ b/YFramework/source/YSLib/UI/ComboList.cpp Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file ComboList.cpp
1212 \ingroup UI
1313 \brief 样式相关的图形用户界面组合列表控件。
14-\version r3169
14+\version r3170
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since build 282
1717 \par 创建时间:
1818 2011-03-07 20:33:05 +0800
1919 \par 修改时间:
20- 2014-04-25 10:09 +0800
20+ 2014-04-25 23:15 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -261,7 +261,7 @@
261261 Button::Refresh(std::move(e));
262262 csCurrent = cs;
263263 DrawArrow(e.Target, Rect(e.Location + Vec(GetWidth() - 16, 0),
264- Size(16, GetHeight())), 4, RDeg270, ForeColor);
264+ Size(16, GetHeight())) & e.ClipArea, 4, RDeg270, ForeColor);
265265 }
266266
267267 } // namespace UI;
diff -r ecd9d86036cc -r e5f859ac3f2c YFramework/source/YSLib/UI/menu.cpp
--- a/YFramework/source/YSLib/UI/menu.cpp Tue May 27 19:56:38 2014 +0800
+++ b/YFramework/source/YSLib/UI/menu.cpp Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file menu.cpp
1212 \ingroup UI
1313 \brief 样式相关的菜单。
14-\version r1183
14+\version r1184
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since build 203
1717 \par 创建时间:
1818 2011-06-02 12:20:10 +0800
1919 \par 修改时间:
20- 2014-05-23 09:51 +0800
20+ 2014-05-28 23:04 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -220,7 +220,7 @@
220220 if(YB_LIKELY(unit.Width > 16))
221221 if(ystdex::exists(mSubMenus, i))
222222 DrawArrow(g, Rect(unit.X + unit.Width - 16, unit.Y, 16,
223- unit.Height), 4, RDeg0, ForeColor);
223+ unit.Height) & mask, 4, RDeg0, ForeColor);
224224 }
225225
226226
diff -r ecd9d86036cc -r e5f859ac3f2c YFramework/source/YSLib/UI/scroll.cpp
--- a/YFramework/source/YSLib/UI/scroll.cpp Tue May 27 19:56:38 2014 +0800
+++ b/YFramework/source/YSLib/UI/scroll.cpp Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file scroll.cpp
1212 \ingroup UI
1313 \brief 样式相关的图形用户界面滚动控件。
14-\version r3644
14+\version r3650
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since build 194
1717 \par 创建时间:
1818 2011-03-07 20:12:02 +0800
1919 \par 修改时间:
20- 2014-05-23 09:52 +0800
20+ 2014-05-28 23:14 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -397,10 +397,12 @@
397397 using namespace placeholders;
398398
399399 yunseq(
400- FetchEvent<Paint>(btnPrev) += bind(DrawArrow, _1, ref(btnPrev), 4, prev,
401- ref(ForeColor)),
402- FetchEvent<Paint>(btnNext) += bind(DrawArrow, _1, ref(btnNext), 4, next,
403- ref(ForeColor))
400+ FetchEvent<Paint>(btnPrev) += [this, prev](PaintEventArgs&& e){
401+ DrawArrow(e.Target, e.ClipArea, 4, prev, ForeColor);
402+ },
403+ FetchEvent<Paint>(btnNext) += [this, next](PaintEventArgs&& e){
404+ DrawArrow(e.Target, e.ClipArea, 4, next, ForeColor);
405+ }
404406 );
405407 }
406408
diff -r ecd9d86036cc -r e5f859ac3f2c YFramework/source/YSLib/UI/ystyle.cpp
--- a/YFramework/source/YSLib/UI/ystyle.cpp Tue May 27 19:56:38 2014 +0800
+++ b/YFramework/source/YSLib/UI/ystyle.cpp Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file ystyle.cpp
1212 \ingroup UI
1313 \brief 图形用户界面样式。
14-\version r791
14+\version r815
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since build 194
1717 \par 创建时间:
1818 2010-05-01 13:52:56 +0800
1919 \par 修改时间:
20- 2014-05-23 09:54 +0800
20+ 2014-05-28 23:25 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -69,41 +69,27 @@
6969 {
7070 const auto& g(pc.Target);
7171 const auto& pt(pc.Location);
72- const auto& r(pc.ClipArea);
72+ const auto& bounds(pc.ClipArea);
7373 SDst x(pt.X), y(pt.Y);
7474
7575 switch(rot)
7676 {
7777 case RDeg0:
78- {
79- SDst t(pt.Y);
80-
81- for(SDst i(0); i < half_size; ++i)
82- DrawVLineSeg(g, r, x--, y--, t++, c);
83- }
84- break;
85- case RDeg90:
86- {
87- SDst t(pt.X);
88-
89- for(SDst i(0); i < half_size; ++i)
90- DrawHLineSeg(g, r, y++, x--, t++, c);
91- }
92- break;
9378 case RDeg180:
9479 {
9580 SDst t(pt.Y);
9681
9782 for(SDst i(0); i < half_size; ++i)
98- DrawVLineSeg(g, r, x++, y--, t++, c);
83+ DrawVLineSeg(g, bounds, rot == 0 ? x-- : x++, y--, t++, c);
9984 }
10085 break;
86+ case RDeg90:
10187 case RDeg270:
10288 {
10389 SDst t(pt.X);
10490
10591 for(SDst i(0); i < half_size; ++i)
106- DrawHLineSeg(g, r, y--, x--, t++, c);
92+ DrawHLineSeg(g, bounds, rot == RDeg90 ? y++ : y--, x--, t++, c);
10793 }
10894 default:
10995 break;
@@ -111,28 +97,28 @@
11197 }
11298
11399 void
114-DrawArrow(const Graphics& g, const Rect& r, SDst half_size, Rotation rot,
100+DrawArrow(const Graphics& g, const Rect& bounds, SDst half_size, Rotation rot,
115101 Color c)
116102 {
117- SPos x(r.X), y(r.Y);
103+ SPos x(bounds.X), y(bounds.Y);
118104
119105 switch(rot)
120106 {
121107 case RDeg0:
122108 case RDeg180:
123109 x += (rot == RDeg180
124- ? (r.Width - half_size) : (r.Width + half_size)) / 2;
125- y += (r.Height + 1) / 2;
110+ ? (bounds.Width - half_size) : (bounds.Width + half_size)) / 2;
111+ y += (bounds.Height + 1) / 2;
126112 break;
127113 case RDeg90:
128114 case RDeg270:
129115 y += (rot == RDeg90
130- ? (r.Height - half_size) : (r.Height + half_size)) / 2;
131- x += (r.Width + 1) / 2;
116+ ? (bounds.Height - half_size) : (bounds.Height + half_size)) / 2;
117+ x += (bounds.Width + 1) / 2;
132118 default:
133119 break;
134120 }
135- RectDrawArrow({g, Point(x, y), r}, half_size, rot, c);
121+ RectDrawArrow({g, Point(x, y), bounds}, half_size, rot, c);
136122 }
137123
138124 void
diff -r ecd9d86036cc -r e5f859ac3f2c YFramework/source/YSLib/UI/ywidget.cpp
--- a/YFramework/source/YSLib/UI/ywidget.cpp Tue May 27 19:56:38 2014 +0800
+++ b/YFramework/source/YSLib/UI/ywidget.cpp Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file ywidget.cpp
1212 \ingroup UI
1313 \brief 样式无关的 GUI 部件。
14-\version r4431
14+\version r4438
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since 早于 build 132
1717 \par 创建时间:
1818 2009-11-16 20:06:58 +0800
1919 \par 修改时间:
20- 2014-04-27 01:02 +0800
20+ 2014-04-28 22:55 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -100,14 +100,6 @@
100100 }
101101
102102 void
103-DrawArrow(PaintEventArgs&& e, IWidget& wgt, SDst half_size, Rotation rot,
104- Color c)
105-{
106- Drawing::DrawArrow(e.Target, Rect(e.Location, GetSizeOf(wgt)), half_size,
107- rot, c);
108-}
109-
110-void
111103 Hide(IWidget& wgt)
112104 {
113105 SetVisibleOf(wgt, false);
diff -r ecd9d86036cc -r e5f859ac3f2c YSTest/include/Shells.h
--- a/YSTest/include/Shells.h Tue May 27 19:56:38 2014 +0800
+++ b/YSTest/include/Shells.h Fri May 30 00:38:19 2014 +0800
@@ -1,5 +1,5 @@
11 /*
2- © 2010-2013 FrankHB.
2+ © 2010-2014 FrankHB.
33
44 This file is part of the YSLib project, and may only be used,
55 modified, and distributed under the terms of the YSLib project
@@ -15,13 +15,13 @@
1515 /*! \file Shells.h
1616 \ingroup YReader
1717 \brief Shell 框架逻辑。
18-\version r2916
18+\version r2924
1919 \author FrankHB <frankhb1989@gmail.com>
2020 \since 早于 build 132
2121 \par 创建时间:
2222 2010-03-06 21:38:16 +0800
2323 \par 修改时间:
24- 2013-12-24 00:57 +0800
24+ 2014-05-29 13:54 +0800
2525 \par 文本编码:
2626 UTF-8
2727 \par 模块名称:
@@ -93,6 +93,14 @@
9393 WidgetLoader&
9494 FetchWidgetLoader();
9595
96+/*!
97+\brief 向标签栏和节点添加按钮。
98+\since build 500
99+*/
100+void
101+AddButtonToTabBar(TabControl&, const ValueNode&, const string&,
102+ const String&, SDst = 64);
103+
96104 } // namespace YReader;
97105
98106 #endif
diff -r ecd9d86036cc -r e5f859ac3f2c YSTest/source/ReaderSettingUI.cpp
--- a/YSTest/source/ReaderSettingUI.cpp Tue May 27 19:56:38 2014 +0800
+++ b/YSTest/source/ReaderSettingUI.cpp Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file ReaderSettingUI.cpp
1212 \ingroup YReader
1313 \brief 阅读器设置界面。
14-\version r423
14+\version r473
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since build 390
1717 \par 创建时间:
1818 2013-03-20 20:28:23 +0800
1919 \par 修改时间:
20- 2014-04-06 17:31 +0800
20+ 2014-05-29 14:54 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -35,25 +35,35 @@
3535 {
3636
3737 const char TU_ReaderSettingUI[]{u8R"NPL(root
38-($type "Panel")($bounds "16 28 216 156")
39-(btnFontSizeDecrease
40- ($type "Button")($bounds "4 4 80 22"))
41-(btnFontSizeIncrease
42- ($type "Button")($bounds "132 4 80 22"))
43-(btnSetUpBack
44- ($type "Button")($bounds "4 36 80 22"))
45-(btnSetDownBack
46- ($type "Button")($bounds "132 36 80 22"))
47-(btnTextColor
48- ($type "Button")($bounds "4 68 80 22"))
49-(ddlFont
50- ($type "DropDownList")($bounds "132 68 80 22"))
51-(ddlEncoding
52- ($type "DropDownList")($bounds "4 100 192 22"))
53-(cbSmoothScroll
54- ($type "CheckButton")($bounds "4 132 72 18"))
55-(ddlScrollTiming
56- ($type "DropDownList")($bounds "80 132 128 22"))
38+($type "TabControl")($bounds "8 24 240 160")
39+(pnlPage1
40+ ($type "Panel")
41+ (btnFontSizeDecrease
42+ ($type "Button")($bounds "12 12 80 22"))
43+ (btnFontSizeIncrease
44+ ($type "Button")($bounds "148 12 80 22"))
45+ (btnSetUpBack
46+ ($type "Button")($bounds "12 44 80 22"))
47+ (btnSetDownBack
48+ ($type "Button")($bounds "148 44 80 22"))
49+ (btnTextColor
50+ ($type "Button")($bounds "12 76 80 22"))
51+ (ddlFont
52+ ($type "DropDownList")($bounds "148 76 80 22"))
53+)
54+(pnlPage2
55+ ($type "Panel")
56+ (ddlEncoding
57+ ($type "DropDownList")($bounds "12 12 192 22"))
58+)
59+(pnlPage3
60+ ($type "Panel")
61+ (cbSmoothScroll
62+ ($type "CheckButton")($bounds "12 12 72 18"))
63+ (ddlScrollTiming
64+ ($type "DropDownList")($bounds "84 12 128 22"))
65+)
66+
5767 )NPL"};
5868
5969 } // unnamed namespace;
@@ -83,16 +93,19 @@
8393 {
8494 // NOTE: Values of durations keep uninitialized. Use carefully.
8595 auto& node(dynWgts.WidgetNode);
86- DeclDynWidget(Panel, root, node)
87- DeclDynWidgetNode(Button, btnFontSizeDecrease)
88- DeclDynWidgetNode(Button, btnFontSizeIncrease)
89- DeclDynWidgetNode(Button, btnSetUpBack)
90- DeclDynWidgetNode(Button, btnSetDownBack)
91- DeclDynWidgetNode(Button, btnTextColor)
92- DeclDynWidgetNode(DropDownList, ddlFont)
93- DeclDynWidgetNode(DropDownList, ddlEncoding)
94- DeclDynWidgetNode(CheckButton, cbSmoothScroll)
95- DeclDynWidgetNode(DropDownList, ddlScrollTiming)
96+ DeclDynWidget(TabControl, root, node)
97+ auto& node_pnlPage1(AccessWidgetNode(node, "pnlPage1"));
98+ auto& node_pnlPage2(AccessWidgetNode(node, "pnlPage2"));
99+ auto& node_pnlPage3(AccessWidgetNode(node, "pnlPage3"));
100+ DeclDynWidgetN(Button, btnFontSizeDecrease, node_pnlPage1)
101+ DeclDynWidgetN(Button, btnFontSizeIncrease, node_pnlPage1)
102+ DeclDynWidgetN(Button, btnSetUpBack, node_pnlPage1)
103+ DeclDynWidgetN(Button, btnSetDownBack, node_pnlPage1)
104+ DeclDynWidgetN(Button, btnTextColor, node_pnlPage1)
105+ DeclDynWidgetN(DropDownList, ddlFont, node_pnlPage1)
106+ DeclDynWidgetN(DropDownList, ddlEncoding, node_pnlPage2)
107+ DeclDynWidgetN(CheckButton, cbSmoothScroll, node_pnlPage3)
108+ DeclDynWidgetN(DropDownList, ddlScrollTiming, node_pnlPage3)
96109 const auto set_font_size([this](FontSize size){
97110 lblAreaUp.Font.SetSize(size),
98111 lblAreaDown.Font.SetSize(size);
@@ -101,6 +114,13 @@
101114 Invalidate(lblAreaDown);
102115 });
103116
117+ AddButtonToTabBar(root, node_pnlPage1, "btnTabDisplay", u"显示设置");
118+ AddButtonToTabBar(root, node_pnlPage2, "btnTabText", u"文本设置");
119+ AddButtonToTabBar(root, node_pnlPage3, "btnTabOperation", u"操作设置");
120+ root.UpdateTabPages();
121+ for(const auto& p_pnl : root.GetPages())
122+ if(p_pnl)
123+ FetchEvent<Paint>(*p_pnl).Add(BorderBrush(), BoundaryPriority);
104124 AddWidgets(*this, root),
105125 Add(boxColor, 112U),
106126 SetVisibleOf(boxColor, false),
@@ -210,8 +230,8 @@
210230 SettingPanel::operator<<(const ReaderSetting& s)
211231 {
212232 auto& node(dynWgts.WidgetNode);
213- DeclDynWidgetNode(DropDownList, ddlFont)
214- DeclDynWidgetNode(CheckButton, cbSmoothScroll)
233+ DeclDynWidgetN(DropDownList, ddlFont, node, "pnlPage1")
234+ DeclDynWidgetN(CheckButton, cbSmoothScroll, node, "pnlPage3")
215235
216236 yunseq(
217237 lblAreaUp.ForeColor = s.FontColor,
diff -r ecd9d86036cc -r e5f859ac3f2c YSTest/source/Shells.cpp
--- a/YSTest/source/Shells.cpp Tue May 27 19:56:38 2014 +0800
+++ b/YSTest/source/Shells.cpp Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file Shells.cpp
1212 \ingroup YReader
1313 \brief Shell 框架逻辑。
14-\version r6346
14+\version r6357
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since 早于 build 132
1717 \par 创建时间:
1818 2010-03-06 21:38:16 +0800
1919 \par 修改时间:
20- 2014-05-01 10:48 +0800
20+ 2014-05-29 13:55 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -154,5 +154,18 @@
154154 return wgt_ldr;
155155 }
156156
157+void
158+AddButtonToTabBar(TabControl& tc, const ValueNode& node, const string& name,
159+ const String& text, SDst w)
160+{
161+ auto& tb(tc.GetTabBarRef());
162+ auto p_tab(make_shared<Button>(Rect(0, 0, w, tc.BarHeight)));
163+
164+ p_tab->Text = text,
165+ tb += *p_tab,
166+ tc.Attach(*p_tab);
167+ node += {0, name, std::move(p_tab)};
168+}
169+
157170 } // namespace YReader;
158171
diff -r ecd9d86036cc -r e5f859ac3f2c YSTest/source/ShlExplorer.cpp
--- a/YSTest/source/ShlExplorer.cpp Tue May 27 19:56:38 2014 +0800
+++ b/YSTest/source/ShlExplorer.cpp Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file ShlExplorer.cpp
1212 \ingroup YReader
1313 \brief 文件浏览器。
14-\version r1238
14+\version r1293
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since build 390
1717 \par 创建时间:
1818 2013-03-20 21:10:49 +0800
1919 \par 修改时间:
20- 2014-05-23 09:56 +0800
20+ 2014-05-29 13:56 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -149,20 +149,6 @@
149149 }
150150 //@}
151151
152-//! \since build 495
153-void AddButtonTabBar(TabControl& tc, const ValueNode& node, const string& name,
154- const String& text, SDst w = 64)
155-{
156- auto& tb(tc.GetTabBarRef());
157- auto p_tab(make_shared<Button>(Rect(0, 0, w, tc.BarHeight)));
158-
159- p_tab->Text = text,
160- tb += *p_tab,
161- tc.Attach(*p_tab);
162- node += {0, name, std::move(p_tab)};
163-}
164-
165-
166152 //! \since build 436
167153 const char TU_Explorer_Main[]{u8R"NPL(root
168154 ($type "Panel")($bounds "0 0 256 192")
@@ -208,19 +194,21 @@
208194 ($type "Button")($bounds "8 32 104 22"))
209195 (lblDragTest
210196 ($type "Label")($bounds "4 4 104 22"))
211- (tbTest
212- ($type "TextBox")($bounds "116 4 104 22"))
213- (btnTestEx
214- ($type "Button")($bounds "116 32 104 22"))
215- (btnTestAni
216- ($type "Button")($bounds "8 64 104 22"))
217- (cbDisableSetting
218- ($type "CheckButton")($bounds "116 64 104 22"))
219197 )
220198 (pnlPage2
221- ($type "Panel"))
199+ ($type "Panel")
200+ (btnTestAni
201+ ($type "Button")($bounds "8 32 104 22"))
202+ )
222203 (pnlPage3
223- ($type "Panel"))
204+ ($type "Panel")
205+ (tbTest
206+ ($type "TextBox")($bounds "8 4 104 22"))
207+ (btnTestEx
208+ ($type "Button")($bounds "8 32 104 22"))
209+ (cbDisableSetting
210+ ($type "CheckButton")($bounds "8 64 104 22"))
211+ )
224212 )
225213 )
226214 )NPL"};
@@ -286,18 +274,21 @@
286274 DeclDynWidget(Panel, pnlTest1, node_pnlTest1)
287275 DeclDynWidgetN(TabControl, tcTest1, node_pnlTest1)
288276 auto& node_pnlPage1(AccessWidgetNode(node_tcTest1, "pnlPage1"));
277+ auto& node_pnlPage2(AccessWidgetNode(node_tcTest1, "pnlPage2"));
278+ auto& node_pnlPage3(AccessWidgetNode(node_tcTest1, "pnlPage3"));
279+ DeclDynWidget(Panel, pnlPage2, node_pnlPage2)
289280 DeclDynWidgetN(Label, lblDragTest, node_pnlPage1)
290281 DeclDynWidgetN(Button, btnEnterTest, node_pnlPage1)
291- DeclDynWidgetN(TextBox, tbTest, node_pnlPage1)
292- DeclDynWidgetN(Button, btnTestEx, node_pnlPage1)
293- DeclDynWidgetN(Button, btnTestAni, node_pnlPage1)
294- DeclDynWidgetN(CheckButton, cbDisableSetting, node_pnlPage1)
282+ DeclDynWidgetN(Button, btnTestAni, node_pnlPage2)
283+ DeclDynWidgetN(TextBox, tbTest, node_pnlPage3)
284+ DeclDynWidgetN(Button, btnTestEx, node_pnlPage3)
285+ DeclDynWidgetN(CheckButton, cbDisableSetting, node_pnlPage3)
295286
296- AddButtonTabBar(tcTest1, node_pnlTest1, "btnTab1", u"测试标签1");
297- AddButtonTabBar(tcTest1, node_pnlTest1, "btnTab2", u"测试标签2");
298- AddButtonTabBar(tcTest1, node_pnlTest1, "btnTab3", u"测试标签3");
287+ AddButtonToTabBar(tcTest1, node_pnlTest1, "btnTab1", u"基本测试");
288+ AddButtonToTabBar(tcTest1, node_pnlTest1, "btnTab2", u"动画测试");
289+ AddButtonToTabBar(tcTest1, node_pnlTest1, "btnTab3", u"附加测试");
299290 tcTest1.UpdateTabPages();
300- p_border.reset(new BorderResizer(pnlTest1, 4));
291+ p_border = make_unique<BorderResizer>(pnlTest1, 4);
301292 p_ChkFPS = &cbFPS;
302293 dsk_m += root,
303294 dsk_m.Add(btnSwitchMain, 96),
@@ -352,6 +343,7 @@
352343 btnTestEx.VerticalAlignment = TextAlignment::Down,
353344 btnTestAni.Text = u"开始动画",
354345 cbDisableSetting.Text = u"禁用设置选择框",
346+ lblDragTest.Text = u"移动设置面板位置",
355347 btnEnterTest.Font.SetStyle(FontStyle::Italic),
356348 btnEnterTest.Text = u"边界测试",
357349 btnEnterTest.HorizontalAlignment = TextAlignment::Right,
@@ -440,16 +432,20 @@
440432 Invalidate(pnlSetting);
441433 },
442434 FetchEvent<TouchHeld>(pnlTest1) += OnTouchHeld_Dragging,
443- FetchEvent<Paint>(pnlTest1) += [&, this](PaintEventArgs&& e){
435+ FetchEvent<Paint>(pnlPage2) += [&, this](PaintEventArgs&& e){
444436 auto& g(e.Target);
445437 const auto& pt(GetLocationOf(pnlTest1));
446- auto& r(e.ClipArea);
438+ auto& bounds(e.ClipArea);
447439
448- DrawStar(g, r, ColorSpace::Red, pt + Point{96, 96}, 48, rad);
449- DrawStar(g, r, ColorSpace::Green, pt + Point{96, 96}, 48, rad + PI);
450- rad += 0.02;
451- if(rad > PI_2)
452- rad -= PI_2;
440+ DrawStar(g, bounds, ColorSpace::Red, pt + Point{96, 96}, 48, rad);
441+ DrawStar(g, bounds, ColorSpace::Green, pt + Point{96, 96}, 48,
442+ rad + PI);
443+ if(ani.GetConnectionRef().Ready)
444+ {
445+ rad += 0.02;
446+ if(rad > PI_2)
447+ rad -= PI_2;
448+ }
453449 UpdateClipArea(e, {{}, GetSizeOf(e.GetSender())});
454450 },
455451 FetchEvent<Click>(btnTestEx) += [&](CursorEventArgs&& e){
diff -r ecd9d86036cc -r e5f859ac3f2c YSTest/source/ShlReader.cpp
--- a/YSTest/source/ShlReader.cpp Tue May 27 19:56:38 2014 +0800
+++ b/YSTest/source/ShlReader.cpp Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file ShlReader.cpp
1212 \ingroup YReader
1313 \brief Shell 阅读器框架。
14-\version r4579
14+\version r4580
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since build 263
1717 \par 创建时间:
1818 2011-11-24 17:13:41 +0800
1919 \par 修改时间:
20- 2014-05-12 10:41 +0800
20+ 2014-05-29 13:53 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -326,7 +326,7 @@
326326 i = 0;
327327 yunseq(pnlSetting.lblAreaDown.Text = FetchEncodingString(i),
328328 AccessWidget<DropDownList>(pnlSetting.dynWgts.WidgetNode,
329- "ddlEncoding").Text = Encodings[i].second);
329+ "pnlPage2", "ddlEncoding").Text = Encodings[i].second);
330330 }
331331 Show(pnlSetting << CurrentSetting);
332332 }
diff -r ecd9d86036cc -r e5f859ac3f2c doc/ChangeLog.PreAlpha2.txt
--- a/doc/ChangeLog.PreAlpha2.txt Tue May 27 19:56:38 2014 +0800
+++ b/doc/ChangeLog.PreAlpha2.txt Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file ChangeLog.PreAlpha2.txt
1212 \ingroup Documentation
1313 \brief 版本更新历史记录 - PreAlpha2 。
14-\version r3538
14+\version r3539
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since build 393
1717 \par 创建时间:
1818 2013-03-25 00:11:18 +0800
1919 \par 修改时间:
20- 2014-04-27 10:12 +0800
20+ 2014-05-30 00:01 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -1776,7 +1776,7 @@
17761776 );
17771777 + "POD type operations" @ "library %YStandardEx",
17781778 / $dev $lib "simplified macro definitions" @ "ybasemac.h",
1779- / "updated Doxygen file" ^ "Doxygen 1.7.2",
1779+ / $doc "updated Doxygen file" ^ "Doxygen 1.7.2",
17801780 + DLD "nested-use support" @ "implementation" @ "macro %yunsequenced",
17811781 / DLP "libraries using" $=
17821782 (
diff -r ecd9d86036cc -r e5f859ac3f2c doc/ChangeLog.PreAlpha3.txt
--- a/doc/ChangeLog.PreAlpha3.txt Tue May 27 19:56:38 2014 +0800
+++ b/doc/ChangeLog.PreAlpha3.txt Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file ChangeLog.PreAlpha3.txt
1212 \ingroup Documentation
1313 \brief 版本更新历史记录 - PreAlpha3 。
14-\version r4936
14+\version r4938
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since build 393
1717 \par 创建时间:
1818 2013-03-25 00:14:22 +0800
1919 \par 修改时间:
20- 2014-04-27 10:50 +0800
20+ 2014-05-30 00:02 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -3288,8 +3288,9 @@
32883288 * "wrong displayed scrolling interval" $since b301
32893289 )
32903290 ),
3291- / $doc "updated Doxygen file" ^ "Doxygen 1.7.2" $=
3291+ / $doc "updated Doxygen file" $=
32923292 (
3293+ ^ "Doxygen 1.7.2",
32933294 * "wrong Doxygen root output path" $since b300,
32943295 / "input ignorance"
32953296 ),
diff -r ecd9d86036cc -r e5f859ac3f2c doc/ChangeLog.PreAlpha4.txt
--- a/doc/ChangeLog.PreAlpha4.txt Tue May 27 19:56:38 2014 +0800
+++ b/doc/ChangeLog.PreAlpha4.txt Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file ChangeLog.PreAlpha4.txt
1212 \ingroup Documentation
1313 \brief 版本更新历史记录 - PreAlpha4 。
14-\version r8159
14+\version r8162
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since build 400
1717 \par 创建时间:
1818 2013-04-20 11:19:07 +0800
1919 \par 修改时间:
20- 2014-05-27 19:56 +0800
20+ 2014-05-28 22:41 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -30,7 +30,7 @@
3030
3131 // Scope: [b400, $now];
3232
33-$now
33+b499
3434 (
3535 / %YFramework $=
3636 (
@@ -83,7 +83,7 @@
8383 * "missing explicit atomic initialization"
8484 @ "%Enviornment::ExitOnAllWindowThreadCompleted"
8585 @ %Host $since b399,
86- / "message in thrown excpeiton" @ "function %Execute"
86+ / "message in thrown exception" @ "function %Execute"
8787 @ %GUIApplication,
8888 / "singleton pointer unregistered when application exit"
8989 @ %Helper.(GUIApplication, DSApplication)
@@ -174,7 +174,7 @@
174174 ),
175175 / %YSLib $=
176176 (
177- + "inclsion %YFM_YCLib_Keys" @ %YAdaptor.Adaptor,
177+ + "inclusion %YFM_YCLib_Keys" @ %YAdaptor.Adaptor,
178178 // To prevent %YTraceDe undefined.
179179 / @ %UI.Loader $=
180180 (
diff -r ecd9d86036cc -r e5f859ac3f2c doc/ChangeLog.PreAlpha5.txt
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/ChangeLog.PreAlpha5.txt Fri May 30 00:38:19 2014 +0800
@@ -0,0 +1,102 @@
1+/*
2+ © 2014 FrankHB.
3+
4+ This file is part of the YSLib project, and may only be used,
5+ modified, and distributed under the terms of the YSLib project
6+ license, LICENSE.TXT. By continuing to use, modify, or distribute
7+ this file you indicate that you have read the license and
8+ understand and accept it fully.
9+*/
10+
11+/*! \file ChangeLog.PreAlpha5.txt
12+\ingroup Documentation
13+\brief 版本更新历史记录 - PreAlpha5 。
14+\version r101
15+\author FrankHB <frankhb1989@gmail.com>
16+\since build 500
17+\par 创建时间:
18+ 2014-05-29 19:30:47 +0800
19+\par 修改时间:
20+ 2014-05-30 00:01 +0800
21+\par 文本编码:
22+ UTF-8
23+\par 模块名称:
24+ Documentation::ChangeLog::PreAlpha5
25+*/
26+
27+// See %Documentation::Meta for meta descriptions.
28+
29+$import $HISTORY;
30+
31+// Scope: [b500, $now];
32+
33+$now
34+(
35+ / %YFramework,
36+ (
37+ / %YSLib.UI $=
38+ (
39+ * "missing clip area intersection for arrow rendering"
40+ @ "member function" ("%DropDownList::Refresh" @ %ComboList,
41+ "%Menu::DrawItem" @ %Menu,
42+ ) $since b452;
43+ // An obvious example is in the reader setting UI @ YReader, \
44+ moving over or dragging the scroll time setting drop down \
45+ list, the arrow of behind drop down button would be \
46+ wrongly rendered visible, rather than hiding hehind.
47+ (
48+ / "implemented arrow rendering" ^ "function %Drawing::DrawArrow"
49+ ~ "function %UI::DrawArrow" @ "member function \
50+ %AScrollBar::InitializeArrowPainters" @ %Scroll;
51+ * $comp "wrong arrow might be rendered" $since b452,
52+ // Ditto.
53+ - "function %UI::DrawArrow" @ %YWidget
54+ ),
55+ / DLD "simplified implementation" @ "function %RectDrawArrow"
56+ @ %YStyle
57+ ),
58+ / "default configuration" @ "platform %MinGW32" @ %Helper.Initialization
59+ $=
60+ (
61+ / "default root directory macro %ROOTW" -> "." ~ "H:\\NDS\\EFSRoot",
62+ / "default font path macro %DEF_FONT_PATH"
63+ -> "C:\\Windows\\Fonts\\SimSun.ttc"
64+ ~ 'ROOTW "\\Font\\FZYTK.TTF"',
65+ / "default font directory macro %DEF_FONT_DIRECTORY"
66+ -> 'ROOTW "\\Font\\"' ~ 'ROOTW "\\"',
67+ / "default data directory macro %DEF_DATA_DIRECTORY"
68+ -> 'ROOTW "\\Data\\"' ~ 'ROOTW "\\"'
69+ )
70+ ),
71+ / %YReader $=
72+ (
73+ / %ShlExplorer $=
74+ (
75+ / "test widget location"
76+ / @ "class %ShlExplorer" $=
77+ (
78+ + "default text" @ "test label",
79+ / "avoided potentional leak for %unique_ptr setting"
80+ ^ "%make_unique"~ "member function %unique_ptr::reset"
81+ @ "%yunseq segments",
82+ / @ "animation test" $=
83+ (
84+ * "animated wrongly by irrevalent invalidation" $since b451,
85+ / "refined test animation in test tab page"
86+ ~ "in setting panel"
87+ )
88+ )
89+ ),
90+ + "function %AddButtonTabBar" @ %Shells,
91+ + "rearranged setting UI in 3 tab pages" @ %ReaderSettingUI
92+ ),
93+ / $doc "updated Doxygen file" $=
94+ (
95+ ^ "Doxygen 1.8.7" ~ "Doxygen 1.8.2",
96+ / 'YFramework/include/freetype YFramework/include/ft2build.h'
97+ @ "%EXCLUDE" -> '.git Data Tools'
98+ )
99+);
100+
101+////
102+
diff -r ecd9d86036cc -r e5f859ac3f2c doc/YSLib.txt
--- a/doc/YSLib.txt Tue May 27 19:56:38 2014 +0800
+++ b/doc/YSLib.txt Fri May 30 00:38:19 2014 +0800
@@ -11,13 +11,13 @@
1111 /*! \file YSLib.txt
1212 \ingroup Documentation
1313 \brief YSLib 及相关库的细节汇总和暂定说明。
14-\version r2498
14+\version r2501
1515 \author FrankHB <frankhb1989@gmail.com>
1616 \since 早于 build 132
1717 \par 创建时间:
1818 2009-12-02 05:14:30 +0800
1919 \par 修改时间:
20- 2014-05-11 13:35 +0800
20+ 2014-05-29 19:41 +0800
2121 \par 文本编码:
2222 UTF-8
2323 \par 模块名称:
@@ -1128,12 +1128,13 @@
11281128 build 416 及之前的 DS 提交版本(除 build 387 rev 20[release] ) ;
11291129 build 428 之前的 DS release 提交版本。
11301130 build 428 - build 452 每 4 个 DS release 提交版本。
1131+ build 460 - build 500 每 20 个 DS release 提交版本。
11311132
11321133 @11.1.2 MinGW :
11331134 所有 MinGW32 版本通过 PC 测试。
1134- build 438 前及 build 497 起测试环境 Windows 7 Ultimate x64 。
1135+ build 438 前及 build 497 - build 499 起测试环境 Windows 7 Ultimate x64 。
11351136 build 438 - build 452 测试环境 Windows 2012 Datacenter x64 。
1136- build 453 - build 496 起测试环境 Windows 2012 R2 Datacenter x64 。
1137+ build 453 - build 496 及 build 500 起测试环境 Windows 2012 R2 Datacenter x64 。
11371138
11381139 @11.1.3 Android :
11391140 所有 Android 版本通过 PC 测试。测试环境 Windows 7 Ultimate x64 + Android 模拟器 Nexus S 。
Show on old repository browser