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
=== modified file 'doc/c/doxy.config.in'
--- doc/c/doxy.config.in 2011-06-30 20:03:46 +0000
+++ doc/c/doxy.config.in 2012-03-15 17:14:22 +0000
@@ -1,442 +1,623 @@
1# Doxyfile 1.4.51# Doxyfile 1.7.5
22
3# This file describes the settings to be used by the documentation system3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project4# doxygen (www.doxygen.org) for a project.
5#5#
6# All text after a hash (#) is considered a comment and will be ignored6# All text after a hash (#) is considered a comment and will be ignored.
7# The format is:7# The format is:
8# TAG = value [value, ...]8# TAG = value [value, ...]
9# For lists items can also be appended using:9# For lists items can also be appended using:
10# TAG += value [value, ...]10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")11# Values that contain spaces should be placed between quotes (" ").
1212
13#---------------------------------------------------------------------------13#---------------------------------------------------------------------------
14# Project related configuration options14# Project related configuration options
15#---------------------------------------------------------------------------15#---------------------------------------------------------------------------
1616
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 17# This tag specifies the encoding used for all characters in the config file
18# by quotes) that should identify the project.18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
25# The PROJECT_NAME tag is a single word (or sequence of words) that should
26# identify the project. Note that if you do not use Doxywizard you need
27# to put quotes around the project name if it contains spaces.
1928
20PROJECT_NAME = Zorba C-API29PROJECT_NAME = Zorba C-API
2130
22# The PROJECT_NUMBER tag can be used to enter a project or revision number. 31# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or 32# This could be handy for archiving the generated documentation or
24# if some version control system is used.33# if some version control system is used.
2534
26PROJECT_NUMBER = @ZORBA_MAJOR_NUMBER@.@ZORBA_MINOR_NUMBER@.@ZORBA_PATCH_NUMBER@35PROJECT_NUMBER = @ZORBA_MAJOR_NUMBER@.@ZORBA_MINOR_NUMBER@.@ZORBA_PATCH_NUMBER@
2736
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 37# Using the PROJECT_BRIEF tag one can provide an optional one line description
29# base path where the generated documentation will be put. 38# for a project that appears at the top of each page and should give viewer
30# If a relative path is entered, it will be relative to the location 39# a quick idea about the purpose of the project. Keep the description short.
40
41PROJECT_BRIEF =
42
43# With the PROJECT_LOGO tag one can specify an logo or icon that is
44# included in the documentation. The maximum height of the logo should not
45# exceed 55 pixels and the maximum width should not exceed 200 pixels.
46# Doxygen will copy the logo to the output directory.
47
48PROJECT_LOGO =
49
50# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51# base path where the generated documentation will be put.
52# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.53# where doxygen was started. If left blank the current directory will be used.
3254
33OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@55OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
3456
35# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 57# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36# 4096 sub-directories (in 2 levels) under the output directory of each output 58# 4096 sub-directories (in 2 levels) under the output directory of each output
37# format and will distribute the generated files over these directories. 59# format and will distribute the generated files over these directories.
38# Enabling this option can be useful when feeding doxygen a huge amount of 60# Enabling this option can be useful when feeding doxygen a huge amount of
39# source files, where putting all generated files in the same directory would 61# source files, where putting all generated files in the same directory would
40# otherwise cause performance problems for the file system.62# otherwise cause performance problems for the file system.
4163
42CREATE_SUBDIRS = NO64CREATE_SUBDIRS = NO
4365
44# The OUTPUT_LANGUAGE tag is used to specify the language in which all 66# The OUTPUT_LANGUAGE tag is used to specify the language in which all
45# documentation generated by doxygen is written. Doxygen will use this 67# documentation generated by doxygen is written. Doxygen will use this
46# information to generate all constant output in the proper language. 68# information to generate all constant output in the proper language.
47# The default language is English, other supported languages are: 69# The default language is English, other supported languages are:
48# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 70# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
49# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 71# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
50# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 72# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
51# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 73# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
52# Swedish, and Ukrainian.74# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
5376
54OUTPUT_LANGUAGE = English77OUTPUT_LANGUAGE = English
5578
56# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 79# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57# include brief member descriptions after the members that are listed in 80# include brief member descriptions after the members that are listed in
58# the file and class documentation (similar to JavaDoc). 81# the file and class documentation (similar to JavaDoc).
59# Set to NO to disable this.82# Set to NO to disable this.
6083
61BRIEF_MEMBER_DESC = YES84BRIEF_MEMBER_DESC = YES
6285
63# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 86# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64# the brief description of a member or function before the detailed description. 87# the brief description of a member or function before the detailed description.
65# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 88# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66# brief descriptions will be completely suppressed.89# brief descriptions will be completely suppressed.
6790
68REPEAT_BRIEF = YES91REPEAT_BRIEF = YES
6992
70# This tag implements a quasi-intelligent brief description abbreviator 93# This tag implements a quasi-intelligent brief description abbreviator
71# that is used to form the text in various listings. Each string 94# that is used to form the text in various listings. Each string
72# in this list, if found as the leading text of the brief description, will be 95# in this list, if found as the leading text of the brief description, will be
73# stripped from the text and the result after processing the whole list, is 96# stripped from the text and the result after processing the whole list, is
74# used as the annotated text. Otherwise, the brief description is used as-is. 97# used as the annotated text. Otherwise, the brief description is used as-is.
75# If left blank, the following values are used ("$name" is automatically 98# If left blank, the following values are used ("$name" is automatically
76# replaced with the name of the entity): "The $name class" "The $name widget" 99# replaced with the name of the entity): "The $name class" "The $name widget"
77# "The $name file" "is" "provides" "specifies" "contains" 100# "The $name file" "is" "provides" "specifies" "contains"
78# "represents" "a" "an" "the"101# "represents" "a" "an" "the"
79102
80ABBREVIATE_BRIEF = 103ABBREVIATE_BRIEF =
81104
82# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 105# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
83# Doxygen will generate a detailed section even if there is only a brief 106# Doxygen will generate a detailed section even if there is only a brief
84# description.107# description.
85108
86ALWAYS_DETAILED_SEC = NO109ALWAYS_DETAILED_SEC = NO
87110
88# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 111# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
89# inherited members of a class in the documentation of that class as if those 112# inherited members of a class in the documentation of that class as if those
90# members were ordinary class members. Constructors, destructors and assignment 113# members were ordinary class members. Constructors, destructors and assignment
91# operators of the base classes will not be shown.114# operators of the base classes will not be shown.
92115
93INLINE_INHERITED_MEMB = YES116INLINE_INHERITED_MEMB = YES
94117
95# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 118# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
96# path before files name in the file list and in the header files. If set 119# path before files name in the file list and in the header files. If set
97# to NO the shortest path that makes the file name unique will be used.120# to NO the shortest path that makes the file name unique will be used.
98121
99FULL_PATH_NAMES = NO122FULL_PATH_NAMES = NO
100123
101# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 124# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
102# can be used to strip a user-defined part of the path. Stripping is 125# can be used to strip a user-defined part of the path. Stripping is
103# only done if one of the specified strings matches the left-hand part of 126# only done if one of the specified strings matches the left-hand part of
104# the path. The tag can be used to show relative paths in the file list. 127# the path. The tag can be used to show relative paths in the file list.
105# If left blank the directory from which doxygen is run is used as the 128# If left blank the directory from which doxygen is run is used as the
106# path to strip.129# path to strip.
107130
108STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src @CMAKE_BINARY_DIR@/src131STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src \
109132 @CMAKE_BINARY_DIR@/src
110133
111# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 134# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
112# the path mentioned in the documentation of a class, which tells 135# the path mentioned in the documentation of a class, which tells
113# the reader which header file to include in order to use a class. 136# the reader which header file to include in order to use a class.
114# If left blank only the name of the header file containing the class 137# If left blank only the name of the header file containing the class
115# definition is used. Otherwise one should specify the include paths that 138# definition is used. Otherwise one should specify the include paths that
116# are normally passed to the compiler using the -I flag.139# are normally passed to the compiler using the -I flag.
117140
118STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include @CMAKE_BINARY_DIR@/include141STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include \
142 @CMAKE_BINARY_DIR@/include
119143
120# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 144# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
121# (but less readable) file names. This can be useful is your file systems 145# (but less readable) file names. This can be useful if your file system
122# doesn't support long names like on DOS, Mac, or CD-ROM.146# doesn't support long names like on DOS, Mac, or CD-ROM.
123147
124SHORT_NAMES = NO148SHORT_NAMES = NO
125149
126# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 150# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
127# will interpret the first line (until the first dot) of a JavaDoc-style 151# will interpret the first line (until the first dot) of a JavaDoc-style
128# comment as the brief description. If set to NO, the JavaDoc 152# comment as the brief description. If set to NO, the JavaDoc
129# comments will behave just like the Qt-style comments (thus requiring an 153# comments will behave just like regular Qt-style comments
130# explicit @brief command for a brief description.154# (thus requiring an explicit @brief command for a brief description.)
131155
132JAVADOC_AUTOBRIEF = YES156JAVADOC_AUTOBRIEF = YES
133157
134# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 158# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
135# treat a multi-line C++ special comment block (i.e. a block of //! or /// 159# interpret the first line (until the first dot) of a Qt-style
136# comments) as a brief description. This used to be the default behaviour. 160# comment as the brief description. If set to NO, the comments
137# The new default is to treat a multi-line C++ comment block as a detailed 161# will behave just like regular Qt-style comments (thus requiring
162# an explicit \brief command for a brief description.)
163
164QT_AUTOBRIEF = NO
165
166# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
167# treat a multi-line C++ special comment block (i.e. a block of //! or ///
168# comments) as a brief description. This used to be the default behaviour.
169# The new default is to treat a multi-line C++ comment block as a detailed
138# description. Set this tag to YES if you prefer the old behaviour instead.170# description. Set this tag to YES if you prefer the old behaviour instead.
139171
140MULTILINE_CPP_IS_BRIEF = NO172MULTILINE_CPP_IS_BRIEF = NO
141173
142# If the DETAILS_AT_TOP tag is set to YES then Doxygen 174# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
143# will output the detailed description near the top, like JavaDoc.175# member inherits the documentation from any documented member that it
144# If set to NO, the detailed description appears after the member
145# documentation.
146
147DETAILS_AT_TOP = NO
148
149# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
150# member inherits the documentation from any documented member that it
151# re-implements.176# re-implements.
152177
153INHERIT_DOCS = YES178INHERIT_DOCS = YES
154179
155# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 180# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
156# a new page for each member. If set to NO, the documentation of a member will 181# a new page for each member. If set to NO, the documentation of a member will
157# be part of the file/class/namespace that contains it.182# be part of the file/class/namespace that contains it.
158183
159SEPARATE_MEMBER_PAGES = NO184SEPARATE_MEMBER_PAGES = NO
160185
161# The TAB_SIZE tag can be used to set the number of spaces in a tab. 186# The TAB_SIZE tag can be used to set the number of spaces in a tab.
162# Doxygen uses this value to replace tabs by spaces in code fragments.187# Doxygen uses this value to replace tabs by spaces in code fragments.
163188
164TAB_SIZE = 2189TAB_SIZE = 2
165190
166# This tag can be used to specify a number of aliases that acts 191# This tag can be used to specify a number of aliases that acts
167# as commands in the documentation. An alias has the form "name=value". 192# as commands in the documentation. An alias has the form "name=value".
168# For example adding "sideeffect=\par Side Effects:\n" will allow you to 193# For example adding "sideeffect=\par Side Effects:\n" will allow you to
169# put the command \sideeffect (or @sideeffect) in the documentation, which 194# put the command \sideeffect (or @sideeffect) in the documentation, which
170# will result in a user-defined paragraph with heading "Side Effects:". 195# will result in a user-defined paragraph with heading "Side Effects:".
171# You can put \n's in the value part of an alias to insert newlines.196# You can put \n's in the value part of an alias to insert newlines.
172197
173ALIASES = 198ALIASES =
174199
175# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 200# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
176# sources only. Doxygen will then generate output that is more tailored for C. 201# sources only. Doxygen will then generate output that is more tailored for C.
177# For instance, some of the names that are used will be different. The list 202# For instance, some of the names that are used will be different. The list
178# of all members will be omitted, etc.203# of all members will be omitted, etc.
179204
180OPTIMIZE_OUTPUT_FOR_C = YES205OPTIMIZE_OUTPUT_FOR_C = YES
181206
182# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 207# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
183# sources only. Doxygen will then generate output that is more tailored for Java. 208# sources only. Doxygen will then generate output that is more tailored for
184# For instance, namespaces will be presented as packages, qualified scopes 209# Java. For instance, namespaces will be presented as packages, qualified
185# will look different, etc.210# scopes will look different, etc.
186211
187OPTIMIZE_OUTPUT_JAVA = NO212OPTIMIZE_OUTPUT_JAVA = NO
188213
189# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 214# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
190# include (a tag file for) the STL sources as input, then you should 215# sources only. Doxygen will then generate output that is more tailored for
191# set this tag to YES in order to let doxygen match functions declarations and 216# Fortran.
192# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 217
193# func(std::string) {}). This also make the inheritance and collaboration 218OPTIMIZE_FOR_FORTRAN = NO
219
220# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
221# sources. Doxygen will then generate output that is tailored for
222# VHDL.
223
224OPTIMIZE_OUTPUT_VHDL = NO
225
226# Doxygen selects the parser to use depending on the extension of the files it
227# parses. With this tag you can assign which parser to use for a given extension.
228# Doxygen has a built-in mapping, but you can override or extend it using this
229# tag. The format is ext=language, where ext is a file extension, and language
230# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
231# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
232# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
233# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
234# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
235
236EXTENSION_MAPPING =
237
238# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
239# to include (a tag file for) the STL sources as input, then you should
240# set this tag to YES in order to let doxygen match functions declarations and
241# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
242# func(std::string) {}). This also makes the inheritance and collaboration
194# diagrams that involve STL classes more complete and accurate.243# diagrams that involve STL classes more complete and accurate.
195244
196# BUILTIN_STL_SUPPORT = NO245BUILTIN_STL_SUPPORT = NO
197246
198# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 247# If you use Microsoft's C++/CLI language, you should set this option to YES to
199# tag is set to YES, then doxygen will reuse the documentation of the first 248# enable parsing support.
200# member in the group (if any) for the other members of the group. By default 249
250CPP_CLI_SUPPORT = NO
251
252# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
253# Doxygen will parse them like normal C++ but will assume all classes use public
254# instead of private inheritance when no explicit protection keyword is present.
255
256SIP_SUPPORT = NO
257
258# For Microsoft's IDL there are propget and propput attributes to indicate getter
259# and setter methods for a property. Setting this option to YES (the default)
260# will make doxygen replace the get and set methods by a property in the
261# documentation. This will only work if the methods are indeed getting or
262# setting a simple type. If this is not the case, or you want to show the
263# methods anyway, you should set this option to NO.
264
265IDL_PROPERTY_SUPPORT = YES
266
267# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
268# tag is set to YES, then doxygen will reuse the documentation of the first
269# member in the group (if any) for the other members of the group. By default
201# all members of a group must be documented explicitly.270# all members of a group must be documented explicitly.
202271
203DISTRIBUTE_GROUP_DOC = NO272DISTRIBUTE_GROUP_DOC = NO
204273
205# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 274# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
206# the same type (for instance a group of public functions) to be put as a 275# the same type (for instance a group of public functions) to be put as a
207# subgroup of that type (e.g. under the Public Functions section). Set it to 276# subgroup of that type (e.g. under the Public Functions section). Set it to
208# NO to prevent subgrouping. Alternatively, this can be done per class using 277# NO to prevent subgrouping. Alternatively, this can be done per class using
209# the \nosubgrouping command.278# the \nosubgrouping command.
210279
211SUBGROUPING = YES280SUBGROUPING = YES
212281
282# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
283# unions are shown inside the group in which they are included (e.g. using
284# @ingroup) instead of on a separate page (for HTML and Man pages) or
285# section (for LaTeX and RTF).
286
287INLINE_GROUPED_CLASSES = NO
288
289# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
290# unions with only public data fields will be shown inline in the documentation
291# of the scope in which they are defined (i.e. file, namespace, or group
292# documentation), provided this scope is documented. If set to NO (the default),
293# structs, classes, and unions are shown on a separate page (for HTML and Man
294# pages) or section (for LaTeX and RTF).
295
296INLINE_SIMPLE_STRUCTS = NO
297
298# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
299# is documented as struct, union, or enum with the name of the typedef. So
300# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
301# with name TypeT. When disabled the typedef will appear as a member of a file,
302# namespace, or class. And the struct will be named TypeS. This can typically
303# be useful for C code in case the coding convention dictates that all compound
304# types are typedef'ed and only the typedef is referenced, never the tag name.
305
306TYPEDEF_HIDES_STRUCT = NO
307
308# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
309# determine which symbols to keep in memory and which to flush to disk.
310# When the cache is full, less often used symbols will be written to disk.
311# For small to medium size projects (<1000 input files) the default value is
312# probably good enough. For larger projects a too small cache size can cause
313# doxygen to be busy swapping symbols to and from disk most of the time
314# causing a significant performance penalty.
315# If the system has enough physical memory increasing the cache will improve the
316# performance by keeping more symbols in memory. Note that the value works on
317# a logarithmic scale so increasing the size by one will roughly double the
318# memory usage. The cache size is given by this formula:
319# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
320# corresponding to a cache size of 2^16 = 65536 symbols
321
322SYMBOL_CACHE_SIZE = 0
323
213#---------------------------------------------------------------------------324#---------------------------------------------------------------------------
214# Build related configuration options325# Build related configuration options
215#---------------------------------------------------------------------------326#---------------------------------------------------------------------------
216327
217# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 328# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
218# documentation are documented, even if no documentation was available. 329# documentation are documented, even if no documentation was available.
219# Private class members and static file members will be hidden unless 330# Private class members and static file members will be hidden unless
220# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES331# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
221332
222EXTRACT_ALL = YES333EXTRACT_ALL = YES
223334
224# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 335# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
225# will be included in the documentation.336# will be included in the documentation.
226337
227EXTRACT_PRIVATE = NO338EXTRACT_PRIVATE = NO
228339
229# If the EXTRACT_STATIC tag is set to YES all static members of a file 340# If the EXTRACT_STATIC tag is set to YES all static members of a file
230# will be included in the documentation.341# will be included in the documentation.
231342
232EXTRACT_STATIC = NO343EXTRACT_STATIC = NO
233344
234# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 345# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
235# defined locally in source files will be included in the documentation. 346# defined locally in source files will be included in the documentation.
236# If set to NO only classes defined in header files are included.347# If set to NO only classes defined in header files are included.
237348
238EXTRACT_LOCAL_CLASSES = YES349EXTRACT_LOCAL_CLASSES = YES
239350
240# This flag is only useful for Objective-C code. When set to YES local 351# This flag is only useful for Objective-C code. When set to YES local
241# methods, which are defined in the implementation section but not in 352# methods, which are defined in the implementation section but not in
242# the interface are included in the documentation. 353# the interface are included in the documentation.
243# If set to NO (the default) only methods in the interface are included.354# If set to NO (the default) only methods in the interface are included.
244355
245EXTRACT_LOCAL_METHODS = NO356EXTRACT_LOCAL_METHODS = NO
246357
247# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 358# If this flag is set to YES, the members of anonymous namespaces will be
248# undocumented members of documented classes, files or namespaces. 359# extracted and appear in the documentation as a namespace called
249# If set to NO (the default) these members will be included in the 360# 'anonymous_namespace{file}', where file will be replaced with the base
250# various overviews, but no documentation section is generated. 361# name of the file that contains the anonymous namespace. By default
362# anonymous namespaces are hidden.
363
364EXTRACT_ANON_NSPACES = NO
365
366# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
367# undocumented members of documented classes, files or namespaces.
368# If set to NO (the default) these members will be included in the
369# various overviews, but no documentation section is generated.
251# This option has no effect if EXTRACT_ALL is enabled.370# This option has no effect if EXTRACT_ALL is enabled.
252371
253HIDE_UNDOC_MEMBERS = YES372HIDE_UNDOC_MEMBERS = YES
254373
255# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 374# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
256# undocumented classes that are normally visible in the class hierarchy. 375# undocumented classes that are normally visible in the class hierarchy.
257# If set to NO (the default) these classes will be included in the various 376# If set to NO (the default) these classes will be included in the various
258# overviews. This option has no effect if EXTRACT_ALL is enabled.377# overviews. This option has no effect if EXTRACT_ALL is enabled.
259378
260HIDE_UNDOC_CLASSES = YES379HIDE_UNDOC_CLASSES = YES
261380
262# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 381# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
263# friend (class|struct|union) declarations. 382# friend (class|struct|union) declarations.
264# If set to NO (the default) these declarations will be included in the 383# If set to NO (the default) these declarations will be included in the
265# documentation.384# documentation.
266385
267HIDE_FRIEND_COMPOUNDS = NO386HIDE_FRIEND_COMPOUNDS = NO
268387
269# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 388# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
270# documentation blocks found inside the body of a function. 389# documentation blocks found inside the body of a function.
271# If set to NO (the default) these blocks will be appended to the 390# If set to NO (the default) these blocks will be appended to the
272# function's detailed documentation block.391# function's detailed documentation block.
273392
274HIDE_IN_BODY_DOCS = NO393HIDE_IN_BODY_DOCS = NO
275394
276# The INTERNAL_DOCS tag determines if documentation 395# The INTERNAL_DOCS tag determines if documentation
277# that is typed after a \internal command is included. If the tag is set 396# that is typed after a \internal command is included. If the tag is set
278# to NO (the default) then the documentation will be excluded. 397# to NO (the default) then the documentation will be excluded.
279# Set it to YES to include the internal documentation.398# Set it to YES to include the internal documentation.
280399
281INTERNAL_DOCS = NO400INTERNAL_DOCS = NO
282401
283# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 402# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
284# file names in lower-case letters. If set to YES upper-case letters are also 403# file names in lower-case letters. If set to YES upper-case letters are also
285# allowed. This is useful if you have classes or files whose names only differ 404# allowed. This is useful if you have classes or files whose names only differ
286# in case and if your file system supports case sensitive file names. Windows 405# in case and if your file system supports case sensitive file names. Windows
287# and Mac users are advised to set this option to NO.406# and Mac users are advised to set this option to NO.
288407
289CASE_SENSE_NAMES = YES408CASE_SENSE_NAMES = YES
290409
291# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 410# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
292# will show members with their full class and namespace scopes in the 411# will show members with their full class and namespace scopes in the
293# documentation. If set to YES the scope will be hidden.412# documentation. If set to YES the scope will be hidden.
294413
295HIDE_SCOPE_NAMES = NO414HIDE_SCOPE_NAMES = NO
296415
297# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 416# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
298# will put a list of the files that are included by a file in the documentation 417# will put a list of the files that are included by a file in the documentation
299# of that file.418# of that file.
300419
301SHOW_INCLUDE_FILES = YES420SHOW_INCLUDE_FILES = YES
302421
303# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 422# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
423# will list include files with double quotes in the documentation
424# rather than with sharp brackets.
425
426FORCE_LOCAL_INCLUDES = NO
427
428# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
304# is inserted in the documentation for inline members.429# is inserted in the documentation for inline members.
305430
306INLINE_INFO = YES431INLINE_INFO = YES
307432
308# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 433# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
309# will sort the (detailed) documentation of file and class members 434# will sort the (detailed) documentation of file and class members
310# alphabetically by member name. If set to NO the members will appear in 435# alphabetically by member name. If set to NO the members will appear in
311# declaration order.436# declaration order.
312437
313SORT_MEMBER_DOCS = YES438SORT_MEMBER_DOCS = YES
314439
315# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 440# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
316# brief documentation of file, namespace and class members alphabetically 441# brief documentation of file, namespace and class members alphabetically
317# by member name. If set to NO (the default) the members will appear in 442# by member name. If set to NO (the default) the members will appear in
318# declaration order.443# declaration order.
319444
320SORT_BRIEF_DOCS = YES445SORT_BRIEF_DOCS = YES
321446
322# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 447# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
323# sorted by fully-qualified names, including namespaces. If set to 448# will sort the (brief and detailed) documentation of class members so that
324# NO (the default), the class list will be sorted only by class name, 449# constructors and destructors are listed first. If set to NO (the default)
325# not including the namespace part. 450# the constructors will appear in the respective orders defined by
451# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
452# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
453# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
454
455SORT_MEMBERS_CTORS_1ST = NO
456
457# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
458# hierarchy of group names into alphabetical order. If set to NO (the default)
459# the group names will appear in their defined order.
460
461SORT_GROUP_NAMES = NO
462
463# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
464# sorted by fully-qualified names, including namespaces. If set to
465# NO (the default), the class list will be sorted only by class name,
466# not including the namespace part.
326# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.467# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
327# Note: This option applies only to the class list, not to the 468# Note: This option applies only to the class list, not to the
328# alphabetical list.469# alphabetical list.
329470
330SORT_BY_SCOPE_NAME = NO471SORT_BY_SCOPE_NAME = NO
331472
332# The GENERATE_TODOLIST tag can be used to enable (YES) or 473# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
333# disable (NO) the todo list. This list is created by putting \todo 474# do proper type resolution of all parameters of a function it will reject a
475# match between the prototype and the implementation of a member function even
476# if there is only one candidate or it is obvious which candidate to choose
477# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
478# will still accept a match between prototype and implementation in such cases.
479
480STRICT_PROTO_MATCHING = NO
481
482# The GENERATE_TODOLIST tag can be used to enable (YES) or
483# disable (NO) the todo list. This list is created by putting \todo
334# commands in the documentation.484# commands in the documentation.
335485
336GENERATE_TODOLIST = YES486GENERATE_TODOLIST = YES
337487
338# The GENERATE_TESTLIST tag can be used to enable (YES) or 488# The GENERATE_TESTLIST tag can be used to enable (YES) or
339# disable (NO) the test list. This list is created by putting \test 489# disable (NO) the test list. This list is created by putting \test
340# commands in the documentation.490# commands in the documentation.
341491
342GENERATE_TESTLIST = YES492GENERATE_TESTLIST = YES
343493
344# The GENERATE_BUGLIST tag can be used to enable (YES) or 494# The GENERATE_BUGLIST tag can be used to enable (YES) or
345# disable (NO) the bug list. This list is created by putting \bug 495# disable (NO) the bug list. This list is created by putting \bug
346# commands in the documentation.496# commands in the documentation.
347497
348GENERATE_BUGLIST = YES498GENERATE_BUGLIST = YES
349499
350# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 500# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
351# disable (NO) the deprecated list. This list is created by putting 501# disable (NO) the deprecated list. This list is created by putting
352# \deprecated commands in the documentation.502# \deprecated commands in the documentation.
353503
354GENERATE_DEPRECATEDLIST= YES504GENERATE_DEPRECATEDLIST= YES
355505
356# The ENABLED_SECTIONS tag can be used to enable conditional 506# The ENABLED_SECTIONS tag can be used to enable conditional
357# documentation sections, marked by \if sectionname ... \endif.507# documentation sections, marked by \if sectionname ... \endif.
358508
359ENABLED_SECTIONS =509ENABLED_SECTIONS =
360510
361# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 511# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
362# the initial value of a variable or define consists of for it to appear in 512# the initial value of a variable or macro consists of for it to appear in
363# the documentation. If the initializer consists of more lines than specified 513# the documentation. If the initializer consists of more lines than specified
364# here it will be hidden. Use a value of 0 to hide initializers completely. 514# here it will be hidden. Use a value of 0 to hide initializers completely.
365# The appearance of the initializer of individual variables and defines in the 515# The appearance of the initializer of individual variables and macros in the
366# documentation can be controlled using \showinitializer or \hideinitializer 516# documentation can be controlled using \showinitializer or \hideinitializer
367# command in the documentation regardless of this setting.517# command in the documentation regardless of this setting.
368518
369MAX_INITIALIZER_LINES = 30519MAX_INITIALIZER_LINES = 30
370520
371# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 521# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
372# at the bottom of the documentation of classes and structs. If set to YES the 522# at the bottom of the documentation of classes and structs. If set to YES the
373# list will mention the files that were used to generate the documentation.523# list will mention the files that were used to generate the documentation.
374524
375SHOW_USED_FILES = YES525SHOW_USED_FILES = YES
376526
377# If the sources in your project are distributed over multiple directories 527# If the sources in your project are distributed over multiple directories
378# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 528# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
379# in the documentation. The default is YES.529# in the documentation. The default is NO.
380530
381SHOW_DIRECTORIES = YES531SHOW_DIRECTORIES = YES
382532
383# The FILE_VERSION_FILTER tag can be used to specify a program or script that 533# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
384# doxygen should invoke to get the current version for each file (typically from the 534# This will remove the Files entry from the Quick Index and from the
385# version control system). Doxygen will invoke the program by executing (via 535# Folder Tree View (if specified). The default is YES.
386# popen()) the command <command> <input-file>, where <command> is the value of 536
387# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 537SHOW_FILES = YES
388# provided by doxygen. Whatever the program writes to standard output 538
539# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
540# Namespaces page.
541# This will remove the Namespaces entry from the Quick Index
542# and from the Folder Tree View (if specified). The default is YES.
543
544SHOW_NAMESPACES = YES
545
546# The FILE_VERSION_FILTER tag can be used to specify a program or script that
547# doxygen should invoke to get the current version for each file (typically from
548# the version control system). Doxygen will invoke the program by executing (via
549# popen()) the command <command> <input-file>, where <command> is the value of
550# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
551# provided by doxygen. Whatever the program writes to standard output
389# is used as the file version. See the manual for examples.552# is used as the file version. See the manual for examples.
390553
391FILE_VERSION_FILTER = 554FILE_VERSION_FILTER =
555
556# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
557# by doxygen. The layout file controls the global structure of the generated
558# output files in an output format independent way. The create the layout file
559# that represents doxygen's defaults, run doxygen with the -l option.
560# You can optionally specify a file name after the option, if omitted
561# DoxygenLayout.xml will be used as the name of the layout file.
562
563LAYOUT_FILE =
564
565# The CITE_BIB_FILES tag can be used to specify one or more bib files
566# containing the references data. This must be a list of .bib files. The
567# .bib extension is automatically appended if omitted. Using this command
568# requires the bibtex tool to be installed. See also
569# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
570# of the bibliography can be controlled using LATEX_BIB_STYLE.
571
572CITE_BIB_FILES =
392573
393#---------------------------------------------------------------------------574#---------------------------------------------------------------------------
394# configuration options related to warning and progress messages575# configuration options related to warning and progress messages
395#---------------------------------------------------------------------------576#---------------------------------------------------------------------------
396577
397# The QUIET tag can be used to turn on/off the messages that are generated 578# The QUIET tag can be used to turn on/off the messages that are generated
398# by doxygen. Possible values are YES and NO. If left blank NO is used.579# by doxygen. Possible values are YES and NO. If left blank NO is used.
399580
400QUIET = NO581QUIET = NO
401582
402# The WARNINGS tag can be used to turn on/off the warning messages that are 583# The WARNINGS tag can be used to turn on/off the warning messages that are
403# generated by doxygen. Possible values are YES and NO. If left blank 584# generated by doxygen. Possible values are YES and NO. If left blank
404# NO is used.585# NO is used.
405586
406WARNINGS = YES587WARNINGS = YES
407588
408# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 589# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
409# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 590# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
410# automatically be disabled.591# automatically be disabled.
411592
412WARN_IF_UNDOCUMENTED = YES593WARN_IF_UNDOCUMENTED = YES
413594
414# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 595# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
415# potential errors in the documentation, such as not documenting some 596# potential errors in the documentation, such as not documenting some
416# parameters in a documented function, or documenting parameters that 597# parameters in a documented function, or documenting parameters that
417# don't exist or using markup commands wrongly.598# don't exist or using markup commands wrongly.
418599
419WARN_IF_DOC_ERROR = YES600WARN_IF_DOC_ERROR = YES
420601
421# This WARN_NO_PARAMDOC option can be abled to get warnings for 602# The WARN_NO_PARAMDOC option can be enabled to get warnings for
422# functions that are documented, but have no documentation for their parameters 603# functions that are documented, but have no documentation for their parameters
423# or return value. If set to NO (the default) doxygen will only warn about 604# or return value. If set to NO (the default) doxygen will only warn about
424# wrong or incomplete parameter documentation, but not about the absence of 605# wrong or incomplete parameter documentation, but not about the absence of
425# documentation.606# documentation.
426607
427WARN_NO_PARAMDOC = NO608WARN_NO_PARAMDOC = NO
428609
429# The WARN_FORMAT tag determines the format of the warning messages that 610# The WARN_FORMAT tag determines the format of the warning messages that
430# doxygen can produce. The string should contain the $file, $line, and $text 611# doxygen can produce. The string should contain the $file, $line, and $text
431# tags, which will be replaced by the file and line number from which the 612# tags, which will be replaced by the file and line number from which the
432# warning originated and the warning text. Optionally the format may contain 613# warning originated and the warning text. Optionally the format may contain
433# $version, which will be replaced by the version of the file (if it could 614# $version, which will be replaced by the version of the file (if it could
434# be obtained via FILE_VERSION_FILTER)615# be obtained via FILE_VERSION_FILTER)
435616
436WARN_FORMAT = @DOXY_WARN_FORMAT@617WARN_FORMAT = @DOXY_WARN_FORMAT@
437618
438# The WARN_LOGFILE tag can be used to specify a file to which warning 619# The WARN_LOGFILE tag can be used to specify a file to which warning
439# and error messages should be written. If left blank the output is written 620# and error messages should be written. If left blank the output is written
440# to stderr.621# to stderr.
441622
442WARN_LOGFILE = Doc/doxy.log623WARN_LOGFILE = Doc/doxy.log
@@ -445,9 +626,9 @@
445# configuration options related to the input files626# configuration options related to the input files
446#---------------------------------------------------------------------------627#---------------------------------------------------------------------------
447628
448# The INPUT tag can be used to specify the files and/or directories that contain 629# The INPUT tag can be used to specify the files and/or directories that contain
449# documented source files. You may enter file names like "myfile.cpp" or 630# documented source files. You may enter file names like "myfile.cpp" or
450# directories like "/usr/src/myproject". Separate the files or directories 631# directories like "/usr/src/myproject". Separate the files or directories
451# with spaces.632# with spaces.
452633
453INPUT = @CMAKE_SOURCE_DIR@/include/zorba/zorbac.h \634INPUT = @CMAKE_SOURCE_DIR@/include/zorba/zorbac.h \
@@ -455,140 +636,176 @@
455 @CMAKE_SOURCE_DIR@/include/zorba/static_context_consts.h \636 @CMAKE_SOURCE_DIR@/include/zorba/static_context_consts.h \
456 @CMAKE_SOURCE_DIR@/include/zorba/options.h \637 @CMAKE_SOURCE_DIR@/include/zorba/options.h \
457 @CMAKE_CURRENT_SOURCE_DIR@/manual638 @CMAKE_CURRENT_SOURCE_DIR@/manual
458 639
459640# This tag can be used to specify the character encoding of the source files
460# If the value of the INPUT tag contains directories, you can use the 641# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
461# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 642# also the default input encoding. Doxygen uses libiconv (or the iconv built
462# and *.h) to filter out the source-files in the directories. If left 643# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
463# blank the following patterns are tested: 644# the list of possible encodings.
464# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 645
465# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py646INPUT_ENCODING = UTF-8
466647
467FILE_PATTERNS = *.h *.dox648# If the value of the INPUT tag contains directories, you can use the
468649# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
469# The RECURSIVE tag can be used to turn specify whether or not subdirectories 650# and *.h) to filter out the source-files in the directories. If left
470# should be searched for input files as well. Possible values are YES and NO. 651# blank the following patterns are tested:
652# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
653# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
654# *.f90 *.f *.for *.vhd *.vhdl
655
656FILE_PATTERNS = *.h \
657 *.dox
658
659# The RECURSIVE tag can be used to turn specify whether or not subdirectories
660# should be searched for input files as well. Possible values are YES and NO.
471# If left blank NO is used.661# If left blank NO is used.
472662
473RECURSIVE = YES663RECURSIVE = YES
474664
475# The EXCLUDE tag can be used to specify files and/or directories that should 665# The EXCLUDE tag can be used to specify files and/or directories that should
476# excluded from the INPUT source files. This way you can easily exclude a 666# excluded from the INPUT source files. This way you can easily exclude a
477# subdirectory from a directory tree whose root is specified with the INPUT tag.667# subdirectory from a directory tree whose root is specified with the INPUT tag.
478668# Note that relative paths are relative to directory from which doxygen is run.
479EXCLUDE = 669
480670EXCLUDE =
481# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 671
482# directories that are symbolic links (a Unix filesystem feature) are excluded 672# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
673# directories that are symbolic links (a Unix file system feature) are excluded
483# from the input.674# from the input.
484675
485EXCLUDE_SYMLINKS = NO676EXCLUDE_SYMLINKS = NO
486677
487# If the value of the INPUT tag contains directories, you can use the 678# If the value of the INPUT tag contains directories, you can use the
488# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 679# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
489# certain files from those directories. Note that the wildcards are matched 680# certain files from those directories. Note that the wildcards are matched
490# against the file with absolute path, so to exclude all test directories 681# against the file with absolute path, so to exclude all test directories
491# for example use the pattern */test/*682# for example use the pattern */test/*
492683
493EXCLUDE_PATTERNS = */.svn \684EXCLUDE_PATTERNS = */.svn \
494 */.svn/*685 */.svn/*
495686
496# The EXAMPLE_PATH tag can be used to specify one or more files or 687# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
497# directories that contain example code fragments that are included (see 688# (namespaces, classes, functions, etc.) that should be excluded from the
689# output. The symbol name can be a fully qualified name, a word, or if the
690# wildcard * is used, a substring. Examples: ANamespace, AClass,
691# AClass::ANamespace, ANamespace::*Test
692
693EXCLUDE_SYMBOLS =
694
695# The EXAMPLE_PATH tag can be used to specify one or more files or
696# directories that contain example code fragments that are included (see
498# the \include command).697# the \include command).
499698
500EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples699EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples
501700
502# If the value of the EXAMPLE_PATH tag contains directories, you can use the 701# If the value of the EXAMPLE_PATH tag contains directories, you can use the
503# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 702# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
504# and *.h) to filter out the source-files in the directories. If left 703# and *.h) to filter out the source-files in the directories. If left
505# blank all files are included.704# blank all files are included.
506705
507EXAMPLE_PATTERNS = *.c706EXAMPLE_PATTERNS = *.c
508707
509# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 708# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
510# searched for input files to be used with the \include or \dontinclude 709# searched for input files to be used with the \include or \dontinclude
511# commands irrespective of the value of the RECURSIVE tag. 710# commands irrespective of the value of the RECURSIVE tag.
512# Possible values are YES and NO. If left blank NO is used.711# Possible values are YES and NO. If left blank NO is used.
513712
514EXAMPLE_RECURSIVE = YES713EXAMPLE_RECURSIVE = YES
515714
516# The IMAGE_PATH tag can be used to specify one or more files or 715# The IMAGE_PATH tag can be used to specify one or more files or
517# directories that contain image that are included in the documentation (see 716# directories that contain image that are included in the documentation (see
518# the \image command).717# the \image command).
519718
520IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@719IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@
521720
522721# The INPUT_FILTER tag can be used to specify a program that doxygen should
523# The INPUT_FILTER tag can be used to specify a program that doxygen should 722# invoke to filter for each input file. Doxygen will invoke the filter program
524# invoke to filter for each input file. Doxygen will invoke the filter program 723# by executing (via popen()) the command <filter> <input-file>, where <filter>
525# by executing (via popen()) the command <filter> <input-file>, where <filter> 724# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
526# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 725# input file. Doxygen will then use the output that the filter program writes
527# input file. Doxygen will then use the output that the filter program writes 726# to standard output.
528# to standard output. If FILTER_PATTERNS is specified, this tag will be 727# If FILTER_PATTERNS is specified, this tag will be
529# ignored.728# ignored.
530729
531INPUT_FILTER = 730INPUT_FILTER =
532731
533# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 732# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
534# basis. Doxygen will compare the file name with each pattern and apply the 733# basis.
535# filter if there is a match. The filters are a list of the form: 734# Doxygen will compare the file name with each pattern and apply the
536# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 735# filter if there is a match.
537# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 736# The filters are a list of the form:
538# is applied to all files.737# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
539738# info on how filters are used. If FILTER_PATTERNS is empty or if
540FILTER_PATTERNS = 739# non of the patterns match the file name, INPUT_FILTER is applied.
541740
542# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 741FILTER_PATTERNS =
543# INPUT_FILTER) will be used to filter the input files when producing source 742
743# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
744# INPUT_FILTER) will be used to filter the input files when producing source
544# files to browse (i.e. when SOURCE_BROWSER is set to YES).745# files to browse (i.e. when SOURCE_BROWSER is set to YES).
545746
546FILTER_SOURCE_FILES = NO747FILTER_SOURCE_FILES = NO
547748
749# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
750# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
751# and it is also possible to disable source filtering for a specific pattern
752# using *.ext= (so without naming a filter). This option only has effect when
753# FILTER_SOURCE_FILES is enabled.
754
755FILTER_SOURCE_PATTERNS =
756
548#---------------------------------------------------------------------------757#---------------------------------------------------------------------------
549# configuration options related to source browsing758# configuration options related to source browsing
550#---------------------------------------------------------------------------759#---------------------------------------------------------------------------
551760
552# If the SOURCE_BROWSER tag is set to YES then a list of source files will 761# If the SOURCE_BROWSER tag is set to YES then a list of source files will
553# be generated. Documented entities will be cross-referenced with these sources. 762# be generated. Documented entities will be cross-referenced with these sources.
554# Note: To get rid of all source code in the generated output, make sure also 763# Note: To get rid of all source code in the generated output, make sure also
555# VERBATIM_HEADERS is set to NO.764# VERBATIM_HEADERS is set to NO.
556765
557SOURCE_BROWSER = YES766SOURCE_BROWSER = YES
558767
559# Setting the INLINE_SOURCES tag to YES will include the body 768# Setting the INLINE_SOURCES tag to YES will include the body
560# of functions and classes directly in the documentation.769# of functions and classes directly in the documentation.
561770
562INLINE_SOURCES = NO771INLINE_SOURCES = NO
563772
564# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 773# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
565# doxygen to hide any special comment blocks from generated source code 774# doxygen to hide any special comment blocks from generated source code
566# fragments. Normal C and C++ comments will always remain visible.775# fragments. Normal C and C++ comments will always remain visible.
567776
568STRIP_CODE_COMMENTS = NO777STRIP_CODE_COMMENTS = NO
569778
570# If the REFERENCED_BY_RELATION tag is set to YES (the default) 779# If the REFERENCED_BY_RELATION tag is set to YES
571# then for each documented function all documented 780# then for each documented function all documented
572# functions referencing it will be listed.781# functions referencing it will be listed.
573782
574REFERENCED_BY_RELATION = YES783REFERENCED_BY_RELATION = YES
575784
576# If the REFERENCES_RELATION tag is set to YES (the default) 785# If the REFERENCES_RELATION tag is set to YES
577# then for each documented function all documented entities 786# then for each documented function all documented entities
578# called/used by that function will be listed.787# called/used by that function will be listed.
579788
580REFERENCES_RELATION = YES789REFERENCES_RELATION = YES
581790
582# If the USE_HTAGS tag is set to YES then the references to source code 791# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
583# will point to the HTML generated by the htags(1) tool instead of doxygen 792# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
584# built-in source browser. The htags tool is part of GNU's global source 793# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
585# tagging system (see http://www.gnu.org/software/global/global.html). You 794# link to the source code.
795# Otherwise they will link to the documentation.
796
797REFERENCES_LINK_SOURCE = YES
798
799# If the USE_HTAGS tag is set to YES then the references to source code
800# will point to the HTML generated by the htags(1) tool instead of doxygen
801# built-in source browser. The htags tool is part of GNU's global source
802# tagging system (see http://www.gnu.org/software/global/global.html). You
586# will need version 4.8.6 or higher.803# will need version 4.8.6 or higher.
587804
588USE_HTAGS = NO805USE_HTAGS = NO
589806
590# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 807# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
591# will generate a verbatim copy of the header file for each class for 808# will generate a verbatim copy of the header file for each class for
592# which an include is specified. Set to NO to disable this.809# which an include is specified. Set to NO to disable this.
593810
594VERBATIM_HEADERS = YES811VERBATIM_HEADERS = YES
@@ -597,281 +814,548 @@
597# configuration options related to the alphabetical class index814# configuration options related to the alphabetical class index
598#---------------------------------------------------------------------------815#---------------------------------------------------------------------------
599816
600# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 817# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
601# of all compounds will be generated. Enable this if the project 818# of all compounds will be generated. Enable this if the project
602# contains a lot of classes, structs, unions or interfaces.819# contains a lot of classes, structs, unions or interfaces.
603820
604ALPHABETICAL_INDEX = YES821ALPHABETICAL_INDEX = YES
605822
606# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 823# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
607# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 824# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
608# in which this list will be split (can be a number in the range [1..20])825# in which this list will be split (can be a number in the range [1..20])
609826
610COLS_IN_ALPHA_INDEX = 2827COLS_IN_ALPHA_INDEX = 2
611828
612# In case all classes in a project start with a common prefix, all 829# In case all classes in a project start with a common prefix, all
613# classes will be put under the same header in the alphabetical index. 830# classes will be put under the same header in the alphabetical index.
614# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 831# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
615# should be ignored while generating the index headers.832# should be ignored while generating the index headers.
616833
617IGNORE_PREFIX = 834IGNORE_PREFIX =
618835
619#---------------------------------------------------------------------------836#---------------------------------------------------------------------------
620# configuration options related to the HTML output837# configuration options related to the HTML output
621#---------------------------------------------------------------------------838#---------------------------------------------------------------------------
622839
623# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 840# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
624# generate HTML output.841# generate HTML output.
625842
626GENERATE_HTML = YES843GENERATE_HTML = YES
627844
628# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 845# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
629# If a relative path is entered the value of OUTPUT_DIRECTORY will be 846# If a relative path is entered the value of OUTPUT_DIRECTORY will be
630# put in front of it. If left blank `html' will be used as the default path.847# put in front of it. If left blank `html' will be used as the default path.
631848
632HTML_OUTPUT = html849HTML_OUTPUT = html
633850
634# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 851# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
635# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 852# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
636# doxygen will generate files with .html extension.853# doxygen will generate files with .html extension.
637854
638HTML_FILE_EXTENSION = .html855HTML_FILE_EXTENSION = .html
639856
640# The HTML_HEADER tag can be used to specify a personal HTML header for 857# The HTML_HEADER tag can be used to specify a personal HTML header for
641# each generated HTML page. If it is left blank doxygen will generate a 858# each generated HTML page. If it is left blank doxygen will generate a
642# standard header.859# standard header. Note that when using a custom header you are responsible
860# for the proper inclusion of any scripts and style sheets that doxygen
861# needs, which is dependent on the configuration options used.
862# It is adviced to generate a default header using "doxygen -w html
863# header.html footer.html stylesheet.css YourConfigFile" and then modify
864# that header. Note that the header is subject to change so you typically
865# have to redo this when upgrading to a newer version of doxygen or when
866# changing the value of configuration settings such as GENERATE_TREEVIEW!
867
643HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/../style/header.html868HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/../style/header.html
644869
645870# The HTML_FOOTER tag can be used to specify a personal HTML footer for
646# The HTML_FOOTER tag can be used to specify a personal HTML footer for 871# each generated HTML page. If it is left blank doxygen will generate a
647# each generated HTML page. If it is left blank doxygen will generate a
648# standard footer.872# standard footer.
649873
650HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/../style/footer.html874HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/../style/footer.html
651875
652# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 876# If the HTML_TIMESTAMP tag is set to YES then the generated HTML documentation will contain the timesstamp.
653# style sheet that is used by each HTML page. It can be used to 877
654# fine-tune the look of the HTML output. If the tag is left blank doxygen 878HTML_TIMESTAMP = NO
655# will generate a default style sheet. Note that doxygen will try to copy 879
656# the style sheet file to the HTML output directory, so don't put your own 880# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
881# style sheet that is used by each HTML page. It can be used to
882# fine-tune the look of the HTML output. If the tag is left blank doxygen
883# will generate a default style sheet. Note that doxygen will try to copy
884# the style sheet file to the HTML output directory, so don't put your own
657# stylesheet in the HTML output directory as well, or it will be erased!885# stylesheet in the HTML output directory as well, or it will be erased!
658886
659HTML_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/../style/stylesheet.css887HTML_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/../style/stylesheet.css
660888
661# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 889# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
662# files or namespaces will be aligned in HTML using tables. If set to 890# other source files which should be copied to the HTML output directory. Note
891# that these files will be copied to the base HTML output directory. Use the
892# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
893# files. In the HTML_STYLESHEET file, use the file name only. Also note that
894# the files will be copied as-is; there are no commands or markers available.
895
896HTML_EXTRA_FILES =
897
898# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
899# Doxygen will adjust the colors in the stylesheet and background images
900# according to this color. Hue is specified as an angle on a colorwheel,
901# see http://en.wikipedia.org/wiki/Hue for more information.
902# For instance the value 0 represents red, 60 is yellow, 120 is green,
903# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
904# The allowed range is 0 to 359.
905
906HTML_COLORSTYLE_HUE = 220
907
908# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
909# the colors in the HTML output. For a value of 0 the output will use
910# grayscales only. A value of 255 will produce the most vivid colors.
911
912HTML_COLORSTYLE_SAT = 100
913
914# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
915# the luminance component of the colors in the HTML output. Values below
916# 100 gradually make the output lighter, whereas values above 100 make
917# the output darker. The value divided by 100 is the actual gamma applied,
918# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
919# and 100 does not change the gamma.
920
921HTML_COLORSTYLE_GAMMA = 80
922
923# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
924# page will contain the date and time when the page was generated. Setting
925# this to NO can help when comparing the output of multiple runs.
926
927HTML_TIMESTAMP = YES
928
929# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
930# files or namespaces will be aligned in HTML using tables. If set to
663# NO a bullet list will be used.931# NO a bullet list will be used.
664932
665HTML_ALIGN_MEMBERS = YES933HTML_ALIGN_MEMBERS = YES
666934
667# If the GENERATE_HTMLHELP tag is set to YES, additional index files 935# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
668# will be generated that can be used as input for tools like the 936# documentation will contain sections that can be hidden and shown after the
669# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 937# page has loaded. For this to work a browser that supports
938# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
939# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
940
941HTML_DYNAMIC_SECTIONS = NO
942
943# If the GENERATE_DOCSET tag is set to YES, additional index files
944# will be generated that can be used as input for Apple's Xcode 3
945# integrated development environment, introduced with OSX 10.5 (Leopard).
946# To create a documentation set, doxygen will generate a Makefile in the
947# HTML output directory. Running make will produce the docset in that
948# directory and running "make install" will install the docset in
949# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
950# it at startup.
951# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
952# for more information.
953
954GENERATE_DOCSET = NO
955
956# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
957# feed. A documentation feed provides an umbrella under which multiple
958# documentation sets from a single provider (such as a company or product suite)
959# can be grouped.
960
961DOCSET_FEEDNAME = "Doxygen generated docs"
962
963# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
964# should uniquely identify the documentation set bundle. This should be a
965# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
966# will append .docset to the name.
967
968DOCSET_BUNDLE_ID = org.doxygen.Project
969
970# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
971# the documentation publisher. This should be a reverse domain-name style
972# string, e.g. com.mycompany.MyDocSet.documentation.
973
974DOCSET_PUBLISHER_ID = org.doxygen.Publisher
975
976# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
977
978DOCSET_PUBLISHER_NAME = Publisher
979
980# If the GENERATE_HTMLHELP tag is set to YES, additional index files
981# will be generated that can be used as input for tools like the
982# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
670# of the generated HTML documentation.983# of the generated HTML documentation.
671984
672GENERATE_HTMLHELP = YES985GENERATE_HTMLHELP = YES
673986
674# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 987# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
675# be used to specify the file name of the resulting .chm file. You 988# be used to specify the file name of the resulting .chm file. You
676# can add a path in front of the file if the result should not be 989# can add a path in front of the file if the result should not be
677# written to the html output directory.990# written to the html output directory.
678991
679CHM_FILE = 992CHM_FILE =
680993
681# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 994# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
682# be used to specify the location (absolute path including file name) of 995# be used to specify the location (absolute path including file name) of
683# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 996# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
684# the HTML help compiler on the generated index.hhp.997# the HTML help compiler on the generated index.hhp.
685998
686HHC_LOCATION = 999HHC_LOCATION =
6871000
688# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1001# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
689# controls if a separate .chi index file is generated (YES) or that 1002# controls if a separate .chi index file is generated (YES) or that
690# it should be included in the master .chm file (NO).1003# it should be included in the master .chm file (NO).
6911004
692GENERATE_CHI = NO1005GENERATE_CHI = NO
6931006
694# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1007# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
695# controls whether a binary table of contents is generated (YES) or a 1008# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1009# content.
1010
1011CHM_INDEX_ENCODING =
1012
1013# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1014# controls whether a binary table of contents is generated (YES) or a
696# normal table of contents (NO) in the .chm file.1015# normal table of contents (NO) in the .chm file.
6971016
698BINARY_TOC = NO1017BINARY_TOC = NO
6991018
700# The TOC_EXPAND flag can be set to YES to add extra items for group members 1019# The TOC_EXPAND flag can be set to YES to add extra items for group members
701# to the contents of the HTML help documentation and to the tree view.1020# to the contents of the HTML help documentation and to the tree view.
7021021
703TOC_EXPAND = NO1022TOC_EXPAND = NO
7041023
705# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 1024# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
706# top of each HTML page. The value NO (the default) enables the index and 1025# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1026# that can be used as input for Qt's qhelpgenerator to generate a
1027# Qt Compressed Help (.qch) of the generated HTML documentation.
1028
1029GENERATE_QHP = NO
1030
1031# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1032# be used to specify the file name of the resulting .qch file.
1033# The path specified is relative to the HTML output folder.
1034
1035QCH_FILE =
1036
1037# The QHP_NAMESPACE tag specifies the namespace to use when generating
1038# Qt Help Project output. For more information please see
1039# http://doc.trolltech.com/qthelpproject.html#namespace
1040
1041QHP_NAMESPACE = org.doxygen.Project
1042
1043# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1044# Qt Help Project output. For more information please see
1045# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1046
1047QHP_VIRTUAL_FOLDER = doc
1048
1049# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1050# add. For more information please see
1051# http://doc.trolltech.com/qthelpproject.html#custom-filters
1052
1053QHP_CUST_FILTER_NAME =
1054
1055# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1056# custom filter to add. For more information please see
1057# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1058# Qt Help Project / Custom Filters</a>.
1059
1060QHP_CUST_FILTER_ATTRS =
1061
1062# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1063# project's
1064# filter section matches.
1065# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1066# Qt Help Project / Filter Attributes</a>.
1067
1068QHP_SECT_FILTER_ATTRS =
1069
1070# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1071# be used to specify the location of Qt's qhelpgenerator.
1072# If non-empty doxygen will try to run qhelpgenerator on the generated
1073# .qhp file.
1074
1075QHG_LOCATION =
1076
1077# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1078# will be generated, which together with the HTML files, form an Eclipse help
1079# plugin. To install this plugin and make it available under the help contents
1080# menu in Eclipse, the contents of the directory containing the HTML and XML
1081# files needs to be copied into the plugins directory of eclipse. The name of
1082# the directory within the plugins directory should be the same as
1083# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1084# the help appears.
1085
1086GENERATE_ECLIPSEHELP = NO
1087
1088# A unique identifier for the eclipse help plugin. When installing the plugin
1089# the directory name containing the HTML and XML files should also have
1090# this name.
1091
1092ECLIPSE_DOC_ID = org.doxygen.Project
1093
1094# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1095# top of each HTML page. The value NO (the default) enables the index and
707# the value YES disables it.1096# the value YES disables it.
7081097
709DISABLE_INDEX = NO1098DISABLE_INDEX = NO
7101099
711# This tag can be used to set the number of enum values (range [1..20]) 1100# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
712# that doxygen will group on one line in the generated HTML documentation.1101# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1102# documentation. Note that a value of 0 will completely suppress the enum
1103# values from appearing in the overview section.
7131104
714ENUM_VALUES_PER_LINE = 41105ENUM_VALUES_PER_LINE = 4
7151106
716# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be1107# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
717# generated containing a tree-like index structure (just like the one that 1108# structure should be generated to display hierarchical information.
718# is generated for HTML Help). For this to work a browser that supports 1109# If the tag value is set to YES, a side panel will be generated
719# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 1110# containing a tree-like index structure (just like the one that
720# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 1111# is generated for HTML Help). For this to work a browser that supports
721# probably better off using the HTML help feature.1112# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1113# Windows users are probably better off using the HTML help feature.
7221114
723GENERATE_TREEVIEW = NO1115GENERATE_TREEVIEW = NO
7241116
725# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1117# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
726# used to set the initial width (in pixels) of the frame in which the tree 1118# and Class Hierarchy pages using a tree view instead of an ordered list.
1119
1120USE_INLINE_TREES = NO
1121
1122# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1123# used to set the initial width (in pixels) of the frame in which the tree
727# is shown.1124# is shown.
7281125
729TREEVIEW_WIDTH = 2501126TREEVIEW_WIDTH = 250
7301127
1128# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1129# links to external symbols imported via tag files in a separate window.
1130
1131EXT_LINKS_IN_WINDOW = NO
1132
1133# Use this tag to change the font size of Latex formulas included
1134# as images in the HTML documentation. The default is 10. Note that
1135# when you change the font size after a successful doxygen run you need
1136# to manually remove any form_*.png images from the HTML output directory
1137# to force them to be regenerated.
1138
1139FORMULA_FONTSIZE = 10
1140
1141# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1142# generated for formulas are transparent PNGs. Transparent PNGs are
1143# not supported properly for IE 6.0, but are supported on all modern browsers.
1144# Note that when changing this option you need to delete any form_*.png files
1145# in the HTML output before the changes have effect.
1146
1147FORMULA_TRANSPARENT = YES
1148
1149# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1150# (see http://www.mathjax.org) which uses client side Javascript for the
1151# rendering instead of using prerendered bitmaps. Use this if you do not
1152# have LaTeX installed or if you want to formulas look prettier in the HTML
1153# output. When enabled you also need to install MathJax separately and
1154# configure the path to it using the MATHJAX_RELPATH option.
1155
1156USE_MATHJAX = NO
1157
1158# When MathJax is enabled you need to specify the location relative to the
1159# HTML output directory using the MATHJAX_RELPATH option. The destination
1160# directory should contain the MathJax.js script. For instance, if the mathjax
1161# directory is located at the same level as the HTML output directory, then
1162# MATHJAX_RELPATH should be ../mathjax. The default value points to the
1163# mathjax.org site, so you can quickly see the result without installing
1164# MathJax, but it is strongly recommended to install a local copy of MathJax
1165# before deployment.
1166
1167MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1168
1169# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1170# names that should be enabled during MathJax rendering.
1171
1172MATHJAX_EXTENSIONS =
1173
1174# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1175# for the HTML output. The underlying search engine uses javascript
1176# and DHTML and should work on any modern browser. Note that when using
1177# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1178# (GENERATE_DOCSET) there is already a search function so this one should
1179# typically be disabled. For large projects the javascript based search engine
1180# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1181
1182SEARCHENGINE = NO
1183
1184# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1185# implemented using a PHP enabled web server instead of at the web client
1186# using Javascript. Doxygen will generate the search PHP script and index
1187# file to put on the web server. The advantage of the server
1188# based approach is that it scales better to large projects and allows
1189# full text search. The disadvantages are that it is more difficult to setup
1190# and does not have live searching capabilities.
1191
1192SERVER_BASED_SEARCH = NO
1193
731#---------------------------------------------------------------------------1194#---------------------------------------------------------------------------
732# configuration options related to the LaTeX output1195# configuration options related to the LaTeX output
733#---------------------------------------------------------------------------1196#---------------------------------------------------------------------------
7341197
735# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1198# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
736# generate Latex output.1199# generate Latex output.
7371200
738GENERATE_LATEX = NO1201GENERATE_LATEX = NO
7391202
740# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1203# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
741# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1204# If a relative path is entered the value of OUTPUT_DIRECTORY will be
742# put in front of it. If left blank `latex' will be used as the default path.1205# put in front of it. If left blank `latex' will be used as the default path.
7431206
744LATEX_OUTPUT = latex1207LATEX_OUTPUT = latex
7451208
746# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1209# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
747# invoked. If left blank `latex' will be used as the default command name.1210# invoked. If left blank `latex' will be used as the default command name.
7481211# Note that when enabling USE_PDFLATEX this option is only used for
749#LATEX_CMD_NAME = latex1212# generating bitmaps for formulas in the HTML output, but not in the
750LATEX_CMD_NAME = @LATEX_COMPILER@1213# Makefile that is written to the output directory.
7511214
752# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1215LATEX_CMD_NAME = @LATEX_COMPILER@
753# generate index for LaTeX. If left blank `makeindex' will be used as the 1216
1217# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1218# generate index for LaTeX. If left blank `makeindex' will be used as the
754# default command name.1219# default command name.
7551220
756#MAKEINDEX_CMD_NAME = makeindex
757MAKEINDEX_CMD_NAME = @MAKEINDEX_COMPILER@1221MAKEINDEX_CMD_NAME = @MAKEINDEX_COMPILER@
7581222
759# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1223# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
760# LaTeX documents. This may be useful for small projects and may help to 1224# LaTeX documents. This may be useful for small projects and may help to
761# save some trees in general.1225# save some trees in general.
7621226
763COMPACT_LATEX = NO1227COMPACT_LATEX = NO
7641228
765# The PAPER_TYPE tag can be used to set the paper type that is used 1229# The PAPER_TYPE tag can be used to set the paper type that is used
766# by the printer. Possible values are: a4, a4wide, letter, legal and 1230# by the printer. Possible values are: a4, letter, legal and
767# executive. If left blank a4wide will be used.1231# executive. If left blank a4wide will be used.
7681232
769PAPER_TYPE = a41233PAPER_TYPE = a4
7701234
771# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1235# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
772# packages that should be included in the LaTeX output.1236# packages that should be included in the LaTeX output.
7731237
774EXTRA_PACKAGES = 1238EXTRA_PACKAGES =
7751239
776# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1240# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
777# the generated latex document. The header should contain everything until 1241# the generated latex document. The header should contain everything until
778# the first chapter. If it is left blank doxygen will generate a 1242# the first chapter. If it is left blank doxygen will generate a
779# standard header. Notice: only use this tag if you know what you are doing!1243# standard header. Notice: only use this tag if you know what you are doing!
7801244
781LATEX_HEADER = 1245LATEX_HEADER =
7821246
783# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1247# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
784# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1248# the generated latex document. The footer should contain everything after
785# contain links (just like the HTML output) instead of page references 1249# the last chapter. If it is left blank doxygen will generate a
1250# standard footer. Notice: only use this tag if you know what you are doing!
1251
1252LATEX_FOOTER =
1253
1254# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1255# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1256# contain links (just like the HTML output) instead of page references
786# This makes the output suitable for online browsing using a pdf viewer.1257# This makes the output suitable for online browsing using a pdf viewer.
7871258
788PDF_HYPERLINKS = YES1259PDF_HYPERLINKS = YES
7891260
790# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1261# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
791# plain latex in the generated Makefile. Set this option to YES to get a 1262# plain latex in the generated Makefile. Set this option to YES to get a
792# higher quality PDF documentation.1263# higher quality PDF documentation.
7931264
794USE_PDFLATEX = YES1265USE_PDFLATEX = YES
7951266
796# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1267# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
797# command to the generated LaTeX files. This will instruct LaTeX to keep 1268# command to the generated LaTeX files. This will instruct LaTeX to keep
798# running if errors occur, instead of asking the user for help. 1269# running if errors occur, instead of asking the user for help.
799# This option is also used when generating formulas in HTML.1270# This option is also used when generating formulas in HTML.
8001271
801LATEX_BATCHMODE = YES1272LATEX_BATCHMODE = YES
8021273
803# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1274# If LATEX_HIDE_INDICES is set to YES then doxygen will not
804# include the index chapters (such as File Index, Compound Index, etc.) 1275# include the index chapters (such as File Index, Compound Index, etc.)
805# in the output.1276# in the output.
8061277
807LATEX_HIDE_INDICES = NO1278LATEX_HIDE_INDICES = NO
8081279
1280# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1281# source code with syntax highlighting in the LaTeX output.
1282# Note that which sources are shown also depends on other settings
1283# such as SOURCE_BROWSER.
1284
1285LATEX_SOURCE_CODE = NO
1286
1287# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1288# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1289# http://en.wikipedia.org/wiki/BibTeX for more info.
1290
1291LATEX_BIB_STYLE = plain
1292
809#---------------------------------------------------------------------------1293#---------------------------------------------------------------------------
810# configuration options related to the RTF output1294# configuration options related to the RTF output
811#---------------------------------------------------------------------------1295#---------------------------------------------------------------------------
8121296
813# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1297# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
814# The RTF output is optimized for Word 97 and may not look very pretty with 1298# The RTF output is optimized for Word 97 and may not look very pretty with
815# other RTF readers or editors.1299# other RTF readers or editors.
8161300
817GENERATE_RTF = NO1301GENERATE_RTF = NO
8181302
819# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1303# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
820# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1304# If a relative path is entered the value of OUTPUT_DIRECTORY will be
821# put in front of it. If left blank `rtf' will be used as the default path.1305# put in front of it. If left blank `rtf' will be used as the default path.
8221306
823RTF_OUTPUT = rtf1307RTF_OUTPUT = rtf
8241308
825# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1309# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
826# RTF documents. This may be useful for small projects and may help to 1310# RTF documents. This may be useful for small projects and may help to
827# save some trees in general.1311# save some trees in general.
8281312
829COMPACT_RTF = NO1313COMPACT_RTF = NO
8301314
831# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1315# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
832# will contain hyperlink fields. The RTF file will 1316# will contain hyperlink fields. The RTF file will
833# contain links (just like the HTML output) instead of page references. 1317# contain links (just like the HTML output) instead of page references.
834# This makes the output suitable for online browsing using WORD or other 1318# This makes the output suitable for online browsing using WORD or other
835# programs which support those fields. 1319# programs which support those fields.
836# Note: wordpad (write) and others do not support links.1320# Note: wordpad (write) and others do not support links.
8371321
838RTF_HYPERLINKS = NO1322RTF_HYPERLINKS = NO
8391323
840# Load stylesheet definitions from file. Syntax is similar to doxygen's 1324# Load stylesheet definitions from file. Syntax is similar to doxygen's
841# config file, i.e. a series of assignments. You only have to provide 1325# config file, i.e. a series of assignments. You only have to provide
842# replacements, missing definitions are set to their default value.1326# replacements, missing definitions are set to their default value.
8431327
844RTF_STYLESHEET_FILE = 1328RTF_STYLESHEET_FILE =
8451329
846# Set optional variables used in the generation of an rtf document. 1330# Set optional variables used in the generation of an rtf document.
847# Syntax is similar to doxygen's config file.1331# Syntax is similar to doxygen's config file.
8481332
849RTF_EXTENSIONS_FILE = 1333RTF_EXTENSIONS_FILE =
8501334
851#---------------------------------------------------------------------------1335#---------------------------------------------------------------------------
852# configuration options related to the man page output1336# configuration options related to the man page output
853#---------------------------------------------------------------------------1337#---------------------------------------------------------------------------
8541338
855# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1339# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
856# generate man pages1340# generate man pages
8571341
858GENERATE_MAN = NO1342GENERATE_MAN = NO
8591343
860# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1344# The MAN_OUTPUT tag is used to specify where the man pages will be put.
861# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1345# If a relative path is entered the value of OUTPUT_DIRECTORY will be
862# put in front of it. If left blank `man' will be used as the default path.1346# put in front of it. If left blank `man' will be used as the default path.
8631347
864MAN_OUTPUT = man1348MAN_OUTPUT = man
8651349
866# The MAN_EXTENSION tag determines the extension that is added to 1350# The MAN_EXTENSION tag determines the extension that is added to
867# the generated man pages (default is the subroutine's section .3)1351# the generated man pages (default is the subroutine's section .3)
8681352
869MAN_EXTENSION = .31353MAN_EXTENSION = .3
8701354
871# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1355# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
872# then it will generate one additional man file for each entity 1356# then it will generate one additional man file for each entity
873# documented in the real man page(s). These additional files 1357# documented in the real man page(s). These additional files
874# only source the real man page, but without them the man command 1358# only source the real man page, but without them the man command
875# would be unable to find the correct page. The default is NO.1359# would be unable to find the correct page. The default is NO.
8761360
877MAN_LINKS = NO1361MAN_LINKS = NO
@@ -880,33 +1364,33 @@
880# configuration options related to the XML output1364# configuration options related to the XML output
881#---------------------------------------------------------------------------1365#---------------------------------------------------------------------------
8821366
883# If the GENERATE_XML tag is set to YES Doxygen will 1367# If the GENERATE_XML tag is set to YES Doxygen will
884# generate an XML file that captures the structure of 1368# generate an XML file that captures the structure of
885# the code including all documentation.1369# the code including all documentation.
8861370
887GENERATE_XML = NO1371GENERATE_XML = NO
8881372
889# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1373# The XML_OUTPUT tag is used to specify where the XML pages will be put.
890# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1374# If a relative path is entered the value of OUTPUT_DIRECTORY will be
891# put in front of it. If left blank `xml' will be used as the default path.1375# put in front of it. If left blank `xml' will be used as the default path.
8921376
893XML_OUTPUT = xml1377XML_OUTPUT = xml
8941378
895# The XML_SCHEMA tag can be used to specify an XML schema, 1379# The XML_SCHEMA tag can be used to specify an XML schema,
896# which can be used by a validating XML parser to check the 1380# which can be used by a validating XML parser to check the
897# syntax of the XML files.1381# syntax of the XML files.
8981382
899XML_SCHEMA = 1383XML_SCHEMA =
9001384
901# The XML_DTD tag can be used to specify an XML DTD, 1385# The XML_DTD tag can be used to specify an XML DTD,
902# which can be used by a validating XML parser to check the 1386# which can be used by a validating XML parser to check the
903# syntax of the XML files.1387# syntax of the XML files.
9041388
905XML_DTD = 1389XML_DTD =
9061390
907# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1391# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
908# dump the program listings (including syntax highlighting 1392# dump the program listings (including syntax highlighting
909# and cross-referencing information) to the XML output. Note that 1393# and cross-referencing information) to the XML output. Note that
910# enabling this will significantly increase the size of the XML output.1394# enabling this will significantly increase the size of the XML output.
9111395
912XML_PROGRAMLISTING = YES1396XML_PROGRAMLISTING = YES
@@ -915,10 +1399,10 @@
915# configuration options for the AutoGen Definitions output1399# configuration options for the AutoGen Definitions output
916#---------------------------------------------------------------------------1400#---------------------------------------------------------------------------
9171401
918# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1402# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
919# generate an AutoGen Definitions (see autogen.sf.net) file 1403# generate an AutoGen Definitions (see autogen.sf.net) file
920# that captures the structure of the code including all 1404# that captures the structure of the code including all
921# documentation. Note that this feature is still experimental 1405# documentation. Note that this feature is still experimental
922# and incomplete at the moment.1406# and incomplete at the moment.
9231407
924GENERATE_AUTOGEN_DEF = NO1408GENERATE_AUTOGEN_DEF = NO
@@ -927,286 +1411,359 @@
927# configuration options related to the Perl module output1411# configuration options related to the Perl module output
928#---------------------------------------------------------------------------1412#---------------------------------------------------------------------------
9291413
930# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1414# If the GENERATE_PERLMOD tag is set to YES Doxygen will
931# generate a Perl module file that captures the structure of 1415# generate a Perl module file that captures the structure of
932# the code including all documentation. Note that this 1416# the code including all documentation. Note that this
933# feature is still experimental and incomplete at the 1417# feature is still experimental and incomplete at the
934# moment.1418# moment.
9351419
936GENERATE_PERLMOD = NO1420GENERATE_PERLMOD = NO
9371421
938# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1422# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
939# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1423# the necessary Makefile rules, Perl scripts and LaTeX code to be able
940# to generate PDF and DVI output from the Perl module output.1424# to generate PDF and DVI output from the Perl module output.
9411425
942PERLMOD_LATEX = NO1426PERLMOD_LATEX = NO
9431427
944# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1428# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
945# nicely formatted so it can be parsed by a human reader. This is useful 1429# nicely formatted so it can be parsed by a human reader.
946# if you want to understand what is going on. On the other hand, if this 1430# This is useful
947# tag is set to NO the size of the Perl module output will be much smaller 1431# if you want to understand what is going on.
1432# On the other hand, if this
1433# tag is set to NO the size of the Perl module output will be much smaller
948# and Perl will parse it just the same.1434# and Perl will parse it just the same.
9491435
950PERLMOD_PRETTY = YES1436PERLMOD_PRETTY = YES
9511437
952# The names of the make variables in the generated doxyrules.make file 1438# The names of the make variables in the generated doxyrules.make file
953# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1439# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
954# This is useful so different doxyrules.make files included by the same 1440# This is useful so different doxyrules.make files included by the same
955# Makefile don't overwrite each other's variables.1441# Makefile don't overwrite each other's variables.
9561442
957PERLMOD_MAKEVAR_PREFIX = 1443PERLMOD_MAKEVAR_PREFIX =
9581444
959#---------------------------------------------------------------------------1445#---------------------------------------------------------------------------
960# Configuration options related to the preprocessor 1446# Configuration options related to the preprocessor
961#---------------------------------------------------------------------------1447#---------------------------------------------------------------------------
9621448
963# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1449# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
964# evaluate all C-preprocessor directives found in the sources and include 1450# evaluate all C-preprocessor directives found in the sources and include
965# files.1451# files.
9661452
967ENABLE_PREPROCESSING = YES1453ENABLE_PREPROCESSING = YES
9681454
969# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1455# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
970# names in the source code. If set to NO (the default) only conditional 1456# names in the source code. If set to NO (the default) only conditional
971# compilation will be performed. Macro expansion can be done in a controlled 1457# compilation will be performed. Macro expansion can be done in a controlled
972# way by setting EXPAND_ONLY_PREDEF to YES.1458# way by setting EXPAND_ONLY_PREDEF to YES.
9731459
974MACRO_EXPANSION = YES1460MACRO_EXPANSION = YES
9751461
976# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1462# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
977# then the macro expansion is limited to the macros specified with the 1463# then the macro expansion is limited to the macros specified with the
978# PREDEFINED and EXPAND_AS_DEFINED tags.1464# PREDEFINED and EXPAND_AS_DEFINED tags.
9791465
980EXPAND_ONLY_PREDEF = YES1466EXPAND_ONLY_PREDEF = YES
9811467
982# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1468# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
983# in the INCLUDE_PATH (see below) will be search if a #include is found.1469# pointed to by INCLUDE_PATH will be searched when a #include is found.
9841470
985SEARCH_INCLUDES = YES1471SEARCH_INCLUDES = YES
9861472
987# The INCLUDE_PATH tag can be used to specify one or more directories that 1473# The INCLUDE_PATH tag can be used to specify one or more directories that
988# contain include files that are not input files but should be processed by 1474# contain include files that are not input files but should be processed by
989# the preprocessor.1475# the preprocessor.
9901476
991INCLUDE_PATH = 1477INCLUDE_PATH =
9921478
993# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1479# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
994# patterns (like *.h and *.hpp) to filter out the header-files in the 1480# patterns (like *.h and *.hpp) to filter out the header-files in the
995# directories. If left blank, the patterns specified with FILE_PATTERNS will 1481# directories. If left blank, the patterns specified with FILE_PATTERNS will
996# be used.1482# be used.
9971483
998INCLUDE_FILE_PATTERNS = 1484INCLUDE_FILE_PATTERNS =
9991485
1000# The PREDEFINED tag can be used to specify one or more macro names that 1486# The PREDEFINED tag can be used to specify one or more macro names that
1001# are defined before the preprocessor is started (similar to the -D option of 1487# are defined before the preprocessor is started (similar to the -D option of
1002# gcc). The argument of the tag is a list of macros of the form: name 1488# gcc). The argument of the tag is a list of macros of the form: name
1003# or name=definition (no spaces). If the definition and the = are 1489# or name=definition (no spaces). If the definition and the = are
1004# omitted =1 is assumed. To prevent a macro definition from being 1490# omitted =1 is assumed. To prevent a macro definition from being
1005# undefined via #undef or recursively expanded use the := operator 1491# undefined via #undef or recursively expanded use the := operator
1006# instead of the = operator.1492# instead of the = operator.
10071493
1008PREDEFINED = 1494PREDEFINED =
10091495
1010# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1496# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1011# this tag can be used to specify a list of macro names that should be expanded. 1497# this tag can be used to specify a list of macro names that should be expanded.
1012# The macro definition that is found in the sources will be used. 1498# The macro definition that is found in the sources will be used.
1013# Use the PREDEFINED tag if you want to use a different macro definition.1499# Use the PREDEFINED tag if you want to use a different macro definition that
10141500# overrules the definition found in the source code.
1015EXPAND_AS_DEFINED = 1501
10161502EXPAND_AS_DEFINED =
1017# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1503
1018# doxygen's preprocessor will remove all function-like macros that are alone 1504# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1019# on a line, have an all uppercase name, and do not end with a semicolon. Such 1505# doxygen's preprocessor will remove all references to function-like macros
1020# function macros are typically used for boiler-plate code, and will confuse 1506# that are alone on a line, have an all uppercase name, and do not end with a
1021# the parser if not removed.1507# semicolon, because these will confuse the parser if not removed.
10221508
1023SKIP_FUNCTION_MACROS = YES1509SKIP_FUNCTION_MACROS = YES
10241510
1025#---------------------------------------------------------------------------1511#---------------------------------------------------------------------------
1026# Configuration::additions related to external references 1512# Configuration::additions related to external references
1027#---------------------------------------------------------------------------1513#---------------------------------------------------------------------------
10281514
1029# The TAGFILES option can be used to specify one or more tagfiles. 1515# The TAGFILES option can be used to specify one or more tagfiles.
1030# Optionally an initial location of the external documentation 1516# Optionally an initial location of the external documentation
1031# can be added for each tagfile. The format of a tag file without 1517# can be added for each tagfile. The format of a tag file without
1032# this location is as follows: 1518# this location is as follows:
1033# TAGFILES = file1 file2 ... 1519#
1034# Adding location for the tag files is done as follows: 1520# TAGFILES = file1 file2 ...
1035# TAGFILES = file1=loc1 "file2 = loc2" ... 1521# Adding location for the tag files is done as follows:
1036# where "loc1" and "loc2" can be relative or absolute paths or 1522#
1037# URLs. If a location is present for each tag, the installdox tool 1523# TAGFILES = file1=loc1 "file2 = loc2" ...
1524# where "loc1" and "loc2" can be relative or absolute paths or
1525# URLs. If a location is present for each tag, the installdox tool
1038# does not have to be run to correct the links.1526# does not have to be run to correct the links.
1039# Note that each tag file must have a unique name1527# Note that each tag file must have a unique name
1040# (where the name does NOT include the path)1528# (where the name does NOT include the path)
1041# If a tag file is not located in the directory in which doxygen 1529# If a tag file is not located in the directory in which doxygen
1042# is run, you must also specify the path to the tagfile here.1530# is run, you must also specify the path to the tagfile here.
10431531
1044TAGFILES = 1532TAGFILES =
10451533
1046# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1534# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1047# a tag file that is based on the input files it reads.1535# a tag file that is based on the input files it reads.
10481536
1049GENERATE_TAGFILE = html/@PROJECT_NAME@.TAGFILE1537GENERATE_TAGFILE = html/@PROJECT_NAME@.TAGFILE
10501538
1051# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1539# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1052# in the class index. If set to NO only the inherited external classes 1540# in the class index. If set to NO only the inherited external classes
1053# will be listed.1541# will be listed.
10541542
1055ALLEXTERNALS = YES1543ALLEXTERNALS = YES
10561544
1057# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1545# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1058# in the modules index. If set to NO, only the current project's groups will 1546# in the modules index. If set to NO, only the current project's groups will
1059# be listed.1547# be listed.
10601548
1061EXTERNAL_GROUPS = YES1549EXTERNAL_GROUPS = YES
10621550
1063# The PERL_PATH should be the absolute path and name of the perl script 1551# The PERL_PATH should be the absolute path and name of the perl script
1064# interpreter (i.e. the result of `which perl').1552# interpreter (i.e. the result of `which perl').
10651553
1066PERL_PATH = /usr/bin/perl1554PERL_PATH = /usr/bin/perl
10671555
1068#---------------------------------------------------------------------------1556#---------------------------------------------------------------------------
1069# Configuration options related to the dot tool 1557# Configuration options related to the dot tool
1070#---------------------------------------------------------------------------1558#---------------------------------------------------------------------------
10711559
1072# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1560# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1073# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1561# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1074# or super classes. Setting the tag to NO turns the diagrams off. Note that 1562# or super classes. Setting the tag to NO turns the diagrams off. Note that
1075# this option is superseded by the HAVE_DOT option below. This is only a 1563# this option also works with HAVE_DOT disabled, but it is recommended to
1076# fallback. It is recommended to install and use dot, since it yields more 1564# install and use dot, since it yields more powerful graphs.
1077# powerful graphs.
10781565
1079CLASS_DIAGRAMS = YES1566CLASS_DIAGRAMS = YES
10801567
1081# If set to YES, the inheritance and collaboration graphs will hide 1568# You can define message sequence charts within doxygen comments using the \msc
1082# inheritance and usage relations if the target is undocumented 1569# command. Doxygen will then run the mscgen tool (see
1570# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1571# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1572# the mscgen tool resides. If left empty the tool is assumed to be found in the
1573# default search path.
1574
1575MSCGEN_PATH =
1576
1577# If set to YES, the inheritance and collaboration graphs will hide
1578# inheritance and usage relations if the target is undocumented
1083# or is not a class.1579# or is not a class.
10841580
1085HIDE_UNDOC_RELATIONS = YES1581HIDE_UNDOC_RELATIONS = YES
10861582
1087# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1583# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1088# available from the path. This tool is part of Graphviz, a graph visualization 1584# available from the path. This tool is part of Graphviz, a graph visualization
1089# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1585# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1090# have no effect if this option is set to NO (the default)1586# have no effect if this option is set to NO (the default)
10911587
1092HAVE_DOT = @DOXYGEN_DOT_FOUND@1588HAVE_DOT = @DOXYGEN_DOT_FOUND@
10931589
1094# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1590# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1095# will generate a graph for each documented class showing the direct and 1591# allowed to run in parallel. When set to 0 (the default) doxygen will
1096# indirect inheritance relations. Setting this tag to YES will force the 1592# base this on the number of processors available in the system. You can set it
1593# explicitly to a value larger than 0 to get control over the balance
1594# between CPU load and processing speed.
1595
1596DOT_NUM_THREADS = 0
1597
1598# By default doxygen will use the Helvetica font for all dot files that
1599# doxygen generates. When you want a differently looking font you can specify
1600# the font name using DOT_FONTNAME. You need to make sure dot is able to find
1601# the font, which can be done by putting it in a standard location or by setting
1602# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1603# directory containing the font.
1604
1605DOT_FONTNAME = Helvetica
1606
1607# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1608# The default size is 10pt.
1609
1610DOT_FONTSIZE = 10
1611
1612# By default doxygen will tell dot to use the Helvetica font.
1613# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1614# set the path where dot can find it.
1615
1616DOT_FONTPATH =
1617
1618# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1619# will generate a graph for each documented class showing the direct and
1620# indirect inheritance relations. Setting this tag to YES will force the
1097# the CLASS_DIAGRAMS tag to NO.1621# the CLASS_DIAGRAMS tag to NO.
10981622
1099CLASS_GRAPH = YES1623CLASS_GRAPH = YES
11001624
1101# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1625# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1102# will generate a graph for each documented class showing the direct and 1626# will generate a graph for each documented class showing the direct and
1103# indirect implementation dependencies (inheritance, containment, and 1627# indirect implementation dependencies (inheritance, containment, and
1104# class references variables) of the class with other documented classes.1628# class references variables) of the class with other documented classes.
11051629
1106COLLABORATION_GRAPH = YES1630COLLABORATION_GRAPH = YES
11071631
1108# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1632# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1109# will generate a graph for groups, showing the direct groups dependencies1633# will generate a graph for groups, showing the direct groups dependencies
11101634
1111GROUP_GRAPHS = YES1635GROUP_GRAPHS = YES
11121636
1113# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1637# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1114# collaboration diagrams in a style similar to the OMG's Unified Modeling 1638# collaboration diagrams in a style similar to the OMG's Unified Modeling
1115# Language.1639# Language.
11161640
1117UML_LOOK = NO1641UML_LOOK = NO
1118# UML_LOOK = YES
11191642
1120# If set to YES, the inheritance and collaboration graphs will show the 1643# If set to YES, the inheritance and collaboration graphs will show the
1121# relations between templates and their instances.1644# relations between templates and their instances.
11221645
1123TEMPLATE_RELATIONS = YES1646TEMPLATE_RELATIONS = YES
11241647
1125# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1648# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1126# tags are set to YES then doxygen will generate a graph for each documented 1649# tags are set to YES then doxygen will generate a graph for each documented
1127# file showing the direct and indirect include dependencies of the file with 1650# file showing the direct and indirect include dependencies of the file with
1128# other documented files.1651# other documented files.
11291652
1130INCLUDE_GRAPH = YES1653INCLUDE_GRAPH = YES
11311654
1132# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1655# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1133# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1656# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1134# documented header file showing the documented files that directly or 1657# documented header file showing the documented files that directly or
1135# indirectly include this file.1658# indirectly include this file.
11361659
1137INCLUDED_BY_GRAPH = YES1660INCLUDED_BY_GRAPH = YES
11381661
1139# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1662# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1140# generate a call dependency graph for every global function or class method. 1663# doxygen will generate a call dependency graph for every global function
1141# Note that enabling this option will significantly increase the time of a run. 1664# or class method. Note that enabling this option will significantly increase
1142# So in most cases it will be better to enable call graphs for selected 1665# the time of a run. So in most cases it will be better to enable call graphs
1143# functions only using the \callgraph command.1666# for selected functions only using the \callgraph command.
11441667
1145CALL_GRAPH = NO1668CALL_GRAPH = NO
11461669
1147# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1670# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1148# will graphical hierarchy of all classes instead of a textual one.1671# doxygen will generate a caller dependency graph for every global function
1672# or class method. Note that enabling this option will significantly increase
1673# the time of a run. So in most cases it will be better to enable caller
1674# graphs for selected functions only using the \callergraph command.
1675
1676CALLER_GRAPH = NO
1677
1678# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1679# will generate a graphical hierarchy of all classes instead of a textual one.
11491680
1150GRAPHICAL_HIERARCHY = YES1681GRAPHICAL_HIERARCHY = YES
11511682
1152# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1683# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1153# then doxygen will show the dependencies a directory has on other directories 1684# then doxygen will show the dependencies a directory has on other directories
1154# in a graphical way. The dependency relations are determined by the #include1685# in a graphical way. The dependency relations are determined by the #include
1155# relations between the files in the directories.1686# relations between the files in the directories.
11561687
1157DIRECTORY_GRAPH = YES1688DIRECTORY_GRAPH = YES
11581689
1159# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1690# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1160# generated by dot. Possible values are png, jpg, or gif1691# generated by dot. Possible values are svg, png, jpg, or gif.
1161# If left blank png will be used.1692# If left blank png will be used. If you choose svg you need to set
1693# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1694# visible in IE 9+ (other browsers do not have this requirement).
11621695
1163DOT_IMAGE_FORMAT = png1696DOT_IMAGE_FORMAT = png
11641697
1165# The tag DOT_PATH can be used to specify the path where the dot tool can be 1698# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1699# enable generation of interactive SVG images that allow zooming and panning.
1700# Note that this requires a modern browser other than Internet Explorer.
1701# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1702# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1703# visible. Older versions of IE do not have SVG support.
1704
1705INTERACTIVE_SVG = NO
1706
1707# The tag DOT_PATH can be used to specify the path where the dot tool can be
1166# found. If left blank, it is assumed the dot tool can be found in the path.1708# found. If left blank, it is assumed the dot tool can be found in the path.
11671709
1168DOT_PATH = @DOXYGEN_DOT_EXECUTABLE_PATH@1710DOT_PATH = @DOXYGEN_DOT_EXECUTABLE_PATH@
11691711
1170# The DOTFILE_DIRS tag can be used to specify one or more directories that 1712# The DOTFILE_DIRS tag can be used to specify one or more directories that
1171# contain dot files that are included in the documentation (see the 1713# contain dot files that are included in the documentation (see the
1172# \dotfile command).1714# \dotfile command).
11731715
1174DOTFILE_DIRS = 1716DOTFILE_DIRS =
11751717
1176# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1718# The MSCFILE_DIRS tag can be used to specify one or more directories that
1177# background. This is disabled by default, which results in a white background. 1719# contain msc files that are included in the documentation (see the
1178# Warning: Depending on the platform used, enabling this option may lead to 1720# \mscfile command).
1179# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1721
1180# read).1722MSCFILE_DIRS =
1723
1724# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1725# nodes that will be shown in the graph. If the number of nodes in a graph
1726# becomes larger than this value, doxygen will truncate the graph, which is
1727# visualized by representing a node as a red box. Note that doxygen if the
1728# number of direct children of the root node in a graph is already larger than
1729# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1730# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1731
1732DOT_GRAPH_MAX_NODES = 50
1733
1734# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1735# graphs generated by dot. A depth value of 3 means that only nodes reachable
1736# from the root by following a path via at most 3 edges will be shown. Nodes
1737# that lay further from the root node will be omitted. Note that setting this
1738# option to 1 or 2 may greatly reduce the computation time needed for large
1739# code bases. Also note that the size of a graph can be further restricted by
1740# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1741
1742MAX_DOT_GRAPH_DEPTH = 0
1743
1744# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1745# background. This is disabled by default, because dot on Windows does not
1746# seem to support this out of the box. Warning: Depending on the platform used,
1747# enabling this option may lead to badly anti-aliased labels on the edges of
1748# a graph (i.e. they become hard to read).
11811749
1182DOT_TRANSPARENT = NO1750DOT_TRANSPARENT = NO
11831751
1184# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1752# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1185# files in one run (i.e. multiple -o and -T options on the command line). This 1753# files in one run (i.e. multiple -o and -T options on the command line). This
1186# makes dot run faster, but since only newer versions of dot (>1.8.10) 1754# makes dot run faster, but since only newer versions of dot (>1.8.10)
1187# support this, this feature is disabled by default.1755# support this, this feature is disabled by default.
1188# JW1756
1189# DOT_MULTI_TARGETS = NO
1190DOT_MULTI_TARGETS = YES1757DOT_MULTI_TARGETS = YES
11911758
1192# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1759# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1193# generate a legend page explaining the meaning of the various boxes and 1760# generate a legend page explaining the meaning of the various boxes and
1194# arrows in the dot generated graphs.1761# arrows in the dot generated graphs.
11951762
1196GENERATE_LEGEND = YES1763GENERATE_LEGEND = YES
11971764
1198# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1765# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1199# remove the intermediate dot files that are used to generate 1766# remove the intermediate dot files that are used to generate
1200# the various graphs.1767# the various graphs.
12011768
1202DOT_CLEANUP = YES1769DOT_CLEANUP = YES
1203
1204#---------------------------------------------------------------------------
1205# Configuration::additions related to the search engine
1206#---------------------------------------------------------------------------
1207
1208# The SEARCHENGINE tag specifies whether or not a search engine should be
1209# used. If set to NO the values of all tags below this one will be ignored.
1210
1211# JW SEARCHENGINE = NO
1212SEARCHENGINE = NO
12131770
=== modified file 'doc/cxx/doxy.config.in'
--- doc/cxx/doxy.config.in 2011-08-11 18:46:20 +0000
+++ doc/cxx/doxy.config.in 2012-03-15 17:14:22 +0000
@@ -1,442 +1,623 @@
1# Doxyfile 1.4.51# Doxyfile 1.7.5
22
3# This file describes the settings to be used by the documentation system3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project4# doxygen (www.doxygen.org) for a project.
5#5#
6# All text after a hash (#) is considered a comment and will be ignored6# All text after a hash (#) is considered a comment and will be ignored.
7# The format is:7# The format is:
8# TAG = value [value, ...]8# TAG = value [value, ...]
9# For lists items can also be appended using:9# For lists items can also be appended using:
10# TAG += value [value, ...]10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")11# Values that contain spaces should be placed between quotes (" ").
1212
13#---------------------------------------------------------------------------13#---------------------------------------------------------------------------
14# Project related configuration options14# Project related configuration options
15#---------------------------------------------------------------------------15#---------------------------------------------------------------------------
1616
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 17# This tag specifies the encoding used for all characters in the config file
18# by quotes) that should identify the project.18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
25# The PROJECT_NAME tag is a single word (or sequence of words) that should
26# identify the project. Note that if you do not use Doxywizard you need
27# to put quotes around the project name if it contains spaces.
1928
20PROJECT_NAME = Zorba CXX-API29PROJECT_NAME = Zorba CXX-API
2130
22# The PROJECT_NUMBER tag can be used to enter a project or revision number. 31# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or 32# This could be handy for archiving the generated documentation or
24# if some version control system is used.33# if some version control system is used.
2534
26PROJECT_NUMBER = @ZORBA_MAJOR_NUMBER@.@ZORBA_MINOR_NUMBER@.@ZORBA_PATCH_NUMBER@35PROJECT_NUMBER = @ZORBA_MAJOR_NUMBER@.@ZORBA_MINOR_NUMBER@.@ZORBA_PATCH_NUMBER@
2736
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 37# Using the PROJECT_BRIEF tag one can provide an optional one line description
29# base path where the generated documentation will be put. 38# for a project that appears at the top of each page and should give viewer
30# If a relative path is entered, it will be relative to the location 39# a quick idea about the purpose of the project. Keep the description short.
40
41PROJECT_BRIEF =
42
43# With the PROJECT_LOGO tag one can specify an logo or icon that is
44# included in the documentation. The maximum height of the logo should not
45# exceed 55 pixels and the maximum width should not exceed 200 pixels.
46# Doxygen will copy the logo to the output directory.
47
48PROJECT_LOGO =
49
50# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51# base path where the generated documentation will be put.
52# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.53# where doxygen was started. If left blank the current directory will be used.
3254
33OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@55OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
3456
35# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 57# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36# 4096 sub-directories (in 2 levels) under the output directory of each output 58# 4096 sub-directories (in 2 levels) under the output directory of each output
37# format and will distribute the generated files over these directories. 59# format and will distribute the generated files over these directories.
38# Enabling this option can be useful when feeding doxygen a huge amount of 60# Enabling this option can be useful when feeding doxygen a huge amount of
39# source files, where putting all generated files in the same directory would 61# source files, where putting all generated files in the same directory would
40# otherwise cause performance problems for the file system.62# otherwise cause performance problems for the file system.
4163
42CREATE_SUBDIRS = NO64CREATE_SUBDIRS = NO
4365
44# The OUTPUT_LANGUAGE tag is used to specify the language in which all 66# The OUTPUT_LANGUAGE tag is used to specify the language in which all
45# documentation generated by doxygen is written. Doxygen will use this 67# documentation generated by doxygen is written. Doxygen will use this
46# information to generate all constant output in the proper language. 68# information to generate all constant output in the proper language.
47# The default language is English, other supported languages are: 69# The default language is English, other supported languages are:
48# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 70# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
49# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 71# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
50# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 72# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
51# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 73# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
52# Swedish, and Ukrainian.74# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
5376
54OUTPUT_LANGUAGE = English77OUTPUT_LANGUAGE = English
5578
56# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 79# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57# include brief member descriptions after the members that are listed in 80# include brief member descriptions after the members that are listed in
58# the file and class documentation (similar to JavaDoc). 81# the file and class documentation (similar to JavaDoc).
59# Set to NO to disable this.82# Set to NO to disable this.
6083
61BRIEF_MEMBER_DESC = YES84BRIEF_MEMBER_DESC = YES
6285
63# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 86# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64# the brief description of a member or function before the detailed description. 87# the brief description of a member or function before the detailed description.
65# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 88# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66# brief descriptions will be completely suppressed.89# brief descriptions will be completely suppressed.
6790
68REPEAT_BRIEF = YES91REPEAT_BRIEF = YES
6992
70# This tag implements a quasi-intelligent brief description abbreviator 93# This tag implements a quasi-intelligent brief description abbreviator
71# that is used to form the text in various listings. Each string 94# that is used to form the text in various listings. Each string
72# in this list, if found as the leading text of the brief description, will be 95# in this list, if found as the leading text of the brief description, will be
73# stripped from the text and the result after processing the whole list, is 96# stripped from the text and the result after processing the whole list, is
74# used as the annotated text. Otherwise, the brief description is used as-is. 97# used as the annotated text. Otherwise, the brief description is used as-is.
75# If left blank, the following values are used ("$name" is automatically 98# If left blank, the following values are used ("$name" is automatically
76# replaced with the name of the entity): "The $name class" "The $name widget" 99# replaced with the name of the entity): "The $name class" "The $name widget"
77# "The $name file" "is" "provides" "specifies" "contains" 100# "The $name file" "is" "provides" "specifies" "contains"
78# "represents" "a" "an" "the"101# "represents" "a" "an" "the"
79102
80ABBREVIATE_BRIEF = 103ABBREVIATE_BRIEF =
81104
82# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 105# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
83# Doxygen will generate a detailed section even if there is only a brief 106# Doxygen will generate a detailed section even if there is only a brief
84# description.107# description.
85108
86ALWAYS_DETAILED_SEC = NO109ALWAYS_DETAILED_SEC = NO
87110
88# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 111# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
89# inherited members of a class in the documentation of that class as if those 112# inherited members of a class in the documentation of that class as if those
90# members were ordinary class members. Constructors, destructors and assignment 113# members were ordinary class members. Constructors, destructors and assignment
91# operators of the base classes will not be shown.114# operators of the base classes will not be shown.
92115
93INLINE_INHERITED_MEMB = YES116INLINE_INHERITED_MEMB = YES
94117
95# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 118# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
96# path before files name in the file list and in the header files. If set 119# path before files name in the file list and in the header files. If set
97# to NO the shortest path that makes the file name unique will be used.120# to NO the shortest path that makes the file name unique will be used.
98121
99FULL_PATH_NAMES = NO122FULL_PATH_NAMES = NO
100123
101# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 124# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
102# can be used to strip a user-defined part of the path. Stripping is 125# can be used to strip a user-defined part of the path. Stripping is
103# only done if one of the specified strings matches the left-hand part of 126# only done if one of the specified strings matches the left-hand part of
104# the path. The tag can be used to show relative paths in the file list. 127# the path. The tag can be used to show relative paths in the file list.
105# If left blank the directory from which doxygen is run is used as the 128# If left blank the directory from which doxygen is run is used as the
106# path to strip.129# path to strip.
107130
108STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src @CMAKE_BINARY_DIR@/src131STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src \
109132 @CMAKE_BINARY_DIR@/src
110133
111# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 134# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
112# the path mentioned in the documentation of a class, which tells 135# the path mentioned in the documentation of a class, which tells
113# the reader which header file to include in order to use a class. 136# the reader which header file to include in order to use a class.
114# If left blank only the name of the header file containing the class 137# If left blank only the name of the header file containing the class
115# definition is used. Otherwise one should specify the include paths that 138# definition is used. Otherwise one should specify the include paths that
116# are normally passed to the compiler using the -I flag.139# are normally passed to the compiler using the -I flag.
117140
118STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include @CMAKE_BINARY_DIR@/include141STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include \
142 @CMAKE_BINARY_DIR@/include
119143
120# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 144# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
121# (but less readable) file names. This can be useful is your file systems 145# (but less readable) file names. This can be useful if your file system
122# doesn't support long names like on DOS, Mac, or CD-ROM.146# doesn't support long names like on DOS, Mac, or CD-ROM.
123147
124SHORT_NAMES = NO148SHORT_NAMES = NO
125149
126# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 150# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
127# will interpret the first line (until the first dot) of a JavaDoc-style 151# will interpret the first line (until the first dot) of a JavaDoc-style
128# comment as the brief description. If set to NO, the JavaDoc 152# comment as the brief description. If set to NO, the JavaDoc
129# comments will behave just like the Qt-style comments (thus requiring an 153# comments will behave just like regular Qt-style comments
130# explicit @brief command for a brief description.154# (thus requiring an explicit @brief command for a brief description.)
131155
132JAVADOC_AUTOBRIEF = YES156JAVADOC_AUTOBRIEF = YES
133157
134# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 158# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
135# treat a multi-line C++ special comment block (i.e. a block of //! or /// 159# interpret the first line (until the first dot) of a Qt-style
136# comments) as a brief description. This used to be the default behaviour. 160# comment as the brief description. If set to NO, the comments
137# The new default is to treat a multi-line C++ comment block as a detailed 161# will behave just like regular Qt-style comments (thus requiring
162# an explicit \brief command for a brief description.)
163
164QT_AUTOBRIEF = NO
165
166# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
167# treat a multi-line C++ special comment block (i.e. a block of //! or ///
168# comments) as a brief description. This used to be the default behaviour.
169# The new default is to treat a multi-line C++ comment block as a detailed
138# description. Set this tag to YES if you prefer the old behaviour instead.170# description. Set this tag to YES if you prefer the old behaviour instead.
139171
140MULTILINE_CPP_IS_BRIEF = NO172MULTILINE_CPP_IS_BRIEF = NO
141173
142# If the DETAILS_AT_TOP tag is set to YES then Doxygen 174# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
143# will output the detailed description near the top, like JavaDoc.175# member inherits the documentation from any documented member that it
144# If set to NO, the detailed description appears after the member
145# documentation.
146
147DETAILS_AT_TOP = NO
148
149# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
150# member inherits the documentation from any documented member that it
151# re-implements.176# re-implements.
152177
153INHERIT_DOCS = YES178INHERIT_DOCS = YES
154179
155# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 180# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
156# a new page for each member. If set to NO, the documentation of a member will 181# a new page for each member. If set to NO, the documentation of a member will
157# be part of the file/class/namespace that contains it.182# be part of the file/class/namespace that contains it.
158183
159SEPARATE_MEMBER_PAGES = NO184SEPARATE_MEMBER_PAGES = NO
160185
161# The TAB_SIZE tag can be used to set the number of spaces in a tab. 186# The TAB_SIZE tag can be used to set the number of spaces in a tab.
162# Doxygen uses this value to replace tabs by spaces in code fragments.187# Doxygen uses this value to replace tabs by spaces in code fragments.
163188
164TAB_SIZE = 2189TAB_SIZE = 2
165190
166# This tag can be used to specify a number of aliases that acts 191# This tag can be used to specify a number of aliases that acts
167# as commands in the documentation. An alias has the form "name=value". 192# as commands in the documentation. An alias has the form "name=value".
168# For example adding "sideeffect=\par Side Effects:\n" will allow you to 193# For example adding "sideeffect=\par Side Effects:\n" will allow you to
169# put the command \sideeffect (or @sideeffect) in the documentation, which 194# put the command \sideeffect (or @sideeffect) in the documentation, which
170# will result in a user-defined paragraph with heading "Side Effects:". 195# will result in a user-defined paragraph with heading "Side Effects:".
171# You can put \n's in the value part of an alias to insert newlines.196# You can put \n's in the value part of an alias to insert newlines.
172197
173ALIASES = 198ALIASES =
174199
175# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 200# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
176# sources only. Doxygen will then generate output that is more tailored for C. 201# sources only. Doxygen will then generate output that is more tailored for C.
177# For instance, some of the names that are used will be different. The list 202# For instance, some of the names that are used will be different. The list
178# of all members will be omitted, etc.203# of all members will be omitted, etc.
179204
180OPTIMIZE_OUTPUT_FOR_C = NO205OPTIMIZE_OUTPUT_FOR_C = NO
181206
182# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 207# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
183# sources only. Doxygen will then generate output that is more tailored for Java. 208# sources only. Doxygen will then generate output that is more tailored for
184# For instance, namespaces will be presented as packages, qualified scopes 209# Java. For instance, namespaces will be presented as packages, qualified
185# will look different, etc.210# scopes will look different, etc.
186211
187OPTIMIZE_OUTPUT_JAVA = NO212OPTIMIZE_OUTPUT_JAVA = NO
188213
189# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 214# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
190# include (a tag file for) the STL sources as input, then you should 215# sources only. Doxygen will then generate output that is more tailored for
191# set this tag to YES in order to let doxygen match functions declarations and 216# Fortran.
192# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 217
193# func(std::string) {}). This also make the inheritance and collaboration 218OPTIMIZE_FOR_FORTRAN = NO
219
220# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
221# sources. Doxygen will then generate output that is tailored for
222# VHDL.
223
224OPTIMIZE_OUTPUT_VHDL = NO
225
226# Doxygen selects the parser to use depending on the extension of the files it
227# parses. With this tag you can assign which parser to use for a given extension.
228# Doxygen has a built-in mapping, but you can override or extend it using this
229# tag. The format is ext=language, where ext is a file extension, and language
230# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
231# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
232# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
233# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
234# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
235
236EXTENSION_MAPPING =
237
238# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
239# to include (a tag file for) the STL sources as input, then you should
240# set this tag to YES in order to let doxygen match functions declarations and
241# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
242# func(std::string) {}). This also makes the inheritance and collaboration
194# diagrams that involve STL classes more complete and accurate.243# diagrams that involve STL classes more complete and accurate.
195244
196# BUILTIN_STL_SUPPORT = NO245BUILTIN_STL_SUPPORT = NO
197246
198# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 247# If you use Microsoft's C++/CLI language, you should set this option to YES to
199# tag is set to YES, then doxygen will reuse the documentation of the first 248# enable parsing support.
200# member in the group (if any) for the other members of the group. By default 249
250CPP_CLI_SUPPORT = NO
251
252# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
253# Doxygen will parse them like normal C++ but will assume all classes use public
254# instead of private inheritance when no explicit protection keyword is present.
255
256SIP_SUPPORT = NO
257
258# For Microsoft's IDL there are propget and propput attributes to indicate getter
259# and setter methods for a property. Setting this option to YES (the default)
260# will make doxygen replace the get and set methods by a property in the
261# documentation. This will only work if the methods are indeed getting or
262# setting a simple type. If this is not the case, or you want to show the
263# methods anyway, you should set this option to NO.
264
265IDL_PROPERTY_SUPPORT = YES
266
267# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
268# tag is set to YES, then doxygen will reuse the documentation of the first
269# member in the group (if any) for the other members of the group. By default
201# all members of a group must be documented explicitly.270# all members of a group must be documented explicitly.
202271
203DISTRIBUTE_GROUP_DOC = NO272DISTRIBUTE_GROUP_DOC = NO
204273
205# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 274# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
206# the same type (for instance a group of public functions) to be put as a 275# the same type (for instance a group of public functions) to be put as a
207# subgroup of that type (e.g. under the Public Functions section). Set it to 276# subgroup of that type (e.g. under the Public Functions section). Set it to
208# NO to prevent subgrouping. Alternatively, this can be done per class using 277# NO to prevent subgrouping. Alternatively, this can be done per class using
209# the \nosubgrouping command.278# the \nosubgrouping command.
210279
211SUBGROUPING = YES280SUBGROUPING = YES
212281
282# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
283# unions are shown inside the group in which they are included (e.g. using
284# @ingroup) instead of on a separate page (for HTML and Man pages) or
285# section (for LaTeX and RTF).
286
287INLINE_GROUPED_CLASSES = NO
288
289# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
290# unions with only public data fields will be shown inline in the documentation
291# of the scope in which they are defined (i.e. file, namespace, or group
292# documentation), provided this scope is documented. If set to NO (the default),
293# structs, classes, and unions are shown on a separate page (for HTML and Man
294# pages) or section (for LaTeX and RTF).
295
296INLINE_SIMPLE_STRUCTS = NO
297
298# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
299# is documented as struct, union, or enum with the name of the typedef. So
300# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
301# with name TypeT. When disabled the typedef will appear as a member of a file,
302# namespace, or class. And the struct will be named TypeS. This can typically
303# be useful for C code in case the coding convention dictates that all compound
304# types are typedef'ed and only the typedef is referenced, never the tag name.
305
306TYPEDEF_HIDES_STRUCT = NO
307
308# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
309# determine which symbols to keep in memory and which to flush to disk.
310# When the cache is full, less often used symbols will be written to disk.
311# For small to medium size projects (<1000 input files) the default value is
312# probably good enough. For larger projects a too small cache size can cause
313# doxygen to be busy swapping symbols to and from disk most of the time
314# causing a significant performance penalty.
315# If the system has enough physical memory increasing the cache will improve the
316# performance by keeping more symbols in memory. Note that the value works on
317# a logarithmic scale so increasing the size by one will roughly double the
318# memory usage. The cache size is given by this formula:
319# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
320# corresponding to a cache size of 2^16 = 65536 symbols
321
322SYMBOL_CACHE_SIZE = 0
323
213#---------------------------------------------------------------------------324#---------------------------------------------------------------------------
214# Build related configuration options325# Build related configuration options
215#---------------------------------------------------------------------------326#---------------------------------------------------------------------------
216327
217# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 328# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
218# documentation are documented, even if no documentation was available. 329# documentation are documented, even if no documentation was available.
219# Private class members and static file members will be hidden unless 330# Private class members and static file members will be hidden unless
220# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES331# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
221332
222EXTRACT_ALL = YES333EXTRACT_ALL = YES
223334
224# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 335# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
225# will be included in the documentation.336# will be included in the documentation.
226337
227EXTRACT_PRIVATE = NO338EXTRACT_PRIVATE = NO
228339
229# If the EXTRACT_STATIC tag is set to YES all static members of a file 340# If the EXTRACT_STATIC tag is set to YES all static members of a file
230# will be included in the documentation.341# will be included in the documentation.
231342
232EXTRACT_STATIC = NO343EXTRACT_STATIC = NO
233344
234# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 345# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
235# defined locally in source files will be included in the documentation. 346# defined locally in source files will be included in the documentation.
236# If set to NO only classes defined in header files are included.347# If set to NO only classes defined in header files are included.
237348
238EXTRACT_LOCAL_CLASSES = YES349EXTRACT_LOCAL_CLASSES = YES
239350
240# This flag is only useful for Objective-C code. When set to YES local 351# This flag is only useful for Objective-C code. When set to YES local
241# methods, which are defined in the implementation section but not in 352# methods, which are defined in the implementation section but not in
242# the interface are included in the documentation. 353# the interface are included in the documentation.
243# If set to NO (the default) only methods in the interface are included.354# If set to NO (the default) only methods in the interface are included.
244355
245EXTRACT_LOCAL_METHODS = NO356EXTRACT_LOCAL_METHODS = NO
246357
247# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 358# If this flag is set to YES, the members of anonymous namespaces will be
248# undocumented members of documented classes, files or namespaces. 359# extracted and appear in the documentation as a namespace called
249# If set to NO (the default) these members will be included in the 360# 'anonymous_namespace{file}', where file will be replaced with the base
250# various overviews, but no documentation section is generated. 361# name of the file that contains the anonymous namespace. By default
362# anonymous namespaces are hidden.
363
364EXTRACT_ANON_NSPACES = NO
365
366# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
367# undocumented members of documented classes, files or namespaces.
368# If set to NO (the default) these members will be included in the
369# various overviews, but no documentation section is generated.
251# This option has no effect if EXTRACT_ALL is enabled.370# This option has no effect if EXTRACT_ALL is enabled.
252371
253HIDE_UNDOC_MEMBERS = YES372HIDE_UNDOC_MEMBERS = YES
254373
255# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 374# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
256# undocumented classes that are normally visible in the class hierarchy. 375# undocumented classes that are normally visible in the class hierarchy.
257# If set to NO (the default) these classes will be included in the various 376# If set to NO (the default) these classes will be included in the various
258# overviews. This option has no effect if EXTRACT_ALL is enabled.377# overviews. This option has no effect if EXTRACT_ALL is enabled.
259378
260HIDE_UNDOC_CLASSES = YES379HIDE_UNDOC_CLASSES = YES
261380
262# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 381# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
263# friend (class|struct|union) declarations. 382# friend (class|struct|union) declarations.
264# If set to NO (the default) these declarations will be included in the 383# If set to NO (the default) these declarations will be included in the
265# documentation.384# documentation.
266385
267HIDE_FRIEND_COMPOUNDS = NO386HIDE_FRIEND_COMPOUNDS = NO
268387
269# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 388# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
270# documentation blocks found inside the body of a function. 389# documentation blocks found inside the body of a function.
271# If set to NO (the default) these blocks will be appended to the 390# If set to NO (the default) these blocks will be appended to the
272# function's detailed documentation block.391# function's detailed documentation block.
273392
274HIDE_IN_BODY_DOCS = NO393HIDE_IN_BODY_DOCS = NO
275394
276# The INTERNAL_DOCS tag determines if documentation 395# The INTERNAL_DOCS tag determines if documentation
277# that is typed after a \internal command is included. If the tag is set 396# that is typed after a \internal command is included. If the tag is set
278# to NO (the default) then the documentation will be excluded. 397# to NO (the default) then the documentation will be excluded.
279# Set it to YES to include the internal documentation.398# Set it to YES to include the internal documentation.
280399
281INTERNAL_DOCS = NO400INTERNAL_DOCS = NO
282401
283# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 402# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
284# file names in lower-case letters. If set to YES upper-case letters are also 403# file names in lower-case letters. If set to YES upper-case letters are also
285# allowed. This is useful if you have classes or files whose names only differ 404# allowed. This is useful if you have classes or files whose names only differ
286# in case and if your file system supports case sensitive file names. Windows 405# in case and if your file system supports case sensitive file names. Windows
287# and Mac users are advised to set this option to NO.406# and Mac users are advised to set this option to NO.
288407
289CASE_SENSE_NAMES = YES408CASE_SENSE_NAMES = YES
290409
291# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 410# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
292# will show members with their full class and namespace scopes in the 411# will show members with their full class and namespace scopes in the
293# documentation. If set to YES the scope will be hidden.412# documentation. If set to YES the scope will be hidden.
294413
295HIDE_SCOPE_NAMES = NO414HIDE_SCOPE_NAMES = NO
296415
297# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 416# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
298# will put a list of the files that are included by a file in the documentation 417# will put a list of the files that are included by a file in the documentation
299# of that file.418# of that file.
300419
301SHOW_INCLUDE_FILES = YES420SHOW_INCLUDE_FILES = YES
302421
303# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 422# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
423# will list include files with double quotes in the documentation
424# rather than with sharp brackets.
425
426FORCE_LOCAL_INCLUDES = NO
427
428# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
304# is inserted in the documentation for inline members.429# is inserted in the documentation for inline members.
305430
306INLINE_INFO = YES431INLINE_INFO = YES
307432
308# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 433# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
309# will sort the (detailed) documentation of file and class members 434# will sort the (detailed) documentation of file and class members
310# alphabetically by member name. If set to NO the members will appear in 435# alphabetically by member name. If set to NO the members will appear in
311# declaration order.436# declaration order.
312437
313SORT_MEMBER_DOCS = YES438SORT_MEMBER_DOCS = YES
314439
315# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 440# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
316# brief documentation of file, namespace and class members alphabetically 441# brief documentation of file, namespace and class members alphabetically
317# by member name. If set to NO (the default) the members will appear in 442# by member name. If set to NO (the default) the members will appear in
318# declaration order.443# declaration order.
319444
320SORT_BRIEF_DOCS = YES445SORT_BRIEF_DOCS = YES
321446
322# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 447# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
323# sorted by fully-qualified names, including namespaces. If set to 448# will sort the (brief and detailed) documentation of class members so that
324# NO (the default), the class list will be sorted only by class name, 449# constructors and destructors are listed first. If set to NO (the default)
325# not including the namespace part. 450# the constructors will appear in the respective orders defined by
451# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
452# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
453# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
454
455SORT_MEMBERS_CTORS_1ST = NO
456
457# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
458# hierarchy of group names into alphabetical order. If set to NO (the default)
459# the group names will appear in their defined order.
460
461SORT_GROUP_NAMES = NO
462
463# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
464# sorted by fully-qualified names, including namespaces. If set to
465# NO (the default), the class list will be sorted only by class name,
466# not including the namespace part.
326# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.467# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
327# Note: This option applies only to the class list, not to the 468# Note: This option applies only to the class list, not to the
328# alphabetical list.469# alphabetical list.
329470
330SORT_BY_SCOPE_NAME = NO471SORT_BY_SCOPE_NAME = NO
331472
332# The GENERATE_TODOLIST tag can be used to enable (YES) or 473# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
333# disable (NO) the todo list. This list is created by putting \todo 474# do proper type resolution of all parameters of a function it will reject a
475# match between the prototype and the implementation of a member function even
476# if there is only one candidate or it is obvious which candidate to choose
477# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
478# will still accept a match between prototype and implementation in such cases.
479
480STRICT_PROTO_MATCHING = NO
481
482# The GENERATE_TODOLIST tag can be used to enable (YES) or
483# disable (NO) the todo list. This list is created by putting \todo
334# commands in the documentation.484# commands in the documentation.
335485
336GENERATE_TODOLIST = YES486GENERATE_TODOLIST = YES
337487
338# The GENERATE_TESTLIST tag can be used to enable (YES) or 488# The GENERATE_TESTLIST tag can be used to enable (YES) or
339# disable (NO) the test list. This list is created by putting \test 489# disable (NO) the test list. This list is created by putting \test
340# commands in the documentation.490# commands in the documentation.
341491
342GENERATE_TESTLIST = YES492GENERATE_TESTLIST = YES
343493
344# The GENERATE_BUGLIST tag can be used to enable (YES) or 494# The GENERATE_BUGLIST tag can be used to enable (YES) or
345# disable (NO) the bug list. This list is created by putting \bug 495# disable (NO) the bug list. This list is created by putting \bug
346# commands in the documentation.496# commands in the documentation.
347497
348GENERATE_BUGLIST = YES498GENERATE_BUGLIST = YES
349499
350# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 500# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
351# disable (NO) the deprecated list. This list is created by putting 501# disable (NO) the deprecated list. This list is created by putting
352# \deprecated commands in the documentation.502# \deprecated commands in the documentation.
353503
354GENERATE_DEPRECATEDLIST= YES504GENERATE_DEPRECATEDLIST= YES
355505
356# The ENABLED_SECTIONS tag can be used to enable conditional 506# The ENABLED_SECTIONS tag can be used to enable conditional
357# documentation sections, marked by \if sectionname ... \endif.507# documentation sections, marked by \if sectionname ... \endif.
358508
359ENABLED_SECTIONS =509ENABLED_SECTIONS =
360510
361# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 511# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
362# the initial value of a variable or define consists of for it to appear in 512# the initial value of a variable or macro consists of for it to appear in
363# the documentation. If the initializer consists of more lines than specified 513# the documentation. If the initializer consists of more lines than specified
364# here it will be hidden. Use a value of 0 to hide initializers completely. 514# here it will be hidden. Use a value of 0 to hide initializers completely.
365# The appearance of the initializer of individual variables and defines in the 515# The appearance of the initializer of individual variables and macros in the
366# documentation can be controlled using \showinitializer or \hideinitializer 516# documentation can be controlled using \showinitializer or \hideinitializer
367# command in the documentation regardless of this setting.517# command in the documentation regardless of this setting.
368518
369MAX_INITIALIZER_LINES = 30519MAX_INITIALIZER_LINES = 30
370520
371# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 521# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
372# at the bottom of the documentation of classes and structs. If set to YES the 522# at the bottom of the documentation of classes and structs. If set to YES the
373# list will mention the files that were used to generate the documentation.523# list will mention the files that were used to generate the documentation.
374524
375SHOW_USED_FILES = YES525SHOW_USED_FILES = YES
376526
377# If the sources in your project are distributed over multiple directories 527# If the sources in your project are distributed over multiple directories
378# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 528# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
379# in the documentation. The default is YES.529# in the documentation. The default is NO.
380530
381SHOW_DIRECTORIES = YES531SHOW_DIRECTORIES = YES
382532
383# The FILE_VERSION_FILTER tag can be used to specify a program or script that 533# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
384# doxygen should invoke to get the current version for each file (typically from the 534# This will remove the Files entry from the Quick Index and from the
385# version control system). Doxygen will invoke the program by executing (via 535# Folder Tree View (if specified). The default is YES.
386# popen()) the command <command> <input-file>, where <command> is the value of 536
387# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 537SHOW_FILES = YES
388# provided by doxygen. Whatever the program writes to standard output 538
539# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
540# Namespaces page.
541# This will remove the Namespaces entry from the Quick Index
542# and from the Folder Tree View (if specified). The default is YES.
543
544SHOW_NAMESPACES = YES
545
546# The FILE_VERSION_FILTER tag can be used to specify a program or script that
547# doxygen should invoke to get the current version for each file (typically from
548# the version control system). Doxygen will invoke the program by executing (via
549# popen()) the command <command> <input-file>, where <command> is the value of
550# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
551# provided by doxygen. Whatever the program writes to standard output
389# is used as the file version. See the manual for examples.552# is used as the file version. See the manual for examples.
390553
391FILE_VERSION_FILTER = 554FILE_VERSION_FILTER =
555
556# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
557# by doxygen. The layout file controls the global structure of the generated
558# output files in an output format independent way. The create the layout file
559# that represents doxygen's defaults, run doxygen with the -l option.
560# You can optionally specify a file name after the option, if omitted
561# DoxygenLayout.xml will be used as the name of the layout file.
562
563LAYOUT_FILE =
564
565# The CITE_BIB_FILES tag can be used to specify one or more bib files
566# containing the references data. This must be a list of .bib files. The
567# .bib extension is automatically appended if omitted. Using this command
568# requires the bibtex tool to be installed. See also
569# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
570# of the bibliography can be controlled using LATEX_BIB_STYLE.
571
572CITE_BIB_FILES =
392573
393#---------------------------------------------------------------------------574#---------------------------------------------------------------------------
394# configuration options related to warning and progress messages575# configuration options related to warning and progress messages
395#---------------------------------------------------------------------------576#---------------------------------------------------------------------------
396577
397# The QUIET tag can be used to turn on/off the messages that are generated 578# The QUIET tag can be used to turn on/off the messages that are generated
398# by doxygen. Possible values are YES and NO. If left blank NO is used.579# by doxygen. Possible values are YES and NO. If left blank NO is used.
399580
400QUIET = NO581QUIET = NO
401582
402# The WARNINGS tag can be used to turn on/off the warning messages that are 583# The WARNINGS tag can be used to turn on/off the warning messages that are
403# generated by doxygen. Possible values are YES and NO. If left blank 584# generated by doxygen. Possible values are YES and NO. If left blank
404# NO is used.585# NO is used.
405586
406WARNINGS = YES587WARNINGS = YES
407588
408# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 589# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
409# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 590# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
410# automatically be disabled.591# automatically be disabled.
411592
412WARN_IF_UNDOCUMENTED = YES593WARN_IF_UNDOCUMENTED = YES
413594
414# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 595# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
415# potential errors in the documentation, such as not documenting some 596# potential errors in the documentation, such as not documenting some
416# parameters in a documented function, or documenting parameters that 597# parameters in a documented function, or documenting parameters that
417# don't exist or using markup commands wrongly.598# don't exist or using markup commands wrongly.
418599
419WARN_IF_DOC_ERROR = YES600WARN_IF_DOC_ERROR = YES
420601
421# This WARN_NO_PARAMDOC option can be abled to get warnings for 602# The WARN_NO_PARAMDOC option can be enabled to get warnings for
422# functions that are documented, but have no documentation for their parameters 603# functions that are documented, but have no documentation for their parameters
423# or return value. If set to NO (the default) doxygen will only warn about 604# or return value. If set to NO (the default) doxygen will only warn about
424# wrong or incomplete parameter documentation, but not about the absence of 605# wrong or incomplete parameter documentation, but not about the absence of
425# documentation.606# documentation.
426607
427WARN_NO_PARAMDOC = NO608WARN_NO_PARAMDOC = NO
428609
429# The WARN_FORMAT tag determines the format of the warning messages that 610# The WARN_FORMAT tag determines the format of the warning messages that
430# doxygen can produce. The string should contain the $file, $line, and $text 611# doxygen can produce. The string should contain the $file, $line, and $text
431# tags, which will be replaced by the file and line number from which the 612# tags, which will be replaced by the file and line number from which the
432# warning originated and the warning text. Optionally the format may contain 613# warning originated and the warning text. Optionally the format may contain
433# $version, which will be replaced by the version of the file (if it could 614# $version, which will be replaced by the version of the file (if it could
434# be obtained via FILE_VERSION_FILTER)615# be obtained via FILE_VERSION_FILTER)
435616
436WARN_FORMAT = @DOXY_WARN_FORMAT@617WARN_FORMAT = @DOXY_WARN_FORMAT@
437618
438# The WARN_LOGFILE tag can be used to specify a file to which warning 619# The WARN_LOGFILE tag can be used to specify a file to which warning
439# and error messages should be written. If left blank the output is written 620# and error messages should be written. If left blank the output is written
440# to stderr.621# to stderr.
441622
442WARN_LOGFILE = Doc/doxy.log623WARN_LOGFILE = Doc/doxy.log
@@ -445,19 +626,29 @@
445# configuration options related to the input files626# configuration options related to the input files
446#---------------------------------------------------------------------------627#---------------------------------------------------------------------------
447628
448# The INPUT tag can be used to specify the files and/or directories that contain 629# The INPUT tag can be used to specify the files and/or directories that contain
449# documented source files. You may enter file names like "myfile.cpp" or 630# documented source files. You may enter file names like "myfile.cpp" or
450# directories like "/usr/src/myproject". Separate the files or directories 631# directories like "/usr/src/myproject". Separate the files or directories
451# with spaces.632# with spaces.
452633
453INPUT = @CMAKE_SOURCE_DIR@/include/zorba @CMAKE_CURRENT_SOURCE_DIR@/manual 634INPUT = @CMAKE_SOURCE_DIR@/include/zorba \
454635 @CMAKE_CURRENT_SOURCE_DIR@/manual
455# If the value of the INPUT tag contains directories, you can use the 636
456# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 637# This tag can be used to specify the character encoding of the source files
457# and *.h) to filter out the source-files in the directories. If left 638# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
458# blank the following patterns are tested: 639# also the default input encoding. Doxygen uses libiconv (or the iconv built
459# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 640# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
460# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py641# the list of possible encodings.
642
643INPUT_ENCODING = UTF-8
644
645# If the value of the INPUT tag contains directories, you can use the
646# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
647# and *.h) to filter out the source-files in the directories. If left
648# blank the following patterns are tested:
649# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
650# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
651# *.f90 *.f *.for *.vhd *.vhdl
461652
462FILE_PATTERNS = *.cpp \653FILE_PATTERNS = *.cpp \
463 *.cc \654 *.cc \
@@ -466,43 +657,53 @@
466 *.hpp \657 *.hpp \
467 *.dox658 *.dox
468659
469# The RECURSIVE tag can be used to turn specify whether or not subdirectories 660# The RECURSIVE tag can be used to turn specify whether or not subdirectories
470# should be searched for input files as well. Possible values are YES and NO. 661# should be searched for input files as well. Possible values are YES and NO.
471# If left blank NO is used.662# If left blank NO is used.
472663
473RECURSIVE = YES664RECURSIVE = YES
474665
475# The EXCLUDE tag can be used to specify files and/or directories that should 666# The EXCLUDE tag can be used to specify files and/or directories that should
476# excluded from the INPUT source files. This way you can easily exclude a 667# excluded from the INPUT source files. This way you can easily exclude a
477# subdirectory from a directory tree whose root is specified with the INPUT tag.668# subdirectory from a directory tree whose root is specified with the INPUT tag.
478669# Note that relative paths are relative to directory from which doxygen is run.
479EXCLUDE = 670
480671EXCLUDE =
481# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 672
482# directories that are symbolic links (a Unix filesystem feature) are excluded 673# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
674# directories that are symbolic links (a Unix file system feature) are excluded
483# from the input.675# from the input.
484676
485EXCLUDE_SYMLINKS = NO677EXCLUDE_SYMLINKS = NO
486678
487# If the value of the INPUT tag contains directories, you can use the 679# If the value of the INPUT tag contains directories, you can use the
488# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 680# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
489# certain files from those directories. Note that the wildcards are matched 681# certain files from those directories. Note that the wildcards are matched
490# against the file with absolute path, so to exclude all test directories 682# against the file with absolute path, so to exclude all test directories
491# for example use the pattern */test/*683# for example use the pattern */test/*
492684
493EXCLUDE_PATTERNS = */.svn \685EXCLUDE_PATTERNS = */.svn \
494 */.svn/* \686 */.svn/* \
495 */zorba/zorbac.h687 */zorba/zorbac.h
496688
497# The EXAMPLE_PATH tag can be used to specify one or more files or 689# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
498# directories that contain example code fragments that are included (see 690# (namespaces, classes, functions, etc.) that should be excluded from the
691# output. The symbol name can be a fully qualified name, a word, or if the
692# wildcard * is used, a substring. Examples: ANamespace, AClass,
693# AClass::ANamespace, ANamespace::*Test
694
695EXCLUDE_SYMBOLS =
696
697# The EXAMPLE_PATH tag can be used to specify one or more files or
698# directories that contain example code fragments that are included (see
499# the \include command).699# the \include command).
500700
501EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples @CMAKE_SOURCE_DIR@/test/rbkt/Queries701EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples \
702 @CMAKE_SOURCE_DIR@/test/rbkt/Queries
502703
503# If the value of the EXAMPLE_PATH tag contains directories, you can use the 704# If the value of the EXAMPLE_PATH tag contains directories, you can use the
504# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 705# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
505# and *.h) to filter out the source-files in the directories. If left 706# and *.h) to filter out the source-files in the directories. If left
506# blank all files are included.707# blank all files are included.
507708
508EXAMPLE_PATTERNS = *.cpp \709EXAMPLE_PATTERNS = *.cpp \
@@ -510,91 +711,113 @@
510 *.h \711 *.h \
511 *.hh \712 *.hh \
512 *.xq \713 *.xq \
513 INSTALL DEPENDENCIES CHANGELOG LICENSE LGPL714 INSTALL \
715 DEPENDENCIES \
716 CHANGELOG \
717 LICENSE \
718 LGPL
514719
515# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 720# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
516# searched for input files to be used with the \include or \dontinclude 721# searched for input files to be used with the \include or \dontinclude
517# commands irrespective of the value of the RECURSIVE tag. 722# commands irrespective of the value of the RECURSIVE tag.
518# Possible values are YES and NO. If left blank NO is used.723# Possible values are YES and NO. If left blank NO is used.
519724
520EXAMPLE_RECURSIVE = YES725EXAMPLE_RECURSIVE = YES
521726
522# The IMAGE_PATH tag can be used to specify one or more files or 727# The IMAGE_PATH tag can be used to specify one or more files or
523# directories that contain image that are included in the documentation (see 728# directories that contain image that are included in the documentation (see
524# the \image command).729# the \image command).
525730
526IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@731IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@
527732
528733# The INPUT_FILTER tag can be used to specify a program that doxygen should
529# The INPUT_FILTER tag can be used to specify a program that doxygen should 734# invoke to filter for each input file. Doxygen will invoke the filter program
530# invoke to filter for each input file. Doxygen will invoke the filter program 735# by executing (via popen()) the command <filter> <input-file>, where <filter>
531# by executing (via popen()) the command <filter> <input-file>, where <filter> 736# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
532# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 737# input file. Doxygen will then use the output that the filter program writes
533# input file. Doxygen will then use the output that the filter program writes 738# to standard output.
534# to standard output. If FILTER_PATTERNS is specified, this tag will be 739# If FILTER_PATTERNS is specified, this tag will be
535# ignored.740# ignored.
536741
537INPUT_FILTER = 742INPUT_FILTER =
538743
539# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 744# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
540# basis. Doxygen will compare the file name with each pattern and apply the 745# basis.
541# filter if there is a match. The filters are a list of the form: 746# Doxygen will compare the file name with each pattern and apply the
542# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 747# filter if there is a match.
543# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 748# The filters are a list of the form:
544# is applied to all files.749# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
545750# info on how filters are used. If FILTER_PATTERNS is empty or if
546FILTER_PATTERNS = 751# non of the patterns match the file name, INPUT_FILTER is applied.
547752
548# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 753FILTER_PATTERNS =
549# INPUT_FILTER) will be used to filter the input files when producing source 754
755# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
756# INPUT_FILTER) will be used to filter the input files when producing source
550# files to browse (i.e. when SOURCE_BROWSER is set to YES).757# files to browse (i.e. when SOURCE_BROWSER is set to YES).
551758
552FILTER_SOURCE_FILES = NO759FILTER_SOURCE_FILES = NO
553760
761# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
762# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
763# and it is also possible to disable source filtering for a specific pattern
764# using *.ext= (so without naming a filter). This option only has effect when
765# FILTER_SOURCE_FILES is enabled.
766
767FILTER_SOURCE_PATTERNS =
768
554#---------------------------------------------------------------------------769#---------------------------------------------------------------------------
555# configuration options related to source browsing770# configuration options related to source browsing
556#---------------------------------------------------------------------------771#---------------------------------------------------------------------------
557772
558# If the SOURCE_BROWSER tag is set to YES then a list of source files will 773# If the SOURCE_BROWSER tag is set to YES then a list of source files will
559# be generated. Documented entities will be cross-referenced with these sources. 774# be generated. Documented entities will be cross-referenced with these sources.
560# Note: To get rid of all source code in the generated output, make sure also 775# Note: To get rid of all source code in the generated output, make sure also
561# VERBATIM_HEADERS is set to NO.776# VERBATIM_HEADERS is set to NO.
562777
563SOURCE_BROWSER = YES778SOURCE_BROWSER = YES
564779
565# Setting the INLINE_SOURCES tag to YES will include the body 780# Setting the INLINE_SOURCES tag to YES will include the body
566# of functions and classes directly in the documentation.781# of functions and classes directly in the documentation.
567782
568INLINE_SOURCES = NO783INLINE_SOURCES = NO
569784
570# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 785# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
571# doxygen to hide any special comment blocks from generated source code 786# doxygen to hide any special comment blocks from generated source code
572# fragments. Normal C and C++ comments will always remain visible.787# fragments. Normal C and C++ comments will always remain visible.
573788
574STRIP_CODE_COMMENTS = NO789STRIP_CODE_COMMENTS = NO
575790
576# If the REFERENCED_BY_RELATION tag is set to YES (the default) 791# If the REFERENCED_BY_RELATION tag is set to YES
577# then for each documented function all documented 792# then for each documented function all documented
578# functions referencing it will be listed.793# functions referencing it will be listed.
579794
580REFERENCED_BY_RELATION = YES795REFERENCED_BY_RELATION = YES
581796
582# If the REFERENCES_RELATION tag is set to YES (the default) 797# If the REFERENCES_RELATION tag is set to YES
583# then for each documented function all documented entities 798# then for each documented function all documented entities
584# called/used by that function will be listed.799# called/used by that function will be listed.
585800
586REFERENCES_RELATION = YES801REFERENCES_RELATION = YES
587802
588# If the USE_HTAGS tag is set to YES then the references to source code 803# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
589# will point to the HTML generated by the htags(1) tool instead of doxygen 804# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
590# built-in source browser. The htags tool is part of GNU's global source 805# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
591# tagging system (see http://www.gnu.org/software/global/global.html). You 806# link to the source code.
807# Otherwise they will link to the documentation.
808
809REFERENCES_LINK_SOURCE = YES
810
811# If the USE_HTAGS tag is set to YES then the references to source code
812# will point to the HTML generated by the htags(1) tool instead of doxygen
813# built-in source browser. The htags tool is part of GNU's global source
814# tagging system (see http://www.gnu.org/software/global/global.html). You
592# will need version 4.8.6 or higher.815# will need version 4.8.6 or higher.
593816
594USE_HTAGS = NO817USE_HTAGS = NO
595818
596# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 819# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
597# will generate a verbatim copy of the header file for each class for 820# will generate a verbatim copy of the header file for each class for
598# which an include is specified. Set to NO to disable this.821# which an include is specified. Set to NO to disable this.
599822
600VERBATIM_HEADERS = YES823VERBATIM_HEADERS = YES
@@ -603,281 +826,548 @@
603# configuration options related to the alphabetical class index826# configuration options related to the alphabetical class index
604#---------------------------------------------------------------------------827#---------------------------------------------------------------------------
605828
606# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 829# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
607# of all compounds will be generated. Enable this if the project 830# of all compounds will be generated. Enable this if the project
608# contains a lot of classes, structs, unions or interfaces.831# contains a lot of classes, structs, unions or interfaces.
609832
610ALPHABETICAL_INDEX = YES833ALPHABETICAL_INDEX = YES
611834
612# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 835# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
613# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 836# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
614# in which this list will be split (can be a number in the range [1..20])837# in which this list will be split (can be a number in the range [1..20])
615838
616COLS_IN_ALPHA_INDEX = 2839COLS_IN_ALPHA_INDEX = 2
617840
618# In case all classes in a project start with a common prefix, all 841# In case all classes in a project start with a common prefix, all
619# classes will be put under the same header in the alphabetical index. 842# classes will be put under the same header in the alphabetical index.
620# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 843# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
621# should be ignored while generating the index headers.844# should be ignored while generating the index headers.
622845
623IGNORE_PREFIX = 846IGNORE_PREFIX =
624847
625#---------------------------------------------------------------------------848#---------------------------------------------------------------------------
626# configuration options related to the HTML output849# configuration options related to the HTML output
627#---------------------------------------------------------------------------850#---------------------------------------------------------------------------
628851
629# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 852# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
630# generate HTML output.853# generate HTML output.
631854
632GENERATE_HTML = YES855GENERATE_HTML = YES
633856
634# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 857# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
635# If a relative path is entered the value of OUTPUT_DIRECTORY will be 858# If a relative path is entered the value of OUTPUT_DIRECTORY will be
636# put in front of it. If left blank `html' will be used as the default path.859# put in front of it. If left blank `html' will be used as the default path.
637860
638HTML_OUTPUT = html861HTML_OUTPUT = html
639862
640# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 863# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
641# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 864# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
642# doxygen will generate files with .html extension.865# doxygen will generate files with .html extension.
643866
644HTML_FILE_EXTENSION = .html867HTML_FILE_EXTENSION = .html
645868
646# The HTML_HEADER tag can be used to specify a personal HTML header for 869# The HTML_HEADER tag can be used to specify a personal HTML header for
647# each generated HTML page. If it is left blank doxygen will generate a 870# each generated HTML page. If it is left blank doxygen will generate a
648# standard header.871# standard header. Note that when using a custom header you are responsible
872# for the proper inclusion of any scripts and style sheets that doxygen
873# needs, which is dependent on the configuration options used.
874# It is adviced to generate a default header using "doxygen -w html
875# header.html footer.html stylesheet.css YourConfigFile" and then modify
876# that header. Note that the header is subject to change so you typically
877# have to redo this when upgrading to a newer version of doxygen or when
878# changing the value of configuration settings such as GENERATE_TREEVIEW!
879
649HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/../style/header.html880HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/../style/header.html
650881
651882# The HTML_FOOTER tag can be used to specify a personal HTML footer for
652# The HTML_FOOTER tag can be used to specify a personal HTML footer for 883# each generated HTML page. If it is left blank doxygen will generate a
653# each generated HTML page. If it is left blank doxygen will generate a
654# standard footer.884# standard footer.
655885
656HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/../style/footer.html886HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/../style/footer.html
657887
658# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 888# If the HTML_TIMESTAMP tag is set to YES then the generated HTML documentation will contain the timesstamp.
659# style sheet that is used by each HTML page. It can be used to 889
660# fine-tune the look of the HTML output. If the tag is left blank doxygen 890HTML_TIMESTAMP = NO
661# will generate a default style sheet. Note that doxygen will try to copy 891
662# the style sheet file to the HTML output directory, so don't put your own 892# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
893# style sheet that is used by each HTML page. It can be used to
894# fine-tune the look of the HTML output. If the tag is left blank doxygen
895# will generate a default style sheet. Note that doxygen will try to copy
896# the style sheet file to the HTML output directory, so don't put your own
663# stylesheet in the HTML output directory as well, or it will be erased!897# stylesheet in the HTML output directory as well, or it will be erased!
664898
665HTML_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/../style/stylesheet.css899HTML_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/../style/stylesheet.css
666900
667# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 901# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
668# files or namespaces will be aligned in HTML using tables. If set to 902# other source files which should be copied to the HTML output directory. Note
903# that these files will be copied to the base HTML output directory. Use the
904# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
905# files. In the HTML_STYLESHEET file, use the file name only. Also note that
906# the files will be copied as-is; there are no commands or markers available.
907
908HTML_EXTRA_FILES =
909
910# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
911# Doxygen will adjust the colors in the stylesheet and background images
912# according to this color. Hue is specified as an angle on a colorwheel,
913# see http://en.wikipedia.org/wiki/Hue for more information.
914# For instance the value 0 represents red, 60 is yellow, 120 is green,
915# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
916# The allowed range is 0 to 359.
917
918HTML_COLORSTYLE_HUE = 220
919
920# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
921# the colors in the HTML output. For a value of 0 the output will use
922# grayscales only. A value of 255 will produce the most vivid colors.
923
924HTML_COLORSTYLE_SAT = 100
925
926# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
927# the luminance component of the colors in the HTML output. Values below
928# 100 gradually make the output lighter, whereas values above 100 make
929# the output darker. The value divided by 100 is the actual gamma applied,
930# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
931# and 100 does not change the gamma.
932
933HTML_COLORSTYLE_GAMMA = 80
934
935# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
936# page will contain the date and time when the page was generated. Setting
937# this to NO can help when comparing the output of multiple runs.
938
939HTML_TIMESTAMP = YES
940
941# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
942# files or namespaces will be aligned in HTML using tables. If set to
669# NO a bullet list will be used.943# NO a bullet list will be used.
670944
671HTML_ALIGN_MEMBERS = YES945HTML_ALIGN_MEMBERS = YES
672946
673# If the GENERATE_HTMLHELP tag is set to YES, additional index files 947# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
674# will be generated that can be used as input for tools like the 948# documentation will contain sections that can be hidden and shown after the
675# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 949# page has loaded. For this to work a browser that supports
950# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
951# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
952
953HTML_DYNAMIC_SECTIONS = NO
954
955# If the GENERATE_DOCSET tag is set to YES, additional index files
956# will be generated that can be used as input for Apple's Xcode 3
957# integrated development environment, introduced with OSX 10.5 (Leopard).
958# To create a documentation set, doxygen will generate a Makefile in the
959# HTML output directory. Running make will produce the docset in that
960# directory and running "make install" will install the docset in
961# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
962# it at startup.
963# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
964# for more information.
965
966GENERATE_DOCSET = NO
967
968# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
969# feed. A documentation feed provides an umbrella under which multiple
970# documentation sets from a single provider (such as a company or product suite)
971# can be grouped.
972
973DOCSET_FEEDNAME = "Doxygen generated docs"
974
975# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
976# should uniquely identify the documentation set bundle. This should be a
977# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
978# will append .docset to the name.
979
980DOCSET_BUNDLE_ID = org.doxygen.Project
981
982# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
983# the documentation publisher. This should be a reverse domain-name style
984# string, e.g. com.mycompany.MyDocSet.documentation.
985
986DOCSET_PUBLISHER_ID = org.doxygen.Publisher
987
988# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
989
990DOCSET_PUBLISHER_NAME = Publisher
991
992# If the GENERATE_HTMLHELP tag is set to YES, additional index files
993# will be generated that can be used as input for tools like the
994# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
676# of the generated HTML documentation.995# of the generated HTML documentation.
677996
678GENERATE_HTMLHELP = YES997GENERATE_HTMLHELP = YES
679998
680# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 999# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
681# be used to specify the file name of the resulting .chm file. You 1000# be used to specify the file name of the resulting .chm file. You
682# can add a path in front of the file if the result should not be 1001# can add a path in front of the file if the result should not be
683# written to the html output directory.1002# written to the html output directory.
6841003
685CHM_FILE = 1004CHM_FILE =
6861005
687# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 1006# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
688# be used to specify the location (absolute path including file name) of 1007# be used to specify the location (absolute path including file name) of
689# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 1008# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
690# the HTML help compiler on the generated index.hhp.1009# the HTML help compiler on the generated index.hhp.
6911010
692HHC_LOCATION = 1011HHC_LOCATION =
6931012
694# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 1013# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
695# controls if a separate .chi index file is generated (YES) or that 1014# controls if a separate .chi index file is generated (YES) or that
696# it should be included in the master .chm file (NO).1015# it should be included in the master .chm file (NO).
6971016
698GENERATE_CHI = NO1017GENERATE_CHI = NO
6991018
700# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 1019# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
701# controls whether a binary table of contents is generated (YES) or a 1020# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1021# content.
1022
1023CHM_INDEX_ENCODING =
1024
1025# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
1026# controls whether a binary table of contents is generated (YES) or a
702# normal table of contents (NO) in the .chm file.1027# normal table of contents (NO) in the .chm file.
7031028
704BINARY_TOC = NO1029BINARY_TOC = NO
7051030
706# The TOC_EXPAND flag can be set to YES to add extra items for group members 1031# The TOC_EXPAND flag can be set to YES to add extra items for group members
707# to the contents of the HTML help documentation and to the tree view.1032# to the contents of the HTML help documentation and to the tree view.
7081033
709TOC_EXPAND = NO1034TOC_EXPAND = NO
7101035
711# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 1036# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
712# top of each HTML page. The value NO (the default) enables the index and 1037# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
1038# that can be used as input for Qt's qhelpgenerator to generate a
1039# Qt Compressed Help (.qch) of the generated HTML documentation.
1040
1041GENERATE_QHP = NO
1042
1043# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
1044# be used to specify the file name of the resulting .qch file.
1045# The path specified is relative to the HTML output folder.
1046
1047QCH_FILE =
1048
1049# The QHP_NAMESPACE tag specifies the namespace to use when generating
1050# Qt Help Project output. For more information please see
1051# http://doc.trolltech.com/qthelpproject.html#namespace
1052
1053QHP_NAMESPACE = org.doxygen.Project
1054
1055# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
1056# Qt Help Project output. For more information please see
1057# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1058
1059QHP_VIRTUAL_FOLDER = doc
1060
1061# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1062# add. For more information please see
1063# http://doc.trolltech.com/qthelpproject.html#custom-filters
1064
1065QHP_CUST_FILTER_NAME =
1066
1067# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1068# custom filter to add. For more information please see
1069# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1070# Qt Help Project / Custom Filters</a>.
1071
1072QHP_CUST_FILTER_ATTRS =
1073
1074# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1075# project's
1076# filter section matches.
1077# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1078# Qt Help Project / Filter Attributes</a>.
1079
1080QHP_SECT_FILTER_ATTRS =
1081
1082# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1083# be used to specify the location of Qt's qhelpgenerator.
1084# If non-empty doxygen will try to run qhelpgenerator on the generated
1085# .qhp file.
1086
1087QHG_LOCATION =
1088
1089# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1090# will be generated, which together with the HTML files, form an Eclipse help
1091# plugin. To install this plugin and make it available under the help contents
1092# menu in Eclipse, the contents of the directory containing the HTML and XML
1093# files needs to be copied into the plugins directory of eclipse. The name of
1094# the directory within the plugins directory should be the same as
1095# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1096# the help appears.
1097
1098GENERATE_ECLIPSEHELP = NO
1099
1100# A unique identifier for the eclipse help plugin. When installing the plugin
1101# the directory name containing the HTML and XML files should also have
1102# this name.
1103
1104ECLIPSE_DOC_ID = org.doxygen.Project
1105
1106# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1107# top of each HTML page. The value NO (the default) enables the index and
713# the value YES disables it.1108# the value YES disables it.
7141109
715DISABLE_INDEX = NO1110DISABLE_INDEX = NO
7161111
717# This tag can be used to set the number of enum values (range [1..20]) 1112# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
718# that doxygen will group on one line in the generated HTML documentation.1113# (range [0,1..20]) that doxygen will group on one line in the generated HTML
1114# documentation. Note that a value of 0 will completely suppress the enum
1115# values from appearing in the overview section.
7191116
720ENUM_VALUES_PER_LINE = 41117ENUM_VALUES_PER_LINE = 4
7211118
722# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be1119# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
723# generated containing a tree-like index structure (just like the one that 1120# structure should be generated to display hierarchical information.
724# is generated for HTML Help). For this to work a browser that supports 1121# If the tag value is set to YES, a side panel will be generated
725# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 1122# containing a tree-like index structure (just like the one that
726# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 1123# is generated for HTML Help). For this to work a browser that supports
727# probably better off using the HTML help feature.1124# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1125# Windows users are probably better off using the HTML help feature.
7281126
729GENERATE_TREEVIEW = NO1127GENERATE_TREEVIEW = NO
7301128
731# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1129# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
732# used to set the initial width (in pixels) of the frame in which the tree 1130# and Class Hierarchy pages using a tree view instead of an ordered list.
1131
1132USE_INLINE_TREES = NO
1133
1134# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1135# used to set the initial width (in pixels) of the frame in which the tree
733# is shown.1136# is shown.
7341137
735TREEVIEW_WIDTH = 2501138TREEVIEW_WIDTH = 250
7361139
1140# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1141# links to external symbols imported via tag files in a separate window.
1142
1143EXT_LINKS_IN_WINDOW = NO
1144
1145# Use this tag to change the font size of Latex formulas included
1146# as images in the HTML documentation. The default is 10. Note that
1147# when you change the font size after a successful doxygen run you need
1148# to manually remove any form_*.png images from the HTML output directory
1149# to force them to be regenerated.
1150
1151FORMULA_FONTSIZE = 10
1152
1153# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1154# generated for formulas are transparent PNGs. Transparent PNGs are
1155# not supported properly for IE 6.0, but are supported on all modern browsers.
1156# Note that when changing this option you need to delete any form_*.png files
1157# in the HTML output before the changes have effect.
1158
1159FORMULA_TRANSPARENT = YES
1160
1161# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
1162# (see http://www.mathjax.org) which uses client side Javascript for the
1163# rendering instead of using prerendered bitmaps. Use this if you do not
1164# have LaTeX installed or if you want to formulas look prettier in the HTML
1165# output. When enabled you also need to install MathJax separately and
1166# configure the path to it using the MATHJAX_RELPATH option.
1167
1168USE_MATHJAX = NO
1169
1170# When MathJax is enabled you need to specify the location relative to the
1171# HTML output directory using the MATHJAX_RELPATH option. The destination
1172# directory should contain the MathJax.js script. For instance, if the mathjax
1173# directory is located at the same level as the HTML output directory, then
1174# MATHJAX_RELPATH should be ../mathjax. The default value points to the
1175# mathjax.org site, so you can quickly see the result without installing
1176# MathJax, but it is strongly recommended to install a local copy of MathJax
1177# before deployment.
1178
1179MATHJAX_RELPATH = http://www.mathjax.org/mathjax
1180
1181# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
1182# names that should be enabled during MathJax rendering.
1183
1184MATHJAX_EXTENSIONS =
1185
1186# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1187# for the HTML output. The underlying search engine uses javascript
1188# and DHTML and should work on any modern browser. Note that when using
1189# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1190# (GENERATE_DOCSET) there is already a search function so this one should
1191# typically be disabled. For large projects the javascript based search engine
1192# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1193
1194SEARCHENGINE = YES
1195
1196# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1197# implemented using a PHP enabled web server instead of at the web client
1198# using Javascript. Doxygen will generate the search PHP script and index
1199# file to put on the web server. The advantage of the server
1200# based approach is that it scales better to large projects and allows
1201# full text search. The disadvantages are that it is more difficult to setup
1202# and does not have live searching capabilities.
1203
1204SERVER_BASED_SEARCH = NO
1205
737#---------------------------------------------------------------------------1206#---------------------------------------------------------------------------
738# configuration options related to the LaTeX output1207# configuration options related to the LaTeX output
739#---------------------------------------------------------------------------1208#---------------------------------------------------------------------------
7401209
741# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1210# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
742# generate Latex output.1211# generate Latex output.
7431212
744GENERATE_LATEX = NO1213GENERATE_LATEX = NO
7451214
746# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1215# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
747# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1216# If a relative path is entered the value of OUTPUT_DIRECTORY will be
748# put in front of it. If left blank `latex' will be used as the default path.1217# put in front of it. If left blank `latex' will be used as the default path.
7491218
750LATEX_OUTPUT = latex1219LATEX_OUTPUT = latex
7511220
752# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1221# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
753# invoked. If left blank `latex' will be used as the default command name.1222# invoked. If left blank `latex' will be used as the default command name.
7541223# Note that when enabling USE_PDFLATEX this option is only used for
755#LATEX_CMD_NAME = latex1224# generating bitmaps for formulas in the HTML output, but not in the
756LATEX_CMD_NAME = @LATEX_COMPILER@1225# Makefile that is written to the output directory.
7571226
758# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 1227LATEX_CMD_NAME = @LATEX_COMPILER@
759# generate index for LaTeX. If left blank `makeindex' will be used as the 1228
1229# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1230# generate index for LaTeX. If left blank `makeindex' will be used as the
760# default command name.1231# default command name.
7611232
762#MAKEINDEX_CMD_NAME = makeindex
763MAKEINDEX_CMD_NAME = @MAKEINDEX_COMPILER@1233MAKEINDEX_CMD_NAME = @MAKEINDEX_COMPILER@
7641234
765# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1235# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
766# LaTeX documents. This may be useful for small projects and may help to 1236# LaTeX documents. This may be useful for small projects and may help to
767# save some trees in general.1237# save some trees in general.
7681238
769COMPACT_LATEX = NO1239COMPACT_LATEX = NO
7701240
771# The PAPER_TYPE tag can be used to set the paper type that is used 1241# The PAPER_TYPE tag can be used to set the paper type that is used
772# by the printer. Possible values are: a4, a4wide, letter, legal and 1242# by the printer. Possible values are: a4, letter, legal and
773# executive. If left blank a4wide will be used.1243# executive. If left blank a4wide will be used.
7741244
775PAPER_TYPE = a41245PAPER_TYPE = a4
7761246
777# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1247# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
778# packages that should be included in the LaTeX output.1248# packages that should be included in the LaTeX output.
7791249
780EXTRA_PACKAGES = 1250EXTRA_PACKAGES =
7811251
782# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1252# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
783# the generated latex document. The header should contain everything until 1253# the generated latex document. The header should contain everything until
784# the first chapter. If it is left blank doxygen will generate a 1254# the first chapter. If it is left blank doxygen will generate a
785# standard header. Notice: only use this tag if you know what you are doing!1255# standard header. Notice: only use this tag if you know what you are doing!
7861256
787LATEX_HEADER = 1257LATEX_HEADER =
7881258
789# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1259# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
790# is prepared for conversion to pdf (using ps2pdf). The pdf file will 1260# the generated latex document. The footer should contain everything after
791# contain links (just like the HTML output) instead of page references 1261# the last chapter. If it is left blank doxygen will generate a
1262# standard footer. Notice: only use this tag if you know what you are doing!
1263
1264LATEX_FOOTER =
1265
1266# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1267# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1268# contain links (just like the HTML output) instead of page references
792# This makes the output suitable for online browsing using a pdf viewer.1269# This makes the output suitable for online browsing using a pdf viewer.
7931270
794PDF_HYPERLINKS = YES1271PDF_HYPERLINKS = YES
7951272
796# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1273# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
797# plain latex in the generated Makefile. Set this option to YES to get a 1274# plain latex in the generated Makefile. Set this option to YES to get a
798# higher quality PDF documentation.1275# higher quality PDF documentation.
7991276
800USE_PDFLATEX = YES1277USE_PDFLATEX = YES
8011278
802# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1279# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
803# command to the generated LaTeX files. This will instruct LaTeX to keep 1280# command to the generated LaTeX files. This will instruct LaTeX to keep
804# running if errors occur, instead of asking the user for help. 1281# running if errors occur, instead of asking the user for help.
805# This option is also used when generating formulas in HTML.1282# This option is also used when generating formulas in HTML.
8061283
807LATEX_BATCHMODE = YES1284LATEX_BATCHMODE = YES
8081285
809# If LATEX_HIDE_INDICES is set to YES then doxygen will not 1286# If LATEX_HIDE_INDICES is set to YES then doxygen will not
810# include the index chapters (such as File Index, Compound Index, etc.) 1287# include the index chapters (such as File Index, Compound Index, etc.)
811# in the output.1288# in the output.
8121289
813LATEX_HIDE_INDICES = NO1290LATEX_HIDE_INDICES = NO
8141291
1292# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1293# source code with syntax highlighting in the LaTeX output.
1294# Note that which sources are shown also depends on other settings
1295# such as SOURCE_BROWSER.
1296
1297LATEX_SOURCE_CODE = NO
1298
1299# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1300# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
1301# http://en.wikipedia.org/wiki/BibTeX for more info.
1302
1303LATEX_BIB_STYLE = plain
1304
815#---------------------------------------------------------------------------1305#---------------------------------------------------------------------------
816# configuration options related to the RTF output1306# configuration options related to the RTF output
817#---------------------------------------------------------------------------1307#---------------------------------------------------------------------------
8181308
819# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1309# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
820# The RTF output is optimized for Word 97 and may not look very pretty with 1310# The RTF output is optimized for Word 97 and may not look very pretty with
821# other RTF readers or editors.1311# other RTF readers or editors.
8221312
823GENERATE_RTF = NO1313GENERATE_RTF = NO
8241314
825# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1315# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
826# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1316# If a relative path is entered the value of OUTPUT_DIRECTORY will be
827# put in front of it. If left blank `rtf' will be used as the default path.1317# put in front of it. If left blank `rtf' will be used as the default path.
8281318
829RTF_OUTPUT = rtf1319RTF_OUTPUT = rtf
8301320
831# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1321# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
832# RTF documents. This may be useful for small projects and may help to 1322# RTF documents. This may be useful for small projects and may help to
833# save some trees in general.1323# save some trees in general.
8341324
835COMPACT_RTF = NO1325COMPACT_RTF = NO
8361326
837# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1327# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
838# will contain hyperlink fields. The RTF file will 1328# will contain hyperlink fields. The RTF file will
839# contain links (just like the HTML output) instead of page references. 1329# contain links (just like the HTML output) instead of page references.
840# This makes the output suitable for online browsing using WORD or other 1330# This makes the output suitable for online browsing using WORD or other
841# programs which support those fields. 1331# programs which support those fields.
842# Note: wordpad (write) and others do not support links.1332# Note: wordpad (write) and others do not support links.
8431333
844RTF_HYPERLINKS = NO1334RTF_HYPERLINKS = NO
8451335
846# Load stylesheet definitions from file. Syntax is similar to doxygen's 1336# Load stylesheet definitions from file. Syntax is similar to doxygen's
847# config file, i.e. a series of assignments. You only have to provide 1337# config file, i.e. a series of assignments. You only have to provide
848# replacements, missing definitions are set to their default value.1338# replacements, missing definitions are set to their default value.
8491339
850RTF_STYLESHEET_FILE = 1340RTF_STYLESHEET_FILE =
8511341
852# Set optional variables used in the generation of an rtf document. 1342# Set optional variables used in the generation of an rtf document.
853# Syntax is similar to doxygen's config file.1343# Syntax is similar to doxygen's config file.
8541344
855RTF_EXTENSIONS_FILE = 1345RTF_EXTENSIONS_FILE =
8561346
857#---------------------------------------------------------------------------1347#---------------------------------------------------------------------------
858# configuration options related to the man page output1348# configuration options related to the man page output
859#---------------------------------------------------------------------------1349#---------------------------------------------------------------------------
8601350
861# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1351# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
862# generate man pages1352# generate man pages
8631353
864GENERATE_MAN = NO1354GENERATE_MAN = NO
8651355
866# The MAN_OUTPUT tag is used to specify where the man pages will be put. 1356# The MAN_OUTPUT tag is used to specify where the man pages will be put.
867# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1357# If a relative path is entered the value of OUTPUT_DIRECTORY will be
868# put in front of it. If left blank `man' will be used as the default path.1358# put in front of it. If left blank `man' will be used as the default path.
8691359
870MAN_OUTPUT = man1360MAN_OUTPUT = man
8711361
872# The MAN_EXTENSION tag determines the extension that is added to 1362# The MAN_EXTENSION tag determines the extension that is added to
873# the generated man pages (default is the subroutine's section .3)1363# the generated man pages (default is the subroutine's section .3)
8741364
875MAN_EXTENSION = .31365MAN_EXTENSION = .3
8761366
877# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1367# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
878# then it will generate one additional man file for each entity 1368# then it will generate one additional man file for each entity
879# documented in the real man page(s). These additional files 1369# documented in the real man page(s). These additional files
880# only source the real man page, but without them the man command 1370# only source the real man page, but without them the man command
881# would be unable to find the correct page. The default is NO.1371# would be unable to find the correct page. The default is NO.
8821372
883MAN_LINKS = NO1373MAN_LINKS = NO
@@ -886,33 +1376,33 @@
886# configuration options related to the XML output1376# configuration options related to the XML output
887#---------------------------------------------------------------------------1377#---------------------------------------------------------------------------
8881378
889# If the GENERATE_XML tag is set to YES Doxygen will 1379# If the GENERATE_XML tag is set to YES Doxygen will
890# generate an XML file that captures the structure of 1380# generate an XML file that captures the structure of
891# the code including all documentation.1381# the code including all documentation.
8921382
893GENERATE_XML = NO1383GENERATE_XML = NO
8941384
895# The XML_OUTPUT tag is used to specify where the XML pages will be put. 1385# The XML_OUTPUT tag is used to specify where the XML pages will be put.
896# If a relative path is entered the value of OUTPUT_DIRECTORY will be 1386# If a relative path is entered the value of OUTPUT_DIRECTORY will be
897# put in front of it. If left blank `xml' will be used as the default path.1387# put in front of it. If left blank `xml' will be used as the default path.
8981388
899XML_OUTPUT = xml1389XML_OUTPUT = xml
9001390
901# The XML_SCHEMA tag can be used to specify an XML schema, 1391# The XML_SCHEMA tag can be used to specify an XML schema,
902# which can be used by a validating XML parser to check the 1392# which can be used by a validating XML parser to check the
903# syntax of the XML files.1393# syntax of the XML files.
9041394
905XML_SCHEMA = 1395XML_SCHEMA =
9061396
907# The XML_DTD tag can be used to specify an XML DTD, 1397# The XML_DTD tag can be used to specify an XML DTD,
908# which can be used by a validating XML parser to check the 1398# which can be used by a validating XML parser to check the
909# syntax of the XML files.1399# syntax of the XML files.
9101400
911XML_DTD = 1401XML_DTD =
9121402
913# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1403# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
914# dump the program listings (including syntax highlighting 1404# dump the program listings (including syntax highlighting
915# and cross-referencing information) to the XML output. Note that 1405# and cross-referencing information) to the XML output. Note that
916# enabling this will significantly increase the size of the XML output.1406# enabling this will significantly increase the size of the XML output.
9171407
918XML_PROGRAMLISTING = YES1408XML_PROGRAMLISTING = YES
@@ -921,10 +1411,10 @@
921# configuration options for the AutoGen Definitions output1411# configuration options for the AutoGen Definitions output
922#---------------------------------------------------------------------------1412#---------------------------------------------------------------------------
9231413
924# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1414# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
925# generate an AutoGen Definitions (see autogen.sf.net) file 1415# generate an AutoGen Definitions (see autogen.sf.net) file
926# that captures the structure of the code including all 1416# that captures the structure of the code including all
927# documentation. Note that this feature is still experimental 1417# documentation. Note that this feature is still experimental
928# and incomplete at the moment.1418# and incomplete at the moment.
9291419
930GENERATE_AUTOGEN_DEF = NO1420GENERATE_AUTOGEN_DEF = NO
@@ -933,285 +1423,359 @@
933# configuration options related to the Perl module output1423# configuration options related to the Perl module output
934#---------------------------------------------------------------------------1424#---------------------------------------------------------------------------
9351425
936# If the GENERATE_PERLMOD tag is set to YES Doxygen will 1426# If the GENERATE_PERLMOD tag is set to YES Doxygen will
937# generate a Perl module file that captures the structure of 1427# generate a Perl module file that captures the structure of
938# the code including all documentation. Note that this 1428# the code including all documentation. Note that this
939# feature is still experimental and incomplete at the 1429# feature is still experimental and incomplete at the
940# moment.1430# moment.
9411431
942GENERATE_PERLMOD = NO1432GENERATE_PERLMOD = NO
9431433
944# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1434# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
945# the necessary Makefile rules, Perl scripts and LaTeX code to be able 1435# the necessary Makefile rules, Perl scripts and LaTeX code to be able
946# to generate PDF and DVI output from the Perl module output.1436# to generate PDF and DVI output from the Perl module output.
9471437
948PERLMOD_LATEX = NO1438PERLMOD_LATEX = NO
9491439
950# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1440# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
951# nicely formatted so it can be parsed by a human reader. This is useful 1441# nicely formatted so it can be parsed by a human reader.
952# if you want to understand what is going on. On the other hand, if this 1442# This is useful
953# tag is set to NO the size of the Perl module output will be much smaller 1443# if you want to understand what is going on.
1444# On the other hand, if this
1445# tag is set to NO the size of the Perl module output will be much smaller
954# and Perl will parse it just the same.1446# and Perl will parse it just the same.
9551447
956PERLMOD_PRETTY = YES1448PERLMOD_PRETTY = YES
9571449
958# The names of the make variables in the generated doxyrules.make file 1450# The names of the make variables in the generated doxyrules.make file
959# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1451# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
960# This is useful so different doxyrules.make files included by the same 1452# This is useful so different doxyrules.make files included by the same
961# Makefile don't overwrite each other's variables.1453# Makefile don't overwrite each other's variables.
9621454
963PERLMOD_MAKEVAR_PREFIX = 1455PERLMOD_MAKEVAR_PREFIX =
9641456
965#---------------------------------------------------------------------------1457#---------------------------------------------------------------------------
966# Configuration options related to the preprocessor 1458# Configuration options related to the preprocessor
967#---------------------------------------------------------------------------1459#---------------------------------------------------------------------------
9681460
969# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1461# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
970# evaluate all C-preprocessor directives found in the sources and include 1462# evaluate all C-preprocessor directives found in the sources and include
971# files.1463# files.
9721464
973ENABLE_PREPROCESSING = YES1465ENABLE_PREPROCESSING = YES
9741466
975# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1467# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
976# names in the source code. If set to NO (the default) only conditional 1468# names in the source code. If set to NO (the default) only conditional
977# compilation will be performed. Macro expansion can be done in a controlled 1469# compilation will be performed. Macro expansion can be done in a controlled
978# way by setting EXPAND_ONLY_PREDEF to YES.1470# way by setting EXPAND_ONLY_PREDEF to YES.
9791471
980MACRO_EXPANSION = YES1472MACRO_EXPANSION = YES
9811473
982# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1474# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
983# then the macro expansion is limited to the macros specified with the 1475# then the macro expansion is limited to the macros specified with the
984# PREDEFINED and EXPAND_AS_DEFINED tags.1476# PREDEFINED and EXPAND_AS_DEFINED tags.
9851477
986EXPAND_ONLY_PREDEF = YES1478EXPAND_ONLY_PREDEF = YES
9871479
988# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1480# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
989# in the INCLUDE_PATH (see below) will be search if a #include is found.1481# pointed to by INCLUDE_PATH will be searched when a #include is found.
9901482
991SEARCH_INCLUDES = YES1483SEARCH_INCLUDES = YES
9921484
993# The INCLUDE_PATH tag can be used to specify one or more directories that 1485# The INCLUDE_PATH tag can be used to specify one or more directories that
994# contain include files that are not input files but should be processed by 1486# contain include files that are not input files but should be processed by
995# the preprocessor.1487# the preprocessor.
9961488
997INCLUDE_PATH = 1489INCLUDE_PATH =
998# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1490
999# patterns (like *.h and *.hpp) to filter out the header-files in the 1491# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1000# directories. If left blank, the patterns specified with FILE_PATTERNS will 1492# patterns (like *.h and *.hpp) to filter out the header-files in the
1493# directories. If left blank, the patterns specified with FILE_PATTERNS will
1001# be used.1494# be used.
10021495
1003INCLUDE_FILE_PATTERNS = 1496INCLUDE_FILE_PATTERNS =
10041497
1005# The PREDEFINED tag can be used to specify one or more macro names that 1498# The PREDEFINED tag can be used to specify one or more macro names that
1006# are defined before the preprocessor is started (similar to the -D option of 1499# are defined before the preprocessor is started (similar to the -D option of
1007# gcc). The argument of the tag is a list of macros of the form: name 1500# gcc). The argument of the tag is a list of macros of the form: name
1008# or name=definition (no spaces). If the definition and the = are 1501# or name=definition (no spaces). If the definition and the = are
1009# omitted =1 is assumed. To prevent a macro definition from being 1502# omitted =1 is assumed. To prevent a macro definition from being
1010# undefined via #undef or recursively expanded use the := operator 1503# undefined via #undef or recursively expanded use the := operator
1011# instead of the = operator.1504# instead of the = operator.
10121505
1013PREDEFINED = 1506PREDEFINED =
10141507
1015# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1508# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1016# this tag can be used to specify a list of macro names that should be expanded. 1509# this tag can be used to specify a list of macro names that should be expanded.
1017# The macro definition that is found in the sources will be used. 1510# The macro definition that is found in the sources will be used.
1018# Use the PREDEFINED tag if you want to use a different macro definition.1511# Use the PREDEFINED tag if you want to use a different macro definition that
10191512# overrules the definition found in the source code.
1020EXPAND_AS_DEFINED = 1513
10211514EXPAND_AS_DEFINED =
1022# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1515
1023# doxygen's preprocessor will remove all function-like macros that are alone 1516# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1024# on a line, have an all uppercase name, and do not end with a semicolon. Such 1517# doxygen's preprocessor will remove all references to function-like macros
1025# function macros are typically used for boiler-plate code, and will confuse 1518# that are alone on a line, have an all uppercase name, and do not end with a
1026# the parser if not removed.1519# semicolon, because these will confuse the parser if not removed.
10271520
1028SKIP_FUNCTION_MACROS = YES1521SKIP_FUNCTION_MACROS = YES
10291522
1030#---------------------------------------------------------------------------1523#---------------------------------------------------------------------------
1031# Configuration::additions related to external references 1524# Configuration::additions related to external references
1032#---------------------------------------------------------------------------1525#---------------------------------------------------------------------------
10331526
1034# The TAGFILES option can be used to specify one or more tagfiles. 1527# The TAGFILES option can be used to specify one or more tagfiles.
1035# Optionally an initial location of the external documentation 1528# Optionally an initial location of the external documentation
1036# can be added for each tagfile. The format of a tag file without 1529# can be added for each tagfile. The format of a tag file without
1037# this location is as follows: 1530# this location is as follows:
1038# TAGFILES = file1 file2 ... 1531#
1039# Adding location for the tag files is done as follows: 1532# TAGFILES = file1 file2 ...
1040# TAGFILES = file1=loc1 "file2 = loc2" ... 1533# Adding location for the tag files is done as follows:
1041# where "loc1" and "loc2" can be relative or absolute paths or 1534#
1042# URLs. If a location is present for each tag, the installdox tool 1535# TAGFILES = file1=loc1 "file2 = loc2" ...
1536# where "loc1" and "loc2" can be relative or absolute paths or
1537# URLs. If a location is present for each tag, the installdox tool
1043# does not have to be run to correct the links.1538# does not have to be run to correct the links.
1044# Note that each tag file must have a unique name1539# Note that each tag file must have a unique name
1045# (where the name does NOT include the path)1540# (where the name does NOT include the path)
1046# If a tag file is not located in the directory in which doxygen 1541# If a tag file is not located in the directory in which doxygen
1047# is run, you must also specify the path to the tagfile here.1542# is run, you must also specify the path to the tagfile here.
10481543
1049TAGFILES = 1544TAGFILES =
10501545
1051# When a file name is specified after GENERATE_TAGFILE, doxygen will create 1546# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1052# a tag file that is based on the input files it reads.1547# a tag file that is based on the input files it reads.
10531548
1054GENERATE_TAGFILE = html/@PROJECT_NAME@.TAGFILE1549GENERATE_TAGFILE = html/@PROJECT_NAME@.TAGFILE
10551550
1056# If the ALLEXTERNALS tag is set to YES all external classes will be listed 1551# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1057# in the class index. If set to NO only the inherited external classes 1552# in the class index. If set to NO only the inherited external classes
1058# will be listed.1553# will be listed.
10591554
1060ALLEXTERNALS = YES1555ALLEXTERNALS = YES
10611556
1062# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1557# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1063# in the modules index. If set to NO, only the current project's groups will 1558# in the modules index. If set to NO, only the current project's groups will
1064# be listed.1559# be listed.
10651560
1066EXTERNAL_GROUPS = YES1561EXTERNAL_GROUPS = YES
10671562
1068# The PERL_PATH should be the absolute path and name of the perl script 1563# The PERL_PATH should be the absolute path and name of the perl script
1069# interpreter (i.e. the result of `which perl').1564# interpreter (i.e. the result of `which perl').
10701565
1071PERL_PATH = /usr/bin/perl1566PERL_PATH = /usr/bin/perl
10721567
1073#---------------------------------------------------------------------------1568#---------------------------------------------------------------------------
1074# Configuration options related to the dot tool 1569# Configuration options related to the dot tool
1075#---------------------------------------------------------------------------1570#---------------------------------------------------------------------------
10761571
1077# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1572# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1078# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1573# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1079# or super classes. Setting the tag to NO turns the diagrams off. Note that 1574# or super classes. Setting the tag to NO turns the diagrams off. Note that
1080# this option is superseded by the HAVE_DOT option below. This is only a 1575# this option also works with HAVE_DOT disabled, but it is recommended to
1081# fallback. It is recommended to install and use dot, since it yields more 1576# install and use dot, since it yields more powerful graphs.
1082# powerful graphs.
10831577
1084CLASS_DIAGRAMS = YES1578CLASS_DIAGRAMS = YES
10851579
1086# If set to YES, the inheritance and collaboration graphs will hide 1580# You can define message sequence charts within doxygen comments using the \msc
1087# inheritance and usage relations if the target is undocumented 1581# command. Doxygen will then run the mscgen tool (see
1582# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1583# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1584# the mscgen tool resides. If left empty the tool is assumed to be found in the
1585# default search path.
1586
1587MSCGEN_PATH =
1588
1589# If set to YES, the inheritance and collaboration graphs will hide
1590# inheritance and usage relations if the target is undocumented
1088# or is not a class.1591# or is not a class.
10891592
1090HIDE_UNDOC_RELATIONS = YES1593HIDE_UNDOC_RELATIONS = YES
10911594
1092# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1595# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1093# available from the path. This tool is part of Graphviz, a graph visualization 1596# available from the path. This tool is part of Graphviz, a graph visualization
1094# toolkit from AT&T and Lucent Bell Labs. The other options in this section 1597# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1095# have no effect if this option is set to NO (the default)1598# have no effect if this option is set to NO (the default)
10961599
1097HAVE_DOT = @DOXYGEN_DOT_FOUND@1600HAVE_DOT = @DOXYGEN_DOT_FOUND@
10981601
1099# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1602# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1100# will generate a graph for each documented class showing the direct and 1603# allowed to run in parallel. When set to 0 (the default) doxygen will
1101# indirect inheritance relations. Setting this tag to YES will force the 1604# base this on the number of processors available in the system. You can set it
1605# explicitly to a value larger than 0 to get control over the balance
1606# between CPU load and processing speed.
1607
1608DOT_NUM_THREADS = 0
1609
1610# By default doxygen will use the Helvetica font for all dot files that
1611# doxygen generates. When you want a differently looking font you can specify
1612# the font name using DOT_FONTNAME. You need to make sure dot is able to find
1613# the font, which can be done by putting it in a standard location or by setting
1614# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1615# directory containing the font.
1616
1617DOT_FONTNAME = Helvetica
1618
1619# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1620# The default size is 10pt.
1621
1622DOT_FONTSIZE = 10
1623
1624# By default doxygen will tell dot to use the Helvetica font.
1625# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
1626# set the path where dot can find it.
1627
1628DOT_FONTPATH =
1629
1630# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1631# will generate a graph for each documented class showing the direct and
1632# indirect inheritance relations. Setting this tag to YES will force the
1102# the CLASS_DIAGRAMS tag to NO.1633# the CLASS_DIAGRAMS tag to NO.
11031634
1104CLASS_GRAPH = YES1635CLASS_GRAPH = YES
11051636
1106# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1637# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1107# will generate a graph for each documented class showing the direct and 1638# will generate a graph for each documented class showing the direct and
1108# indirect implementation dependencies (inheritance, containment, and 1639# indirect implementation dependencies (inheritance, containment, and
1109# class references variables) of the class with other documented classes.1640# class references variables) of the class with other documented classes.
11101641
1111COLLABORATION_GRAPH = YES1642COLLABORATION_GRAPH = YES
11121643
1113# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1644# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1114# will generate a graph for groups, showing the direct groups dependencies1645# will generate a graph for groups, showing the direct groups dependencies
11151646
1116GROUP_GRAPHS = YES1647GROUP_GRAPHS = YES
11171648
1118# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1649# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1119# collaboration diagrams in a style similar to the OMG's Unified Modeling 1650# collaboration diagrams in a style similar to the OMG's Unified Modeling
1120# Language.1651# Language.
11211652
1122UML_LOOK = NO1653UML_LOOK = NO
1123# UML_LOOK = YES
11241654
1125# If set to YES, the inheritance and collaboration graphs will show the 1655# If set to YES, the inheritance and collaboration graphs will show the
1126# relations between templates and their instances.1656# relations between templates and their instances.
11271657
1128TEMPLATE_RELATIONS = YES1658TEMPLATE_RELATIONS = YES
11291659
1130# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1660# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1131# tags are set to YES then doxygen will generate a graph for each documented 1661# tags are set to YES then doxygen will generate a graph for each documented
1132# file showing the direct and indirect include dependencies of the file with 1662# file showing the direct and indirect include dependencies of the file with
1133# other documented files.1663# other documented files.
11341664
1135INCLUDE_GRAPH = YES1665INCLUDE_GRAPH = YES
11361666
1137# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1667# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1138# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1668# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1139# documented header file showing the documented files that directly or 1669# documented header file showing the documented files that directly or
1140# indirectly include this file.1670# indirectly include this file.
11411671
1142INCLUDED_BY_GRAPH = YES1672INCLUDED_BY_GRAPH = YES
11431673
1144# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1674# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1145# generate a call dependency graph for every global function or class method. 1675# doxygen will generate a call dependency graph for every global function
1146# Note that enabling this option will significantly increase the time of a run. 1676# or class method. Note that enabling this option will significantly increase
1147# So in most cases it will be better to enable call graphs for selected 1677# the time of a run. So in most cases it will be better to enable call graphs
1148# functions only using the \callgraph command.1678# for selected functions only using the \callgraph command.
11491679
1150CALL_GRAPH = NO1680CALL_GRAPH = NO
11511681
1152# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1682# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1153# will graphical hierarchy of all classes instead of a textual one.1683# doxygen will generate a caller dependency graph for every global function
1684# or class method. Note that enabling this option will significantly increase
1685# the time of a run. So in most cases it will be better to enable caller
1686# graphs for selected functions only using the \callergraph command.
1687
1688CALLER_GRAPH = NO
1689
1690# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1691# will generate a graphical hierarchy of all classes instead of a textual one.
11541692
1155GRAPHICAL_HIERARCHY = YES1693GRAPHICAL_HIERARCHY = YES
11561694
1157# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1695# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1158# then doxygen will show the dependencies a directory has on other directories 1696# then doxygen will show the dependencies a directory has on other directories
1159# in a graphical way. The dependency relations are determined by the #include1697# in a graphical way. The dependency relations are determined by the #include
1160# relations between the files in the directories.1698# relations between the files in the directories.
11611699
1162DIRECTORY_GRAPH = YES1700DIRECTORY_GRAPH = YES
11631701
1164# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1702# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1165# generated by dot. Possible values are png, jpg, or gif1703# generated by dot. Possible values are svg, png, jpg, or gif.
1166# If left blank png will be used.1704# If left blank png will be used. If you choose svg you need to set
1705# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1706# visible in IE 9+ (other browsers do not have this requirement).
11671707
1168DOT_IMAGE_FORMAT = png1708DOT_IMAGE_FORMAT = png
11691709
1170# The tag DOT_PATH can be used to specify the path where the dot tool can be 1710# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
1711# enable generation of interactive SVG images that allow zooming and panning.
1712# Note that this requires a modern browser other than Internet Explorer.
1713# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
1714# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
1715# visible. Older versions of IE do not have SVG support.
1716
1717INTERACTIVE_SVG = NO
1718
1719# The tag DOT_PATH can be used to specify the path where the dot tool can be
1171# found. If left blank, it is assumed the dot tool can be found in the path.1720# found. If left blank, it is assumed the dot tool can be found in the path.
11721721
1173DOT_PATH = @DOXYGEN_DOT_EXECUTABLE_PATH@1722DOT_PATH = @DOXYGEN_DOT_EXECUTABLE_PATH@
11741723
1175# The DOTFILE_DIRS tag can be used to specify one or more directories that 1724# The DOTFILE_DIRS tag can be used to specify one or more directories that
1176# contain dot files that are included in the documentation (see the 1725# contain dot files that are included in the documentation (see the
1177# \dotfile command).1726# \dotfile command).
11781727
1179DOTFILE_DIRS = 1728DOTFILE_DIRS =
11801729
1181# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1730# The MSCFILE_DIRS tag can be used to specify one or more directories that
1182# background. This is disabled by default, which results in a white background. 1731# contain msc files that are included in the documentation (see the
1183# Warning: Depending on the platform used, enabling this option may lead to 1732# \mscfile command).
1184# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1733
1185# read).1734MSCFILE_DIRS =
1735
1736# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1737# nodes that will be shown in the graph. If the number of nodes in a graph
1738# becomes larger than this value, doxygen will truncate the graph, which is
1739# visualized by representing a node as a red box. Note that doxygen if the
1740# number of direct children of the root node in a graph is already larger than
1741# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1742# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1743
1744DOT_GRAPH_MAX_NODES = 50
1745
1746# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1747# graphs generated by dot. A depth value of 3 means that only nodes reachable
1748# from the root by following a path via at most 3 edges will be shown. Nodes
1749# that lay further from the root node will be omitted. Note that setting this
1750# option to 1 or 2 may greatly reduce the computation time needed for large
1751# code bases. Also note that the size of a graph can be further restricted by
1752# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1753
1754MAX_DOT_GRAPH_DEPTH = 0
1755
1756# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1757# background. This is disabled by default, because dot on Windows does not
1758# seem to support this out of the box. Warning: Depending on the platform used,
1759# enabling this option may lead to badly anti-aliased labels on the edges of
1760# a graph (i.e. they become hard to read).
11861761
1187DOT_TRANSPARENT = NO1762DOT_TRANSPARENT = NO
11881763
1189# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1764# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1190# files in one run (i.e. multiple -o and -T options on the command line). This 1765# files in one run (i.e. multiple -o and -T options on the command line). This
1191# makes dot run faster, but since only newer versions of dot (>1.8.10) 1766# makes dot run faster, but since only newer versions of dot (>1.8.10)
1192# support this, this feature is disabled by default.1767# support this, this feature is disabled by default.
1193# JW1768
1194# DOT_MULTI_TARGETS = NO
1195DOT_MULTI_TARGETS = YES1769DOT_MULTI_TARGETS = YES
11961770
1197# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1771# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1198# generate a legend page explaining the meaning of the various boxes and 1772# generate a legend page explaining the meaning of the various boxes and
1199# arrows in the dot generated graphs.1773# arrows in the dot generated graphs.
12001774
1201GENERATE_LEGEND = YES1775GENERATE_LEGEND = YES
12021776
1203# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1777# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1204# remove the intermediate dot files that are used to generate 1778# remove the intermediate dot files that are used to generate
1205# the various graphs.1779# the various graphs.
12061780
1207DOT_CLEANUP = YES1781DOT_CLEANUP = YES
1208
1209#---------------------------------------------------------------------------
1210# Configuration::additions related to the search engine
1211#---------------------------------------------------------------------------
1212
1213# The SEARCHENGINE tag specifies whether or not a search engine should be
1214# used. If set to NO the values of all tags below this one will be ignored.
1215
1216# JW SEARCHENGINE = NO
1217SEARCHENGINE = YES
12181782
=== modified file 'doc/java/doxy.config.in' (properties changed: +x to -x)
--- doc/java/doxy.config.in 2010-07-14 12:32:17 +0000
+++ doc/java/doxy.config.in 2012-03-15 17:14:22 +0000
@@ -1,442 +1,623 @@
1# Doxyfile 1.4.51# Doxyfile 1.7.5
22
3# This file describes the settings to be used by the documentation system3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project4# doxygen (www.doxygen.org) for a project.
5#5#
6# All text after a hash (#) is considered a comment and will be ignored6# All text after a hash (#) is considered a comment and will be ignored.
7# The format is:7# The format is:
8# TAG = value [value, ...]8# TAG = value [value, ...]
9# For lists items can also be appended using:9# For lists items can also be appended using:
10# TAG += value [value, ...]10# TAG += value [value, ...]
11# Values that contain spaces should be placed between quotes (" ")11# Values that contain spaces should be placed between quotes (" ").
1212
13#---------------------------------------------------------------------------13#---------------------------------------------------------------------------
14# Project related configuration options14# Project related configuration options
15#---------------------------------------------------------------------------15#---------------------------------------------------------------------------
1616
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 17# This tag specifies the encoding used for all characters in the config file
18# by quotes) that should identify the project.18# that follow. The default is UTF-8 which is also the encoding used for all
19# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20# iconv built into libc) for the transcoding. See
21# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23DOXYFILE_ENCODING = UTF-8
24
25# The PROJECT_NAME tag is a single word (or sequence of words) that should
26# identify the project. Note that if you do not use Doxywizard you need
27# to put quotes around the project name if it contains spaces.
1928
20PROJECT_NAME = Zorba Java-API29PROJECT_NAME = Zorba Java-API
2130
22# The PROJECT_NUMBER tag can be used to enter a project or revision number. 31# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or 32# This could be handy for archiving the generated documentation or
24# if some version control system is used.33# if some version control system is used.
2534
26PROJECT_NUMBER = @ZORBA_MAJOR_NUMBER@.@ZORBA_MINOR_NUMBER@.@ZORBA_PATCH_NUMBER@35PROJECT_NUMBER = @ZORBA_MAJOR_NUMBER@.@ZORBA_MINOR_NUMBER@.@ZORBA_PATCH_NUMBER@
2736
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 37# Using the PROJECT_BRIEF tag one can provide an optional one line description
29# base path where the generated documentation will be put. 38# for a project that appears at the top of each page and should give viewer
30# If a relative path is entered, it will be relative to the location 39# a quick idea about the purpose of the project. Keep the description short.
40
41PROJECT_BRIEF =
42
43# With the PROJECT_LOGO tag one can specify an logo or icon that is
44# included in the documentation. The maximum height of the logo should not
45# exceed 55 pixels and the maximum width should not exceed 200 pixels.
46# Doxygen will copy the logo to the output directory.
47
48PROJECT_LOGO =
49
50# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
51# base path where the generated documentation will be put.
52# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.53# where doxygen was started. If left blank the current directory will be used.
3254
33OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@55OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
3456
35# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 57# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36# 4096 sub-directories (in 2 levels) under the output directory of each output 58# 4096 sub-directories (in 2 levels) under the output directory of each output
37# format and will distribute the generated files over these directories. 59# format and will distribute the generated files over these directories.
38# Enabling this option can be useful when feeding doxygen a huge amount of 60# Enabling this option can be useful when feeding doxygen a huge amount of
39# source files, where putting all generated files in the same directory would 61# source files, where putting all generated files in the same directory would
40# otherwise cause performance problems for the file system.62# otherwise cause performance problems for the file system.
4163
42CREATE_SUBDIRS = NO64CREATE_SUBDIRS = NO
4365
44# The OUTPUT_LANGUAGE tag is used to specify the language in which all 66# The OUTPUT_LANGUAGE tag is used to specify the language in which all
45# documentation generated by doxygen is written. Doxygen will use this 67# documentation generated by doxygen is written. Doxygen will use this
46# information to generate all constant output in the proper language. 68# information to generate all constant output in the proper language.
47# The default language is English, other supported languages are: 69# The default language is English, other supported languages are:
48# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 70# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
49# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 71# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
50# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 72# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
51# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 73# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
52# Swedish, and Ukrainian.74# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
5376
54OUTPUT_LANGUAGE = English77OUTPUT_LANGUAGE = English
5578
56# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 79# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
57# include brief member descriptions after the members that are listed in 80# include brief member descriptions after the members that are listed in
58# the file and class documentation (similar to JavaDoc). 81# the file and class documentation (similar to JavaDoc).
59# Set to NO to disable this.82# Set to NO to disable this.
6083
61BRIEF_MEMBER_DESC = YES84BRIEF_MEMBER_DESC = YES
6285
63# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 86# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
64# the brief description of a member or function before the detailed description. 87# the brief description of a member or function before the detailed description.
65# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 88# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66# brief descriptions will be completely suppressed.89# brief descriptions will be completely suppressed.
6790
68REPEAT_BRIEF = YES91REPEAT_BRIEF = YES
6992
70# This tag implements a quasi-intelligent brief description abbreviator 93# This tag implements a quasi-intelligent brief description abbreviator
71# that is used to form the text in various listings. Each string 94# that is used to form the text in various listings. Each string
72# in this list, if found as the leading text of the brief description, will be 95# in this list, if found as the leading text of the brief description, will be
73# stripped from the text and the result after processing the whole list, is 96# stripped from the text and the result after processing the whole list, is
74# used as the annotated text. Otherwise, the brief description is used as-is. 97# used as the annotated text. Otherwise, the brief description is used as-is.
75# If left blank, the following values are used ("$name" is automatically 98# If left blank, the following values are used ("$name" is automatically
76# replaced with the name of the entity): "The $name class" "The $name widget" 99# replaced with the name of the entity): "The $name class" "The $name widget"
77# "The $name file" "is" "provides" "specifies" "contains" 100# "The $name file" "is" "provides" "specifies" "contains"
78# "represents" "a" "an" "the"101# "represents" "a" "an" "the"
79102
80ABBREVIATE_BRIEF = 103ABBREVIATE_BRIEF =
81104
82# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 105# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
83# Doxygen will generate a detailed section even if there is only a brief 106# Doxygen will generate a detailed section even if there is only a brief
84# description.107# description.
85108
86ALWAYS_DETAILED_SEC = NO109ALWAYS_DETAILED_SEC = NO
87110
88# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 111# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
89# inherited members of a class in the documentation of that class as if those 112# inherited members of a class in the documentation of that class as if those
90# members were ordinary class members. Constructors, destructors and assignment 113# members were ordinary class members. Constructors, destructors and assignment
91# operators of the base classes will not be shown.114# operators of the base classes will not be shown.
92115
93INLINE_INHERITED_MEMB = YES116INLINE_INHERITED_MEMB = YES
94117
95# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 118# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
96# path before files name in the file list and in the header files. If set 119# path before files name in the file list and in the header files. If set
97# to NO the shortest path that makes the file name unique will be used.120# to NO the shortest path that makes the file name unique will be used.
98121
99FULL_PATH_NAMES = NO122FULL_PATH_NAMES = NO
100123
101# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 124# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
102# can be used to strip a user-defined part of the path. Stripping is 125# can be used to strip a user-defined part of the path. Stripping is
103# only done if one of the specified strings matches the left-hand part of 126# only done if one of the specified strings matches the left-hand part of
104# the path. The tag can be used to show relative paths in the file list. 127# the path. The tag can be used to show relative paths in the file list.
105# If left blank the directory from which doxygen is run is used as the 128# If left blank the directory from which doxygen is run is used as the
106# path to strip.129# path to strip.
107130
108STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src @CMAKE_BINARY_DIR@/src131STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src \
109132 @CMAKE_BINARY_DIR@/src
110133
111# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 134# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
112# the path mentioned in the documentation of a class, which tells 135# the path mentioned in the documentation of a class, which tells
113# the reader which header file to include in order to use a class. 136# the reader which header file to include in order to use a class.
114# If left blank only the name of the header file containing the class 137# If left blank only the name of the header file containing the class
115# definition is used. Otherwise one should specify the include paths that 138# definition is used. Otherwise one should specify the include paths that
116# are normally passed to the compiler using the -I flag.139# are normally passed to the compiler using the -I flag.
117140
118STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include @CMAKE_BINARY_DIR@/include141STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include \
142 @CMAKE_BINARY_DIR@/include
119143
120# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 144# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
121# (but less readable) file names. This can be useful is your file systems 145# (but less readable) file names. This can be useful if your file system
122# doesn't support long names like on DOS, Mac, or CD-ROM.146# doesn't support long names like on DOS, Mac, or CD-ROM.
123147
124SHORT_NAMES = NO148SHORT_NAMES = NO
125149
126# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 150# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
127# will interpret the first line (until the first dot) of a JavaDoc-style 151# will interpret the first line (until the first dot) of a JavaDoc-style
128# comment as the brief description. If set to NO, the JavaDoc 152# comment as the brief description. If set to NO, the JavaDoc
129# comments will behave just like the Qt-style comments (thus requiring an 153# comments will behave just like regular Qt-style comments
130# explicit @brief command for a brief description.154# (thus requiring an explicit @brief command for a brief description.)
131155
132JAVADOC_AUTOBRIEF = YES156JAVADOC_AUTOBRIEF = YES
133157
134# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 158# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
135# treat a multi-line C++ special comment block (i.e. a block of //! or /// 159# interpret the first line (until the first dot) of a Qt-style
136# comments) as a brief description. This used to be the default behaviour. 160# comment as the brief description. If set to NO, the comments
137# The new default is to treat a multi-line C++ comment block as a detailed 161# will behave just like regular Qt-style comments (thus requiring
162# an explicit \brief command for a brief description.)
163
164QT_AUTOBRIEF = NO
165
166# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
167# treat a multi-line C++ special comment block (i.e. a block of //! or ///
168# comments) as a brief description. This used to be the default behaviour.
169# The new default is to treat a multi-line C++ comment block as a detailed
138# description. Set this tag to YES if you prefer the old behaviour instead.170# description. Set this tag to YES if you prefer the old behaviour instead.
139171
140MULTILINE_CPP_IS_BRIEF = NO172MULTILINE_CPP_IS_BRIEF = NO
141173
142# If the DETAILS_AT_TOP tag is set to YES then Doxygen 174# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
143# will output the detailed description near the top, like JavaDoc.175# member inherits the documentation from any documented member that it
144# If set to NO, the detailed description appears after the member
145# documentation.
146
147DETAILS_AT_TOP = NO
148
149# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
150# member inherits the documentation from any documented member that it
151# re-implements.176# re-implements.
152177
153INHERIT_DOCS = YES178INHERIT_DOCS = YES
154179
155# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 180# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
156# a new page for each member. If set to NO, the documentation of a member will 181# a new page for each member. If set to NO, the documentation of a member will
157# be part of the file/class/namespace that contains it.182# be part of the file/class/namespace that contains it.
158183
159SEPARATE_MEMBER_PAGES = NO184SEPARATE_MEMBER_PAGES = NO
160185
161# The TAB_SIZE tag can be used to set the number of spaces in a tab. 186# The TAB_SIZE tag can be used to set the number of spaces in a tab.
162# Doxygen uses this value to replace tabs by spaces in code fragments.187# Doxygen uses this value to replace tabs by spaces in code fragments.
163188
164TAB_SIZE = 2189TAB_SIZE = 2
165190
166# This tag can be used to specify a number of aliases that acts 191# This tag can be used to specify a number of aliases that acts
167# as commands in the documentation. An alias has the form "name=value". 192# as commands in the documentation. An alias has the form "name=value".
168# For example adding "sideeffect=\par Side Effects:\n" will allow you to 193# For example adding "sideeffect=\par Side Effects:\n" will allow you to
169# put the command \sideeffect (or @sideeffect) in the documentation, which 194# put the command \sideeffect (or @sideeffect) in the documentation, which
170# will result in a user-defined paragraph with heading "Side Effects:". 195# will result in a user-defined paragraph with heading "Side Effects:".
171# You can put \n's in the value part of an alias to insert newlines.196# You can put \n's in the value part of an alias to insert newlines.
172197
173ALIASES = 198ALIASES =
174199
175# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 200# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
176# sources only. Doxygen will then generate output that is more tailored for C. 201# sources only. Doxygen will then generate output that is more tailored for C.
177# For instance, some of the names that are used will be different. The list 202# For instance, some of the names that are used will be different. The list
178# of all members will be omitted, etc.203# of all members will be omitted, etc.
179204
180OPTIMIZE_OUTPUT_FOR_C = YES205OPTIMIZE_OUTPUT_FOR_C = YES
181206
182# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 207# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
183# sources only. Doxygen will then generate output that is more tailored for Java. 208# sources only. Doxygen will then generate output that is more tailored for
184# For instance, namespaces will be presented as packages, qualified scopes 209# Java. For instance, namespaces will be presented as packages, qualified
185# will look different, etc.210# scopes will look different, etc.
186211
187OPTIMIZE_OUTPUT_JAVA = NO212OPTIMIZE_OUTPUT_JAVA = NO
188213
189# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 214# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
190# include (a tag file for) the STL sources as input, then you should 215# sources only. Doxygen will then generate output that is more tailored for
191# set this tag to YES in order to let doxygen match functions declarations and 216# Fortran.
192# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 217
193# func(std::string) {}). This also make the inheritance and collaboration 218OPTIMIZE_FOR_FORTRAN = NO
219
220# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
221# sources. Doxygen will then generate output that is tailored for
222# VHDL.
223
224OPTIMIZE_OUTPUT_VHDL = NO
225
226# Doxygen selects the parser to use depending on the extension of the files it
227# parses. With this tag you can assign which parser to use for a given extension.
228# Doxygen has a built-in mapping, but you can override or extend it using this
229# tag. The format is ext=language, where ext is a file extension, and language
230# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
231# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
232# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
233# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
234# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
235
236EXTENSION_MAPPING =
237
238# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
239# to include (a tag file for) the STL sources as input, then you should
240# set this tag to YES in order to let doxygen match functions declarations and
241# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
242# 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