← Back to branch summary

~ubuntu-branches/ubuntu/wily/alsaplayer/wily

« back to all changes in this revision

Viewing changes to docs/reference.doxygen.in

  • Committer: Bazaar Package Importer
  • Author(s): Hubert Chathi
  • Date: 2007-10-10 15:33:10 UTC
  • mto: (9.2.5 sid)
  • mto: This revision was merged to the branch mainline in revision 15.
  • Revision ID: james.westby@ubuntu.com-20071010153310-h3holq75eu2cigb0
Tags: upstream-0.99.80~rc4
Import upstream version 0.99.80~rc4

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference.doxygen.in
1
 
# Doxyfile 1.2.14
 
1
# Doxyfile 1.4.7
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
 
# General configuration options
 
14
# Project related configuration options
15
15
#---------------------------------------------------------------------------
16
16
 
17
17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
32
32
 
33
33
OUTPUT_DIRECTORY       = reference
34
34
 
 
35
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
 
36
# 4096 sub-directories (in 2 levels) under the output directory of each output 
 
37
# format and will distribute the generated files over these directories. 
 
38
# Enabling this option can be useful when feeding doxygen a huge amount of 
 
39
# source files, where putting all generated files in the same directory would 
 
40
# otherwise cause performance problems for the file system.
 
41
 
 
42
CREATE_SUBDIRS         = NO
 
43
 
35
44
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
36
45
# documentation generated by doxygen is written. Doxygen will use this 
37
46
# information to generate all constant output in the proper language. 
38
47
# The default language is English, other supported languages are: 
39
 
# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, 
40
 
# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, 
41
 
# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
 
48
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 
 
49
# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 
 
50
# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 
 
51
# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 
 
52
# Swedish, and Ukrainian.
42
53
 
43
54
OUTPUT_LANGUAGE        = English
44
55
 
 
56
# This tag can be used to specify the encoding used in the generated output. 
 
57
# The encoding is not always determined by the language that is chosen, 
 
58
# but also whether or not the output is meant for Windows or non-Windows users. 
 
59
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
 
60
# forces the Windows encoding (this is the default for the Windows binary), 
 
61
# whereas setting the tag to NO uses a Unix-style encoding (the default for 
 
62
# all platforms other than Windows).
 
63
 
 
64
USE_WINDOWS_ENCODING   = NO
 
65
 
 
66
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
 
67
# include brief member descriptions after the members that are listed in 
 
68
# the file and class documentation (similar to JavaDoc). 
 
69
# Set to NO to disable this.
 
70
 
 
71
BRIEF_MEMBER_DESC      = YES
 
72
 
 
73
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
 
74
# the brief description of a member or function before the detailed description. 
 
75
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
 
76
# brief descriptions will be completely suppressed.
 
77
 
 
78
REPEAT_BRIEF           = YES
 
79
 
 
80
# This tag implements a quasi-intelligent brief description abbreviator 
 
81
# that is used to form the text in various listings. Each string 
 
82
# in this list, if found as the leading text of the brief description, will be 
 
83
# stripped from the text and the result after processing the whole list, is 
 
84
# used as the annotated text. Otherwise, the brief description is used as-is. 
 
85
# If left blank, the following values are used ("$name" is automatically 
 
86
# replaced with the name of the entity): "The $name class" "The $name widget" 
 
87
# "The $name file" "is" "provides" "specifies" "contains" 
 
88
# "represents" "a" "an" "the"
 
89
 
 
90
ABBREVIATE_BRIEF       = 
 
91
 
 
92
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
 
93
# Doxygen will generate a detailed section even if there is only a brief 
 
94
# description.
 
95
 
 
96
ALWAYS_DETAILED_SEC    = NO
 
97
 
 
98
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
 
99
# inherited members of a class in the documentation of that class as if those 
 
100
# members were ordinary class members. Constructors, destructors and assignment 
 
101
# operators of the base classes will not be shown.
 
102
 
 
103
INLINE_INHERITED_MEMB  = NO
 
104
 
 
105
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
 
106
# path before files name in the file list and in the header files. If set 
 
107
# to NO the shortest path that makes the file name unique will be used.
 
108
 
 
109
FULL_PATH_NAMES        = NO
 
110
 
 
111
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
 
112
# can be used to strip a user-defined part of the path. Stripping is 
 
113
# only done if one of the specified strings matches the left-hand part of 
 
114
# the path. The tag can be used to show relative paths in the file list. 
 
115
# If left blank the directory from which doxygen is run is used as the 
 
116
# path to strip.
 
117
 
 
118
STRIP_FROM_PATH        = 
 
119
 
 
120
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
 
121
# the path mentioned in the documentation of a class, which tells 
 
122
# the reader which header file to include in order to use a class. 
 
123
# If left blank only the name of the header file containing the class 
 
124
# definition is used. Otherwise one should specify the include paths that 
 
125
# are normally passed to the compiler using the -I flag.
 
126
 
 
127
STRIP_FROM_INC_PATH    = 
 
128
 
 
129
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
 
130
# (but less readable) file names. This can be useful is your file systems 
 
131
# doesn't support long names like on DOS, Mac, or CD-ROM.
 
