« back to all changes in this revision
Viewing changes to doc/c/doxy.config.in
- browse files at revision 10723
- compare with another revision
- download diff
- download tarball
- view history from revision 10723
- Committer: Tarmac
- Author(s): Sorin Marian Nasoi
- Date: 2012-03-16 12:38:03 UTC
- mfrom: (10720.2.8 fix_warnings_fedora)
- Revision ID: tarmac-20120316123803-o22n385z0sbijhx2
Fixed warnings that appear in Fedora. Approved: William Candillon, Sorin Marian Nasoi, Matthias Brantner
- files modified:
- doc/c/doxy.config.in
added
removed
doc/c/doxy.config.in
1
# Doxyfile 1.4.5
1
# Doxyfile 1.7.5
2
2
3
3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
4
# doxygen (www.doxygen.org) for a project.
5
5
#
6
# All text after a hash (#) is considered a comment and will be ignored
6
# All text after a hash (#) is considered a comment and will be ignored.
7
7
# The format is:
8
8
# TAG = value [value, ...]
9
9
# For lists items can also be appended using:
10
10
# TAG += value [value, ...]
11
# Values that contain spaces should be placed between quotes (" ")
11
# Values that contain spaces should be placed between quotes (" ").
12
12
13
13
#---------------------------------------------------------------------------
14
14
# Project related configuration options
15
15
#---------------------------------------------------------------------------
16
16
17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18
# by quotes) that should identify the project.
19
20
PROJECT_NAME = Zorba C-API
21
22
# 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
17
# This tag specifies the encoding used for all characters in the config file
18
# that follow. The default is UTF-8 which is also the encoding used for all
19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20
# iconv built into libc) for the transcoding. See
21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23
DOXYFILE_ENCODING = UTF-8
24
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.
28
29
PROJECT_NAME = "Zorba C-API"
30
31
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
32
# This could be handy for archiving the generated documentation or
24
33
# if some version control system is used.
25
34
26
35
PROJECT_NUMBER = @ZORBA_MAJOR_NUMBER@.@ZORBA_MINOR_NUMBER@.@ZORBA_PATCH_NUMBER@
27
36
28
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29
# base path where the generated documentation will be put.
30
# If a relative path is entered, it will be relative to the location
37
# Using the PROJECT_BRIEF tag one can provide an optional one line description
38
# for a project that appears at the top of each page and should give viewer
39
# a quick idea about the purpose of the project. Keep the description short.
40
41
PROJECT_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
48
PROJECT_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
53
# where doxygen was started. If left blank the current directory will be used.
32
54
33
55
OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
34
56
35
# 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
37
# format and will distribute the generated files over these directories.
38
# 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
57
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
58
# 4096 sub-directories (in 2 levels) under the output directory of each output
59
# format and will distribute the generated files over these directories.
60
# Enabling this option can be useful when feeding doxygen a huge amount of
61
# source files, where putting all generated files in the same directory would
40
62
# otherwise cause performance problems for the file system.
41
63
42
64
CREATE_SUBDIRS = NO
43
65
44
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
45
# documentation generated by doxygen is written. Doxygen will use this
46
# information to generate all constant output in the proper language.
47
# The default language is English, other supported languages are:
48
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
49
# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
50
# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
51
# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
52
# Swedish, and Ukrainian.
66
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
67
# documentation generated by doxygen is written. Doxygen will use this
68
# information to generate all constant output in the proper language.
69
# The default language is English, other supported languages are:
70
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
53
76
54
77
OUTPUT_LANGUAGE = English
55
78
56
# 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
58
# the file and class documentation (similar to JavaDoc).
79
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
80
# include brief member descriptions after the members that are listed in
81
# the file and class documentation (similar to JavaDoc).
59
82
# Set to NO to disable this.
60
83
61
84
BRIEF_MEMBER_DESC = YES
62
85
63
# 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.
65
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
86
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
87
# the brief description of a member or function before the detailed description.
88
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
66
89
# brief descriptions will be completely suppressed.
67
90
68
91
REPEAT_BRIEF = YES
69
92
70
# This tag implements a quasi-intelligent brief description abbreviator
71
# 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
73
# 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.
75
# 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"
77
# "The $name file" "is" "provides" "specifies" "contains"
93
# This tag implements a quasi-intelligent brief description abbreviator
94
# that is used to form the text in various listings. Each string
95
# in this list, if found as the leading text of the brief description, will be
96
# stripped from the text and the result after processing the whole list, is
97
# used as the annotated text. Otherwise, the brief description is used as-is.
98
# If left blank, the following values are used ("$name" is automatically
99
# replaced with the name of the entity): "The $name class" "The $name widget"
100
# "The $name file" "is" "provides" "specifies" "contains"
78
101
# "represents" "a" "an" "the"
79
102
80
ABBREVIATE_BRIEF =
103
ABBREVIATE_BRIEF =
81
104
82
# 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
105
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
106
# Doxygen will generate a detailed section even if there is only a brief
84
107
# description.
85
108
86
109
ALWAYS_DETAILED_SEC = NO
87
110
88
# 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
90
# members were ordinary class members. Constructors, destructors and assignment
111
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
112
# inherited members of a class in the documentation of that class as if those
113
# members were ordinary class members. Constructors, destructors and assignment
91
114
# operators of the base classes will not be shown.
92
115
93
116
INLINE_INHERITED_MEMB = YES
94
117
95
# 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
118
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
119
# path before files name in the file list and in the header files. If set
97
120
# to NO the shortest path that makes the file name unique will be used.
98
121
99
122
FULL_PATH_NAMES = NO
100
123
101
# 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
103
# 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.
105
# If left blank the directory from which doxygen is run is used as the
124
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
125
# can be used to strip a user-defined part of the path. Stripping is
126
# only done if one of the specified strings matches the left-hand part of
127
# the path. The tag can be used to show relative paths in the file list.
128
# If left blank the directory from which doxygen is run is used as the
106
129
# path to strip.
107
130
108
STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src @CMAKE_BINARY_DIR@/src
109
110
111
# 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
113
# 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
115
# definition is used. Otherwise one should specify the include paths that
131
STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src \
132
@CMAKE_BINARY_DIR@/src
133
134
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
135
# the path mentioned in the documentation of a class, which tells
136
# the reader which header file to include in order to use a class.
137
# If left blank only the name of the header file containing the class
138
# definition is used. Otherwise one should specify the include paths that
116
139
# are normally passed to the compiler using the -I flag.
117
140
118
STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include @CMAKE_BINARY_DIR@/include
141
STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/include \
142
@CMAKE_BINARY_DIR@/include
119
143
120
# 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
144
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
145
# (but less readable) file names. This can be useful if your file system
122
146
# doesn't support long names like on DOS, Mac, or CD-ROM.
123
147
124
148
SHORT_NAMES = NO
125
149
126
# 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
128
# comment as the brief description. If set to NO, the JavaDoc
129
# comments will behave just like the Qt-style comments (thus requiring an
130
# explicit @brief command for a brief description.
150
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
151
# will interpret the first line (until the first dot) of a JavaDoc-style
152
# comment as the brief description. If set to NO, the JavaDoc
153
# comments will behave just like regular Qt-style comments
154
# (thus requiring an explicit @brief command for a brief description.)
131
155
132
156
JAVADOC_AUTOBRIEF = YES
133
157
134
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
135
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
136
# comments) as a brief description. This used to be the default behaviour.
137
# The new default is to treat a multi-line C++ comment block as a detailed
158
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
159
# interpret the first line (until the first dot) of a Qt-style
160
# comment as the brief description. If set to NO, the comments
161
# will behave just like regular Qt-style comments (thus requiring
162
# an explicit \brief command for a brief description.)
163
164
QT_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
170
# description. Set this tag to YES if you prefer the old behaviour instead.
139
171
140
172
MULTILINE_CPP_IS_BRIEF = NO
141
173
142
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
143
# will output the detailed description near the top, like JavaDoc.
144
# If set to NO, the detailed description appears after the member
145
# documentation.
146
147
DETAILS_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
174
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
175
# member inherits the documentation from any documented member that it
151
176
# re-implements.
152
177
153
178
INHERIT_DOCS = YES
154
179
155
# 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
180
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
181
# a new page for each member. If set to NO, the documentation of a member will
157
182
# be part of the file/class/namespace that contains it.
158
183
159
184
SEPARATE_MEMBER_PAGES = NO
160
185
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
187
# Doxygen uses this value to replace tabs by spaces in code fragments.
163
188
164
189
TAB_SIZE = 2
165
190
166
# 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".
168
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
169
# put the command \sideeffect (or @sideeffect) in the documentation, which
170
# will result in a user-defined paragraph with heading "Side Effects:".
191
# This tag can be used to specify a number of aliases that acts
192
# as commands in the documentation. An alias has the form "name=value".
193
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
194
# put the command \sideeffect (or @sideeffect) in the documentation, which
195
# will result in a user-defined paragraph with heading "Side Effects:".
171
196
# You can put \n's in the value part of an alias to insert newlines.
172
197
173
ALIASES =
198
ALIASES =
174
199
175
# 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.
177
# For instance, some of the names that are used will be different. The list
200
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
201
# sources only. Doxygen will then generate output that is more tailored for C.
202
# For instance, some of the names that are used will be different. The list
178
203
# of all members will be omitted, etc.
179
204
180
205
OPTIMIZE_OUTPUT_FOR_C = YES
181
206
182
# 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.
184
# For instance, namespaces will be presented as packages, qualified scopes
185
# will look different, etc.
207
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
208
# sources only. Doxygen will then generate output that is more tailored for
209
# Java. For instance, namespaces will be presented as packages, qualified
210
# scopes will look different, etc.
186
211
187
212
OPTIMIZE_OUTPUT_JAVA = NO
188
213
189
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
190
# include (a tag file for) the STL sources as input, then you should
191
# set this tag to YES in order to let doxygen match functions declarations and
192
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
193
# func(std::string) {}). This also make the inheritance and collaboration
214
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
215
# sources only. Doxygen will then generate output that is more tailored for
216
# Fortran.
217
218
OPTIMIZE_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
224
OPTIMIZE_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
236
EXTENSION_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
243
# diagrams that involve STL classes more complete and accurate.
195
244
196
# BUILTIN_STL_SUPPORT = NO
197
198
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
199
# tag is set to YES, then doxygen will reuse the documentation of the first
200
# member in the group (if any) for the other members of the group. By default
245
BUILTIN_STL_SUPPORT = NO
246
247
# If you use Microsoft's C++/CLI language, you should set this option to YES to
248
# enable parsing support.
249
250
CPP_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
256
SIP_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
265
IDL_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
270
# all members of a group must be documented explicitly.
202
271
203
272
DISTRIBUTE_GROUP_DOC = NO
204
273
205
# 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
207
# 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
274
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
275
# the same type (for instance a group of public functions) to be put as a
276
# subgroup of that type (e.g. under the Public Functions section). Set it to
277
# NO to prevent subgrouping. Alternatively, this can be done per class using
209
278
# the \nosubgrouping command.
210
279
211
280
SUBGROUPING = YES
212
281
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
287
INLINE_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
296
INLINE_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
306
TYPEDEF_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
322
SYMBOL_CACHE_SIZE = 0
323
213
324
#---------------------------------------------------------------------------
214
325
# Build related configuration options
215
326
#---------------------------------------------------------------------------
216
327
217
# 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.
219
# Private class members and static file members will be hidden unless
328
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
329
# documentation are documented, even if no documentation was available.
330
# Private class members and static file members will be hidden unless
220
331
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
221
332
222
333
EXTRACT_ALL = YES
223
334
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
336
# will be included in the documentation.
226
337
227
338
EXTRACT_PRIVATE = NO
228
339
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
341
# will be included in the documentation.
231
342
232
343
EXTRACT_STATIC = NO
233
344
234
# 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.
345
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
346
# defined locally in source files will be included in the documentation.
236
347
# If set to NO only classes defined in header files are included.
237
348
238
349
EXTRACT_LOCAL_CLASSES = YES
239
350
240
# 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
242
# the interface are included in the documentation.
351
# This flag is only useful for Objective-C code. When set to YES local
352
# methods, which are defined in the implementation section but not in
353
# the interface are included in the documentation.
243
354
# If set to NO (the default) only methods in the interface are included.
244
355
245
356
EXTRACT_LOCAL_METHODS = NO
246
357
247
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
248
# undocumented members of documented classes, files or namespaces.
249
# If set to NO (the default) these members will be included in the
250
# various overviews, but no documentation section is generated.
358
# If this flag is set to YES, the members of anonymous namespaces will be
359
# extracted and appear in the documentation as a namespace called
360
# 'anonymous_namespace{file}', where file will be replaced with the base
361
# name of the file that contains the anonymous namespace. By default
362
# anonymous namespaces are hidden.
363
364
EXTRACT_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
370
# This option has no effect if EXTRACT_ALL is enabled.
252
371
253
372
HIDE_UNDOC_MEMBERS = YES
254
373
255
# 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.
257
# If set to NO (the default) these classes will be included in the various
374
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
375
# undocumented classes that are normally visible in the class hierarchy.
376
# If set to NO (the default) these classes will be included in the various
258
377
# overviews. This option has no effect if EXTRACT_ALL is enabled.
259
378
260
379
HIDE_UNDOC_CLASSES = YES
261
380
262
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
263
# friend (class|struct|union) declarations.
264
# If set to NO (the default) these declarations will be included in the
381
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
382
# friend (class|struct|union) declarations.
383
# If set to NO (the default) these declarations will be included in the
265
384
# documentation.
266
385
267
386
HIDE_FRIEND_COMPOUNDS = NO
268
387
269
# 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.
271
# If set to NO (the default) these blocks will be appended to the
388
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
389
# documentation blocks found inside the body of a function.
390
# If set to NO (the default) these blocks will be appended to the
272
391
# function's detailed documentation block.
273
392
274
393
HIDE_IN_BODY_DOCS = NO
275
394
276
# The INTERNAL_DOCS tag determines if documentation
277
# 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.
395
# The INTERNAL_DOCS tag determines if documentation
396
# that is typed after a \internal command is included. If the tag is set
397
# to NO (the default) then the documentation will be excluded.
279
398
# Set it to YES to include the internal documentation.
280
399
281
400
INTERNAL_DOCS = NO
282
401
283
# 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
285
# 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
402
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
403
# file names in lower-case letters. If set to YES upper-case letters are also
404
# allowed. This is useful if you have classes or files whose names only differ
405
# in case and if your file system supports case sensitive file names. Windows
287
406
# and Mac users are advised to set this option to NO.
288
407
289
408
CASE_SENSE_NAMES = YES
290
409
291
# 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
410
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
411
# will show members with their full class and namespace scopes in the
293
412
# documentation. If set to YES the scope will be hidden.
294
413
295
414
HIDE_SCOPE_NAMES = NO
296
415
297
# 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
416
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
417
# will put a list of the files that are included by a file in the documentation
299
418
# of that file.
300
419
301
420
SHOW_INCLUDE_FILES = YES
302
421
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
426
FORCE_LOCAL_INCLUDES = NO
427
428
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
304
429
# is inserted in the documentation for inline members.
305
430
306
431
INLINE_INFO = YES
307
432
308
# 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
310
# alphabetically by member name. If set to NO the members will appear in
433
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
434
# will sort the (detailed) documentation of file and class members
435
# alphabetically by member name. If set to NO the members will appear in
311
436
# declaration order.
312
437
313
438
SORT_MEMBER_DOCS = YES
314
439
315
# 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
317
# by member name. If set to NO (the default) the members will appear in
440
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
441
# brief documentation of file, namespace and class members alphabetically
442
# by member name. If set to NO (the default) the members will appear in
318
443
# declaration order.
319
444
320
445
SORT_BRIEF_DOCS = YES
321
446
322
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
323
# sorted by fully-qualified names, including namespaces. If set to
324
# NO (the default), the class list will be sorted only by class name,
325
# not including the namespace part.
447
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
448
# will sort the (brief and detailed) documentation of class members so that
449
# constructors and destructors are listed first. If set to NO (the default)
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
455
SORT_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
461
SORT_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
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
469
# alphabetical list.
329
470
330
471
SORT_BY_SCOPE_NAME = NO
331
472
332
# The GENERATE_TODOLIST tag can be used to enable (YES) or
333
# disable (NO) the todo list. This list is created by putting \todo
473
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
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
480
STRICT_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
484
# commands in the documentation.
335
485
336
486
GENERATE_TODOLIST = YES
337
487
338
# The GENERATE_TESTLIST tag can be used to enable (YES) or
339
# disable (NO) the test list. This list is created by putting \test
488
# The GENERATE_TESTLIST tag can be used to enable (YES) or
489
# disable (NO) the test list. This list is created by putting \test
340
490
# commands in the documentation.
341
491
342
492
GENERATE_TESTLIST = YES
343
493
344
# The GENERATE_BUGLIST tag can be used to enable (YES) or
345
# disable (NO) the bug list. This list is created by putting \bug
494
# The GENERATE_BUGLIST tag can be used to enable (YES) or
495
# disable (NO) the bug list. This list is created by putting \bug
346
496
# commands in the documentation.
347
497
348
498
GENERATE_BUGLIST = YES
349
499
350
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
351
# disable (NO) the deprecated list. This list is created by putting
500
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
501
# disable (NO) the deprecated list. This list is created by putting
352
502
# \deprecated commands in the documentation.
353
503
354
504
GENERATE_DEPRECATEDLIST= YES
355
505
356
# The ENABLED_SECTIONS tag can be used to enable conditional
506
# The ENABLED_SECTIONS tag can be used to enable conditional
357
507
# documentation sections, marked by \if sectionname ... \endif.
358
508
359
509
ENABLED_SECTIONS =
360
510
361
# 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
363
# 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.
365
# The appearance of the initializer of individual variables and defines in the
366
# documentation can be controlled using \showinitializer or \hideinitializer
511
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
512
# the initial value of a variable or macro consists of for it to appear in
513
# the documentation. If the initializer consists of more lines than specified
514
# here it will be hidden. Use a value of 0 to hide initializers completely.
515
# The appearance of the initializer of individual variables and macros in the
516
# documentation can be controlled using \showinitializer or \hideinitializer
367
517
# command in the documentation regardless of this setting.
368
518
369
519
MAX_INITIALIZER_LINES = 30
370
520
371
# 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
521
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
522
# at the bottom of the documentation of classes and structs. If set to YES the
373
523
# list will mention the files that were used to generate the documentation.
374
524
375
525
SHOW_USED_FILES = YES
376
526
377
# 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
379
# in the documentation. The default is YES.
527
# If the sources in your project are distributed over multiple directories
528
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
529
# in the documentation. The default is NO.
380
530
381
531
SHOW_DIRECTORIES = YES
382
532
383
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
384
# doxygen should invoke to get the current version for each file (typically from the
385
# version control system). Doxygen will invoke the program by executing (via
386
# popen()) the command <command> <input-file>, where <command> is the value of
387
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
388
# provided by doxygen. Whatever the program writes to standard output
533
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
534
# This will remove the Files entry from the Quick Index and from the
535
# Folder Tree View (if specified). The default is YES.
536
537
SHOW_FILES = YES
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
544
SHOW_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
552
# is used as the file version. See the manual for examples.
390
553
391
FILE_VERSION_FILTER =
554
FILE_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
563
LAYOUT_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
572
CITE_BIB_FILES =
392
573
393
574
#---------------------------------------------------------------------------
394
575
# configuration options related to warning and progress messages
395
576
#---------------------------------------------------------------------------
396
577
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
579
# by doxygen. Possible values are YES and NO. If left blank NO is used.
399
580
400
581
QUIET = NO
401
582
402
# 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
583
# The WARNINGS tag can be used to turn on/off the warning messages that are
584
# generated by doxygen. Possible values are YES and NO. If left blank
404
585
# NO is used.
405
586
406
587
WARNINGS = YES
407
588
408
# 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
589
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
590
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
410
591
# automatically be disabled.
411
592
412
593
WARN_IF_UNDOCUMENTED = YES
413
594
414
# 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
416
# parameters in a documented function, or documenting parameters that
595
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
596
# potential errors in the documentation, such as not documenting some
597
# parameters in a documented function, or documenting parameters that
417
598
# don't exist or using markup commands wrongly.
418
599
419
600
WARN_IF_DOC_ERROR = YES
420
601
421
# This WARN_NO_PARAMDOC option can be abled to get warnings for
422
# 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
424
# wrong or incomplete parameter documentation, but not about the absence of
602
# The WARN_NO_PARAMDOC option can be enabled to get warnings for
603
# functions that are documented, but have no documentation for their parameters
604
# or return value. If set to NO (the default) doxygen will only warn about
605
# wrong or incomplete parameter documentation, but not about the absence of
425
606
# documentation.
426
607
427
608
WARN_NO_PARAMDOC = NO
428
609
429
# 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
431
# 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
433
# $version, which will be replaced by the version of the file (if it could
610
# The WARN_FORMAT tag determines the format of the warning messages that
611
# doxygen can produce. The string should contain the $file, $line, and $text
612
# tags, which will be replaced by the file and line number from which the
613
# warning originated and the warning text. Optionally the format may contain
614
# $version, which will be replaced by the version of the file (if it could
434
615
# be obtained via FILE_VERSION_FILTER)
435
616
436
617
WARN_FORMAT = @DOXY_WARN_FORMAT@
437
618
438
# 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
619
# The WARN_LOGFILE tag can be used to specify a file to which warning
620
# and error messages should be written. If left blank the output is written
440
621
# to stderr.
441
622
442
623
WARN_LOGFILE = Doc/doxy.log
445
626
# configuration options related to the input files
446
627
#---------------------------------------------------------------------------
447
628
448
# 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
450
# directories like "/usr/src/myproject". Separate the files or directories
629
# The INPUT tag can be used to specify the files and/or directories that contain
630
# documented source files. You may enter file names like "myfile.cpp" or
631
# directories like "/usr/src/myproject". Separate the files or directories
451
632
# with spaces.
452
633
453
634
INPUT = @CMAKE_SOURCE_DIR@/include/zorba/zorbac.h \
455
636
@CMAKE_SOURCE_DIR@/include/zorba/static_context_consts.h \
456
637
@CMAKE_SOURCE_DIR@/include/zorba/options.h \
457
638
@CMAKE_CURRENT_SOURCE_DIR@/manual
458
459
460
# If the value of the INPUT tag contains directories, you can use the
461
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
462
# and *.h) to filter out the source-files in the directories. If left
463
# blank the following patterns are tested:
464
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
465
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
466
467
FILE_PATTERNS = *.h *.dox
468
469
# 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.
639
640
# This tag can be used to specify the character encoding of the source files
641
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
642
# also the default input encoding. Doxygen uses libiconv (or the iconv built
643
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
644
# the list of possible encodings.
645
646
INPUT_ENCODING = UTF-8
647
648
# If the value of the INPUT tag contains directories, you can use the
649
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
650
# and *.h) to filter out the source-files in the directories. If left
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
656
FILE_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
661
# If left blank NO is used.
472
662
473
663
RECURSIVE = YES
474
664
475
# 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
665
# The EXCLUDE tag can be used to specify files and/or directories that should
666
# excluded from the INPUT source files. This way you can easily exclude a
477
667
# subdirectory from a directory tree whose root is specified with the INPUT tag.
478
479
EXCLUDE =
480
481
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
482
# directories that are symbolic links (a Unix filesystem feature) are excluded
668
# Note that relative paths are relative to directory from which doxygen is run.
669
670
EXCLUDE =
671
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
674
# from the input.
484
675
485
676
EXCLUDE_SYMLINKS = NO
486
677
487
# 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
489
# certain files from those directories. Note that the wildcards are matched
490
# against the file with absolute path, so to exclude all test directories
678
# If the value of the INPUT tag contains directories, you can use the
679
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
680
# certain files from those directories. Note that the wildcards are matched
681
# against the file with absolute path, so to exclude all test directories
491
682
# for example use the pattern */test/*
492
683
493
684
EXCLUDE_PATTERNS = */.svn \
494
685
*/.svn/*
495
686
496
# The EXAMPLE_PATH tag can be used to specify one or more files or
497
# directories that contain example code fragments that are included (see
687
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
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
693
EXCLUDE_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
697
# the \include command).
499
698
500
699
EXAMPLE_PATH = @CMAKE_CURRENT_SOURCE_DIR@/examples
501
700
502
# 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
504
# and *.h) to filter out the source-files in the directories. If left
701
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
702
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
703
# and *.h) to filter out the source-files in the directories. If left
505
704
# blank all files are included.
506
705
507
706
EXAMPLE_PATTERNS = *.c
508
707
509
# 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
511
# commands irrespective of the value of the RECURSIVE tag.
708
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
709
# searched for input files to be used with the \include or \dontinclude
710
# commands irrespective of the value of the RECURSIVE tag.
512
711
# Possible values are YES and NO. If left blank NO is used.
513
712
514
713
EXAMPLE_RECURSIVE = YES
515
714
516
# 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
715
# The IMAGE_PATH tag can be used to specify one or more files or
716
# directories that contain image that are included in the documentation (see
518
717
# the \image command).
519
718
520
719
IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@
521
720
522
523
# The INPUT_FILTER tag can be used to specify a program that doxygen should
524
# invoke to filter for each input file. Doxygen will invoke the filter program
525
# by executing (via popen()) the command <filter> <input-file>, where <filter>
526
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
527
# input file. Doxygen will then use the output that the filter program writes
528
# to standard output. If FILTER_PATTERNS is specified, this tag will be
721
# 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
723
# 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
725
# input file. Doxygen will then use the output that the filter program writes
726
# to standard output.
727
# If FILTER_PATTERNS is specified, this tag will be
529
728
# ignored.
530
729
531
INPUT_FILTER =
532
533
# 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
535
# filter if there is a match. The filters are a list of the form:
536
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
537
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
538
# is applied to all files.
539
540
FILTER_PATTERNS =
541
542
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
543
# INPUT_FILTER) will be used to filter the input files when producing source
730
INPUT_FILTER =
731
732
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
733
# basis.
734
# Doxygen will compare the file name with each pattern and apply the
735
# filter if there is a match.
736
# The filters are a list of the form:
737
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
738
# info on how filters are used. If FILTER_PATTERNS is empty or if
739
# non of the patterns match the file name, INPUT_FILTER is applied.
740
741
FILTER_PATTERNS =
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
745
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
545
746
546
747
FILTER_SOURCE_FILES = NO
547
748
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
755
FILTER_SOURCE_PATTERNS =
756
548
757
#---------------------------------------------------------------------------
549
758
# configuration options related to source browsing
550
759
#---------------------------------------------------------------------------
551
760
552
# 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.
554
# Note: To get rid of all source code in the generated output, make sure also
761
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
762
# be generated. Documented entities will be cross-referenced with these sources.
763
# Note: To get rid of all source code in the generated output, make sure also
555
764
# VERBATIM_HEADERS is set to NO.
556
765
557
766
SOURCE_BROWSER = YES
558
767
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
769
# of functions and classes directly in the documentation.
561
770
562
771
INLINE_SOURCES = NO
563
772
564
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
565
# doxygen to hide any special comment blocks from generated source code
773
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
774
# doxygen to hide any special comment blocks from generated source code
566
775
# fragments. Normal C and C++ comments will always remain visible.
567
776
568
777
STRIP_CODE_COMMENTS = NO
569
778
570
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
571
# then for each documented function all documented
779
# If the REFERENCED_BY_RELATION tag is set to YES
780
# then for each documented function all documented
572
781
# functions referencing it will be listed.
573
782
574
783
REFERENCED_BY_RELATION = YES
575
784
576
# If the REFERENCES_RELATION tag is set to YES (the default)
577
# then for each documented function all documented entities
785
# If the REFERENCES_RELATION tag is set to YES
786
# then for each documented function all documented entities
578
787
# called/used by that function will be listed.
579
788
580
789
REFERENCES_RELATION = YES
581
790
582
# If the USE_HTAGS tag is set to YES then the references to source code
583
# will point to the HTML generated by the htags(1) tool instead of doxygen
584
# built-in source browser. The htags tool is part of GNU's global source
585
# tagging system (see http://www.gnu.org/software/global/global.html). You
791
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
792
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
793
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
794
# link to the source code.
795
# Otherwise they will link to the documentation.
796
797
REFERENCES_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
803
# will need version 4.8.6 or higher.
587
804
588
805
USE_HTAGS = NO
589
806
590
# 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
807
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
808
# will generate a verbatim copy of the header file for each class for
592
809
# which an include is specified. Set to NO to disable this.
593
810
594
811
VERBATIM_HEADERS = YES
597
814
# configuration options related to the alphabetical class index
598
815
#---------------------------------------------------------------------------
599
816
600
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
601
# of all compounds will be generated. Enable this if the project
817
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
818
# of all compounds will be generated. Enable this if the project
602
819
# contains a lot of classes, structs, unions or interfaces.
603
820
604
821
ALPHABETICAL_INDEX = YES
605
822
606
# 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
823
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
824
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
608
825
# in which this list will be split (can be a number in the range [1..20])
609
826
610
827
COLS_IN_ALPHA_INDEX = 2
611
828
612
# 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.
614
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
829
# In case all classes in a project start with a common prefix, all
830
# classes will be put under the same header in the alphabetical index.
831
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
615
832
# should be ignored while generating the index headers.
616
833
617
IGNORE_PREFIX =
834
IGNORE_PREFIX =
618
835
619
836
#---------------------------------------------------------------------------
620
837
# configuration options related to the HTML output
621
838
#---------------------------------------------------------------------------
622
839
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
841
# generate HTML output.
625
842
626
843
GENERATE_HTML = YES
627
844
628
# 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
845
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
846
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
630
847
# put in front of it. If left blank `html' will be used as the default path.
631
848
632
849
HTML_OUTPUT = html
633
850
634
# 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
851
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
852
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
636
853
# doxygen will generate files with .html extension.
637
854
638
855
HTML_FILE_EXTENSION = .html
639
856
640
# 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
642
# standard header.
857
# The HTML_HEADER tag can be used to specify a personal HTML header for
858
# each generated HTML page. If it is left blank doxygen will generate a
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
643
868
HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/../style/header.html
644
869
645
646
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
647
# each generated HTML page. If it is left blank doxygen will generate a
870
# 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
648
872
# standard footer.
649
873
650
874
HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/../style/footer.html
651
875
652
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
653
# style sheet that is used by each HTML page. It can be used to
654
# fine-tune the look of the HTML output. If the tag is left blank doxygen
655
# will generate a default style sheet. Note that doxygen will try to copy
656
# the style sheet file to the HTML output directory, so don't put your own
876
# If the HTML_TIMESTAMP tag is set to YES then the generated HTML documentation will contain the timesstamp.
877
878
HTML_TIMESTAMP = NO
879
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
885
# stylesheet in the HTML output directory as well, or it will be erased!
658
886
659
887
HTML_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/../style/stylesheet.css
660
888
661
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
662
# files or namespaces will be aligned in HTML using tables. If set to
889
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
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
896
HTML_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
906
HTML_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
912
HTML_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
921
HTML_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
927
HTML_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
931
# NO a bullet list will be used.
664
932
665
933
HTML_ALIGN_MEMBERS = YES
666
934
667
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
668
# will be generated that can be used as input for tools like the
669
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
935
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
936
# documentation will contain sections that can be hidden and shown after the
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
941
HTML_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
954
GENERATE_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
961
DOCSET_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
968
DOCSET_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
974
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
975
976
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
977
978
DOCSET_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
983
# of the generated HTML documentation.
671
984
672
985
GENERATE_HTMLHELP = YES
673
986
674
# 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
676
# can add a path in front of the file if the result should not be
987
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
988
# be used to specify the file name of the resulting .chm file. You
989
# can add a path in front of the file if the result should not be
677
990
# written to the html output directory.
678
991
679
CHM_FILE =
992
CHM_FILE =
680
993
681
# 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
683
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
994
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
995
# be used to specify the location (absolute path including file name) of
996
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
684
997
# the HTML help compiler on the generated index.hhp.
685
998
686
HHC_LOCATION =
999
HHC_LOCATION =
687
1000
688
# 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
1001
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
1002
# controls if a separate .chi index file is generated (YES) or that
690
1003
# it should be included in the master .chm file (NO).
691
1004
692
1005
GENERATE_CHI = NO
693
1006
694
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
695
# controls whether a binary table of contents is generated (YES) or a
1007
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
1008
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
1009
# content.
1010
1011
CHM_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
1015
# normal table of contents (NO) in the .chm file.
697
1016
698
1017
BINARY_TOC = NO
699
1018
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
1020
# to the contents of the HTML help documentation and to the tree view.
702
1021
703
1022
TOC_EXPAND = NO
704
1023
705
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
706
# top of each HTML page. The value NO (the default) enables the index and
1024
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE 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
1029
GENERATE_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
1035
QCH_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
1041
QHP_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
1047
QHP_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
1053
QHP_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
1060
QHP_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
1068
QHP_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
1075
QHG_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
1086
GENERATE_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
1092
ECLIPSE_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
1096
# the value YES disables it.
708
1097
709
1098
DISABLE_INDEX = NO
710
1099
711
# This tag can be used to set the number of enum values (range [1..20])
712
# that doxygen will group on one line in the generated HTML documentation.
1100
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
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.
713
1104
714
1105
ENUM_VALUES_PER_LINE = 4
715
1106
716
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
717
# generated containing a tree-like index structure (just like the one that
718
# is generated for HTML Help). For this to work a browser that supports
719
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
720
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
721
# probably better off using the HTML help feature.
1107
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1108
# structure should be generated to display hierarchical information.
1109
# If the tag value is set to YES, a side panel will be generated
1110
# containing a tree-like index structure (just like the one that
1111
# is generated for HTML Help). For this to work a browser that supports
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.
722
1114
723
1115
GENERATE_TREEVIEW = NO
724
1116
725
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
726
# used to set the initial width (in pixels) of the frame in which the tree
1117
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1118
# and Class Hierarchy pages using a tree view instead of an ordered list.
1119
1120
USE_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
1124
# is shown.
728
1125
729
1126
TREEVIEW_WIDTH = 250
730
1127
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
1131
EXT_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
1139
FORMULA_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
1147
FORMULA_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
1156
USE_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
1167
MATHJAX_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
1172
MATHJAX_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
1182
SEARCHENGINE = 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
1192
SERVER_BASED_SEARCH = NO
1193
731
1194
#---------------------------------------------------------------------------
732
1195
# configuration options related to the LaTeX output
733
1196
#---------------------------------------------------------------------------
734
1197
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
1199
# generate Latex output.
737
1200
738
1201
GENERATE_LATEX = NO
739
1202
740
# 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
1203
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1204
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
742
1205
# put in front of it. If left blank `latex' will be used as the default path.
743
1206
744
1207
LATEX_OUTPUT = latex
745
1208
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
1210
# invoked. If left blank `latex' will be used as the default command name.
748
749
#LATEX_CMD_NAME = latex
750
LATEX_CMD_NAME = @LATEX_COMPILER@
751
752
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
753
# generate index for LaTeX. If left blank `makeindex' will be used as the
1211
# Note that when enabling USE_PDFLATEX this option is only used for
1212
# generating bitmaps for formulas in the HTML output, but not in the
1213
# Makefile that is written to the output directory.
1214
1215
LATEX_CMD_NAME = @LATEX_COMPILER@
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
1219
# default command name.
755
1220
756
#MAKEINDEX_CMD_NAME = makeindex
757
1221
MAKEINDEX_CMD_NAME = @MAKEINDEX_COMPILER@
758
1222
759
# 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
1223
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1224
# LaTeX documents. This may be useful for small projects and may help to
761
1225
# save some trees in general.
762
1226
763
1227
COMPACT_LATEX = NO
764
1228
765
# 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
1229
# The PAPER_TYPE tag can be used to set the paper type that is used
1230
# by the printer. Possible values are: a4, letter, legal and
767
1231
# executive. If left blank a4wide will be used.
768
1232
769
1233
PAPER_TYPE = a4
770
1234
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
1236
# packages that should be included in the LaTeX output.
773
1237
774
EXTRA_PACKAGES =
1238
EXTRA_PACKAGES =
775
1239
776
# 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
778
# the first chapter. If it is left blank doxygen will generate a
1240
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1241
# the generated latex document. The header should contain everything until
1242
# the first chapter. If it is left blank doxygen will generate a
779
1243
# standard header. Notice: only use this tag if you know what you are doing!
780
1244
781
LATEX_HEADER =
782
783
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
784
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
785
# contain links (just like the HTML output) instead of page references
1245
LATEX_HEADER =
1246
1247
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
1248
# the generated latex document. The footer should contain everything after
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
1252
LATEX_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
1257
# This makes the output suitable for online browsing using a pdf viewer.
787
1258
788
1259
PDF_HYPERLINKS = YES
789
1260
790
# 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
1261
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1262
# plain latex in the generated Makefile. Set this option to YES to get a
792
1263
# higher quality PDF documentation.
793
1264
794
1265
USE_PDFLATEX = YES
795
1266
796
# 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
798
# running if errors occur, instead of asking the user for help.
1267
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1268
# command to the generated LaTeX files. This will instruct LaTeX to keep
1269
# running if errors occur, instead of asking the user for help.
799
1270
# This option is also used when generating formulas in HTML.
800
1271
801
1272
LATEX_BATCHMODE = YES
802
1273
803
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
804
# include the index chapters (such as File Index, Compound Index, etc.)
1274
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1275
# include the index chapters (such as File Index, Compound Index, etc.)
805
1276
# in the output.
806
1277
807
1278
LATEX_HIDE_INDICES = NO
808
1279
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
1285
LATEX_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
1291
LATEX_BIB_STYLE = plain
1292
809
1293
#---------------------------------------------------------------------------
810
1294
# configuration options related to the RTF output
811
1295
#---------------------------------------------------------------------------
812
1296
813
# 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
1297
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1298
# The RTF output is optimized for Word 97 and may not look very pretty with
815
1299
# other RTF readers or editors.
816
1300
817
1301
GENERATE_RTF = NO
818
1302
819
# 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
1303
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1304
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
821
1305
# put in front of it. If left blank `rtf' will be used as the default path.
822
1306
823
1307
RTF_OUTPUT = rtf
824
1308
825
# 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
1309
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1310
# RTF documents. This may be useful for small projects and may help to
827
1311
# save some trees in general.
828
1312
829
1313
COMPACT_RTF = NO
830
1314
831
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
832
# will contain hyperlink fields. The RTF file will
833
# contain links (just like the HTML output) instead of page references.
834
# This makes the output suitable for online browsing using WORD or other
835
# programs which support those fields.
1315
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1316
# will contain hyperlink fields. The RTF file will
1317
# contain links (just like the HTML output) instead of page references.
1318
# This makes the output suitable for online browsing using WORD or other
1319
# programs which support those fields.
836
1320
# Note: wordpad (write) and others do not support links.
837
1321
838
1322
RTF_HYPERLINKS = NO
839
1323
840
# 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
1324
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1325
# config file, i.e. a series of assignments. You only have to provide
842
1326
# replacements, missing definitions are set to their default value.
843
1327
844
RTF_STYLESHEET_FILE =
1328
RTF_STYLESHEET_FILE =
845
1329
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
1331
# Syntax is similar to doxygen's config file.
848
1332
849
RTF_EXTENSIONS_FILE =
1333
RTF_EXTENSIONS_FILE =
850
1334
851
1335
#---------------------------------------------------------------------------
852
1336
# configuration options related to the man page output
853
1337
#---------------------------------------------------------------------------
854
1338
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
1340
# generate man pages
857
1341
858
1342
GENERATE_MAN = NO
859
1343
860
# 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
1344
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1345
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
862
1346
# put in front of it. If left blank `man' will be used as the default path.
863
1347
864
1348
MAN_OUTPUT = man
865
1349
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
1351
# the generated man pages (default is the subroutine's section .3)
868
1352
869
1353
MAN_EXTENSION = .3
870
1354
871
# 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
873
# documented in the real man page(s). These additional files
874
# only source the real man page, but without them the man command
1355
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1356
# then it will generate one additional man file for each entity
1357
# documented in the real man page(s). These additional files
1358
# only source the real man page, but without them the man command
875
1359
# would be unable to find the correct page. The default is NO.
876
1360
877
1361
MAN_LINKS = NO
880
1364
# configuration options related to the XML output
881
1365
#---------------------------------------------------------------------------
882
1366
883
# If the GENERATE_XML tag is set to YES Doxygen will
884
# generate an XML file that captures the structure of
1367
# If the GENERATE_XML tag is set to YES Doxygen will
1368
# generate an XML file that captures the structure of
885
1369
# the code including all documentation.
886
1370
887
1371
GENERATE_XML = NO
888
1372
889
# 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
1373
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1374
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
891
1375
# put in front of it. If left blank `xml' will be used as the default path.
892
1376
893
1377
XML_OUTPUT = xml
894
1378
895
# 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
897
# syntax of the XML files.
898
899
XML_SCHEMA =
900
901
# 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
903
# syntax of the XML files.
904
905
XML_DTD =
906
907
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
908
# dump the program listings (including syntax highlighting
909
# and cross-referencing information) to the XML output. Note that
1379
# The XML_SCHEMA tag can be used to specify an XML schema,
1380
# which can be used by a validating XML parser to check the
1381
# syntax of the XML files.
1382
1383
XML_SCHEMA =
1384
1385
# The XML_DTD tag can be used to specify an XML DTD,
1386
# which can be used by a validating XML parser to check the
1387
# syntax of the XML files.
1388
1389
XML_DTD =
1390
1391
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1392
# dump the program listings (including syntax highlighting
1393
# and cross-referencing information) to the XML output. Note that
910
1394
# enabling this will significantly increase the size of the XML output.
911
1395
912
1396
XML_PROGRAMLISTING = YES
915
1399
# configuration options for the AutoGen Definitions output
916
1400
#---------------------------------------------------------------------------
917
1401
918
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
919
# generate an AutoGen Definitions (see autogen.sf.net) file
920
# that captures the structure of the code including all
921
# documentation. Note that this feature is still experimental
1402
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1403
# generate an AutoGen Definitions (see autogen.sf.net) file
1404
# that captures the structure of the code including all
1405
# documentation. Note that this feature is still experimental
922
1406
# and incomplete at the moment.
923
1407
924
1408
GENERATE_AUTOGEN_DEF = NO
927
1411
# configuration options related to the Perl module output
928
1412
#---------------------------------------------------------------------------
929
1413
930
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
931
# generate a Perl module file that captures the structure of
932
# the code including all documentation. Note that this
933
# feature is still experimental and incomplete at the
1414
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1415
# generate a Perl module file that captures the structure of
1416
# the code including all documentation. Note that this
1417
# feature is still experimental and incomplete at the
934
1418
# moment.
935
1419
936
1420
GENERATE_PERLMOD = NO
937
1421
938
# 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
1422
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1423
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
940
1424
# to generate PDF and DVI output from the Perl module output.
941
1425
942
1426
PERLMOD_LATEX = NO
943
1427
944
# 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
946
# if you want to understand what is going on. On the other hand, if this
947
# tag is set to NO the size of the Perl module output will be much smaller
1428
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1429
# nicely formatted so it can be parsed by a human reader.
1430
# This is useful
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
1434
# and Perl will parse it just the same.
949
1435
950
1436
PERLMOD_PRETTY = YES
951
1437
952
# The names of the make variables in the generated doxyrules.make file
953
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
954
# This is useful so different doxyrules.make files included by the same
1438
# The names of the make variables in the generated doxyrules.make file
1439
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1440
# This is useful so different doxyrules.make files included by the same
955
1441
# Makefile don't overwrite each other's variables.
956
1442
957
PERLMOD_MAKEVAR_PREFIX =
958
959
#---------------------------------------------------------------------------
960
# Configuration options related to the preprocessor
961
#---------------------------------------------------------------------------
962
963
# 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
1443
PERLMOD_MAKEVAR_PREFIX =
1444
1445
#---------------------------------------------------------------------------
1446
# Configuration options related to the preprocessor
1447
#---------------------------------------------------------------------------
1448
1449
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1450
# evaluate all C-preprocessor directives found in the sources and include
965
1451
# files.
966
1452
967
1453
ENABLE_PREPROCESSING = YES
968
1454
969
# 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
971
# compilation will be performed. Macro expansion can be done in a controlled
1455
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1456
# names in the source code. If set to NO (the default) only conditional
1457
# compilation will be performed. Macro expansion can be done in a controlled
972
1458
# way by setting EXPAND_ONLY_PREDEF to YES.
973
1459
974
1460
MACRO_EXPANSION = YES
975
1461
976
# 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
1462
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1463
# then the macro expansion is limited to the macros specified with the
978
1464
# PREDEFINED and EXPAND_AS_DEFINED tags.
979
1465
980
1466
EXPAND_ONLY_PREDEF = YES
981
1467
982
# 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.
1468
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1469
# pointed to by INCLUDE_PATH will be searched when a #include is found.
984
1470
985
1471
SEARCH_INCLUDES = YES
986
1472
987
# 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
1473
# The INCLUDE_PATH tag can be used to specify one or more directories that
1474
# contain include files that are not input files but should be processed by
989
1475
# the preprocessor.
990
1476
991
INCLUDE_PATH =
1477
INCLUDE_PATH =
992
1478
993
# 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
995
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1479
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1480
# patterns (like *.h and *.hpp) to filter out the header-files in the
1481
# directories. If left blank, the patterns specified with FILE_PATTERNS will
996
1482
# be used.
997
1483
998
INCLUDE_FILE_PATTERNS =
1484
INCLUDE_FILE_PATTERNS =
999
1485
1000
# 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
1002
# 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
1004
# omitted =1 is assumed. To prevent a macro definition from being
1005
# undefined via #undef or recursively expanded use the := operator
1486
# The PREDEFINED tag can be used to specify one or more macro names that
1487
# are defined before the preprocessor is started (similar to the -D option of
1488
# gcc). The argument of the tag is a list of macros of the form: name
1489
# or name=definition (no spaces). If the definition and the = are
1490
# omitted =1 is assumed. To prevent a macro definition from being
1491
# undefined via #undef or recursively expanded use the := operator
1006
1492
# instead of the = operator.
1007
1493
1008
PREDEFINED =
1009
1010
# 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.
1012
# 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.
1014
1015
EXPAND_AS_DEFINED =
1016
1017
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1018
# doxygen's preprocessor will remove all function-like macros that are alone
1019
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1020
# function macros are typically used for boiler-plate code, and will confuse
1021
# the parser if not removed.
1494
PREDEFINED =
1495
1496
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1497
# this tag can be used to specify a list of macro names that should be expanded.
1498
# The macro definition that is found in the sources will be used.
1499
# Use the PREDEFINED tag if you want to use a different macro definition that
1500
# overrules the definition found in the source code.
1501
1502
EXPAND_AS_DEFINED =
1503
1504
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1505
# doxygen's preprocessor will remove all references to function-like macros
1506
# that are alone on a line, have an all uppercase name, and do not end with a
1507
# semicolon, because these will confuse the parser if not removed.
1022
1508
1023
1509
SKIP_FUNCTION_MACROS = YES
1024
1510
1025
1511
#---------------------------------------------------------------------------
1026
# Configuration::additions related to external references
1512
# Configuration::additions related to external references
1027
1513
#---------------------------------------------------------------------------
1028
1514
1029
# The TAGFILES option can be used to specify one or more tagfiles.
1030
# Optionally an initial location of the external documentation
1031
# can be added for each tagfile. The format of a tag file without
1032
# this location is as follows:
1033
# TAGFILES = file1 file2 ...
1034
# Adding location for the tag files is done as follows:
1035
# TAGFILES = file1=loc1 "file2 = loc2" ...
1036
# where "loc1" and "loc2" can be relative or absolute paths or
1037
# URLs. If a location is present for each tag, the installdox tool
1515
# The TAGFILES option can be used to specify one or more tagfiles.
1516
# Optionally an initial location of the external documentation
1517
# can be added for each tagfile. The format of a tag file without
1518
# this location is as follows:
1519
#
1520
# TAGFILES = file1 file2 ...
1521
# Adding location for the tag files is done as follows:
1522
#
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
1526
# does not have to be run to correct the links.
1039
1527
# Note that each tag file must have a unique name
1040
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
1530
# is run, you must also specify the path to the tagfile here.
1043
1531
1044
TAGFILES =
1532
TAGFILES =
1045
1533
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
1535
# a tag file that is based on the input files it reads.
1048
1536
1049
1537
GENERATE_TAGFILE = html/@PROJECT_NAME@.TAGFILE
1050
1538
1051
# 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
1539
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1540
# in the class index. If set to NO only the inherited external classes
1053
1541
# will be listed.
1054
1542
1055
1543
ALLEXTERNALS = YES
1056
1544
1057
# 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
1545
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1546
# in the modules index. If set to NO, only the current project's groups will
1059
1547
# be listed.
1060
1548
1061
1549
EXTERNAL_GROUPS = YES
1062
1550
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
1552
# interpreter (i.e. the result of `which perl').
1065
1553
1066
1554
PERL_PATH = /usr/bin/perl
1067
1555
1068
1556
#---------------------------------------------------------------------------
1069
# Configuration options related to the dot tool
1557
# Configuration options related to the dot tool
1070
1558
#---------------------------------------------------------------------------
1071
1559
1072
# 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
1074
# 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
1076
# fallback. It is recommended to install and use dot, since it yields more
1077
# powerful graphs.
1560
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1561
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1562
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1563
# this option also works with HAVE_DOT disabled, but it is recommended to
1564
# install and use dot, since it yields more powerful graphs.
1078
1565
1079
1566
CLASS_DIAGRAMS = YES
1080
1567
1081
# If set to YES, the inheritance and collaboration graphs will hide
1082
# inheritance and usage relations if the target is undocumented
1568
# You can define message sequence charts within doxygen comments using the \msc
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
1575
MSCGEN_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
1579
# or is not a class.
1084
1580
1085
1581
HIDE_UNDOC_RELATIONS = YES
1086
1582
1087
# 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
1089
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1583
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1584
# available from the path. This tool is part of Graphviz, a graph visualization
1585
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1090
1586
# have no effect if this option is set to NO (the default)
1091
1587
1092
1588
HAVE_DOT = @DOXYGEN_DOT_FOUND@
1093
1589
1094
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1095
# will generate a graph for each documented class showing the direct and
1096
# indirect inheritance relations. Setting this tag to YES will force the
1590
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1591
# allowed to run in parallel. When set to 0 (the default) doxygen will
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
1596
DOT_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
1605
DOT_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
1610
DOT_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
1616
DOT_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
1621
# the CLASS_DIAGRAMS tag to NO.
1098
1622
1099
1623
CLASS_GRAPH = YES
1100
1624
1101
# 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
1103
# indirect implementation dependencies (inheritance, containment, and
1625
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1626
# will generate a graph for each documented class showing the direct and
1627
# indirect implementation dependencies (inheritance, containment, and
1104
1628
# class references variables) of the class with other documented classes.
1105
1629
1106
1630
COLLABORATION_GRAPH = YES
1107
1631
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
1633
# will generate a graph for groups, showing the direct groups dependencies
1110
1634
1111
1635
GROUP_GRAPHS = YES
1112
1636
1113
# 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
1637
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1638
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1115
1639
# Language.
1116
1640
1117
1641
UML_LOOK = NO
1118
# UML_LOOK = YES
1119
1642
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
1644
# relations between templates and their instances.
1122
1645
1123
1646
TEMPLATE_RELATIONS = YES
1124
1647
1125
# 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
1127
# file showing the direct and indirect include dependencies of the file with
1648
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1649
# tags are set to YES then doxygen will generate a graph for each documented
1650
# file showing the direct and indirect include dependencies of the file with
1128
1651
# other documented files.
1129
1652
1130
1653
INCLUDE_GRAPH = YES
1131
1654
1132
# 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
1134
# documented header file showing the documented files that directly or
1655
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1656
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1657
# documented header file showing the documented files that directly or
1135
1658
# indirectly include this file.
1136
1659
1137
1660
INCLUDED_BY_GRAPH = YES
1138
1661
1139
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1140
# generate a call dependency graph for every global function or class method.
1141
# Note that enabling this option will significantly increase the time of a run.
1142
# So in most cases it will be better to enable call graphs for selected
1143
# functions only using the \callgraph command.
1662
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1663
# doxygen will generate a call dependency graph for every global function
1664
# or class method. Note that enabling this option will significantly increase
1665
# the time of a run. So in most cases it will be better to enable call graphs
1666
# for selected functions only using the \callgraph command.
1144
1667
1145
1668
CALL_GRAPH = NO
1146
1669
1147
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1148
# will graphical hierarchy of all classes instead of a textual one.
1670
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
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
1676
CALLER_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.
1149
1680
1150
1681
GRAPHICAL_HIERARCHY = YES
1151
1682
1152
# 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
1683
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1684
# then doxygen will show the dependencies a directory has on other directories
1154
1685
# in a graphical way. The dependency relations are determined by the #include
1155
1686
# relations between the files in the directories.
1156
1687
1157
1688
DIRECTORY_GRAPH = YES
1158
1689
1159
# 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 gif
1161
# If left blank png will be used.
1690
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1691
# generated by dot. Possible values are svg, png, jpg, or gif.
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).
1162
1695
1163
1696
DOT_IMAGE_FORMAT = png
1164
1697
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
1705
INTERACTIVE_SVG = NO
1706
1707
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1166
1708
# found. If left blank, it is assumed the dot tool can be found in the path.
1167
1709
1168
1710
DOT_PATH = @DOXYGEN_DOT_EXECUTABLE_PATH@
1169
1711
1170
# 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
1712
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1713
# contain dot files that are included in the documentation (see the
1172
1714
# \dotfile command).
1173
1715
1174
DOTFILE_DIRS =
1175
1176
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1177
# background. This is disabled by default, which results in a white background.
1178
# Warning: Depending on the platform used, enabling this option may lead to
1179
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1180
# read).
1716
DOTFILE_DIRS =
1717
1718
# The MSCFILE_DIRS tag can be used to specify one or more directories that
1719
# contain msc files that are included in the documentation (see the
1720
# \mscfile command).
1721
1722
MSCFILE_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
1732
DOT_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
1742
MAX_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).
1181
1749
1182
1750
DOT_TRANSPARENT = NO
1183
1751
1184
# 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
1186
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1752
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1753
# files in one run (i.e. multiple -o and -T options on the command line). This
1754
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1187
1755
# support this, this feature is disabled by default.
1188
# JW
1189
# DOT_MULTI_TARGETS = NO
1756
1190
1757
DOT_MULTI_TARGETS = YES
1191
1758
1192
# 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
1759
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1760
# generate a legend page explaining the meaning of the various boxes and
1194
1761
# arrows in the dot generated graphs.
1195
1762
1196
1763
GENERATE_LEGEND = YES
1197
1764
1198
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1199
# remove the intermediate dot files that are used to generate
1765
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1766
# remove the intermediate dot files that are used to generate
1200
1767
# the various graphs.
1201
1768
1202
1769
DOT_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
1212
SEARCHENGINE = NO
Loggerhead is a web-based interface for Breezy
Version: 2.0.1