« back to all changes in this revision
Viewing changes to doc/doxyfile.in
- browse files at revision 151
- compare with another revision
- download diff
- download tarball
- view history from revision 151
- Committer: GitHub
- Author(s): Lukas Dürrenberger
- Date: 2018-08-20 06:40:04 UTC
- mfrom: (149.2.1)
- Revision ID: git-v1:3b41d938f9ecaf350f925b4f34751160870a5221
Merge pull request #128 from SFML/bugfix/doc_gen
Update the doxygen file and made adjustments for the latest doxygen version
Update the doxygen file and made adjustments for the latest doxygen version
- files added:
- doc/footer.html
- files removed:
- doc/footer.htm
- files modified:
- doc/CMakeLists.txt
added
removed
doc/doxyfile.in
1
# Doxyfile 1.5.8
1
# Doxyfile 1.8.14
2
2
3
3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
5
#
6
# All text after a hash (#) is considered a comment and will be ignored
4
# doxygen (www.doxygen.org) for a project.
5
#
6
# All text after a double hash (##) is considered a comment and is placed in
7
# front of the TAG it is preceding.
8
#
9
# All text after a single hash (#) is considered a comment and will be ignored.
7
10
# The format is:
8
# TAG = value [value, ...]
9
# For lists items can also be appended using:
10
# TAG += value [value, ...]
11
# Values that contain spaces should be placed between quotes (" ")
11
# TAG = value [value, ...]
12
# For lists, items can also be appended using:
13
# TAG += value [value, ...]
14
# Values that contain spaces should be placed between quotes (\" \").
12
15
13
16
#---------------------------------------------------------------------------
14
17
# Project related configuration options
15
18
#---------------------------------------------------------------------------
16
19
17
# This tag specifies the encoding used for all characters in the config file
18
# that follow. The default is UTF-8 which is also the encoding used for all
19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
20
# iconv built into libc) for the transcoding. See
21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
20
# This tag specifies the encoding used for all characters in the config file
21
# that follow. The default is UTF-8 which is also the encoding used for all text
22
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23
# built into libc) for the transcoding. See
24
# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
25
# The default value is: UTF-8.
22
26
23
27
DOXYFILE_ENCODING = UTF-8
24
28
25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26
# by quotes) that should identify the project.
29
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30
# double-quotes, unless you are using Doxywizard) that should identify the
31
# project for which the documentation is generated. This name is used in the
32
# title of most generated pages and in a few other places.
33
# The default value is: My Project.
27
34
28
35
PROJECT_NAME = CSFML
29
36
30
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31
# This could be handy for archiving the generated documentation or
32
# if some version control system is used.
37
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38
# could be handy for archiving the generated documentation or if some version
39
# control system is used.
33
40
34
41
PROJECT_NUMBER = @VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@
35
42
36
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
37
# base path where the generated documentation will be put.
38
# If a relative path is entered, it will be relative to the location
39
# where doxygen was started. If left blank the current directory will be used.
43
# Using the PROJECT_BRIEF tag one can provide an optional one line description
44
# for a project that appears at the top of each page and should give viewer a
45
# quick idea about the purpose of the project. Keep the description short.
46
47
PROJECT_BRIEF =
48
49
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50
# in the documentation. The maximum height of the logo should not exceed 55
51
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52
# the logo to the output directory.
53
54
PROJECT_LOGO =
55
56
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57
# into which the generated documentation will be written. If a relative path is
58
# entered, it will be relative to the location where doxygen was started. If
59
# left blank the current directory will be used.
40
60
41
61
OUTPUT_DIRECTORY = "@DOXYGEN_OUTPUT_DIR@"
42
62
43
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44
# 4096 sub-directories (in 2 levels) under the output directory of each output
45
# format and will distribute the generated files over these directories.
46
# Enabling this option can be useful when feeding doxygen a huge amount of
47
# source files, where putting all generated files in the same directory would
48
# otherwise cause performance problems for the file system.
63
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64
# directories (in 2 levels) under the output directory of each output format and
65
# will distribute the generated files over these directories. Enabling this
66
# option can be useful when feeding doxygen a huge amount of source files, where
67
# putting all generated files in the same directory would otherwise causes
68
# performance problems for the file system.
69
# The default value is: NO.
49
70
50
71
CREATE_SUBDIRS = NO
51
72
52
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53
# documentation generated by doxygen is written. Doxygen will use this
54
# information to generate all constant output in the proper language.
55
# The default language is English, other supported languages are:
56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60
# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
61
# Spanish, Swedish, and Ukrainian.
73
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74
# characters to appear in the names of generated files. If set to NO, non-ASCII
75
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76
# U+3044.
77
# The default value is: NO.
78
79
ALLOW_UNICODE_NAMES = NO
80
81
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
82
# documentation generated by doxygen is written. Doxygen will use this
83
# information to generate all constant output in the proper language.
84
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91
# Ukrainian and Vietnamese.
92
# The default value is: English.
62
93
63
94
OUTPUT_LANGUAGE = English
64
95
65
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66
# include brief member descriptions after the members that are listed in
67
# the file and class documentation (similar to JavaDoc).
68
# Set to NO to disable this.
96
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
97
# descriptions after the members that are listed in the file and class
98
# documentation (similar to Javadoc). Set to NO to disable this.
99
# The default value is: YES.
69
100
70
101
BRIEF_MEMBER_DESC = YES
71
102
72
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73
# the brief description of a member or function before the detailed description.
74
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
103
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104
# description of a member or function before the detailed description
105
#
106
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75
107
# brief descriptions will be completely suppressed.
108
# The default value is: YES.
76
109
77
110
REPEAT_BRIEF = YES
78
111
79
# This tag implements a quasi-intelligent brief description abbreviator
80
# that is used to form the text in various listings. Each string
81
# in this list, if found as the leading text of the brief description, will be
82
# stripped from the text and the result after processing the whole list, is
83
# used as the annotated text. Otherwise, the brief description is used as-is.
84
# If left blank, the following values are used ("$name" is automatically
85
# replaced with the name of the entity): "The $name class" "The $name widget"
86
# "The $name file" "is" "provides" "specifies" "contains"
87
# "represents" "a" "an" "the"
112
# This tag implements a quasi-intelligent brief description abbreviator that is
113
# used to form the text in various listings. Each string in this list, if found
114
# as the leading text of the brief description, will be stripped from the text
115
# and the result, after processing the whole list, is used as the annotated
116
# text. Otherwise, the brief description is used as-is. If left blank, the
117
# following values are used ($name is automatically replaced with the name of
118
# the entity):The $name class, The $name widget, The $name file, is, provides,
119
# specifies, contains, represents, a, an and the.
88
120
89
121
ABBREVIATE_BRIEF = "The $name class" \
90
122
"The $name widget" \
98
130
an \
99
131
the
100
132
101
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102
# Doxygen will generate a detailed section even if there is only a brief
133
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
134
# doxygen will generate a detailed section even if there is only a brief
103
135
# description.
136
# The default value is: NO.
104
137
105
138
ALWAYS_DETAILED_SEC = YES
106
139
107
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108
# inherited members of a class in the documentation of that class as if those
109
# members were ordinary class members. Constructors, destructors and assignment
140
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
141
# inherited members of a class in the documentation of that class as if those
142
# members were ordinary class members. Constructors, destructors and assignment
110
143
# operators of the base classes will not be shown.
144
# The default value is: NO.
111
145
112
146
INLINE_INHERITED_MEMB = YES
113
147
114
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115
# path before files name in the file list and in the header files. If set
116
# to NO the shortest path that makes the file name unique will be used.
148
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
149
# before files name in the file list and in the header files. If set to NO the
150
# shortest path that makes the file name unique will be used
151
# The default value is: YES.
117
152
118
153
FULL_PATH_NAMES = NO
119
154
120
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121
# can be used to strip a user-defined part of the path. Stripping is
122
# only done if one of the specified strings matches the left-hand part of
123
# the path. The tag can be used to show relative paths in the file list.
124
# If left blank the directory from which doxygen is run is used as the
125
# path to strip.
126
127
STRIP_FROM_PATH =
128
129
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130
# the path mentioned in the documentation of a class, which tells
131
# the reader which header file to include in order to use a class.
132
# If left blank only the name of the header file containing the class
133
# definition is used. Otherwise one should specify the include paths that
134
# are normally passed to the compiler using the -I flag.
135
136
STRIP_FROM_INC_PATH =
137
138
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139
# (but less readable) file names. This can be useful is your file systems
140
# doesn't support long names like on DOS, Mac, or CD-ROM.
155
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
156
# Stripping is only done if one of the specified strings matches the left-hand
157
# part of the path. The tag can be used to show relative paths in the file list.
158
# If left blank the directory from which doxygen is run is used as the path to
159
# strip.
160
#
161
# Note that you can specify absolute paths here, but also relative paths, which
162
# will be relative from the directory where doxygen is started.
163
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
164
165
STRIP_FROM_PATH =
166
167
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
168
# path mentioned in the documentation of a class, which tells the reader which
169
# header file to include in order to use a class. If left blank only the name of
170
# the header file containing the class definition is used. Otherwise one should
171
# specify the list of include paths that are normally passed to the compiler
172
# using the -I flag.
173
174
STRIP_FROM_INC_PATH =
175
176
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
177
# less readable) file names. This can be useful is your file systems doesn't
178
# support long names like on DOS, Mac, or CD-ROM.
179
# The default value is: NO.
141
180
142
181
SHORT_NAMES = NO
143
182
144
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
145
# will interpret the first line (until the first dot) of a JavaDoc-style
146
# comment as the brief description. If set to NO, the JavaDoc
147
# comments will behave just like regular Qt-style comments
148
# (thus requiring an explicit @brief command for a brief description.)
183
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
184
# first line (until the first dot) of a Javadoc-style comment as the brief
185
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
186
# style comments (thus requiring an explicit @brief command for a brief
187
# description.)
188
# The default value is: NO.
149
189
150
190
JAVADOC_AUTOBRIEF = YES
151
191
152
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
153
# interpret the first line (until the first dot) of a Qt-style
154
# comment as the brief description. If set to NO, the comments
155
# will behave just like regular Qt-style comments (thus requiring
156
# an explicit \brief command for a brief description.)
192
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
193
# line (until the first dot) of a Qt-style comment as the brief description. If
194
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
195
# requiring an explicit \brief command for a brief description.)
196
# The default value is: NO.
157
197
158
198
QT_AUTOBRIEF = NO
159
199
160
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
161
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
162
# comments) as a brief description. This used to be the default behaviour.
163
# The new default is to treat a multi-line C++ comment block as a detailed
164
# description. Set this tag to YES if you prefer the old behaviour instead.
200
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
201
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
202
# a brief description. This used to be the default behavior. The new default is
203
# to treat a multi-line C++ comment block as a detailed description. Set this
204
# tag to YES if you prefer the old behavior instead.
205
#
206
# Note that setting this tag to YES also means that rational rose comments are
207
# not recognized any more.
208
# The default value is: NO.
165
209
166
210
MULTILINE_CPP_IS_BRIEF = NO
167
211
168
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
169
# member inherits the documentation from any documented member that it
170
# re-implements.
212
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
213
# documentation from any documented member that it re-implements.
214
# The default value is: YES.
171
215
172
216
INHERIT_DOCS = YES
173
217
174
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175
# a new page for each member. If set to NO, the documentation of a member will
176
# be part of the file/class/namespace that contains it.
218
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
219
# page for each member. If set to NO, the documentation of a member will be part
220
# of the file/class/namespace that contains it.
221
# The default value is: NO.
177
222
178
223
SEPARATE_MEMBER_PAGES = NO
179
224
180
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
181
# Doxygen uses this value to replace tabs by spaces in code fragments.
225
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
226
# uses this value to replace tabs by spaces in code fragments.
227
# Minimum value: 1, maximum value: 16, default value: 4.
182
228
183
229
TAB_SIZE = 4
184
230
185
# This tag can be used to specify a number of aliases that acts
186
# as commands in the documentation. An alias has the form "name=value".
187
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
188
# put the command \sideeffect (or @sideeffect) in the documentation, which
189
# will result in a user-defined paragraph with heading "Side Effects:".
190
# You can put \n's in the value part of an alias to insert newlines.
191
192
ALIASES =
193
194
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
195
# sources only. Doxygen will then generate output that is more tailored for C.
196
# For instance, some of the names that are used will be different. The list
197
# of all members will be omitted, etc.
198
199
OPTIMIZE_OUTPUT_FOR_C = YES
200
201
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
202
# sources only. Doxygen will then generate output that is more tailored for
203
# Java. For instance, namespaces will be presented as packages, qualified
204
# scopes will look different, etc.
231
# This tag can be used to specify a number of aliases that act as commands in
232
# the documentation. An alias has the form:
233
# name=value
234
# For example adding
235
# "sideeffect=@par Side Effects:\n"
236
# will allow you to put the command \sideeffect (or @sideeffect) in the
237
# documentation, which will result in a user-defined paragraph with heading
238
# "Side Effects:". You can put \n's in the value part of an alias to insert
239
# newlines (in the resulting output). You can put ^^ in the value part of an
240
# alias to insert a newline as if a physical newline was in the original file.
241
242
#---------------------------------------------------------------------------
243
# SFML specific aliases
244
#---------------------------------------------------------------------------
245
246
# sfplatform{platform(s)}
247
# sfplatform{platform(s), header}
248
#
249
# Warns the user that some specific class or function is only available on
250
# specific platforms.
251
#
252
# This shouldn't be used for incomplete implementations. It's meant for things
253
# that will never appear on another platform, e.g. Android's native activity.
254
#
255
# If a header is given, the user is informed, that this header must be included
256
# for the mentioned element to be defined.
257
258
ALIASES = "sfplatform{1}=<dl class=\"attention\"><dt>Platform Limitation</dt><dd><b>This is only available on \1.</b></dd></dl>" \
259
"sfplatform{2}=<dl class=\"attention\"><dt>Platform Limitation</dt><dd><b>This is only available on \1</b> and to use it, you'll have to specifically include \2 in your code.</dd></dl>"
260
261
# This tag can be used to specify a number of word-keyword mappings (TCL only).
262
# A mapping has the form "name=value". For example adding "class=itcl::class"
263
# will allow you to use the command class in the itcl::class meaning.
264
265
TCL_SUBST =
266
267
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
268
# only. Doxygen will then generate output that is more tailored for C. For
269
# instance, some of the names that are used will be different. The list of all
270
# members will be omitted, etc.
271
# The default value is: NO.
272
273
OPTIMIZE_OUTPUT_FOR_C = NO
274
275
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
276
# Python sources only. Doxygen will then generate output that is more tailored
277
# for that language. For instance, namespaces will be presented as packages,
278
# qualified scopes will look different, etc.
279
# The default value is: NO.
205
280
206
281
OPTIMIZE_OUTPUT_JAVA = NO
207
282
208
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
209
# sources only. Doxygen will then generate output that is more tailored for
210
# Fortran.
283
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
284
# sources. Doxygen will then generate output that is tailored for Fortran.
285
# The default value is: NO.
211
286
212
287
OPTIMIZE_FOR_FORTRAN = NO
213
288
214
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
215
# sources. Doxygen will then generate output that is tailored for
216
# VHDL.
289
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
290
# sources. Doxygen will then generate output that is tailored for VHDL.
291
# The default value is: NO.
217
292
218
293
OPTIMIZE_OUTPUT_VHDL = NO
219
294
220
# Doxygen selects the parser to use depending on the extension of the files it parses.
221
# With this tag you can assign which parser to use for a given extension.
222
# Doxygen has a built-in mapping, but you can override or extend it using this tag.
223
# The format is ext=language, where ext is a file extension, and language is one of
224
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
225
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
226
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
227
# use: inc=Fortran f=C
228
229
EXTENSION_MAPPING =
230
231
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
232
# to include (a tag file for) the STL sources as input, then you should
233
# set this tag to YES in order to let doxygen match functions declarations and
234
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
235
# func(std::string) {}). This also make the inheritance and collaboration
295
# Doxygen selects the parser to use depending on the extension of the files it
296
# parses. With this tag you can assign which parser to use for a given
297
# extension. Doxygen has a built-in mapping, but you can override or extend it
298
# using this tag. The format is ext=language, where ext is a file extension, and
299
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
300
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
301
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
302
# Fortran. In the later case the parser tries to guess whether the code is fixed
303
# or free formatted code, this is the default for Fortran type files), VHDL. For
304
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
305
# and .f files as C (default is Fortran), use: inc=Fortran f=C.
306
#
307
# Note: For files without extension you can use no_extension as a placeholder.
308
#
309
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
310
# the files are not read by doxygen.
311
312
EXTENSION_MAPPING =
313
314
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
315
# according to the Markdown format, which allows for more readable
316
# documentation. See http://daringfireball.net/projects/markdown/ for details.
317
# The output of markdown processing is further processed by doxygen, so you can
318
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
319
# case of backward compatibilities issues.
320
# The default value is: YES.
321
322
MARKDOWN_SUPPORT = YES
323
324
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
325
# to that level are automatically included in the table of contents, even if
326
# they do not have an id attribute.
327
# Note: This feature currently applies only to Markdown headings.
328
# Minimum value: 0, maximum value: 99, default value: 0.
329
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
330
331
TOC_INCLUDE_HEADINGS = 0
332
333
# When enabled doxygen tries to link words that correspond to documented
334
# classes, or namespaces to their corresponding documentation. Such a link can
335
# be prevented in individual cases by putting a % sign in front of the word or
336
# globally by setting AUTOLINK_SUPPORT to NO.
337
# The default value is: YES.
338
339
AUTOLINK_SUPPORT = YES
340
341
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
342
# to include (a tag file for) the STL sources as input, then you should set this
343
# tag to YES in order to let doxygen match functions declarations and
344
# definitions whose arguments contain STL classes (e.g. func(std::string);
345
# versus func(std::string) {}). This also make the inheritance and collaboration
236
346
# diagrams that involve STL classes more complete and accurate.
347
# The default value is: NO.
237
348
238
349
BUILTIN_STL_SUPPORT = NO
239
350
240
# If you use Microsoft's C++/CLI language, you should set this option to YES to
351
# If you use Microsoft's C++/CLI language, you should set this option to YES to
241
352
# enable parsing support.
353
# The default value is: NO.
242
354
243
355
CPP_CLI_SUPPORT = NO
244
356
245
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
246
# Doxygen will parse them like normal C++ but will assume all classes use public
247
# instead of private inheritance when no explicit protection keyword is present.
357
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
358
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
359
# will parse them like normal C++ but will assume all classes use public instead
360
# of private inheritance when no explicit protection keyword is present.
361
# The default value is: NO.
248
362
249
363
SIP_SUPPORT = NO
250
364
251
# For Microsoft's IDL there are propget and propput attributes to indicate getter
252
# and setter methods for a property. Setting this option to YES (the default)
253
# will make doxygen to replace the get and set methods by a property in the
254
# documentation. This will only work if the methods are indeed getting or
255
# setting a simple type. If this is not the case, or you want to show the
256
# methods anyway, you should set this option to NO.
365
# For Microsoft's IDL there are propget and propput attributes to indicate
366
# getter and setter methods for a property. Setting this option to YES will make
367
# doxygen to replace the get and set methods by a property in the documentation.
368
# This will only work if the methods are indeed getting or setting a simple
369
# type. If this is not the case, or you want to show the methods anyway, you
370
# should set this option to NO.
371
# The default value is: YES.
257
372
258
373
IDL_PROPERTY_SUPPORT = YES
259
374
260
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
261
# tag is set to YES, then doxygen will reuse the documentation of the first
262
# member in the group (if any) for the other members of the group. By default
375
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
376
# tag is set to YES then doxygen will reuse the documentation of the first
377
# member in the group (if any) for the other members of the group. By default
263
378
# all members of a group must be documented explicitly.
379
# The default value is: NO.
264
380
265
381
DISTRIBUTE_GROUP_DOC = NO
266
382
267
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
268
# the same type (for instance a group of public functions) to be put as a
269
# subgroup of that type (e.g. under the Public Functions section). Set it to
270
# NO to prevent subgrouping. Alternatively, this can be done per class using
271
# the \nosubgrouping command.
383
# If one adds a struct or class to a group and this option is enabled, then also
384
# any nested class or struct is added to the same group. By default this option
385
# is disabled and one has to add nested compounds explicitly via \ingroup.
386
# The default value is: NO.
387
388
GROUP_NESTED_COMPOUNDS = NO
389
390
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
391
# (for instance a group of public functions) to be put as a subgroup of that
392
# type (e.g. under the Public Functions section). Set it to NO to prevent
393
# subgrouping. Alternatively, this can be done per class using the
394
# \nosubgrouping command.
395
# The default value is: YES.
272
396
273
397
SUBGROUPING = YES
274
398
275
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
276
# is documented as struct, union, or enum with the name of the typedef. So
277
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
278
# with name TypeT. When disabled the typedef will appear as a member of a file,
279
# namespace, or class. And the struct will be named TypeS. This can typically
280
# be useful for C code in case the coding convention dictates that all compound
399
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
400
# are shown inside the group in which they are included (e.g. using \ingroup)
401
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
402
# and RTF).
403
#
404
# Note that this feature does not work in combination with
405
# SEPARATE_MEMBER_PAGES.
406
# The default value is: NO.
407
408
INLINE_GROUPED_CLASSES = NO
409
410
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
411
# with only public data fields or simple typedef fields will be shown inline in
412
# the documentation of the scope in which they are defined (i.e. file,
413
# namespace, or group documentation), provided this scope is documented. If set
414
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
415
# Man pages) or section (for LaTeX and RTF).
416
# The default value is: NO.
417
418
INLINE_SIMPLE_STRUCTS = NO
419
420
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
421
# enum is documented as struct, union, or enum with the name of the typedef. So
422
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
423
# with name TypeT. When disabled the typedef will appear as a member of a file,
424
# namespace, or class. And the struct will be named TypeS. This can typically be
425
# useful for C code in case the coding convention dictates that all compound
281
426
# types are typedef'ed and only the typedef is referenced, never the tag name.
427
# The default value is: NO.
282
428
283
429
TYPEDEF_HIDES_STRUCT = NO
284
430
285
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
286
# determine which symbols to keep in memory and which to flush to disk.
287
# When the cache is full, less often used symbols will be written to disk.
288
# For small to medium size projects (<1000 input files) the default value is
289
# probably good enough. For larger projects a too small cache size can cause
290
# doxygen to be busy swapping symbols to and from disk most of the time
291
# causing a significant performance penality.
292
# If the system has enough physical memory increasing the cache will improve the
293
# performance by keeping more symbols in memory. Note that the value works on
294
# a logarithmic scale so increasing the size by one will rougly double the
295
# memory usage. The cache size is given by this formula:
296
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
297
# corresponding to a cache size of 2^16 = 65536 symbols
431
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
432
# cache is used to resolve symbols given their name and scope. Since this can be
433
# an expensive process and often the same symbol appears multiple times in the
434
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
435
# doxygen will become slower. If the cache is too large, memory is wasted. The
436
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
437
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
438
# symbols. At the end of a run doxygen will report the cache usage and suggest
439
# the optimal cache size from a speed point of view.
440
# Minimum value: 0, maximum value: 9, default value: 0.
298
441
299
SYMBOL_CACHE_SIZE = 0
442
LOOKUP_CACHE_SIZE = 0
300
443
301
444
#---------------------------------------------------------------------------
302
445
# Build related configuration options
303
446
#---------------------------------------------------------------------------
304
447
305
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
306
# documentation are documented, even if no documentation was available.
307
# Private class members and static file members will be hidden unless
308
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
309
310
EXTRACT_ALL = YES
311
312
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
313
# will be included in the documentation.
448
# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
449
# documentation are documented, even if no documentation was available. Private
450
# class members and static file members will be hidden unless the
451
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
452
# Note: This will also disable the warnings about undocumented members that are
453
# normally produced when WARNINGS is set to YES.
454
# The default value is: NO.
455
456
EXTRACT_ALL = NO
457
458
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
459
# be included in the documentation.
460
# The default value is: NO.
314
461
315
462
EXTRACT_PRIVATE = NO
316
463
317
# If the EXTRACT_STATIC tag is set to YES all static members of a file
318
# will be included in the documentation.
319
320
EXTRACT_STATIC = NO
321
322
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
323
# defined locally in source files will be included in the documentation.
324
# If set to NO only classes defined in header files are included.
325
326
EXTRACT_LOCAL_CLASSES = NO
327
328
# This flag is only useful for Objective-C code. When set to YES local
329
# methods, which are defined in the implementation section but not in
330
# the interface are included in the documentation.
331
# If set to NO (the default) only methods in the interface are included.
464
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
465
# scope will be included in the documentation.
466
# The default value is: NO.
467
468
EXTRACT_PACKAGE = NO
469
470
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
471
# included in the documentation.
472
# The default value is: NO.
473
474
EXTRACT_STATIC = YES
475
476
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
477
# locally in source files will be included in the documentation. If set to NO,
478
# only classes defined in header files are included. Does not have any effect
479
# for Java sources.
480
# The default value is: YES.
481
482
EXTRACT_LOCAL_CLASSES = YES
483
484
# This flag is only useful for Objective-C code. If set to YES, local methods,
485
# which are defined in the implementation section but not in the interface are
486
# included in the documentation. If set to NO, only methods in the interface are
487
# included.
488
# The default value is: NO.
332
489
333
490
EXTRACT_LOCAL_METHODS = NO
334
491
335
# If this flag is set to YES, the members of anonymous namespaces will be
336
# extracted and appear in the documentation as a namespace called
337
# 'anonymous_namespace{file}', where file will be replaced with the base
338
# name of the file that contains the anonymous namespace. By default
339
# anonymous namespace are hidden.
492
# If this flag is set to YES, the members of anonymous namespaces will be
493
# extracted and appear in the documentation as a namespace called
494
# 'anonymous_namespace{file}', where file will be replaced with the base name of
495
# the file that contains the anonymous namespace. By default anonymous namespace
496
# are hidden.
497
# The default value is: NO.
340
498
341
499
EXTRACT_ANON_NSPACES = NO
342
500
343
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
344
# undocumented members of documented classes, files or namespaces.
345
# If set to NO (the default) these members will be included in the
346
# various overviews, but no documentation section is generated.
347
# This option has no effect if EXTRACT_ALL is enabled.
501
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
502
# undocumented members inside documented classes or files. If set to NO these
503
# members will be included in the various overviews, but no documentation
504
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
505
# The default value is: NO.
348
506
349
507
HIDE_UNDOC_MEMBERS = NO
350
508
351
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
352
# undocumented classes that are normally visible in the class hierarchy.
353
# If set to NO (the default) these classes will be included in the various
354
# overviews. This option has no effect if EXTRACT_ALL is enabled.
509
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
510
# undocumented classes that are normally visible in the class hierarchy. If set
511
# to NO, these classes will be included in the various overviews. This option
512
# has no effect if EXTRACT_ALL is enabled.
513
# The default value is: NO.
355
514
356
515
HIDE_UNDOC_CLASSES = NO
357
516
358
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
359
# friend (class|struct|union) declarations.
360
# If set to NO (the default) these declarations will be included in the
361
# documentation.
517
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
518
# (class|struct|union) declarations. If set to NO, these declarations will be
519
# included in the documentation.
520
# The default value is: NO.
362
521
363
522
HIDE_FRIEND_COMPOUNDS = NO
364
523
365
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
366
# documentation blocks found inside the body of a function.
367
# If set to NO (the default) these blocks will be appended to the
368
# function's detailed documentation block.
524
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
525
# documentation blocks found inside the body of a function. If set to NO, these
526
# blocks will be appended to the function's detailed documentation block.
527
# The default value is: NO.
369
528
370
529
HIDE_IN_BODY_DOCS = NO
371
530
372
# The INTERNAL_DOCS tag determines if documentation
373
# that is typed after a \internal command is included. If the tag is set
374
# to NO (the default) then the documentation will be excluded.
375
# Set it to YES to include the internal documentation.
531
# The INTERNAL_DOCS tag determines if documentation that is typed after a
532
# \internal command is included. If the tag is set to NO then the documentation
533
# will be excluded. Set it to YES to include the internal documentation.
534
# The default value is: NO.
376
535
377
536
INTERNAL_DOCS = NO
378
537
379
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
380
# file names in lower-case letters. If set to YES upper-case letters are also
381
# allowed. This is useful if you have classes or files whose names only differ
382
# in case and if your file system supports case sensitive file names. Windows
538
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
539
# names in lower-case letters. If set to YES, upper-case letters are also
540
# allowed. This is useful if you have classes or files whose names only differ
541
# in case and if your file system supports case sensitive file names. Windows
383
542
# and Mac users are advised to set this option to NO.
543
# The default value is: system dependent.
384
544
385
545
CASE_SENSE_NAMES = YES
386
546
387
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
388
# will show members with their full class and namespace scopes in the
389
# documentation. If set to YES the scope will be hidden.
547
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
548
# their full class and namespace scopes in the documentation. If set to YES, the
549
# scope will be hidden.
550
# The default value is: NO.
390
551
391
552
HIDE_SCOPE_NAMES = NO
392
553
393
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
394
# will put a list of the files that are included by a file in the documentation
395
# of that file.
554
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
555
# append additional text to a page's title, such as Class Reference. If set to
556
# YES the compound reference will be hidden.
557
# The default value is: NO.
558
559
HIDE_COMPOUND_REFERENCE= NO
560
561
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
562
# the files that are included by a file in the documentation of that file.
563
# The default value is: YES.
396
564
397
565
SHOW_INCLUDE_FILES = YES
398
566
399
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
400
# is inserted in the documentation for inline members.
567
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
568
# grouped member an include statement to the documentation, telling the reader
569
# which file to include in order to use the member.
570
# The default value is: NO.
571
572
SHOW_GROUPED_MEMB_INC = NO
573
574
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
575
# files with double quotes in the documentation rather than with sharp brackets.
576
# The default value is: NO.
577
578
FORCE_LOCAL_INCLUDES = NO
579
580
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
581
# documentation for inline members.
582
# The default value is: YES.
401
583
402
584
INLINE_INFO = YES
403
585
404
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
405
# will sort the (detailed) documentation of file and class members
406
# alphabetically by member name. If set to NO the members will appear in
407
# declaration order.
586
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
587
# (detailed) documentation of file and class members alphabetically by member
588
# name. If set to NO, the members will appear in declaration order.
589
# The default value is: YES.
408
590
409
591
SORT_MEMBER_DOCS = YES
410
592
411
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
412
# brief documentation of file, namespace and class members alphabetically
413
# by member name. If set to NO (the default) the members will appear in
414
# declaration order.
593
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
594
# descriptions of file, namespace and class members alphabetically by member
595
# name. If set to NO, the members will appear in declaration order. Note that
596
# this will also influence the order of the classes in the class list.
597
# The default value is: NO.
415
598
416
599
SORT_BRIEF_DOCS = NO
417
600
418
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
419
# hierarchy of group names into alphabetical order. If set to NO (the default)
420
# the group names will appear in their defined order.
601
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
602
# (brief and detailed) documentation of class members so that constructors and
603
# destructors are listed first. If set to NO the constructors will appear in the
604
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
605
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
606
# member documentation.
607
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
608
# detailed member documentation.
609
# The default value is: NO.
610
611
SORT_MEMBERS_CTORS_1ST = NO
612
613
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
614
# of group names into alphabetical order. If set to NO the group names will
615
# appear in their defined order.
616
# The default value is: NO.
421
617
422
618
SORT_GROUP_NAMES = NO
423
619
424
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
425
# sorted by fully-qualified names, including namespaces. If set to
426
# NO (the default), the class list will be sorted only by class name,
427
# not including the namespace part.
428
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
429
# Note: This option applies only to the class list, not to the
430
# alphabetical list.
620
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
621
# fully-qualified names, including namespaces. If set to NO, the class list will
622
# be sorted only by class name, not including the namespace part.
623
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
624
# Note: This option applies only to the class list, not to the alphabetical
625
# list.
626
# The default value is: NO.
431
627
432
628
SORT_BY_SCOPE_NAME = NO
433
629
434
# The GENERATE_TODOLIST tag can be used to enable (YES) or
435
# disable (NO) the todo list. This list is created by putting \todo
436
# commands in the documentation.
630
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
631
# type resolution of all parameters of a function it will reject a match between
632
# the prototype and the implementation of a member function even if there is
633
# only one candidate or it is obvious which candidate to choose by doing a
634
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
635
# accept a match between prototype and implementation in such cases.
636
# The default value is: NO.
637
638
STRICT_PROTO_MATCHING = NO
639
640
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
641
# list. This list is created by putting \todo commands in the documentation.
642
# The default value is: YES.
437
643
438
644
GENERATE_TODOLIST = YES
439
645
440
# The GENERATE_TESTLIST tag can be used to enable (YES) or
441
# disable (NO) the test list. This list is created by putting \test
442
# commands in the documentation.
646
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
647
# list. This list is created by putting \test commands in the documentation.
648
# The default value is: YES.
443
649
444
650
GENERATE_TESTLIST = YES
445
651
446
# The GENERATE_BUGLIST tag can be used to enable (YES) or
447
# disable (NO) the bug list. This list is created by putting \bug
448
# commands in the documentation.
652
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
653
# list. This list is created by putting \bug commands in the documentation.
654
# The default value is: YES.
449
655
450
656
GENERATE_BUGLIST = YES
451
657
452
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
453
# disable (NO) the deprecated list. This list is created by putting
454
# \deprecated commands in the documentation.
658
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
659
# the deprecated list. This list is created by putting \deprecated commands in
660
# the documentation.
661
# The default value is: YES.
455
662
456
663
GENERATE_DEPRECATEDLIST= YES
457
664
458
# The ENABLED_SECTIONS tag can be used to enable conditional
459
# documentation sections, marked by \if sectionname ... \endif.
460
461
ENABLED_SECTIONS =
462
463
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
464
# the initial value of a variable or define consists of for it to appear in
465
# the documentation. If the initializer consists of more lines than specified
466
# here it will be hidden. Use a value of 0 to hide initializers completely.
467
# The appearance of the initializer of individual variables and defines in the
468
# documentation can be controlled using \showinitializer or \hideinitializer
469
# command in the documentation regardless of this setting.
665
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
666
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
667
# ... \endcond blocks.
668
669
ENABLED_SECTIONS =
670
671
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
672
# initial value of a variable or macro / define can have for it to appear in the
673
# documentation. If the initializer consists of more lines than specified here
674
# it will be hidden. Use a value of 0 to hide initializers completely. The
675
# appearance of the value of individual variables and macros / defines can be
676
# controlled using \showinitializer or \hideinitializer command in the
677
# documentation regardless of this setting.
678
# Minimum value: 0, maximum value: 10000, default value: 30.
470
679
471
680
MAX_INITIALIZER_LINES = 30
472
681
473
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
474
# at the bottom of the documentation of classes and structs. If set to YES the
682
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
683
# the bottom of the documentation of classes and structs. If set to YES, the
475
684
# list will mention the files that were used to generate the documentation.
685
# The default value is: YES.
476
686
477
687
SHOW_USED_FILES = YES
478
688
479
# If the sources in your project are distributed over multiple directories
480
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
481
# in the documentation. The default is NO.
482
483
SHOW_DIRECTORIES = NO
484
485
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
486
# This will remove the Files entry from the Quick Index and from the
487
# Folder Tree View (if specified). The default is YES.
689
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
690
# will remove the Files entry from the Quick Index and from the Folder Tree View
691
# (if specified).
692
# The default value is: YES.
488
693
489
694
SHOW_FILES = YES
490
695
491
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
492
# Namespaces page. This will remove the Namespaces entry from the Quick Index
493
# and from the Folder Tree View (if specified). The default is YES.
696
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
697
# page. This will remove the Namespaces entry from the Quick Index and from the
698
# Folder Tree View (if specified).
699
# The default value is: YES.
494
700
495
701
SHOW_NAMESPACES = YES
496
702
497
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
498
# doxygen should invoke to get the current version for each file (typically from
499
# the version control system). Doxygen will invoke the program by executing (via
500
# popen()) the command <command> <input-file>, where <command> is the value of
501
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
502
# provided by doxygen. Whatever the program writes to standard output
503
# is used as the file version. See the manual for examples.
504
505
FILE_VERSION_FILTER =
506
507
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
508
# doxygen. The layout file controls the global structure of the generated output files
509
# in an output format independent way. The create the layout file that represents
510
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
511
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
512
# of the layout file.
513
514
LAYOUT_FILE =
515
516
#---------------------------------------------------------------------------
517
# configuration options related to warning and progress messages
518
#---------------------------------------------------------------------------
519
520
# The QUIET tag can be used to turn on/off the messages that are generated
521
# by doxygen. Possible values are YES and NO. If left blank NO is used.
703
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
704
# doxygen should invoke to get the current version for each file (typically from
705
# the version control system). Doxygen will invoke the program by executing (via
706
# popen()) the command command input-file, where command is the value of the
707
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
708
# by doxygen. Whatever the program writes to standard output is used as the file
709
# version. For an example see the documentation.
710
711
FILE_VERSION_FILTER =
712
713
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
714
# by doxygen. The layout file controls the global structure of the generated
715
# output files in an output format independent way. To create the layout file
716
# that represents doxygen's defaults, run doxygen with the -l option. You can
717
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
718
# will be used as the name of the layout file.
719
#
720
# Note that if you run doxygen from a directory containing a file called
721
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
722
# tag is left empty.
723
724
LAYOUT_FILE =
725
726
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
727
# the reference definitions. This must be a list of .bib files. The .bib
728
# extension is automatically appended if omitted. This requires the bibtex tool
729
# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
730
# For LaTeX the style of the bibliography can be controlled using
731
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
732
# search path. See also \cite for info how to create references.
733
734
CITE_BIB_FILES =
735
736
#---------------------------------------------------------------------------
737
# Configuration options related to warning and progress messages
738
#---------------------------------------------------------------------------
739
740
# The QUIET tag can be used to turn on/off the messages that are generated to
741
# standard output by doxygen. If QUIET is set to YES this implies that the
742
# messages are off.
743
# The default value is: NO.
522
744
523
745
QUIET = NO
524
746
525
# The WARNINGS tag can be used to turn on/off the warning messages that are
526
# generated by doxygen. Possible values are YES and NO. If left blank
527
# NO is used.
747
# The WARNINGS tag can be used to turn on/off the warning messages that are
748
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
749
# this implies that the warnings are on.
750
#
751
# Tip: Turn warnings on while writing the documentation.
752
# The default value is: YES.
528
753
529
754
WARNINGS = YES
530
755
531
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
532
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
533
# automatically be disabled.
756
# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
757
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
758
# will automatically be disabled.
759
# The default value is: YES.
534
760
535
761
WARN_IF_UNDOCUMENTED = YES
536
762
537
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
538
# potential errors in the documentation, such as not documenting some
539
# parameters in a documented function, or documenting parameters that
540
# don't exist or using markup commands wrongly.
763
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
764
# potential errors in the documentation, such as not documenting some parameters
765
# in a documented function, or documenting parameters that don't exist or using
766
# markup commands wrongly.
767
# The default value is: YES.
541
768
542
769
WARN_IF_DOC_ERROR = YES
543
770
544
# This WARN_NO_PARAMDOC option can be abled to get warnings for
545
# functions that are documented, but have no documentation for their parameters
546
# or return value. If set to NO (the default) doxygen will only warn about
547
# wrong or incomplete parameter documentation, but not about the absence of
548
# documentation.
771
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
772
# are documented, but have no documentation for their parameters or return
773
# value. If set to NO, doxygen will only warn about wrong or incomplete
774
# parameter documentation, but not about the absence of documentation.
775
# The default value is: NO.
549
776
550
777
WARN_NO_PARAMDOC = YES
551
778
552
# The WARN_FORMAT tag determines the format of the warning messages that
553
# doxygen can produce. The string should contain the $file, $line, and $text
554
# tags, which will be replaced by the file and line number from which the
555
# warning originated and the warning text. Optionally the format may contain
556
# $version, which will be replaced by the version of the file (if it could
557
# be obtained via FILE_VERSION_FILTER)
779
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
780
# a warning is encountered.
781
# The default value is: NO.
782
783
WARN_AS_ERROR = NO
784
785
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
786
# can produce. The string should contain the $file, $line, and $text tags, which
787
# will be replaced by the file and line number from which the warning originated
788
# and the warning text. Optionally the format may contain $version, which will
789
# be replaced by the version of the file (if it could be obtained via
790
# FILE_VERSION_FILTER)
791
# The default value is: $file:$line: $text.
558
792
559
793
WARN_FORMAT = "$file:$line: $text"
560
794
561
# The WARN_LOGFILE tag can be used to specify a file to which warning
562
# and error messages should be written. If left blank the output is written
563
# to stderr.
564
565
WARN_LOGFILE =
566
567
#---------------------------------------------------------------------------
568
# configuration options related to the input files
569
#---------------------------------------------------------------------------
570
571
# The INPUT tag can be used to specify the files and/or directories that contain
572
# documented source files. You may enter file names like "myfile.cpp" or
573
# directories like "/usr/src/myproject". Separate the files or directories
574
# with spaces.
795
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
796
# messages should be written. If left blank the output is written to standard
797
# error (stderr).
798
799
WARN_LOGFILE =
800
801
#---------------------------------------------------------------------------
802
# Configuration options related to the input files
803
#---------------------------------------------------------------------------
804
805
# The INPUT tag is used to specify the files and/or directories that contain
806
# documented source files. You may enter file names like myfile.cpp or
807
# directories like /usr/src/myproject. Separate the files or directories with
808
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
809
# Note: If this tag is empty the current directory is searched.
575
810
576
811
INPUT = "@DOXYGEN_INPUT_DIR@/include/SFML" \
577
812
"@DOXYGEN_INPUT_DIR@/doc/mainpage.hpp"
578
813
579
# This tag can be used to specify the character encoding of the source files
580
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
581
# also the default input encoding. Doxygen uses libiconv (or the iconv built
582
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
583
# the list of possible encodings.
814
# This tag can be used to specify the character encoding of the source files
815
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
816
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
817
# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
818
# possible encodings.
819
# The default value is: UTF-8.
584
820
585
821
INPUT_ENCODING = UTF-8
586
822
587
# If the value of the INPUT tag contains directories, you can use the
588
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
589
# and *.h) to filter out the source-files in the directories. If left
590
# blank the following patterns are tested:
591
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
592
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
823
# If the value of the INPUT tag contains directories, you can use the
824
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
825
# *.h) to filter out the source-files in the directories.
826
#
827
# Note that for custom extensions or not directly supported extensions you also
828
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
829
# read by doxygen.
830
#
831
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
832
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
833
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
834
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
835
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
593
836
594
837
FILE_PATTERNS = *.h \
595
*.hpp
838
*.hpp
596
839
597
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
598
# should be searched for input files as well. Possible values are YES and NO.
599
# If left blank NO is used.
840
# The RECURSIVE tag can be used to specify whether or not subdirectories should
841
# be searched for input files as well.
842
# The default value is: NO.
600
843
601
844
RECURSIVE = YES
602
845
603
# The EXCLUDE tag can be used to specify files and/or directories that should
604
# excluded from the INPUT source files. This way you can easily exclude a
846
# The EXCLUDE tag can be used to specify files and/or directories that should be
847
# excluded from the INPUT source files. This way you can easily exclude a
605
848
# subdirectory from a directory tree whose root is specified with the INPUT tag.
606
607
EXCLUDE =
608
609
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
610
# directories that are symbolic links (a Unix filesystem feature) are excluded
849
#
850
# Note that relative paths are relative to the directory from which doxygen is
851
# run.
852
853
EXCLUDE =
854
855
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
856
# directories that are symbolic links (a Unix file system feature) are excluded
611
857
# from the input.
858
# The default value is: NO.
612
859
613
860
EXCLUDE_SYMLINKS = NO
614
861
615
# If the value of the INPUT tag contains directories, you can use the
616
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
617
# certain files from those directories. Note that the wildcards are matched
618
# against the file with absolute path, so to exclude all test directories
619
# for example use the pattern */test/*
620
621
EXCLUDE_PATTERNS = .svn
622
623
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
624
# (namespaces, classes, functions, etc.) that should be excluded from the
625
# output. The symbol name can be a fully qualified name, a word, or if the
626
# wildcard * is used, a substring. Examples: ANamespace, AClass,
862
# If the value of the INPUT tag contains directories, you can use the
863
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
864
# certain files from those directories.
865
#
866
# Note that the wildcards are matched against the file with absolute path, so to
867
# exclude all test directories for example use the pattern */test/*
868
869
EXCLUDE_PATTERNS = .git \
870
extlibs \
871
src \
872
examples \
873
install \
874
build \
875
tools \
876
cmake
877
878
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
879
# (namespaces, classes, functions, etc.) that should be excluded from the
880
# output. The symbol name can be a fully qualified name, a word, or if the
881
# wildcard * is used, a substring. Examples: ANamespace, AClass,
627
882
# AClass::ANamespace, ANamespace::*Test
628
629
EXCLUDE_SYMBOLS =
630
631
# The EXAMPLE_PATH tag can be used to specify one or more files or
632
# directories that contain example code fragments that are included (see
633
# the \include command).
634
635
EXAMPLE_PATH =
636
637
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
638
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
639
# and *.h) to filter out the source-files in the directories. If left
640
# blank all files are included.
883
#
884
# Note that the wildcards are matched against the file with absolute path, so to
885
# exclude all test directories use the pattern */test/*
886
887
EXCLUDE_SYMBOLS = priv
888
889
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
890
# that contain example code fragments that are included (see the \include
891
# command).
892
893
EXAMPLE_PATH =
894
895
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
896
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
897
# *.h) to filter out the source-files in the directories. If left blank all
898
# files are included.
641
899
642
900
EXAMPLE_PATTERNS = *
643
901
644
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
645
# searched for input files to be used with the \include or \dontinclude
646
# commands irrespective of the value of the RECURSIVE tag.
647
# Possible values are YES and NO. If left blank NO is used.
902
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
903
# searched for input files to be used with the \include or \dontinclude commands
904
# irrespective of the value of the RECURSIVE tag.
905
# The default value is: NO.
648
906
649
907
EXAMPLE_RECURSIVE = NO
650
908
651
# The IMAGE_PATH tag can be used to specify one or more files or
652
# directories that contain image that are included in the documentation (see
653
# the \image command).
654
655
IMAGE_PATH =
656
657
# The INPUT_FILTER tag can be used to specify a program that doxygen should
658
# invoke to filter for each input file. Doxygen will invoke the filter program
659
# by executing (via popen()) the command <filter> <input-file>, where <filter>
660
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
661
# input file. Doxygen will then use the output that the filter program writes
662
# to standard output. If FILTER_PATTERNS is specified, this tag will be
663
# ignored.
664
665
INPUT_FILTER =
666
667
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
668
# basis. Doxygen will compare the file name with each pattern and apply the
669
# filter if there is a match. The filters are a list of the form:
670
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
671
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
672
# is applied to all files.
673
674
FILTER_PATTERNS =
675
676
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
677
# INPUT_FILTER) will be used to filter the input files when producing source
678
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
909
# The IMAGE_PATH tag can be used to specify one or more files or directories
910
# that contain images that are to be included in the documentation (see the
911
# \image command).
912
913
IMAGE_PATH =
914
915
# The INPUT_FILTER tag can be used to specify a program that doxygen should
916
# invoke to filter for each input file. Doxygen will invoke the filter program
917
# by executing (via popen()) the command:
918
#
919
# <filter> <input-file>
920
#
921
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
922
# name of an input file. Doxygen will then use the output that the filter
923
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
924
# will be ignored.
925
#
926
# Note that the filter must not add or remove lines; it is applied before the
927
# code is scanned, but not when the output code is generated. If lines are added
928
# or removed, the anchors will not be placed correctly.
929
#
930
# Note that for custom extensions or not directly supported extensions you also
931
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
932
# properly processed by doxygen.
933
934
INPUT_FILTER =
935
936
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
937
# basis. Doxygen will compare the file name with each pattern and apply the
938
# filter if there is a match. The filters are a list of the form: pattern=filter
939
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
940
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
941
# patterns match the file name, INPUT_FILTER is applied.
942
#
943
# Note that for custom extensions or not directly supported extensions you also
944
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
945
# properly processed by doxygen.
946
947
FILTER_PATTERNS =
948
949
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
950
# INPUT_FILTER) will also be used to filter the input files that are used for
951
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
952
# The default value is: NO.
679
953
680
954
FILTER_SOURCE_FILES = NO
681
955
682
#---------------------------------------------------------------------------
683
# configuration options related to source browsing
684
#---------------------------------------------------------------------------
685
686
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
687
# be generated. Documented entities will be cross-referenced with these sources.
688
# Note: To get rid of all source code in the generated output, make sure also
689
# VERBATIM_HEADERS is set to NO.
956
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
957
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
958
# it is also possible to disable source filtering for a specific pattern using
959
# *.ext= (so without naming a filter).
960
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
961
962
FILTER_SOURCE_PATTERNS =
963
964
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
965
# is part of the input, its contents will be placed on the main page
966
# (index.html). This can be useful if you have a project on for instance GitHub
967
# and want to reuse the introduction page also for the doxygen output.
968
969
USE_MDFILE_AS_MAINPAGE =
970
971
#---------------------------------------------------------------------------
972
# Configuration options related to source browsing
973
#---------------------------------------------------------------------------
974
975
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
976
# generated. Documented entities will be cross-referenced with these sources.
977
#
978
# Note: To get rid of all source code in the generated output, make sure that
979
# also VERBATIM_HEADERS is set to NO.
980
# The default value is: NO.
690
981
691
982
SOURCE_BROWSER = YES
692
983
693
# Setting the INLINE_SOURCES tag to YES will include the body
694
# of functions and classes directly in the documentation.
984
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
985
# classes and enums directly into the documentation.
986
# The default value is: NO.
695
987
696
988
INLINE_SOURCES = NO
697
989
698
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
699
# doxygen to hide any special comment blocks from generated source code
700
# fragments. Normal C and C++ comments will always remain visible.
990
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
991
# special comment blocks from generated source code fragments. Normal C, C++ and
992
# Fortran comments will always remain visible.
993
# The default value is: YES.
701
994
702
995
STRIP_CODE_COMMENTS = YES
703
996
704
# If the REFERENCED_BY_RELATION tag is set to YES
705
# then for each documented function all documented
706
# functions referencing it will be listed.
997
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
998
# function all documented functions referencing it will be listed.
999
# The default value is: NO.
707
1000
708
1001
REFERENCED_BY_RELATION = NO
709
1002
710
# If the REFERENCES_RELATION tag is set to YES
711
# then for each documented function all documented entities
712
# called/used by that function will be listed.
1003
# If the REFERENCES_RELATION tag is set to YES then for each documented function
1004
# all documented entities called/used by that function will be listed.
1005
# The default value is: NO.
713
1006
714
1007
REFERENCES_RELATION = NO
715
1008
716
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
717
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
718
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
719
# link to the source code. Otherwise they will link to the documentation.
1009
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1010
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1011
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1012
# link to the documentation.
1013
# The default value is: YES.
720
1014
721
1015
REFERENCES_LINK_SOURCE = NO
722
1016
723
# If the USE_HTAGS tag is set to YES then the references to source code
724
# will point to the HTML generated by the htags(1) tool instead of doxygen
725
# built-in source browser. The htags tool is part of GNU's global source
726
# tagging system (see http://www.gnu.org/software/global/global.html). You
727
# will need version 4.8.6 or higher.
1017
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1018
# source code will show a tooltip with additional information such as prototype,
1019
# brief description and links to the definition and documentation. Since this
1020
# will make the HTML file larger and loading of large files a bit slower, you
1021
# can opt to disable this feature.
1022
# The default value is: YES.
1023
# This tag requires that the tag SOURCE_BROWSER is set to YES.
1024
1025
SOURCE_TOOLTIPS = YES
1026
1027
# If the USE_HTAGS tag is set to YES then the references to source code will
1028
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1029
# source browser. The htags tool is part of GNU's global source tagging system
1030
# (see https://www.gnu.org/software/global/global.html). You will need version
1031
# 4.8.6 or higher.
1032
#
1033
# To use it do the following:
1034
# - Install the latest version of global
1035
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1036
# - Make sure the INPUT points to the root of the source tree
1037
# - Run doxygen as normal
1038
#
1039
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1040
# tools must be available from the command line (i.e. in the search path).
1041
#
1042
# The result: instead of the source browser generated by doxygen, the links to
1043
# source code will now point to the output of htags.
1044
# The default value is: NO.
1045
# This tag requires that the tag SOURCE_BROWSER is set to YES.
728
1046
729
1047
USE_HTAGS = NO
730
1048
731
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
732
# will generate a verbatim copy of the header file for each class for
733
# which an include is specified. Set to NO to disable this.
1049
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1050
# verbatim copy of the header file for each class for which an include is
1051
# specified. Set to NO to disable this.
1052
# See also: Section \class.
1053
# The default value is: YES.
734
1054
735
1055
VERBATIM_HEADERS = YES
736
1056
737
1057
#---------------------------------------------------------------------------
738
# configuration options related to the alphabetical class index
1058
# Configuration options related to the alphabetical class index
739
1059
#---------------------------------------------------------------------------
740
1060
741
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
742
# of all compounds will be generated. Enable this if the project
743
# contains a lot of classes, structs, unions or interfaces.
1061
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1062
# compounds will be generated. Enable this if the project contains a lot of
1063
# classes, structs, unions or interfaces.
1064
# The default value is: YES.
744
1065
745
1066
ALPHABETICAL_INDEX = YES
746
1067
747
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
748
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
749
# in which this list will be split (can be a number in the range [1..20])
750
751
COLS_IN_ALPHA_INDEX = 5
752
753
# In case all classes in a project start with a common prefix, all
754
# classes will be put under the same header in the alphabetical index.
755
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
756
# should be ignored while generating the index headers.
757
758
IGNORE_PREFIX =
759
760
#---------------------------------------------------------------------------
761
# configuration options related to the HTML output
762
#---------------------------------------------------------------------------
763
764
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
765
# generate HTML output.
1068
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1069
# which the alphabetical index list will be split.
1070
# Minimum value: 1, maximum value: 20, default value: 5.
1071
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1072
1073
COLS_IN_ALPHA_INDEX = 3
1074
1075
# In case all classes in a project start with a common prefix, all classes will
1076
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1077
# can be used to specify a prefix (or a list of prefixes) that should be ignored
1078
# while generating the index headers.
1079
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1080
1081
IGNORE_PREFIX =
1082
1083
#---------------------------------------------------------------------------
1084
# Configuration options related to the HTML output
1085
#---------------------------------------------------------------------------
1086
1087
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1088
# The default value is: YES.
766
1089
767
1090
GENERATE_HTML = YES
768
1091
769
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
770
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
771
# put in front of it. If left blank `html' will be used as the default path.
1092
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1093
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1094
# it.
1095
# The default directory is: html.
1096
# This tag requires that the tag GENERATE_HTML is set to YES.
772
1097
773
1098
HTML_OUTPUT = html
774
1099
775
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
776
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
777
# doxygen will generate files with .html extension.
778
779
HTML_FILE_EXTENSION = .htm
780
781
# The HTML_HEADER tag can be used to specify a personal HTML header for
782
# each generated HTML page. If it is left blank doxygen will generate a
1100
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1101
# generated HTML page (for example: .htm, .php, .asp).
1102
# The default value is: .html.
1103
# This tag requires that the tag GENERATE_HTML is set to YES.
1104
1105
HTML_FILE_EXTENSION = .html
1106
1107
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1108
# each generated HTML page. If the tag is left blank doxygen will generate a
783
1109
# standard header.
784
785
HTML_HEADER = "@DOXYGEN_INPUT_DIR@/doc/header.htm"
786
787
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
788
# each generated HTML page. If it is left blank doxygen will generate a
789
# standard footer.
790
791
HTML_FOOTER = "@DOXYGEN_INPUT_DIR@/doc/footer.htm"
792
793
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
794
# style sheet that is used by each HTML page. It can be used to
795
# fine-tune the look of the HTML output. If the tag is left blank doxygen
796
# will generate a default style sheet. Note that doxygen will try to copy
797
# the style sheet file to the HTML output directory, so don't put your own
798
# stylesheet in the HTML output directory as well, or it will be erased!
1110
#
1111
# To get valid HTML the header file that includes any scripts and style sheets
1112
# that doxygen needs, which is dependent on the configuration options used (e.g.
1113
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1114
# default header using
1115
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1116
# YourConfigFile
1117
# and then modify the file new_header.html. See also section "Doxygen usage"
1118
# for information on how to generate the default header that doxygen normally
1119
# uses.
1120
# Note: The header is subject to change so you typically have to regenerate the
1121
# default header when upgrading to a newer version of doxygen. For a description
1122
# of the possible markers and block names see the documentation.
1123
# This tag requires that the tag GENERATE_HTML is set to YES.
1124
1125
HTML_HEADER = "@DOXYGEN_INPUT_DIR@/doc/header.html"
1126
1127
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1128
# generated HTML page. If the tag is left blank doxygen will generate a standard
1129
# footer. See HTML_HEADER for more information on how to generate a default
1130
# footer and what special commands can be used inside the footer. See also
1131
# section "Doxygen usage" for information on how to generate the default footer
1132
# that doxygen normally uses.
1133
# This tag requires that the tag GENERATE_HTML is set to YES.
1134
1135
HTML_FOOTER = "@DOXYGEN_INPUT_DIR@/doc/footer.html"
1136
1137
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1138
# sheet that is used by each HTML page. It can be used to fine-tune the look of
1139
# the HTML output. If left blank doxygen will generate a default style sheet.
1140
# See also section "Doxygen usage" for information on how to generate the style
1141
# sheet that doxygen normally uses.
1142
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1143
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1144
# obsolete.
1145
# This tag requires that the tag GENERATE_HTML is set to YES.
799
1146
800
1147
HTML_STYLESHEET = "@DOXYGEN_INPUT_DIR@/doc/doxygen.css"
801
1148
802
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
803
# files or namespaces will be aligned in HTML using tables. If set to
804
# NO a bullet list will be used.
805
806
HTML_ALIGN_MEMBERS = YES
807
808
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
809
# documentation will contain sections that can be hidden and shown after the
810
# page has loaded. For this to work a browser that supports
811
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
812
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
1149
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1150
# cascading style sheets that are included after the standard style sheets
1151
# created by doxygen. Using this option one can overrule certain style aspects.
1152
# This is preferred over using HTML_STYLESHEET since it does not replace the
1153
# standard style sheet and is therefore more robust against future updates.
1154
# Doxygen will copy the style sheet files to the output directory.
1155
# Note: The order of the extra style sheet files is of importance (e.g. the last
1156
# style sheet in the list overrules the setting of the previous ones in the
1157
# list). For an example see the documentation.
1158
# This tag requires that the tag GENERATE_HTML is set to YES.
1159
1160
HTML_EXTRA_STYLESHEET =
1161
1162
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1163
# other source files which should be copied to the HTML output directory. Note
1164
# that these files will be copied to the base HTML output directory. Use the
1165
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1166
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1167
# files will be copied as-is; there are no commands or markers available.
1168
# This tag requires that the tag GENERATE_HTML is set to YES.
1169
1170
HTML_EXTRA_FILES =
1171
1172
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1173
# will adjust the colors in the style sheet and background images according to
1174
# this color. Hue is specified as an angle on a colorwheel, see
1175
# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1176
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1177
# purple, and 360 is red again.
1178
# Minimum value: 0, maximum value: 359, default value: 220.
1179
# This tag requires that the tag GENERATE_HTML is set to YES.
1180
1181
HTML_COLORSTYLE_HUE = 220
1182
1183
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1184
# in the HTML output. For a value of 0 the output will use grayscales only. A
1185
# value of 255 will produce the most vivid colors.
1186
# Minimum value: 0, maximum value: 255, default value: 100.
1187
# This tag requires that the tag GENERATE_HTML is set to YES.
1188
1189
HTML_COLORSTYLE_SAT = 100
1190
1191
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1192
# luminance component of the colors in the HTML output. Values below 100
1193
# gradually make the output lighter, whereas values above 100 make the output
1194
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1195
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1196
# change the gamma.
1197
# Minimum value: 40, maximum value: 240, default value: 80.
1198
# This tag requires that the tag GENERATE_HTML is set to YES.
1199
1200
HTML_COLORSTYLE_GAMMA = 80
1201
1202
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1203
# page will contain the date and time when the page was generated. Setting this
1204
# to YES can help to show when doxygen was last run and thus if the
1205
# documentation is up to date.
1206
# The default value is: NO.
1207
# This tag requires that the tag GENERATE_HTML is set to YES.
1208
1209
HTML_TIMESTAMP = NO
1210
1211
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1212
# documentation will contain a main index with vertical navigation menus that
1213
# are dynamically created via Javascript. If disabled, the navigation index will
1214
# consists of multiple levels of tabs that are statically embedded in every HTML
1215
# page. Disable this option to support browsers that do not have Javascript,
1216
# like the Qt help browser.
1217
# The default value is: YES.
1218
# This tag requires that the tag GENERATE_HTML is set to YES.
1219
1220
HTML_DYNAMIC_MENUS = NO
1221
1222
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1223
# documentation will contain sections that can be hidden and shown after the
1224
# page has loaded.
1225
# The default value is: NO.
1226
# This tag requires that the tag GENERATE_HTML is set to YES.
813
1227
814
1228
HTML_DYNAMIC_SECTIONS = NO
815
1229
816
# If the GENERATE_DOCSET tag is set to YES, additional index files
817
# will be generated that can be used as input for Apple's Xcode 3
818
# integrated development environment, introduced with OSX 10.5 (Leopard).
819
# To create a documentation set, doxygen will generate a Makefile in the
820
# HTML output directory. Running make will produce the docset in that
821
# directory and running "make install" will install the docset in
822
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
823
# it at startup.
824
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
1230
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1231
# shown in the various tree structured indices initially; the user can expand
1232
# and collapse entries dynamically later on. Doxygen will expand the tree to
1233
# such a level that at most the specified number of entries are visible (unless
1234
# a fully collapsed tree already exceeds this amount). So setting the number of
1235
# entries 1 will produce a full collapsed tree by default. 0 is a special value
1236
# representing an infinite number of entries and will result in a full expanded
1237
# tree by default.
1238
# Minimum value: 0, maximum value: 9999, default value: 100.
1239
# This tag requires that the tag GENERATE_HTML is set to YES.
1240
1241
HTML_INDEX_NUM_ENTRIES = 100
1242
1243
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1244
# generated that can be used as input for Apple's Xcode 3 integrated development
1245
# environment (see: https://developer.apple.com/tools/xcode/), introduced with
1246
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1247
# Makefile in the HTML output directory. Running make will produce the docset in
1248
# that directory and running make install will install the docset in
1249
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1250
# startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1251
# for more information.
1252
# The default value is: NO.
1253
# This tag requires that the tag GENERATE_HTML is set to YES.
825
1254
826
1255
GENERATE_DOCSET = NO
827
1256
828
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
829
# feed. A documentation feed provides an umbrella under which multiple
830
# documentation sets from a single provider (such as a company or product suite)
831
# can be grouped.
832
833
DOCSET_FEEDNAME = "Doxygen generated docs"
834
835
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
836
# should uniquely identify the documentation set bundle. This should be a
837
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
838
# will append .docset to the name.
839
840
DOCSET_BUNDLE_ID = org.doxygen.Project
841
842
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
843
# will be generated that can be used as input for tools like the
844
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
845
# of the generated HTML documentation.
1257
# This tag determines the name of the docset feed. A documentation feed provides
1258
# an umbrella under which multiple documentation sets from a single provider
1259
# (such as a company or product suite) can be grouped.
1260
# The default value is: Doxygen generated docs.
1261
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1262
1263
DOCSET_FEEDNAME = "CSFML Documentation"
1264
1265
# This tag specifies a string that should uniquely identify the documentation
1266
# set bundle. This should be a reverse domain-name style string, e.g.
1267
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1268
# The default value is: org.doxygen.Project.
1269
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1270
1271
DOCSET_BUNDLE_ID = org.sfml-dev.CSFML
1272
1273
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1274
# the documentation publisher. This should be a reverse domain-name style
1275
# string, e.g. com.mycompany.MyDocSet.documentation.
1276
# The default value is: org.doxygen.Publisher.
1277
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1278
1279
DOCSET_PUBLISHER_ID = org.sfml-dev.CSFML
1280
1281
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1282
# The default value is: Publisher.
1283
# This tag requires that the tag GENERATE_DOCSET is set to YES.
1284
1285
DOCSET_PUBLISHER_NAME = CSFML
1286
1287
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1288
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1289
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1290
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1291
# Windows.
1292
#
1293
# The HTML Help Workshop contains a compiler that can convert all HTML output
1294
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1295
# files are now used as the Windows 98 help format, and will replace the old
1296
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1297
# HTML files also contain an index, a table of contents, and you can search for
1298
# words in the documentation. The HTML workshop also contains a viewer for
1299
# compressed HTML files.
1300
# The default value is: NO.
1301
# This tag requires that the tag GENERATE_HTML is set to YES.
846
1302
847
1303
GENERATE_HTMLHELP = @DOXYGEN_GENERATE_HTMLHELP@
848
1304
849
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
850
# be used to specify the file name of the resulting .chm file. You
851
# can add a path in front of the file if the result should not be
1305
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1306
# file. You can add a path in front of the file if the result should not be
852
1307
# written to the html output directory.
1308
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
853
1309
854
1310
CHM_FILE = ../CSFML.chm
855
1311
856
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
857
# be used to specify the location (absolute path including file name) of
858
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
859
# the HTML help compiler on the generated index.hhp.
1312
# The HHC_LOCATION tag can be used to specify the location (absolute path
1313
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1314
# doxygen will try to run the HTML help compiler on the generated index.hhp.
1315
# The file has to be specified with full path.
1316
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
860
1317
861
1318
HHC_LOCATION = "@DOXYGEN_HHC_PROGRAM@"
862
1319
863
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
864
# controls if a separate .chi index file is generated (YES) or that
865
# it should be included in the master .chm file (NO).
1320
# The GENERATE_CHI flag controls if a separate .chi index file is generated
1321
# (YES) or that it should be included in the master .chm file (NO).
1322
# The default value is: NO.
1323
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
866
1324
867
1325
GENERATE_CHI = NO
868
1326
869
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
870
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
871
# content.
872
873
CHM_INDEX_ENCODING =
874
875
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
876
# controls whether a binary table of contents is generated (YES) or a
877
# normal table of contents (NO) in the .chm file.
1327
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1328
# and project file content.
1329
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1330
1331
CHM_INDEX_ENCODING =
1332
1333
# The BINARY_TOC flag controls whether a binary table of contents is generated
1334
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1335
# enables the Previous and Next buttons.
1336
# The default value is: NO.
1337
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
878
1338
879
1339
BINARY_TOC = NO
880
1340
881
# The TOC_EXPAND flag can be set to YES to add extra items for group members
882
# to the contents of the HTML help documentation and to the tree view.
1341
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1342
# the table of contents of the HTML help documentation and to the tree view.
1343
# The default value is: NO.
1344
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
883
1345
884
1346
TOC_EXPAND = NO
885
1347
886
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
887
# are set, an additional index file will be generated that can be used as input for
888
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
889
# HTML documentation.
1348
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1349
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1350
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1351
# (.qch) of the generated HTML documentation.
1352
# The default value is: NO.
1353
# This tag requires that the tag GENERATE_HTML is set to YES.
890
1354
891
1355
GENERATE_QHP = NO
892
1356
893
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
894
# be used to specify the file name of the resulting .qch file.
895
# The path specified is relative to the HTML output folder.
896
897
QCH_FILE =
898
899
# The QHP_NAMESPACE tag specifies the namespace to use when generating
900
# Qt Help Project output. For more information please see
901
# http://doc.trolltech.com/qthelpproject.html#namespace
902
903
QHP_NAMESPACE =
904
905
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
906
# Qt Help Project output. For more information please see
907
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1357
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1358
# the file name of the resulting .qch file. The path specified is relative to
1359
# the HTML output folder.
1360
# This tag requires that the tag GENERATE_QHP is set to YES.
1361
1362
QCH_FILE =
1363
1364
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1365
# Project output. For more information please see Qt Help Project / Namespace
1366
# (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace).
1367
# The default value is: org.doxygen.Project.
1368
# This tag requires that the tag GENERATE_QHP is set to YES.
1369
1370
QHP_NAMESPACE = org.doxygen.Project
1371
1372
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1373
# Help Project output. For more information please see Qt Help Project / Virtual
1374
# Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders).
1375
# The default value is: doc.
1376
# This tag requires that the tag GENERATE_QHP is set to YES.
908
1377
909
1378
QHP_VIRTUAL_FOLDER = doc
910
1379
911
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
912
# For more information please see
913
# http://doc.trolltech.com/qthelpproject.html#custom-filters
914
915
QHP_CUST_FILTER_NAME =
916
917
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
918
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
919
920
QHP_CUST_FILTER_ATTRS =
921
922
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
923
# filter section matches.
924
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
925
926
QHP_SECT_FILTER_ATTRS =
927
928
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
929
# be used to specify the location of Qt's qhelpgenerator.
930
# If non-empty doxygen will try to run qhelpgenerator on the generated
931
# .qhp file.
932
933
QHG_LOCATION =
934
935
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
936
# top of each HTML page. The value NO (the default) enables the index and
937
# the value YES disables it.
1380
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1381
# filter to add. For more information please see Qt Help Project / Custom
1382
# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters).
1383
# This tag requires that the tag GENERATE_QHP is set to YES.
1384
1385
QHP_CUST_FILTER_NAME =
1386
1387
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1388
# custom filter to add. For more information please see Qt Help Project / Custom
1389
# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters).
1390
# This tag requires that the tag GENERATE_QHP is set to YES.
1391
1392
QHP_CUST_FILTER_ATTRS =
1393
1394
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1395
# project's filter section matches. Qt Help Project / Filter Attributes (see:
1396
# http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes).
1397
# This tag requires that the tag GENERATE_QHP is set to YES.
1398
1399
QHP_SECT_FILTER_ATTRS =
1400
1401
# The QHG_LOCATION tag can be used to specify the location of Qt's
1402
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1403
# generated .qhp file.
1404
# This tag requires that the tag GENERATE_QHP is set to YES.
1405
1406
QHG_LOCATION =
1407
1408
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1409
# generated, together with the HTML files, they form an Eclipse help plugin. To
1410
# install this plugin and make it available under the help contents menu in
1411
# Eclipse, the contents of the directory containing the HTML and XML files needs
1412
# to be copied into the plugins directory of eclipse. The name of the directory
1413
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1414
# After copying Eclipse needs to be restarted before the help appears.
1415
# The default value is: NO.
1416
# This tag requires that the tag GENERATE_HTML is set to YES.
1417
1418
GENERATE_ECLIPSEHELP = NO
1419
1420
# A unique identifier for the Eclipse help plugin. When installing the plugin
1421
# the directory name containing the HTML and XML files should also have this
1422
# name. Each documentation set should have its own identifier.
1423
# The default value is: org.doxygen.Project.
1424
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1425
1426
ECLIPSE_DOC_ID = org.doxygen.Project
1427
1428
# If you want full control over the layout of the generated HTML pages it might
1429
# be necessary to disable the index and replace it with your own. The
1430
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1431
# of each HTML page. A value of NO enables the index and the value YES disables
1432
# it. Since the tabs in the index contain the same information as the navigation
1433
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1434
# The default value is: NO.
1435
# This tag requires that the tag GENERATE_HTML is set to YES.
938
1436
939
1437
DISABLE_INDEX = NO
940
1438
941
# This tag can be used to set the number of enum values (range [1..20])
942
# that doxygen will group on one line in the generated HTML documentation.
943
944
ENUM_VALUES_PER_LINE = 1
945
946
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
947
# structure should be generated to display hierarchical information.
948
# If the tag value is set to FRAME, a side panel will be generated
949
# containing a tree-like index structure (just like the one that
950
# is generated for HTML Help). For this to work a browser that supports
951
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
952
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
953
# probably better off using the HTML help feature. Other possible values
954
# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
955
# and Class Hierarchy pages using a tree view instead of an ordered list;
956
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
957
# disables this behavior completely. For backwards compatibility with previous
958
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
959
# respectively.
1439
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1440
# structure should be generated to display hierarchical information. If the tag
1441
# value is set to YES, a side panel will be generated containing a tree-like
1442
# index structure (just like the one that is generated for HTML Help). For this
1443
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1444
# (i.e. any modern browser). Windows users are probably better off using the
1445
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1446
# further fine-tune the look of the index. As an example, the default style
1447
# sheet generated by doxygen has an example that shows how to put an image at
1448
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1449
# the same information as the tab index, you could consider setting
1450
# DISABLE_INDEX to YES when enabling this option.
1451
# The default value is: NO.
1452
# This tag requires that the tag GENERATE_HTML is set to YES.
960
1453
961
1454
GENERATE_TREEVIEW = NO
962
1455
963
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
964
# used to set the initial width (in pixels) of the frame in which the tree
965
# is shown.
1456
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1457
# doxygen will group on one line in the generated HTML documentation.
1458
#
1459
# Note that a value of 0 will completely suppress the enum values from appearing
1460
# in the overview section.
1461
# Minimum value: 0, maximum value: 20, default value: 4.
1462
# This tag requires that the tag GENERATE_HTML is set to YES.
1463
1464
ENUM_VALUES_PER_LINE = 4
1465
1466
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1467
# to set the initial width (in pixels) of the frame in which the tree is shown.
1468
# Minimum value: 0, maximum value: 1500, default value: 250.
1469
# This tag requires that the tag GENERATE_HTML is set to YES.
966
1470
967
1471
TREEVIEW_WIDTH = 250
968
1472
969
# Use this tag to change the font size of Latex formulas included
970
# as images in the HTML documentation. The default is 10. Note that
971
# when you change the font size after a successful doxygen run you need
972
# to manually remove any form_*.png images from the HTML output directory
973
# to force them to be regenerated.
1473
# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1474
# external symbols imported via tag files in a separate window.
1475
# The default value is: NO.
1476
# This tag requires that the tag GENERATE_HTML is set to YES.
1477
1478
EXT_LINKS_IN_WINDOW = NO
1479
1480
# Use this tag to change the font size of LaTeX formulas included as images in
1481
# the HTML documentation. When you change the font size after a successful
1482
# doxygen run you need to manually remove any form_*.png images from the HTML
1483
# output directory to force them to be regenerated.
1484
# Minimum value: 8, maximum value: 50, default value: 10.
1485
# This tag requires that the tag GENERATE_HTML is set to YES.
974
1486
975
1487
FORMULA_FONTSIZE = 10
976
1488
977
#---------------------------------------------------------------------------
978
# configuration options related to the LaTeX output
979
#---------------------------------------------------------------------------
980
981
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
982
# generate Latex output.
1489
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1490
# generated for formulas are transparent PNGs. Transparent PNGs are not
1491
# supported properly for IE 6.0, but are supported on all modern browsers.
1492
#
1493
# Note that when changing this option you need to delete any form_*.png files in
1494
# the HTML output directory before the changes have effect.
1495
# The default value is: YES.
1496
# This tag requires that the tag GENERATE_HTML is set to YES.
1497
1498
FORMULA_TRANSPARENT = YES
1499
1500
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1501
# https://www.mathjax.org) which uses client side Javascript for the rendering
1502
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1503
# installed or if you want to formulas look prettier in the HTML output. When
1504
# enabled you may also need to install MathJax separately and configure the path
1505
# to it using the MATHJAX_RELPATH option.
1506
# The default value is: NO.
1507
# This tag requires that the tag GENERATE_HTML is set to YES.
1508
1509
USE_MATHJAX = NO
1510
1511
# When MathJax is enabled you can set the default output format to be used for
1512
# the MathJax output. See the MathJax site (see:
1513
# http://docs.mathjax.org/en/latest/output.html) for more details.
1514
# Possible values are: HTML-CSS (which is slower, but has the best
1515
# compatibility), NativeMML (i.e. MathML) and SVG.
1516
# The default value is: HTML-CSS.
1517
# This tag requires that the tag USE_MATHJAX is set to YES.
1518
1519
MATHJAX_FORMAT = HTML-CSS
1520
1521
# When MathJax is enabled you need to specify the location relative to the HTML
1522
# output directory using the MATHJAX_RELPATH option. The destination directory
1523
# should contain the MathJax.js script. For instance, if the mathjax directory
1524
# is located at the same level as the HTML output directory, then
1525
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1526
# Content Delivery Network so you can quickly see the result without installing
1527
# MathJax. However, it is strongly recommended to install a local copy of
1528
# MathJax from https://www.mathjax.org before deployment.
1529
# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/.
1530
# This tag requires that the tag USE_MATHJAX is set to YES.
1531
1532
MATHJAX_RELPATH = https://cdn.mathjax.org/mathjax/latest
1533
1534
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1535
# extension names that should be enabled during MathJax rendering. For example
1536
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1537
# This tag requires that the tag USE_MATHJAX is set to YES.
1538
1539
MATHJAX_EXTENSIONS =
1540
1541
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1542
# of code that will be used on startup of the MathJax code. See the MathJax site
1543
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1544
# example see the documentation.
1545
# This tag requires that the tag USE_MATHJAX is set to YES.
1546
1547
MATHJAX_CODEFILE =
1548
1549
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1550
# the HTML output. The underlying search engine uses javascript and DHTML and
1551
# should work on any modern browser. Note that when using HTML help
1552
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1553
# there is already a search function so this one should typically be disabled.
1554
# For large projects the javascript based search engine can be slow, then
1555
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1556
# search using the keyboard; to jump to the search box use <access key> + S
1557
# (what the <access key> is depends on the OS and browser, but it is typically
1558
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1559
# key> to jump into the search results window, the results can be navigated
1560
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1561
# the search. The filter options can be selected when the cursor is inside the
1562
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1563
# to select a filter and <Enter> or <escape> to activate or cancel the filter
1564
# option.
1565
# The default value is: YES.
1566
# This tag requires that the tag GENERATE_HTML is set to YES.
1567
1568
SEARCHENGINE = NO
1569
1570
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1571
# implemented using a web server instead of a web client using Javascript. There
1572
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1573
# setting. When disabled, doxygen will generate a PHP script for searching and
1574
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1575
# and searching needs to be provided by external tools. See the section
1576
# "External Indexing and Searching" for details.
1577
# The default value is: NO.
1578
# This tag requires that the tag SEARCHENGINE is set to YES.
1579
1580
SERVER_BASED_SEARCH = NO
1581
1582
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1583
# script for searching. Instead the search results are written to an XML file
1584
# which needs to be processed by an external indexer. Doxygen will invoke an
1585
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1586
# search results.
1587
#
1588
# Doxygen ships with an example indexer (doxyindexer) and search engine
1589
# (doxysearch.cgi) which are based on the open source search engine library
1590
# Xapian (see: https://xapian.org/).
1591
#
1592
# See the section "External Indexing and Searching" for details.
1593
# The default value is: NO.
1594
# This tag requires that the tag SEARCHENGINE is set to YES.
1595
1596
EXTERNAL_SEARCH = NO
1597
1598
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1599
# which will return the search results when EXTERNAL_SEARCH is enabled.
1600
#
1601
# Doxygen ships with an example indexer (doxyindexer) and search engine
1602
# (doxysearch.cgi) which are based on the open source search engine library
1603
# Xapian (see: https://xapian.org/). See the section "External Indexing and
1604
# Searching" for details.
1605
# This tag requires that the tag SEARCHENGINE is set to YES.
1606
1607
SEARCHENGINE_URL =
1608
1609
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1610
# search data is written to a file for indexing by an external tool. With the
1611
# SEARCHDATA_FILE tag the name of this file can be specified.
1612
# The default file is: searchdata.xml.
1613
# This tag requires that the tag SEARCHENGINE is set to YES.
1614
1615
SEARCHDATA_FILE = searchdata.xml
1616
1617
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1618
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1619
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1620
# projects and redirect the results back to the right project.
1621
# This tag requires that the tag SEARCHENGINE is set to YES.
1622
1623
EXTERNAL_SEARCH_ID =
1624
1625
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1626
# projects other than the one defined by this configuration file, but that are
1627
# all added to the same external search index. Each project needs to have a
1628
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1629
# to a relative location where the documentation can be found. The format is:
1630
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1631
# This tag requires that the tag SEARCHENGINE is set to YES.
1632
1633
EXTRA_SEARCH_MAPPINGS =
1634
1635
#---------------------------------------------------------------------------
1636
# Configuration options related to the LaTeX output
1637
#---------------------------------------------------------------------------
1638
1639
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1640
# The default value is: YES.
983
1641
984
1642
GENERATE_LATEX = NO
985
1643
986
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
987
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
988
# put in front of it. If left blank `latex' will be used as the default path.
1644
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1645
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1646
# it.
1647
# The default directory is: latex.
1648
# This tag requires that the tag GENERATE_LATEX is set to YES.
989
1649
990
1650
LATEX_OUTPUT = latex
991
1651
992
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
993
# invoked. If left blank `latex' will be used as the default command name.
1652
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1653
# invoked.
1654
#
1655
# Note that when enabling USE_PDFLATEX this option is only used for generating
1656
# bitmaps for formulas in the HTML output, but not in the Makefile that is
1657
# written to the output directory.
1658
# The default file is: latex.
1659
# This tag requires that the tag GENERATE_LATEX is set to YES.
994
1660
995
1661
LATEX_CMD_NAME = latex
996
1662
997
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
998
# generate index for LaTeX. If left blank `makeindex' will be used as the
999
# default command name.
1663
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1664
# index for LaTeX.
1665
# The default file is: makeindex.
1666
# This tag requires that the tag GENERATE_LATEX is set to YES.
1000
1667
1001
1668
MAKEINDEX_CMD_NAME = makeindex
1002
1669
1003
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1004
# LaTeX documents. This may be useful for small projects and may help to
1005
# save some trees in general.
1670
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1671
# documents. This may be useful for small projects and may help to save some
1672
# trees in general.
1673
# The default value is: NO.
1674
# This tag requires that the tag GENERATE_LATEX is set to YES.
1006
1675
1007
1676
COMPACT_LATEX = NO
1008
1677
1009
# The PAPER_TYPE tag can be used to set the paper type that is used
1010
# by the printer. Possible values are: a4, a4wide, letter, legal and
1011
# executive. If left blank a4wide will be used.
1012
1013
PAPER_TYPE = a4wide
1014
1015
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1016
# packages that should be included in the LaTeX output.
1017
1018
EXTRA_PACKAGES =
1019
1020
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1021
# the generated latex document. The header should contain everything until
1022
# the first chapter. If it is left blank doxygen will generate a
1023
# standard header. Notice: only use this tag if you know what you are doing!
1024
1025
LATEX_HEADER =
1026
1027
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1028
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1029
# contain links (just like the HTML output) instead of page references
1030
# This makes the output suitable for online browsing using a pdf viewer.
1031
1032
PDF_HYPERLINKS = NO
1033
1034
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1035
# plain latex in the generated Makefile. Set this option to YES to get a
1678
# The PAPER_TYPE tag can be used to set the paper type that is used by the
1679
# printer.
1680
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1681
# 14 inches) and executive (7.25 x 10.5 inches).
1682
# The default value is: a4.
1683
# This tag requires that the tag GENERATE_LATEX is set to YES.
1684
1685
PAPER_TYPE = a4
1686
1687
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1688
# that should be included in the LaTeX output. The package can be specified just
1689
# by its name or with the correct syntax as to be used with the LaTeX
1690
# \usepackage command. To get the times font for instance you can specify :
1691
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1692
# To use the option intlimits with the amsmath package you can specify:
1693
# EXTRA_PACKAGES=[intlimits]{amsmath}
1694
# If left blank no extra packages will be included.
1695
# This tag requires that the tag GENERATE_LATEX is set to YES.
1696
1697
EXTRA_PACKAGES =
1698
1699
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1700
# generated LaTeX document. The header should contain everything until the first
1701
# chapter. If it is left blank doxygen will generate a standard header. See
1702
# section "Doxygen usage" for information on how to let doxygen write the
1703
# default header to a separate file.
1704
#
1705
# Note: Only use a user-defined header if you know what you are doing! The
1706
# following commands have a special meaning inside the header: $title,
1707
# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1708
# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1709
# string, for the replacement values of the other commands the user is referred
1710
# to HTML_HEADER.
1711
# This tag requires that the tag GENERATE_LATEX is set to YES.
1712
1713
LATEX_HEADER =
1714
1715
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1716
# generated LaTeX document. The footer should contain everything after the last
1717
# chapter. If it is left blank doxygen will generate a standard footer. See
1718
# LATEX_HEADER for more information on how to generate a default footer and what
1719
# special commands can be used inside the footer.
1720
#
1721
# Note: Only use a user-defined footer if you know what you are doing!
1722
# This tag requires that the tag GENERATE_LATEX is set to YES.
1723
1724
LATEX_FOOTER =
1725
1726
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1727
# LaTeX style sheets that are included after the standard style sheets created
1728
# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1729
# will copy the style sheet files to the output directory.
1730
# Note: The order of the extra style sheet files is of importance (e.g. the last
1731
# style sheet in the list overrules the setting of the previous ones in the
1732
# list).
1733
# This tag requires that the tag GENERATE_LATEX is set to YES.
1734
1735
LATEX_EXTRA_STYLESHEET =
1736
1737
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1738
# other source files which should be copied to the LATEX_OUTPUT output
1739
# directory. Note that the files will be copied as-is; there are no commands or
1740
# markers available.
1741
# This tag requires that the tag GENERATE_LATEX is set to YES.
1742
1743
LATEX_EXTRA_FILES =
1744
1745
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1746
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1747
# contain links (just like the HTML output) instead of page references. This
1748
# makes the output suitable for online browsing using a PDF viewer.
1749
# The default value is: YES.
1750
# This tag requires that the tag GENERATE_LATEX is set to YES.
1751
1752
PDF_HYPERLINKS = YES
1753
1754
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1755
# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1036
1756
# higher quality PDF documentation.
1037
1038
USE_PDFLATEX = NO
1039
1040
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1041
# command to the generated LaTeX files. This will instruct LaTeX to keep
1042
# running if errors occur, instead of asking the user for help.
1043
# This option is also used when generating formulas in HTML.
1757
# The default value is: YES.
1758
# This tag requires that the tag GENERATE_LATEX is set to YES.
1759
1760
USE_PDFLATEX = YES
1761
1762
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1763
# command to the generated LaTeX files. This will instruct LaTeX to keep running
1764
# if errors occur, instead of asking the user for help. This option is also used
1765
# when generating formulas in HTML.
1766
# The default value is: NO.
1767
# This tag requires that the tag GENERATE_LATEX is set to YES.
1044
1768
1045
1769
LATEX_BATCHMODE = NO
1046
1770
1047
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1048
# include the index chapters (such as File Index, Compound Index, etc.)
1049
# in the output.
1771
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1772
# index chapters (such as File Index, Compound Index, etc.) in the output.
1773
# The default value is: NO.
1774
# This tag requires that the tag GENERATE_LATEX is set to YES.
1050
1775
1051
1776
LATEX_HIDE_INDICES = NO
1052
1777
1053
#---------------------------------------------------------------------------
1054
# configuration options related to the RTF output
1055
#---------------------------------------------------------------------------
1056
1057
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1058
# The RTF output is optimized for Word 97 and may not look very pretty with
1059
# other RTF readers or editors.
1778
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1779
# code with syntax highlighting in the LaTeX output.
1780
#
1781
# Note that which sources are shown also depends on other settings such as
1782
# SOURCE_BROWSER.
1783
# The default value is: NO.
1784
# This tag requires that the tag GENERATE_LATEX is set to YES.
1785
1786
LATEX_SOURCE_CODE = NO
1787
1788
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1789
# bibliography, e.g. plainnat, or ieeetr. See
1790
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1791
# The default value is: plain.
1792
# This tag requires that the tag GENERATE_LATEX is set to YES.
1793
1794
LATEX_BIB_STYLE = plain
1795
1796
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1797
# page will contain the date and time when the page was generated. Setting this
1798
# to NO can help when comparing the output of multiple runs.
1799
# The default value is: NO.
1800
# This tag requires that the tag GENERATE_LATEX is set to YES.
1801
1802
LATEX_TIMESTAMP = NO
1803
1804
#---------------------------------------------------------------------------
1805
# Configuration options related to the RTF output
1806
#---------------------------------------------------------------------------
1807
1808
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1809
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1810
# readers/editors.
1811
# The default value is: NO.
1060
1812
1061
1813
GENERATE_RTF = NO
1062
1814
1063
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1064
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1065
# put in front of it. If left blank `rtf' will be used as the default path.
1815
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1816
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1817
# it.
1818
# The default directory is: rtf.
1819
# This tag requires that the tag GENERATE_RTF is set to YES.
1066
1820
1067
1821
RTF_OUTPUT = rtf
1068
1822
1069
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1070
# RTF documents. This may be useful for small projects and may help to
1071
# save some trees in general.
1823
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1824
# documents. This may be useful for small projects and may help to save some
1825
# trees in general.
1826
# The default value is: NO.
1827
# This tag requires that the tag GENERATE_RTF is set to YES.
1072
1828
1073
1829
COMPACT_RTF = NO
1074
1830
1075
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1076
# will contain hyperlink fields. The RTF file will
1077
# contain links (just like the HTML output) instead of page references.
1078
# This makes the output suitable for online browsing using WORD or other
1079
# programs which support those fields.
1080
# Note: wordpad (write) and others do not support links.
1831
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1832
# contain hyperlink fields. The RTF file will contain links (just like the HTML
1833
# output) instead of page references. This makes the output suitable for online
1834
# browsing using Word or some other Word compatible readers that support those
1835
# fields.
1836
#
1837
# Note: WordPad (write) and others do not support links.
1838
# The default value is: NO.
1839
# This tag requires that the tag GENERATE_RTF is set to YES.
1081
1840
1082
1841
RTF_HYPERLINKS = NO
1083
1842
1084
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1085
# config file, i.e. a series of assignments. You only have to provide
1086
# replacements, missing definitions are set to their default value.
1087
1088
RTF_STYLESHEET_FILE =
1089
1090
# Set optional variables used in the generation of an rtf document.
1091
# Syntax is similar to doxygen's config file.
1092
1093
RTF_EXTENSIONS_FILE =
1094
1095
#---------------------------------------------------------------------------
1096
# configuration options related to the man page output
1097
#---------------------------------------------------------------------------
1098
1099
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1100
# generate man pages
1843
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1844
# file, i.e. a series of assignments. You only have to provide replacements,
1845
# missing definitions are set to their default value.
1846
#
1847
# See also section "Doxygen usage" for information on how to generate the
1848
# default style sheet that doxygen normally uses.
1849
# This tag requires that the tag GENERATE_RTF is set to YES.
1850
1851
RTF_STYLESHEET_FILE =
1852
1853
# Set optional variables used in the generation of an RTF document. Syntax is
1854
# similar to doxygen's config file. A template extensions file can be generated
1855
# using doxygen -e rtf extensionFile.
1856
# This tag requires that the tag GENERATE_RTF is set to YES.
1857
1858
RTF_EXTENSIONS_FILE =
1859
1860
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1861
# with syntax highlighting in the RTF output.
1862
#
1863
# Note that which sources are shown also depends on other settings such as
1864
# SOURCE_BROWSER.
1865
# The default value is: NO.
1866
# This tag requires that the tag GENERATE_RTF is set to YES.
1867
1868
RTF_SOURCE_CODE = NO
1869
1870
#---------------------------------------------------------------------------
1871
# Configuration options related to the man page output
1872
#---------------------------------------------------------------------------
1873
1874
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1875
# classes and files.
1876
# The default value is: NO.
1101
1877
1102
1878
GENERATE_MAN = NO
1103
1879
1104
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1105
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1106
# put in front of it. If left blank `man' will be used as the default path.
1880
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1881
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1882
# it. A directory man3 will be created inside the directory specified by
1883
# MAN_OUTPUT.
1884
# The default directory is: man.
1885
# This tag requires that the tag GENERATE_MAN is set to YES.
1107
1886
1108
1887
MAN_OUTPUT = man
1109
1888
1110
# The MAN_EXTENSION tag determines the extension that is added to
1111
# the generated man pages (default is the subroutine's section .3)
1889
# The MAN_EXTENSION tag determines the extension that is added to the generated
1890
# man pages. In case the manual section does not start with a number, the number
1891
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1892
# optional.
1893
# The default value is: .3.
1894
# This tag requires that the tag GENERATE_MAN is set to YES.
1112
1895
1113
1896
MAN_EXTENSION = .3
1114
1897
1115
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1116
# then it will generate one additional man file for each entity
1117
# documented in the real man page(s). These additional files
1118
# only source the real man page, but without them the man command
1119
# would be unable to find the correct page. The default is NO.
1898
# The MAN_SUBDIR tag determines the name of the directory created within
1899
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1900
# MAN_EXTENSION with the initial . removed.
1901
# This tag requires that the tag GENERATE_MAN is set to YES.
1902
1903
MAN_SUBDIR =
1904
1905
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1906
# will generate one additional man file for each entity documented in the real
1907
# man page(s). These additional files only source the real man page, but without
1908
# them the man command would be unable to find the correct page.
1909
# The default value is: NO.
1910
# This tag requires that the tag GENERATE_MAN is set to YES.
1120
1911
1121
1912
MAN_LINKS = NO
1122
1913
1123
1914
#---------------------------------------------------------------------------
1124
# configuration options related to the XML output
1915
# Configuration options related to the XML output
1125
1916
#---------------------------------------------------------------------------
1126
1917
1127
# If the GENERATE_XML tag is set to YES Doxygen will
1128
# generate an XML file that captures the structure of
1129
# the code including all documentation.
1918
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1919
# captures the structure of the code including all documentation.
1920
# The default value is: NO.
1130
1921
1131
1922
GENERATE_XML = NO
1132
1923
1133
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1134
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1135
# put in front of it. If left blank `xml' will be used as the default path.
1924
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1925
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1926
# it.
1927
# The default directory is: xml.
1928
# This tag requires that the tag GENERATE_XML is set to YES.
1136
1929
1137
1930
XML_OUTPUT = xml
1138
1931
1139
# The XML_SCHEMA tag can be used to specify an XML schema,
1140
# which can be used by a validating XML parser to check the
1141
# syntax of the XML files.
1142
1143
XML_SCHEMA =
1144
1145
# The XML_DTD tag can be used to specify an XML DTD,
1146
# which can be used by a validating XML parser to check the
1147
# syntax of the XML files.
1148
1149
XML_DTD =
1150
1151
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1152
# dump the program listings (including syntax highlighting
1153
# and cross-referencing information) to the XML output. Note that
1154
# enabling this will significantly increase the size of the XML output.
1932
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1933
# listings (including syntax highlighting and cross-referencing information) to
1934
# the XML output. Note that enabling this will significantly increase the size
1935
# of the XML output.
1936
# The default value is: YES.
1937
# This tag requires that the tag GENERATE_XML is set to YES.
1155
1938
1156
1939
XML_PROGRAMLISTING = YES
1157
1940
1158
1941
#---------------------------------------------------------------------------
1159
# configuration options for the AutoGen Definitions output
1160
#---------------------------------------------------------------------------
1161
1162
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1163
# generate an AutoGen Definitions (see autogen.sf.net) file
1164
# that captures the structure of the code including all
1165
# documentation. Note that this feature is still experimental
1166
# and incomplete at the moment.
1942
# Configuration options related to the DOCBOOK output
1943
#---------------------------------------------------------------------------
1944
1945
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1946
# that can be used to generate PDF.
1947
# The default value is: NO.
1948
1949
GENERATE_DOCBOOK = NO
1950
1951
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1952
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1953
# front of it.
1954
# The default directory is: docbook.
1955
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1956
1957
DOCBOOK_OUTPUT = docbook
1958
1959
# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1960
# program listings (including syntax highlighting and cross-referencing
1961
# information) to the DOCBOOK output. Note that enabling this will significantly
1962
# increase the size of the DOCBOOK output.
1963
# The default value is: NO.
1964
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1965
1966
DOCBOOK_PROGRAMLISTING = NO
1967
1968
#---------------------------------------------------------------------------
1969
# Configuration options for the AutoGen Definitions output
1970
#---------------------------------------------------------------------------
1971
1972
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1973
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
1974
# the structure of the code including all documentation. Note that this feature
1975
# is still experimental and incomplete at the moment.
1976
# The default value is: NO.
1167
1977
1168
1978
GENERATE_AUTOGEN_DEF = NO
1169
1979
1170
1980
#---------------------------------------------------------------------------
1171
# configuration options related to the Perl module output
1981
# Configuration options related to the Perl module output
1172
1982
#---------------------------------------------------------------------------
1173
1983
1174
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1175
# generate a Perl module file that captures the structure of
1176
# the code including all documentation. Note that this
1177
# feature is still experimental and incomplete at the
1178
# moment.
1984
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1985
# file that captures the structure of the code including all documentation.
1986
#
1987
# Note that this feature is still experimental and incomplete at the moment.
1988
# The default value is: NO.
1179
1989
1180
1990
GENERATE_PERLMOD = NO
1181
1991
1182
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1183
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1184
# to generate PDF and DVI output from the Perl module output.
1992
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1993
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1994
# output from the Perl module output.
1995
# The default value is: NO.
1996
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1185
1997
1186
1998
PERLMOD_LATEX = NO
1187
1999
1188
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1189
# nicely formatted so it can be parsed by a human reader. This is useful
1190
# if you want to understand what is going on. On the other hand, if this
1191
# tag is set to NO the size of the Perl module output will be much smaller
1192
# and Perl will parse it just the same.
2000
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2001
# formatted so it can be parsed by a human reader. This is useful if you want to
2002
# understand what is going on. On the other hand, if this tag is set to NO, the
2003
# size of the Perl module output will be much smaller and Perl will parse it
2004
# just the same.
2005
# The default value is: YES.
2006
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
1193
2007
1194
2008
PERLMOD_PRETTY = YES
1195
2009
1196
# The names of the make variables in the generated doxyrules.make file
1197
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1198
# This is useful so different doxyrules.make files included by the same
1199
# Makefile don't overwrite each other's variables.
1200
1201
PERLMOD_MAKEVAR_PREFIX =
1202
1203
#---------------------------------------------------------------------------
1204
# Configuration options related to the preprocessor
1205
#---------------------------------------------------------------------------
1206
1207
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1208
# evaluate all C-preprocessor directives found in the sources and include
1209
# files.
2010
# The names of the make variables in the generated doxyrules.make file are
2011
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2012
# so different doxyrules.make files included by the same Makefile don't
2013
# overwrite each other's variables.
2014
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2015
2016
PERLMOD_MAKEVAR_PREFIX =
2017
2018
#---------------------------------------------------------------------------
2019
# Configuration options related to the preprocessor
2020
#---------------------------------------------------------------------------
2021
2022
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2023
# C-preprocessor directives found in the sources and include files.
2024
# The default value is: YES.
1210
2025
1211
2026
ENABLE_PREPROCESSING = YES
1212
2027
1213
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1214
# names in the source code. If set to NO (the default) only conditional
1215
# compilation will be performed. Macro expansion can be done in a controlled
1216
# way by setting EXPAND_ONLY_PREDEF to YES.
1217
1218
MACRO_EXPANSION = NO
1219
1220
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1221
# then the macro expansion is limited to the macros specified with the
1222
# PREDEFINED and EXPAND_AS_DEFINED tags.
1223
1224
EXPAND_ONLY_PREDEF = NO
1225
1226
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1227
# in the INCLUDE_PATH (see below) will be search if a #include is found.
2028
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2029
# in the source code. If set to NO, only conditional compilation will be
2030
# performed. Macro expansion can be done in a controlled way by setting
2031
# EXPAND_ONLY_PREDEF to YES.
2032
# The default value is: NO.
2033
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2034
2035
MACRO_EXPANSION = YES
2036
2037
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2038
# the macro expansion is limited to the macros specified with the PREDEFINED and
2039
# EXPAND_AS_DEFINED tags.
2040
# The default value is: NO.
2041
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2042
2043
EXPAND_ONLY_PREDEF = YES
2044
2045
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2046
# INCLUDE_PATH will be searched if a #include is found.
2047
# The default value is: YES.
2048
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1228
2049
1229
2050
SEARCH_INCLUDES = YES
1230
2051
1231
# The INCLUDE_PATH tag can be used to specify one or more directories that
1232
# contain include files that are not input files but should be processed by
1233
# the preprocessor.
1234
1235
INCLUDE_PATH =
1236
1237
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1238
# patterns (like *.h and *.hpp) to filter out the header-files in the
1239
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1240
# be used.
1241
1242
INCLUDE_FILE_PATTERNS =
1243
1244
# The PREDEFINED tag can be used to specify one or more macro names that
1245
# are defined before the preprocessor is started (similar to the -D option of
1246
# gcc). The argument of the tag is a list of macros of the form: name
1247
# or name=definition (no spaces). If the definition and the = are
1248
# omitted =1 is assumed. To prevent a macro definition from being
1249
# undefined via #undef or recursively expanded use the := operator
1250
# instead of the = operator.
1251
1252
PREDEFINED =
1253
1254
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1255
# this tag can be used to specify a list of macro names that should be expanded.
1256
# The macro definition that is found in the sources will be used.
1257
# Use the PREDEFINED tag if you want to use a different macro definition.
1258
1259
EXPAND_AS_DEFINED =
1260
1261
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1262
# doxygen's preprocessor will remove all function-like macros that are alone
1263
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1264
# function macros are typically used for boiler-plate code, and will confuse
1265
# the parser if not removed.
2052
# The INCLUDE_PATH tag can be used to specify one or more directories that
2053
# contain include files that are not input files but should be processed by the
2054
# preprocessor.
2055
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2056
2057
INCLUDE_PATH =
2058
2059
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2060
# patterns (like *.h and *.hpp) to filter out the header-files in the
2061
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2062
# used.
2063
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2064
2065
INCLUDE_FILE_PATTERNS =
2066
2067
# The PREDEFINED tag can be used to specify one or more macro names that are
2068
# defined before the preprocessor is started (similar to the -D option of e.g.
2069
# gcc). The argument of the tag is a list of macros of the form: name or
2070
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2071
# is assumed. To prevent a macro definition from being undefined via #undef or
2072
# recursively expanded use the := operator instead of the = operator.
2073
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2074
2075
PREDEFINED = SFML_SYSTEM_API \
2076
SFML_NETWORK_API \
2077
SFML_WINDOW_API \
2078
SFML_AUDIO_API \
2079
SFML_GRAPHICS_API \
2080
SFML_DEPRECATED \
2081
SFML_DOXYGEN \
2082
CSFML_SYSTEM_API \
2083
CSFML_NETWORK_API \
2084
CSFML_WINDOW_API \
2085
CSFML_AUDIO_API \
2086
CSFML_GRAPHICS_API \
2087
CSFML_DEPRECATED \
2088
CSFML_DOXYGEN
2089
2090
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2091
# tag can be used to specify a list of macro names that should be expanded. The
2092
# macro definition that is found in the sources will be used. Use the PREDEFINED
2093
# tag if you want to use a different macro definition that overrules the
2094
# definition found in the source code.
2095
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2096
2097
EXPAND_AS_DEFINED =
2098
2099
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2100
# remove all references to function-like macros that are alone on a line, have
2101
# an all uppercase name, and do not end with a semicolon. Such function macros
2102
# are typically used for boiler-plate code, and will confuse the parser if not
2103
# removed.
2104
# The default value is: YES.
2105
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1266
2106
1267
2107
SKIP_FUNCTION_MACROS = YES
1268
2108
1269
2109
#---------------------------------------------------------------------------
1270
# Configuration::additions related to external references
2110
# Configuration options related to external references
1271
2111
#---------------------------------------------------------------------------
1272
2112
1273
# The TAGFILES option can be used to specify one or more tagfiles.
1274
# Optionally an initial location of the external documentation
1275
# can be added for each tagfile. The format of a tag file without
1276
# this location is as follows:
1277
# TAGFILES = file1 file2 ...
1278
# Adding location for the tag files is done as follows:
1279
# TAGFILES = file1=loc1 "file2 = loc2" ...
1280
# where "loc1" and "loc2" can be relative or absolute paths or
1281
# URLs. If a location is present for each tag, the installdox tool
1282
# does not have to be run to correct the links.
1283
# Note that each tag file must have a unique name
1284
# (where the name does NOT include the path)
1285
# If a tag file is not located in the directory in which doxygen
1286
# is run, you must also specify the path to the tagfile here.
1287
1288
TAGFILES =
1289
1290
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1291
# a tag file that is based on the input files it reads.
1292
1293
GENERATE_TAGFILE =
1294
1295
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1296
# in the class index. If set to NO only the inherited external classes
1297
# will be listed.
2113
# The TAGFILES tag can be used to specify one or more tag files. For each tag
2114
# file the location of the external documentation should be added. The format of
2115
# a tag file without this location is as follows:
2116
# TAGFILES = file1 file2 ...
2117
# Adding location for the tag files is done as follows:
2118
# TAGFILES = file1=loc1 "file2 = loc2" ...
2119
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2120
# section "Linking to external documentation" for more information about the use
2121
# of tag files.
2122
# Note: Each tag file must have a unique name (where the name does NOT include
2123
# the path). If a tag file is not located in the directory in which doxygen is
2124
# run, you must also specify the path to the tagfile here.
2125
2126
TAGFILES =
2127
2128
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2129
# tag file that is based on the input files it reads. See section "Linking to
2130
# external documentation" for more information about the usage of tag files.
2131
2132
GENERATE_TAGFILE = @DOXYGEN_OUTPUT_DIR@/CSFML.tag
2133
2134
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2135
# the class index. If set to NO, only the inherited external classes will be
2136
# listed.
2137
# The default value is: NO.
1298
2138
1299
2139
ALLEXTERNALS = NO
1300
2140
1301
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1302
# in the modules index. If set to NO, only the current project's groups will
2141
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2142
# in the modules index. If set to NO, only the current project's groups will be
2143
# listed.
2144
# The default value is: YES.
2145
2146
EXTERNAL_GROUPS = YES
2147
2148
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2149
# the related pages index. If set to NO, only the current project's pages will
1303
2150
# be listed.
1304
1305
EXTERNAL_GROUPS = YES
1306
1307
# The PERL_PATH should be the absolute path and name of the perl script
1308
# interpreter (i.e. the result of `which perl').
2151
# The default value is: YES.
2152
2153
EXTERNAL_PAGES = YES
2154
2155
# The PERL_PATH should be the absolute path and name of the perl script
2156
# interpreter (i.e. the result of 'which perl').
2157
# The default file (with absolute path) is: /usr/bin/perl.
1309
2158
1310
2159
PERL_PATH = /usr/bin/perl
1311
2160
1312
2161
#---------------------------------------------------------------------------
1313
# Configuration options related to the dot tool
2162
# Configuration options related to the dot tool
1314
2163
#---------------------------------------------------------------------------
1315
2164
1316
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1317
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1318
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1319
# this option is superseded by the HAVE_DOT option below. This is only a
1320
# fallback. It is recommended to install and use dot, since it yields more
2165
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2166
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2167
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2168
# disabled, but it is recommended to install and use dot, since it yields more
1321
2169
# powerful graphs.
2170
# The default value is: YES.
1322
2171
1323
2172
CLASS_DIAGRAMS = YES
1324
2173
1325
# You can define message sequence charts within doxygen comments using the \msc
1326
# command. Doxygen will then run the mscgen tool (see
1327
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1328
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1329
# the mscgen tool resides. If left empty the tool is assumed to be found in the
2174
# You can define message sequence charts within doxygen comments using the \msc
2175
# command. Doxygen will then run the mscgen tool (see:
2176
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2177
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2178
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1330
2179
# default search path.
1331
2180
1332
MSCGEN_PATH =
1333
1334
# If set to YES, the inheritance and collaboration graphs will hide
1335
# inheritance and usage relations if the target is undocumented
1336
# or is not a class.
2181
MSCGEN_PATH =
2182
2183
# You can include diagrams made with dia in doxygen documentation. Doxygen will
2184
# then run dia to produce the diagram and insert it in the documentation. The
2185
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2186
# If left empty dia is assumed to be found in the default search path.
2187
2188
DIA_PATH =
2189
2190
# If set to YES the inheritance and collaboration graphs will hide inheritance
2191
# and usage relations if the target is undocumented or is not a class.
2192
# The default value is: YES.
1337
2193
1338
2194
HIDE_UNDOC_RELATIONS = YES
1339
2195
1340
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1341
# available from the path. This tool is part of Graphviz, a graph visualization
1342
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1343
# have no effect if this option is set to NO (the default)
2196
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2197
# available from the path. This tool is part of Graphviz (see:
2198
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2199
# Bell Labs. The other options in this section have no effect if this option is
2200
# set to NO
2201
# The default value is: NO.
1344
2202
1345
2203
HAVE_DOT = NO
1346
2204
1347
# By default doxygen will write a font called FreeSans.ttf to the output
1348
# directory and reference it in all dot files that doxygen generates. This
1349
# font does not include all possible unicode characters however, so when you need
1350
# these (or just want a differently looking font) you can specify the font name
1351
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1352
# which can be done by putting it in a standard location or by setting the
1353
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1354
# containing the font.
1355
1356
DOT_FONTNAME = FreeSans
1357
1358
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1359
# The default size is 10pt.
2205
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2206
# to run in parallel. When set to 0 doxygen will base this on the number of
2207
# processors available in the system. You can set it explicitly to a value
2208
# larger than 0 to get control over the balance between CPU load and processing
2209
# speed.
2210
# Minimum value: 0, maximum value: 32, default value: 0.
2211
# This tag requires that the tag HAVE_DOT is set to YES.
2212
2213
DOT_NUM_THREADS = 0
2214
2215
# When you want a differently looking font in the dot files that doxygen
2216
# generates you can specify the font name using DOT_FONTNAME. You need to make
2217
# sure dot is able to find the font, which can be done by putting it in a
2218
# standard location or by setting the DOTFONTPATH environment variable or by
2219
# setting DOT_FONTPATH to the directory containing the font.
2220
# The default value is: Helvetica.
2221
# This tag requires that the tag HAVE_DOT is set to YES.
2222
2223
DOT_FONTNAME = Helvetica
2224
2225
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2226
# dot graphs.
2227
# Minimum value: 4, maximum value: 24, default value: 10.
2228
# This tag requires that the tag HAVE_DOT is set to YES.
1360
2229
1361
2230
DOT_FONTSIZE = 10
1362
2231
1363
# By default doxygen will tell dot to use the output directory to look for the
1364
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1365
# different font using DOT_FONTNAME you can set the path where dot
1366
# can find it using this tag.
1367
1368
DOT_FONTPATH =
1369
1370
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1371
# will generate a graph for each documented class showing the direct and
1372
# indirect inheritance relations. Setting this tag to YES will force the
1373
# the CLASS_DIAGRAMS tag to NO.
2232
# By default doxygen will tell dot to use the default font as specified with
2233
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2234
# the path where dot can find it using this tag.
2235
# This tag requires that the tag HAVE_DOT is set to YES.
2236
2237
DOT_FONTPATH =
2238
2239
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2240
# each documented class showing the direct and indirect inheritance relations.
2241
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2242
# The default value is: YES.
2243
# This tag requires that the tag HAVE_DOT is set to YES.
1374
2244
1375
2245
CLASS_GRAPH = YES
1376
2246
1377
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1378
# will generate a graph for each documented class showing the direct and
1379
# indirect implementation dependencies (inheritance, containment, and
1380
# class references variables) of the class with other documented classes.
2247
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2248
# graph for each documented class showing the direct and indirect implementation
2249
# dependencies (inheritance, containment, and class references variables) of the
2250
# class with other documented classes.
2251
# The default value is: YES.
2252
# This tag requires that the tag HAVE_DOT is set to YES.
1381
2253
1382
2254
COLLABORATION_GRAPH = YES
1383
2255
1384
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1385
# will generate a graph for groups, showing the direct groups dependencies
2256
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2257
# groups, showing the direct groups dependencies.
2258
# The default value is: YES.
2259
# This tag requires that the tag HAVE_DOT is set to YES.
1386
2260
1387
2261
GROUP_GRAPHS = YES
1388
2262
1389
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1390
# collaboration diagrams in a style similar to the OMG's Unified Modeling
2263
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2264
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1391
2265
# Language.
2266
# The default value is: NO.
2267
# This tag requires that the tag HAVE_DOT is set to YES.
1392
2268
1393
2269
UML_LOOK = NO
1394
2270
1395
# If set to YES, the inheritance and collaboration graphs will show the
1396
# relations between templates and their instances.
2271
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2272
# class node. If there are many fields or methods and many nodes the graph may
2273
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2274
# number of items for each type to make the size more manageable. Set this to 0
2275
# for no limit. Note that the threshold may be exceeded by 50% before the limit
2276
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2277
# but if the number exceeds 15, the total amount of fields shown is limited to
2278
# 10.
2279
# Minimum value: 0, maximum value: 100, default value: 10.
2280
# This tag requires that the tag HAVE_DOT is set to YES.
2281
2282
UML_LIMIT_NUM_FIELDS = 10
2283
2284
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2285
# collaboration graphs will show the relations between templates and their
2286
# instances.
2287
# The default value is: NO.
2288
# This tag requires that the tag HAVE_DOT is set to YES.
1397
2289
1398
2290
TEMPLATE_RELATIONS = NO
1399
2291
1400
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1401
# tags are set to YES then doxygen will generate a graph for each documented
1402
# file showing the direct and indirect include dependencies of the file with
1403
# other documented files.
2292
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2293
# YES then doxygen will generate a graph for each documented file showing the
2294
# direct and indirect include dependencies of the file with other documented
2295
# files.
2296
# The default value is: YES.
2297
# This tag requires that the tag HAVE_DOT is set to YES.
1404
2298
1405
2299
INCLUDE_GRAPH = YES
1406
2300
1407
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1408
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1409
# documented header file showing the documented files that directly or
1410
# indirectly include this file.
2301
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2302
# set to YES then doxygen will generate a graph for each documented file showing
2303
# the direct and indirect include dependencies of the file with other documented
2304
# files.
2305
# The default value is: YES.
2306
# This tag requires that the tag HAVE_DOT is set to YES.
1411
2307
1412
2308
INCLUDED_BY_GRAPH = YES
1413
2309
1414
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1415
# doxygen will generate a call dependency graph for every global function
1416
# or class method. Note that enabling this option will significantly increase
1417
# the time of a run. So in most cases it will be better to enable call graphs
1418
# for selected functions only using the \callgraph command.
2310
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2311
# dependency graph for every global function or class method.
2312
#
2313
# Note that enabling this option will significantly increase the time of a run.
2314
# So in most cases it will be better to enable call graphs for selected
2315
# functions only using the \callgraph command. Disabling a call graph can be
2316
# accomplished by means of the command \hidecallgraph.
2317
# The default value is: NO.
2318
# This tag requires that the tag HAVE_DOT is set to YES.
1419
2319
1420
2320
CALL_GRAPH = NO
1421
2321
1422
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1423
# doxygen will generate a caller dependency graph for every global function
1424
# or class method. Note that enabling this option will significantly increase
1425
# the time of a run. So in most cases it will be better to enable caller
1426
# graphs for selected functions only using the \callergraph command.
2322
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2323
# dependency graph for every global function or class method.
2324
#
2325
# Note that enabling this option will significantly increase the time of a run.
2326
# So in most cases it will be better to enable caller graphs for selected
2327
# functions only using the \callergraph command. Disabling a caller graph can be
2328
# accomplished by means of the command \hidecallergraph.
2329
# The default value is: NO.
2330
# This tag requires that the tag HAVE_DOT is set to YES.
1427
2331
1428
2332
CALLER_GRAPH = NO
1429
2333
1430
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1431
# will graphical hierarchy of all classes instead of a textual one.
2334
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2335
# hierarchy of all classes instead of a textual one.
2336
# The default value is: YES.
2337
# This tag requires that the tag HAVE_DOT is set to YES.
1432
2338
1433
2339
GRAPHICAL_HIERARCHY = YES
1434
2340
1435
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1436
# then doxygen will show the dependencies a directory has on other directories
1437
# in a graphical way. The dependency relations are determined by the #include
1438
# relations between the files in the directories.
2341
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2342
# dependencies a directory has on other directories in a graphical way. The
2343
# dependency relations are determined by the #include relations between the
2344
# files in the directories.
2345
# The default value is: YES.
2346
# This tag requires that the tag HAVE_DOT is set to YES.
1439
2347
1440
2348
DIRECTORY_GRAPH = YES
1441
2349
1442
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1443
# generated by dot. Possible values are png, jpg, or gif
1444
# If left blank png will be used.
2350
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2351
# generated by dot. For an explanation of the image formats see the section
2352
# output formats in the documentation of the dot tool (Graphviz (see:
2353
# http://www.graphviz.org/)).
2354
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2355
# to make the SVG files visible in IE 9+ (other browsers do not have this
2356
# requirement).
2357
# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2358
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2359
# png:gdiplus:gdiplus.
2360
# The default value is: png.
2361
# This tag requires that the tag HAVE_DOT is set to YES.
1445
2362
1446
2363
DOT_IMAGE_FORMAT = png
1447
2364
1448
# The tag DOT_PATH can be used to specify the path where the dot tool can be
2365
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2366
# enable generation of interactive SVG images that allow zooming and panning.
2367
#
2368
# Note that this requires a modern browser other than Internet Explorer. Tested
2369
# and working are Firefox, Chrome, Safari, and Opera.
2370
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2371
# the SVG files visible. Older versions of IE do not have SVG support.
2372
# The default value is: NO.
2373
# This tag requires that the tag HAVE_DOT is set to YES.
2374
2375
INTERACTIVE_SVG = NO
2376
2377
# The DOT_PATH tag can be used to specify the path where the dot tool can be
1449
2378
# found. If left blank, it is assumed the dot tool can be found in the path.
1450
1451
DOT_PATH =
1452
1453
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1454
# contain dot files that are included in the documentation (see the
1455
# \dotfile command).
1456
1457
DOTFILE_DIRS =
1458
1459
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1460
# nodes that will be shown in the graph. If the number of nodes in a graph
1461
# becomes larger than this value, doxygen will truncate the graph, which is
1462
# visualized by representing a node as a red box. Note that doxygen if the
1463
# number of direct children of the root node in a graph is already larger than
1464
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1465
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2379
# This tag requires that the tag HAVE_DOT is set to YES.
2380
2381
DOT_PATH =
2382
2383
# The DOTFILE_DIRS tag can be used to specify one or more directories that
2384
# contain dot files that are included in the documentation (see the \dotfile
2385
# command).
2386
# This tag requires that the tag HAVE_DOT is set to YES.
2387
2388
DOTFILE_DIRS =
2389
2390
# The MSCFILE_DIRS tag can be used to specify one or more directories that
2391
# contain msc files that are included in the documentation (see the \mscfile
2392
# command).
2393
2394
MSCFILE_DIRS =
2395
2396
# The DIAFILE_DIRS tag can be used to specify one or more directories that
2397
# contain dia files that are included in the documentation (see the \diafile
2398
# command).
2399
2400
DIAFILE_DIRS =
2401
2402
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2403
# path where java can find the plantuml.jar file. If left blank, it is assumed
2404
# PlantUML is not used or called during a preprocessing step. Doxygen will
2405
# generate a warning when it encounters a \startuml command in this case and
2406
# will not generate output for the diagram.
2407
2408
PLANTUML_JAR_PATH =
2409
2410
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2411
# configuration file for plantuml.
2412
2413
PLANTUML_CFG_FILE =
2414
2415
# When using plantuml, the specified paths are searched for files specified by
2416
# the !include statement in a plantuml block.
2417
2418
PLANTUML_INCLUDE_PATH =
2419
2420
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2421
# that will be shown in the graph. If the number of nodes in a graph becomes
2422
# larger than this value, doxygen will truncate the graph, which is visualized
2423
# by representing a node as a red box. Note that doxygen if the number of direct
2424
# children of the root node in a graph is already larger than
2425
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2426
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2427
# Minimum value: 0, maximum value: 10000, default value: 50.
2428
# This tag requires that the tag HAVE_DOT is set to YES.
1466
2429
1467
2430
DOT_GRAPH_MAX_NODES = 50
1468
2431
1469
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1470
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1471
# from the root by following a path via at most 3 edges will be shown. Nodes
1472
# that lay further from the root node will be omitted. Note that setting this
1473
# option to 1 or 2 may greatly reduce the computation time needed for large
1474
# code bases. Also note that the size of a graph can be further restricted by
2432
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2433
# generated by dot. A depth value of 3 means that only nodes reachable from the
2434
# root by following a path via at most 3 edges will be shown. Nodes that lay
2435
# further from the root node will be omitted. Note that setting this option to 1
2436
# or 2 may greatly reduce the computation time needed for large code bases. Also
2437
# note that the size of a graph can be further restricted by
1475
2438
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2439
# Minimum value: 0, maximum value: 1000, default value: 0.
2440
# This tag requires that the tag HAVE_DOT is set to YES.
1476
2441
1477
2442
MAX_DOT_GRAPH_DEPTH = 0
1478
2443
1479
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1480
# background. This is disabled by default, because dot on Windows does not
1481
# seem to support this out of the box. Warning: Depending on the platform used,
1482
# enabling this option may lead to badly anti-aliased labels on the edges of
1483
# a graph (i.e. they become hard to read).
2444
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2445
# background. This is disabled by default, because dot on Windows does not seem
2446
# to support this out of the box.
2447
#
2448
# Warning: Depending on the platform used, enabling this option may lead to
2449
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2450
# read).
2451
# The default value is: NO.
2452
# This tag requires that the tag HAVE_DOT is set to YES.
1484
2453
1485
2454
DOT_TRANSPARENT = NO
1486
2455
1487
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1488
# files in one run (i.e. multiple -o and -T options on the command line). This
1489
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1490
# support this, this feature is disabled by default.
2456
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2457
# files in one run (i.e. multiple -o and -T options on the command line). This
2458
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2459
# this, this feature is disabled by default.
2460
# The default value is: NO.
2461
# This tag requires that the tag HAVE_DOT is set to YES.
1491
2462
1492
2463
DOT_MULTI_TARGETS = NO
1493
2464
1494
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1495
# generate a legend page explaining the meaning of the various boxes and
1496
# arrows in the dot generated graphs.
2465
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2466
# explaining the meaning of the various boxes and arrows in the dot generated
2467
# graphs.
2468
# The default value is: YES.
2469
# This tag requires that the tag HAVE_DOT is set to YES.
1497
2470
1498
2471
GENERATE_LEGEND = YES
1499
2472
1500
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1501
# remove the intermediate dot files that are used to generate
1502
# the various graphs.
2473
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2474
# files that are used to generate the various graphs.
2475
# The default value is: YES.
2476
# This tag requires that the tag HAVE_DOT is set to YES.
1503
2477
1504
2478
DOT_CLEANUP = YES
1505
1506
#---------------------------------------------------------------------------
1507
# Options related to the search engine
1508
#---------------------------------------------------------------------------
1509
1510
# The SEARCHENGINE tag specifies whether or not a search engine should be
1511
# used. If set to NO the values of all tags below this one will be ignored.
1512
1513
SEARCHENGINE = NO
Loggerhead is a web-based interface for Breezy
Version: 2.0.1