132
 
 
133
SHORT_NAMES            = NO
 
134
 
 
135
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
 
136
# will interpret the first line (until the first dot) of a JavaDoc-style 
 
137
# comment as the brief description. If set to NO, the JavaDoc 
 
138
# comments will behave just like the Qt-style comments (thus requiring an 
 
139
# explicit @brief command for a brief description.
 
140
 
 
141
JAVADOC_AUTOBRIEF      = NO
 
142
 
 
143
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
 
144
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
 
145
# comments) as a brief description. This used to be the default behaviour. 
 
146
# The new default is to treat a multi-line C++ comment block as a detailed 
 
147
# description. Set this tag to YES if you prefer the old behaviour instead.
 
148
 
 
149
MULTILINE_CPP_IS_BRIEF = NO
 
150
 
 
151
# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
 
152
# will output the detailed description near the top, like JavaDoc.
 
153
# If set to NO, the detailed description appears after the member 
 
154
# documentation.
 
155
 
 
156
DETAILS_AT_TOP         = NO
 
157
 
 
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 
 
160
# re-implements.
 
161
 
 
162
INHERIT_DOCS           = YES
 
163
 
 
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 
 
166
# be part of the file/class/namespace that contains it.
 
167
 
 
168
SEPARATE_MEMBER_PAGES  = NO
 
169
 
 
170
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
 
171
# Doxygen uses this value to replace tabs by spaces in code fragments.
 
172
 
 
173
TAB_SIZE               = 8
 
174
 
 
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:". 
 
180
# You can put \n's in the value part of an alias to insert newlines.
 
181
 
 
182
ALIASES                = 
 
183
 
 
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 
 
187
# of all members will be omitted, etc.
 
188
 
 
189
OPTIMIZE_OUTPUT_FOR_C  = YES
 
190
 
 
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 Java. 
 
193
# For instance, namespaces will be presented as packages, qualified scopes 
 
194
# will look different, etc.
 
195
 
 
196
OPTIMIZE_OUTPUT_JAVA   = NO
 
197
 
 
198
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 
 
199
# include (a tag file for) the STL sources as input, then you should 
 
200
# set this tag to YES in order to let doxygen match functions declarations and 
 
201
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
 
202
# func(std::string) {}). This also make the inheritance and collaboration 
 
203
# diagrams that involve STL classes more complete and accurate.
 
204
 
 
205
BUILTIN_STL_SUPPORT    = NO
 
206
 
 
207
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
 
208
# tag is set to YES, then doxygen will reuse the documentation of the first 
 
209
# member in the group (if any) for the other members of the group. By default 
 
210
# all members of a group must be documented explicitly.
 
211
 
 
212
DISTRIBUTE_GROUP_DOC   = NO
 
213
 
 
214
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
 
215
# the same type (for instance a group of public functions) to be put as a 
 
216
# subgroup of that type (e.g. under the Public Functions section). Set it to 
 
217
# NO to prevent subgrouping. Alternatively, this can be done per class using 
 
218
# the \nosubgrouping command.
 
219
 
 
220
SUBGROUPING            = YES
 
221
 
 
222
#---------------------------------------------------------------------------
 
223
# Build related configuration options
 
224
#---------------------------------------------------------------------------
 
225
 
45
226
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
46
227
# documentation are documented, even if no documentation was available. 
47
228
# Private class members and static file members will be hidden unless 
65
246
 
66
247
EXTRACT_LOCAL_CLASSES  = YES
67
248
 
 
249
# This flag is only useful for Objective-C code. When set to YES local 
 
250
# methods, which are defined in the implementation section but not in 
 
251
# the interface are included in the documentation. 
 
252
# If set to NO (the default) only methods in the interface are included.
 
253
 
 
254
EXTRACT_LOCAL_METHODS  = NO
 
255
 
68
256
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
69
257
# undocumented members of documented classes, files or namespaces. 
70
258
# If set to NO (the default) these members will be included in the 
75
263
 
76
264
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
77
265
# undocumented classes that are normally visible in the class hierarchy. 
78
 
# If set to NO (the default) these class will be included in the various 
 
266
# If set to NO (the default) these classes will be included in the various 
79
267
# overviews. This option has no effect if EXTRACT_ALL is enabled.
80
268
 
81
269
HIDE_UNDOC_CLASSES     = NO
82
270
 
83
 
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
84
 
# include brief member descriptions after the members that are listed in 
85
 
# the file and class documentation (similar to JavaDoc). 
86
 
# Set to NO to disable this.
87
 
 
88
 
BRIEF_MEMBER_DESC      = YES
89
 
 
90
 
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
91
 
# the brief description of a member or function before the detailed description.
92
 
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
93
 
# brief descriptions will be completely suppressed.
94
 
 
95
 
REPEAT_BRIEF           = YES
96
 
 
97
 
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
98
 
# Doxygen will generate a detailed section even if there is only a brief 
99
 
# description.
100
 
 
101
 
ALWAYS_DETAILED_SEC    = NO
102
 
 
103
 
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show 
104
 
# all inherited members of a class in the documentation of that class as 
105
 
