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

Proposed by Sorin Marian Nasoi
Status: Superseded
Proposed branch: lp:~zorba-coders/zorba/fix_warnings_fedora
Merge into: lp:zorba
Diff against target: 16767 lines (+7863/-3928)
26 files modified
doc/c/doxy.config.in (+1109/-552)
doc/cxx/doxy.config.in (+1115/-551)
doc/java/doxy.config.in (+1110/-552)
doc/php/doxy.config.in (+1110/-552)
doc/python/doxy.config.in (+1110/-552)
doc/ruby/doxy.config.in (+1110/-552)
doc/zorba/CMakeLists.txt (+2/-0)
doc/zorba/build.dox (+5/-2)
doc/zorba/build_noncore.dox (+5/-5)
doc/zorba/doxy.config.in (+1110/-548)
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
Matthias Brantner Needs Fixing
Sorin Marian Nasoi Approve
William Candillon Pending
Review via email: mp+97394@code.launchpad.net

This proposal has been superseded by a proposal from 2012-03-15.

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) :
review: Approve
Revision history for this message
Matthias Brantner (matthias-brantner) wrote :

- 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 :

> - 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 :

> > - 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 :

> > > - 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 :

> > > > > - 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 :

Is working on Windows

10725. By Sorin Marian Nasoi <email address hidden>

Merged trunk.

10726. By Sorin Marian Nasoi <email address hidden>

Reverted the changes made by the 'doxygen -u' : the files are now updated 'by hand' with the old names of the projects.

10727. By Sorin Marian Nasoi <email address hidden>

Fixed the unused variable warning.

10728. By Sorin Marian Nasoi <email address hidden>

Added quotes for the Project Names.

Unmerged revisions

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

Subscribers

People subscribed via source and target branches