Revision 157b7d0c

View differences:

Doxyfile
1
# Doxyfile 1.5.6
1
# Doxyfile 1.3-rc1
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
......
11 11
# Values that contain spaces should be placed between quotes (" ")
12 12

  
13 13
#---------------------------------------------------------------------------
14
# Project related configuration options
14
# General 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.
22

  
23
DOXYFILE_ENCODING      = UTF-8
24

  
25 17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 18
# by quotes) that should identify the project.
27 19

  
......
40 32

  
41 33
OUTPUT_DIRECTORY       = doxy
42 34

  
43
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
44
# 4096 sub-directories (in 2 levels) under the output directory of each output
45
# format and will distribute the generated files over these directories.
46
# Enabling this option can be useful when feeding doxygen a huge amount of
47
# source files, where putting all generated files in the same directory would
48
# otherwise cause performance problems for the file system.
49

  
50
CREATE_SUBDIRS         = NO
51

  
52 35
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53 36
# documentation generated by doxygen is written. Doxygen will use this
54 37
# information to generate all constant output in the proper language.
55 38
# The default language is English, other supported languages are:
56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
58
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
59
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
60
# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
61
# and Ukrainian.
39
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
40
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
41
# (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
42
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
62 43

  
63 44
OUTPUT_LANGUAGE        = English
64 45

  
65
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66
# include brief member descriptions after the members that are listed in
67
# the file and class documentation (similar to JavaDoc).
68
# Set to NO to disable this.
69

  
70
BRIEF_MEMBER_DESC      = YES
71

  
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
75
# brief descriptions will be completely suppressed.
76

  
77
REPEAT_BRIEF           = YES
78

  
79
# This tag implements a quasi-intelligent brief description abbreviator
80
# that is used to form the text in various listings. Each string
81
# in this list, if found as the leading text of the brief description, will be
82
# stripped from the text and the result after processing the whole list, is
83
# used as the annotated text. Otherwise, the brief description is used as-is.
84
# If left blank, the following values are used ("$name" is automatically
85
# replaced with the name of the entity): "The $name class" "The $name widget"
86
# "The $name file" "is" "provides" "specifies" "contains"
87
# "represents" "a" "an" "the"
88

  
89
ABBREVIATE_BRIEF       =
90

  
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
93
# description.
94

  
95
ALWAYS_DETAILED_SEC    = NO
96

  
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
100
# operators of the base classes will not be shown.
101

  
102
INLINE_INHERITED_MEMB  = NO
103

  
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
106
# to NO the shortest path that makes the file name unique will be used.
107

  
108
FULL_PATH_NAMES        = YES
109

  
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
115
# path to strip.
116

  
117
STRIP_FROM_PATH        = .
118

  
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
124
# are normally passed to the compiler using the -I flag.
125

  
126
STRIP_FROM_INC_PATH    =
127

  
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
130
# doesn't support long names like on DOS, Mac, or CD-ROM.
131

  
132
SHORT_NAMES            = NO
133

  
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
138
# (thus requiring an explicit @brief command for a brief description.)
139

  
140
JAVADOC_AUTOBRIEF      = YES
141

  
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
146
# an explicit \brief command for a brief description.)
147

  
148
QT_AUTOBRIEF           = NO
149

  
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
154
# description. Set this tag to YES if you prefer the old behaviour instead.
155

  
156
MULTILINE_CPP_IS_BRIEF = NO
157

  
158
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
159
# will output the detailed description near the top, like JavaDoc.
160
# If set to NO, the detailed description appears after the member
161
# documentation.
162

  
163
DETAILS_AT_TOP         = NO
164

  
165
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
166
# member inherits the documentation from any documented member that it
167
# re-implements.
168

  
169
INHERIT_DOCS           = YES
170

  
171
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
172
# a new page for each member. If set to NO, the documentation of a member will
173
# be part of the file/class/namespace that contains it.
174

  
175
SEPARATE_MEMBER_PAGES  = NO
176

  
177
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
178
# Doxygen uses this value to replace tabs by spaces in code fragments.
179

  
180
TAB_SIZE               = 8
181

  
182
# This tag can be used to specify a number of aliases that acts
183
# as commands in the documentation. An alias has the form "name=value".
184
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
185
# put the command \sideeffect (or @sideeffect) in the documentation, which
186
# will result in a user-defined paragraph with heading "Side Effects:".
187
# You can put \n's in the value part of an alias to insert newlines.
188

  
189
ALIASES                =
190

  
191
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
192
# sources only. Doxygen will then generate output that is more tailored for C.
193
# For instance, some of the names that are used will be different. The list
194
# of all members will be omitted, etc.
195

  
196
OPTIMIZE_OUTPUT_FOR_C  = YES
197

  
198
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
199
# sources only. Doxygen will then generate output that is more tailored for
200
# Java. For instance, namespaces will be presented as packages, qualified
201
# scopes will look different, etc.
202

  
203
OPTIMIZE_OUTPUT_JAVA   = NO
204

  
205
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
206
# sources only. Doxygen will then generate output that is more tailored for
207
# Fortran.
208

  
209
OPTIMIZE_FOR_FORTRAN   = NO
210

  
211
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
212
# sources. Doxygen will then generate output that is tailored for
213
# VHDL.
214

  
215
OPTIMIZE_OUTPUT_VHDL   = NO
216

  
217
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
218
# to include (a tag file for) the STL sources as input, then you should
219
# set this tag to YES in order to let doxygen match functions declarations and
220
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
221
# func(std::string) {}). This also make the inheritance and collaboration
222
# diagrams that involve STL classes more complete and accurate.
223

  
224
BUILTIN_STL_SUPPORT    = NO
225

  
226
# If you use Microsoft's C++/CLI language, you should set this option to YES to
227
# enable parsing support.
228

  
229
CPP_CLI_SUPPORT        = NO
230

  
231
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
232
# Doxygen will parse them like normal C++ but will assume all classes use public
233
# instead of private inheritance when no explicit protection keyword is present.
234

  
235
SIP_SUPPORT            = NO
236

  
237
# For Microsoft's IDL there are propget and propput attributes to indicate getter
238
# and setter methods for a property. Setting this option to YES (the default)
239
# will make doxygen to replace the get and set methods by a property in the
240
# documentation. This will only work if the methods are indeed getting or
241
# setting a simple type. If this is not the case, or you want to show the
242
# methods anyway, you should set this option to NO.
243

  
244
IDL_PROPERTY_SUPPORT   = YES
245

  
246
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
247
# tag is set to YES, then doxygen will reuse the documentation of the first
248
# member in the group (if any) for the other members of the group. By default
249
# all members of a group must be documented explicitly.
250

  
251
DISTRIBUTE_GROUP_DOC   = NO
252

  
253
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
254
# the same type (for instance a group of public functions) to be put as a
255
# subgroup of that type (e.g. under the Public Functions section). Set it to
256
# NO to prevent subgrouping. Alternatively, this can be done per class using
257
# the \nosubgrouping command.
258

  
259
SUBGROUPING            = YES
260

  
261
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
262
# is documented as struct, union, or enum with the name of the typedef. So
263
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
264
# with name TypeT. When disabled the typedef will appear as a member of a file,
265
# namespace, or class. And the struct will be named TypeS. This can typically
266
# be useful for C code in case the coding convention dictates that all compound
267
# types are typedef'ed and only the typedef is referenced, never the tag name.
268

  
269
TYPEDEF_HIDES_STRUCT   = NO
270

  
271
#---------------------------------------------------------------------------
272
# Build related configuration options
273
#---------------------------------------------------------------------------
274

  
275 46
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
276 47
# documentation are documented, even if no documentation was available.
277 48
# Private class members and static file members will be hidden unless
......
295 66

  
296 67
EXTRACT_LOCAL_CLASSES  = YES
297 68

  
298
# This flag is only useful for Objective-C code. When set to YES local
299
# methods, which are defined in the implementation section but not in
300
# the interface are included in the documentation.
301
# If set to NO (the default) only methods in the interface are included.
302

  
303
EXTRACT_LOCAL_METHODS  = NO
304

  
305
# If this flag is set to YES, the members of anonymous namespaces will be
306
# extracted and appear in the documentation as a namespace called
307
# 'anonymous_namespace{file}', where file will be replaced with the base
308
# name of the file that contains the anonymous namespace. By default
309
# anonymous namespace are hidden.
310

  
311
EXTRACT_ANON_NSPACES   = NO
312

  
313 69
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
314 70
# undocumented members of documented classes, files or namespaces.
315 71
# If set to NO (the default) these members will be included in the
......
320 76

  
321 77
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
322 78
# undocumented classes that are normally visible in the class hierarchy.
323
# If set to NO (the default) these classes will be included in the various
79
# If set to NO (the default) these class will be included in the various
324 80
# overviews. This option has no effect if EXTRACT_ALL is enabled.
325 81

  
326 82
HIDE_UNDOC_CLASSES     = NO
......
339 95

  
340 96
HIDE_IN_BODY_DOCS      = NO
341 97

  
98
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
99
# include brief member descriptions after the members that are listed in
100
# the file and class documentation (similar to JavaDoc).
101
# Set to NO to disable this.
102

  
103
BRIEF_MEMBER_DESC      = YES
104

  
105
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
106
# the brief description of a member or function before the detailed description.
107
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
108
# brief descriptions will be completely suppressed.
109

  
110
REPEAT_BRIEF           = YES
111

  
112
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
113
# Doxygen will generate a detailed section even if there is only a brief
114
# description.
115

  
116
ALWAYS_DETAILED_SEC    = NO
117

  
118
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
119
# members of a class in the documentation of that class as if those members were
120
# ordinary class members. Constructors, destructors and assignment operators of
121
# the base classes will not be shown.
122

  
123
INLINE_INHERITED_MEMB  = NO
124

  
125
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
126
# path before files name in the file list and in the header files. If set
127
# to NO the shortest path that makes the file name unique will be used.
128

  
129
FULL_PATH_NAMES        = YES
130

  
131
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
132
# can be used to strip a user defined part of the path. Stripping is
133
# only done if one of the specified strings matches the left-hand part of
134
# the path. It is allowed to use relative paths in the argument list.
135

  
136
STRIP_FROM_PATH        = .
137

  
342 138
# The INTERNAL_DOCS tag determines if documentation
343 139
# that is typed after a \internal command is included. If the tag is set
344 140
# to NO (the default) then the documentation will be excluded.
......
347 143
INTERNAL_DOCS          = NO
348 144

  
349 145
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
350
# file names in lower-case letters. If set to YES upper-case letters are also
146
# file names in lower case letters. If set to YES upper case letters are also
351 147
# allowed. This is useful if you have classes or files whose names only differ
352 148
# in case and if your file system supports case sensitive file names. Windows
353
# and Mac users are advised to set this option to NO.
149
# users are adviced to set this option to NO.
354 150

  
355 151
CASE_SENSE_NAMES       = YES
356 152

  
153
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
154
# (but less readable) file names. This can be useful is your file systems
155
# doesn't support long names like on DOS, Mac, or CD-ROM.
156

  
157
SHORT_NAMES            = NO
158

  
357 159
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
358 160
# will show members with their full class and namespace scopes in the
359 161
# documentation. If set to YES the scope will be hidden.
360 162

  
361 163
HIDE_SCOPE_NAMES       = NO
362 164

  
165
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
166
# will generate a verbatim copy of the header file for each class for
167
# which an include is specified. Set to NO to disable this.
168

  
169
VERBATIM_HEADERS       = YES
170

  
363 171
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
364
# will put a list of the files that are included by a file in the documentation
172
# will put list of the files that are included by a file in the documentation
365 173
# of that file.
366 174

  
367 175
SHOW_INCLUDE_FILES     = YES
368 176

  
177
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
178
# will interpret the first line (until the first dot) of a JavaDoc-style
179
# comment as the brief description. If set to NO, the JavaDoc
180
# comments  will behave just like the Qt-style comments (thus requiring an
181
# explict @brief command for a brief description.
182

  
183
JAVADOC_AUTOBRIEF      = YES
184

  
185
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
186
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
187
# comments) as a brief description. This used to be the default behaviour.
188
# The new default is to treat a multi-line C++ comment block as a detailed
189
# description. Set this tag to YES if you prefer the old behaviour instead.
190

  
191
MULTILINE_CPP_IS_BRIEF = NO
192

  
193
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
194
# will output the detailed description near the top, like JavaDoc.
195
# If set to NO, the detailed description appears after the member
196
# documentation.
197

  
198
DETAILS_AT_TOP         = NO
199

  
200
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
201
# member inherits the documentation from any documented member that it
202
# reimplements.
203

  
204
INHERIT_DOCS           = YES
205

  
369 206
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
370 207
# is inserted in the documentation for inline members.
371 208

  
......
378 215

  
379 216
SORT_MEMBER_DOCS       = YES
380 217

  
381
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
382
# brief documentation of file, namespace and class members alphabetically
383
# by member name. If set to NO (the default) the members will appear in
384
# declaration order.
385

  
386
SORT_BRIEF_DOCS        = NO
387

  
388
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
389
# hierarchy of group names into alphabetical order. If set to NO (the default)
390
# the group names will appear in their defined order.
218
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
219
# tag is set to YES, then doxygen will reuse the documentation of the first
220
# member in the group (if any) for the other members of the group. By default
221
# all members of a group must be documented explicitly.
391 222

  
392
SORT_GROUP_NAMES       = NO
223
DISTRIBUTE_GROUP_DOC   = NO
393 224

  
394
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
395
# sorted by fully-qualified names, including namespaces. If set to
396
# NO (the default), the class list will be sorted only by class name,
397
# not including the namespace part.
398
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
399
# Note: This option applies only to the class list, not to the
400
# alphabetical list.
225
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
226
# Doxygen uses this value to replace tabs by spaces in code fragments.
401 227

  
402
SORT_BY_SCOPE_NAME     = NO
228
TAB_SIZE               = 8
403 229

  
404 230
# The GENERATE_TODOLIST tag can be used to enable (YES) or
405 231
# disable (NO) the todo list. This list is created by putting \todo
......
425 251

  
426 252
GENERATE_DEPRECATEDLIST= YES
427 253

  
254
# This tag can be used to specify a number of aliases that acts
255
# as commands in the documentation. An alias has the form "name=value".
256
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
257
# put the command \sideeffect (or @sideeffect) in the documentation, which
258
# will result in a user defined paragraph with heading "Side Effects:".
259
# You can put \n's in the value part of an alias to insert newlines.
260

  
261
ALIASES                =
262

  
428 263
# The ENABLED_SECTIONS tag can be used to enable conditional
429 264
# documentation sections, marked by \if sectionname ... \endif.
430 265

  
431 266
ENABLED_SECTIONS       =
432 267

  
433 268
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
434
# the initial value of a variable or define consists of for it to appear in
269
# the initial value of a variable or define consist of for it to appear in
435 270
# the documentation. If the initializer consists of more lines than specified
436 271
# here it will be hidden. Use a value of 0 to hide initializers completely.
437 272
# The appearance of the initializer of individual variables and defines in the
......
440 275

  
441 276
MAX_INITIALIZER_LINES  = 30
442 277

  
443
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
444
# at the bottom of the documentation of classes and structs. If set to YES the
445
# list will mention the files that were used to generate the documentation.
446

  
447
SHOW_USED_FILES        = YES
448

  
449
# If the sources in your project are distributed over multiple directories
450
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
451
# in the documentation. The default is NO.
452

  
453
SHOW_DIRECTORIES       = NO
454

  
455
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
456
# This will remove the Files entry from the Quick Index and from the
457
# Folder Tree View (if specified). The default is YES.
278
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
279
# only. Doxygen will then generate output that is more tailored for C.
280
# For instance some of the names that are used will be different. The list
281
# of all members will be omitted, etc.
458 282

  
459
SHOW_FILES             = YES
283
OPTIMIZE_OUTPUT_FOR_C  = YES
460 284

  
461
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
462
# Namespaces page.  This will remove the Namespaces entry from the Quick Index
463
# and from the Folder Tree View (if specified). The default is YES.
285
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
286
# only. Doxygen will then generate output that is more tailored for Java.
287
# For instance namespaces will be presented as packages, qualified scopes
288
# will look different, etc.
464 289

  
465
SHOW_NAMESPACES        = YES
290
OPTIMIZE_OUTPUT_JAVA   = NO
466 291

  
467
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
468
# doxygen should invoke to get the current version for each file (typically from
469
# the version control system). Doxygen will invoke the program by executing (via
470
# popen()) the command <command> <input-file>, where <command> is the value of
471
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
472
# provided by doxygen. Whatever the program writes to standard output
473
# is used as the file version. See the manual for examples.
292
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
293
# at the bottom of the documentation of classes and structs. If set to YES the
294
# list will mention the files that were used to generate the documentation.
474 295

  
475
FILE_VERSION_FILTER    =
296
SHOW_USED_FILES        = YES
476 297

  
477 298
#---------------------------------------------------------------------------
478 299
# configuration options related to warning and progress messages
......
495 316

  
496 317
WARN_IF_UNDOCUMENTED   = YES
497 318

  
498
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
499
# potential errors in the documentation, such as not documenting some
500
# parameters in a documented function, or documenting parameters that
501
# don't exist or using markup commands wrongly.
502

  
503
WARN_IF_DOC_ERROR      = YES
504

  
505
# This WARN_NO_PARAMDOC option can be abled to get warnings for
506
# functions that are documented, but have no documentation for their parameters
507
# or return value. If set to NO (the default) doxygen will only warn about
508
# wrong or incomplete parameter documentation, but not about the absence of
509
# documentation.
510

  
511
WARN_NO_PARAMDOC       = NO
512

  
513 319
# The WARN_FORMAT tag determines the format of the warning messages that
514 320
# doxygen can produce. The string should contain the $file, $line, and $text
515 321
# tags, which will be replaced by the file and line number from which the
516
# warning originated and the warning text. Optionally the format may contain
517
# $version, which will be replaced by the version of the file (if it could
518
# be obtained via FILE_VERSION_FILTER)
322
# warning originated and the warning text.
519 323

  
520 324
WARN_FORMAT            = "$file:$line: $text"
521 325

  
......
536 340

  
537 341
INPUT                  =
538 342

  
539
# This tag can be used to specify the character encoding of the source files
540
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
541
# also the default input encoding. Doxygen uses libiconv (or the iconv built
542
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
543
# the list of possible encodings.
544

  
545
INPUT_ENCODING         = UTF-8
546

  
547 343
# If the value of the INPUT tag contains directories, you can use the
548 344
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
549 345
# and *.h) to filter out the source-files in the directories. If left
550 346
# blank the following patterns are tested:
551
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
552
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
347
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
348
# *.h++ *.idl *.odl
553 349

  
554 350
FILE_PATTERNS          =
555 351

  
......
565 361

  
566 362
EXCLUDE                =
567 363

  
568
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
569
# directories that are symbolic links (a Unix filesystem feature) are excluded
570
# from the input.
364
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
365
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
571 366

  
572 367
EXCLUDE_SYMLINKS       = NO
573 368

  
574 369
# If the value of the INPUT tag contains directories, you can use the
575 370
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
576
# certain files from those directories. Note that the wildcards are matched
577
# against the file with absolute path, so to exclude all test directories
578
# for example use the pattern */test/*
579

  
580
EXCLUDE_PATTERNS       = *.svn \
581
                         *.git