# if those members were ordinary class members. Constructors, destructors 
106
 
# and assignment operators of the base classes will not be shown.
107
 
 
108
 
INLINE_INHERITED_MEMB  = NO
109
 
 
110
 
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
111
 
# path before files name in the file list and in the header files. If set 
112
 
# to NO the shortest path that makes the file name unique will be used.
113
 
 
114
 
FULL_PATH_NAMES        = NO
115
 
 
116
 
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
117
 
# can be used to strip a user defined part of the path. Stripping is 
118
 
# only done if one of the specified strings matches the left-hand part of 
119
 
# the path. It is allowed to use relative paths in the argument list.
120
 
 
121
 
STRIP_FROM_PATH        = 
 
271
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
 
272
# friend (class|struct|union) declarations. 
 
273
# If set to NO (the default) these declarations will be included in the 
 
274
# documentation.
 
275
 
 
276
HIDE_FRIEND_COMPOUNDS  = NO
 
277
 
 
278
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
 
279
# documentation blocks found inside the body of a function. 
 
280
# If set to NO (the default) these blocks will be appended to the 
 
281
# function's detailed documentation block.
 
282
 
 
283
HIDE_IN_BODY_DOCS      = NO
122
284
 
123
285
# The INTERNAL_DOCS tag determines if documentation 
124
286
# that is typed after a \internal command is included. If the tag is set 
127
289
 
128
290
INTERNAL_DOCS          = NO
129
291
 
130
 
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
131
 
# doxygen to hide any special comment blocks from generated source code 
132
 
# fragments. Normal C and C++ comments will always remain visible.
133
 
 
134
 
STRIP_CODE_COMMENTS    = YES
135
 
 
136
292
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
137
 
# file names in lower case letters. If set to YES upper case letters are also 
 
293
# file names in lower-case letters. If set to YES upper-case letters are also 
138
294
# allowed. This is useful if you have classes or files whose names only differ 
139
295
# in case and if your file system supports case sensitive file names. Windows 
140
 
# users are adviced to set this option to NO.
 
296
# and Mac users are advised to set this option to NO.
141
297
 
142
298
CASE_SENSE_NAMES       = YES
143
299
 
144
 
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
145
 
# (but less readable) file names. This can be useful is your file systems 
146
 
# doesn't support long names like on DOS, Mac, or CD-ROM.
147
 
 
148
 
SHORT_NAMES            = NO
149
 
 
150
300
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
151
301
# will show members with their full class and namespace scopes in the 
152
302
# documentation. If set to YES the scope will be hidden.
153
303
 
154
304
HIDE_SCOPE_NAMES       = NO
155
305
 
156
 
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
157
 
# will generate a verbatim copy of the header file for each class for 
158
 
# which an include is specified. Set to NO to disable this.
159
 
 
160
 
VERBATIM_HEADERS       = YES
161
 
 
162
306
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
163
 
# will put list of the files that are included by a file in the documentation 
 
307
# will put a list of the files that are included by a file in the documentation 
164
308
# of that file.
165
309
 
166
310
SHOW_INCLUDE_FILES     = YES
167
311
 
168
 
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
169
 
# will interpret the first line (until the first dot) of a JavaDoc-style 
170
 
# comment as the brief description. If set to NO, the JavaDoc 
171
 
# comments  will behave just like the Qt-style comments (thus requiring an 
172
 
# explict @brief command for a brief description.
173
 
 
174
 
JAVADOC_AUTOBRIEF      = NO
175
 
 
176
 
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
177
 
# member inherits the documentation from any documented member that it 
178
 
# reimplements.
179
 
 
180
 
INHERIT_DOCS           = YES
181
 
 
182
312
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
183
313
# is inserted in the documentation for inline members.
184
314
 
191
321
 
192
322
SORT_MEMBER_DOCS       = YES
193
323
 
194
 
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
195
 
# tag is set to YES, then doxygen will reuse the documentation of the first 
196
 
# member in the group (if any) for the other members of the group. By default 
197
 
# all members of a group must be documented explicitly.
198
 
 
199
 
DISTRIBUTE_GROUP_DOC   = NO
200
 
 
201
 
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
202
 
# Doxygen uses this value to replace tabs by spaces in code fragments.
203
 
 
204
 
TAB_SIZE               = 8
 
324
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
 
325
# brief documentation of file, namespace and class members alphabetically 
 
326
# by member name. If set to NO (the default) the members will appear in 
 
327
# declaration order.
 
328
 
 
329
SORT_BRIEF_DOCS        = NO
 
330
 
 
331
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
 
332
# sorted by fully-qualified names, including namespaces. If set to 
 
333
# NO (the default), the class list will be sorted only by class name, 
 
334
# not including the namespace part. 
 
335
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
 
336
# Note: This option applies only to the class list, not to the 
 
337
# alphabetical list.
 
338
 
 
339
SORT_BY_SCOPE_NAME     = NO
205
340
 
206
341
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
207
342
# disable (NO) the todo list. This list is created by putting \todo 
221
356
 
222
357
GENERATE_BUGLIST       = NO
223
358
 
224
 
