Merge lp:~zorba-coders/zorba/fix_warnings_fedora into lp:zorba

Proposed by Sorin Marian Nasoi
Status: Merged
Approved by: William Candillon
Approved revision: 10728
Merged at revision: 10723
Proposed branch: lp:~zorba-coders/zorba/fix_warnings_fedora
Merge into: lp:zorba
Diff against target: 16788 lines (+7884/-3949)
26 files modified
doc/c/doxy.config.in (+1112/-555)
doc/cxx/doxy.config.in (+1118/-554)
doc/java/doxy.config.in (+1113/-555)
doc/php/doxy.config.in (+1113/-555)
doc/python/doxy.config.in (+1113/-555)
doc/ruby/doxy.config.in (+1113/-555)
doc/zorba/CMakeLists.txt (+2/-0)
doc/zorba/build.dox (+5/-2)
doc/zorba/build_noncore.dox (+5/-5)
doc/zorba/doxy.config.in (+1113/-551)
doc/zorba/ft_thesaurus.dox (+7/-4)
doc/zorba/modules_authoring_2.dox (+4/-2)
doc/zorba/options.dox (+2/-2)
include/xqc.h (+9/-9)
include/zorba/internal/diagnostic.h (+3/-0)
include/zorba/item.h (+1/-1)
include/zorba/item_factory.h (+2/-2)
include/zorba/static_collection_manager.h (+3/-3)
include/zorba/static_context.h (+13/-14)
include/zorba/xquery.h (+5/-6)
include/zorba/zorbac.h (+16/-16)
src/functions/external_function.cpp (+2/-2)
src/runtime/collections/collections_impl.cpp (+6/-0)
src/store/naive/simple_index.cpp (+2/-0)
src/util/json_parser.cpp (+1/-1)
src/zorbaserialization/bin_archiver.cpp (+1/-0)
To merge this branch: bzr merge lp:~zorba-coders/zorba/fix_warnings_fedora
Reviewer Review Type Date Requested Status
William Candillon Approve
Sorin Marian Nasoi Approve
Matthias Brantner Approve
Review via email: mp+97705@code.launchpad.net

This proposal supersedes a proposal from 2012-03-14.

Commit message

Fixed warnings that appear in Fedora.

Description of the change

Fixed warnings that appear in Fedora.

To post a comment you must log in.
Revision history for this message
Sorin Marian Nasoi (sorin.marian.nasoi) : Posted in a previous version of this proposal
review: Approve
Revision history for this message
Matthias Brantner (matthias-brantner) wrote : Posted in a previous version of this proposal

- The changes in src/runtime/collections/collections_impl.cpp trigger another warning on other systems about a return value that is not used.
- why were the spaces for the project names removed (e.g. ZorbaC-API => Zorba C-API)

review: Needs Fixing
Revision history for this message
Sorin Marian Nasoi (sorin.marian.nasoi) wrote : Posted in a previous version of this proposal

> - The changes in src/runtime/collections/collections_impl.cpp trigger another
> warning on other systems about a return value that is not used.
Can you please give me more details to see if I can fix both issues?
Otherwise I will just revert that change.

> - why were the spaces for the project names removed (e.g. ZorbaC-API => Zorba
> C-API)
Also some details would help me understand your issues.

FYI: the doxy.config.in were *not* updated by hand.
I used doxygen -u doxy.config.in for every file in order to regenerate them using a more recent Doxygen version (1.7.5) and thus getting rid of the DEPRECATED warnings raised by "make doc".

Revision history for this message
Matthias Brantner (matthias-brantner) wrote : Posted in a previous version of this proposal

> > - The changes in src/runtime/collections/collections_impl.cpp trigger
> another
> > warning on other systems about a return value that is not used.
> Can you please give me more details to see if I can fix both issues?
> Otherwise I will just revert that change.
Just revert the change and add a (void*)collectionDecl; line.
This should avoid the unused variable warning.

> > > - why were the spaces for the project names removed (e.g. ZorbaC-API =>
> Zorba
> > C-API)
> Also some details would help me understand your issues.
>
> FYI: the doxy.config.in were *not* updated by hand.
> I used doxygen -u doxy.config.in for every file in order to regenerate them
> using a more recent Doxygen version (1.7.5) and thus getting rid of the
> DEPRECATED warnings raised by "make doc".
The doxygen documentation says

"The PROJECT_NAME tag is a single word (or a sequence of words surrounded by double-quotes) that should identify the project for which the documentation is generated. This name is used in the title of most generated pages and in a few other places."

So, I guess we should go for the old name surrounded by double-quotes.

Revision history for this message
Sorin Marian Nasoi (sorin.marian.nasoi) wrote : Posted in a previous version of this proposal

> > > - The changes in src/runtime/collections/collections_impl.cpp trigger
> > another
> > > warning on other systems about a return value that is not used.
> > Can you please give me more details to see if I can fix both issues?
> > Otherwise I will just revert that change.
> Just revert the change and add a (void*)collectionDecl; line.
> This should avoid the unused variable warning.
Will do.

> > > > - why were the spaces for the project names removed (e.g. ZorbaC-API =>
> > Zorba
> > > C-API)
> > Also some details would help me understand your issues.
> >
> > FYI: the doxy.config.in were *not* updated by hand.
> > I used doxygen -u doxy.config.in for every file in order to regenerate them
> > using a more recent Doxygen version (1.7.5) and thus getting rid of the
> > DEPRECATED warnings raised by "make doc".
> The doxygen documentation says
>
> "The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
> double-quotes) that should identify the project for which the documentation is
> generated. This name is used in the title of most generated pages and in a few
> other places."
>
> So, I guess we should go for the old name surrounded by double-quotes.
This would imply modifying the doxy.config.in files by hand, which IMHO is not a good idea.
Next time we need to update them, "doxygen -u" will reveal the same issue: are you sure it's not a better solution to keep the actual names as generated automatically by Doxygen?

Revision history for this message
Matthias Brantner (matthias-brantner) wrote : Posted in a previous version of this proposal

> > > > > - why were the spaces for the project names removed (e.g. ZorbaC-API
> =>
> > > Zorba
> > > > C-API)
> > > Also some details would help me understand your issues.
> > >
> > > FYI: the doxy.config.in were *not* updated by hand.
> > > I used doxygen -u doxy.config.in for every file in order to regenerate
> them
> > > using a more recent Doxygen version (1.7.5) and thus getting rid of the
> > > DEPRECATED warnings raised by "make doc".
> > The doxygen documentation says
> >
> > "The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
> > double-quotes) that should identify the project for which the documentation
> is
> > generated. This name is used in the title of most generated pages and in a
> few
> > other places."
> >
> > So, I guess we should go for the old name surrounded by double-quotes.
> This would imply modifying the doxy.config.in files by hand, which IMHO is not
> a good idea.
> Next time we need to update them, "doxygen -u" will reveal the same issue: are
> you sure it's not a better solution to keep the actual names as generated
> automatically by Doxygen?
Initially, the file was edited by hand. Once the name is surrounded by quotes, the next update will take care of this automatically. It's just that it was buggy before because the name contained spaces.

Revision history for this message
Juan Zacarias (juan457) wrote : Posted in a previous version of this proposal

Is working on Windows

Revision history for this message
Sorin Marian Nasoi (sorin.marian.nasoi) :
review: Approve
Revision history for this message
Matthias Brantner (matthias-brantner) wrote :

The PROJECT_NAMES need to be quoted because they contain spaces. That is, "Zorba C-API".

Revision history for this message
William Candillon (wcandillon) wrote :

Works great for me.

Revision history for this message
Sorin Marian Nasoi (sorin.marian.nasoi) wrote :

> Works great for me.
It still needs one more Approve to be merged :).

Revision history for this message
Matthias Brantner (matthias-brantner) :
review: Approve
Revision history for this message
Sorin Marian Nasoi (sorin.marian.nasoi) :
review: Approve
Revision history for this message
Zorba Build Bot (zorba-buildbot) wrote :
Revision history for this message
Zorba Build Bot (zorba-buildbot) wrote :

Validation queue job fix_warnings_fedora-2012-03-16T06-26-11.832Z is finished. The final status was:

All tests succeeded!

Revision history for this message
Zorba Build Bot (zorba-buildbot) wrote :

Voting does not meet specified criteria. Required: Approve > 1, Disapprove < 1, Needs Fixing < 1, Pending < 1. Got: 2 Approve, 1 Pending.

Revision history for this message
William Candillon (wcandillon) :
review: Approve
Revision history for this message
Zorba Build Bot (zorba-buildbot) wrote :
Revision history for this message
Zorba Build Bot (zorba-buildbot) wrote :

Validation queue job fix_warnings_fedora-2012-03-16T12-08-16.444Z is finished. The final status was:

All tests succeeded!

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'doc/c/doxy.config.in'
2--- doc/c/doxy.config.in 2011-06-30 20:03:46 +0000
3+++ doc/c/doxy.config.in 2012-03-15 17:48:23 +0000
4@@ -1,442 +1,623 @@
5-# Doxyfile 1.4.5
6+# Doxyfile 1.7.5
7
8 # This file describes the settings to be used by the documentation system
9-# doxygen (www.doxygen.org) for a project
10+# doxygen (www.doxygen.org) for a project.
11 #
12-# All text after a hash (#) is considered a comment and will be ignored
13+# All text after a hash (#) is considered a comment and will be ignored.
14 # The format is:
15 # TAG = value [value, ...]
16 # For lists items can also be appended using:
17 # TAG += value [value, ...]
18-# Values that contain spaces should be placed between quotes (" ")
19+# Values that contain spaces should be placed between quotes (" ").
20
21 #---------------------------------------------------------------------------
22 # Project related configuration options
23 #---------------------------------------------------------------------------
24
25-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26-# by quotes) that should identify the project.
27-
28-PROJECT_NAME = Zorba C-API
29-
30-# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31-# This could be handy for archiving the generated documentation or
32+# This tag specifies the encoding used for all characters in the config file
33+# that follow. The default is UTF-8 which is also the encoding used for all
34+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
35+# iconv built into libc) for the transcoding. See
36+# http://www.gnu.org/software/libiconv for the list of possible encodings.
37+
38+DOXYFILE_ENCODING = UTF-8
39+
40+# The PROJECT_NAME tag is a single word (or sequence of words) that should
41+# identify the project. Note that if you do not use Doxywizard you need
42+# to put quotes around the project name if it contains spaces.
43+
44+PROJECT_NAME = "Zorba C-API"
45+
46+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
47+# This could be handy for archiving the generated documentation or
48 # if some version control system is used.
49
50 PROJECT_NUMBER = @ZORBA_MAJOR_NUMBER@.@ZORBA_MINOR_NUMBER@.@ZORBA_PATCH_NUMBER@
51
52-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
53-# base path where the generated documentation will be put.
54-# If a relative path is entered, it will be relative to the location
55+# Using the PROJECT_BRIEF tag one can provide an optional one line description
56+# for a project that appears at the top of each page and should give viewer
57+# a quick idea about the purpose of the project. Keep the description short.
58+
59+PROJECT_BRIEF =
60+
61+# With the PROJECT_LOGO tag one can specify an logo or icon that is
62+# included in the documentation. The maximum height of the logo should not
63+# exceed 55 pixels and the maximum width should not exceed 200 pixels.
64+# Doxygen will copy the logo to the output directory.
65+
66+PROJECT_LOGO =
67+
68+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
69+# base path where the generated documentation will be put.
70+# If a relative path is entered, it will be relative to the location
71 # where doxygen was started. If left blank the current directory will be used.
72
73 OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
74
75-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
76-# 4096 sub-directories (in 2 levels) under the output directory of each output
77-# format and will distribute the generated files over these directories.
78-# Enabling this option can be useful when feeding doxygen a huge amount of
79-# source files, where putting all generated files in the same directory would
80+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
81+# 4096 sub-directories (in 2 levels) under the output directory of each output
82+# format and will distribute the generated files over these directories.
83+# Enabling this option can be useful when feeding doxygen a huge amount of
84+# source files, where putting all generated files in the same directory would
85 # otherwise cause performance problems for the file system.
86
87 CREATE_SUBDIRS = NO
88
89-# The OUTPUT_LANGUAGE tag is used to specify the language in which all
90-# documentation generated by doxygen is written. Doxygen will use this
91-# information to generate all constant output in the proper language.
92-# The default language is English, other supported languages are:
93-# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
94-# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
95-# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
96-# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
97-# Swedish, and Ukrainian.
98+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
99+# documentation generated by doxygen is written. Doxygen will use this
100+# information to generate all constant output in the proper language.
101+# The default language is English, other supported languages are:
102+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
103+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
104+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
105+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
106+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
107+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
108
109 OUTPUT_LANGUAGE = English
110
111-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
112-# include brief member descriptions after the members that are listed in
113-# the file and class documentation (similar to JavaDoc).
114+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
115+# include brief member descriptions after the members that are listed in
116+# the file and class documentation (similar to JavaDoc).
117 # Set to NO to disable this.
118
119 BRIEF_MEMBER_DESC = YES
120
121-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
122-# the brief description of a member or function before the detailed description.
123-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
124+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
125+# the brief description of a member or function before the detailed description.
126+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
127 # brief descriptions will be completely suppressed.
128
129 REPEAT_BRIEF = YES
130
131-# This tag implements a quasi-intelligent brief description abbreviator
132-# that is used to form the text in various listings. Each string
133-# in this list, if found as the leading text of the brief description, will be
134-# stripped from the text and the result after processing the whole list, is
135-# used as the annotated text. Otherwise, the brief description is used as-is.
136-# If left blank, the following values are used ("$name" is automatically
137-# replaced with the name of the entity): "The $name class" "The $name widget"
138-# "The $name file" "is" "provides" "specifies" "contains"
139+# This tag implements a quasi-intelligent brief description abbreviator
140+# that is used to form the text in various listings. Each string
141+# in this list, if found as the leading text of the brief description, will be
142+# stripped from the text and the result after processing the whole list, is
143+# used as the annotated text. Otherwise, the brief description is used as-is.
144+# If left blank, the following values are used ("$name" is automatically
145+# replaced with the name of the entity): "The $name class" "The $name widget"
146+# "The $name file" "is" "provides" "specifies" "contains"
147 # "represents" "a" "an" "the"
148
149-ABBREVIATE_BRIEF =
150+ABBREVIATE_BRIEF =
151
152-# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
153-# Doxygen will generate a detailed section even if there is only a brief
154+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
155+# Doxygen will generate a detailed section even if there is only a brief
156 # description.
157
158 ALWAYS_DETAILED_SEC = NO
159
160-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
161-# inherited members of a class in the documentation of that class as if those
162-# members were ordinary class members. Constructors, destructors and assignment
163+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
164+# inherited members of a class in the documentation of that class as if those
165+# members were ordinary class members. Constructors, destructors and assignment
166 # operators of the base classes will not be shown.
167
168 INLINE_INHERITED_MEMB = YES
169
170-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
171-# path before files name in the file list and in the header files. If set
172+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
173+# path before files name in the file list and in the header files. If set
174 # to NO the shortest path that makes the file name unique will be used.
175
176 FULL_PATH_NAMES = NO
177
178-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
179-# can be used to strip a user-defined part of the path. Stripping is
180-# only done if one of the specified strings matches the left-hand part of
181-# the path. The tag can be used to show relative paths in the file list.
182-# If left blank the directory from which doxygen is run is used as the
183+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
184+# can be used to strip a user-defined part of the path. Stripping is
185+# only done if one of the specified strings matches the left-hand part of
186+# the path. The tag can be used to show relative paths in the file list.
187+# If left blank the directory from which doxygen is run is used as the
188 # path to strip.
189
190-STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src @CMAKE_BINARY_DIR@/src
191-
192-
193-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
194-# the path mentioned in the documentation of a class, which tells
195-# the reader which header file to include in order to use a class.
196-# If left blank only the name of the header file containing the class
197-# definition is used. Otherwise one should specify the include paths that
198+STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src \
199+ @CMAKE_BINARY_DIR@/src
200+
201+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
202+# the path mentioned in the documentation of a class, which tells
203+# the reader which header file to include in order to use a class.
204+# If left blank only the name of the header file containing the class
205+# definition is used. Otherwise one should specify the include paths that
206 # are normally passed to the compiler using the -I flag.
207
208-STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include @CMAKE_BINARY_DIR@/include
209+STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include \
210+ @CMAKE_BINARY_DIR@/include
211
212-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
213-# (but less readable) file names. This can be useful is your file systems
214+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
215+# (but less readable) file names. This can be useful if your file system
216 # doesn't support long names like on DOS, Mac, or CD-ROM.
217
218 SHORT_NAMES = NO
219
220-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
221-# will interpret the first line (until the first dot) of a JavaDoc-style
222-# comment as the brief description. If set to NO, the JavaDoc
223-# comments will behave just like the Qt-style comments (thus requiring an
224-# explicit @brief command for a brief description.
225+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
226+# will interpret the first line (until the first dot) of a JavaDoc-style
227+# comment as the brief description. If set to NO, the JavaDoc
228+# comments will behave just like regular Qt-style comments
229+# (thus requiring an explicit @brief command for a brief description.)
230
231 JAVADOC_AUTOBRIEF = YES
232
233-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
234-# treat a multi-line C++ special comment block (i.e. a block of //! or ///
235-# comments) as a brief description. This used to be the default behaviour.
236-# The new default is to treat a multi-line C++ comment block as a detailed
237+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
238+# interpret the first line (until the first dot) of a Qt-style
239+# comment as the brief description. If set to NO, the comments
240+# will behave just like regular Qt-style comments (thus requiring
241+# an explicit \brief command for a brief description.)
242+
243+QT_AUTOBRIEF = NO
244+
245+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
246+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
247+# comments) as a brief description. This used to be the default behaviour.
248+# The new default is to treat a multi-line C++ comment block as a detailed
249 # description. Set this tag to YES if you prefer the old behaviour instead.
250
251 MULTILINE_CPP_IS_BRIEF = NO
252
253-# If the DETAILS_AT_TOP tag is set to YES then Doxygen
254-# will output the detailed description near the top, like JavaDoc.
255-# If set to NO, the detailed description appears after the member
256-# documentation.
257-
258-DETAILS_AT_TOP = NO
259-
260-# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
261-# member inherits the documentation from any documented member that it
262+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
263+# member inherits the documentation from any documented member that it
264 # re-implements.
265
266 INHERIT_DOCS = YES
267
268-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
269-# a new page for each member. If set to NO, the documentation of a member will
270+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
271+# a new page for each member. If set to NO, the documentation of a member will
272 # be part of the file/class/namespace that contains it.
273
274 SEPARATE_MEMBER_PAGES = NO
275
276-# The TAB_SIZE tag can be used to set the number of spaces in a tab.
277+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
278 # Doxygen uses this value to replace tabs by spaces in code fragments.
279
280 TAB_SIZE = 2
281
282-# This tag can be used to specify a number of aliases that acts
283-# as commands in the documentation. An alias has the form "name=value".
284-# For example adding "sideeffect=\par Side Effects:\n" will allow you to
285-# put the command \sideeffect (or @sideeffect) in the documentation, which
286-# will result in a user-defined paragraph with heading "Side Effects:".
287+# This tag can be used to specify a number of aliases that acts
288+# as commands in the documentation. An alias has the form "name=value".
289+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
290+# put the command \sideeffect (or @sideeffect) in the documentation, which
291+# will result in a user-defined paragraph with heading "Side Effects:".
292 # You can put \n's in the value part of an alias to insert newlines.
293
294-ALIASES =
295+ALIASES =
296
297-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
298-# sources only. Doxygen will then generate output that is more tailored for C.
299-# For instance, some of the names that are used will be different. The list
300+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
301+# sources only. Doxygen will then generate output that is more tailored for C.
302+# For instance, some of the names that are used will be different. The list
303 # of all members will be omitted, etc.
304
305 OPTIMIZE_OUTPUT_FOR_C = YES
306
307-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
308-# sources only. Doxygen will then generate output that is more tailored for Java.
309-# For instance, namespaces will be presented as packages, qualified scopes
310-# will look different, etc.
311+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
312+# sources only. Doxygen will then generate output that is more tailored for
313+# Java. For instance, namespaces will be presented as packages, qualified
314+# scopes will look different, etc.
315
316 OPTIMIZE_OUTPUT_JAVA = NO
317
318-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
319-# include (a tag file for) the STL sources as input, then you should
320-# set this tag to YES in order to let doxygen match functions declarations and
321-# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
322-# func(std::string) {}). This also make the inheritance and collaboration
323+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
324+# sources only. Doxygen will then generate output that is more tailored for
325+# Fortran.
326+
327+OPTIMIZE_FOR_FORTRAN = NO
328+
329+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
330+# sources. Doxygen will then generate output that is tailored for
331+# VHDL.
332+
333+OPTIMIZE_OUTPUT_VHDL = NO
334+
335+# Doxygen selects the parser to use depending on the extension of the files it
336+# parses. With this tag you can assign which parser to use for a given extension.
337+# Doxygen has a built-in mapping, but you can override or extend it using this
338+# tag. The format is ext=language, where ext is a file extension, and language
339+# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
340+# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
341+# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
342+# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
343+# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
344+
345+EXTENSION_MAPPING =
346+
347+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
348+# to include (a tag file for) the STL sources as input, then you should
349+# set this tag to YES in order to let doxygen match functions declarations and
350+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
351+# func(std::string) {}). This also makes the inheritance and collaboration
352 # diagrams that involve STL classes more complete and accurate.
353
354-# BUILTIN_STL_SUPPORT = NO
355-
356-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
357-# tag is set to YES, then doxygen will reuse the documentation of the first
358-# member in the group (if any) for the other members of the group. By default
359+BUILTIN_STL_SUPPORT = NO
360+
361+# If you use Microsoft's C++/CLI language, you should set this option to YES to
362+# enable parsing support.
363+
364+CPP_CLI_SUPPORT = NO
365+
366+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
367+# Doxygen will parse them like normal C++ but will assume all classes use public
368+# instead of private inheritance when no explicit protection keyword is present.
369+
370+SIP_SUPPORT = NO
371+
372+# For Microsoft's IDL there are propget and propput attributes to indicate getter
373+# and setter methods for a property. Setting this option to YES (the default)
374+# will make doxygen replace the get and set methods by a property in the
375+# documentation. This will only work if the methods are indeed getting or
376+# setting a simple type. If this is not the case, or you want to show the
377+# methods anyway, you should set this option to NO.
378+
379+IDL_PROPERTY_SUPPORT = YES
380+
381+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
382+# tag is set to YES, then doxygen will reuse the documentation of the first
383+# member in the group (if any) for the other members of the group. By default
384 # all members of a group must be documented explicitly.
385
386 DISTRIBUTE_GROUP_DOC = NO
387
388-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
389-# the same type (for instance a group of public functions) to be put as a
390-# subgroup of that type (e.g. under the Public Functions section). Set it to
391-# NO to prevent subgrouping. Alternatively, this can be done per class using
392+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
393+# the same type (for instance a group of public functions) to be put as a
394+# subgroup of that type (e.g. under the Public Functions section). Set it to
395+# NO to prevent subgrouping. Alternatively, this can be done per class using
396 # the \nosubgrouping command.
397
398 SUBGROUPING = YES
399
400+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
401+# unions are shown inside the group in which they are included (e.g. using
402+# @ingroup) instead of on a separate page (for HTML and Man pages) or
403+# section (for LaTeX and RTF).
404+
405+INLINE_GROUPED_CLASSES = NO
406+
407+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
408+# unions with only public data fields will be shown inline in the documentation
409+# of the scope in which they are defined (i.e. file, namespace, or group
410+# documentation), provided this scope is documented. If set to NO (the default),
411+# structs, classes, and unions are shown on a separate page (for HTML and Man
412+# pages) or section (for LaTeX and RTF).
413+
414+INLINE_SIMPLE_STRUCTS = NO
415+
416+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
417+# is documented as struct, union, or enum with the name of the typedef. So
418+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
419+# with name TypeT. When disabled the typedef will appear as a member of a file,
420+# namespace, or class. And the struct will be named TypeS. This can typically
421+# be useful for C code in case the coding convention dictates that all compound
422+# types are typedef'ed and only the typedef is referenced, never the tag name.
423+
424+TYPEDEF_HIDES_STRUCT = NO
425+
426+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
427+# determine which symbols to keep in memory and which to flush to disk.
428+# When the cache is full, less often used symbols will be written to disk.
429+# For small to medium size projects (<1000 input files) the default value is
430+# probably good enough. For larger projects a too small cache size can cause
431+# doxygen to be busy swapping symbols to and from disk most of the time
432+# causing a significant performance penalty.
433+# If the system has enough physical memory increasing the cache will improve the
434+# performance by keeping more symbols in memory. Note that the value works on
435+# a logarithmic scale so increasing the size by one will roughly double the
436+# memory usage. The cache size is given by this formula:
437+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
438+# corresponding to a cache size of 2^16 = 65536 symbols
439+
440+SYMBOL_CACHE_SIZE = 0
441+
442 #---------------------------------------------------------------------------
443 # Build related configuration options
444 #---------------------------------------------------------------------------
445
446-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
447-# documentation are documented, even if no documentation was available.
448-# Private class members and static file members will be hidden unless
449+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
450+# documentation are documented, even if no documentation was available.
451+# Private class members and static file members will be hidden unless
452 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
453
454 EXTRACT_ALL = YES
455
456-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
457+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
458 # will be included in the documentation.
459
460 EXTRACT_PRIVATE = NO
461
462-# If the EXTRACT_STATIC tag is set to YES all static members of a file
463+# If the EXTRACT_STATIC tag is set to YES all static members of a file
464 # will be included in the documentation.
465
466 EXTRACT_STATIC = NO
467
468-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
469-# defined locally in source files will be included in the documentation.
470+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
471+# defined locally in source files will be included in the documentation.
472 # If set to NO only classes defined in header files are included.
473
474 EXTRACT_LOCAL_CLASSES = YES
475
476-# This flag is only useful for Objective-C code. When set to YES local
477-# methods, which are defined in the implementation section but not in
478-# the interface are included in the documentation.
479+# This flag is only useful for Objective-C code. When set to YES local
480+# methods, which are defined in the implementation section but not in
481+# the interface are included in the documentation.
482 # If set to NO (the default) only methods in the interface are included.
483
484 EXTRACT_LOCAL_METHODS = NO
485
486-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
487-# undocumented members of documented classes, files or namespaces.
488-# If set to NO (the default) these members will be included in the
489-# various overviews, but no documentation section is generated.
490+# If this flag is set to YES, the members of anonymous namespaces will be
491+# extracted and appear in the documentation as a namespace called
492+# 'anonymous_namespace{file}', where file will be replaced with the base
493+# name of the file that contains the anonymous namespace. By default
494+# anonymous namespaces are hidden.
495+
496+EXTRACT_ANON_NSPACES = NO
497+
498+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
499+# undocumented members of documented classes, files or namespaces.
500+# If set to NO (the default) these members will be included in the
501+# various overviews, but no documentation section is generated.
502 # This option has no effect if EXTRACT_ALL is enabled.
503
504 HIDE_UNDOC_MEMBERS = YES
505
506-# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
507-# undocumented classes that are normally visible in the class hierarchy.
508-# If set to NO (the default) these classes will be included in the various
509+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
510+# undocumented classes that are normally visible in the class hierarchy.
511+# If set to NO (the default) these classes will be included in the various
512 # overviews. This option has no effect if EXTRACT_ALL is enabled.
513
514 HIDE_UNDOC_CLASSES = YES
515
516-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
517-# friend (class|struct|union) declarations.
518-# If set to NO (the default) these declarations will be included in the
519+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
520+# friend (class|struct|union) declarations.
521+# If set to NO (the default) these declarations will be included in the
522 # documentation.
523
524 HIDE_FRIEND_COMPOUNDS = NO
525
526-# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
527-# documentation blocks found inside the body of a function.
528-# If set to NO (the default) these blocks will be appended to the
529+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
530+# documentation blocks found inside the body of a function.
531+# If set to NO (the default) these blocks will be appended to the
532 # function's detailed documentation block.
533
534 HIDE_IN_BODY_DOCS = NO
535
536-# The INTERNAL_DOCS tag determines if documentation
537-# that is typed after a \internal command is included. If the tag is set
538-# to NO (the default) then the documentation will be excluded.
539+# The INTERNAL_DOCS tag determines if documentation
540+# that is typed after a \internal command is included. If the tag is set
541+# to NO (the default) then the documentation will be excluded.
542 # Set it to YES to include the internal documentation.
543
544 INTERNAL_DOCS = NO
545
546-# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
547-# file names in lower-case letters. If set to YES upper-case letters are also
548-# allowed. This is useful if you have classes or files whose names only differ
549-# in case and if your file system supports case sensitive file names. Windows
550+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
551+# file names in lower-case letters. If set to YES upper-case letters are also
552+# allowed. This is useful if you have classes or files whose names only differ
553+# in case and if your file system supports case sensitive file names. Windows
554 # and Mac users are advised to set this option to NO.
555
556 CASE_SENSE_NAMES = YES
557
558-# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
559-# will show members with their full class and namespace scopes in the
560+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
561+# will show members with their full class and namespace scopes in the
562 # documentation. If set to YES the scope will be hidden.
563
564 HIDE_SCOPE_NAMES = NO
565
566-# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
567-# will put a list of the files that are included by a file in the documentation
568+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
569+# will put a list of the files that are included by a file in the documentation
570 # of that file.
571
572 SHOW_INCLUDE_FILES = YES
573
574-# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
575+# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
576+# will list include files with double quotes in the documentation
577+# rather than with sharp brackets.
578+
579+FORCE_LOCAL_INCLUDES = NO
580+
581+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
582 # is inserted in the documentation for inline members.
583
584 INLINE_INFO = YES
585
586-# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
587-# will sort the (detailed) documentation of file and class members
588-# alphabetically by member name. If set to NO the members will appear in
589+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
590+# will sort the (detailed) documentation of file and class members
591+# alphabetically by member name. If set to NO the members will appear in
592 # declaration order.
593
594 SORT_MEMBER_DOCS = YES
595
596-# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
597-# brief documentation of file, namespace and class members alphabetically
598-# by member name. If set to NO (the default) the members will appear in
599+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
600+# brief documentation of file, namespace and class members alphabetically
601+# by member name. If set to NO (the default) the members will appear in
602 # declaration order.
603
604 SORT_BRIEF_DOCS = YES
605
606-# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
607-# sorted by fully-qualified names, including namespaces. If set to
608-# NO (the default), the class list will be sorted only by class name,
609-# not including the namespace part.
610+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
611+# will sort the (brief and detailed) documentation of class members so that
612+# constructors and destructors are listed first. If set to NO (the default)
613+# the constructors will appear in the respective orders defined by
614+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
615+# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
616+# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
617+
618+SORT_MEMBERS_CTORS_1ST = NO
619+
620+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
621+# hierarchy of group names into alphabetical order. If set to NO (the default)
622+# the group names will appear in their defined order.
623+
624+SORT_GROUP_NAMES = NO
625+
626+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
627+# sorted by fully-qualified names, including namespaces. If set to
628+# NO (the default), the class list will be sorted only by class name,
629+# not including the namespace part.
630 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
631-# Note: This option applies only to the class list, not to the
632+# Note: This option applies only to the class list, not to the
633 # alphabetical list.
634
635 SORT_BY_SCOPE_NAME = NO
636
637-# The GENERATE_TODOLIST tag can be used to enable (YES) or
638-# disable (NO) the todo list. This list is created by putting \todo
639+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
640+# do proper type resolution of all parameters of a function it will reject a
641+# match between the prototype and the implementation of a member function even
642+# if there is only one candidate or it is obvious which candidate to choose
643+# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
644+# will still accept a match between prototype and implementation in such cases.
645+
646+STRICT_PROTO_MATCHING = NO
647+
648+# The GENERATE_TODOLIST tag can be used to enable (YES) or
649+# disable (NO) the todo list. This list is created by putting \todo
650 # commands in the documentation.
651
652 GENERATE_TODOLIST = YES
653
654-# The GENERATE_TESTLIST tag can be used to enable (YES) or
655-# disable (NO) the test list. This list is created by putting \test
656+# The GENERATE_TESTLIST tag can be used to enable (YES) or
657+# disable (NO) the test list. This list is created by putting \test
658 # commands in the documentation.
659
660 GENERATE_TESTLIST = YES
661
662-# The GENERATE_BUGLIST tag can be used to enable (YES) or
663-# disable (NO) the bug list. This list is created by putting \bug
664+# The GENERATE_BUGLIST tag can be used to enable (YES) or
665+# disable (NO) the bug list. This list is created by putting \bug
666 # commands in the documentation.
667
668 GENERATE_BUGLIST = YES
669
670-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
671-# disable (NO) the deprecated list. This list is created by putting
672+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
673+# disable (NO) the deprecated list. This list is created by putting
674 # \deprecated commands in the documentation.
675
676 GENERATE_DEPRECATEDLIST= YES
677
678-# The ENABLED_SECTIONS tag can be used to enable conditional
679+# The ENABLED_SECTIONS tag can be used to enable conditional
680 # documentation sections, marked by \if sectionname ... \endif.
681
682 ENABLED_SECTIONS =
683
684-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
685-# the initial value of a variable or define consists of for it to appear in
686-# the documentation. If the initializer consists of more lines than specified
687-# here it will be hidden. Use a value of 0 to hide initializers completely.
688-# The appearance of the initializer of individual variables and defines in the
689-# documentation can be controlled using \showinitializer or \hideinitializer
690+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
691+# the initial value of a variable or macro consists of for it to appear in
692+# the documentation. If the initializer consists of more lines than specified
693+# here it will be hidden. Use a value of 0 to hide initializers completely.
694+# The appearance of the initializer of individual variables and macros in the
695+# documentation can be controlled using \showinitializer or \hideinitializer
696 # command in the documentation regardless of this setting.
697
698 MAX_INITIALIZER_LINES = 30
699
700-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
701-# at the bottom of the documentation of classes and structs. If set to YES the
702+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
703+# at the bottom of the documentation of classes and structs. If set to YES the
704 # list will mention the files that were used to generate the documentation.
705
706 SHOW_USED_FILES = YES
707
708-# If the sources in your project are distributed over multiple directories
709-# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
710-# in the documentation. The default is YES.
711+# If the sources in your project are distributed over multiple directories
712+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
713+# in the documentation. The default is NO.
714
715 SHOW_DIRECTORIES = YES
716
717-# The FILE_VERSION_FILTER tag can be used to specify a program or script that
718-# doxygen should invoke to get the current version for each file (typically from the
719-# version control system). Doxygen will invoke the program by executing (via
720-# popen()) the command <command> <input-file>, where <command> is the value of
721-# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
722-# provided by doxygen. Whatever the program writes to standard output
723+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
724+# This will remove the Files entry from the Quick Index and from the
725+# Folder Tree View (if specified). The default is YES.
726+
727+SHOW_FILES = YES
728+
729+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
730+# Namespaces page.
731+# This will remove the Namespaces entry from the Quick Index
732+# and from the Folder Tree View (if specified). The default is YES.
733+
734+SHOW_NAMESPACES = YES
735+
736+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
737+# doxygen should invoke to get the current version for each file (typically from
738+# the version control system). Doxygen will invoke the program by executing (via
739+# popen()) the command <command> <input-file>, where <command> is the value of
740+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
741+# provided by doxygen. Whatever the program writes to standard output
742 # is used as the file version. See the manual for examples.
743
744-FILE_VERSION_FILTER =
745+FILE_VERSION_FILTER =
746+
747+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
748+# by doxygen. The layout file controls the global structure of the generated
749+# output files in an output format independent way. The create the layout file
750+# that represents doxygen's defaults, run doxygen with the -l option.
751+# You can optionally specify a file name after the option, if omitted
752+# DoxygenLayout.xml will be used as the name of the layout file.
753+
754+LAYOUT_FILE =
755+
756+# The CITE_BIB_FILES tag can be used to specify one or more bib files
757+# containing the references data. This must be a list of .bib files. The
758+# .bib extension is automatically appended if omitted. Using this command
759+# requires the bibtex tool to be installed. See also
760+# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
761+# of the bibliography can be controlled using LATEX_BIB_STYLE.
762+
763+CITE_BIB_FILES =
764
765 #---------------------------------------------------------------------------
766 # configuration options related to warning and progress messages
767 #---------------------------------------------------------------------------
768
769-# The QUIET tag can be used to turn on/off the messages that are generated
770+# The QUIET tag can be used to turn on/off the messages that are generated
771 # by doxygen. Possible values are YES and NO. If left blank NO is used.
772
773 QUIET = NO
774
775-# The WARNINGS tag can be used to turn on/off the warning messages that are
776-# generated by doxygen. Possible values are YES and NO. If left blank
777+# The WARNINGS tag can be used to turn on/off the warning messages that are
778+# generated by doxygen. Possible values are YES and NO. If left blank
779 # NO is used.
780
781 WARNINGS = YES
782
783-# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
784-# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
785+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
786+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
787 # automatically be disabled.
788
789 WARN_IF_UNDOCUMENTED = YES
790
791-# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
792-# potential errors in the documentation, such as not documenting some
793-# parameters in a documented function, or documenting parameters that
794+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
795+# potential errors in the documentation, such as not documenting some
796+# parameters in a documented function, or documenting parameters that
797 # don't exist or using markup commands wrongly.
798
799 WARN_IF_DOC_ERROR = YES
800
801-# This WARN_NO_PARAMDOC option can be abled to get warnings for
802-# functions that are documented, but have no documentation for their parameters
803-# or return value. If set to NO (the default) doxygen will only warn about
804-# wrong or incomplete parameter documentation, but not about the absence of
805+# The WARN_NO_PARAMDOC option can be enabled to get warnings for
806+# functions that are documented, but have no documentation for their parameters
807+# or return value. If set to NO (the default) doxygen will only warn about
808+# wrong or incomplete parameter documentation, but not about the absence of
809 # documentation.
810
811 WARN_NO_PARAMDOC = NO
812
813-# The WARN_FORMAT tag determines the format of the warning messages that
814-# doxygen can produce. The string should contain the $file, $line, and $text
815-# tags, which will be replaced by the file and line number from which the
816-# warning originated and the warning text. Optionally the format may contain
817-# $version, which will be replaced by the version of the file (if it could
818+# The WARN_FORMAT tag determines the format of the warning messages that
819+# doxygen can produce. The string should contain the $file, $line, and $text
820+# tags, which will be replaced by the file and line number from which the
821+# warning originated and the warning text. Optionally the format may contain
822+# $version, which will be replaced by the version of the file (if it could
823 # be obtained via FILE_VERSION_FILTER)
824
825 WARN_FORMAT = @DOXY_WARN_FORMAT@
826
827-# The WARN_LOGFILE tag can be used to specify a file to which warning
828-# and error messages should be written. If left blank the output is written
829+# The WARN_LOGFILE tag can be used to specify a file to which warning
830+# and error messages should be written. If left blank the output is written
831 # to stderr.
832
833 WARN_LOGFILE = Doc/doxy.log
834@@ -445,9 +626,9 @@
835 # configuration options related to the input files
836 #---------------------------------------------------------------------------
837
838-# The INPUT tag can be used to specify the files and/or directories that contain
839-# documented source files. You may enter file names like "myfile.cpp" or
840-# directories like "/usr/src/myproject". Separate the files or directories
841+# The INPUT tag can be used to specify the files and/or directories that contain
842+# documented source files. You may enter file names like "myfile.cpp" or
843+# directories like "/usr/src/myproject". Separate the files or directories
844 # with spaces.
845
846 INPUT = @CMAKE_SOURCE_DIR@/include/zorba/zorbac.h \
847@@ -455,140 +636,176 @@
848 @CMAKE_SOURCE_DIR@/include/zorba/static_context_consts.h \
849 @CMAKE_SOURCE_DIR@/include/zorba/options.h \
850 @CMAKE_CURRENT_SOURCE_DIR@/manual
851-
852-
853-# If the value of the INPUT tag contains directories, you can use the
854-# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
855-# and *.h) to filter out the source-files in the directories. If left
856-# blank the following patterns are tested:
857-# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
858-# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
859-
860-FILE_PATTERNS = *.h *.dox
861-
862-# The RECURSIVE tag can be used to turn specify whether or not subdirectories
863-# should be searched for input files as well. Possible values are YES and NO.
864+
865+# This tag can be used to specify the character encoding of the source files
866+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
867+# also the default input encoding. Doxygen uses libiconv (or the iconv built
868+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
869+# the list of possible encodings.
870+
871+INPUT_ENCODING = UTF-8
872+
873+# If the value of the INPUT tag contains directories, you can use the
874+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
875+# and *.h) to filter out the source-files in the directories. If left
876+# blank the following patterns are tested:
877+# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
878+# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
879+# *.f90 *.f *.for *.vhd *.vhdl
880+
881+FILE_PATTERNS = *.h \
882+ *.dox
883+
884+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
885+# should be searched for input files as well. Possible values are YES and NO.
886 # If left blank NO is used.
887
888 RECURSIVE = YES
889
890-# The EXCLUDE tag can be used to specify files and/or directories that should
891-# excluded from the INPUT source files. This way you can easily exclude a
892+# The EXCLUDE tag can be used to specify files and/or directories that should
893+# excluded from the INPUT source files. This way you can easily exclude a
894 # subdirectory from a directory tree whose root is specified with the INPUT tag.
895-
896-EXCLUDE =
897-
898-# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
899-# directories that are symbolic links (a Unix filesystem feature) are excluded
900+# Note that relative paths are relative to directory from which doxygen is run.
901+
902+EXCLUDE =
903+
904+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
905+# directories that are symbolic links (a Unix file system feature) are excluded
906 # from the input.
907
908 EXCLUDE_SYMLINKS = NO
909
910-# If the value of the INPUT tag contains directories, you can use the
911-# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
912-# certain files from those directories. Note that the wildcards are matched
913-# against the file with absolute path, so to exclude all test directories
914+# If the value of the INPUT tag contains directories, you can use the
915+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
916+# certain files from those directories. Note that the wildcards are matched
917+# against the file with absolute path, so to exclude all test directories
918 # for example use the pattern */test/*
919
920 EXCLUDE_PATTERNS = */.svn \
921 */.svn/*
922
923-# The EXAMPLE_PATH tag can be used to specify one or more files or
924-# directories that contain example code fragments that are included (see
925+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
926+# (namespaces, classes, functions, etc.) that should be excluded from the
927+# output. The symbol name can be a fully qualified name, a word, or if the
928+# wildcard * is used, a substring. Examples: ANamespace, AClass,
929+# AClass::ANamespace, ANamespace::*Test
930+
931+EXCLUDE_SYMBOLS =
932+
933+# The EXAMPLE_PATH tag can be used to specify one or more files or
934+# directories that contain example code fragments that are included (see
935 # the \include command).
936
937 EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples
938
939-# If the value of the EXAMPLE_PATH tag contains directories, you can use the
940-# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
941-# and *.h) to filter out the source-files in the directories. If left
942+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
943+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
944+# and *.h) to filter out the source-files in the directories. If left
945 # blank all files are included.
946
947 EXAMPLE_PATTERNS = *.c
948
949-# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
950-# searched for input files to be used with the \include or \dontinclude
951-# commands irrespective of the value of the RECURSIVE tag.
952+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
953+# searched for input files to be used with the \include or \dontinclude
954+# commands irrespective of the value of the RECURSIVE tag.
955 # Possible values are YES and NO. If left blank NO is used.
956
957 EXAMPLE_RECURSIVE = YES
958
959-# The IMAGE_PATH tag can be used to specify one or more files or
960-# directories that contain image that are included in the documentation (see
961+# The IMAGE_PATH tag can be used to specify one or more files or
962+# directories that contain image that are included in the documentation (see
963 # the \image command).
964
965 IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@
966
967-
968-# The INPUT_FILTER tag can be used to specify a program that doxygen should
969-# invoke to filter for each input file. Doxygen will invoke the filter program
970-# by executing (via popen()) the command <filter> <input-file>, where <filter>
971-# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
972-# input file. Doxygen will then use the output that the filter program writes
973-# to standard output. If FILTER_PATTERNS is specified, this tag will be
974+# The INPUT_FILTER tag can be used to specify a program that doxygen should
975+# invoke to filter for each input file. Doxygen will invoke the filter program
976+# by executing (via popen()) the command <filter> <input-file>, where <filter>
977+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
978+# input file. Doxygen will then use the output that the filter program writes
979+# to standard output.
980+# If FILTER_PATTERNS is specified, this tag will be
981 # ignored.
982
983-INPUT_FILTER =
984-
985-# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
986-# basis. Doxygen will compare the file name with each pattern and apply the
987-# filter if there is a match. The filters are a list of the form:
988-# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
989-# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
990-# is applied to all files.
991-
992-FILTER_PATTERNS =
993-
994-# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
995-# INPUT_FILTER) will be used to filter the input files when producing source
996+INPUT_FILTER =
997+
998+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
999+# basis.
1000+# Doxygen will compare the file name with each pattern and apply the
1001+# filter if there is a match.
1002+# The filters are a list of the form:
1003+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
1004+# info on how filters are used. If FILTER_PATTERNS is empty or if
1005+# non of the patterns match the file name, INPUT_FILTER is applied.
1006+
1007+FILTER_PATTERNS =
1008+
1009+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1010+# INPUT_FILTER) will be used to filter the input files when producing source
1011 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
1012
1013 FILTER_SOURCE_FILES = NO
1014
1015+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1016+# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
1017+# and it is also possible to disable source filtering for a specific pattern
1018+# using *.ext= (so without naming a filter). This option only has effect when
1019+# FILTER_SOURCE_FILES is enabled.
1020+
1021+FILTER_SOURCE_PATTERNS =
1022+
1023 #---------------------------------------------------------------------------
1024 # configuration options related to source browsing
1025 #---------------------------------------------------------------------------
1026
1027-# If the SOURCE_BROWSER tag is set to YES then a list of source files will
1028-# be generated. Documented entities will be cross-referenced with these sources.
1029-# Note: To get rid of all source code in the generated output, make sure also
1030+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
1031+# be generated. Documented entities will be cross-referenced with these sources.
1032+# Note: To get rid of all source code in the generated output, make sure also
1033 # VERBATIM_HEADERS is set to NO.
1034
1035 SOURCE_BROWSER = YES
1036
1037-# Setting the INLINE_SOURCES tag to YES will include the body
1038+# Setting the INLINE_SOURCES tag to YES will include the body
1039 # of functions and classes directly in the documentation.
1040
1041 INLINE_SOURCES = NO
1042
1043-# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
1044-# doxygen to hide any special comment blocks from generated source code
1045+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
1046+# doxygen to hide any special comment blocks from generated source code
1047 # fragments. Normal C and C++ comments will always remain visible.
1048
1049 STRIP_CODE_COMMENTS = NO
1050
1051-# If the REFERENCED_BY_RELATION tag is set to YES (the default)
1052-# then for each documented function all documented
1053+# If the REFERENCED_BY_RELATION tag is set to YES
1054+# then for each documented function all documented
1055 # functions referencing it will be listed.
1056
1057 REFERENCED_BY_RELATION = YES
1058
1059-# If the REFERENCES_RELATION tag is set to YES (the default)
1060-# then for each documented function all documented entities
1061+# If the REFERENCES_RELATION tag is set to YES
1062+# then for each documented function all documented entities
1063 # called/used by that function will be listed.
1064
1065 REFERENCES_RELATION = YES
1066
1067-# If the USE_HTAGS tag is set to YES then the references to source code
1068-# will point to the HTML generated by the htags(1) tool instead of doxygen
1069-# built-in source browser. The htags tool is part of GNU's global source
1070-# tagging system (see http://www.gnu.org/software/global/global.html). You
1071+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
1072+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
1073+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
1074+# link to the source code.
1075+# Otherwise they will link to the documentation.
1076+
1077+REFERENCES_LINK_SOURCE = YES
1078+
1079+# If the USE_HTAGS tag is set to YES then the references to source code
1080+# will point to the HTML generated by the htags(1) tool instead of doxygen
1081+# built-in source browser. The htags tool is part of GNU's global source
1082+# tagging system (see http://www.gnu.org/software/global/global.html). You
1083 # will need version 4.8.6 or higher.
1084
1085 USE_HTAGS = NO
1086
1087-# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
1088-# will generate a verbatim copy of the header file for each class for
1089+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
1090+# will generate a verbatim copy of the header file for each class for
1091 # which an include is specified. Set to NO to disable this.
1092
1093 VERBATIM_HEADERS = YES
1094@@ -597,281 +814,548 @@
1095 # configuration options related to the alphabetical class index
1096 #---------------------------------------------------------------------------
1097
1098-# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
1099-# of all compounds will be generated. Enable this if the project
1100+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
1101+# of all compounds will be generated. Enable this if the project
1102 # contains a lot of classes, structs, unions or interfaces.
1103
1104 ALPHABETICAL_INDEX = YES
1105
1106-# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
1107-# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
1108+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
1109+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
1110 # in which this list will be split (can be a number in the range [1..20])
1111
1112 COLS_IN_ALPHA_INDEX = 2
1113
1114-# In case all classes in a project start with a common prefix, all
1115-# classes will be put under the same header in the alphabetical index.
1116-# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
1117+# In case all classes in a project start with a common prefix, all
1118+# classes will be put under the same header in the alphabetical index.
1119+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
1120 # should be ignored while generating the index headers.
1121
1122-IGNORE_PREFIX =
1123+IGNORE_PREFIX =
1124
1125 #---------------------------------------------------------------------------
1126 # configuration options related to the HTML output
1127 #---------------------------------------------------------------------------
1128
1129-# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
1130+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
1131 # generate HTML output.
1132
1133 GENERATE_HTML = YES
1134
1135-# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
1136-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1137+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
1138+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1139 # put in front of it. If left blank `html' will be used as the default path.
1140
1141 HTML_OUTPUT = html
1142
1143-# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
1144-# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
1145+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
1146+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
1147 # doxygen will generate files with .html extension.
1148
1149 HTML_FILE_EXTENSION = .html
1150
1151-# The HTML_HEADER tag can be used to specify a personal HTML header for
1152-# each generated HTML page. If it is left blank doxygen will generate a
1153-# standard header.
1154+# The HTML_HEADER tag can be used to specify a personal HTML header for
1155+# each generated HTML page. If it is left blank doxygen will generate a
1156+# standard header. Note that when using a custom header you are responsible
1157+# for the proper inclusion of any scripts and style sheets that doxygen
1158+# needs, which is dependent on the configuration options used.
1159+# It is adviced to generate a default header using "doxygen -w html
1160+# header.html footer.html stylesheet.css YourConfigFile" and then modify
1161+# that header. Note that the header is subject to change so you typically
1162+# have to redo this when upgrading to a newer version of doxygen or when
1163+# changing the value of configuration settings such as GENERATE_TREEVIEW!
1164+
1165 HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/../style/header.html
1166
1167-
1168-# The HTML_FOOTER tag can be used to specify a personal HTML footer for
1169-# each generated HTML page. If it is left blank doxygen will generate a
1170+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
1171+# each generated HTML page. If it is left blank doxygen will generate a
1172 # standard footer.
1173
1174 HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/../style/footer.html
1175
1176-# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
1177-# style sheet that is used by each HTML page. It can be used to
1178-# fine-tune the look of the HTML output. If the tag is left blank doxygen
1179-# will generate a default style sheet. Note that doxygen will try to copy
1180-# the style sheet file to the HTML output directory, so don't put your own
1181+# If the HTML_TIMESTAMP tag is set to YES then the generated HTML documentation will contain the timesstamp.
1182+
1183+HTML_TIMESTAMP = NO
1184+
1185+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
1186+# style sheet that is used by each HTML page. It can be used to
1187+# fine-tune the look of the HTML output. If the tag is left blank doxygen
1188+# will generate a default style sheet. Note that doxygen will try to copy
1189+# the style sheet file to the HTML output directory, so don't put your own
1190 # stylesheet in the HTML output directory as well, or it will be erased!
1191
1192 HTML_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/../style/stylesheet.css
1193
1194-# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
1195-# files or namespaces will be aligned in HTML using tables. If set to
1196+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1197+# other source files which should be copied to the HTML output directory. Note
1198+# that these files will be copied to the base HTML output directory. Use the
1199+# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1200+# files. In the HTML_STYLESHEET file, use the file name only. Also note that
1201+# the files will be copied as-is; there are no commands or markers available.
1202+
1203+HTML_EXTRA_FILES =
1204+
1205+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
1206+# Doxygen will adjust the colors in the stylesheet and background images
1207+# according to this color. Hue is specified as an angle on a colorwheel,
1208+# see http://en.wikipedia.org/wiki/Hue for more information.
1209+# For instance the value 0 represents red, 60 is yellow, 120 is green,
1210+# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
1211+# The allowed range is 0 to 359.
1212+
1213+HTML_COLORSTYLE_HUE = 220
1214+
1215+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
1216+# the colors in the HTML output. For a value of 0 the output will use
1217+# grayscales only. A value of 255 will produce the most vivid colors.
1218+
1219+HTML_COLORSTYLE_SAT = 100
1220+
1221+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
1222+# the luminance component of the colors in the HTML output. Values below
1223+# 100 gradually make the output lighter, whereas values above 100 make
1224+# the output darker. The value divided by 100 is the actual gamma applied,
1225+# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
1226+# and 100 does not change the gamma.
1227+
1228+HTML_COLORSTYLE_GAMMA = 80
1229+
1230+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1231+# page will contain the date and time when the page was generated. Setting
1232+# this to NO can help when comparing the output of multiple runs.
1233+
1234+HTML_TIMESTAMP = YES
1235+
1236+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
1237+# files or namespaces will be aligned in HTML using tables. If set to
1238 # NO a bullet list will be used.
1239
1240 HTML_ALIGN_MEMBERS = YES
1241
1242-# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1243-# will be generated that can be used as input for tools like the
1244-# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
1245+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1246+# documentation will contain sections that can be hidden and shown after the
1247+# page has loaded. For this to work a browser that supports
1248+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
1249+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
1250+
1251+HTML_DYNAMIC_SECTIONS = NO
1252+
1253+# If the GENERATE_DOCSET tag is set to YES, additional index files
1254+# will be generated that can be used as input for Apple's Xcode 3
1255+# integrated development environment, introduced with OSX 10.5 (Leopard).
1256+# To create a documentation set, doxygen will generate a Makefile in the
1257+# HTML output directory. Running make will produce the docset in that
1258+# directory and running "make install" will install the docset in
1259+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
1260+# it at startup.
1261+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1262+# for more information.
1263+
1264+GENERATE_DOCSET = NO
1265+
1266+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
1267+# feed. A documentation feed provides an umbrella under which multiple
1268+# documentation sets from a single provider (such as a company or product suite)
1269+# can be grouped.
1270+
1271+DOCSET_FEEDNAME = "Doxygen generated docs"
1272+
1273+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
1274+# should uniquely identify the documentation set bundle. This should be a
1275+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
1276+# will append .docset to the name.
1277+
1278+DOCSET_BUNDLE_ID = org.doxygen.Project
1279+
1280+# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
1281+# the documentation publisher. This should be a reverse domain-name style
1282+# string, e.g. com.mycompany.MyDocSet.documentation.
1283+
1284+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1285+
1286+# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
1287+
1288+DOCSET_PUBLISHER_NAME = Publisher
1289+
1290+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
1291+# will be generated that can be used as input for tools like the
1292+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
1293 # of the generated HTML documentation.
1294
1295 GENERATE_HTMLHELP = YES
1296
1297-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1298-# be used to specify the file name of the resulting .chm file. You
1299-# can add a path in front of the file if the result should not be
1300+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
1301+# be used to specify the file name of the resulting .chm file. You
1302+# can add a path in front of the file if the result should not be
1303 # written to the html output directory.
1304
1305-CHM_FILE =
1306+CHM_FILE =
1307
1308-# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1309-# be used to specify the location (absolute path including file name) of
1310-# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1311+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
1312+# be used to specify the location (absolute path including file name) of
1313+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
1314 # the HTML help compiler on the generated index.hhp.
1315
1316-HHC_LOCATION =
1317+HHC_LOCATION =
1318
1319-# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1320-# controls if a separate .chi index file is generated (YES) or that
1321+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1322+# controls if a separate .chi index file is generated (YES) or that
1323 # it should be included in the master .chm file (NO).
1324
1325 GENERATE_CHI = NO
1326
1327-# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1328-# controls whether a binary table of contents is generated (YES) or a
1329+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1330+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1331+# content.
1332+
1333+CHM_INDEX_ENCODING =
1334+
1335+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1336+# controls whether a binary table of contents is generated (YES) or a
1337 # normal table of contents (NO) in the .chm file.
1338
1339 BINARY_TOC = NO
1340
1341-# The TOC_EXPAND flag can be set to YES to add extra items for group members
1342+# The TOC_EXPAND flag can be set to YES to add extra items for group members
1343 # to the contents of the HTML help documentation and to the tree view.
1344
1345 TOC_EXPAND = NO
1346
1347-# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1348-# top of each HTML page. The value NO (the default) enables the index and
1349+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1350+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1351+# that can be used as input for Qt's qhelpgenerator to generate a
1352+# Qt Compressed Help (.qch) of the generated HTML documentation.
1353+
1354+GENERATE_QHP = NO
1355+
1356+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1357+# be used to specify the file name of the resulting .qch file.
1358+# The path specified is relative to the HTML output folder.
1359+
1360+QCH_FILE =
1361+
1362+# The QHP_NAMESPACE tag specifies the namespace to use when generating
1363+# Qt Help Project output. For more information please see
1364+# http://doc.trolltech.com/qthelpproject.html#namespace
1365+
1366+QHP_NAMESPACE = org.doxygen.Project
1367+
1368+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1369+# Qt Help Project output. For more information please see
1370+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1371+
1372+QHP_VIRTUAL_FOLDER = doc
1373+
1374+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1375+# add. For more information please see
1376+# http://doc.trolltech.com/qthelpproject.html#custom-filters
1377+
1378+QHP_CUST_FILTER_NAME =
1379+
1380+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1381+# custom filter to add. For more information please see
1382+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1383+# Qt Help Project / Custom Filters</a>.
1384+
1385+QHP_CUST_FILTER_ATTRS =
1386+
1387+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1388+# project's
1389+# filter section matches.
1390+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1391+# Qt Help Project / Filter Attributes</a>.
1392+
1393+QHP_SECT_FILTER_ATTRS =
1394+
1395+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1396+# be used to specify the location of Qt's qhelpgenerator.
1397+# If non-empty doxygen will try to run qhelpgenerator on the generated
1398+# .qhp file.
1399+
1400+QHG_LOCATION =
1401+
1402+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1403+# will be generated, which together with the HTML files, form an Eclipse help
1404+# plugin. To install this plugin and make it available under the help contents
1405+# menu in Eclipse, the contents of the directory containing the HTML and XML
1406+# files needs to be copied into the plugins directory of eclipse. The name of
1407+# the directory within the plugins directory should be the same as
1408+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1409+# the help appears.
1410+
1411+GENERATE_ECLIPSEHELP = NO
1412+
1413+# A unique identifier for the eclipse help plugin. When installing the plugin
1414+# the directory name containing the HTML and XML files should also have
1415+# this name.
1416+
1417+ECLIPSE_DOC_ID = org.doxygen.Project
1418+
1419+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1420+# top of each HTML page. The value NO (the default) enables the index and
1421 # the value YES disables it.
1422
1423 DISABLE_INDEX = NO
1424
1425-# This tag can be used to set the number of enum values (range [1..20])
1426-# that doxygen will group on one line in the generated HTML documentation.
1427+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
1428+# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1429+# documentation. Note that a value of 0 will completely suppress the enum
1430+# values from appearing in the overview section.
1431
1432 ENUM_VALUES_PER_LINE = 4
1433
1434-# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
1435-# generated containing a tree-like index structure (just like the one that
1436-# is generated for HTML Help). For this to work a browser that supports
1437-# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
1438-# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
1439-# probably better off using the HTML help feature.
1440+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1441+# structure should be generated to display hierarchical information.
1442+# If the tag value is set to YES, a side panel will be generated
1443+# containing a tree-like index structure (just like the one that
1444+# is generated for HTML Help). For this to work a browser that supports
1445+# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1446+# Windows users are probably better off using the HTML help feature.
1447
1448 GENERATE_TREEVIEW = NO
1449
1450-# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1451-# used to set the initial width (in pixels) of the frame in which the tree
1452+# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1453+# and Class Hierarchy pages using a tree view instead of an ordered list.
1454+
1455+USE_INLINE_TREES = NO
1456+
1457+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1458+# used to set the initial width (in pixels) of the frame in which the tree
1459 # is shown.
1460
1461 TREEVIEW_WIDTH = 250
1462
1463+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1464+# links to external symbols imported via tag files in a separate window.
1465+
1466+EXT_LINKS_IN_WINDOW = NO
1467+
1468+# Use this tag to change the font size of Latex formulas included
1469+# as images in the HTML documentation. The default is 10. Note that
1470+# when you change the font size after a successful doxygen run you need
1471+# to manually remove any form_*.png images from the HTML output directory
1472+# to force them to be regenerated.
1473+
1474+FORMULA_FONTSIZE = 10
1475+
1476+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1477+# generated for formulas are transparent PNGs. Transparent PNGs are
1478+# not supported properly for IE 6.0, but are supported on all modern browsers.
1479+# Note that when changing this option you need to delete any form_*.png files
1480+# in the HTML output before the changes have effect.
1481+
1482+FORMULA_TRANSPARENT = YES
1483+
1484+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1485+# (see http://www.mathjax.org) which uses client side Javascript for the
1486+# rendering instead of using prerendered bitmaps. Use this if you do not
1487+# have LaTeX installed or if you want to formulas look prettier in the HTML
1488+# output. When enabled you also need to install MathJax separately and
1489+# configure the path to it using the MATHJAX_RELPATH option.
1490+
1491+USE_MATHJAX = NO
1492+
1493+# When MathJax is enabled you need to specify the location relative to the
1494+# HTML output directory using the MATHJAX_RELPATH option. The destination
1495+# directory should contain the MathJax.js script. For instance, if the mathjax
1496+# directory is located at the same level as the HTML output directory, then
1497+# MATHJAX_RELPATH should be ../mathjax. The default value points to the
1498+# mathjax.org site, so you can quickly see the result without installing
1499+# MathJax, but it is strongly recommended to install a local copy of MathJax
1500+# before deployment.
1501+
1502+MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1503+
1504+# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1505+# names that should be enabled during MathJax rendering.
1506+
1507+MATHJAX_EXTENSIONS =
1508+
1509+# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1510+# for the HTML output. The underlying search engine uses javascript
1511+# and DHTML and should work on any modern browser. Note that when using
1512+# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1513+# (GENERATE_DOCSET) there is already a search function so this one should
1514+# typically be disabled. For large projects the javascript based search engine
1515+# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1516+
1517+SEARCHENGINE = NO
1518+
1519+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1520+# implemented using a PHP enabled web server instead of at the web client
1521+# using Javascript. Doxygen will generate the search PHP script and index
1522+# file to put on the web server. The advantage of the server
1523+# based approach is that it scales better to large projects and allows
1524+# full text search. The disadvantages are that it is more difficult to setup
1525+# and does not have live searching capabilities.
1526+
1527+SERVER_BASED_SEARCH = NO
1528+
1529 #---------------------------------------------------------------------------
1530 # configuration options related to the LaTeX output
1531 #---------------------------------------------------------------------------
1532
1533-# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1534+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1535 # generate Latex output.
1536
1537 GENERATE_LATEX = NO
1538
1539-# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1540-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1541+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1542+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1543 # put in front of it. If left blank `latex' will be used as the default path.
1544
1545 LATEX_OUTPUT = latex
1546
1547-# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1548+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1549 # invoked. If left blank `latex' will be used as the default command name.
1550-
1551-#LATEX_CMD_NAME = latex
1552-LATEX_CMD_NAME = @LATEX_COMPILER@
1553-
1554-# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1555-# generate index for LaTeX. If left blank `makeindex' will be used as the
1556+# Note that when enabling USE_PDFLATEX this option is only used for
1557+# generating bitmaps for formulas in the HTML output, but not in the
1558+# Makefile that is written to the output directory.
1559+
1560+LATEX_CMD_NAME = @LATEX_COMPILER@
1561+
1562+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1563+# generate index for LaTeX. If left blank `makeindex' will be used as the
1564 # default command name.
1565
1566-#MAKEINDEX_CMD_NAME = makeindex
1567 MAKEINDEX_CMD_NAME = @MAKEINDEX_COMPILER@
1568
1569-# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1570-# LaTeX documents. This may be useful for small projects and may help to
1571+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1572+# LaTeX documents. This may be useful for small projects and may help to
1573 # save some trees in general.
1574
1575 COMPACT_LATEX = NO
1576
1577-# The PAPER_TYPE tag can be used to set the paper type that is used
1578-# by the printer. Possible values are: a4, a4wide, letter, legal and
1579+# The PAPER_TYPE tag can be used to set the paper type that is used
1580+# by the printer. Possible values are: a4, letter, legal and
1581 # executive. If left blank a4wide will be used.
1582
1583 PAPER_TYPE = a4
1584
1585-# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1586+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1587 # packages that should be included in the LaTeX output.
1588
1589-EXTRA_PACKAGES =
1590+EXTRA_PACKAGES =
1591
1592-# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1593-# the generated latex document. The header should contain everything until
1594-# the first chapter. If it is left blank doxygen will generate a
1595+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1596+# the generated latex document. The header should contain everything until
1597+# the first chapter. If it is left blank doxygen will generate a
1598 # standard header. Notice: only use this tag if you know what you are doing!
1599
1600-LATEX_HEADER =
1601-
1602-# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1603-# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1604-# contain links (just like the HTML output) instead of page references
1605+LATEX_HEADER =
1606+
1607+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1608+# the generated latex document. The footer should contain everything after
1609+# the last chapter. If it is left blank doxygen will generate a
1610+# standard footer. Notice: only use this tag if you know what you are doing!
1611+
1612+LATEX_FOOTER =
1613+
1614+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1615+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1616+# contain links (just like the HTML output) instead of page references
1617 # This makes the output suitable for online browsing using a pdf viewer.
1618
1619 PDF_HYPERLINKS = YES
1620
1621-# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1622-# plain latex in the generated Makefile. Set this option to YES to get a
1623+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1624+# plain latex in the generated Makefile. Set this option to YES to get a
1625 # higher quality PDF documentation.
1626
1627 USE_PDFLATEX = YES
1628
1629-# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1630-# command to the generated LaTeX files. This will instruct LaTeX to keep
1631-# running if errors occur, instead of asking the user for help.
1632+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1633+# command to the generated LaTeX files. This will instruct LaTeX to keep
1634+# running if errors occur, instead of asking the user for help.
1635 # This option is also used when generating formulas in HTML.
1636
1637 LATEX_BATCHMODE = YES
1638
1639-# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1640-# include the index chapters (such as File Index, Compound Index, etc.)
1641+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1642+# include the index chapters (such as File Index, Compound Index, etc.)
1643 # in the output.
1644
1645 LATEX_HIDE_INDICES = NO
1646
1647+# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1648+# source code with syntax highlighting in the LaTeX output.
1649+# Note that which sources are shown also depends on other settings
1650+# such as SOURCE_BROWSER.
1651+
1652+LATEX_SOURCE_CODE = NO
1653+
1654+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1655+# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1656+# http://en.wikipedia.org/wiki/BibTeX for more info.
1657+
1658+LATEX_BIB_STYLE = plain
1659+
1660 #---------------------------------------------------------------------------
1661 # configuration options related to the RTF output
1662 #---------------------------------------------------------------------------
1663
1664-# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1665-# The RTF output is optimized for Word 97 and may not look very pretty with
1666+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1667+# The RTF output is optimized for Word 97 and may not look very pretty with
1668 # other RTF readers or editors.
1669
1670 GENERATE_RTF = NO
1671
1672-# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1673-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1674+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1675+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1676 # put in front of it. If left blank `rtf' will be used as the default path.
1677
1678 RTF_OUTPUT = rtf
1679
1680-# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1681-# RTF documents. This may be useful for small projects and may help to
1682+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1683+# RTF documents. This may be useful for small projects and may help to
1684 # save some trees in general.
1685
1686 COMPACT_RTF = NO
1687
1688-# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1689-# will contain hyperlink fields. The RTF file will
1690-# contain links (just like the HTML output) instead of page references.
1691-# This makes the output suitable for online browsing using WORD or other
1692-# programs which support those fields.
1693+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1694+# will contain hyperlink fields. The RTF file will
1695+# contain links (just like the HTML output) instead of page references.
1696+# This makes the output suitable for online browsing using WORD or other
1697+# programs which support those fields.
1698 # Note: wordpad (write) and others do not support links.
1699
1700 RTF_HYPERLINKS = NO
1701
1702-# Load stylesheet definitions from file. Syntax is similar to doxygen's
1703-# config file, i.e. a series of assignments. You only have to provide
1704+# Load stylesheet definitions from file. Syntax is similar to doxygen's
1705+# config file, i.e. a series of assignments. You only have to provide
1706 # replacements, missing definitions are set to their default value.
1707
1708-RTF_STYLESHEET_FILE =
1709+RTF_STYLESHEET_FILE =
1710
1711-# Set optional variables used in the generation of an rtf document.
1712+# Set optional variables used in the generation of an rtf document.
1713 # Syntax is similar to doxygen's config file.
1714
1715-RTF_EXTENSIONS_FILE =
1716+RTF_EXTENSIONS_FILE =
1717
1718 #---------------------------------------------------------------------------
1719 # configuration options related to the man page output
1720 #---------------------------------------------------------------------------
1721
1722-# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1723+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1724 # generate man pages
1725
1726 GENERATE_MAN = NO
1727
1728-# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1729-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1730+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1731+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1732 # put in front of it. If left blank `man' will be used as the default path.
1733
1734 MAN_OUTPUT = man
1735
1736-# The MAN_EXTENSION tag determines the extension that is added to
1737+# The MAN_EXTENSION tag determines the extension that is added to
1738 # the generated man pages (default is the subroutine's section .3)
1739
1740 MAN_EXTENSION = .3
1741
1742-# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1743-# then it will generate one additional man file for each entity
1744-# documented in the real man page(s). These additional files
1745-# only source the real man page, but without them the man command
1746+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1747+# then it will generate one additional man file for each entity
1748+# documented in the real man page(s). These additional files
1749+# only source the real man page, but without them the man command
1750 # would be unable to find the correct page. The default is NO.
1751
1752 MAN_LINKS = NO
1753@@ -880,33 +1364,33 @@
1754 # configuration options related to the XML output
1755 #---------------------------------------------------------------------------
1756
1757-# If the GENERATE_XML tag is set to YES Doxygen will
1758-# generate an XML file that captures the structure of
1759+# If the GENERATE_XML tag is set to YES Doxygen will
1760+# generate an XML file that captures the structure of
1761 # the code including all documentation.
1762
1763 GENERATE_XML = NO
1764
1765-# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1766-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1767+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1768+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1769 # put in front of it. If left blank `xml' will be used as the default path.
1770
1771 XML_OUTPUT = xml
1772
1773-# The XML_SCHEMA tag can be used to specify an XML schema,
1774-# which can be used by a validating XML parser to check the
1775-# syntax of the XML files.
1776-
1777-XML_SCHEMA =
1778-
1779-# The XML_DTD tag can be used to specify an XML DTD,
1780-# which can be used by a validating XML parser to check the
1781-# syntax of the XML files.
1782-
1783-XML_DTD =
1784-
1785-# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1786-# dump the program listings (including syntax highlighting
1787-# and cross-referencing information) to the XML output. Note that
1788+# The XML_SCHEMA tag can be used to specify an XML schema,
1789+# which can be used by a validating XML parser to check the
1790+# syntax of the XML files.
1791+
1792+XML_SCHEMA =
1793+
1794+# The XML_DTD tag can be used to specify an XML DTD,
1795+# which can be used by a validating XML parser to check the
1796+# syntax of the XML files.
1797+
1798+XML_DTD =
1799+
1800+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1801+# dump the program listings (including syntax highlighting
1802+# and cross-referencing information) to the XML output. Note that
1803 # enabling this will significantly increase the size of the XML output.
1804
1805 XML_PROGRAMLISTING = YES
1806@@ -915,10 +1399,10 @@
1807 # configuration options for the AutoGen Definitions output
1808 #---------------------------------------------------------------------------
1809
1810-# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1811-# generate an AutoGen Definitions (see autogen.sf.net) file
1812-# that captures the structure of the code including all
1813-# documentation. Note that this feature is still experimental
1814+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1815+# generate an AutoGen Definitions (see autogen.sf.net) file
1816+# that captures the structure of the code including all
1817+# documentation. Note that this feature is still experimental
1818 # and incomplete at the moment.
1819
1820 GENERATE_AUTOGEN_DEF = NO
1821@@ -927,286 +1411,359 @@
1822 # configuration options related to the Perl module output
1823 #---------------------------------------------------------------------------
1824
1825-# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1826-# generate a Perl module file that captures the structure of
1827-# the code including all documentation. Note that this
1828-# feature is still experimental and incomplete at the
1829+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1830+# generate a Perl module file that captures the structure of
1831+# the code including all documentation. Note that this
1832+# feature is still experimental and incomplete at the
1833 # moment.
1834
1835 GENERATE_PERLMOD = NO
1836
1837-# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1838-# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1839+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1840+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1841 # to generate PDF and DVI output from the Perl module output.
1842
1843 PERLMOD_LATEX = NO
1844
1845-# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1846-# nicely formatted so it can be parsed by a human reader. This is useful
1847-# if you want to understand what is going on. On the other hand, if this
1848-# tag is set to NO the size of the Perl module output will be much smaller
1849+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1850+# nicely formatted so it can be parsed by a human reader.
1851+# This is useful
1852+# if you want to understand what is going on.
1853+# On the other hand, if this
1854+# tag is set to NO the size of the Perl module output will be much smaller
1855 # and Perl will parse it just the same.
1856
1857 PERLMOD_PRETTY = YES
1858
1859-# The names of the make variables in the generated doxyrules.make file
1860-# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1861-# This is useful so different doxyrules.make files included by the same
1862+# The names of the make variables in the generated doxyrules.make file
1863+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1864+# This is useful so different doxyrules.make files included by the same
1865 # Makefile don't overwrite each other's variables.
1866
1867-PERLMOD_MAKEVAR_PREFIX =
1868-
1869-#---------------------------------------------------------------------------
1870-# Configuration options related to the preprocessor
1871-#---------------------------------------------------------------------------
1872-
1873-# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1874-# evaluate all C-preprocessor directives found in the sources and include
1875+PERLMOD_MAKEVAR_PREFIX =
1876+
1877+#---------------------------------------------------------------------------
1878+# Configuration options related to the preprocessor
1879+#---------------------------------------------------------------------------
1880+
1881+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1882+# evaluate all C-preprocessor directives found in the sources and include
1883 # files.
1884
1885 ENABLE_PREPROCESSING = YES
1886
1887-# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1888-# names in the source code. If set to NO (the default) only conditional
1889-# compilation will be performed. Macro expansion can be done in a controlled
1890+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1891+# names in the source code. If set to NO (the default) only conditional
1892+# compilation will be performed. Macro expansion can be done in a controlled
1893 # way by setting EXPAND_ONLY_PREDEF to YES.
1894
1895 MACRO_EXPANSION = YES
1896
1897-# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1898-# then the macro expansion is limited to the macros specified with the
1899+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1900+# then the macro expansion is limited to the macros specified with the
1901 # PREDEFINED and EXPAND_AS_DEFINED tags.
1902
1903 EXPAND_ONLY_PREDEF = YES
1904
1905-# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1906-# in the INCLUDE_PATH (see below) will be search if a #include is found.
1907+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1908+# pointed to by INCLUDE_PATH will be searched when a #include is found.
1909
1910 SEARCH_INCLUDES = YES
1911
1912-# The INCLUDE_PATH tag can be used to specify one or more directories that
1913-# contain include files that are not input files but should be processed by
1914+# The INCLUDE_PATH tag can be used to specify one or more directories that
1915+# contain include files that are not input files but should be processed by
1916 # the preprocessor.
1917
1918-INCLUDE_PATH =
1919+INCLUDE_PATH =
1920
1921-# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1922-# patterns (like *.h and *.hpp) to filter out the header-files in the
1923-# directories. If left blank, the patterns specified with FILE_PATTERNS will
1924+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1925+# patterns (like *.h and *.hpp) to filter out the header-files in the
1926+# directories. If left blank, the patterns specified with FILE_PATTERNS will
1927 # be used.
1928
1929-INCLUDE_FILE_PATTERNS =
1930+INCLUDE_FILE_PATTERNS =
1931
1932-# The PREDEFINED tag can be used to specify one or more macro names that
1933-# are defined before the preprocessor is started (similar to the -D option of
1934-# gcc). The argument of the tag is a list of macros of the form: name
1935-# or name=definition (no spaces). If the definition and the = are
1936-# omitted =1 is assumed. To prevent a macro definition from being
1937-# undefined via #undef or recursively expanded use the := operator
1938+# The PREDEFINED tag can be used to specify one or more macro names that
1939+# are defined before the preprocessor is started (similar to the -D option of
1940+# gcc). The argument of the tag is a list of macros of the form: name
1941+# or name=definition (no spaces). If the definition and the = are
1942+# omitted =1 is assumed. To prevent a macro definition from being
1943+# undefined via #undef or recursively expanded use the := operator
1944 # instead of the = operator.
1945
1946-PREDEFINED =
1947-
1948-# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1949-# this tag can be used to specify a list of macro names that should be expanded.
1950-# The macro definition that is found in the sources will be used.
1951-# Use the PREDEFINED tag if you want to use a different macro definition.
1952-
1953-EXPAND_AS_DEFINED =
1954-
1955-# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1956-# doxygen's preprocessor will remove all function-like macros that are alone
1957-# on a line, have an all uppercase name, and do not end with a semicolon. Such
1958-# function macros are typically used for boiler-plate code, and will confuse
1959-# the parser if not removed.
1960+PREDEFINED =
1961+
1962+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1963+# this tag can be used to specify a list of macro names that should be expanded.
1964+# The macro definition that is found in the sources will be used.
1965+# Use the PREDEFINED tag if you want to use a different macro definition that
1966+# overrules the definition found in the source code.
1967+
1968+EXPAND_AS_DEFINED =
1969+
1970+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1971+# doxygen's preprocessor will remove all references to function-like macros
1972+# that are alone on a line, have an all uppercase name, and do not end with a
1973+# semicolon, because these will confuse the parser if not removed.
1974
1975 SKIP_FUNCTION_MACROS = YES
1976
1977 #---------------------------------------------------------------------------
1978-# Configuration::additions related to external references
1979+# Configuration::additions related to external references
1980 #---------------------------------------------------------------------------
1981
1982-# The TAGFILES option can be used to specify one or more tagfiles.
1983-# Optionally an initial location of the external documentation
1984-# can be added for each tagfile. The format of a tag file without
1985-# this location is as follows:
1986-# TAGFILES = file1 file2 ...
1987-# Adding location for the tag files is done as follows:
1988-# TAGFILES = file1=loc1 "file2 = loc2" ...
1989-# where "loc1" and "loc2" can be relative or absolute paths or
1990-# URLs. If a location is present for each tag, the installdox tool
1991+# The TAGFILES option can be used to specify one or more tagfiles.
1992+# Optionally an initial location of the external documentation
1993+# can be added for each tagfile. The format of a tag file without
1994+# this location is as follows:
1995+#
1996+# TAGFILES = file1 file2 ...
1997+# Adding location for the tag files is done as follows:
1998+#
1999+# TAGFILES = file1=loc1 "file2 = loc2" ...
2000+# where "loc1" and "loc2" can be relative or absolute paths or
2001+# URLs. If a location is present for each tag, the installdox tool
2002 # does not have to be run to correct the links.
2003 # Note that each tag file must have a unique name
2004 # (where the name does NOT include the path)
2005-# If a tag file is not located in the directory in which doxygen
2006+# If a tag file is not located in the directory in which doxygen
2007 # is run, you must also specify the path to the tagfile here.
2008
2009-TAGFILES =
2010+TAGFILES =
2011
2012-# When a file name is specified after GENERATE_TAGFILE, doxygen will create
2013+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
2014 # a tag file that is based on the input files it reads.
2015
2016 GENERATE_TAGFILE = html/@PROJECT_NAME@.TAGFILE
2017
2018-# If the ALLEXTERNALS tag is set to YES all external classes will be listed
2019-# in the class index. If set to NO only the inherited external classes
2020+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
2021+# in the class index. If set to NO only the inherited external classes
2022 # will be listed.
2023
2024 ALLEXTERNALS = YES
2025
2026-# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
2027-# in the modules index. If set to NO, only the current project's groups will
2028+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
2029+# in the modules index. If set to NO, only the current project's groups will
2030 # be listed.
2031
2032 EXTERNAL_GROUPS = YES
2033
2034-# The PERL_PATH should be the absolute path and name of the perl script
2035+# The PERL_PATH should be the absolute path and name of the perl script
2036 # interpreter (i.e. the result of `which perl').
2037
2038 PERL_PATH = /usr/bin/perl
2039
2040 #---------------------------------------------------------------------------
2041-# Configuration options related to the dot tool
2042+# Configuration options related to the dot tool
2043 #---------------------------------------------------------------------------
2044
2045-# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
2046-# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
2047-# or super classes. Setting the tag to NO turns the diagrams off. Note that
2048-# this option is superseded by the HAVE_DOT option below. This is only a
2049-# fallback. It is recommended to install and use dot, since it yields more
2050-# powerful graphs.
2051+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
2052+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
2053+# or super classes. Setting the tag to NO turns the diagrams off. Note that
2054+# this option also works with HAVE_DOT disabled, but it is recommended to
2055+# install and use dot, since it yields more powerful graphs.
2056
2057 CLASS_DIAGRAMS = YES
2058
2059-# If set to YES, the inheritance and collaboration graphs will hide
2060-# inheritance and usage relations if the target is undocumented
2061+# You can define message sequence charts within doxygen comments using the \msc
2062+# command. Doxygen will then run the mscgen tool (see
2063+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
2064+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2065+# the mscgen tool resides. If left empty the tool is assumed to be found in the
2066+# default search path.
2067+
2068+MSCGEN_PATH =
2069+
2070+# If set to YES, the inheritance and collaboration graphs will hide
2071+# inheritance and usage relations if the target is undocumented
2072 # or is not a class.
2073
2074 HIDE_UNDOC_RELATIONS = YES
2075
2076-# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2077-# available from the path. This tool is part of Graphviz, a graph visualization
2078-# toolkit from AT&T and Lucent Bell Labs. The other options in this section
2079+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2080+# available from the path. This tool is part of Graphviz, a graph visualization
2081+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
2082 # have no effect if this option is set to NO (the default)
2083
2084 HAVE_DOT = @DOXYGEN_DOT_FOUND@
2085
2086-# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
2087-# will generate a graph for each documented class showing the direct and
2088-# indirect inheritance relations. Setting this tag to YES will force the
2089+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
2090+# allowed to run in parallel. When set to 0 (the default) doxygen will
2091+# base this on the number of processors available in the system. You can set it
2092+# explicitly to a value larger than 0 to get control over the balance
2093+# between CPU load and processing speed.
2094+
2095+DOT_NUM_THREADS = 0
2096+
2097+# By default doxygen will use the Helvetica font for all dot files that
2098+# doxygen generates. When you want a differently looking font you can specify
2099+# the font name using DOT_FONTNAME. You need to make sure dot is able to find
2100+# the font, which can be done by putting it in a standard location or by setting
2101+# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2102+# directory containing the font.
2103+
2104+DOT_FONTNAME = Helvetica
2105+
2106+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
2107+# The default size is 10pt.
2108+
2109+DOT_FONTSIZE = 10
2110+
2111+# By default doxygen will tell dot to use the Helvetica font.
2112+# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
2113+# set the path where dot can find it.
2114+
2115+DOT_FONTPATH =
2116+
2117+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
2118+# will generate a graph for each documented class showing the direct and
2119+# indirect inheritance relations. Setting this tag to YES will force the
2120 # the CLASS_DIAGRAMS tag to NO.
2121
2122 CLASS_GRAPH = YES
2123
2124-# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
2125-# will generate a graph for each documented class showing the direct and
2126-# indirect implementation dependencies (inheritance, containment, and
2127+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
2128+# will generate a graph for each documented class showing the direct and
2129+# indirect implementation dependencies (inheritance, containment, and
2130 # class references variables) of the class with other documented classes.
2131
2132 COLLABORATION_GRAPH = YES
2133
2134-# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
2135+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
2136 # will generate a graph for groups, showing the direct groups dependencies
2137
2138 GROUP_GRAPHS = YES
2139
2140-# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2141-# collaboration diagrams in a style similar to the OMG's Unified Modeling
2142+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2143+# collaboration diagrams in a style similar to the OMG's Unified Modeling
2144 # Language.
2145
2146 UML_LOOK = NO
2147-# UML_LOOK = YES
2148
2149-# If set to YES, the inheritance and collaboration graphs will show the
2150+# If set to YES, the inheritance and collaboration graphs will show the
2151 # relations between templates and their instances.
2152
2153 TEMPLATE_RELATIONS = YES
2154
2155-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
2156-# tags are set to YES then doxygen will generate a graph for each documented
2157-# file showing the direct and indirect include dependencies of the file with
2158+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
2159+# tags are set to YES then doxygen will generate a graph for each documented
2160+# file showing the direct and indirect include dependencies of the file with
2161 # other documented files.
2162
2163 INCLUDE_GRAPH = YES
2164
2165-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
2166-# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
2167-# documented header file showing the documented files that directly or
2168+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
2169+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
2170+# documented header file showing the documented files that directly or
2171 # indirectly include this file.
2172
2173 INCLUDED_BY_GRAPH = YES
2174
2175-# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
2176-# generate a call dependency graph for every global function or class method.
2177-# Note that enabling this option will significantly increase the time of a run.
2178-# So in most cases it will be better to enable call graphs for selected
2179-# functions only using the \callgraph command.
2180+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
2181+# doxygen will generate a call dependency graph for every global function
2182+# or class method. Note that enabling this option will significantly increase
2183+# the time of a run. So in most cases it will be better to enable call graphs
2184+# for selected functions only using the \callgraph command.
2185
2186 CALL_GRAPH = NO
2187
2188-# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
2189-# will graphical hierarchy of all classes instead of a textual one.
2190+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
2191+# doxygen will generate a caller dependency graph for every global function
2192+# or class method. Note that enabling this option will significantly increase
2193+# the time of a run. So in most cases it will be better to enable caller
2194+# graphs for selected functions only using the \callergraph command.
2195+
2196+CALLER_GRAPH = NO
2197+
2198+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
2199+# will generate a graphical hierarchy of all classes instead of a textual one.
2200
2201 GRAPHICAL_HIERARCHY = YES
2202
2203-# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
2204-# then doxygen will show the dependencies a directory has on other directories
2205+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
2206+# then doxygen will show the dependencies a directory has on other directories
2207 # in a graphical way. The dependency relations are determined by the #include
2208 # relations between the files in the directories.
2209
2210 DIRECTORY_GRAPH = YES
2211
2212-# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2213-# generated by dot. Possible values are png, jpg, or gif
2214-# If left blank png will be used.
2215+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2216+# generated by dot. Possible values are svg, png, jpg, or gif.
2217+# If left blank png will be used. If you choose svg you need to set
2218+# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
2219+# visible in IE 9+ (other browsers do not have this requirement).
2220
2221 DOT_IMAGE_FORMAT = png
2222
2223-# The tag DOT_PATH can be used to specify the path where the dot tool can be
2224+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2225+# enable generation of interactive SVG images that allow zooming and panning.
2226+# Note that this requires a modern browser other than Internet Explorer.
2227+# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
2228+# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
2229+# visible. Older versions of IE do not have SVG support.
2230+
2231+INTERACTIVE_SVG = NO
2232+
2233+# The tag DOT_PATH can be used to specify the path where the dot tool can be
2234 # found. If left blank, it is assumed the dot tool can be found in the path.
2235
2236 DOT_PATH = @DOXYGEN_DOT_EXECUTABLE_PATH@
2237
2238-# The DOTFILE_DIRS tag can be used to specify one or more directories that
2239-# contain dot files that are included in the documentation (see the
2240+# The DOTFILE_DIRS tag can be used to specify one or more directories that
2241+# contain dot files that are included in the documentation (see the
2242 # \dotfile command).
2243
2244-DOTFILE_DIRS =
2245-
2246-# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2247-# background. This is disabled by default, which results in a white background.
2248-# Warning: Depending on the platform used, enabling this option may lead to
2249-# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2250-# read).
2251+DOTFILE_DIRS =
2252+
2253+# The MSCFILE_DIRS tag can be used to specify one or more directories that
2254+# contain msc files that are included in the documentation (see the
2255+# \mscfile command).
2256+
2257+MSCFILE_DIRS =
2258+
2259+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
2260+# nodes that will be shown in the graph. If the number of nodes in a graph
2261+# becomes larger than this value, doxygen will truncate the graph, which is
2262+# visualized by representing a node as a red box. Note that doxygen if the
2263+# number of direct children of the root node in a graph is already larger than
2264+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
2265+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2266+
2267+DOT_GRAPH_MAX_NODES = 50
2268+
2269+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
2270+# graphs generated by dot. A depth value of 3 means that only nodes reachable
2271+# from the root by following a path via at most 3 edges will be shown. Nodes
2272+# that lay further from the root node will be omitted. Note that setting this
2273+# option to 1 or 2 may greatly reduce the computation time needed for large
2274+# code bases. Also note that the size of a graph can be further restricted by
2275+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2276+
2277+MAX_DOT_GRAPH_DEPTH = 0
2278+
2279+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2280+# background. This is disabled by default, because dot on Windows does not
2281+# seem to support this out of the box. Warning: Depending on the platform used,
2282+# enabling this option may lead to badly anti-aliased labels on the edges of
2283+# a graph (i.e. they become hard to read).
2284
2285 DOT_TRANSPARENT = NO
2286
2287-# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2288-# files in one run (i.e. multiple -o and -T options on the command line). This
2289-# makes dot run faster, but since only newer versions of dot (>1.8.10)
2290+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2291+# files in one run (i.e. multiple -o and -T options on the command line). This
2292+# makes dot run faster, but since only newer versions of dot (>1.8.10)
2293 # support this, this feature is disabled by default.
2294-# JW
2295-# DOT_MULTI_TARGETS = NO
2296+
2297 DOT_MULTI_TARGETS = YES
2298
2299-# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
2300-# generate a legend page explaining the meaning of the various boxes and
2301+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
2302+# generate a legend page explaining the meaning of the various boxes and
2303 # arrows in the dot generated graphs.
2304
2305 GENERATE_LEGEND = YES
2306
2307-# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
2308-# remove the intermediate dot files that are used to generate
2309+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
2310+# remove the intermediate dot files that are used to generate
2311 # the various graphs.
2312
2313 DOT_CLEANUP = YES
2314-
2315-#---------------------------------------------------------------------------
2316-# Configuration::additions related to the search engine
2317-#---------------------------------------------------------------------------
2318-
2319-# The SEARCHENGINE tag specifies whether or not a search engine should be
2320-# used. If set to NO the values of all tags below this one will be ignored.
2321-
2322-# JW SEARCHENGINE = NO
2323-SEARCHENGINE = NO
2324
2325=== modified file 'doc/cxx/doxy.config.in'
2326--- doc/cxx/doxy.config.in 2011-08-11 18:46:20 +0000
2327+++ doc/cxx/doxy.config.in 2012-03-15 17:48:23 +0000
2328@@ -1,442 +1,623 @@
2329-# Doxyfile 1.4.5
2330+# Doxyfile 1.7.5
2331
2332 # This file describes the settings to be used by the documentation system
2333-# doxygen (www.doxygen.org) for a project
2334+# doxygen (www.doxygen.org) for a project.
2335 #
2336-# All text after a hash (#) is considered a comment and will be ignored
2337+# All text after a hash (#) is considered a comment and will be ignored.
2338 # The format is:
2339 # TAG = value [value, ...]
2340 # For lists items can also be appended using:
2341 # TAG += value [value, ...]
2342-# Values that contain spaces should be placed between quotes (" ")
2343+# Values that contain spaces should be placed between quotes (" ").
2344
2345 #---------------------------------------------------------------------------
2346 # Project related configuration options
2347 #---------------------------------------------------------------------------
2348
2349-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
2350-# by quotes) that should identify the project.
2351-
2352-PROJECT_NAME = Zorba CXX-API
2353-
2354-# The PROJECT_NUMBER tag can be used to enter a project or revision number.
2355-# This could be handy for archiving the generated documentation or
2356+# This tag specifies the encoding used for all characters in the config file
2357+# that follow. The default is UTF-8 which is also the encoding used for all
2358+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
2359+# iconv built into libc) for the transcoding. See
2360+# http://www.gnu.org/software/libiconv for the list of possible encodings.
2361+
2362+DOXYFILE_ENCODING = UTF-8
2363+
2364+# The PROJECT_NAME tag is a single word (or sequence of words) that should
2365+# identify the project. Note that if you do not use Doxywizard you need
2366+# to put quotes around the project name if it contains spaces.
2367+
2368+PROJECT_NAME = "Zorba CXX-API"
2369+
2370+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
2371+# This could be handy for archiving the generated documentation or
2372 # if some version control system is used.
2373
2374 PROJECT_NUMBER = @ZORBA_MAJOR_NUMBER@.@ZORBA_MINOR_NUMBER@.@ZORBA_PATCH_NUMBER@
2375
2376-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
2377-# base path where the generated documentation will be put.
2378-# If a relative path is entered, it will be relative to the location
2379+# Using the PROJECT_BRIEF tag one can provide an optional one line description
2380+# for a project that appears at the top of each page and should give viewer
2381+# a quick idea about the purpose of the project. Keep the description short.
2382+
2383+PROJECT_BRIEF =
2384+
2385+# With the PROJECT_LOGO tag one can specify an logo or icon that is
2386+# included in the documentation. The maximum height of the logo should not
2387+# exceed 55 pixels and the maximum width should not exceed 200 pixels.
2388+# Doxygen will copy the logo to the output directory.
2389+
2390+PROJECT_LOGO =
2391+
2392+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
2393+# base path where the generated documentation will be put.
2394+# If a relative path is entered, it will be relative to the location
2395 # where doxygen was started. If left blank the current directory will be used.
2396
2397 OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
2398
2399-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
2400-# 4096 sub-directories (in 2 levels) under the output directory of each output
2401-# format and will distribute the generated files over these directories.
2402-# Enabling this option can be useful when feeding doxygen a huge amount of
2403-# source files, where putting all generated files in the same directory would
2404+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
2405+# 4096 sub-directories (in 2 levels) under the output directory of each output
2406+# format and will distribute the generated files over these directories.
2407+# Enabling this option can be useful when feeding doxygen a huge amount of
2408+# source files, where putting all generated files in the same directory would
2409 # otherwise cause performance problems for the file system.
2410
2411 CREATE_SUBDIRS = NO
2412
2413-# The OUTPUT_LANGUAGE tag is used to specify the language in which all
2414-# documentation generated by doxygen is written. Doxygen will use this
2415-# information to generate all constant output in the proper language.
2416-# The default language is English, other supported languages are:
2417-# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
2418-# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
2419-# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
2420-# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
2421-# Swedish, and Ukrainian.
2422+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
2423+# documentation generated by doxygen is written. Doxygen will use this
2424+# information to generate all constant output in the proper language.
2425+# The default language is English, other supported languages are:
2426+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
2427+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
2428+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
2429+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
2430+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
2431+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
2432
2433 OUTPUT_LANGUAGE = English
2434
2435-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
2436-# include brief member descriptions after the members that are listed in
2437-# the file and class documentation (similar to JavaDoc).
2438+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
2439+# include brief member descriptions after the members that are listed in
2440+# the file and class documentation (similar to JavaDoc).
2441 # Set to NO to disable this.
2442
2443 BRIEF_MEMBER_DESC = YES
2444
2445-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
2446-# the brief description of a member or function before the detailed description.
2447-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
2448+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
2449+# the brief description of a member or function before the detailed description.
2450+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
2451 # brief descriptions will be completely suppressed.
2452
2453 REPEAT_BRIEF = YES
2454
2455-# This tag implements a quasi-intelligent brief description abbreviator
2456-# that is used to form the text in various listings. Each string
2457-# in this list, if found as the leading text of the brief description, will be
2458-# stripped from the text and the result after processing the whole list, is
2459-# used as the annotated text. Otherwise, the brief description is used as-is.
2460-# If left blank, the following values are used ("$name" is automatically
2461-# replaced with the name of the entity): "The $name class" "The $name widget"
2462-# "The $name file" "is" "provides" "specifies" "contains"
2463+# This tag implements a quasi-intelligent brief description abbreviator
2464+# that is used to form the text in various listings. Each string
2465+# in this list, if found as the leading text of the brief description, will be
2466+# stripped from the text and the result after processing the whole list, is
2467+# used as the annotated text. Otherwise, the brief description is used as-is.
2468+# If left blank, the following values are used ("$name" is automatically
2469+# replaced with the name of the entity): "The $name class" "The $name widget"
2470+# "The $name file" "is" "provides" "specifies" "contains"
2471 # "represents" "a" "an" "the"
2472
2473-ABBREVIATE_BRIEF =
2474+ABBREVIATE_BRIEF =
2475
2476-# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
2477-# Doxygen will generate a detailed section even if there is only a brief
2478+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
2479+# Doxygen will generate a detailed section even if there is only a brief
2480 # description.
2481
2482 ALWAYS_DETAILED_SEC = NO
2483
2484-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
2485-# inherited members of a class in the documentation of that class as if those
2486-# members were ordinary class members. Constructors, destructors and assignment
2487+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
2488+# inherited members of a class in the documentation of that class as if those
2489+# members were ordinary class members. Constructors, destructors and assignment
2490 # operators of the base classes will not be shown.
2491
2492 INLINE_INHERITED_MEMB = YES
2493
2494-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
2495-# path before files name in the file list and in the header files. If set
2496+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
2497+# path before files name in the file list and in the header files. If set
2498 # to NO the shortest path that makes the file name unique will be used.
2499
2500 FULL_PATH_NAMES = NO
2501
2502-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
2503-# can be used to strip a user-defined part of the path. Stripping is
2504-# only done if one of the specified strings matches the left-hand part of
2505-# the path. The tag can be used to show relative paths in the file list.
2506-# If left blank the directory from which doxygen is run is used as the
2507+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
2508+# can be used to strip a user-defined part of the path. Stripping is
2509+# only done if one of the specified strings matches the left-hand part of
2510+# the path. The tag can be used to show relative paths in the file list.
2511+# If left blank the directory from which doxygen is run is used as the
2512 # path to strip.
2513
2514-STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src @CMAKE_BINARY_DIR@/src
2515-
2516-
2517-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
2518-# the path mentioned in the documentation of a class, which tells
2519-# the reader which header file to include in order to use a class.
2520-# If left blank only the name of the header file containing the class
2521-# definition is used. Otherwise one should specify the include paths that
2522+STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src \
2523+ @CMAKE_BINARY_DIR@/src
2524+
2525+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
2526+# the path mentioned in the documentation of a class, which tells
2527+# the reader which header file to include in order to use a class.
2528+# If left blank only the name of the header file containing the class
2529+# definition is used. Otherwise one should specify the include paths that
2530 # are normally passed to the compiler using the -I flag.
2531
2532-STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include @CMAKE_BINARY_DIR@/include
2533+STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include \
2534+ @CMAKE_BINARY_DIR@/include
2535
2536-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
2537-# (but less readable) file names. This can be useful is your file systems
2538+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
2539+# (but less readable) file names. This can be useful if your file system
2540 # doesn't support long names like on DOS, Mac, or CD-ROM.
2541
2542 SHORT_NAMES = NO
2543
2544-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
2545-# will interpret the first line (until the first dot) of a JavaDoc-style
2546-# comment as the brief description. If set to NO, the JavaDoc
2547-# comments will behave just like the Qt-style comments (thus requiring an
2548-# explicit @brief command for a brief description.
2549+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
2550+# will interpret the first line (until the first dot) of a JavaDoc-style
2551+# comment as the brief description. If set to NO, the JavaDoc
2552+# comments will behave just like regular Qt-style comments
2553+# (thus requiring an explicit @brief command for a brief description.)
2554
2555 JAVADOC_AUTOBRIEF = YES
2556
2557-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
2558-# treat a multi-line C++ special comment block (i.e. a block of //! or ///
2559-# comments) as a brief description. This used to be the default behaviour.
2560-# The new default is to treat a multi-line C++ comment block as a detailed
2561+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
2562+# interpret the first line (until the first dot) of a Qt-style
2563+# comment as the brief description. If set to NO, the comments
2564+# will behave just like regular Qt-style comments (thus requiring
2565+# an explicit \brief command for a brief description.)
2566+
2567+QT_AUTOBRIEF = NO
2568+
2569+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
2570+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
2571+# comments) as a brief description. This used to be the default behaviour.
2572+# The new default is to treat a multi-line C++ comment block as a detailed
2573 # description. Set this tag to YES if you prefer the old behaviour instead.
2574
2575 MULTILINE_CPP_IS_BRIEF = NO
2576
2577-# If the DETAILS_AT_TOP tag is set to YES then Doxygen
2578-# will output the detailed description near the top, like JavaDoc.
2579-# If set to NO, the detailed description appears after the member
2580-# documentation.
2581-
2582-DETAILS_AT_TOP = NO
2583-
2584-# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
2585-# member inherits the documentation from any documented member that it
2586+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
2587+# member inherits the documentation from any documented member that it
2588 # re-implements.
2589
2590 INHERIT_DOCS = YES
2591
2592-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
2593-# a new page for each member. If set to NO, the documentation of a member will
2594+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
2595+# a new page for each member. If set to NO, the documentation of a member will
2596 # be part of the file/class/namespace that contains it.
2597
2598 SEPARATE_MEMBER_PAGES = NO
2599
2600-# The TAB_SIZE tag can be used to set the number of spaces in a tab.
2601+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
2602 # Doxygen uses this value to replace tabs by spaces in code fragments.
2603
2604 TAB_SIZE = 2
2605
2606-# This tag can be used to specify a number of aliases that acts
2607-# as commands in the documentation. An alias has the form "name=value".
2608-# For example adding "sideeffect=\par Side Effects:\n" will allow you to
2609-# put the command \sideeffect (or @sideeffect) in the documentation, which
2610-# will result in a user-defined paragraph with heading "Side Effects:".
2611+# This tag can be used to specify a number of aliases that acts
2612+# as commands in the documentation. An alias has the form "name=value".
2613+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
2614+# put the command \sideeffect (or @sideeffect) in the documentation, which
2615+# will result in a user-defined paragraph with heading "Side Effects:".
2616 # You can put \n's in the value part of an alias to insert newlines.
2617
2618-ALIASES =
2619+ALIASES =
2620
2621-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
2622-# sources only. Doxygen will then generate output that is more tailored for C.
2623-# For instance, some of the names that are used will be different. The list
2624+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
2625+# sources only. Doxygen will then generate output that is more tailored for C.
2626+# For instance, some of the names that are used will be different. The list
2627 # of all members will be omitted, etc.
2628
2629 OPTIMIZE_OUTPUT_FOR_C = NO
2630
2631-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
2632-# sources only. Doxygen will then generate output that is more tailored for Java.
2633-# For instance, namespaces will be presented as packages, qualified scopes
2634-# will look different, etc.
2635+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
2636+# sources only. Doxygen will then generate output that is more tailored for
2637+# Java. For instance, namespaces will be presented as packages, qualified
2638+# scopes will look different, etc.
2639
2640 OPTIMIZE_OUTPUT_JAVA = NO
2641
2642-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
2643-# include (a tag file for) the STL sources as input, then you should
2644-# set this tag to YES in order to let doxygen match functions declarations and
2645-# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
2646-# func(std::string) {}). This also make the inheritance and collaboration
2647+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
2648+# sources only. Doxygen will then generate output that is more tailored for
2649+# Fortran.
2650+
2651+OPTIMIZE_FOR_FORTRAN = NO
2652+
2653+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
2654+# sources. Doxygen will then generate output that is tailored for
2655+# VHDL.
2656+
2657+OPTIMIZE_OUTPUT_VHDL = NO
2658+
2659+# Doxygen selects the parser to use depending on the extension of the files it
2660+# parses. With this tag you can assign which parser to use for a given extension.
2661+# Doxygen has a built-in mapping, but you can override or extend it using this
2662+# tag. The format is ext=language, where ext is a file extension, and language
2663+# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
2664+# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
2665+# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
2666+# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
2667+# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
2668+
2669+EXTENSION_MAPPING =
2670+
2671+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
2672+# to include (a tag file for) the STL sources as input, then you should
2673+# set this tag to YES in order to let doxygen match functions declarations and
2674+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
2675+# func(std::string) {}). This also makes the inheritance and collaboration
2676 # diagrams that involve STL classes more complete and accurate.
2677
2678-# BUILTIN_STL_SUPPORT = NO
2679-
2680-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
2681-# tag is set to YES, then doxygen will reuse the documentation of the first
2682-# member in the group (if any) for the other members of the group. By default
2683+BUILTIN_STL_SUPPORT = NO
2684+
2685+# If you use Microsoft's C++/CLI language, you should set this option to YES to
2686+# enable parsing support.
2687+
2688+CPP_CLI_SUPPORT = NO
2689+
2690+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
2691+# Doxygen will parse them like normal C++ but will assume all classes use public
2692+# instead of private inheritance when no explicit protection keyword is present.
2693+
2694+SIP_SUPPORT = NO
2695+
2696+# For Microsoft's IDL there are propget and propput attributes to indicate getter
2697+# and setter methods for a property. Setting this option to YES (the default)
2698+# will make doxygen replace the get and set methods by a property in the
2699+# documentation. This will only work if the methods are indeed getting or
2700+# setting a simple type. If this is not the case, or you want to show the
2701+# methods anyway, you should set this option to NO.
2702+
2703+IDL_PROPERTY_SUPPORT = YES
2704+
2705+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
2706+# tag is set to YES, then doxygen will reuse the documentation of the first
2707+# member in the group (if any) for the other members of the group. By default
2708 # all members of a group must be documented explicitly.
2709
2710 DISTRIBUTE_GROUP_DOC = NO
2711
2712-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
2713-# the same type (for instance a group of public functions) to be put as a
2714-# subgroup of that type (e.g. under the Public Functions section). Set it to
2715-# NO to prevent subgrouping. Alternatively, this can be done per class using
2716+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
2717+# the same type (for instance a group of public functions) to be put as a
2718+# subgroup of that type (e.g. under the Public Functions section). Set it to
2719+# NO to prevent subgrouping. Alternatively, this can be done per class using
2720 # the \nosubgrouping command.
2721
2722 SUBGROUPING = YES
2723
2724+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
2725+# unions are shown inside the group in which they are included (e.g. using
2726+# @ingroup) instead of on a separate page (for HTML and Man pages) or
2727+# section (for LaTeX and RTF).
2728+
2729+INLINE_GROUPED_CLASSES = NO
2730+
2731+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
2732+# unions with only public data fields will be shown inline in the documentation
2733+# of the scope in which they are defined (i.e. file, namespace, or group
2734+# documentation), provided this scope is documented. If set to NO (the default),
2735+# structs, classes, and unions are shown on a separate page (for HTML and Man
2736+# pages) or section (for LaTeX and RTF).
2737+
2738+INLINE_SIMPLE_STRUCTS = NO
2739+
2740+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
2741+# is documented as struct, union, or enum with the name of the typedef. So
2742+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
2743+# with name TypeT. When disabled the typedef will appear as a member of a file,
2744+# namespace, or class. And the struct will be named TypeS. This can typically
2745+# be useful for C code in case the coding convention dictates that all compound
2746+# types are typedef'ed and only the typedef is referenced, never the tag name.
2747+
2748+TYPEDEF_HIDES_STRUCT = NO
2749+
2750+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
2751+# determine which symbols to keep in memory and which to flush to disk.
2752+# When the cache is full, less often used symbols will be written to disk.
2753+# For small to medium size projects (<1000 input files) the default value is
2754+# probably good enough. For larger projects a too small cache size can cause
2755+# doxygen to be busy swapping symbols to and from disk most of the time
2756+# causing a significant performance penalty.
2757+# If the system has enough physical memory increasing the cache will improve the
2758+# performance by keeping more symbols in memory. Note that the value works on
2759+# a logarithmic scale so increasing the size by one will roughly double the
2760+# memory usage. The cache size is given by this formula:
2761+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
2762+# corresponding to a cache size of 2^16 = 65536 symbols
2763+
2764+SYMBOL_CACHE_SIZE = 0
2765+
2766 #---------------------------------------------------------------------------
2767 # Build related configuration options
2768 #---------------------------------------------------------------------------
2769
2770-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
2771-# documentation are documented, even if no documentation was available.
2772-# Private class members and static file members will be hidden unless
2773+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
2774+# documentation are documented, even if no documentation was available.
2775+# Private class members and static file members will be hidden unless
2776 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
2777
2778 EXTRACT_ALL = YES
2779
2780-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
2781+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
2782 # will be included in the documentation.
2783
2784 EXTRACT_PRIVATE = NO
2785
2786-# If the EXTRACT_STATIC tag is set to YES all static members of a file
2787+# If the EXTRACT_STATIC tag is set to YES all static members of a file
2788 # will be included in the documentation.
2789
2790 EXTRACT_STATIC = NO
2791
2792-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
2793-# defined locally in source files will be included in the documentation.
2794+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
2795+# defined locally in source files will be included in the documentation.
2796 # If set to NO only classes defined in header files are included.
2797
2798 EXTRACT_LOCAL_CLASSES = YES
2799
2800-# This flag is only useful for Objective-C code. When set to YES local
2801-# methods, which are defined in the implementation section but not in
2802-# the interface are included in the documentation.
2803+# This flag is only useful for Objective-C code. When set to YES local
2804+# methods, which are defined in the implementation section but not in
2805+# the interface are included in the documentation.
2806 # If set to NO (the default) only methods in the interface are included.
2807
2808 EXTRACT_LOCAL_METHODS = NO
2809
2810-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
2811-# undocumented members of documented classes, files or namespaces.
2812-# If set to NO (the default) these members will be included in the
2813-# various overviews, but no documentation section is generated.
2814+# If this flag is set to YES, the members of anonymous namespaces will be
2815+# extracted and appear in the documentation as a namespace called
2816+# 'anonymous_namespace{file}', where file will be replaced with the base
2817+# name of the file that contains the anonymous namespace. By default
2818+# anonymous namespaces are hidden.
2819+
2820+EXTRACT_ANON_NSPACES = NO
2821+
2822+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
2823+# undocumented members of documented classes, files or namespaces.
2824+# If set to NO (the default) these members will be included in the
2825+# various overviews, but no documentation section is generated.
2826 # This option has no effect if EXTRACT_ALL is enabled.
2827
2828 HIDE_UNDOC_MEMBERS = YES
2829
2830-# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
2831-# undocumented classes that are normally visible in the class hierarchy.
2832-# If set to NO (the default) these classes will be included in the various
2833+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
2834+# undocumented classes that are normally visible in the class hierarchy.
2835+# If set to NO (the default) these classes will be included in the various
2836 # overviews. This option has no effect if EXTRACT_ALL is enabled.
2837
2838 HIDE_UNDOC_CLASSES = YES
2839
2840-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
2841-# friend (class|struct|union) declarations.
2842-# If set to NO (the default) these declarations will be included in the
2843+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
2844+# friend (class|struct|union) declarations.
2845+# If set to NO (the default) these declarations will be included in the
2846 # documentation.
2847
2848 HIDE_FRIEND_COMPOUNDS = NO
2849
2850-# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
2851-# documentation blocks found inside the body of a function.
2852-# If set to NO (the default) these blocks will be appended to the
2853+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
2854+# documentation blocks found inside the body of a function.
2855+# If set to NO (the default) these blocks will be appended to the
2856 # function's detailed documentation block.
2857
2858 HIDE_IN_BODY_DOCS = NO
2859
2860-# The INTERNAL_DOCS tag determines if documentation
2861-# that is typed after a \internal command is included. If the tag is set
2862-# to NO (the default) then the documentation will be excluded.
2863+# The INTERNAL_DOCS tag determines if documentation
2864+# that is typed after a \internal command is included. If the tag is set
2865+# to NO (the default) then the documentation will be excluded.
2866 # Set it to YES to include the internal documentation.
2867
2868 INTERNAL_DOCS = NO
2869
2870-# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
2871-# file names in lower-case letters. If set to YES upper-case letters are also
2872-# allowed. This is useful if you have classes or files whose names only differ
2873-# in case and if your file system supports case sensitive file names. Windows
2874+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
2875+# file names in lower-case letters. If set to YES upper-case letters are also
2876+# allowed. This is useful if you have classes or files whose names only differ
2877+# in case and if your file system supports case sensitive file names. Windows
2878 # and Mac users are advised to set this option to NO.
2879
2880 CASE_SENSE_NAMES = YES
2881
2882-# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
2883-# will show members with their full class and namespace scopes in the
2884+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
2885+# will show members with their full class and namespace scopes in the
2886 # documentation. If set to YES the scope will be hidden.
2887
2888 HIDE_SCOPE_NAMES = NO
2889
2890-# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
2891-# will put a list of the files that are included by a file in the documentation
2892+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
2893+# will put a list of the files that are included by a file in the documentation
2894 # of that file.
2895
2896 SHOW_INCLUDE_FILES = YES
2897
2898-# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
2899+# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
2900+# will list include files with double quotes in the documentation
2901+# rather than with sharp brackets.
2902+
2903+FORCE_LOCAL_INCLUDES = NO
2904+
2905+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
2906 # is inserted in the documentation for inline members.
2907
2908 INLINE_INFO = YES
2909
2910-# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
2911-# will sort the (detailed) documentation of file and class members
2912-# alphabetically by member name. If set to NO the members will appear in
2913+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
2914+# will sort the (detailed) documentation of file and class members
2915+# alphabetically by member name. If set to NO the members will appear in
2916 # declaration order.
2917
2918 SORT_MEMBER_DOCS = YES
2919
2920-# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
2921-# brief documentation of file, namespace and class members alphabetically
2922-# by member name. If set to NO (the default) the members will appear in
2923+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
2924+# brief documentation of file, namespace and class members alphabetically
2925+# by member name. If set to NO (the default) the members will appear in
2926 # declaration order.
2927
2928 SORT_BRIEF_DOCS = YES
2929
2930-# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
2931-# sorted by fully-qualified names, including namespaces. If set to
2932-# NO (the default), the class list will be sorted only by class name,
2933-# not including the namespace part.
2934+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
2935+# will sort the (brief and detailed) documentation of class members so that
2936+# constructors and destructors are listed first. If set to NO (the default)
2937+# the constructors will appear in the respective orders defined by
2938+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
2939+# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
2940+# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
2941+
2942+SORT_MEMBERS_CTORS_1ST = NO
2943+
2944+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
2945+# hierarchy of group names into alphabetical order. If set to NO (the default)
2946+# the group names will appear in their defined order.
2947+
2948+SORT_GROUP_NAMES = NO
2949+
2950+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
2951+# sorted by fully-qualified names, including namespaces. If set to
2952+# NO (the default), the class list will be sorted only by class name,
2953+# not including the namespace part.
2954 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
2955-# Note: This option applies only to the class list, not to the
2956+# Note: This option applies only to the class list, not to the
2957 # alphabetical list.
2958
2959 SORT_BY_SCOPE_NAME = NO
2960
2961-# The GENERATE_TODOLIST tag can be used to enable (YES) or
2962-# disable (NO) the todo list. This list is created by putting \todo
2963+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
2964+# do proper type resolution of all parameters of a function it will reject a
2965+# match between the prototype and the implementation of a member function even
2966+# if there is only one candidate or it is obvious which candidate to choose
2967+# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
2968+# will still accept a match between prototype and implementation in such cases.
2969+
2970+STRICT_PROTO_MATCHING = NO
2971+
2972+# The GENERATE_TODOLIST tag can be used to enable (YES) or
2973+# disable (NO) the todo list. This list is created by putting \todo
2974 # commands in the documentation.
2975
2976 GENERATE_TODOLIST = YES
2977
2978-# The GENERATE_TESTLIST tag can be used to enable (YES) or
2979-# disable (NO) the test list. This list is created by putting \test
2980+# The GENERATE_TESTLIST tag can be used to enable (YES) or
2981+# disable (NO) the test list. This list is created by putting \test
2982 # commands in the documentation.
2983
2984 GENERATE_TESTLIST = YES
2985
2986-# The GENERATE_BUGLIST tag can be used to enable (YES) or
2987-# disable (NO) the bug list. This list is created by putting \bug
2988+# The GENERATE_BUGLIST tag can be used to enable (YES) or
2989+# disable (NO) the bug list. This list is created by putting \bug
2990 # commands in the documentation.
2991
2992 GENERATE_BUGLIST = YES
2993
2994-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
2995-# disable (NO) the deprecated list. This list is created by putting
2996+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
2997+# disable (NO) the deprecated list. This list is created by putting
2998 # \deprecated commands in the documentation.
2999
3000 GENERATE_DEPRECATEDLIST= YES
3001
3002-# The ENABLED_SECTIONS tag can be used to enable conditional
3003+# The ENABLED_SECTIONS tag can be used to enable conditional
3004 # documentation sections, marked by \if sectionname ... \endif.
3005
3006 ENABLED_SECTIONS =
3007
3008-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
3009-# the initial value of a variable or define consists of for it to appear in
3010-# the documentation. If the initializer consists of more lines than specified
3011-# here it will be hidden. Use a value of 0 to hide initializers completely.
3012-# The appearance of the initializer of individual variables and defines in the
3013-# documentation can be controlled using \showinitializer or \hideinitializer
3014+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
3015+# the initial value of a variable or macro consists of for it to appear in
3016+# the documentation. If the initializer consists of more lines than specified
3017+# here it will be hidden. Use a value of 0 to hide initializers completely.
3018+# The appearance of the initializer of individual variables and macros in the
3019+# documentation can be controlled using \showinitializer or \hideinitializer
3020 # command in the documentation regardless of this setting.
3021
3022 MAX_INITIALIZER_LINES = 30
3023
3024-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
3025-# at the bottom of the documentation of classes and structs. If set to YES the
3026+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
3027+# at the bottom of the documentation of classes and structs. If set to YES the
3028 # list will mention the files that were used to generate the documentation.
3029
3030 SHOW_USED_FILES = YES
3031
3032-# If the sources in your project are distributed over multiple directories
3033-# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
3034-# in the documentation. The default is YES.
3035+# If the sources in your project are distributed over multiple directories
3036+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
3037+# in the documentation. The default is NO.
3038
3039 SHOW_DIRECTORIES = YES
3040
3041-# The FILE_VERSION_FILTER tag can be used to specify a program or script that
3042-# doxygen should invoke to get the current version for each file (typically from the
3043-# version control system). Doxygen will invoke the program by executing (via
3044-# popen()) the command <command> <input-file>, where <command> is the value of
3045-# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
3046-# provided by doxygen. Whatever the program writes to standard output
3047+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
3048+# This will remove the Files entry from the Quick Index and from the
3049+# Folder Tree View (if specified). The default is YES.
3050+
3051+SHOW_FILES = YES
3052+
3053+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
3054+# Namespaces page.
3055+# This will remove the Namespaces entry from the Quick Index
3056+# and from the Folder Tree View (if specified). The default is YES.
3057+
3058+SHOW_NAMESPACES = YES
3059+
3060+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
3061+# doxygen should invoke to get the current version for each file (typically from
3062+# the version control system). Doxygen will invoke the program by executing (via
3063+# popen()) the command <command> <input-file>, where <command> is the value of
3064+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
3065+# provided by doxygen. Whatever the program writes to standard output
3066 # is used as the file version. See the manual for examples.
3067
3068-FILE_VERSION_FILTER =
3069+FILE_VERSION_FILTER =
3070+
3071+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
3072+# by doxygen. The layout file controls the global structure of the generated
3073+# output files in an output format independent way. The create the layout file
3074+# that represents doxygen's defaults, run doxygen with the -l option.
3075+# You can optionally specify a file name after the option, if omitted
3076+# DoxygenLayout.xml will be used as the name of the layout file.
3077+
3078+LAYOUT_FILE =
3079+
3080+# The CITE_BIB_FILES tag can be used to specify one or more bib files
3081+# containing the references data. This must be a list of .bib files. The
3082+# .bib extension is automatically appended if omitted. Using this command
3083+# requires the bibtex tool to be installed. See also
3084+# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
3085+# of the bibliography can be controlled using LATEX_BIB_STYLE.
3086+
3087+CITE_BIB_FILES =
3088
3089 #---------------------------------------------------------------------------
3090 # configuration options related to warning and progress messages
3091 #---------------------------------------------------------------------------
3092
3093-# The QUIET tag can be used to turn on/off the messages that are generated
3094+# The QUIET tag can be used to turn on/off the messages that are generated
3095 # by doxygen. Possible values are YES and NO. If left blank NO is used.
3096
3097 QUIET = NO
3098
3099-# The WARNINGS tag can be used to turn on/off the warning messages that are
3100-# generated by doxygen. Possible values are YES and NO. If left blank
3101+# The WARNINGS tag can be used to turn on/off the warning messages that are
3102+# generated by doxygen. Possible values are YES and NO. If left blank
3103 # NO is used.
3104
3105 WARNINGS = YES
3106
3107-# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
3108-# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
3109+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
3110+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
3111 # automatically be disabled.
3112
3113 WARN_IF_UNDOCUMENTED = YES
3114
3115-# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
3116-# potential errors in the documentation, such as not documenting some
3117-# parameters in a documented function, or documenting parameters that
3118+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
3119+# potential errors in the documentation, such as not documenting some
3120+# parameters in a documented function, or documenting parameters that
3121 # don't exist or using markup commands wrongly.
3122
3123 WARN_IF_DOC_ERROR = YES
3124
3125-# This WARN_NO_PARAMDOC option can be abled to get warnings for
3126-# functions that are documented, but have no documentation for their parameters
3127-# or return value. If set to NO (the default) doxygen will only warn about
3128-# wrong or incomplete parameter documentation, but not about the absence of
3129+# The WARN_NO_PARAMDOC option can be enabled to get warnings for
3130+# functions that are documented, but have no documentation for their parameters
3131+# or return value. If set to NO (the default) doxygen will only warn about
3132+# wrong or incomplete parameter documentation, but not about the absence of
3133 # documentation.
3134
3135 WARN_NO_PARAMDOC = NO
3136
3137-# The WARN_FORMAT tag determines the format of the warning messages that
3138-# doxygen can produce. The string should contain the $file, $line, and $text
3139-# tags, which will be replaced by the file and line number from which the
3140-# warning originated and the warning text. Optionally the format may contain
3141-# $version, which will be replaced by the version of the file (if it could
3142+# The WARN_FORMAT tag determines the format of the warning messages that
3143+# doxygen can produce. The string should contain the $file, $line, and $text
3144+# tags, which will be replaced by the file and line number from which the
3145+# warning originated and the warning text. Optionally the format may contain
3146+# $version, which will be replaced by the version of the file (if it could
3147 # be obtained via FILE_VERSION_FILTER)
3148
3149 WARN_FORMAT = @DOXY_WARN_FORMAT@
3150
3151-# The WARN_LOGFILE tag can be used to specify a file to which warning
3152-# and error messages should be written. If left blank the output is written
3153+# The WARN_LOGFILE tag can be used to specify a file to which warning
3154+# and error messages should be written. If left blank the output is written
3155 # to stderr.
3156
3157 WARN_LOGFILE = Doc/doxy.log
3158@@ -445,19 +626,29 @@
3159 # configuration options related to the input files
3160 #---------------------------------------------------------------------------
3161
3162-# The INPUT tag can be used to specify the files and/or directories that contain
3163-# documented source files. You may enter file names like "myfile.cpp" or
3164-# directories like "/usr/src/myproject". Separate the files or directories
3165+# The INPUT tag can be used to specify the files and/or directories that contain
3166+# documented source files. You may enter file names like "myfile.cpp" or
3167+# directories like "/usr/src/myproject". Separate the files or directories
3168 # with spaces.
3169
3170-INPUT = @CMAKE_SOURCE_DIR@/include/zorba @CMAKE_CURRENT_SOURCE_DIR@/manual
3171-
3172-# If the value of the INPUT tag contains directories, you can use the
3173-# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
3174-# and *.h) to filter out the source-files in the directories. If left
3175-# blank the following patterns are tested:
3176-# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
3177-# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
3178+INPUT = @CMAKE_SOURCE_DIR@/include/zorba \
3179+ @CMAKE_CURRENT_SOURCE_DIR@/manual
3180+
3181+# This tag can be used to specify the character encoding of the source files
3182+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
3183+# also the default input encoding. Doxygen uses libiconv (or the iconv built
3184+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
3185+# the list of possible encodings.
3186+
3187+INPUT_ENCODING = UTF-8
3188+
3189+# If the value of the INPUT tag contains directories, you can use the
3190+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
3191+# and *.h) to filter out the source-files in the directories. If left
3192+# blank the following patterns are tested:
3193+# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
3194+# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
3195+# *.f90 *.f *.for *.vhd *.vhdl
3196
3197 FILE_PATTERNS = *.cpp \
3198 *.cc \
3199@@ -466,43 +657,53 @@
3200 *.hpp \
3201 *.dox
3202
3203-# The RECURSIVE tag can be used to turn specify whether or not subdirectories
3204-# should be searched for input files as well. Possible values are YES and NO.
3205+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
3206+# should be searched for input files as well. Possible values are YES and NO.
3207 # If left blank NO is used.
3208
3209 RECURSIVE = YES
3210
3211-# The EXCLUDE tag can be used to specify files and/or directories that should
3212-# excluded from the INPUT source files. This way you can easily exclude a
3213+# The EXCLUDE tag can be used to specify files and/or directories that should
3214+# excluded from the INPUT source files. This way you can easily exclude a
3215 # subdirectory from a directory tree whose root is specified with the INPUT tag.
3216-
3217-EXCLUDE =
3218-
3219-# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
3220-# directories that are symbolic links (a Unix filesystem feature) are excluded
3221+# Note that relative paths are relative to directory from which doxygen is run.
3222+
3223+EXCLUDE =
3224+
3225+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
3226+# directories that are symbolic links (a Unix file system feature) are excluded
3227 # from the input.
3228
3229 EXCLUDE_SYMLINKS = NO
3230
3231-# If the value of the INPUT tag contains directories, you can use the
3232-# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
3233-# certain files from those directories. Note that the wildcards are matched
3234-# against the file with absolute path, so to exclude all test directories
3235+# If the value of the INPUT tag contains directories, you can use the
3236+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
3237+# certain files from those directories. Note that the wildcards are matched
3238+# against the file with absolute path, so to exclude all test directories
3239 # for example use the pattern */test/*
3240
3241 EXCLUDE_PATTERNS = */.svn \
3242 */.svn/* \
3243 */zorba/zorbac.h
3244
3245-# The EXAMPLE_PATH tag can be used to specify one or more files or
3246-# directories that contain example code fragments that are included (see
3247+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
3248+# (namespaces, classes, functions, etc.) that should be excluded from the
3249+# output. The symbol name can be a fully qualified name, a word, or if the
3250+# wildcard * is used, a substring. Examples: ANamespace, AClass,
3251+# AClass::ANamespace, ANamespace::*Test
3252+
3253+EXCLUDE_SYMBOLS =
3254+
3255+# The EXAMPLE_PATH tag can be used to specify one or more files or
3256+# directories that contain example code fragments that are included (see
3257 # the \include command).
3258
3259-EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples @CMAKE_SOURCE_DIR@/test/rbkt/Queries
3260+EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples \
3261+ @CMAKE_SOURCE_DIR@/test/rbkt/Queries
3262
3263-# If the value of the EXAMPLE_PATH tag contains directories, you can use the
3264-# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
3265-# and *.h) to filter out the source-files in the directories. If left
3266+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
3267+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
3268+# and *.h) to filter out the source-files in the directories. If left
3269 # blank all files are included.
3270
3271 EXAMPLE_PATTERNS = *.cpp \
3272@@ -510,91 +711,113 @@
3273 *.h \
3274 *.hh \
3275 *.xq \
3276- INSTALL DEPENDENCIES CHANGELOG LICENSE LGPL
3277+ INSTALL \
3278+ DEPENDENCIES \
3279+ CHANGELOG \
3280+ LICENSE \
3281+ LGPL
3282
3283-# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
3284-# searched for input files to be used with the \include or \dontinclude
3285-# commands irrespective of the value of the RECURSIVE tag.
3286+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
3287+# searched for input files to be used with the \include or \dontinclude
3288+# commands irrespective of the value of the RECURSIVE tag.
3289 # Possible values are YES and NO. If left blank NO is used.
3290
3291 EXAMPLE_RECURSIVE = YES
3292
3293-# The IMAGE_PATH tag can be used to specify one or more files or
3294-# directories that contain image that are included in the documentation (see
3295+# The IMAGE_PATH tag can be used to specify one or more files or
3296+# directories that contain image that are included in the documentation (see
3297 # the \image command).
3298
3299 IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@
3300
3301-
3302-# The INPUT_FILTER tag can be used to specify a program that doxygen should
3303-# invoke to filter for each input file. Doxygen will invoke the filter program
3304-# by executing (via popen()) the command <filter> <input-file>, where <filter>
3305-# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
3306-# input file. Doxygen will then use the output that the filter program writes
3307-# to standard output. If FILTER_PATTERNS is specified, this tag will be
3308+# The INPUT_FILTER tag can be used to specify a program that doxygen should
3309+# invoke to filter for each input file. Doxygen will invoke the filter program
3310+# by executing (via popen()) the command <filter> <input-file>, where <filter>
3311+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
3312+# input file. Doxygen will then use the output that the filter program writes
3313+# to standard output.
3314+# If FILTER_PATTERNS is specified, this tag will be
3315 # ignored.
3316
3317-INPUT_FILTER =
3318-
3319-# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
3320-# basis. Doxygen will compare the file name with each pattern and apply the
3321-# filter if there is a match. The filters are a list of the form:
3322-# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
3323-# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
3324-# is applied to all files.
3325-
3326-FILTER_PATTERNS =
3327-
3328-# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
3329-# INPUT_FILTER) will be used to filter the input files when producing source
3330+INPUT_FILTER =
3331+
3332+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
3333+# basis.
3334+# Doxygen will compare the file name with each pattern and apply the
3335+# filter if there is a match.
3336+# The filters are a list of the form:
3337+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
3338+# info on how filters are used. If FILTER_PATTERNS is empty or if
3339+# non of the patterns match the file name, INPUT_FILTER is applied.
3340+
3341+FILTER_PATTERNS =
3342+
3343+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
3344+# INPUT_FILTER) will be used to filter the input files when producing source
3345 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
3346
3347 FILTER_SOURCE_FILES = NO
3348
3349+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
3350+# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
3351+# and it is also possible to disable source filtering for a specific pattern
3352+# using *.ext= (so without naming a filter). This option only has effect when
3353+# FILTER_SOURCE_FILES is enabled.
3354+
3355+FILTER_SOURCE_PATTERNS =
3356+
3357 #---------------------------------------------------------------------------
3358 # configuration options related to source browsing
3359 #---------------------------------------------------------------------------
3360
3361-# If the SOURCE_BROWSER tag is set to YES then a list of source files will
3362-# be generated. Documented entities will be cross-referenced with these sources.
3363-# Note: To get rid of all source code in the generated output, make sure also
3364+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
3365+# be generated. Documented entities will be cross-referenced with these sources.
3366+# Note: To get rid of all source code in the generated output, make sure also
3367 # VERBATIM_HEADERS is set to NO.
3368
3369 SOURCE_BROWSER = YES
3370
3371-# Setting the INLINE_SOURCES tag to YES will include the body
3372+# Setting the INLINE_SOURCES tag to YES will include the body
3373 # of functions and classes directly in the documentation.
3374
3375 INLINE_SOURCES = NO
3376
3377-# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
3378-# doxygen to hide any special comment blocks from generated source code
3379+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
3380+# doxygen to hide any special comment blocks from generated source code
3381 # fragments. Normal C and C++ comments will always remain visible.
3382
3383 STRIP_CODE_COMMENTS = NO
3384
3385-# If the REFERENCED_BY_RELATION tag is set to YES (the default)
3386-# then for each documented function all documented
3387+# If the REFERENCED_BY_RELATION tag is set to YES
3388+# then for each documented function all documented
3389 # functions referencing it will be listed.
3390
3391 REFERENCED_BY_RELATION = YES
3392
3393-# If the REFERENCES_RELATION tag is set to YES (the default)
3394-# then for each documented function all documented entities
3395+# If the REFERENCES_RELATION tag is set to YES
3396+# then for each documented function all documented entities
3397 # called/used by that function will be listed.
3398
3399 REFERENCES_RELATION = YES
3400
3401-# If the USE_HTAGS tag is set to YES then the references to source code
3402-# will point to the HTML generated by the htags(1) tool instead of doxygen
3403-# built-in source browser. The htags tool is part of GNU's global source
3404-# tagging system (see http://www.gnu.org/software/global/global.html). You
3405+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
3406+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
3407+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
3408+# link to the source code.
3409+# Otherwise they will link to the documentation.
3410+
3411+REFERENCES_LINK_SOURCE = YES
3412+
3413+# If the USE_HTAGS tag is set to YES then the references to source code
3414+# will point to the HTML generated by the htags(1) tool instead of doxygen
3415+# built-in source browser. The htags tool is part of GNU's global source
3416+# tagging system (see http://www.gnu.org/software/global/global.html). You
3417 # will need version 4.8.6 or higher.
3418
3419 USE_HTAGS = NO
3420
3421-# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
3422-# will generate a verbatim copy of the header file for each class for
3423+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
3424+# will generate a verbatim copy of the header file for each class for
3425 # which an include is specified. Set to NO to disable this.
3426
3427 VERBATIM_HEADERS = YES
3428@@ -603,281 +826,548 @@
3429 # configuration options related to the alphabetical class index
3430 #---------------------------------------------------------------------------
3431
3432-# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
3433-# of all compounds will be generated. Enable this if the project
3434+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
3435+# of all compounds will be generated. Enable this if the project
3436 # contains a lot of classes, structs, unions or interfaces.
3437
3438 ALPHABETICAL_INDEX = YES
3439
3440-# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
3441-# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
3442+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
3443+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
3444 # in which this list will be split (can be a number in the range [1..20])
3445
3446 COLS_IN_ALPHA_INDEX = 2
3447
3448-# In case all classes in a project start with a common prefix, all
3449-# classes will be put under the same header in the alphabetical index.
3450-# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
3451+# In case all classes in a project start with a common prefix, all
3452+# classes will be put under the same header in the alphabetical index.
3453+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
3454 # should be ignored while generating the index headers.
3455
3456-IGNORE_PREFIX =
3457+IGNORE_PREFIX =
3458
3459 #---------------------------------------------------------------------------
3460 # configuration options related to the HTML output
3461 #---------------------------------------------------------------------------
3462
3463-# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
3464+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
3465 # generate HTML output.
3466
3467 GENERATE_HTML = YES
3468
3469-# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
3470-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3471+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
3472+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3473 # put in front of it. If left blank `html' will be used as the default path.
3474
3475 HTML_OUTPUT = html
3476
3477-# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
3478-# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
3479+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
3480+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
3481 # doxygen will generate files with .html extension.
3482
3483 HTML_FILE_EXTENSION = .html
3484
3485-# The HTML_HEADER tag can be used to specify a personal HTML header for
3486-# each generated HTML page. If it is left blank doxygen will generate a
3487-# standard header.
3488+# The HTML_HEADER tag can be used to specify a personal HTML header for
3489+# each generated HTML page. If it is left blank doxygen will generate a
3490+# standard header. Note that when using a custom header you are responsible
3491+# for the proper inclusion of any scripts and style sheets that doxygen
3492+# needs, which is dependent on the configuration options used.
3493+# It is adviced to generate a default header using "doxygen -w html
3494+# header.html footer.html stylesheet.css YourConfigFile" and then modify
3495+# that header. Note that the header is subject to change so you typically
3496+# have to redo this when upgrading to a newer version of doxygen or when
3497+# changing the value of configuration settings such as GENERATE_TREEVIEW!
3498+
3499 HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/../style/header.html
3500
3501-
3502-# The HTML_FOOTER tag can be used to specify a personal HTML footer for
3503-# each generated HTML page. If it is left blank doxygen will generate a
3504+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
3505+# each generated HTML page. If it is left blank doxygen will generate a
3506 # standard footer.
3507
3508 HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/../style/footer.html
3509
3510-# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
3511-# style sheet that is used by each HTML page. It can be used to
3512-# fine-tune the look of the HTML output. If the tag is left blank doxygen
3513-# will generate a default style sheet. Note that doxygen will try to copy
3514-# the style sheet file to the HTML output directory, so don't put your own
3515+# If the HTML_TIMESTAMP tag is set to YES then the generated HTML documentation will contain the timesstamp.
3516+
3517+HTML_TIMESTAMP = NO
3518+
3519+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
3520+# style sheet that is used by each HTML page. It can be used to
3521+# fine-tune the look of the HTML output. If the tag is left blank doxygen
3522+# will generate a default style sheet. Note that doxygen will try to copy
3523+# the style sheet file to the HTML output directory, so don't put your own
3524 # stylesheet in the HTML output directory as well, or it will be erased!
3525
3526 HTML_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/../style/stylesheet.css
3527
3528-# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
3529-# files or namespaces will be aligned in HTML using tables. If set to
3530+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
3531+# other source files which should be copied to the HTML output directory. Note
3532+# that these files will be copied to the base HTML output directory. Use the
3533+# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
3534+# files. In the HTML_STYLESHEET file, use the file name only. Also note that
3535+# the files will be copied as-is; there are no commands or markers available.
3536+
3537+HTML_EXTRA_FILES =
3538+
3539+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
3540+# Doxygen will adjust the colors in the stylesheet and background images
3541+# according to this color. Hue is specified as an angle on a colorwheel,
3542+# see http://en.wikipedia.org/wiki/Hue for more information.
3543+# For instance the value 0 represents red, 60 is yellow, 120 is green,
3544+# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
3545+# The allowed range is 0 to 359.
3546+
3547+HTML_COLORSTYLE_HUE = 220
3548+
3549+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
3550+# the colors in the HTML output. For a value of 0 the output will use
3551+# grayscales only. A value of 255 will produce the most vivid colors.
3552+
3553+HTML_COLORSTYLE_SAT = 100
3554+
3555+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
3556+# the luminance component of the colors in the HTML output. Values below
3557+# 100 gradually make the output lighter, whereas values above 100 make
3558+# the output darker. The value divided by 100 is the actual gamma applied,
3559+# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
3560+# and 100 does not change the gamma.
3561+
3562+HTML_COLORSTYLE_GAMMA = 80
3563+
3564+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
3565+# page will contain the date and time when the page was generated. Setting
3566+# this to NO can help when comparing the output of multiple runs.
3567+
3568+HTML_TIMESTAMP = YES
3569+
3570+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
3571+# files or namespaces will be aligned in HTML using tables. If set to
3572 # NO a bullet list will be used.
3573
3574 HTML_ALIGN_MEMBERS = YES
3575
3576-# If the GENERATE_HTMLHELP tag is set to YES, additional index files
3577-# will be generated that can be used as input for tools like the
3578-# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
3579+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
3580+# documentation will contain sections that can be hidden and shown after the
3581+# page has loaded. For this to work a browser that supports
3582+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
3583+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
3584+
3585+HTML_DYNAMIC_SECTIONS = NO
3586+
3587+# If the GENERATE_DOCSET tag is set to YES, additional index files
3588+# will be generated that can be used as input for Apple's Xcode 3
3589+# integrated development environment, introduced with OSX 10.5 (Leopard).
3590+# To create a documentation set, doxygen will generate a Makefile in the
3591+# HTML output directory. Running make will produce the docset in that
3592+# directory and running "make install" will install the docset in
3593+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
3594+# it at startup.
3595+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
3596+# for more information.
3597+
3598+GENERATE_DOCSET = NO
3599+
3600+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
3601+# feed. A documentation feed provides an umbrella under which multiple
3602+# documentation sets from a single provider (such as a company or product suite)
3603+# can be grouped.
3604+
3605+DOCSET_FEEDNAME = "Doxygen generated docs"
3606+
3607+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
3608+# should uniquely identify the documentation set bundle. This should be a
3609+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
3610+# will append .docset to the name.
3611+
3612+DOCSET_BUNDLE_ID = org.doxygen.Project
3613+
3614+# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
3615+# the documentation publisher. This should be a reverse domain-name style
3616+# string, e.g. com.mycompany.MyDocSet.documentation.
3617+
3618+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
3619+
3620+# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
3621+
3622+DOCSET_PUBLISHER_NAME = Publisher
3623+
3624+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
3625+# will be generated that can be used as input for tools like the
3626+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
3627 # of the generated HTML documentation.
3628
3629 GENERATE_HTMLHELP = YES
3630
3631-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
3632-# be used to specify the file name of the resulting .chm file. You
3633-# can add a path in front of the file if the result should not be
3634+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
3635+# be used to specify the file name of the resulting .chm file. You
3636+# can add a path in front of the file if the result should not be
3637 # written to the html output directory.
3638
3639-CHM_FILE =
3640+CHM_FILE =
3641
3642-# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
3643-# be used to specify the location (absolute path including file name) of
3644-# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
3645+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
3646+# be used to specify the location (absolute path including file name) of
3647+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
3648 # the HTML help compiler on the generated index.hhp.
3649
3650-HHC_LOCATION =
3651+HHC_LOCATION =
3652
3653-# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
3654-# controls if a separate .chi index file is generated (YES) or that
3655+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
3656+# controls if a separate .chi index file is generated (YES) or that
3657 # it should be included in the master .chm file (NO).
3658
3659 GENERATE_CHI = NO
3660
3661-# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
3662-# controls whether a binary table of contents is generated (YES) or a
3663+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
3664+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
3665+# content.
3666+
3667+CHM_INDEX_ENCODING =
3668+
3669+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
3670+# controls whether a binary table of contents is generated (YES) or a
3671 # normal table of contents (NO) in the .chm file.
3672
3673 BINARY_TOC = NO
3674
3675-# The TOC_EXPAND flag can be set to YES to add extra items for group members
3676+# The TOC_EXPAND flag can be set to YES to add extra items for group members
3677 # to the contents of the HTML help documentation and to the tree view.
3678
3679 TOC_EXPAND = NO
3680
3681-# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
3682-# top of each HTML page. The value NO (the default) enables the index and
3683+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
3684+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
3685+# that can be used as input for Qt's qhelpgenerator to generate a
3686+# Qt Compressed Help (.qch) of the generated HTML documentation.
3687+
3688+GENERATE_QHP = NO
3689+
3690+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
3691+# be used to specify the file name of the resulting .qch file.
3692+# The path specified is relative to the HTML output folder.
3693+
3694+QCH_FILE =
3695+
3696+# The QHP_NAMESPACE tag specifies the namespace to use when generating
3697+# Qt Help Project output. For more information please see
3698+# http://doc.trolltech.com/qthelpproject.html#namespace
3699+
3700+QHP_NAMESPACE = org.doxygen.Project
3701+
3702+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
3703+# Qt Help Project output. For more information please see
3704+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
3705+
3706+QHP_VIRTUAL_FOLDER = doc
3707+
3708+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
3709+# add. For more information please see
3710+# http://doc.trolltech.com/qthelpproject.html#custom-filters
3711+
3712+QHP_CUST_FILTER_NAME =
3713+
3714+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
3715+# custom filter to add. For more information please see
3716+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
3717+# Qt Help Project / Custom Filters</a>.
3718+
3719+QHP_CUST_FILTER_ATTRS =
3720+
3721+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
3722+# project's
3723+# filter section matches.
3724+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
3725+# Qt Help Project / Filter Attributes</a>.
3726+
3727+QHP_SECT_FILTER_ATTRS =
3728+
3729+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
3730+# be used to specify the location of Qt's qhelpgenerator.
3731+# If non-empty doxygen will try to run qhelpgenerator on the generated
3732+# .qhp file.
3733+
3734+QHG_LOCATION =
3735+
3736+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
3737+# will be generated, which together with the HTML files, form an Eclipse help
3738+# plugin. To install this plugin and make it available under the help contents
3739+# menu in Eclipse, the contents of the directory containing the HTML and XML
3740+# files needs to be copied into the plugins directory of eclipse. The name of
3741+# the directory within the plugins directory should be the same as
3742+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
3743+# the help appears.
3744+
3745+GENERATE_ECLIPSEHELP = NO
3746+
3747+# A unique identifier for the eclipse help plugin. When installing the plugin
3748+# the directory name containing the HTML and XML files should also have
3749+# this name.
3750+
3751+ECLIPSE_DOC_ID = org.doxygen.Project
3752+
3753+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
3754+# top of each HTML page. The value NO (the default) enables the index and
3755 # the value YES disables it.
3756
3757 DISABLE_INDEX = NO
3758
3759-# This tag can be used to set the number of enum values (range [1..20])
3760-# that doxygen will group on one line in the generated HTML documentation.
3761+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
3762+# (range [0,1..20]) that doxygen will group on one line in the generated HTML
3763+# documentation. Note that a value of 0 will completely suppress the enum
3764+# values from appearing in the overview section.
3765
3766 ENUM_VALUES_PER_LINE = 4
3767
3768-# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
3769-# generated containing a tree-like index structure (just like the one that
3770-# is generated for HTML Help). For this to work a browser that supports
3771-# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
3772-# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
3773-# probably better off using the HTML help feature.
3774+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
3775+# structure should be generated to display hierarchical information.
3776+# If the tag value is set to YES, a side panel will be generated
3777+# containing a tree-like index structure (just like the one that
3778+# is generated for HTML Help). For this to work a browser that supports
3779+# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
3780+# Windows users are probably better off using the HTML help feature.
3781
3782 GENERATE_TREEVIEW = NO
3783
3784-# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
3785-# used to set the initial width (in pixels) of the frame in which the tree
3786+# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
3787+# and Class Hierarchy pages using a tree view instead of an ordered list.
3788+
3789+USE_INLINE_TREES = NO
3790+
3791+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
3792+# used to set the initial width (in pixels) of the frame in which the tree
3793 # is shown.
3794
3795 TREEVIEW_WIDTH = 250
3796
3797+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
3798+# links to external symbols imported via tag files in a separate window.
3799+
3800+EXT_LINKS_IN_WINDOW = NO
3801+
3802+# Use this tag to change the font size of Latex formulas included
3803+# as images in the HTML documentation. The default is 10. Note that
3804+# when you change the font size after a successful doxygen run you need
3805+# to manually remove any form_*.png images from the HTML output directory
3806+# to force them to be regenerated.
3807+
3808+FORMULA_FONTSIZE = 10
3809+
3810+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
3811+# generated for formulas are transparent PNGs. Transparent PNGs are
3812+# not supported properly for IE 6.0, but are supported on all modern browsers.
3813+# Note that when changing this option you need to delete any form_*.png files
3814+# in the HTML output before the changes have effect.
3815+
3816+FORMULA_TRANSPARENT = YES
3817+
3818+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
3819+# (see http://www.mathjax.org) which uses client side Javascript for the
3820+# rendering instead of using prerendered bitmaps. Use this if you do not
3821+# have LaTeX installed or if you want to formulas look prettier in the HTML
3822+# output. When enabled you also need to install MathJax separately and
3823+# configure the path to it using the MATHJAX_RELPATH option.
3824+
3825+USE_MATHJAX = NO
3826+
3827+# When MathJax is enabled you need to specify the location relative to the
3828+# HTML output directory using the MATHJAX_RELPATH option. The destination
3829+# directory should contain the MathJax.js script. For instance, if the mathjax
3830+# directory is located at the same level as the HTML output directory, then
3831+# MATHJAX_RELPATH should be ../mathjax. The default value points to the
3832+# mathjax.org site, so you can quickly see the result without installing
3833+# MathJax, but it is strongly recommended to install a local copy of MathJax
3834+# before deployment.
3835+
3836+MATHJAX_RELPATH = http://www.mathjax.org/mathjax
3837+
3838+# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
3839+# names that should be enabled during MathJax rendering.
3840+
3841+MATHJAX_EXTENSIONS =
3842+
3843+# When the SEARCHENGINE tag is enabled doxygen will generate a search box
3844+# for the HTML output. The underlying search engine uses javascript
3845+# and DHTML and should work on any modern browser. Note that when using
3846+# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
3847+# (GENERATE_DOCSET) there is already a search function so this one should
3848+# typically be disabled. For large projects the javascript based search engine
3849+# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
3850+
3851+SEARCHENGINE = YES
3852+
3853+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
3854+# implemented using a PHP enabled web server instead of at the web client
3855+# using Javascript. Doxygen will generate the search PHP script and index
3856+# file to put on the web server. The advantage of the server
3857+# based approach is that it scales better to large projects and allows
3858+# full text search. The disadvantages are that it is more difficult to setup
3859+# and does not have live searching capabilities.
3860+
3861+SERVER_BASED_SEARCH = NO
3862+
3863 #---------------------------------------------------------------------------
3864 # configuration options related to the LaTeX output
3865 #---------------------------------------------------------------------------
3866
3867-# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
3868+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
3869 # generate Latex output.
3870
3871 GENERATE_LATEX = NO
3872
3873-# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
3874-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3875+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
3876+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
3877 # put in front of it. If left blank `latex' will be used as the default path.
3878
3879 LATEX_OUTPUT = latex
3880
3881-# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
3882+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
3883 # invoked. If left blank `latex' will be used as the default command name.
3884-
3885-#LATEX_CMD_NAME = latex
3886-LATEX_CMD_NAME = @LATEX_COMPILER@
3887-
3888-# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
3889-# generate index for LaTeX. If left blank `makeindex' will be used as the
3890+# Note that when enabling USE_PDFLATEX this option is only used for
3891+# generating bitmaps for formulas in the HTML output, but not in the
3892+# Makefile that is written to the output directory.
3893+
3894+LATEX_CMD_NAME = @LATEX_COMPILER@
3895+
3896+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
3897+# generate index for LaTeX. If left blank `makeindex' will be used as the
3898 # default command name.
3899
3900-#MAKEINDEX_CMD_NAME = makeindex
3901 MAKEINDEX_CMD_NAME = @MAKEINDEX_COMPILER@
3902
3903-# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
3904-# LaTeX documents. This may be useful for small projects and may help to
3905+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
3906+# LaTeX documents. This may be useful for small projects and may help to
3907 # save some trees in general.
3908
3909 COMPACT_LATEX = NO
3910
3911-# The PAPER_TYPE tag can be used to set the paper type that is used
3912-# by the printer. Possible values are: a4, a4wide, letter, legal and
3913+# The PAPER_TYPE tag can be used to set the paper type that is used
3914+# by the printer. Possible values are: a4, letter, legal and
3915 # executive. If left blank a4wide will be used.
3916
3917 PAPER_TYPE = a4
3918
3919-# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
3920+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
3921 # packages that should be included in the LaTeX output.
3922
3923-EXTRA_PACKAGES =
3924+EXTRA_PACKAGES =
3925
3926-# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
3927-# the generated latex document. The header should contain everything until
3928-# the first chapter. If it is left blank doxygen will generate a
3929+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
3930+# the generated latex document. The header should contain everything until
3931+# the first chapter. If it is left blank doxygen will generate a
3932 # standard header. Notice: only use this tag if you know what you are doing!
3933
3934-LATEX_HEADER =
3935-
3936-# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
3937-# is prepared for conversion to pdf (using ps2pdf). The pdf file will
3938-# contain links (just like the HTML output) instead of page references
3939+LATEX_HEADER =
3940+
3941+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
3942+# the generated latex document. The footer should contain everything after
3943+# the last chapter. If it is left blank doxygen will generate a
3944+# standard footer. Notice: only use this tag if you know what you are doing!
3945+
3946+LATEX_FOOTER =
3947+
3948+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
3949+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
3950+# contain links (just like the HTML output) instead of page references
3951 # This makes the output suitable for online browsing using a pdf viewer.
3952
3953 PDF_HYPERLINKS = YES
3954
3955-# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
3956-# plain latex in the generated Makefile. Set this option to YES to get a
3957+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
3958+# plain latex in the generated Makefile. Set this option to YES to get a
3959 # higher quality PDF documentation.
3960
3961 USE_PDFLATEX = YES
3962
3963-# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
3964-# command to the generated LaTeX files. This will instruct LaTeX to keep
3965-# running if errors occur, instead of asking the user for help.
3966+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
3967+# command to the generated LaTeX files. This will instruct LaTeX to keep
3968+# running if errors occur, instead of asking the user for help.
3969 # This option is also used when generating formulas in HTML.
3970
3971 LATEX_BATCHMODE = YES
3972
3973-# If LATEX_HIDE_INDICES is set to YES then doxygen will not
3974-# include the index chapters (such as File Index, Compound Index, etc.)
3975+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
3976+# include the index chapters (such as File Index, Compound Index, etc.)
3977 # in the output.
3978
3979 LATEX_HIDE_INDICES = NO
3980
3981+# If LATEX_SOURCE_CODE is set to YES then doxygen will include
3982+# source code with syntax highlighting in the LaTeX output.
3983+# Note that which sources are shown also depends on other settings
3984+# such as SOURCE_BROWSER.
3985+
3986+LATEX_SOURCE_CODE = NO
3987+
3988+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
3989+# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
3990+# http://en.wikipedia.org/wiki/BibTeX for more info.
3991+
3992+LATEX_BIB_STYLE = plain
3993+
3994 #---------------------------------------------------------------------------
3995 # configuration options related to the RTF output
3996 #---------------------------------------------------------------------------
3997
3998-# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
3999-# The RTF output is optimized for Word 97 and may not look very pretty with
4000+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
4001+# The RTF output is optimized for Word 97 and may not look very pretty with
4002 # other RTF readers or editors.
4003
4004 GENERATE_RTF = NO
4005
4006-# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
4007-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
4008+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
4009+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
4010 # put in front of it. If left blank `rtf' will be used as the default path.
4011
4012 RTF_OUTPUT = rtf
4013
4014-# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
4015-# RTF documents. This may be useful for small projects and may help to
4016+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
4017+# RTF documents. This may be useful for small projects and may help to
4018 # save some trees in general.
4019
4020 COMPACT_RTF = NO
4021
4022-# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
4023-# will contain hyperlink fields. The RTF file will
4024-# contain links (just like the HTML output) instead of page references.
4025-# This makes the output suitable for online browsing using WORD or other
4026-# programs which support those fields.
4027+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
4028+# will contain hyperlink fields. The RTF file will
4029+# contain links (just like the HTML output) instead of page references.
4030+# This makes the output suitable for online browsing using WORD or other
4031+# programs which support those fields.
4032 # Note: wordpad (write) and others do not support links.
4033
4034 RTF_HYPERLINKS = NO
4035
4036-# Load stylesheet definitions from file. Syntax is similar to doxygen's
4037-# config file, i.e. a series of assignments. You only have to provide
4038+# Load stylesheet definitions from file. Syntax is similar to doxygen's
4039+# config file, i.e. a series of assignments. You only have to provide
4040 # replacements, missing definitions are set to their default value.
4041
4042-RTF_STYLESHEET_FILE =
4043+RTF_STYLESHEET_FILE =
4044
4045-# Set optional variables used in the generation of an rtf document.
4046+# Set optional variables used in the generation of an rtf document.
4047 # Syntax is similar to doxygen's config file.
4048
4049-RTF_EXTENSIONS_FILE =
4050+RTF_EXTENSIONS_FILE =
4051
4052 #---------------------------------------------------------------------------
4053 # configuration options related to the man page output
4054 #---------------------------------------------------------------------------
4055
4056-# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
4057+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
4058 # generate man pages
4059
4060 GENERATE_MAN = NO
4061
4062-# The MAN_OUTPUT tag is used to specify where the man pages will be put.
4063-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
4064+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
4065+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
4066 # put in front of it. If left blank `man' will be used as the default path.
4067
4068 MAN_OUTPUT = man
4069
4070-# The MAN_EXTENSION tag determines the extension that is added to
4071+# The MAN_EXTENSION tag determines the extension that is added to
4072 # the generated man pages (default is the subroutine's section .3)
4073
4074 MAN_EXTENSION = .3
4075
4076-# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
4077-# then it will generate one additional man file for each entity
4078-# documented in the real man page(s). These additional files
4079-# only source the real man page, but without them the man command
4080+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
4081+# then it will generate one additional man file for each entity
4082+# documented in the real man page(s). These additional files
4083+# only source the real man page, but without them the man command
4084 # would be unable to find the correct page. The default is NO.
4085
4086 MAN_LINKS = NO
4087@@ -886,33 +1376,33 @@
4088 # configuration options related to the XML output
4089 #---------------------------------------------------------------------------
4090
4091-# If the GENERATE_XML tag is set to YES Doxygen will
4092-# generate an XML file that captures the structure of
4093+# If the GENERATE_XML tag is set to YES Doxygen will
4094+# generate an XML file that captures the structure of
4095 # the code including all documentation.
4096
4097 GENERATE_XML = NO
4098
4099-# The XML_OUTPUT tag is used to specify where the XML pages will be put.
4100-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
4101+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
4102+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
4103 # put in front of it. If left blank `xml' will be used as the default path.
4104
4105 XML_OUTPUT = xml
4106
4107-# The XML_SCHEMA tag can be used to specify an XML schema,
4108-# which can be used by a validating XML parser to check the
4109-# syntax of the XML files.
4110-
4111-XML_SCHEMA =
4112-
4113-# The XML_DTD tag can be used to specify an XML DTD,
4114-# which can be used by a validating XML parser to check the
4115-# syntax of the XML files.
4116-
4117-XML_DTD =
4118-
4119-# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
4120-# dump the program listings (including syntax highlighting
4121-# and cross-referencing information) to the XML output. Note that
4122+# The XML_SCHEMA tag can be used to specify an XML schema,
4123+# which can be used by a validating XML parser to check the
4124+# syntax of the XML files.
4125+
4126+XML_SCHEMA =
4127+
4128+# The XML_DTD tag can be used to specify an XML DTD,
4129+# which can be used by a validating XML parser to check the
4130+# syntax of the XML files.
4131+
4132+XML_DTD =
4133+
4134+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
4135+# dump the program listings (including syntax highlighting
4136+# and cross-referencing information) to the XML output. Note that
4137 # enabling this will significantly increase the size of the XML output.
4138
4139 XML_PROGRAMLISTING = YES
4140@@ -921,10 +1411,10 @@
4141 # configuration options for the AutoGen Definitions output
4142 #---------------------------------------------------------------------------
4143
4144-# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
4145-# generate an AutoGen Definitions (see autogen.sf.net) file
4146-# that captures the structure of the code including all
4147-# documentation. Note that this feature is still experimental
4148+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
4149+# generate an AutoGen Definitions (see autogen.sf.net) file
4150+# that captures the structure of the code including all
4151+# documentation. Note that this feature is still experimental
4152 # and incomplete at the moment.
4153
4154 GENERATE_AUTOGEN_DEF = NO
4155@@ -933,285 +1423,359 @@
4156 # configuration options related to the Perl module output
4157 #---------------------------------------------------------------------------
4158
4159-# If the GENERATE_PERLMOD tag is set to YES Doxygen will
4160-# generate a Perl module file that captures the structure of
4161-# the code including all documentation. Note that this
4162-# feature is still experimental and incomplete at the
4163+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
4164+# generate a Perl module file that captures the structure of
4165+# the code including all documentation. Note that this
4166+# feature is still experimental and incomplete at the
4167 # moment.
4168
4169 GENERATE_PERLMOD = NO
4170
4171-# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
4172-# the necessary Makefile rules, Perl scripts and LaTeX code to be able
4173+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
4174+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
4175 # to generate PDF and DVI output from the Perl module output.
4176
4177 PERLMOD_LATEX = NO
4178
4179-# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
4180-# nicely formatted so it can be parsed by a human reader. This is useful
4181-# if you want to understand what is going on. On the other hand, if this
4182-# tag is set to NO the size of the Perl module output will be much smaller
4183+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
4184+# nicely formatted so it can be parsed by a human reader.
4185+# This is useful
4186+# if you want to understand what is going on.
4187+# On the other hand, if this
4188+# tag is set to NO the size of the Perl module output will be much smaller
4189 # and Perl will parse it just the same.
4190
4191 PERLMOD_PRETTY = YES
4192
4193-# The names of the make variables in the generated doxyrules.make file
4194-# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
4195-# This is useful so different doxyrules.make files included by the same
4196+# The names of the make variables in the generated doxyrules.make file
4197+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
4198+# This is useful so different doxyrules.make files included by the same
4199 # Makefile don't overwrite each other's variables.
4200
4201-PERLMOD_MAKEVAR_PREFIX =
4202-
4203-#---------------------------------------------------------------------------
4204-# Configuration options related to the preprocessor
4205-#---------------------------------------------------------------------------
4206-
4207-# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
4208-# evaluate all C-preprocessor directives found in the sources and include
4209+PERLMOD_MAKEVAR_PREFIX =
4210+
4211+#---------------------------------------------------------------------------
4212+# Configuration options related to the preprocessor
4213+#---------------------------------------------------------------------------
4214+
4215+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
4216+# evaluate all C-preprocessor directives found in the sources and include
4217 # files.
4218
4219 ENABLE_PREPROCESSING = YES
4220
4221-# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
4222-# names in the source code. If set to NO (the default) only conditional
4223-# compilation will be performed. Macro expansion can be done in a controlled
4224+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
4225+# names in the source code. If set to NO (the default) only conditional
4226+# compilation will be performed. Macro expansion can be done in a controlled
4227 # way by setting EXPAND_ONLY_PREDEF to YES.
4228
4229 MACRO_EXPANSION = YES
4230
4231-# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
4232-# then the macro expansion is limited to the macros specified with the
4233+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
4234+# then the macro expansion is limited to the macros specified with the
4235 # PREDEFINED and EXPAND_AS_DEFINED tags.
4236
4237 EXPAND_ONLY_PREDEF = YES
4238
4239-# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
4240-# in the INCLUDE_PATH (see below) will be search if a #include is found.
4241+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
4242+# pointed to by INCLUDE_PATH will be searched when a #include is found.
4243
4244 SEARCH_INCLUDES = YES
4245
4246-# The INCLUDE_PATH tag can be used to specify one or more directories that
4247-# contain include files that are not input files but should be processed by
4248+# The INCLUDE_PATH tag can be used to specify one or more directories that
4249+# contain include files that are not input files but should be processed by
4250 # the preprocessor.
4251
4252-INCLUDE_PATH =
4253-# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
4254-# patterns (like *.h and *.hpp) to filter out the header-files in the
4255-# directories. If left blank, the patterns specified with FILE_PATTERNS will
4256+INCLUDE_PATH =
4257+
4258+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
4259+# patterns (like *.h and *.hpp) to filter out the header-files in the
4260+# directories. If left blank, the patterns specified with FILE_PATTERNS will
4261 # be used.
4262
4263-INCLUDE_FILE_PATTERNS =
4264+INCLUDE_FILE_PATTERNS =
4265
4266-# The PREDEFINED tag can be used to specify one or more macro names that
4267-# are defined before the preprocessor is started (similar to the -D option of
4268-# gcc). The argument of the tag is a list of macros of the form: name
4269-# or name=definition (no spaces). If the definition and the = are
4270-# omitted =1 is assumed. To prevent a macro definition from being
4271-# undefined via #undef or recursively expanded use the := operator
4272+# The PREDEFINED tag can be used to specify one or more macro names that
4273+# are defined before the preprocessor is started (similar to the -D option of
4274+# gcc). The argument of the tag is a list of macros of the form: name
4275+# or name=definition (no spaces). If the definition and the = are
4276+# omitted =1 is assumed. To prevent a macro definition from being
4277+# undefined via #undef or recursively expanded use the := operator
4278 # instead of the = operator.
4279
4280-PREDEFINED =
4281-
4282-# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
4283-# this tag can be used to specify a list of macro names that should be expanded.
4284-# The macro definition that is found in the sources will be used.
4285-# Use the PREDEFINED tag if you want to use a different macro definition.
4286-
4287-EXPAND_AS_DEFINED =
4288-
4289-# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
4290-# doxygen's preprocessor will remove all function-like macros that are alone
4291-# on a line, have an all uppercase name, and do not end with a semicolon. Such
4292-# function macros are typically used for boiler-plate code, and will confuse
4293-# the parser if not removed.
4294+PREDEFINED =
4295+
4296+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
4297+# this tag can be used to specify a list of macro names that should be expanded.
4298+# The macro definition that is found in the sources will be used.
4299+# Use the PREDEFINED tag if you want to use a different macro definition that
4300+# overrules the definition found in the source code.
4301+
4302+EXPAND_AS_DEFINED =
4303+
4304+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
4305+# doxygen's preprocessor will remove all references to function-like macros
4306+# that are alone on a line, have an all uppercase name, and do not end with a
4307+# semicolon, because these will confuse the parser if not removed.
4308
4309 SKIP_FUNCTION_MACROS = YES
4310
4311 #---------------------------------------------------------------------------
4312-# Configuration::additions related to external references
4313+# Configuration::additions related to external references
4314 #---------------------------------------------------------------------------
4315
4316-# The TAGFILES option can be used to specify one or more tagfiles.
4317-# Optionally an initial location of the external documentation
4318-# can be added for each tagfile. The format of a tag file without
4319-# this location is as follows:
4320-# TAGFILES = file1 file2 ...
4321-# Adding location for the tag files is done as follows:
4322-# TAGFILES = file1=loc1 "file2 = loc2" ...
4323-# where "loc1" and "loc2" can be relative or absolute paths or
4324-# URLs. If a location is present for each tag, the installdox tool
4325+# The TAGFILES option can be used to specify one or more tagfiles.
4326+# Optionally an initial location of the external documentation
4327+# can be added for each tagfile. The format of a tag file without
4328+# this location is as follows:
4329+#
4330+# TAGFILES = file1 file2 ...
4331+# Adding location for the tag files is done as follows:
4332+#
4333+# TAGFILES = file1=loc1 "file2 = loc2" ...
4334+# where "loc1" and "loc2" can be relative or absolute paths or
4335+# URLs. If a location is present for each tag, the installdox tool
4336 # does not have to be run to correct the links.
4337 # Note that each tag file must have a unique name
4338 # (where the name does NOT include the path)
4339-# If a tag file is not located in the directory in which doxygen
4340+# If a tag file is not located in the directory in which doxygen
4341 # is run, you must also specify the path to the tagfile here.
4342
4343-TAGFILES =
4344+TAGFILES =
4345
4346-# When a file name is specified after GENERATE_TAGFILE, doxygen will create
4347+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
4348 # a tag file that is based on the input files it reads.
4349
4350 GENERATE_TAGFILE = html/@PROJECT_NAME@.TAGFILE
4351
4352-# If the ALLEXTERNALS tag is set to YES all external classes will be listed
4353-# in the class index. If set to NO only the inherited external classes
4354+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
4355+# in the class index. If set to NO only the inherited external classes
4356 # will be listed.
4357
4358 ALLEXTERNALS = YES
4359
4360-# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
4361-# in the modules index. If set to NO, only the current project's groups will
4362+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
4363+# in the modules index. If set to NO, only the current project's groups will
4364 # be listed.
4365
4366 EXTERNAL_GROUPS = YES
4367
4368-# The PERL_PATH should be the absolute path and name of the perl script
4369+# The PERL_PATH should be the absolute path and name of the perl script
4370 # interpreter (i.e. the result of `which perl').
4371
4372 PERL_PATH = /usr/bin/perl
4373
4374 #---------------------------------------------------------------------------
4375-# Configuration options related to the dot tool
4376+# Configuration options related to the dot tool
4377 #---------------------------------------------------------------------------
4378
4379-# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
4380-# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
4381-# or super classes. Setting the tag to NO turns the diagrams off. Note that
4382-# this option is superseded by the HAVE_DOT option below. This is only a
4383-# fallback. It is recommended to install and use dot, since it yields more
4384-# powerful graphs.
4385+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
4386+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
4387+# or super classes. Setting the tag to NO turns the diagrams off. Note that
4388+# this option also works with HAVE_DOT disabled, but it is recommended to
4389+# install and use dot, since it yields more powerful graphs.
4390
4391 CLASS_DIAGRAMS = YES
4392
4393-# If set to YES, the inheritance and collaboration graphs will hide
4394-# inheritance and usage relations if the target is undocumented
4395+# You can define message sequence charts within doxygen comments using the \msc
4396+# command. Doxygen will then run the mscgen tool (see
4397+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
4398+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
4399+# the mscgen tool resides. If left empty the tool is assumed to be found in the
4400+# default search path.
4401+
4402+MSCGEN_PATH =
4403+
4404+# If set to YES, the inheritance and collaboration graphs will hide
4405+# inheritance and usage relations if the target is undocumented
4406 # or is not a class.
4407
4408 HIDE_UNDOC_RELATIONS = YES
4409
4410-# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
4411-# available from the path. This tool is part of Graphviz, a graph visualization
4412-# toolkit from AT&T and Lucent Bell Labs. The other options in this section
4413+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
4414+# available from the path. This tool is part of Graphviz, a graph visualization
4415+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
4416 # have no effect if this option is set to NO (the default)
4417
4418 HAVE_DOT = @DOXYGEN_DOT_FOUND@
4419
4420-# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
4421-# will generate a graph for each documented class showing the direct and
4422-# indirect inheritance relations. Setting this tag to YES will force the
4423+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
4424+# allowed to run in parallel. When set to 0 (the default) doxygen will
4425+# base this on the number of processors available in the system. You can set it
4426+# explicitly to a value larger than 0 to get control over the balance
4427+# between CPU load and processing speed.
4428+
4429+DOT_NUM_THREADS = 0
4430+
4431+# By default doxygen will use the Helvetica font for all dot files that
4432+# doxygen generates. When you want a differently looking font you can specify
4433+# the font name using DOT_FONTNAME. You need to make sure dot is able to find
4434+# the font, which can be done by putting it in a standard location or by setting
4435+# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
4436+# directory containing the font.
4437+
4438+DOT_FONTNAME = Helvetica
4439+
4440+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
4441+# The default size is 10pt.
4442+
4443+DOT_FONTSIZE = 10
4444+
4445+# By default doxygen will tell dot to use the Helvetica font.
4446+# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
4447+# set the path where dot can find it.
4448+
4449+DOT_FONTPATH =
4450+
4451+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
4452+# will generate a graph for each documented class showing the direct and
4453+# indirect inheritance relations. Setting this tag to YES will force the
4454 # the CLASS_DIAGRAMS tag to NO.
4455
4456 CLASS_GRAPH = YES
4457
4458-# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
4459-# will generate a graph for each documented class showing the direct and
4460-# indirect implementation dependencies (inheritance, containment, and
4461+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
4462+# will generate a graph for each documented class showing the direct and
4463+# indirect implementation dependencies (inheritance, containment, and
4464 # class references variables) of the class with other documented classes.
4465
4466 COLLABORATION_GRAPH = YES
4467
4468-# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
4469+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
4470 # will generate a graph for groups, showing the direct groups dependencies
4471
4472 GROUP_GRAPHS = YES
4473
4474-# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
4475-# collaboration diagrams in a style similar to the OMG's Unified Modeling
4476+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
4477+# collaboration diagrams in a style similar to the OMG's Unified Modeling
4478 # Language.
4479
4480 UML_LOOK = NO
4481-# UML_LOOK = YES
4482
4483-# If set to YES, the inheritance and collaboration graphs will show the
4484+# If set to YES, the inheritance and collaboration graphs will show the
4485 # relations between templates and their instances.
4486
4487 TEMPLATE_RELATIONS = YES
4488
4489-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
4490-# tags are set to YES then doxygen will generate a graph for each documented
4491-# file showing the direct and indirect include dependencies of the file with
4492+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
4493+# tags are set to YES then doxygen will generate a graph for each documented
4494+# file showing the direct and indirect include dependencies of the file with
4495 # other documented files.
4496
4497 INCLUDE_GRAPH = YES
4498
4499-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
4500-# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
4501-# documented header file showing the documented files that directly or
4502+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
4503+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
4504+# documented header file showing the documented files that directly or
4505 # indirectly include this file.
4506
4507 INCLUDED_BY_GRAPH = YES
4508
4509-# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
4510-# generate a call dependency graph for every global function or class method.
4511-# Note that enabling this option will significantly increase the time of a run.
4512-# So in most cases it will be better to enable call graphs for selected
4513-# functions only using the \callgraph command.
4514+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
4515+# doxygen will generate a call dependency graph for every global function
4516+# or class method. Note that enabling this option will significantly increase
4517+# the time of a run. So in most cases it will be better to enable call graphs
4518+# for selected functions only using the \callgraph command.
4519
4520 CALL_GRAPH = NO
4521
4522-# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
4523-# will graphical hierarchy of all classes instead of a textual one.
4524+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
4525+# doxygen will generate a caller dependency graph for every global function
4526+# or class method. Note that enabling this option will significantly increase
4527+# the time of a run. So in most cases it will be better to enable caller
4528+# graphs for selected functions only using the \callergraph command.
4529+
4530+CALLER_GRAPH = NO
4531+
4532+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
4533+# will generate a graphical hierarchy of all classes instead of a textual one.
4534
4535 GRAPHICAL_HIERARCHY = YES
4536
4537-# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
4538-# then doxygen will show the dependencies a directory has on other directories
4539+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
4540+# then doxygen will show the dependencies a directory has on other directories
4541 # in a graphical way. The dependency relations are determined by the #include
4542 # relations between the files in the directories.
4543
4544 DIRECTORY_GRAPH = YES
4545
4546-# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
4547-# generated by dot. Possible values are png, jpg, or gif
4548-# If left blank png will be used.
4549+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
4550+# generated by dot. Possible values are svg, png, jpg, or gif.
4551+# If left blank png will be used. If you choose svg you need to set
4552+# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
4553+# visible in IE 9+ (other browsers do not have this requirement).
4554
4555 DOT_IMAGE_FORMAT = png
4556
4557-# The tag DOT_PATH can be used to specify the path where the dot tool can be
4558+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
4559+# enable generation of interactive SVG images that allow zooming and panning.
4560+# Note that this requires a modern browser other than Internet Explorer.
4561+# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
4562+# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
4563+# visible. Older versions of IE do not have SVG support.
4564+
4565+INTERACTIVE_SVG = NO
4566+
4567+# The tag DOT_PATH can be used to specify the path where the dot tool can be
4568 # found. If left blank, it is assumed the dot tool can be found in the path.
4569
4570 DOT_PATH = @DOXYGEN_DOT_EXECUTABLE_PATH@
4571
4572-# The DOTFILE_DIRS tag can be used to specify one or more directories that
4573-# contain dot files that are included in the documentation (see the
4574+# The DOTFILE_DIRS tag can be used to specify one or more directories that
4575+# contain dot files that are included in the documentation (see the
4576 # \dotfile command).
4577
4578-DOTFILE_DIRS =
4579-
4580-# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
4581-# background. This is disabled by default, which results in a white background.
4582-# Warning: Depending on the platform used, enabling this option may lead to
4583-# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
4584-# read).
4585+DOTFILE_DIRS =
4586+
4587+# The MSCFILE_DIRS tag can be used to specify one or more directories that
4588+# contain msc files that are included in the documentation (see the
4589+# \mscfile command).
4590+
4591+MSCFILE_DIRS =
4592+
4593+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
4594+# nodes that will be shown in the graph. If the number of nodes in a graph
4595+# becomes larger than this value, doxygen will truncate the graph, which is
4596+# visualized by representing a node as a red box. Note that doxygen if the
4597+# number of direct children of the root node in a graph is already larger than
4598+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
4599+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
4600+
4601+DOT_GRAPH_MAX_NODES = 50
4602+
4603+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
4604+# graphs generated by dot. A depth value of 3 means that only nodes reachable
4605+# from the root by following a path via at most 3 edges will be shown. Nodes
4606+# that lay further from the root node will be omitted. Note that setting this
4607+# option to 1 or 2 may greatly reduce the computation time needed for large
4608+# code bases. Also note that the size of a graph can be further restricted by
4609+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
4610+
4611+MAX_DOT_GRAPH_DEPTH = 0
4612+
4613+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
4614+# background. This is disabled by default, because dot on Windows does not
4615+# seem to support this out of the box. Warning: Depending on the platform used,
4616+# enabling this option may lead to badly anti-aliased labels on the edges of
4617+# a graph (i.e. they become hard to read).
4618
4619 DOT_TRANSPARENT = NO
4620
4621-# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
4622-# files in one run (i.e. multiple -o and -T options on the command line). This
4623-# makes dot run faster, but since only newer versions of dot (>1.8.10)
4624+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
4625+# files in one run (i.e. multiple -o and -T options on the command line). This
4626+# makes dot run faster, but since only newer versions of dot (>1.8.10)
4627 # support this, this feature is disabled by default.
4628-# JW
4629-# DOT_MULTI_TARGETS = NO
4630+
4631 DOT_MULTI_TARGETS = YES
4632
4633-# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
4634-# generate a legend page explaining the meaning of the various boxes and
4635+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
4636+# generate a legend page explaining the meaning of the various boxes and
4637 # arrows in the dot generated graphs.
4638
4639 GENERATE_LEGEND = YES
4640
4641-# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
4642-# remove the intermediate dot files that are used to generate
4643+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
4644+# remove the intermediate dot files that are used to generate
4645 # the various graphs.
4646
4647 DOT_CLEANUP = YES
4648-
4649-#---------------------------------------------------------------------------
4650-# Configuration::additions related to the search engine
4651-#---------------------------------------------------------------------------
4652-
4653-# The SEARCHENGINE tag specifies whether or not a search engine should be
4654-# used. If set to NO the values of all tags below this one will be ignored.
4655-
4656-# JW SEARCHENGINE = NO
4657-SEARCHENGINE = YES
4658
4659=== modified file 'doc/java/doxy.config.in' (properties changed: +x to -x)
4660--- doc/java/doxy.config.in 2010-07-14 12:32:17 +0000
4661+++ doc/java/doxy.config.in 2012-03-15 17:48:23 +0000
4662@@ -1,442 +1,623 @@
4663-# Doxyfile 1.4.5
4664+# Doxyfile 1.7.5
4665
4666 # This file describes the settings to be used by the documentation system
4667-# doxygen (www.doxygen.org) for a project
4668+# doxygen (www.doxygen.org) for a project.
4669 #
4670-# All text after a hash (#) is considered a comment and will be ignored
4671+# All text after a hash (#) is considered a comment and will be ignored.
4672 # The format is:
4673 # TAG = value [value, ...]
4674 # For lists items can also be appended using:
4675 # TAG += value [value, ...]
4676-# Values that contain spaces should be placed between quotes (" ")
4677+# Values that contain spaces should be placed between quotes (" ").
4678
4679 #---------------------------------------------------------------------------
4680 # Project related configuration options
4681 #---------------------------------------------------------------------------
4682
4683-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
4684-# by quotes) that should identify the project.
4685-
4686-PROJECT_NAME = Zorba Java-API
4687-
4688-# The PROJECT_NUMBER tag can be used to enter a project or revision number.
4689-# This could be handy for archiving the generated documentation or
4690+# This tag specifies the encoding used for all characters in the config file
4691+# that follow. The default is UTF-8 which is also the encoding used for all
4692+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
4693+# iconv built into libc) for the transcoding. See
4694+# http://www.gnu.org/software/libiconv for the list of possible encodings.
4695+
4696+DOXYFILE_ENCODING = UTF-8
4697+
4698+# The PROJECT_NAME tag is a single word (or sequence of words) that should
4699+# identify the project. Note that if you do not use Doxywizard you need
4700+# to put quotes around the project name if it contains spaces.
4701+
4702+PROJECT_NAME = "Zorba Java-API"
4703+
4704+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
4705+# This could be handy for archiving the generated documentation or
4706 # if some version control system is used.
4707
4708 PROJECT_NUMBER = @ZORBA_MAJOR_NUMBER@.@ZORBA_MINOR_NUMBER@.@ZORBA_PATCH_NUMBER@
4709
4710-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
4711-# base path where the generated documentation will be put.
4712-# If a relative path is entered, it will be relative to the location
4713+# Using the PROJECT_BRIEF tag one can provide an optional one line description
4714+# for a project that appears at the top of each page and should give viewer
4715+# a quick idea about the purpose of the project. Keep the description short.
4716+
4717+PROJECT_BRIEF =
4718+
4719+# With the PROJECT_LOGO tag one can specify an logo or icon that is
4720+# included in the documentation. The maximum height of the logo should not
4721+# exceed 55 pixels and the maximum width should not exceed 200 pixels.
4722+# Doxygen will copy the logo to the output directory.
4723+
4724+PROJECT_LOGO =
4725+
4726+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
4727+# base path where the generated documentation will be put.
4728+# If a relative path is entered, it will be relative to the location
4729 # where doxygen was started. If left blank the current directory will be used.
4730
4731 OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
4732
4733-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
4734-# 4096 sub-directories (in 2 levels) under the output directory of each output
4735-# format and will distribute the generated files over these directories.
4736-# Enabling this option can be useful when feeding doxygen a huge amount of
4737-# source files, where putting all generated files in the same directory would
4738+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
4739+# 4096 sub-directories (in 2 levels) under the output directory of each output
4740+# format and will distribute the generated files over these directories.
4741+# Enabling this option can be useful when feeding doxygen a huge amount of
4742+# source files, where putting all generated files in the same directory would
4743 # otherwise cause performance problems for the file system.
4744
4745 CREATE_SUBDIRS = NO
4746
4747-# The OUTPUT_LANGUAGE tag is used to specify the language in which all
4748-# documentation generated by doxygen is written. Doxygen will use this
4749-# information to generate all constant output in the proper language.
4750-# The default language is English, other supported languages are:
4751-# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
4752-# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
4753-# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
4754-# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
4755-# Swedish, and Ukrainian.
4756+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
4757+# documentation generated by doxygen is written. Doxygen will use this
4758+# information to generate all constant output in the proper language.
4759+# The default language is English, other supported languages are:
4760+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
4761+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
4762+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
4763+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
4764+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
4765+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
4766
4767 OUTPUT_LANGUAGE = English
4768
4769-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
4770-# include brief member descriptions after the members that are listed in
4771-# the file and class documentation (similar to JavaDoc).
4772+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
4773+# include brief member descriptions after the members that are listed in
4774+# the file and class documentation (similar to JavaDoc).
4775 # Set to NO to disable this.
4776
4777 BRIEF_MEMBER_DESC = YES
4778
4779-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
4780-# the brief description of a member or function before the detailed description.
4781-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
4782+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
4783+# the brief description of a member or function before the detailed description.
4784+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
4785 # brief descriptions will be completely suppressed.
4786
4787 REPEAT_BRIEF = YES
4788
4789-# This tag implements a quasi-intelligent brief description abbreviator
4790-# that is used to form the text in various listings. Each string
4791-# in this list, if found as the leading text of the brief description, will be
4792-# stripped from the text and the result after processing the whole list, is
4793-# used as the annotated text. Otherwise, the brief description is used as-is.
4794-# If left blank, the following values are used ("$name" is automatically
4795-# replaced with the name of the entity): "The $name class" "The $name widget"
4796-# "The $name file" "is" "provides" "specifies" "contains"
4797+# This tag implements a quasi-intelligent brief description abbreviator
4798+# that is used to form the text in various listings. Each string
4799+# in this list, if found as the leading text of the brief description, will be
4800+# stripped from the text and the result after processing the whole list, is
4801+# used as the annotated text. Otherwise, the brief description is used as-is.
4802+# If left blank, the following values are used ("$name" is automatically
4803+# replaced with the name of the entity): "The $name class" "The $name widget"
4804+# "The $name file" "is" "provides" "specifies" "contains"
4805 # "represents" "a" "an" "the"
4806
4807-ABBREVIATE_BRIEF =
4808+ABBREVIATE_BRIEF =
4809
4810-# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
4811-# Doxygen will generate a detailed section even if there is only a brief
4812+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
4813+# Doxygen will generate a detailed section even if there is only a brief
4814 # description.
4815
4816 ALWAYS_DETAILED_SEC = NO
4817
4818-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
4819-# inherited members of a class in the documentation of that class as if those
4820-# members were ordinary class members. Constructors, destructors and assignment
4821+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
4822+# inherited members of a class in the documentation of that class as if those
4823+# members were ordinary class members. Constructors, destructors and assignment
4824 # operators of the base classes will not be shown.
4825
4826 INLINE_INHERITED_MEMB = YES
4827
4828-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
4829-# path before files name in the file list and in the header files. If set
4830+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
4831+# path before files name in the file list and in the header files. If set
4832 # to NO the shortest path that makes the file name unique will be used.
4833
4834 FULL_PATH_NAMES = NO
4835
4836-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
4837-# can be used to strip a user-defined part of the path. Stripping is
4838-# only done if one of the specified strings matches the left-hand part of
4839-# the path. The tag can be used to show relative paths in the file list.
4840-# If left blank the directory from which doxygen is run is used as the
4841+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
4842+# can be used to strip a user-defined part of the path. Stripping is
4843+# only done if one of the specified strings matches the left-hand part of
4844+# the path. The tag can be used to show relative paths in the file list.
4845+# If left blank the directory from which doxygen is run is used as the
4846 # path to strip.
4847
4848-STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src @CMAKE_BINARY_DIR@/src
4849-
4850-
4851-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
4852-# the path mentioned in the documentation of a class, which tells
4853-# the reader which header file to include in order to use a class.
4854-# If left blank only the name of the header file containing the class
4855-# definition is used. Otherwise one should specify the include paths that
4856+STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src \
4857+ @CMAKE_BINARY_DIR@/src
4858+
4859+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
4860+# the path mentioned in the documentation of a class, which tells
4861+# the reader which header file to include in order to use a class.
4862+# If left blank only the name of the header file containing the class
4863+# definition is used. Otherwise one should specify the include paths that
4864 # are normally passed to the compiler using the -I flag.
4865
4866-STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include @CMAKE_BINARY_DIR@/include
4867+STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include \
4868+ @CMAKE_BINARY_DIR@/include
4869
4870-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
4871-# (but less readable) file names. This can be useful is your file systems
4872+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
4873+# (but less readable) file names. This can be useful if your file system
4874 # doesn't support long names like on DOS, Mac, or CD-ROM.
4875
4876 SHORT_NAMES = NO
4877
4878-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
4879-# will interpret the first line (until the first dot) of a JavaDoc-style
4880-# comment as the brief description. If set to NO, the JavaDoc
4881-# comments will behave just like the Qt-style comments (thus requiring an
4882-# explicit @brief command for a brief description.
4883+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
4884+# will interpret the first line (until the first dot) of a JavaDoc-style
4885+# comment as the brief description. If set to NO, the JavaDoc
4886+# comments will behave just like regular Qt-style comments
4887+# (thus requiring an explicit @brief command for a brief description.)
4888
4889 JAVADOC_AUTOBRIEF = YES
4890
4891-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
4892-# treat a multi-line C++ special comment block (i.e. a block of //! or ///
4893-# comments) as a brief description. This used to be the default behaviour.
4894-# The new default is to treat a multi-line C++ comment block as a detailed
4895+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
4896+# interpret the first line (until the first dot) of a Qt-style
4897+# comment as the brief description. If set to NO, the comments
4898+# will behave just like regular Qt-style comments (thus requiring
4899+# an explicit \brief command for a brief description.)
4900+
4901+QT_AUTOBRIEF = NO
4902+
4903+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
4904+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
4905+# comments) as a brief description. This used to be the default behaviour.
4906+# The new default is to treat a multi-line C++ comment block as a detailed
4907 # description. Set this tag to YES if you prefer the old behaviour instead.
4908
4909 MULTILINE_CPP_IS_BRIEF = NO
4910
4911-# If the DETAILS_AT_TOP tag is set to YES then Doxygen
4912-# will output the detailed description near the top, like JavaDoc.
4913-# If set to NO, the detailed description appears after the member
4914-# documentation.
4915-
4916-DETAILS_AT_TOP = NO
4917-
4918-# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
4919-# member inherits the documentation from any documented member that it
4920+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
4921+# member inherits the documentation from any documented member that it
4922 # re-implements.
4923
4924 INHERIT_DOCS = YES
4925
4926-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
4927-# a new page for each member. If set to NO, the documentation of a member will
4928+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
4929+# a new page for each member. If set to NO, the documentation of a member will
4930 # be part of the file/class/namespace that contains it.
4931
4932 SEPARATE_MEMBER_PAGES = NO
4933
4934-# The TAB_SIZE tag can be used to set the number of spaces in a tab.
4935+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
4936 # Doxygen uses this value to replace tabs by spaces in code fragments.
4937
4938 TAB_SIZE = 2
4939
4940-# This tag can be used to specify a number of aliases that acts
4941-# as commands in the documentation. An alias has the form "name=value".
4942-# For example adding "sideeffect=\par Side Effects:\n" will allow you to
4943-# put the command \sideeffect (or @sideeffect) in the documentation, which
4944-# will result in a user-defined paragraph with heading "Side Effects:".
4945+# This tag can be used to specify a number of aliases that acts
4946+# as commands in the documentation. An alias has the form "name=value".
4947+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
4948+# put the command \sideeffect (or @sideeffect) in the documentation, which
4949+# will result in a user-defined paragraph with heading "Side Effects:".
4950 # You can put \n's in the value part of an alias to insert newlines.
4951
4952-ALIASES =
4953+ALIASES =
4954
4955-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
4956-# sources only. Doxygen will then generate output that is more tailored for C.
4957-# For instance, some of the names that are used will be different. The list
4958+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
4959+# sources only. Doxygen will then generate output that is more tailored for C.
4960+# For instance, some of the names that are used will be different. The list
4961 # of all members will be omitted, etc.
4962
4963 OPTIMIZE_OUTPUT_FOR_C = YES
4964
4965-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
4966-# sources only. Doxygen will then generate output that is more tailored for Java.
4967-# For instance, namespaces will be presented as packages, qualified scopes
4968-# will look different, etc.
4969+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
4970+# sources only. Doxygen will then generate output that is more tailored for
4971+# Java. For instance, namespaces will be presented as packages, qualified
4972+# scopes will look different, etc.
4973
4974 OPTIMIZE_OUTPUT_JAVA = NO
4975
4976-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
4977-# include (a tag file for) the STL sources as input, then you should
4978-# set this tag to YES in order to let doxygen match functions declarations and
4979-# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
4980-# func(std::string) {}). This also make the inheritance and collaboration
4981+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
4982+# sources only. Doxygen will then generate output that is more tailored for
4983+# Fortran.
4984+
4985+OPTIMIZE_FOR_FORTRAN = NO
4986+
4987+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
4988+# sources. Doxygen will then generate output that is tailored for
4989+# VHDL.
4990+
4991+OPTIMIZE_OUTPUT_VHDL = NO
4992+
4993+# Doxygen selects the parser to use depending on the extension of the files it
4994+# parses. With this tag you can assign which parser to use for a given extension.
4995+# Doxygen has a built-in mapping, but you can override or extend it using this
4996+# tag. The format is ext=language, where ext is a file extension, and language
4997+# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
4998+# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
4999+# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
5000+# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
The diff has been truncated for viewing.

Subscribers

People subscribed via source and target branches