~ubuntu-branches/ubuntu/oneiric/imagemagick/oneiric-updates
» Revision
29
: config/MagickWand.dox.in
« back to all changes in this revision
Viewing changes to config/MagickWand.dox.in
- browse files at revision 29
- compare with another revision
- download diff
- download tarball
- view history from revision 29
- Committer: Bazaar Package Importer
- Author(s): Colin Watson
- Date: 2011-06-15 11:05:28 UTC
- mfrom: (6.2.11 sid)
- Revision ID: james.westby@ubuntu.com-20110615110528-08jgo07a4846xh8d
Tags: 8:6.6.0.4-3ubuntu1
* Resynchronise with Debian (LP: #797595). Remaining changes:
- Make ufraw-batch (universe) a suggestion instead of a recommendation.
- Make debian/rules install target depend on check; they cannot reliably
be run in parallel.
- Don't set MAKEFLAGS in debian/rules; just pass it to the build.
- Make ufraw-batch (universe) a suggestion instead of a recommendation.
- Make debian/rules install target depend on check; they cannot reliably
be run in parallel.
- Don't set MAKEFLAGS in debian/rules; just pass it to the build.
- files added:
- m4/ac_compile_warnings.m4
- files removed:
- coders/debug.c
- files modified:
- .pc/601824.patch/magick/configure.c
- magick.sh.in *
added
removed
config/MagickWand.dox.in
1
# Doxyfile 1.6.2-20100208
1
# Doxyfile 1.5.4
2
2
3
3
# This file describes the settings to be used by the documentation system
4
4
# doxygen (www.doxygen.org) for a project
14
14
# Project related configuration options
15
15
#---------------------------------------------------------------------------
16
16
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.
17
# This tag specifies the encoding used for all characters in the config file that
18
# follow. The default is UTF-8 which is also the encoding used for all text before
19
# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
20
# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
21
# possible encodings.
22
22
23
23
DOXYFILE_ENCODING = UTF-8
24
24
25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26
26
# by quotes) that should identify the project.
27
27
28
28
PROJECT_NAME = MagickWand
29
29
30
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
31
# This could be handy for archiving the generated documentation or
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
32
# if some version control system is used.
33
33
34
34
PROJECT_NUMBER = @PACKAGE_VERSION@
35
35
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
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
39
# where doxygen was started. If left blank the current directory will be used.
40
40
41
41
OUTPUT_DIRECTORY = www/api
42
42
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
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
48
# otherwise cause performance problems for the file system.
49
49
50
50
CREATE_SUBDIRS = NO
51
51
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, Esperanto, Farsi, Finnish, French, German,
58
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
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, Finnish, French, German, Greek, Hungarian,
58
# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
59
# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
60
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
62
61
63
62
OUTPUT_LANGUAGE = English
64
63
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).
64
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
65
# include brief member descriptions after the members that are listed in
66
# the file and class documentation (similar to JavaDoc).
68
67
# Set to NO to disable this.
69
68
70
69
BRIEF_MEMBER_DESC = YES
71
70
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
71
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
72
# the brief description of a member or function before the detailed description.
73
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75
74
# brief descriptions will be completely suppressed.
76
75
77
76
REPEAT_BRIEF = YES
78
77
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"
78
# This tag implements a quasi-intelligent brief description abbreviator
79
# that is used to form the text in various listings. Each string
80
# in this list, if found as the leading text of the brief description, will be
81
# stripped from the text and the result after processing the whole list, is
82
# used as the annotated text. Otherwise, the brief description is used as-is.
83
# If left blank, the following values are used ("$name" is automatically
84
# replaced with the name of the entity): "The $name class" "The $name widget"
85
# "The $name file" "is" "provides" "specifies" "contains"
87
86
# "represents" "a" "an" "the"
88
87
89
ABBREVIATE_BRIEF =
88
ABBREVIATE_BRIEF =
90
89
91
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92
# Doxygen will generate a detailed section even if there is only a brief
90
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
91
# Doxygen will generate a detailed section even if there is only a brief
93
92
# description.
94
93
95
94
ALWAYS_DETAILED_SEC = NO
96
95
97
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
98
# inherited members of a class in the documentation of that class as if those
99
# members were ordinary class members. Constructors, destructors and assignment
96
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
97
# inherited members of a class in the documentation of that class as if those
98
# members were ordinary class members. Constructors, destructors and assignment
100
99
# operators of the base classes will not be shown.
101
100
102
101
INLINE_INHERITED_MEMB = NO
103
102
104
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105
# path before files name in the file list and in the header files. If set
103
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
104
# path before files name in the file list and in the header files. If set
106
105
# to NO the shortest path that makes the file name unique will be used.
107
106
108
107
FULL_PATH_NAMES = NO
109
108
110
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111
# can be used to strip a user-defined part of the path. Stripping is
112
# only done if one of the specified strings matches the left-hand part of
113
# the path. The tag can be used to show relative paths in the file list.
114
# If left blank the directory from which doxygen is run is used as the
109
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
110
# can be used to strip a user-defined part of the path. Stripping is
111
# only done if one of the specified strings matches the left-hand part of
112
# the path. The tag can be used to show relative paths in the file list.
113
# If left blank the directory from which doxygen is run is used as the
115
114
# path to strip.
116
115
117
STRIP_FROM_PATH =
116
STRIP_FROM_PATH =
118
117
119
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
120
# the path mentioned in the documentation of a class, which tells
121
# the reader which header file to include in order to use a class.
122
# If left blank only the name of the header file containing the class
123
# definition is used. Otherwise one should specify the include paths that
118
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
119
# the path mentioned in the documentation of a class, which tells
120
# the reader which header file to include in order to use a class.
121
# If left blank only the name of the header file containing the class
122
# definition is used. Otherwise one should specify the include paths that
124
123
# are normally passed to the compiler using the -I flag.
125
124
126
STRIP_FROM_INC_PATH =
125
STRIP_FROM_INC_PATH =
127
126
128
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
129
# (but less readable) file names. This can be useful is your file systems
127
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
128
# (but less readable) file names. This can be useful is your file systems
130
129
# doesn't support long names like on DOS, Mac, or CD-ROM.
131
130
132
131
SHORT_NAMES = NO
133
132
134
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135
# will interpret the first line (until the first dot) of a JavaDoc-style
136
# comment as the brief description. If set to NO, the JavaDoc
137
# comments will behave just like regular Qt-style comments
133
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
134
# will interpret the first line (until the first dot) of a JavaDoc-style
135
# comment as the brief description. If set to NO, the JavaDoc
136
# comments will behave just like regular Qt-style comments
138
137
# (thus requiring an explicit @brief command for a brief description.)
139
138
140
139
JAVADOC_AUTOBRIEF = NO
141
140
142
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
143
# interpret the first line (until the first dot) of a Qt-style
144
# comment as the brief description. If set to NO, the comments
145
# will behave just like regular Qt-style comments (thus requiring
141
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
142
# interpret the first line (until the first dot) of a Qt-style
143
# comment as the brief description. If set to NO, the comments
144
# will behave just like regular Qt-style comments (thus requiring
146
145
# an explicit \brief command for a brief description.)
147
146
148
147
QT_AUTOBRIEF = NO
149
148
150
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
151
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
152
# comments) as a brief description. This used to be the default behaviour.
153
# The new default is to treat a multi-line C++ comment block as a detailed
149
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
150
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
151
# comments) as a brief description. This used to be the default behaviour.
152
# The new default is to treat a multi-line C++ comment block as a detailed
154
153
# description. Set this tag to YES if you prefer the old behaviour instead.
155
154
156
155
MULTILINE_CPP_IS_BRIEF = YES
157
156
158
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159
# member inherits the documentation from any documented member that it
157
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
158
# will output the detailed description near the top, like JavaDoc.
159
# If set to NO, the detailed description appears after the member
160
# documentation.
161
162
DETAILS_AT_TOP = YES
163
164
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
165
# member inherits the documentation from any documented member that it
160
166
# re-implements.
161
167
162
168
INHERIT_DOCS = YES
163
169
164
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165
# a new page for each member. If set to NO, the documentation of a member will
170
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
171
# a new page for each member. If set to NO, the documentation of a member will
166
172
# be part of the file/class/namespace that contains it.
167
173
168
174
SEPARATE_MEMBER_PAGES = NO
169
175
170
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
176
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
171
177
# Doxygen uses this value to replace tabs by spaces in code fragments.
172
178
173
179
TAB_SIZE = 8
174
180
175
# This tag can be used to specify a number of aliases that acts
176
# as commands in the documentation. An alias has the form "name=value".
177
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
178
# put the command \sideeffect (or @sideeffect) in the documentation, which
179
# will result in a user-defined paragraph with heading "Side Effects:".
181
# This tag can be used to specify a number of aliases that acts
182
# as commands in the documentation. An alias has the form "name=value".
183
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
184
# put the command \sideeffect (or @sideeffect) in the documentation, which
185
# will result in a user-defined paragraph with heading "Side Effects:".
180
186
# You can put \n's in the value part of an alias to insert newlines.
181
187
182
ALIASES =
188
ALIASES =
183
189
184
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185
# sources only. Doxygen will then generate output that is more tailored for C.
186
# For instance, some of the names that are used will be different. The list
190
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
191
# sources only. Doxygen will then generate output that is more tailored for C.
192
# For instance, some of the names that are used will be different. The list
187
193
# of all members will be omitted, etc.
188
194
189
195
OPTIMIZE_OUTPUT_FOR_C = YES
190
196
191
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192
# sources only. Doxygen will then generate output that is more tailored for
193
# Java. For instance, namespaces will be presented as packages, qualified
194
# scopes will look different, etc.
197
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
198
# sources only. Doxygen will then generate output that is more tailored for Java.
199
# For instance, namespaces will be presented as packages, qualified scopes
200
# will look different, etc.
195
201
196
202
OPTIMIZE_OUTPUT_JAVA = NO
197
203
198
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199
# sources only. Doxygen will then generate output that is more tailored for
200
# Fortran.
201
202
OPTIMIZE_FOR_FORTRAN = NO
203
204
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205
# sources. Doxygen will then generate output that is tailored for
206
# VHDL.
207
208
OPTIMIZE_OUTPUT_VHDL = NO
209
210
# Doxygen selects the parser to use depending on the extension of the files it parses.
211
# With this tag you can assign which parser to use for a given extension.
212
# Doxygen has a built-in mapping, but you can override or extend it using this tag.
213
# The format is ext=language, where ext is a file extension, and language is one of
214
# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
215
# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
216
# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
217
# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
218
219
EXTENSION_MAPPING =
220
221
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
222
# to include (a tag file for) the STL sources as input, then you should
223
# set this tag to YES in order to let doxygen match functions declarations and
224
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
225
# func(std::string) {}). This also make the inheritance and collaboration
204
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
205
# include (a tag file for) the STL sources as input, then you should
206
# set this tag to YES in order to let doxygen match functions declarations and
207
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
208
# func(std::string) {}). This also make the inheritance and collaboration
226
209
# diagrams that involve STL classes more complete and accurate.
227
210
228
211
BUILTIN_STL_SUPPORT = NO
232
215
233
216
CPP_CLI_SUPPORT = NO
234
217
235
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
236
# Doxygen will parse them like normal C++ but will assume all classes use public
218
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
219
# Doxygen will parse them like normal C++ but will assume all classes use public
237
220
# instead of private inheritance when no explicit protection keyword is present.
238
221
239
222
SIP_SUPPORT = NO
240
223
241
# For Microsoft's IDL there are propget and propput attributes to indicate getter
242
# and setter methods for a property. Setting this option to YES (the default)
243
# will make doxygen to replace the get and set methods by a property in the
244
# documentation. This will only work if the methods are indeed getting or
245
# setting a simple type. If this is not the case, or you want to show the
246
# methods anyway, you should set this option to NO.
247
248
IDL_PROPERTY_SUPPORT = YES
249
250
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
251
# tag is set to YES, then doxygen will reuse the documentation of the first
252
# member in the group (if any) for the other members of the group. By default
224
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
225
# tag is set to YES, then doxygen will reuse the documentation of the first
226
# member in the group (if any) for the other members of the group. By default
253
227
# all members of a group must be documented explicitly.
254
228
255
229
DISTRIBUTE_GROUP_DOC = NO
256
230
257
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
258
# the same type (for instance a group of public functions) to be put as a
259
# subgroup of that type (e.g. under the Public Functions section). Set it to
260
# NO to prevent subgrouping. Alternatively, this can be done per class using
231
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
232
# the same type (for instance a group of public functions) to be put as a
233
# subgroup of that type (e.g. under the Public Functions section). Set it to
234
# NO to prevent subgrouping. Alternatively, this can be done per class using
261
235
# the \nosubgrouping command.
262
236
263
237
SUBGROUPING = YES
264
238
265
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
266
# is documented as struct, union, or enum with the name of the typedef. So
267
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
268
# with name TypeT. When disabled the typedef will appear as a member of a file,
269
# namespace, or class. And the struct will be named TypeS. This can typically
270
# be useful for C code in case the coding convention dictates that all compound
271
# types are typedef'ed and only the typedef is referenced, never the tag name.
239
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct (or union) is
240
# documented as struct with the name of the typedef. So
241
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
242
# with name TypeT. When disabled the typedef will appear as a member of a file,
243
# namespace, or class. And the struct will be named TypeS. This can typically
244
# be useful for C code where the coding convention is that all structs are
245
# typedef'ed and only the typedef is referenced never the struct's name.
272
246
273
247
TYPEDEF_HIDES_STRUCT = NO
274
248
275
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
276
# determine which symbols to keep in memory and which to flush to disk.
277
# When the cache is full, less often used symbols will be written to disk.
278
# For small to medium size projects (<1000 input files) the default value is
279
# probably good enough. For larger projects a too small cache size can cause
280
# doxygen to be busy swapping symbols to and from disk most of the time
281
# causing a significant performance penality.
282
# If the system has enough physical memory increasing the cache will improve the
283
# performance by keeping more symbols in memory. Note that the value works on
284
# a logarithmic scale so increasing the size by one will rougly double the
285
# memory usage. The cache size is given by this formula:
286
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
287
# corresponding to a cache size of 2^16 = 65536 symbols
288
289
SYMBOL_CACHE_SIZE = 0
290
291
249
#---------------------------------------------------------------------------
292
250
# Build related configuration options
293
251
#---------------------------------------------------------------------------
294
252
295
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
296
# documentation are documented, even if no documentation was available.
297
# Private class members and static file members will be hidden unless
253
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
254
# documentation are documented, even if no documentation was available.
255
# Private class members and static file members will be hidden unless
298
256
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
299
257
300
258
EXTRACT_ALL = YES
301
259
302
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
260
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
303
261
# will be included in the documentation.
304
262
305
263
EXTRACT_PRIVATE = NO
306
264
307
# If the EXTRACT_STATIC tag is set to YES all static members of a file
265
# If the EXTRACT_STATIC tag is set to YES all static members of a file
308
266
# will be included in the documentation.
309
267
310
268
EXTRACT_STATIC = YES
311
269
312
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
313
# defined locally in source files will be included in the documentation.
270
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
271
# defined locally in source files will be included in the documentation.
314
272
# If set to NO only classes defined in header files are included.
315
273
316
274
EXTRACT_LOCAL_CLASSES = YES
317
275
318
# This flag is only useful for Objective-C code. When set to YES local
319
# methods, which are defined in the implementation section but not in
320
# the interface are included in the documentation.
276
# This flag is only useful for Objective-C code. When set to YES local
277
# methods, which are defined in the implementation section but not in
278
# the interface are included in the documentation.
321
279
# If set to NO (the default) only methods in the interface are included.
322
280
323
281
EXTRACT_LOCAL_METHODS = NO
324
282
325
# If this flag is set to YES, the members of anonymous namespaces will be
326
# extracted and appear in the documentation as a namespace called
327
# 'anonymous_namespace{file}', where file will be replaced with the base
328
# name of the file that contains the anonymous namespace. By default
329
# anonymous namespace are hidden.
283
# If this flag is set to YES, the members of anonymous namespaces will be extracted
284
# and appear in the documentation as a namespace called 'anonymous_namespace{file}',
285
# where file will be replaced with the base name of the file that contains the anonymous
286
# namespace. By default anonymous namespace are hidden.
330
287
331
288
EXTRACT_ANON_NSPACES = NO
332
289
333
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
334
# undocumented members of documented classes, files or namespaces.
335
# If set to NO (the default) these members will be included in the
336
# various overviews, but no documentation section is generated.
290
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
291
# undocumented members of documented classes, files or namespaces.
292
# If set to NO (the default) these members will be included in the
293
# various overviews, but no documentation section is generated.
337
294
# This option has no effect if EXTRACT_ALL is enabled.
338
295
339
296
HIDE_UNDOC_MEMBERS = NO
340
297
341
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
342
# undocumented classes that are normally visible in the class hierarchy.
343
# If set to NO (the default) these classes will be included in the various
298
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
299
# undocumented classes that are normally visible in the class hierarchy.
300
# If set to NO (the default) these classes will be included in the various
344
301
# overviews. This option has no effect if EXTRACT_ALL is enabled.
345
302
346
303
HIDE_UNDOC_CLASSES = NO
347
304
348
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
349
# friend (class|struct|union) declarations.
350
# If set to NO (the default) these declarations will be included in the
305
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
306
# friend (class|struct|union) declarations.
307
# If set to NO (the default) these declarations will be included in the
351
308
# documentation.
352
309
353
310
HIDE_FRIEND_COMPOUNDS = NO
354
311
355
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
356
# documentation blocks found inside the body of a function.
357
# If set to NO (the default) these blocks will be appended to the
312
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
313
# documentation blocks found inside the body of a function.
314
# If set to NO (the default) these blocks will be appended to the
358
315
# function's detailed documentation block.
359
316
360
317
HIDE_IN_BODY_DOCS = NO
361
318
362
# The INTERNAL_DOCS tag determines if documentation
363
# that is typed after a \internal command is included. If the tag is set
364
# to NO (the default) then the documentation will be excluded.
319
# The INTERNAL_DOCS tag determines if documentation
320
# that is typed after a \internal command is included. If the tag is set
321
# to NO (the default) then the documentation will be excluded.
365
322
# Set it to YES to include the internal documentation.
366
323
367
324
INTERNAL_DOCS = NO
368
325
369
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
370
# file names in lower-case letters. If set to YES upper-case letters are also
371
# allowed. This is useful if you have classes or files whose names only differ
372
# in case and if your file system supports case sensitive file names. Windows
326
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
327
# file names in lower-case letters. If set to YES upper-case letters are also
328
# allowed. This is useful if you have classes or files whose names only differ
329
# in case and if your file system supports case sensitive file names. Windows
373
330
# and Mac users are advised to set this option to NO.
374
331
375
332
CASE_SENSE_NAMES = YES
376
333
377
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
378
# will show members with their full class and namespace scopes in the
334
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
335
# will show members with their full class and namespace scopes in the
379
336
# documentation. If set to YES the scope will be hidden.
380
337
381
338
HIDE_SCOPE_NAMES = NO
382
339
383
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
384
# will put a list of the files that are included by a file in the documentation
340
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
341
# will put a list of the files that are included by a file in the documentation
385
342
# of that file.
386
343
387
344
SHOW_INCLUDE_FILES = YES
388
345
389
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
390
# will list include files with double quotes in the documentation
391
# rather than with sharp brackets.
392
393
FORCE_LOCAL_INCLUDES = NO
394
395
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
346
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
396
347
# is inserted in the documentation for inline members.
397
348
398
349
INLINE_INFO = YES
399
350
400
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
401
# will sort the (detailed) documentation of file and class members
402
# alphabetically by member name. If set to NO the members will appear in
351
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
352
# will sort the (detailed) documentation of file and class members
353
# alphabetically by member name. If set to NO the members will appear in
403
354
# declaration order.
404
355
405
356
SORT_MEMBER_DOCS = YES
406
357
407
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
408
# brief documentation of file, namespace and class members alphabetically
409
# by member name. If set to NO (the default) the members will appear in
358
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
359
# brief documentation of file, namespace and class members alphabetically
360
# by member name. If set to NO (the default) the members will appear in
410
361
# declaration order.
411
362
412
363
SORT_BRIEF_DOCS = NO
413
364
414
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
415
416
SORT_MEMBERS_CTORS_1ST = NO
417
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.
421
422
SORT_GROUP_NAMES = NO
423
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.
365
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
366
# sorted by fully-qualified names, including namespaces. If set to
367
# NO (the default), the class list will be sorted only by class name,
368
# not including the namespace part.
428
369
# 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
370
# Note: This option applies only to the class list, not to the
430
371
# alphabetical list.
431
372
432
373
SORT_BY_SCOPE_NAME = NO
433
374
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
375
# The GENERATE_TODOLIST tag can be used to enable (YES) or
376
# disable (NO) the todo list. This list is created by putting \todo
436
377
# commands in the documentation.
437
378
438
379
GENERATE_TODOLIST = YES
439
380
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
381
# The GENERATE_TESTLIST tag can be used to enable (YES) or
382
# disable (NO) the test list. This list is created by putting \test
442
383
# commands in the documentation.
443
384
444
385
GENERATE_TESTLIST = YES
445
386
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
387
# The GENERATE_BUGLIST tag can be used to enable (YES) or
388
# disable (NO) the bug list. This list is created by putting \bug
448
389
# commands in the documentation.
449
390
450
391
GENERATE_BUGLIST = YES
451
392
452
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
453
# disable (NO) the deprecated list. This list is created by putting
393
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
394
# disable (NO) the deprecated list. This list is created by putting
454
395
# \deprecated commands in the documentation.
455
396
456
397
GENERATE_DEPRECATEDLIST= YES
457
398
458
# The ENABLED_SECTIONS tag can be used to enable conditional
399
# The ENABLED_SECTIONS tag can be used to enable conditional
459
400
# documentation sections, marked by \if sectionname ... \endif.
460
401
461
ENABLED_SECTIONS =
402
ENABLED_SECTIONS =
462
403
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
404
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
405
# the initial value of a variable or define consists of for it to appear in
406
# the documentation. If the initializer consists of more lines than specified
407
# here it will be hidden. Use a value of 0 to hide initializers completely.
408
# The appearance of the initializer of individual variables and defines in the
409
# documentation can be controlled using \showinitializer or \hideinitializer
469
410
# command in the documentation regardless of this setting.
470
411
471
412
MAX_INITIALIZER_LINES = 30
472
413
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
414
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
415
# at the bottom of the documentation of classes and structs. If set to YES the
475
416
# list will mention the files that were used to generate the documentation.
476
417
477
418
SHOW_USED_FILES = YES
478
419
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
420
# If the sources in your project are distributed over multiple directories
421
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
481
422
# in the documentation. The default is NO.
482
423
483
424
SHOW_DIRECTORIES = YES
484
425
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.
488
489
SHOW_FILES = YES
490
491
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
492
# Namespaces page.
493
# This will remove the Namespaces entry from the Quick Index
494
# and from the Folder Tree View (if specified). The default is YES.
495
496
SHOW_NAMESPACES = YES
497
498
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
499
# doxygen should invoke to get the current version for each file (typically from
500
# the version control system). Doxygen will invoke the program by executing (via
501
# popen()) the command <command> <input-file>, where <command> is the value of
502
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
503
# provided by doxygen. Whatever the program writes to standard output
426
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
427
# doxygen should invoke to get the current version for each file (typically from the
428
# version control system). Doxygen will invoke the program by executing (via
429
# popen()) the command <command> <input-file>, where <command> is the value of
430
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
431
# provided by doxygen. Whatever the program writes to standard output
504
432
# is used as the file version. See the manual for examples.
505
433
506
FILE_VERSION_FILTER =
507
508
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
509
# doxygen. The layout file controls the global structure of the generated output files
510
# in an output format independent way. The create the layout file that represents
511
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
512
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
513
# of the layout file.
514
515
LAYOUT_FILE =
434
FILE_VERSION_FILTER =
516
435
517
436
#---------------------------------------------------------------------------
518
437
# configuration options related to warning and progress messages
519
438
#---------------------------------------------------------------------------
520
439
521
# The QUIET tag can be used to turn on/off the messages that are generated
440
# The QUIET tag can be used to turn on/off the messages that are generated
522
441
# by doxygen. Possible values are YES and NO. If left blank NO is used.
523
442
524
443
QUIET = NO
525
444
526
# The WARNINGS tag can be used to turn on/off the warning messages that are
527
# generated by doxygen. Possible values are YES and NO. If left blank
445
# The WARNINGS tag can be used to turn on/off the warning messages that are
446
# generated by doxygen. Possible values are YES and NO. If left blank
528
447
# NO is used.
529
448
530
449
WARNINGS = YES
531
450
532
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
533
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
451
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
452
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
534
453
# automatically be disabled.
535
454
536
455
WARN_IF_UNDOCUMENTED = YES
537
456
538
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
539
# potential errors in the documentation, such as not documenting some
540
# parameters in a documented function, or documenting parameters that
457
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
458
# potential errors in the documentation, such as not documenting some
459
# parameters in a documented function, or documenting parameters that
541
460
# don't exist or using markup commands wrongly.
542
461
543
462
WARN_IF_DOC_ERROR = YES
544
463
545
# This WARN_NO_PARAMDOC option can be abled to get warnings for
546
# functions that are documented, but have no documentation for their parameters
547
# or return value. If set to NO (the default) doxygen will only warn about
548
# wrong or incomplete parameter documentation, but not about the absence of
464
# This WARN_NO_PARAMDOC option can be abled to get warnings for
465
# functions that are documented, but have no documentation for their parameters
466
# or return value. If set to NO (the default) doxygen will only warn about
467
# wrong or incomplete parameter documentation, but not about the absence of
549
468
# documentation.
550
469
551
470
WARN_NO_PARAMDOC = NO
552
471
553
# The WARN_FORMAT tag determines the format of the warning messages that
554
# doxygen can produce. The string should contain the $file, $line, and $text
555
# tags, which will be replaced by the file and line number from which the
556
# warning originated and the warning text. Optionally the format may contain
557
# $version, which will be replaced by the version of the file (if it could
472
# The WARN_FORMAT tag determines the format of the warning messages that
473
# doxygen can produce. The string should contain the $file, $line, and $text
474
# tags, which will be replaced by the file and line number from which the
475
# warning originated and the warning text. Optionally the format may contain
476
# $version, which will be replaced by the version of the file (if it could
558
477
# be obtained via FILE_VERSION_FILTER)
559
478
560
479
WARN_FORMAT = "$file:$line: $text "
561
480
562
# The WARN_LOGFILE tag can be used to specify a file to which warning
563
# and error messages should be written. If left blank the output is written
481
# The WARN_LOGFILE tag can be used to specify a file to which warning
482
# and error messages should be written. If left blank the output is written
564
483
# to stderr.
565
484
566
WARN_LOGFILE =
485
WARN_LOGFILE =
567
486
568
487
#---------------------------------------------------------------------------
569
488
# configuration options related to the input files
570
489
#---------------------------------------------------------------------------
571
490
572
# The INPUT tag can be used to specify the files and/or directories that contain
573
# documented source files. You may enter file names like "myfile.cpp" or
574
# directories like "/usr/src/myproject". Separate the files or directories
491
# The INPUT tag can be used to specify the files and/or directories that contain
492
# documented source files. You may enter file names like "myfile.cpp" or
493
# directories like "/usr/src/myproject". Separate the files or directories
575
494
# with spaces.
576
495
577
496
INPUT = wand
578
497
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.
498
# This tag can be used to specify the character encoding of the source files that
499
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
500
# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
501
# See http://www.gnu.org/software/libiconv for the list of possible encodings.
584
502
585
503
INPUT_ENCODING = UTF-8
586
504
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
505
# If the value of the INPUT tag contains directories, you can use the
506
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
507
# and *.h) to filter out the source-files in the directories. If left
508
# blank the following patterns are tested:
509
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
592
510
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
593
511
594
512
FILE_PATTERNS = *.c \
595
513
*.h
596
514
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.
515
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
516
# should be searched for input files as well. Possible values are YES and NO.
599
517
# If left blank NO is used.
600
518
601
519
RECURSIVE = NO
602
520
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
521
# The EXCLUDE tag can be used to specify files and/or directories that should
522
# excluded from the INPUT source files. This way you can easily exclude a
605
523
# subdirectory from a directory tree whose root is specified with the INPUT tag.
606
524
607
EXCLUDE =
525
EXCLUDE =
608
526
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
527
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
528
# directories that are symbolic links (a Unix filesystem feature) are excluded
611
529
# from the input.
612
530
613
531
EXCLUDE_SYMLINKS = NO
614
532
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
533
# If the value of the INPUT tag contains directories, you can use the
534
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
535
# certain files from those directories. Note that the wildcards are matched
536
# against the file with absolute path, so to exclude all test directories
619
537
# for example use the pattern */test/*
620
538
621
EXCLUDE_PATTERNS =
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,
627
# 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
539
EXCLUDE_PATTERNS =
540
541
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
542
# (namespaces, classes, functions, etc.) that should be excluded from the output.
543
# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
544
# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
545
546
EXCLUDE_SYMBOLS =
547
548
# The EXAMPLE_PATH tag can be used to specify one or more files or
549
# directories that contain example code fragments that are included (see
633
550
# the \include command).
634
551
635
552
EXAMPLE_PATH = .
636
553
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
554
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
555
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
556
# and *.h) to filter out the source-files in the directories. If left
640
557
# blank all files are included.
641
558
642
EXAMPLE_PATTERNS =
559
EXAMPLE_PATTERNS =
643
560
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.
561
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
562
# searched for input files to be used with the \include or \dontinclude
563
# commands irrespective of the value of the RECURSIVE tag.
647
564
# Possible values are YES and NO. If left blank NO is used.
648
565
649
566
EXAMPLE_RECURSIVE = NO
650
567
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
568
# The IMAGE_PATH tag can be used to specify one or more files or
569
# directories that contain image that are included in the documentation (see
653
570
# the \image command).
654
571
655
IMAGE_PATH =
572
IMAGE_PATH =
656
573
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.
663
# If FILTER_PATTERNS is specified, this tag will be
574
# The INPUT_FILTER tag can be used to specify a program that doxygen should
575
# invoke to filter for each input file. Doxygen will invoke the filter program
576
# by executing (via popen()) the command <filter> <input-file>, where <filter>
577
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
578
# input file. Doxygen will then use the output that the filter program writes
579
# to standard output. If FILTER_PATTERNS is specified, this tag will be
664
580
# ignored.
665
581
666
INPUT_FILTER =
582
INPUT_FILTER =
667
583
668
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
669
# basis.
670
# Doxygen will compare the file name with each pattern and apply the
671
# filter if there is a match.
672
# The filters are a list of the form:
673
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
674
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
584
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
585
# basis. Doxygen will compare the file name with each pattern and apply the
586
# filter if there is a match. The filters are a list of the form:
587
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
588
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
675
589
# is applied to all files.
676
590
677
FILTER_PATTERNS =
591
FILTER_PATTERNS =
678
592
679
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
680
# INPUT_FILTER) will be used to filter the input files when producing source
593
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
594
# INPUT_FILTER) will be used to filter the input files when producing source
681
595
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
682
596
683
597
FILTER_SOURCE_FILES = NO
686
600
# configuration options related to source browsing
687
601
#---------------------------------------------------------------------------
688
602
689
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
690
# be generated. Documented entities will be cross-referenced with these sources.
691
# Note: To get rid of all source code in the generated output, make sure also
692
# VERBATIM_HEADERS is set to NO.
603
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
604
# be generated. Documented entities will be cross-referenced with these sources.
605
# Note: To get rid of all source code in the generated output, make sure also
606
# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
607
# then you must also enable this option. If you don't then doxygen will produce
608
# a warning and turn it on anyway
693
609
694
610
SOURCE_BROWSER = NO
695
611
696
# Setting the INLINE_SOURCES tag to YES will include the body
612
# Setting the INLINE_SOURCES tag to YES will include the body
697
613
# of functions and classes directly in the documentation.
698
614
699
615
INLINE_SOURCES = NO
700
616
701
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
702
# doxygen to hide any special comment blocks from generated source code
617
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
618
# doxygen to hide any special comment blocks from generated source code
703
619
# fragments. Normal C and C++ comments will always remain visible.
704
620
705
621
STRIP_CODE_COMMENTS = YES
706
622
707
# If the REFERENCED_BY_RELATION tag is set to YES
708
# then for each documented function all documented
623
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
624
# then for each documented function all documented
709
625
# functions referencing it will be listed.
710
626
711
627
REFERENCED_BY_RELATION = YES
712
628
713
# If the REFERENCES_RELATION tag is set to YES
714
# then for each documented function all documented entities
629
# If the REFERENCES_RELATION tag is set to YES (the default)
630
# then for each documented function all documented entities
715
631
# called/used by that function will be listed.
716
632
717
633
REFERENCES_RELATION = YES
719
635
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
720
636
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
721
637
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
722
# link to the source code.
723
# Otherwise they will link to the documentation.
638
# link to the source code. Otherwise they will link to the documentstion.
724
639
725
640
REFERENCES_LINK_SOURCE = YES
726
641
727
# If the USE_HTAGS tag is set to YES then the references to source code
728
# will point to the HTML generated by the htags(1) tool instead of doxygen
729
# built-in source browser. The htags tool is part of GNU's global source
730
# tagging system (see http://www.gnu.org/software/global/global.html). You
642
# If the USE_HTAGS tag is set to YES then the references to source code
643
# will point to the HTML generated by the htags(1) tool instead of doxygen
644
# built-in source browser. The htags tool is part of GNU's global source
645
# tagging system (see http://www.gnu.org/software/global/global.html). You
731
646
# will need version 4.8.6 or higher.
732
647
733
648
USE_HTAGS = NO
734
649
735
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
736
# will generate a verbatim copy of the header file for each class for
650
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
651
# will generate a verbatim copy of the header file for each class for
737
652
# which an include is specified. Set to NO to disable this.
738
653
739
654
VERBATIM_HEADERS = YES
742
657
# configuration options related to the alphabetical class index
743
658
#---------------------------------------------------------------------------
744
659
745
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
746
# of all compounds will be generated. Enable this if the project
660
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
661
# of all compounds will be generated. Enable this if the project
747
662
# contains a lot of classes, structs, unions or interfaces.
748
663
749
664
ALPHABETICAL_INDEX = YES
750
665
751
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
752
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
666
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
667
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
753
668
# in which this list will be split (can be a number in the range [1..20])
754
669
755
670
COLS_IN_ALPHA_INDEX = 8
756
671
757
# In case all classes in a project start with a common prefix, all
758
# classes will be put under the same header in the alphabetical index.
759
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
672
# In case all classes in a project start with a common prefix, all
673
# classes will be put under the same header in the alphabetical index.
674
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
760
675
# should be ignored while generating the index headers.
761
676
762
IGNORE_PREFIX =
677
IGNORE_PREFIX =
763
678
764
679
#---------------------------------------------------------------------------
765
680
# configuration options related to the HTML output
766
681
#---------------------------------------------------------------------------
767
682
768
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
683
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
769
684
# generate HTML output.
770
685
771
686
GENERATE_HTML = YES
772
687
773
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
774
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
688
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
689
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
775
690
# put in front of it. If left blank `html' will be used as the default path.
776
691
777
692
HTML_OUTPUT = MagickWand
778
693
779
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
780
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
694
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
695
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
781
696
# doxygen will generate files with .html extension.
782
697
783
698
HTML_FILE_EXTENSION = .html
784
699
785
# The HTML_HEADER tag can be used to specify a personal HTML header for
786
# each generated HTML page. If it is left blank doxygen will generate a
700
# The HTML_HEADER tag can be used to specify a personal HTML header for
701
# each generated HTML page. If it is left blank doxygen will generate a
787
702
# standard header.
788
703
789
HTML_HEADER =
704
HTML_HEADER =
790
705
791
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
792
# each generated HTML page. If it is left blank doxygen will generate a
706
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
707
# each generated HTML page. If it is left blank doxygen will generate a
793
708
# standard footer.
794
709
795
HTML_FOOTER =
796
797
# If the HTML_TIMESTAMP tag is set to YES then the generated HTML
798
# documentation will contain the timesstamp.
799
800
HTML_TIMESTAMP = NO
801
802
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
803
# style sheet that is used by each HTML page. It can be used to
804
# fine-tune the look of the HTML output. If the tag is left blank doxygen
805
# will generate a default style sheet. Note that doxygen will try to copy
806
# the style sheet file to the HTML output directory, so don't put your own
710
HTML_FOOTER =
711
712
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
713
# style sheet that is used by each HTML page. It can be used to
714
# fine-tune the look of the HTML output. If the tag is left blank doxygen
715
# will generate a default style sheet. Note that doxygen will try to copy
716
# the style sheet file to the HTML output directory, so don't put your own
807
717
# stylesheet in the HTML output directory as well, or it will be erased!
808
718
809
HTML_STYLESHEET =
810
811
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
812
# page will contain the date and time when the page was generated. Setting
813
# this to NO can help when comparing the output of multiple runs.
814
815
HTML_TIMESTAMP = NO
816
817
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
818
# files or namespaces will be aligned in HTML using tables. If set to
719
HTML_STYLESHEET =
720
721
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
722
# files or namespaces will be aligned in HTML using tables. If set to
819
723
# NO a bullet list will be used.
820
724
821
725
HTML_ALIGN_MEMBERS = YES
822
726
823
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
824
# documentation will contain sections that can be hidden and shown after the
825
# page has loaded. For this to work a browser that supports
826
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
727
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
728
# will be generated that can be used as input for tools like the
729
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
730
# of the generated HTML documentation.
731
732
GENERATE_HTMLHELP = NO
733
734
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
735
# documentation will contain sections that can be hidden and shown after the
736
# page has loaded. For this to work a browser that supports
737
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
827
738
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
828
739
829
740
HTML_DYNAMIC_SECTIONS = NO
830
741
831
# If the GENERATE_DOCSET tag is set to YES, additional index files
832
# will be generated that can be used as input for Apple's Xcode 3
833
# integrated development environment, introduced with OSX 10.5 (Leopard).
834
# To create a documentation set, doxygen will generate a Makefile in the
835
# HTML output directory. Running make will produce the docset in that
836
# directory and running "make install" will install the docset in
837
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
838
# it at startup.
839
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
840
841
GENERATE_DOCSET = NO
842
843
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
844
# feed. A documentation feed provides an umbrella under which multiple
845
# documentation sets from a single provider (such as a company or product suite)
846
# can be grouped.
847
848
DOCSET_FEEDNAME = "Doxygen generated docs"
849
850
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
851
# should uniquely identify the documentation set bundle. This should be a
852
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
853
# will append .docset to the name.
854
855
DOCSET_BUNDLE_ID = org.doxygen.Project
856
857
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
858
# will be generated that can be used as input for tools like the
859
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
860
# of the generated HTML documentation.
861
862
GENERATE_HTMLHELP = NO
863
864
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
865
# be used to specify the file name of the resulting .chm file. You
866
# can add a path in front of the file if the result should not be
742
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
743
# be used to specify the file name of the resulting .chm file. You
744
# can add a path in front of the file if the result should not be
867
745
# written to the html output directory.
868
746
869
CHM_FILE =
747
CHM_FILE =
870
748
871
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
872
# be used to specify the location (absolute path including file name) of
873
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
749
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
750
# be used to specify the location (absolute path including file name) of
751
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
874
752
# the HTML help compiler on the generated index.hhp.
875
753
876
HHC_LOCATION =
754
HHC_LOCATION =
877
755
878
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
879
# controls if a separate .chi index file is generated (YES) or that
756
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
757
# controls if a separate .chi index file is generated (YES) or that
880
758
# it should be included in the master .chm file (NO).
881
759
882
760
GENERATE_CHI = NO
883
761
884
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
885
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
886
# content.
887
888
CHM_INDEX_ENCODING =
889
890
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
891
# controls whether a binary table of contents is generated (YES) or a
762
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
763
# controls whether a binary table of contents is generated (YES) or a
892
764
# normal table of contents (NO) in the .chm file.
893
765
894
766
BINARY_TOC = NO
895
767
896
# The TOC_EXPAND flag can be set to YES to add extra items for group members
768
# The TOC_EXPAND flag can be set to YES to add extra items for group members
897
769
# to the contents of the HTML help documentation and to the tree view.
898
770
899
771
TOC_EXPAND = YES
900
772
901
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
902
# are set, an additional index file will be generated that can be used as input for
903
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
904
# HTML documentation.
905
906
GENERATE_QHP = NO
907
908
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
909
# be used to specify the file name of the resulting .qch file.
910
# The path specified is relative to the HTML output folder.
911
912
QCH_FILE =
913
914
# The QHP_NAMESPACE tag specifies the namespace to use when generating
915
# Qt Help Project output. For more information please see
916
# http://doc.trolltech.com/qthelpproject.html#namespace
917
918
QHP_NAMESPACE = org.doxygen.Project
919
920
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
921
# Qt Help Project output. For more information please see
922
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
923
924
QHP_VIRTUAL_FOLDER = doc
925
926
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
927
# For more information please see
928
# http://doc.trolltech.com/qthelpproject.html#custom-filters
929
930
QHP_CUST_FILTER_NAME =
931
932
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
933
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
934
935
QHP_CUST_FILTER_ATTRS =
936
937
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
938
# filter section matches.
939
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
940
941
QHP_SECT_FILTER_ATTRS =
942
943
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
944
# be used to specify the location of Qt's qhelpgenerator.
945
# If non-empty doxygen will try to run qhelpgenerator on the generated
946
# .qhp file.
947
948
QHG_LOCATION =
949
950
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
951
# will be generated, which together with the HTML files, form an Eclipse help
952
# plugin. To install this plugin and make it available under the help contents
953
# menu in Eclipse, the contents of the directory containing the HTML and XML
954
# files needs to be copied into the plugins directory of eclipse. The name of
955
# the directory within the plugins directory should be the same as
956
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.
957
958
GENERATE_ECLIPSEHELP = NO
959
960
# A unique identifier for the eclipse help plugin. When installing the plugin
961
# the directory name containing the HTML and XML files should also have
962
# this name.
963
964
ECLIPSE_DOC_ID = org.doxygen.Project
965
966
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
967
# top of each HTML page. The value NO (the default) enables the index and
773
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
774
# top of each HTML page. The value NO (the default) enables the index and
968
775
# the value YES disables it.
969
776
970
777
DISABLE_INDEX = YES
971
778
972
# This tag can be used to set the number of enum values (range [1..20])
779
# This tag can be used to set the number of enum values (range [1..20])
973
780
# that doxygen will group on one line in the generated HTML documentation.
974
781
975
782
ENUM_VALUES_PER_LINE = 4
976
783
977
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
978
# structure should be generated to display hierarchical information.
979
# If the tag value is set to YES, a side panel will be generated
980
# containing a tree-like index structure (just like the one that
981
# is generated for HTML Help). For this to work a browser that supports
982
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
983
# Windows users are probably better off using the HTML help feature.
784
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
785
# generated containing a tree-like index structure (just like the one that
786
# is generated for HTML Help). For this to work a browser that supports
787
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
788
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
789
# probably better off using the HTML help feature.
984
790
985
791
GENERATE_TREEVIEW = YES
986
792
987
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
988
# and Class Hierarchy pages using a tree view instead of an ordered list.
989
990
USE_INLINE_TREES = NO
991
992
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
993
# used to set the initial width (in pixels) of the frame in which the tree
793
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
794
# used to set the initial width (in pixels) of the frame in which the tree
994
795
# is shown.
995
796
996
797
TREEVIEW_WIDTH = 250
997
798
998
# Use this tag to change the font size of Latex formulas included
999
# as images in the HTML documentation. The default is 10. Note that
1000
# when you change the font size after a successful doxygen run you need
1001
# to manually remove any form_*.png images from the HTML output directory
1002
# to force them to be regenerated.
1003
1004
FORMULA_FONTSIZE = 10
1005
1006
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
1007
# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
1008
# typically be disabled. For large projects the javascript based search engine
1009
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1010
1011
SEARCHENGINE = NO
1012
1013
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index
1014
# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup
1015
# and does not have live searching capabilities.
1016
1017
SERVER_BASED_SEARCH = NO
1018
1019
799
#---------------------------------------------------------------------------
1020
800
# configuration options related to the LaTeX output
1021
801
#---------------------------------------------------------------------------
1022
802
1023
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
803
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1024
804
# generate Latex output.
1025
805
1026
806
GENERATE_LATEX = NO
1027
807
1028
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1029
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
808
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
809
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1030
810
# put in front of it. If left blank `latex' will be used as the default path.
1031
811
1032
812
LATEX_OUTPUT = latex
1033
813
1034
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
814
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1035
815
# invoked. If left blank `latex' will be used as the default command name.
1036
# Note that when enabling USE_PDFLATEX this option is only used for
1037
# generating bitmaps for formulas in the HTML output, but not in the
1038
# Makefile that is written to the output directory.
1039
816
1040
817
LATEX_CMD_NAME = latex
1041
818
1042
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1043
# generate index for LaTeX. If left blank `makeindex' will be used as the
819
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
820
# generate index for LaTeX. If left blank `makeindex' will be used as the
1044
821
# default command name.
1045
822
1046
823
MAKEINDEX_CMD_NAME = makeindex
1047
824
1048
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1049
# LaTeX documents. This may be useful for small projects and may help to
825
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
826
# LaTeX documents. This may be useful for small projects and may help to
1050
827
# save some trees in general.
1051
828
1052
829
COMPACT_LATEX = NO
1053
830
1054
# The PAPER_TYPE tag can be used to set the paper type that is used
1055
# by the printer. Possible values are: a4, a4wide, letter, legal and
831
# The PAPER_TYPE tag can be used to set the paper type that is used
832
# by the printer. Possible values are: a4, a4wide, letter, legal and
1056
833
# executive. If left blank a4wide will be used.
1057
834
1058
835
PAPER_TYPE = a4wide
1059
836
1060
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
837
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1061
838
# packages that should be included in the LaTeX output.
1062
839
1063
EXTRA_PACKAGES =
840
EXTRA_PACKAGES =
1064
841
1065
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1066
# the generated latex document. The header should contain everything until
1067
# the first chapter. If it is left blank doxygen will generate a
842
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
843
# the generated latex document. The header should contain everything until
844
# the first chapter. If it is left blank doxygen will generate a
1068
845
# standard header. Notice: only use this tag if you know what you are doing!
1069
846
1070
LATEX_HEADER =
847
LATEX_HEADER =
1071
848
1072
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1073
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1074
# contain links (just like the HTML output) instead of page references
849
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
850
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
851
# contain links (just like the HTML output) instead of page references
1075
852
# This makes the output suitable for online browsing using a pdf viewer.
1076
853
1077
854
PDF_HYPERLINKS = NO
1078
855
1079
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1080
# plain latex in the generated Makefile. Set this option to YES to get a
856
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
857
# plain latex in the generated Makefile. Set this option to YES to get a
1081
858
# higher quality PDF documentation.
1082
859
1083
860
USE_PDFLATEX = NO
1084
861
1085
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1086
# command to the generated LaTeX files. This will instruct LaTeX to keep
1087
# running if errors occur, instead of asking the user for help.
862
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
863
# command to the generated LaTeX files. This will instruct LaTeX to keep
864
# running if errors occur, instead of asking the user for help.
1088
865
# This option is also used when generating formulas in HTML.
1089
866
1090
867
LATEX_BATCHMODE = NO
1091
868
1092
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1093
# include the index chapters (such as File Index, Compound Index, etc.)
869
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
870
# include the index chapters (such as File Index, Compound Index, etc.)
1094
871
# in the output.
1095
872
1096
873
LATEX_HIDE_INDICES = NO
1097
874
1098
# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
1099
1100
LATEX_SOURCE_CODE = NO
1101
1102
875
#---------------------------------------------------------------------------
1103
876
# configuration options related to the RTF output
1104
877
#---------------------------------------------------------------------------
1105
878
1106
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1107
# The RTF output is optimized for Word 97 and may not look very pretty with
879
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
880
# The RTF output is optimized for Word 97 and may not look very pretty with
1108
881
# other RTF readers or editors.
1109
882
1110
883
GENERATE_RTF = NO
1111
884
1112
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1113
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
885
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
886
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1114
887
# put in front of it. If left blank `rtf' will be used as the default path.
1115
888
1116
889
RTF_OUTPUT = rtf
1117
890
1118
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1119
# RTF documents. This may be useful for small projects and may help to
891
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
892
# RTF documents. This may be useful for small projects and may help to
1120
893
# save some trees in general.
1121
894
1122
895
COMPACT_RTF = NO
1123
896
1124
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1125
# will contain hyperlink fields. The RTF file will
1126
# contain links (just like the HTML output) instead of page references.
1127
# This makes the output suitable for online browsing using WORD or other
1128
# programs which support those fields.
897
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
898
# will contain hyperlink fields. The RTF file will
899
# contain links (just like the HTML output) instead of page references.
900
# This makes the output suitable for online browsing using WORD or other
901
# programs which support those fields.
1129
902
# Note: wordpad (write) and others do not support links.
1130
903
1131
904
RTF_HYPERLINKS = NO
1132
905
1133
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1134
# config file, i.e. a series of assignments. You only have to provide
906
# Load stylesheet definitions from file. Syntax is similar to doxygen's
907
# config file, i.e. a series of assignments. You only have to provide
1135
908
# replacements, missing definitions are set to their default value.
1136
909
1137
RTF_STYLESHEET_FILE =
910
RTF_STYLESHEET_FILE =
1138
911
1139
# Set optional variables used in the generation of an rtf document.
912
# Set optional variables used in the generation of an rtf document.
1140
913
# Syntax is similar to doxygen's config file.
1141
914
1142
RTF_EXTENSIONS_FILE =
915
RTF_EXTENSIONS_FILE =
1143
916
1144
917
#---------------------------------------------------------------------------
1145
918
# configuration options related to the man page output
1146
919
#---------------------------------------------------------------------------
1147
920
1148
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
921
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1149
922
# generate man pages
1150
923
1151
924
GENERATE_MAN = NO
1152
925
1153
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1154
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
926
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
927
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1155
928
# put in front of it. If left blank `man' will be used as the default path.
1156
929
1157
930
MAN_OUTPUT = man
1158
931
1159
# The MAN_EXTENSION tag determines the extension that is added to
932
# The MAN_EXTENSION tag determines the extension that is added to
1160
933
# the generated man pages (default is the subroutine's section .3)
1161
934
1162
935
MAN_EXTENSION = .3
1163
936
1164
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1165
# then it will generate one additional man file for each entity
1166
# documented in the real man page(s). These additional files
1167
# only source the real man page, but without them the man command
937
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
938
# then it will generate one additional man file for each entity
939
# documented in the real man page(s). These additional files
940
# only source the real man page, but without them the man command
1168
941
# would be unable to find the correct page. The default is NO.
1169
942
1170
943
MAN_LINKS = NO
1173
946
# configuration options related to the XML output
1174
947
#---------------------------------------------------------------------------
1175
948
1176
# If the GENERATE_XML tag is set to YES Doxygen will
1177
# generate an XML file that captures the structure of
949
# If the GENERATE_XML tag is set to YES Doxygen will
950
# generate an XML file that captures the structure of
1178
951
# the code including all documentation.
1179
952
1180
953
GENERATE_XML = NO
1181
954
1182
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1183
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
955
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
956
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1184
957
# put in front of it. If left blank `xml' will be used as the default path.
1185
958
1186
959
XML_OUTPUT = xml
1187
960
1188
# The XML_SCHEMA tag can be used to specify an XML schema,
1189
# which can be used by a validating XML parser to check the
1190
# syntax of the XML files.
1191
1192
XML_SCHEMA =
1193
1194
# The XML_DTD tag can be used to specify an XML DTD,
1195
# which can be used by a validating XML parser to check the
1196
# syntax of the XML files.
1197
1198
XML_DTD =
1199
1200
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1201
# dump the program listings (including syntax highlighting
1202
# and cross-referencing information) to the XML output. Note that
961
# The XML_SCHEMA tag can be used to specify an XML schema,
962
# which can be used by a validating XML parser to check the
963
# syntax of the XML files.
964
965
XML_SCHEMA =
966
967
# The XML_DTD tag can be used to specify an XML DTD,
968
# which can be used by a validating XML parser to check the
969
# syntax of the XML files.
970
971
XML_DTD =
972
973
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
974
# dump the program listings (including syntax highlighting
975
# and cross-referencing information) to the XML output. Note that
1203
976
# enabling this will significantly increase the size of the XML output.
1204
977
1205
978
XML_PROGRAMLISTING = YES
1208
981
# configuration options for the AutoGen Definitions output
1209
982
#---------------------------------------------------------------------------
1210
983
1211
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1212
# generate an AutoGen Definitions (see autogen.sf.net) file
1213
# that captures the structure of the code including all
1214
# documentation. Note that this feature is still experimental
984
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
985
# generate an AutoGen Definitions (see autogen.sf.net) file
986
# that captures the structure of the code including all
987
# documentation. Note that this feature is still experimental
1215
988
# and incomplete at the moment.
1216
989
1217
990
GENERATE_AUTOGEN_DEF = NO
1220
993
# configuration options related to the Perl module output
1221
994
#---------------------------------------------------------------------------
1222
995
1223
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1224
# generate a Perl module file that captures the structure of
1225
# the code including all documentation. Note that this
1226
# feature is still experimental and incomplete at the
996
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
997
# generate a Perl module file that captures the structure of
998
# the code including all documentation. Note that this
999
# feature is still experimental and incomplete at the
1227
1000
# moment.
1228
1001
1229
1002
GENERATE_PERLMOD = NO
1230
1003
1231
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1232
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1004
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1005
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1233
1006
# to generate PDF and DVI output from the Perl module output.
1234
1007
1235
1008
PERLMOD_LATEX = NO
1236
1009
1237
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1238
# nicely formatted so it can be parsed by a human reader.
1239
# This is useful
1240
# if you want to understand what is going on.
1241
# On the other hand, if this
1242
# tag is set to NO the size of the Perl module output will be much smaller
1010
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1011
# nicely formatted so it can be parsed by a human reader. This is useful
1012
# if you want to understand what is going on. On the other hand, if this
1013
# tag is set to NO the size of the Perl module output will be much smaller
1243
1014
# and Perl will parse it just the same.
1244
1015
1245
1016
PERLMOD_PRETTY = YES
1246
1017
1247
# The names of the make variables in the generated doxyrules.make file
1248
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1249
# This is useful so different doxyrules.make files included by the same
1018
# The names of the make variables in the generated doxyrules.make file
1019
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1020
# This is useful so different doxyrules.make files included by the same
1250
1021
# Makefile don't overwrite each other's variables.
1251
1022
1252
PERLMOD_MAKEVAR_PREFIX =
1253
1254
#---------------------------------------------------------------------------
1255
# Configuration options related to the preprocessor
1256
#---------------------------------------------------------------------------
1257
1258
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1259
# evaluate all C-preprocessor directives found in the sources and include
1023
PERLMOD_MAKEVAR_PREFIX =
1024
1025
#---------------------------------------------------------------------------
1026
# Configuration options related to the preprocessor
1027
#---------------------------------------------------------------------------
1028
1029
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1030
# evaluate all C-preprocessor directives found in the sources and include
1260
1031
# files.
1261
1032
1262
1033
ENABLE_PREPROCESSING = YES
1263
1034
1264
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1265
# names in the source code. If set to NO (the default) only conditional
1266
# compilation will be performed. Macro expansion can be done in a controlled
1035
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1036
# names in the source code. If set to NO (the default) only conditional
1037
# compilation will be performed. Macro expansion can be done in a controlled
1267
1038
# way by setting EXPAND_ONLY_PREDEF to YES.
1268
1039
1269
1040
MACRO_EXPANSION = NO
1270
1041
1271
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1272
# then the macro expansion is limited to the macros specified with the
1042
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1043
# then the macro expansion is limited to the macros specified with the
1273
1044
# PREDEFINED and EXPAND_AS_DEFINED tags.
1274
1045
1275
1046
EXPAND_ONLY_PREDEF = NO
1276
1047
1277
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1048
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1278
1049
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1279
1050
1280
1051
SEARCH_INCLUDES = YES
1281
1052
1282
# The INCLUDE_PATH tag can be used to specify one or more directories that
1283
# contain include files that are not input files but should be processed by
1053
# The INCLUDE_PATH tag can be used to specify one or more directories that
1054
# contain include files that are not input files but should be processed by
1284
1055
# the preprocessor.
1285
1056
1286
INCLUDE_PATH =
1057
INCLUDE_PATH =
1287
1058
1288
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1289
# patterns (like *.h and *.hpp) to filter out the header-files in the
1290
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1059
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1060
# patterns (like *.h and *.hpp) to filter out the header-files in the
1061
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1291
1062
# be used.
1292
1063
1293
INCLUDE_FILE_PATTERNS =
1064
INCLUDE_FILE_PATTERNS =
1294
1065
1295
# The PREDEFINED tag can be used to specify one or more macro names that
1296
# are defined before the preprocessor is started (similar to the -D option of
1297
# gcc). The argument of the tag is a list of macros of the form: name
1298
# or name=definition (no spaces). If the definition and the = are
1299
# omitted =1 is assumed. To prevent a macro definition from being
1300
# undefined via #undef or recursively expanded use the := operator
1066
# The PREDEFINED tag can be used to specify one or more macro names that
1067
# are defined before the preprocessor is started (similar to the -D option of
1068
# gcc). The argument of the tag is a list of macros of the form: name
1069
# or name=definition (no spaces). If the definition and the = are
1070
# omitted =1 is assumed. To prevent a macro definition from being
1071
# undefined via #undef or recursively expanded use the := operator
1301
1072
# instead of the = operator.
1302
1073
1303
PREDEFINED =
1074
PREDEFINED =
1304
1075
1305
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1306
# this tag can be used to specify a list of macro names that should be expanded.
1307
# The macro definition that is found in the sources will be used.
1076
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1077
# this tag can be used to specify a list of macro names that should be expanded.
1078
# The macro definition that is found in the sources will be used.
1308
1079
# Use the PREDEFINED tag if you want to use a different macro definition.
1309
1080
1310
EXPAND_AS_DEFINED =
1081
EXPAND_AS_DEFINED =
1311
1082
1312
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1313
# doxygen's preprocessor will remove all function-like macros that are alone
1314
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1315
# function macros are typically used for boiler-plate code, and will confuse
1083
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1084
# doxygen's preprocessor will remove all function-like macros that are alone
1085
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1086
# function macros are typically used for boiler-plate code, and will confuse
1316
1087
# the parser if not removed.
1317
1088
1318
1089
SKIP_FUNCTION_MACROS = YES
1319
1090
1320
1091
#---------------------------------------------------------------------------
1321
# Configuration::additions related to external references
1092
# Configuration::additions related to external references
1322
1093
#---------------------------------------------------------------------------
1323
1094
1324
# The TAGFILES option can be used to specify one or more tagfiles.
1325
# Optionally an initial location of the external documentation
1326
# can be added for each tagfile. The format of a tag file without
1327
# this location is as follows:
1328
#
1329
# TAGFILES = file1 file2 ...
1330
# Adding location for the tag files is done as follows:
1331
#
1332
# TAGFILES = file1=loc1 "file2 = loc2" ...
1333
# where "loc1" and "loc2" can be relative or absolute paths or
1334
# URLs. If a location is present for each tag, the installdox tool
1095
# The TAGFILES option can be used to specify one or more tagfiles.
1096
# Optionally an initial location of the external documentation
1097
# can be added for each tagfile. The format of a tag file without
1098
# this location is as follows:
1099
# TAGFILES = file1 file2 ...
1100
# Adding location for the tag files is done as follows:
1101
# TAGFILES = file1=loc1 "file2 = loc2" ...
1102
# where "loc1" and "loc2" can be relative or absolute paths or
1103
# URLs. If a location is present for each tag, the installdox tool
1335
1104
# does not have to be run to correct the links.
1336
1105
# Note that each tag file must have a unique name
1337
1106
# (where the name does NOT include the path)
1338
# If a tag file is not located in the directory in which doxygen
1107
# If a tag file is not located in the directory in which doxygen
1339
1108
# is run, you must also specify the path to the tagfile here.
1340
1109
1341
TAGFILES =
1110
TAGFILES =
1342
1111
1343
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1112
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1344
1113
# a tag file that is based on the input files it reads.
1345
1114
1346
GENERATE_TAGFILE =
1115
GENERATE_TAGFILE =
1347
1116
1348
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1349
# in the class index. If set to NO only the inherited external classes
1117
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1118
# in the class index. If set to NO only the inherited external classes
1350
1119
# will be listed.
1351
1120
1352
1121
ALLEXTERNALS = NO
1353
1122
1354
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1355
# in the modules index. If set to NO, only the current project's groups will
1123
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1124
# in the modules index. If set to NO, only the current project's groups will
1356
1125
# be listed.
1357
1126
1358
1127
EXTERNAL_GROUPS = YES
1359
1128
1360
# The PERL_PATH should be the absolute path and name of the perl script
1129
# The PERL_PATH should be the absolute path and name of the perl script
1361
1130
# interpreter (i.e. the result of `which perl').
1362
1131
1363
1132
PERL_PATH = /usr/bin/perl
1364
1133
1365
1134
#---------------------------------------------------------------------------
1366
# Configuration options related to the dot tool
1135
# Configuration options related to the dot tool
1367
1136
#---------------------------------------------------------------------------
1368
1137
1369
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1370
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1371
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1372
# this option is superseded by the HAVE_DOT option below. This is only a
1373
# fallback. It is recommended to install and use dot, since it yields more
1138
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1139
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1140
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1141
# this option is superseded by the HAVE_DOT option below. This is only a
1142
# fallback. It is recommended to install and use dot, since it yields more
1374
1143
# powerful graphs.
1375
1144
1376
1145
CLASS_DIAGRAMS = YES
1377
1146
1378
# You can define message sequence charts within doxygen comments using the \msc
1379
# command. Doxygen will then run the mscgen tool (see
1380
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1381
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1382
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1383
# default search path.
1384
1385
MSCGEN_PATH =
1386
1387
# If set to YES, the inheritance and collaboration graphs will hide
1388
# inheritance and usage relations if the target is undocumented
1147
# You can define message sequence charts within doxygen comments using the \msc
1148
# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
1149
# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
1150
# specify the directory where the mscgen tool resides. If left empty the tool is assumed to
1151
# be found in the default search path.
1152
1153
MSCGEN_PATH =
1154
1155
# If set to YES, the inheritance and collaboration graphs will hide
1156
# inheritance and usage relations if the target is undocumented
1389
1157
# or is not a class.
1390
1158
1391
1159
HIDE_UNDOC_RELATIONS = YES
1392
1160
1393
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1394
# available from the path. This tool is part of Graphviz, a graph visualization
1395
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1161
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1162
# available from the path. This tool is part of Graphviz, a graph visualization
1163
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1396
1164
# have no effect if this option is set to NO (the default)
1397
1165
1398
1166
HAVE_DOT = NO
1399
1167
1400
# By default doxygen will write a font called FreeSans.ttf to the output
1401
# directory and reference it in all dot files that doxygen generates. This
1402
# font does not include all possible unicode characters however, so when you need
1403
# these (or just want a differently looking font) you can specify the font name
1404
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1405
# which can be done by putting it in a standard location or by setting the
1406
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1407
# containing the font.
1408
1409
DOT_FONTNAME = FreeSans
1410
1411
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1412
# The default size is 10pt.
1413
1414
DOT_FONTSIZE = 10
1415
1416
# By default doxygen will tell dot to use the output directory to look for the
1417
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1418
# different font using DOT_FONTNAME you can set the path where dot
1419
# can find it using this tag.
1420
1421
DOT_FONTPATH =
1422
1423
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1424
# will generate a graph for each documented class showing the direct and
1425
# indirect inheritance relations. Setting this tag to YES will force the
1168
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1169
# will generate a graph for each documented class showing the direct and
1170
# indirect inheritance relations. Setting this tag to YES will force the
1426
1171
# the CLASS_DIAGRAMS tag to NO.
1427
1172
1428
1173
CLASS_GRAPH = YES
1429
1174
1430
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1431
# will generate a graph for each documented class showing the direct and
1432
# indirect implementation dependencies (inheritance, containment, and
1175
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1176
# will generate a graph for each documented class showing the direct and
1177
# indirect implementation dependencies (inheritance, containment, and
1433
1178
# class references variables) of the class with other documented classes.
1434
1179
1435
1180
COLLABORATION_GRAPH = YES
1436
1181
1437
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1182
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1438
1183
# will generate a graph for groups, showing the direct groups dependencies
1439
1184
1440
1185
GROUP_GRAPHS = YES
1441
1186
1442
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1443
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1187
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1188
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1444
1189
# Language.
1445
1190
1446
1191
UML_LOOK = NO
1447
1192
1448
# If set to YES, the inheritance and collaboration graphs will show the
1193
# If set to YES, the inheritance and collaboration graphs will show the
1449
1194
# relations between templates and their instances.
1450
1195
1451
1196
TEMPLATE_RELATIONS = NO
1452
1197
1453
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1454
# tags are set to YES then doxygen will generate a graph for each documented
1455
# file showing the direct and indirect include dependencies of the file with
1198
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1199
# tags are set to YES then doxygen will generate a graph for each documented
1200
# file showing the direct and indirect include dependencies of the file with
1456
1201
# other documented files.
1457
1202
1458
1203
INCLUDE_GRAPH = YES
1459
1204
1460
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1461
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1462
# documented header file showing the documented files that directly or
1205
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1206
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1207
# documented header file showing the documented files that directly or
1463
1208
# indirectly include this file.
1464
1209
1465
1210
INCLUDED_BY_GRAPH = YES
1466
1211
1467
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1468
# doxygen will generate a call dependency graph for every global function
1469
# or class method. Note that enabling this option will significantly increase
1470
# the time of a run. So in most cases it will be better to enable call graphs
1471
# for selected functions only using the \callgraph command.
1212
# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1213
# generate a call dependency graph for every global function or class method.
1214
# Note that enabling this option will significantly increase the time of a run.
1215
# So in most cases it will be better to enable call graphs for selected
1216
# functions only using the \callgraph command.
1472
1217
1473
1218
CALL_GRAPH = NO
1474
1219
1475
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1476
# doxygen will generate a caller dependency graph for every global function
1477
# or class method. Note that enabling this option will significantly increase
1478
# the time of a run. So in most cases it will be better to enable caller
1479
# graphs for selected functions only using the \callergraph command.
1220
# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
1221
# generate a caller dependency graph for every global function or class method.
1222
# Note that enabling this option will significantly increase the time of a run.
1223
# So in most cases it will be better to enable caller graphs for selected
1224
# functions only using the \callergraph command.
1480
1225
1481
1226
CALLER_GRAPH = NO
1482
1227
1483
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1228
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1484
1229
# will graphical hierarchy of all classes instead of a textual one.
1485
1230
1486
1231
GRAPHICAL_HIERARCHY = YES
1487
1232
1488
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1489
# then doxygen will show the dependencies a directory has on other directories
1233
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1234
# then doxygen will show the dependencies a directory has on other directories
1490
1235
# in a graphical way. The dependency relations are determined by the #include
1491
1236
# relations between the files in the directories.
1492
1237
1493
1238
DIRECTORY_GRAPH = YES
1494
1239
1495
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1240
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1496
1241
# generated by dot. Possible values are png, jpg, or gif
1497
1242
# If left blank png will be used.
1498
1243
1499
1244
DOT_IMAGE_FORMAT = png
1500
1245
1501
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1246
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1502
1247
# found. If left blank, it is assumed the dot tool can be found in the path.
1503
1248
1504
DOT_PATH =
1249
DOT_PATH =
1505
1250
1506
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1507
# contain dot files that are included in the documentation (see the
1251
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1252
# contain dot files that are included in the documentation (see the
1508
1253
# \dotfile command).
1509
1254
1510
DOTFILE_DIRS =
1255
DOTFILE_DIRS =
1511
1256
1512
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1513
# nodes that will be shown in the graph. If the number of nodes in a graph
1514
# becomes larger than this value, doxygen will truncate the graph, which is
1515
# visualized by representing a node as a red box. Note that doxygen if the
1516
# number of direct children of the root node in a graph is already larger than
1517
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1257
# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1258
# nodes that will be shown in the graph. If the number of nodes in a graph
1259
# becomes larger than this value, doxygen will truncate the graph, which is
1260
# visualized by representing a node as a red box. Note that doxygen if the number
1261
# of direct children of the root node in a graph is already larger than
1262
# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
1518
1263
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1519
1264
1520
1265
DOT_GRAPH_MAX_NODES = 50
1521
1266
1522
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1523
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1524
# from the root by following a path via at most 3 edges will be shown. Nodes
1525
# that lay further from the root node will be omitted. Note that setting this
1526
# option to 1 or 2 may greatly reduce the computation time needed for large
1527
# code bases. Also note that the size of a graph can be further restricted by
1267
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1268
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1269
# from the root by following a path via at most 3 edges will be shown. Nodes
1270
# that lay further from the root node will be omitted. Note that setting this
1271
# option to 1 or 2 may greatly reduce the computation time needed for large
1272
# code bases. Also note that the size of a graph can be further restricted by
1528
1273
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1529
1274
1530
1275
MAX_DOT_GRAPH_DEPTH = 0
1531
1276
1532
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1533
# background. This is disabled by default, because dot on Windows does not
1534
# seem to support this out of the box. Warning: Depending on the platform used,
1535
# enabling this option may lead to badly anti-aliased labels on the edges of
1536
# a graph (i.e. they become hard to read).
1277
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1278
# background. This is disabled by default, which results in a white background.
1279
# Warning: Depending on the platform used, enabling this option may lead to
1280
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
1281
# read).
1537
1282
1538
1283
DOT_TRANSPARENT = NO
1539
1284
1540
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1541
# files in one run (i.e. multiple -o and -T options on the command line). This
1542
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1285
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1286
# files in one run (i.e. multiple -o and -T options on the command line). This
1287
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1543
1288
# support this, this feature is disabled by default.
1544
1289
1545
1290
DOT_MULTI_TARGETS = NO
1546
1291
1547
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1548
# generate a legend page explaining the meaning of the various boxes and
1292
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1293
# generate a legend page explaining the meaning of the various boxes and
1549
1294
# arrows in the dot generated graphs.
1550
1295
1551
1296
GENERATE_LEGEND = YES
1552
1297
1553
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1554
# remove the intermediate dot files that are used to generate
1298
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1299
# remove the intermediate dot files that are used to generate
1555
1300
# the various graphs.
1556
1301
1557
1302
DOT_CLEANUP = YES
1303
1304
#---------------------------------------------------------------------------
1305
# Configuration::additions related to the search engine
1306
#---------------------------------------------------------------------------
1307
1308
# The SEARCHENGINE tag specifies whether or not a search engine should be
1309
# used. If set to NO the values of all tags below this one will be ignored.
1310
1311
SEARCHENGINE = NO
Loggerhead is a web-based interface for Breezy
Version: 2.0.1