# This tag can be used to specify a number of aliases that acts 
225
 
# as commands in the documentation. An alias has the form "name=value". 
226
 
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
227
 
# put the command \sideeffect (or @sideeffect) in the documentation, which 
228
 
# will result in a user defined paragraph with heading "Side Effects:". 
229
 
# You can put \n's in the value part of an alias to insert newlines.
 
359
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
 
360
# disable (NO) the deprecated list. This list is created by putting 
 
361
# \deprecated commands in the documentation.
230
362
 
231
 
ALIASES                = 
 
363
GENERATE_DEPRECATEDLIST= YES
232
364
 
233
365
# The ENABLED_SECTIONS tag can be used to enable conditional 
234
366
# documentation sections, marked by \if sectionname ... \endif.
236
368
ENABLED_SECTIONS       = 
237
369
 
238
370
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
239
 
# the initial value of a variable or define consist of for it to appear in 
 
371
# the initial value of a variable or define consists of for it to appear in 
240
372
# the documentation. If the initializer consists of more lines than specified 
241
373
# here it will be hidden. Use a value of 0 to hide initializers completely. 
242
374
# The appearance of the initializer of individual variables and defines in the 
245
377
 
246
378
MAX_INITIALIZER_LINES  = 30
247
379
 
248
 
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
249
 
# only. Doxygen will then generate output that is more tailored for C. 
250
 
# For instance some of the names that are used will be different. The list 
251
 
# of all members will be omitted, etc.
252
 
 
253
 
OPTIMIZE_OUTPUT_FOR_C  = YES
254
 
 
255
380
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
256
381
# at the bottom of the documentation of classes and structs. If set to YES the 
257
382
# list will mention the files that were used to generate the documentation.
258
383
 
259
384
SHOW_USED_FILES        = YES
260
385
 
 
386
# If the sources in your project are distributed over multiple directories 
 
387
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
 
388
# in the documentation. The default is NO.
 
389
 
 
390
SHOW_DIRECTORIES       = NO
 
391
 
 
392
# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
 
393
# doxygen should invoke to get the current version for each file (typically from the 
 
394
# version control system). Doxygen will invoke the program by executing (via 
 
395
# popen()) the command <command> <input-file>, where <command> is the value of 
 
396
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
 
397
# provided by doxygen. Whatever the program writes to standard output 
 
398
# is used as the file version. See the manual for examples.
 
399
 
 
400
FILE_VERSION_FILTER    = 
 
401
 
261
402
#---------------------------------------------------------------------------
262
403
# configuration options related to warning and progress messages
263
404
#---------------------------------------------------------------------------
279
420
 
280
421
WARN_IF_UNDOCUMENTED   = YES
281
422
 
 
423
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
 
424
# potential errors in the documentation, such as not documenting some 
 
425
# parameters in a documented function, or documenting parameters that 
 
426
# don't exist or using markup commands wrongly.
 
427
 
 
428
WARN_IF_DOC_ERROR      = YES
 
429
 
 
430
# This WARN_NO_PARAMDOC option can be abled to get warnings for 
 
431
# functions that are documented, but have no documentation for their parameters 
 
432
# or return value. If set to NO (the default) doxygen will only warn about 
 
433
# wrong or incomplete parameter documentation, but not about the absence of 
 
434
# documentation.
 
435
 
 
436
WARN_NO_PARAMDOC       = NO
 
437
 
282
438
# The WARN_FORMAT tag determines the format of the warning messages that 
283
439
# doxygen can produce. The string should contain the $file, $line, and $text 
284
440
# tags, which will be replaced by the file and line number from which the 
285
 
# warning originated and the warning text.
 
441
# warning originated and the warning text. Optionally the format may contain 
 
442
# $version, which will be replaced by the version of the file (if it could 
 
443
# be obtained via FILE_VERSION_FILTER)
286
444
 
287
445
WARN_FORMAT            = "$file:$line: $text"
288
446
 
301
459
# directories like "/usr/src/myproject". Separate the files or directories 
302
460
# with spaces.
303
461
 
304
 
INPUT = @top_srcdir@/alsaplayer/input_plugin.h \
305
 
        @top_srcdir@/alsaplayer/output_plugin.h \
306
 
        @top_srcdir@/alsaplayer/interface_plugin.h \
307
 
        @top_srcdir@/alsaplayer/scope_plugin.h
 
462
INPUT                  = @top_srcdir@/alsaplayer/input_plugin.h \
 
463
                         @top_srcdir@/alsaplayer/output_plugin.h \
 
464
                         @top_srcdir@/alsaplayer/interface_plugin.h \
 
465
                         @top_srcdir@/alsaplayer/scope_plugin.h
308
466
 
309
467
# If the value of the INPUT tag contains directories, you can use the 
310
468
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
311
469
# and *.h) to filter out the source-files in the directories. If left 
312
470
# blank the following patterns are tested: 
313
 
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
314
 
# *.h++ *.idl *.odl
 
471
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
 
472
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
315
473
 
316
474
FILE_PATTERNS          = 
317
475
 
328
486
EXCLUDE                = 
329
487
 
330
488
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
331
 