371
# certain files from those directories.
582 372

  
583
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
584
# (namespaces, classes, functions, etc.) that should be excluded from the
585
# output. The symbol name can be a fully qualified name, a word, or if the
586
# wildcard * is used, a substring. Examples: ANamespace, AClass,
587
# AClass::ANamespace, ANamespace::*Test
588

  
589
EXCLUDE_SYMBOLS        =
373
EXCLUDE_PATTERNS       = *.svn *.git
590 374

  
591 375
# The EXAMPLE_PATH tag can be used to specify one or more files or
592 376
# directories that contain example code fragments that are included (see
......
619 403
# by executing (via popen()) the command <filter> <input-file>, where <filter>
620 404
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
621 405
# input file. Doxygen will then use the output that the filter program writes
622
# to standard output.  If FILTER_PATTERNS is specified, this tag will be
623
# ignored.
406
# to standard output.
624 407

  
625 408
INPUT_FILTER           =
626 409

  
627
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
628
# basis.  Doxygen will compare the file name with each pattern and apply the
629
# filter if there is a match.  The filters are a list of the form:
630
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
631
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
632
# is applied to all files.
633

  
634
FILTER_PATTERNS        =
635

  
636 410
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
637 411
# INPUT_FILTER) will be used to filter the input files when producing source
638 412
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
......
645 419

  
646 420
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
647 421
# be generated. Documented entities will be cross-referenced with these sources.
648
# Note: To get rid of all source code in the generated output, make sure also
649
# VERBATIM_HEADERS is set to NO.
650 422

  
651 423
SOURCE_BROWSER         = YES
652 424

  
......
661 433

  
662 434
STRIP_CODE_COMMENTS    = YES
663 435

  
664
# If the REFERENCED_BY_RELATION tag is set to YES
436
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
665 437
# then for each documented function all documented
666 438
# functions referencing it will be listed.
667 439

  
668 440
REFERENCED_BY_RELATION = YES
669 441

  
670
# If the REFERENCES_RELATION tag is set to YES
442
# If the REFERENCES_RELATION tag is set to YES (the default)
671 443
# then for each documented function all documented entities
672 444
# called/used by that function will be listed.
673 445

  
674 446
REFERENCES_RELATION    = NO
675 447

  
676
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
677
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
678
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
679
# link to the source code.  Otherwise they will link to the documentstion.
680

  
681
REFERENCES_LINK_SOURCE = YES
682

  
683
# If the USE_HTAGS tag is set to YES then the references to source code
684
# will point to the HTML generated by the htags(1) tool instead of doxygen
685
# built-in source browser. The htags tool is part of GNU's global source
686
# tagging system (see http://www.gnu.org/software/global/global.html). You
687
# will need version 4.8.6 or higher.
688

  
689
USE_HTAGS              = NO
690

  
691
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
692
# will generate a verbatim copy of the header file for each class for
693
# which an include is specified. Set to NO to disable this.
694

  
695
VERBATIM_HEADERS       = YES
696

  
697 448
#---------------------------------------------------------------------------
698 449
# configuration options related to the alphabetical class index
699 450
#---------------------------------------------------------------------------
......
750 501

  
751 502
HTML_FOOTER            =
752 503

  
753
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
504
# The HTML_STYLESHEET tag can be used to specify a user defined cascading
754 505
# style sheet that is used by each HTML page. It can be used to
755 506
# fine-tune the look of the HTML output. If the tag is left blank doxygen
756
# will generate a default style sheet. Note that doxygen will try to copy
757
# the style sheet file to the HTML output directory, so don't put your own
758
# stylesheet in the HTML output directory as well, or it will be erased!
507
# will generate a default style sheet
759 508

  
760 509
HTML_STYLESHEET        =
761 510

  
......
767 516

  
768 517
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
769 518
# will be generated that can be used as input for tools like the
770
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
519
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
771 520
# of the generated HTML documentation.
772 521

  
773 522
GENERATE_HTMLHELP      = NO
774 523

  
775
# If the GENERATE_DOCSET tag is set to YES, additional index files
776
# will be generated that can be used as input for Apple's Xcode 3
777
# integrated development environment, introduced with OSX 10.5 (Leopard).
778
# To create a documentation set, doxygen will generate a Makefile in the
779
# HTML output directory. Running make will produce the docset in that
780
# directory and running "make install" will install the docset in
781
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
782
# it at startup.
783

  
784
GENERATE_DOCSET        = NO
785

  
786
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
787
# feed. A documentation feed provides an umbrella under which multiple
788
# documentation sets from a single provider (such as a company or product suite)
789
# can be grouped.
790

  
791
DOCSET_FEEDNAME        = "Doxygen generated docs"
792

  
793
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
794
# should uniquely identify the documentation set bundle. This should be a
795
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
796
# will append .docset to the name.
797

  
798
DOCSET_BUNDLE_ID       = org.doxygen.Project
799

  
800
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
801
# documentation will contain sections that can be hidden and shown after the
802
# page has loaded. For this to work a browser that supports
803
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
804
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
805

  
806
HTML_DYNAMIC_SECTIONS  = NO
807

  
808 524
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
809 525
# be used to specify the file name of the resulting .chm file. You
810 526
# can add a path in front of the file if the result should not be
811
# written to the html output directory.
527
# written to the html output dir.
812 528

  
813 529
CHM_FILE               =
814 530

  
815 531
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
816 532
# be used to specify the location (absolute path including file name) of
817
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
818
# the HTML help compiler on the generated index.hhp.
533
# the HTML help compiler (hhc.exe). If non empty doxygen will try to run
534
# the html help compiler on the generated index.hhp.
819 535

  
820 536
HHC_LOCATION           =
821 537

  
......
825 541

  
826 542
GENERATE_CHI           = NO
827 543

  
828
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
829
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
830
# content.
831

  
832
CHM_INDEX_ENCODING     =
833

  
834 544
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
835 545
# controls whether a binary table of contents is generated (YES) or a
836 546
# normal table of contents (NO) in the .chm file.
......
838 548
BINARY_TOC             = NO
839 549

  
840 550
# The TOC_EXPAND flag can be set to YES to add extra items for group members
841
# to the contents of the HTML help documentation and to the tree view.
551
# to the contents of the Html help documentation and to the tree view.
842 552

  
843 553
TOC_EXPAND             = NO
844 554

  
......
853 563

  
854 564
ENUM_VALUES_PER_LINE   = 4
855 565

  
856
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
857
# structure should be generated to display hierarchical information.
858
# If the tag value is set to FRAME, a side panel will be generated
859
# containing a tree-like index structure (just like the one that
566
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
567
# generated containing a tree-like index structure (just like the one that
860 568
# is generated for HTML Help). For this to work a browser that supports
861
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
862
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
863
# probably better off using the HTML help feature. Other possible values
864
# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
865
# and Class Hiererachy pages using a tree view instead of an ordered list;
866
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
867
# disables this behavior completely. For backwards compatibility with previous
868
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
869
# respectively.
569
# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
570
# or Internet explorer 4.0+). Note that for large projects the tree generation
571
# can take a very long time. In such cases it is better to disable this feature.
572
# Windows users are probably better off using the HTML help feature.
870 573

  
871 574
GENERATE_TREEVIEW      = NO
872 575

  
......
876 579

  
877 580
TREEVIEW_WIDTH         = 250
878 581

  
879
# Use this tag to change the font size of Latex formulas included
880
# as images in the HTML documentation. The default is 10. Note that
881
# when you change the font size after a successful doxygen run you need
882
# to manually remove any form_*.png images from the HTML output directory
883
# to force them to be regenerated.
884

  
885
FORMULA_FONTSIZE       = 10
886

  
887 582
#---------------------------------------------------------------------------
888 583
# configuration options related to the LaTeX output
889 584
#---------------------------------------------------------------------------
......
954 649

  
955 650
LATEX_BATCHMODE        = NO
956 651

  
957
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
958
# include the index chapters (such as File Index, Compound Index, etc.)
959
# in the output.
960

  
961
LATEX_HIDE_INDICES     = NO
962

  
963 652
#---------------------------------------------------------------------------
964 653
# configuration options related to the RTF output
965 654
#---------------------------------------------------------------------------
......
992 681
RTF_HYPERLINKS         = NO
993 682

  
994 683
# Load stylesheet definitions from file. Syntax is similar to doxygen's
995
# config file, i.e. a series of assignments. You only have to provide
684
# config file, i.e. a series of assigments. You only have to provide
996 685
# replacements, missing definitions are set to their default value.
997 686

  
998 687
RTF_STYLESHEET_FILE    =
......
1036 725

  
1037 726
# If the GENERATE_XML tag is set to YES Doxygen will
1038 727
# generate an XML file that captures the structure of
1039
# the code including all documentation.
728
# the code including all documentation. Note that this
729
# feature is still experimental and incomplete at the
730
# moment.
1040 731

  
1041 732
GENERATE_XML           = NO
1042 733

  
1043
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1044
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1045
# put in front of it. If left blank `xml' will be used as the default path.
1046

  
1047
XML_OUTPUT             = xml
1048

  
1049 734
# The XML_SCHEMA tag can be used to specify an XML schema,
1050 735
# which can be used by a validating XML parser to check the
1051 736
# syntax of the XML files.
......
1058 743

  
1059 744
XML_DTD                =
1060 745

  
1061
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1062
# dump the program listings (including syntax highlighting
1063
# and cross-referencing information) to the XML output. Note that
1064
# enabling this will significantly increase the size of the XML output.
1065

  
1066
XML_PROGRAMLISTING     = YES
1067

  
1068 746
#---------------------------------------------------------------------------
1069 747
# configuration options for the AutoGen Definitions output
1070 748
#---------------------------------------------------------------------------
......
1129 807

  
1130 808
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1131 809
# then the macro expansion is limited to the macros specified with the
1132
# PREDEFINED and EXPAND_AS_DEFINED tags.
810
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
1133 811

  
1134 812
EXPAND_ONLY_PREDEF     = YES
1135 813

  
......
1155 833
# are defined before the preprocessor is started (similar to the -D option of
1156 834
# gcc). The argument of the tag is a list of macros of the form: name
1157 835
# or name=definition (no spaces). If the definition and the = are
1158
# omitted =1 is assumed. To prevent a macro definition from being
1159
# undefined via #undef or recursively expanded use the := operator
1160
# instead of the = operator.
836
# omitted =1 is assumed.
1161 837

  
1162 838
PREDEFINED             = __attribute__(x)="" "RENAME(x)=x ## _TMPL" "DEF(x)=x ## _TMPL" \
1163 839
                         HAVE_AV_CONFIG_H HAVE_MMX HAVE_MMX2 HAVE_AMD3DNOW \