# directories that are symbolic links (a Unix filesystem feature) are 
332
 
# excluded from the input.
 
489
# directories that are symbolic links (a Unix filesystem feature) are excluded 
 
490
# from the input.
333
491
 
334
492
EXCLUDE_SYMLINKS       = NO
335
493
 
336
494
# If the value of the INPUT tag contains directories, you can use the 
337
495
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
338
 
# certain files from those directories.
 
496
# certain files from those directories. Note that the wildcards are matched 
 
497
# against the file with absolute path, so to exclude all test directories 
 
498
# for example use the pattern */test/*
339
499
 
340
500
EXCLUDE_PATTERNS       = 
341
501
 
370
530
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
371
531
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
372
532
# input file. Doxygen will then use the output that the filter program writes 
373
 
# to standard output.
 
533
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
 
534
# ignored.
374
535
 
375
536
INPUT_FILTER           = 
376
537
 
 
538
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
 
539
# basis.  Doxygen will compare the file name with each pattern and apply the 
 
540
# filter if there is a match.  The filters are a list of the form: 
 
541
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
 
542
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
 
543
# is applied to all files.
 
544
 
 
545
FILTER_PATTERNS        = 
 
546
 
377
547
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
378
548
# INPUT_FILTER) will be used to filter the input files when producing source 
379
 
# files to browse.
 
549
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
380
550
 
381
551
FILTER_SOURCE_FILES    = NO
382
552
 
385
555
#---------------------------------------------------------------------------
386
556
 
387
557
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
388
 
# be generated. Documented entities will be cross-referenced with these sources.
 
558
# be generated. Documented entities will be cross-referenced with these sources. 
 
559
# Note: To get rid of all source code in the generated output, make sure also 
 
560
# VERBATIM_HEADERS is set to NO.
389
561
 
390
562
SOURCE_BROWSER         = NO
391
563
 
394
566
 
395
567
INLINE_SOURCES         = NO
396
568
 
 
569
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
 
570
# doxygen to hide any special comment blocks from generated source code 
 
571
# fragments. Normal C and C++ comments will always remain visible.
 
572
 
 
573
STRIP_CODE_COMMENTS    = YES
 
574
 
397
575
# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
398
576
# then for each documented function all documented 
399
577
# functions referencing it will be listed.
406
584
 
407
585
REFERENCES_RELATION    = YES
408
586
 
 
587
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
 
588
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
 
589
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
 
590
# link to the source code.  Otherwise they will link to the documentstion.
 
591
 
 
592
REFERENCES_LINK_SOURCE = YES
 
593
 
 
594
# If the USE_HTAGS tag is set to YES then the references to source code 
 
595
# will point to the HTML generated by the htags(1) tool instead of doxygen 
 
596
# built-in source browser. The htags tool is part of GNU's global source 
 
597
# tagging system (see http://www.gnu.org/software/global/global.html). You 
 
598
# will need version 4.8.6 or higher.
 
599
 
 
600
USE_HTAGS              = NO
 
601
 
 
602
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
 
603
# will generate a verbatim copy of the header file for each class for 
 
604
# which an include is specified. Set to NO to disable this.
 
605
 
 
606
VERBATIM_HEADERS       = YES
 
607
 
409
608
#---------------------------------------------------------------------------
410
609
# configuration options related to the alphabetical class index
411
610
#---------------------------------------------------------------------------
462
661
 
463
662
HTML_FOOTER            = 
464
663
 
465
 
# The HTML_STYLESHEET tag can be used to specify a user defined cascading 
 
664
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
466
665
# style sheet that is used by each HTML page. It can be used to 
467
666
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
468
 
# will generate a default style sheet
 
667
# will generate a default style sheet. Note that doxygen will try to copy 
 
668
# the style sheet file to the HTML output directory, so don't put your own 
 
669
# stylesheet in the HTML output directory as well, or it will be erased!
469
670
 
470
671
HTML_STYLESHEET        = 
471
672
 
482
683
 
483
684
GENERATE_HTMLHELP      = NO
484
685
 
 
686
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
 
687
# be used to specify the file name of the resulting .chm file. You 
 
688
# can add a path in front of the file if the result should not be 
 
689
# written to the html output directory.
 
690
 
 
691
CHM_FILE               = 
 
692
 
 
693
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
 
694
# be used to specify the location (absolute path including file name) of 
 
695
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
 
696
# the HTML help compiler on the generated index.hhp.
 
697
 
 
698
HHC_LOCATION           = 
 
699
 
485
700
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
486
701
# controls if a separate .chi index file is generated (YES) or that 
487
702
# it should be included in the master .chm file (NO).
495
710
BINARY_TOC             = NO
496
711
 
497
712
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
498
 
# to the contents of the Html help documentation and to the tree view.
 
713
# to the contents of the HTML help documentation and to the tree view.
499
714
 
500
715
TOC_EXPAND             = NO
501
716
 
513
728
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
514
729
# generated containing a tree-like index structure (just like the one that 
515
730
# is generated for HTML Help). For this to work a browser that supports 
516
 
# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+, 
517
 
# or Internet explorer 4.0+). Note that for large projects the tree generation 
518
 
# can take a very long time. In such cases it is better to disable this feature. 
519
 
# Windows users are probably better off using the HTML help feature.
 
731
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
 
732
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
 
733
# probably better off using the HTML help feature.
520
734
 
521
735
GENERATE_TREEVIEW      = NO
522
736
 
541
755
 
542
756
LATEX_OUTPUT           = latex
543
757
 
 
758
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
 
759
# invoked. If left blank `latex' will be used as the default command name.
 
760
 
 
761
LATEX_CMD_NAME         = latex
 
762
 
 
763
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
 
764
# generate index for LaTeX. If left blank `makeindex' will be used as the 
 
765
# default command name.
 
766
 
 
767
MAKEINDEX_CMD_NAME     = makeindex
 
768
 
544
769
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
545
770
# LaTeX documents. This may be useful for small projects and may help to 
546
771
# save some trees in general.
585
810
 
586
811
LATEX_BATCHMODE        = NO
587
812
 
 
813
# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
 
814
# include the index chapters (such as File Index, Compound Index, etc.) 
 
815
# in the output.
 
816
 
 
817
LATEX_HIDE_INDICES     = NO
 
818
 
588
819
#---------------------------------------------------------------------------
589
820
# configuration options related to the RTF output
590
821
#---------------------------------------------------------------------------
591
822
 
592
823
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
593
 
# The RTF output is optimised for Word 97 and may not look very pretty with 
 
824
# The RTF output is optimized for Word 97 and may not look very pretty with 
594
825
# other RTF readers or editors.
595
826
 
596
827
GENERATE_RTF           = NO
617
848
RTF_HYPERLINKS         = NO
618
849
 
619
850
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
620
 
# config file, i.e. a series of assigments. You only have to provide 
 
851
# config file, i.e. a series of assignments. You only have to provide 
621
852
# replacements, missing definitions are set to their default value.
622
853
 
623
854
RTF_STYLESHEET_FILE    = 
661
892
 
662
893
# If the GENERATE_XML tag is set to YES Doxygen will 
663
894
# generate an XML file that captures the structure of 
664
 
# the code including all documentation. Note that this 
665
 
# feature is still experimental and incomplete at the 
666
 
# moment.
 
895
# the code including all documentation.
667
896
 
668
897
GENERATE_XML           = NO
669
898
 
 
899
# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
 
900
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
 
901
# put in front of it. If left blank `xml' will be used as the default path.
 
902
 
 
903
XML_OUTPUT             = xml
 
904
 
 
905
# The XML_SCHEMA tag can be used to specify an XML schema, 
 
906
# which can be used by a validating XML parser to check the 
 
907
# syntax of the XML files.
 
908
 
 
909
XML_SCHEMA             = 
 
910
 
 
911
# The XML_DTD tag can be used to specify an XML DTD, 
 
912
# which can be used by a validating XML parser to check the 
 
913
# syntax of the XML files.
 
914
 
 
915
XML_DTD                = 
 
916
 
 
917
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
 
918
# dump the program listings (including syntax highlighting 
 
919
# and cross-referencing information) to the XML output. Note that 
 
920
# enabling this will significantly increase the size of the XML output.
 
921
 
 
922
XML_PROGRAMLISTING     = YES
 
923
 
670
924
#---------------------------------------------------------------------------
671
925
# configuration options for the AutoGen Definitions output
672
926
#---------------------------------------------------------------------------
680
934
GENERATE_AUTOGEN_DEF   = NO
681
935
 
682
936
#---------------------------------------------------------------------------
 
937
# configuration options related to the Perl module output
 
938
#---------------------------------------------------------------------------
 
939
 
 
940
# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
 
941
# generate a Perl module file that captures the structure of 
 
942
# the code including all documentation. Note that this 
 
943
# feature is still experimental and incomplete at the 
 
944
# moment.
 
945
 
 
946
GENERATE_PERLMOD       = NO
 
947
 
 
948
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
 
949
# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
 
950
# to generate PDF and DVI output from the Perl module output.
 
951
 
 
952
PERLMOD_LATEX          = NO
 
953
 
 
954
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
 
955
# nicely formatted so it can be parsed by a human reader.  This is useful 
 
956
# if you want to understand what is going on.  On the other hand, if this 
 
957
# tag is set to NO the size of the Perl module output will be much smaller 
 
958
# and Perl will parse it just the same.
 
959
 
 
960
PERLMOD_PRETTY         = YES
 
961
 
 
962
# The names of the make variables in the generated doxyrules.make file 
 
963
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
 
964
# This is useful so different doxyrules.make files included by the same 
 
965
# Makefile don't overwrite each other's variables.
 
966
 
 
967
PERLMOD_MAKEVAR_PREFIX = 
 
968
 
 
969
#---------------------------------------------------------------------------
683
970
# Configuration options related to the preprocessor   
684
971
#---------------------------------------------------------------------------
685
972
 
698
985
 
699
986
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
700
987
# then the macro expansion is limited to the macros specified with the 
701
 
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
 
988
# PREDEFINED and EXPAND_AS_DEFINED tags.
702
989
 
703
990
EXPAND_ONLY_PREDEF     = NO
704
991
 