......
1173 849
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1174 850
# doxygen's preprocessor will remove all function-like macros that are alone
1175 851
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1176
# function macros are typically used for boiler-plate code, and will confuse
1177
# the parser if not removed.
852
# function macros are typically used for boiler-plate code, and will confuse the
853
# parser if not removed.
1178 854

  
1179 855
SKIP_FUNCTION_MACROS   = YES
1180 856

  
1181 857
#---------------------------------------------------------------------------
1182
# Configuration::additions related to external references
858
# Configuration::addtions related to external references
1183 859
#---------------------------------------------------------------------------
1184 860

  
1185
# The TAGFILES option can be used to specify one or more tagfiles.
1186
# Optionally an initial location of the external documentation
1187
# can be added for each tagfile. The format of a tag file without
1188
# this location is as follows:
1189
#   TAGFILES = file1 file2 ...
1190
# Adding location for the tag files is done as follows:
1191
#   TAGFILES = file1=loc1 "file2 = loc2" ...
1192
# where "loc1" and "loc2" can be relative or absolute paths or
1193
# URLs. If a location is present for each tag, the installdox tool
1194
# does not have to be run to correct the links.
1195
# Note that each tag file must have a unique name
1196
# (where the name does NOT include the path)
1197
# If a tag file is not located in the directory in which doxygen
1198
# is run, you must also specify the path to the tagfile here.
861
# The TAGFILES tag can be used to specify one or more tagfiles.
1199 862

  
1200 863
TAGFILES               =
1201 864

  
......
1226 889
#---------------------------------------------------------------------------
1227 890

  
1228 891
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1229
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1230
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1231
# this option is superseded by the HAVE_DOT option below. This is only a
1232
# fallback. It is recommended to install and use dot, since it yields more
1233
# powerful graphs.
892
# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
893
# super classes. Setting the tag to NO turns the diagrams off. Note that this
894
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
895
# recommended to install and use dot, since it yield more powerful graphs.
1234 896

  
1235 897
CLASS_DIAGRAMS         = YES
1236 898

  
1237
# You can define message sequence charts within doxygen comments using the \msc
1238
# command. Doxygen will then run the mscgen tool (see
1239
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1240
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1241
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1242
# default search path.
1243

  
1244
MSCGEN_PATH            =
1245

  
1246 899
# If set to YES, the inheritance and collaboration graphs will hide
1247 900
# inheritance and usage relations if the target is undocumented
1248 901
# or is not a class.
......
1256 909

  
1257 910
HAVE_DOT               = NO
1258 911

  
1259
# By default doxygen will write a font called FreeSans.ttf to the output
1260
# directory and reference it in all dot files that doxygen generates. This
1261
# font does not include all possible unicode characters however, so when you need
1262
# these (or just want a differently looking font) you can specify the font name
1263
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1264
# which can be done by putting it in a standard location or by setting the
1265
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1266
# containing the font.
1267

  
1268
DOT_FONTNAME           = FreeSans
1269

  
1270
# By default doxygen will tell dot to use the output directory to look for the
1271
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1272
# different font using DOT_FONTNAME you can set the path where dot
1273
# can find it using this tag.
1274

  
1275
DOT_FONTPATH           =
1276

  
1277 912
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1278 913
# will generate a graph for each documented class showing the direct and
1279 914
# indirect inheritance relations. Setting this tag to YES will force the
......
1288 923

  
1289 924
COLLABORATION_GRAPH    = YES
1290 925

  
1291
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1292
# will generate a graph for groups, showing the direct groups dependencies
1293

  
1294
GROUP_GRAPHS           = YES
1295

  
1296
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1297
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1298
# Language.
1299

  
1300
UML_LOOK               = NO
1301

  
1302 926
# If set to YES, the inheritance and collaboration graphs will show the
1303 927
# relations between templates and their instances.
1304 928

  
......
1318 942

  
1319 943
INCLUDED_BY_GRAPH      = YES
1320 944

  
1321
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1322
# doxygen will generate a call dependency graph for every global function
1323
# or class method. Note that enabling this option will significantly increase
1324
# the time of a run. So in most cases it will be better to enable call graphs
1325
# for selected functions only using the \callgraph command.
1326

  
1327
CALL_GRAPH             = NO
1328

  
1329
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1330
# doxygen will generate a caller dependency graph for every global function
1331
# or class method. Note that enabling this option will significantly increase
1332
# the time of a run. So in most cases it will be better to enable caller
1333
# graphs for selected functions only using the \callergraph command.
1334

  
1335
CALLER_GRAPH           = NO
1336

  
1337 945
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1338 946
# will graphical hierarchy of all classes instead of a textual one.
1339 947

  
1340 948
GRAPHICAL_HIERARCHY    = YES
1341 949

  
1342
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1343
# then doxygen will show the dependencies a directory has on other directories
1344
# in a graphical way. The dependency relations are determined by the #include
1345
# relations between the files in the directories.
1346

  
1347
DIRECTORY_GRAPH        = YES
1348

  
1349 950
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1350 951
# generated by dot. Possible values are png, jpg, or gif
1351 952
# If left blank png will be used.
......
1353 954
DOT_IMAGE_FORMAT       = png
1354 955

  
1355 956
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1356
# found. If left blank, it is assumed the dot tool can be found in the path.
957
# found. If left blank, it is assumed the dot tool can be found on the path.
1357 958

  
1358 959
DOT_PATH               =
1359 960

  
......
1363 964

  
1364 965
DOTFILE_DIRS           =
1365 966

  
1366
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1367
# nodes that will be shown in the graph. If the number of nodes in a graph
1368
# becomes larger than this value, doxygen will truncate the graph, which is
1369
# visualized by representing a node as a red box. Note that doxygen if the
1370
# number of direct children of the root node in a graph is already larger than
1371
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1372
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1373

  
1374
DOT_GRAPH_MAX_NODES    = 50
1375

  
1376
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1377
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1378
# from the root by following a path via at most 3 edges will be shown. Nodes
1379
# that lay further from the root node will be omitted. Note that setting this
1380
# option to 1 or 2 may greatly reduce the computation time needed for large
1381
# code bases. Also note that the size of a graph can be further restricted by
1382
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
967
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
968
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
969
# this value, doxygen will try to truncate the graph, so that it fits within
970
# the specified constraint. Beware that most browsers cannot cope with very
971
# large images.
1383 972

  
1384
MAX_DOT_GRAPH_DEPTH    = 0
973
MAX_DOT_GRAPH_WIDTH    = 1024
1385 974

  
1386
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1387
# background. This is enabled by default, which results in a transparent
1388
# background. Warning: Depending on the platform used, enabling this option
1389
# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1390
# become hard to read).
975
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
976
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
977
# this value, doxygen will try to truncate the graph, so that it fits within
978
# the specified constraint. Beware that most browsers cannot cope with very
979
# large images.
1391 980

  
1392
DOT_TRANSPARENT        = YES
1393

  
1394
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1395
# files in one run (i.e. multiple -o and -T options on the command line). This
1396
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1397
# support this, this feature is disabled by default.
1398

  
1399
DOT_MULTI_TARGETS      = NO
981
MAX_DOT_GRAPH_HEIGHT   = 1024
1400 982

  
1401 983
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1402 984
# generate a legend page explaining the meaning of the various boxes and
......
1405 987
GENERATE_LEGEND        = YES
1406 988

  
1407 989
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1408
# remove the intermediate dot files that are used to generate
990
# remove the intermedate dot files that are used to generate
1409 991
# the various graphs.
1410 992

  
1411 993
DOT_CLEANUP            = YES
1412 994

  
1413 995
#---------------------------------------------------------------------------
1414
# Configuration::additions related to the search engine
996
# Configuration::addtions related to the search engine
1415 997
#---------------------------------------------------------------------------
1416 998

  
1417 999
# The SEARCHENGINE tag specifies whether or not a search engine should be
1418 1000
# used. If set to NO the values of all tags below this one will be ignored.
1419 1001

  
1420 1002
SEARCHENGINE           = NO
1003

  
1004
# The CGI_NAME tag should be the name of the CGI script that
1005
# starts the search engine (doxysearch) with the correct parameters.
1006
# A script with this name will be generated by doxygen.
1007

  
1008
CGI_NAME               = search.cgi
1009

  
1010
# The CGI_URL tag should be the absolute URL to the directory where the
1011
# cgi binaries are located. See the documentation of your http daemon for
1012
# details.
1013

  
1014
CGI_URL                =
1015

  
1016
# The DOC_URL tag should be the absolute URL to the directory where the
1017
# documentation is located. If left blank the absolute path to the
1018
# documentation, with file:// prepended to it, will be used.
1019

  
1020
DOC_URL                =
1021

  
1022
# The DOC_ABSPATH tag should be the absolute path to the directory where the
1023
# documentation is located. If left blank the directory on the local machine
1024
# will be used.
1025

  
1026
DOC_ABSPATH            =
1027

  
1028
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
1029
# is installed.
1030

  
1031
BIN_ABSPATH            = /usr/local/bin/
1032

  
1033
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
1034
# documentation generated for other projects. This allows doxysearch to search
1035
# the documentation for these projects as well.
1036

  
1037
EXT_DOC_PATHS          =

Also available in: Unified diff