724
1011
# are defined before the preprocessor is started (similar to the -D option of 
725
1012
# gcc). The argument of the tag is a list of macros of the form: name 
726
1013
# or name=definition (no spaces). If the definition and the = are 
727
 
# omitted =1 is assumed.
 
1014
# omitted =1 is assumed. To prevent a macro definition from being 
 
1015
# undefined via #undef or recursively expanded use the := operator 
 
1016
# instead of the = operator.
728
1017
 
729
1018
PREDEFINED             = 
730
1019
 
731
 
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 
 
1020
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
732
1021
# this tag can be used to specify a list of macro names that should be expanded. 
733
1022
# The macro definition that is found in the sources will be used. 
734
1023
# Use the PREDEFINED tag if you want to use a different macro definition.
737
1026
 
738
1027
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
739
1028
# doxygen's preprocessor will remove all function-like macros that are alone 
740
 
# on a line and do not end with a semicolon. Such function macros are typically 
741
 
# used for boiler-plate code, and will confuse the parser if not removed.
 
1029
# on a line, have an all uppercase name, and do not end with a semicolon. Such 
 
1030
# function macros are typically used for boiler-plate code, and will confuse 
 
1031
# the parser if not removed.
742
1032
 
743
1033
SKIP_FUNCTION_MACROS   = YES
744
1034
 
745
1035
#---------------------------------------------------------------------------
746
 
# Configuration::addtions related to external references   
 
1036
# Configuration::additions related to external references   
747
1037
#---------------------------------------------------------------------------
748
1038
 
749
 
# The TAGFILES tag can be used to specify one or more tagfiles.
 
1039
# The TAGFILES option can be used to specify one or more tagfiles. 
 
1040
# Optionally an initial location of the external documentation 
 
1041
# can be added for each tagfile. The format of a tag file without 
 
1042
# this location is as follows: 
 
1043
#   TAGFILES = file1 file2 ... 
 
1044
# Adding location for the tag files is done as follows: 
 
1045
#   TAGFILES = file1=loc1 "file2 = loc2" ... 
 
1046
# where "loc1" and "loc2" can be relative or absolute paths or 
 
1047
# URLs. If a location is present for each tag, the installdox tool 
 
1048
# does not have to be run to correct the links.
 
1049
# Note that each tag file must have a unique name
 
1050
# (where the name does NOT include the path)
 
1051
# If a tag file is not located in the directory in which doxygen 
 
1052
# is run, you must also specify the path to the tagfile here.
750
1053
 
751
1054
TAGFILES               = 
752
1055
 
777
1080
#---------------------------------------------------------------------------
778
1081
 
779
1082
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
780
 
# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or 
781
 
# super classes. Setting the tag to NO turns the diagrams off. Note that this 
782
 
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is 
783
 
# recommended to install and use dot, since it yield more powerful graphs.
 
1083
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
 
1084
# or super classes. Setting the tag to NO turns the diagrams off. Note that 
 
1085
# this option is superseded by the HAVE_DOT option below. This is only a 
 
1086
# fallback. It is recommended to install and use dot, since it yields more 
 
1087
# powerful graphs.
784
1088
 
785
1089
CLASS_DIAGRAMS         = NO
786
1090
 
 
1091
# If set to YES, the inheritance and collaboration graphs will hide 
 
1092
# inheritance and usage relations if the target is undocumented 
 
1093
# or is not a class.
 
1094
 
 
1095
HIDE_UNDOC_RELATIONS   = YES
 
1096
 
787
1097
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
788
1098
# available from the path. This tool is part of Graphviz, a graph visualization 
789
1099
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
805
1115
 
806
1116
COLLABORATION_GRAPH    = YES
807
1117
 
 
1118
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
 
1119
# will generate a graph for groups, showing the direct groups dependencies
 
1120
 
 
1121
GROUP_GRAPHS           = YES
 
1122
 
 
1123
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
 
1124
# collaboration diagrams in a style similar to the OMG's Unified Modeling 
 
1125
# Language.
 
1126
 
 
1127
UML_LOOK               = NO
 
1128
 
808
1129
# If set to YES, the inheritance and collaboration graphs will show the 
809
1130
# relations between templates and their instances.
810
1131
 
811
1132
TEMPLATE_RELATIONS     = YES
812
1133
 
813
 
# If set to YES, the inheritance and collaboration graphs will hide 
814
 
# inheritance and usage relations if the target is undocumented 
815
 
# or is not a class.
816
 
 
817
 
HIDE_UNDOC_RELATIONS   = YES
818
 
 
819
1134
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
820
1135
# tags are set to YES then doxygen will generate a graph for each documented 
821
1136
# file showing the direct and indirect include dependencies of the file with 
830
1145
 
831
1146
INCLUDED_BY_GRAPH      = YES
832
1147
 
 
1148
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
 
1149
# generate a call dependency graph for every global function or class method. 
 
1150
# Note that enabling this option will significantly increase the time of a run. 
 
1151
# So in most cases it will be better to enable call graphs for selected 
 
1152
# functions only using the \callgraph command.
 
1153
 
 
1154
CALL_GRAPH             = NO
 
1155
 
 
1156
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
 
1157
# generate a caller dependency graph for every global function or class method. 
 
1158
# Note that enabling this option will significantly increase the time of a run. 
 
1159
# So in most cases it will be better to enable caller graphs for selected 
 
1160
# functions only using the \callergraph command.
 
1161
 
 
1162
CALLER_GRAPH           = NO
 
1163
 
833
1164
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
834
1165
# will graphical hierarchy of all classes instead of a textual one.
835
1166
 
836
1167
GRAPHICAL_HIERARCHY    = YES
837
1168
 
 
1169
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
 
1170
# then doxygen will show the dependencies a directory has on other directories 
 
1171
# in a graphical way. The dependency relations are determined by the #include
 
1172
# relations between the files in the directories.
 
1173
 
 
1174
DIRECTORY_GRAPH        = YES
 
1175
 
838
1176
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
839
 
# generated by dot. Possible values are gif, jpg, and png
840
 
# If left blank gif will be used.
 
1177
# generated by dot. Possible values are png, jpg, or gif
 
1178
# If left blank png will be used.
841
1179
 
842
1180
DOT_IMAGE_FORMAT       = png
843
1181
 
844
1182
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
845
 
# found. If left blank, it is assumed the dot tool can be found on the path.
 
1183
# found. If left blank, it is assumed the dot tool can be found in the path.
846
1184
 
847
1185
DOT_PATH               = 
848
1186
 
868
1206
 
869
1207
MAX_DOT_GRAPH_HEIGHT   = 1024
870
1208
 
 
1209
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
 
1210
# graphs generated by dot. A depth value of 3 means that only nodes reachable 
 
1211
# from the root by following a path via at most 3 edges will be shown. Nodes 
 
1212
# that lay further from the root node will be omitted. Note that setting this 
 
1213
# option to 1 or 2 may greatly reduce the computation time needed for large 
 
1214
# code bases. Also note that a graph may be further truncated if the graph's 
 
1215
# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 
 
1216
# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 
 
1217
# the graph is not depth-constrained.
 
1218
 
 
1219
MAX_DOT_GRAPH_DEPTH    = 0
 
1220
 
 
1221
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
 
1222
# background. This is disabled by default, which results in a white background. 
 
1223
# Warning: Depending on the platform used, enabling this option may lead to 
 
1224
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
 
1225
# read).
 
1226
 
 
1227
DOT_TRANSPARENT        = NO
 
1228
 
 
1229
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
 
1230
# files in one run (i.e. multiple -o and -T options on the command line). This 
 
1231
# makes dot run faster, but since only newer versions of dot (>1.8.10) 
 
1232
# support this, this feature is disabled by default.
 
1233
 
 
1234
DOT_MULTI_TARGETS      = NO
 
1235
 
871
1236
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
872
1237
# generate a legend page explaining the meaning of the various boxes and 
873
1238
# arrows in the dot generated graphs.
875
1240
GENERATE_LEGEND        = YES
876
1241
 
877
1242
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
878
 
# remove the intermedate dot files that are used to generate 
 
1243
# remove the intermediate dot files that are used to generate 
879
1244
# the various graphs.
880
1245
 
881
1246
DOT_CLEANUP            = YES
882
1247
 
883
1248
#---------------------------------------------------------------------------
884
 
# Configuration::addtions related to the search engine   
 
1249
# Configuration::additions related to the search engine   
885
1250
#---------------------------------------------------------------------------
886
1251
 
887
1252
# The SEARCHENGINE tag specifies whether or not a search engine should be 
888
1253
# used. If set to NO the values of all tags below this one will be ignored.
889
1254
 
890
1255
SEARCHENGINE           = NO
891
 
 
892
 
# The CGI_NAME tag should be the name of the CGI script that 
893
 
# starts the search engine (doxysearch) with the correct parameters. 
894
 
# A script with this name will be generated by doxygen.
895
 
 
896
 
CGI_NAME               = search.cgi
897
 
 
898
 
# The CGI_URL tag should be the absolute URL to the directory where the 
899
 
# cgi binaries are located. See the documentation of your http daemon for 
900
 
# details.
901
 
 
902
 
CGI_URL                = 
903
 
 
904
 
# The DOC_URL tag should be the absolute URL to the directory where the 
905
 
# documentation is located. If left blank the absolute path to the 
906
 
# documentation, with file:// prepended to it, will be used.
907
 
 
908
 
DOC_URL                = 
909
 
 
910
 
# The DOC_ABSPATH tag should be the absolute path to the directory where the 
911
 
# documentation is located. If left blank the directory on the local machine 
912
 
# will be used.
913
 
 
914
 
DOC_ABSPATH            = 
915
 
 
916
 
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary 
917
 
# is installed.
918
 
 
919
 
BIN_ABSPATH            = /usr/local/bin/
920
 
 
921
 
# The EXT_DOC_PATHS tag can be used to specify one or more paths to 
922
 
# documentation generated for other projects. This allows doxysearch to search 
923
 
# the documentation for these projects as well.
924
 
 
925
 
EXT_DOC_PATHS          =