Subversion Repositories Games.Descent

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
1 pmbaty 1
# Doxyfile 1.3.4
2
 
3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
5
#
6
# All text after a hash (#) is considered a comment and will be ignored
7
# The format is:
8
#       TAG = value [value, ...]
9
# For lists items can also be appended using:
10
#       TAG += value [value, ...]
11
# Values that contain spaces should be placed between quotes (" ")
12
 
13
#---------------------------------------------------------------------------
14
# Project related configuration options
15
#---------------------------------------------------------------------------
16
 
17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
18
# by quotes) that should identify the project.
19
 
20
PROJECT_NAME           = physfs
21
 
22
# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
23
# This could be handy for archiving the generated documentation or 
24
# if some version control system is used.
25
 
26
# (CMake will set this properly at build time. --ryan.)
27
PROJECT_NUMBER         = "unknown version (build with 'make docs' next time!)"
28
 
29
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
30
# base path where the generated documentation will be put. 
31
# If a relative path is entered, it will be relative to the location 
32
# where doxygen was started. If left blank the current directory will be used.
33
 
34
OUTPUT_DIRECTORY       = docs
35
 
36
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
37
# documentation generated by doxygen is written. Doxygen will use this 
38
# information to generate all constant output in the proper language. 
39
# The default language is English, other supported languages are: 
40
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 
41
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 
42
# (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, 
43
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
44
 
45
OUTPUT_LANGUAGE        = English
46
 
47
# This tag can be used to specify the encoding used in the generated output. 
48
# The encoding is not always determined by the language that is chosen, 
49
# but also whether or not the output is meant for Windows or non-Windows users. 
50
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
51
# forces the Windows encoding (this is the default for the Windows binary), 
52
# whereas setting the tag to NO uses a Unix-style encoding (the default for 
53
# all platforms other than Windows).
54
 
55
USE_WINDOWS_ENCODING   = NO
56
 
57
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
58
# include brief member descriptions after the members that are listed in 
59
# the file and class documentation (similar to JavaDoc). 
60
# Set to NO to disable this.
61
 
62
BRIEF_MEMBER_DESC      = YES
63
 
64
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
65
# the brief description of a member or function before the detailed description. 
66
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
67
# brief descriptions will be completely suppressed.
68
 
69
REPEAT_BRIEF           = YES
70
 
71
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
72
# Doxygen will generate a detailed section even if there is only a brief 
73
# description.
74
 
75
ALWAYS_DETAILED_SEC    = NO
76
 
77
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 
78
# members of a class in the documentation of that class as if those members were 
79
# ordinary class members. Constructors, destructors and assignment operators of 
80
# the base classes will not be shown.
81
 
82
INLINE_INHERITED_MEMB  = NO
83
 
84
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
85
# path before files name in the file list and in the header files. If set 
86
# to NO the shortest path that makes the file name unique will be used.
87
 
88
FULL_PATH_NAMES        = NO
89
 
90
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
91
# can be used to strip a user-defined part of the path. Stripping is 
92
# only done if one of the specified strings matches the left-hand part of 
93
# the path. It is allowed to use relative paths in the argument list.
94
 
95
STRIP_FROM_PATH        = 
96
 
97
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
98
# (but less readable) file names. This can be useful is your file systems 
99
# doesn't support long names like on DOS, Mac, or CD-ROM.
100
 
101
SHORT_NAMES            = NO
102
 
103
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
104
# will interpret the first line (until the first dot) of a JavaDoc-style 
105
# comment as the brief description. If set to NO, the JavaDoc 
106
# comments will behave just like the Qt-style comments (thus requiring an 
107
# explict @brief command for a brief description.
108
 
109
JAVADOC_AUTOBRIEF      = NO
110
 
111
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
112
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
113
# comments) as a brief description. This used to be the default behaviour. 
114
# The new default is to treat a multi-line C++ comment block as a detailed 
115
# description. Set this tag to YES if you prefer the old behaviour instead.
116
 
117
MULTILINE_CPP_IS_BRIEF = NO
118
 
119
# If the DETAILS_AT_TOP tag is set to YES then Doxygen 
120
# will output the detailed description near the top, like JavaDoc.
121
# If set to NO, the detailed description appears after the member 
122
# documentation.
123
 
124
DETAILS_AT_TOP         = NO
125
 
126
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
127
# member inherits the documentation from any documented member that it 
128
# reimplements.
129
 
130
INHERIT_DOCS           = YES
131
 
132
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
133
# tag is set to YES, then doxygen will reuse the documentation of the first 
134
# member in the group (if any) for the other members of the group. By default 
135
# all members of a group must be documented explicitly.
136
 
137
DISTRIBUTE_GROUP_DOC   = NO
138
 
139
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
140
# Doxygen uses this value to replace tabs by spaces in code fragments.
141
 
142
TAB_SIZE               = 4
143
 
144
# This tag can be used to specify a number of aliases that acts 
145
# as commands in the documentation. An alias has the form "name=value". 
146
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
147
# put the command \sideeffect (or @sideeffect) in the documentation, which 
148
# will result in a user-defined paragraph with heading "Side Effects:". 
149
# You can put \n's in the value part of an alias to insert newlines.
150
 
151
ALIASES                = 
152
 
153
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
154
# only. Doxygen will then generate output that is more tailored for C. 
155
# For instance, some of the names that are used will be different. The list 
156
# of all members will be omitted, etc.
157
 
158
OPTIMIZE_OUTPUT_FOR_C  = YES
159
 
160
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 
161
# only. Doxygen will then generate output that is more tailored for Java. 
162
# For instance, namespaces will be presented as packages, qualified scopes 
163
# will look different, etc.
164
 
165
OPTIMIZE_OUTPUT_JAVA   = NO
166
 
167
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
168
# the same type (for instance a group of public functions) to be put as a 
169
# subgroup of that type (e.g. under the Public Functions section). Set it to 
170
# NO to prevent subgrouping. Alternatively, this can be done per class using 
171
# the \nosubgrouping command.
172
 
173
SUBGROUPING            = YES
174
 
175
#---------------------------------------------------------------------------
176
# Build related configuration options
177
#---------------------------------------------------------------------------
178
 
179
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
180
# documentation are documented, even if no documentation was available. 
181
# Private class members and static file members will be hidden unless 
182
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
183
 
184
EXTRACT_ALL            = NO
185
 
186
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
187
# will be included in the documentation.
188
 
189
EXTRACT_PRIVATE        = NO
190
 
191
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
192
# will be included in the documentation.
193
 
194
EXTRACT_STATIC         = NO
195
 
196
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
197
# defined locally in source files will be included in the documentation. 
198
# If set to NO only classes defined in header files are included.
199
 
200
EXTRACT_LOCAL_CLASSES  = NO
201
 
202
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
203
# undocumented members of documented classes, files or namespaces. 
204
# If set to NO (the default) these members will be included in the 
205
# various overviews, but no documentation section is generated. 
206
# This option has no effect if EXTRACT_ALL is enabled.
207
 
208
HIDE_UNDOC_MEMBERS     = NO
209
 
210
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
211
# undocumented classes that are normally visible in the class hierarchy. 
212
# If set to NO (the default) these classes will be included in the various 
213
# overviews. This option has no effect if EXTRACT_ALL is enabled.
214
 
215
HIDE_UNDOC_CLASSES     = NO
216
 
217
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
218
# friend (class|struct|union) declarations. 
219
# If set to NO (the default) these declarations will be included in the 
220
# documentation.
221
 
222
HIDE_FRIEND_COMPOUNDS  = NO
223
 
224
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
225
# documentation blocks found inside the body of a function. 
226
# If set to NO (the default) these blocks will be appended to the 
227
# function's detailed documentation block.
228
 
229
HIDE_IN_BODY_DOCS      = NO
230
 
231
# The INTERNAL_DOCS tag determines if documentation 
232
# that is typed after a \internal command is included. If the tag is set 
233
# to NO (the default) then the documentation will be excluded. 
234
# Set it to YES to include the internal documentation.
235
 
236
INTERNAL_DOCS          = NO
237
 
238
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
239
# file names in lower-case letters. If set to YES upper-case letters are also 
240
# allowed. This is useful if you have classes or files whose names only differ 
241
# in case and if your file system supports case sensitive file names. Windows 
242
# users are advised to set this option to NO.
243
 
244
CASE_SENSE_NAMES       = YES
245
 
246
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
247
# will show members with their full class and namespace scopes in the 
248
# documentation. If set to YES the scope will be hidden.
249
 
250
HIDE_SCOPE_NAMES       = NO
251
 
252
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
253
# will put a list of the files that are included by a file in the documentation 
254
# of that file.
255
 
256
SHOW_INCLUDE_FILES     = YES
257
 
258
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
259
# is inserted in the documentation for inline members.
260
 
261
INLINE_INFO            = YES
262
 
263
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
264
# will sort the (detailed) documentation of file and class members 
265
# alphabetically by member name. If set to NO the members will appear in 
266
# declaration order.
267
 
268
SORT_MEMBER_DOCS       = YES
269
 
270
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
271
# disable (NO) the todo list. This list is created by putting \todo 
272
# commands in the documentation.
273
 
274
GENERATE_TODOLIST      = YES
275
 
276
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
277
# disable (NO) the test list. This list is created by putting \test 
278
# commands in the documentation.
279
 
280
GENERATE_TESTLIST      = YES
281
 
282
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
283
# disable (NO) the bug list. This list is created by putting \bug 
284
# commands in the documentation.
285
 
286
GENERATE_BUGLIST       = YES
287
 
288
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
289
# disable (NO) the deprecated list. This list is created by putting 
290
# \deprecated commands in the documentation.
291
 
292
GENERATE_DEPRECATEDLIST= YES
293
 
294
# The ENABLED_SECTIONS tag can be used to enable conditional 
295
# documentation sections, marked by \if sectionname ... \endif.
296
 
297
ENABLED_SECTIONS       = 
298
 
299
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
300
# the initial value of a variable or define consists of for it to appear in 
301
# the documentation. If the initializer consists of more lines than specified 
302
# here it will be hidden. Use a value of 0 to hide initializers completely. 
303
# The appearance of the initializer of individual variables and defines in the 
304
# documentation can be controlled using \showinitializer or \hideinitializer 
305
# command in the documentation regardless of this setting.
306
 
307
MAX_INITIALIZER_LINES  = 30
308
 
309
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
310
# at the bottom of the documentation of classes and structs. If set to YES the 
311
# list will mention the files that were used to generate the documentation.
312
 
313
SHOW_USED_FILES        = YES
314
 
315
#---------------------------------------------------------------------------
316
# configuration options related to warning and progress messages
317
#---------------------------------------------------------------------------
318
 
319
# The QUIET tag can be used to turn on/off the messages that are generated 
320
# by doxygen. Possible values are YES and NO. If left blank NO is used.
321
 
322
QUIET                  = NO
323
 
324
# The WARNINGS tag can be used to turn on/off the warning messages that are 
325
# generated by doxygen. Possible values are YES and NO. If left blank 
326
# NO is used.
327
 
328
WARNINGS               = YES
329
 
330
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
331
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
332
# automatically be disabled.
333
 
334
WARN_IF_UNDOCUMENTED   = YES
335
 
336
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
337
# potential errors in the documentation, such as not documenting some 
338
# parameters in a documented function, or documenting parameters that 
339
# don't exist or using markup commands wrongly.
340
 
341
WARN_IF_DOC_ERROR      = YES
342
 
343
# The WARN_FORMAT tag determines the format of the warning messages that 
344
# doxygen can produce. The string should contain the $file, $line, and $text 
345
# tags, which will be replaced by the file and line number from which the 
346
# warning originated and the warning text.
347
 
348
WARN_FORMAT            = "$file:$line: $text"
349
 
350
# The WARN_LOGFILE tag can be used to specify a file to which warning 
351
# and error messages should be written. If left blank the output is written 
352
# to stderr.
353
 
354
WARN_LOGFILE           = 
355
 
356
#---------------------------------------------------------------------------
357
# configuration options related to the input files
358
#---------------------------------------------------------------------------
359
 
360
# The INPUT tag can be used to specify the files and/or directories that contain 
361
# documented source files. You may enter file names like "myfile.cpp" or 
362
# directories like "/usr/src/myproject". Separate the files or directories 
363
# with spaces.
364
 
365
INPUT                  = src/physfs.h
366
 
367
# If the value of the INPUT tag contains directories, you can use the 
368
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
369
# and *.h) to filter out the source-files in the directories. If left 
370
# blank the following patterns are tested: 
371
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
372
# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
373
 
374
FILE_PATTERNS          = 
375
 
376
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
377
# should be searched for input files as well. Possible values are YES and NO. 
378
# If left blank NO is used.
379
 
380
RECURSIVE              = NO
381
 
382
# The EXCLUDE tag can be used to specify files and/or directories that should 
383
# excluded from the INPUT source files. This way you can easily exclude a 
384
# subdirectory from a directory tree whose root is specified with the INPUT tag.
385
 
386
EXCLUDE                = 
387
 
388
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 
389
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
390
 
391
EXCLUDE_SYMLINKS       = NO
392
 
393
# If the value of the INPUT tag contains directories, you can use the 
394
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
395
# certain files from those directories.
396
 
397
EXCLUDE_PATTERNS       = 
398
 
399
# The EXAMPLE_PATH tag can be used to specify one or more files or 
400
# directories that contain example code fragments that are included (see 
401
# the \include command).
402
 
403
EXAMPLE_PATH           = 
404
 
405
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
406
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
407
# and *.h) to filter out the source-files in the directories. If left 
408
# blank all files are included.
409
 
410
EXAMPLE_PATTERNS       = 
411
 
412
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
413
# searched for input files to be used with the \include or \dontinclude 
414
# commands irrespective of the value of the RECURSIVE tag. 
415
# Possible values are YES and NO. If left blank NO is used.
416
 
417
EXAMPLE_RECURSIVE      = NO
418
 
419
# The IMAGE_PATH tag can be used to specify one or more files or 
420
# directories that contain image that are included in the documentation (see 
421
# the \image command).
422
 
423
IMAGE_PATH             = 
424
 
425
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
426
# invoke to filter for each input file. Doxygen will invoke the filter program 
427
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
428
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
429
# input file. Doxygen will then use the output that the filter program writes 
430
# to standard output.
431
 
432
INPUT_FILTER           = 
433
 
434
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
435
# INPUT_FILTER) will be used to filter the input files when producing source 
436
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
437
 
438
FILTER_SOURCE_FILES    = NO
439
 
440
#---------------------------------------------------------------------------
441
# configuration options related to source browsing
442
#---------------------------------------------------------------------------
443
 
444
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
445
# be generated. Documented entities will be cross-referenced with these sources.
446
 
447
SOURCE_BROWSER         = NO
448
 
449
# Setting the INLINE_SOURCES tag to YES will include the body 
450
# of functions and classes directly in the documentation.
451
 
452
INLINE_SOURCES         = NO
453
 
454
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
455
# doxygen to hide any special comment blocks from generated source code 
456
# fragments. Normal C and C++ comments will always remain visible.
457
 
458
STRIP_CODE_COMMENTS    = YES
459
 
460
# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
461
# then for each documented function all documented 
462
# functions referencing it will be listed.
463
 
464
REFERENCED_BY_RELATION = YES
465
 
466
# If the REFERENCES_RELATION tag is set to YES (the default) 
467
# then for each documented function all documented entities 
468
# called/used by that function will be listed.
469
 
470
REFERENCES_RELATION    = YES
471
 
472
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
473
# will generate a verbatim copy of the header file for each class for 
474
# which an include is specified. Set to NO to disable this.
475
 
476
VERBATIM_HEADERS       = YES
477
 
478
#---------------------------------------------------------------------------
479
# configuration options related to the alphabetical class index
480
#---------------------------------------------------------------------------
481
 
482
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
483
# of all compounds will be generated. Enable this if the project 
484
# contains a lot of classes, structs, unions or interfaces.
485
 
486
ALPHABETICAL_INDEX     = NO
487
 
488
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
489
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
490
# in which this list will be split (can be a number in the range [1..20])
491
 
492
COLS_IN_ALPHA_INDEX    = 5
493
 
494
# In case all classes in a project start with a common prefix, all 
495
# classes will be put under the same header in the alphabetical index. 
496
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
497
# should be ignored while generating the index headers.
498
 
499
IGNORE_PREFIX          = 
500
 
501
#---------------------------------------------------------------------------
502
# configuration options related to the HTML output
503
#---------------------------------------------------------------------------
504
 
505
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
506
# generate HTML output.
507
 
508
GENERATE_HTML          = YES
509
 
510
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
511
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
512
# put in front of it. If left blank `html' will be used as the default path.
513
 
514
HTML_OUTPUT            = html
515
 
516
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
517
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
518
# doxygen will generate files with .html extension.
519
 
520
HTML_FILE_EXTENSION    = .html
521
 
522
# The HTML_HEADER tag can be used to specify a personal HTML header for 
523
# each generated HTML page. If it is left blank doxygen will generate a 
524
# standard header.
525
 
526
HTML_HEADER            = 
527
 
528
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
529
# each generated HTML page. If it is left blank doxygen will generate a 
530
# standard footer.
531
 
532
HTML_FOOTER            = 
533
 
534
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
535
# style sheet that is used by each HTML page. It can be used to 
536
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
537
# will generate a default style sheet
538
 
539
HTML_STYLESHEET        = 
540
 
541
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
542
# files or namespaces will be aligned in HTML using tables. If set to 
543
# NO a bullet list will be used.
544
 
545
HTML_ALIGN_MEMBERS     = YES
546
 
547
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
548
# will be generated that can be used as input for tools like the 
549
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
550
# of the generated HTML documentation.
551
 
552
GENERATE_HTMLHELP      = NO
553
 
554
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
555
# be used to specify the file name of the resulting .chm file. You 
556
# can add a path in front of the file if the result should not be 
557
# written to the html output dir.
558
 
559
CHM_FILE               = 
560
 
561
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
562
# be used to specify the location (absolute path including file name) of 
563
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
564
# the HTML help compiler on the generated index.hhp.
565
 
566
HHC_LOCATION           = 
567
 
568
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
569
# controls if a separate .chi index file is generated (YES) or that 
570
# it should be included in the master .chm file (NO).
571
 
572
GENERATE_CHI           = NO
573
 
574
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
575
# controls whether a binary table of contents is generated (YES) or a 
576
# normal table of contents (NO) in the .chm file.
577
 
578
BINARY_TOC             = NO
579
 
580
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
581
# to the contents of the HTML help documentation and to the tree view.
582
 
583
TOC_EXPAND             = NO
584
 
585
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
586
# top of each HTML page. The value NO (the default) enables the index and 
587
# the value YES disables it.
588
 
589
DISABLE_INDEX          = NO
590
 
591
# This tag can be used to set the number of enum values (range [1..20]) 
592
# that doxygen will group on one line in the generated HTML documentation.
593
 
594
ENUM_VALUES_PER_LINE   = 4
595
 
596
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
597
# generated containing a tree-like index structure (just like the one that 
598
# is generated for HTML Help). For this to work a browser that supports 
599
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
600
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
601
# probably better off using the HTML help feature.
602
 
603
GENERATE_TREEVIEW      = NO
604
 
605
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
606
# used to set the initial width (in pixels) of the frame in which the tree 
607
# is shown.
608
 
609
TREEVIEW_WIDTH         = 250
610
 
611
#---------------------------------------------------------------------------
612
# configuration options related to the LaTeX output
613
#---------------------------------------------------------------------------
614
 
615
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
616
# generate Latex output.
617
 
618
GENERATE_LATEX         = YES
619
 
620
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
621
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
622
# put in front of it. If left blank `latex' will be used as the default path.
623
 
624
LATEX_OUTPUT           = latex
625
 
626
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
627
# invoked. If left blank `latex' will be used as the default command name.
628
 
629
LATEX_CMD_NAME         = latex
630
 
631
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
632
# generate index for LaTeX. If left blank `makeindex' will be used as the 
633
# default command name.
634
 
635
MAKEINDEX_CMD_NAME     = makeindex
636
 
637
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
638
# LaTeX documents. This may be useful for small projects and may help to 
639
# save some trees in general.
640
 
641
COMPACT_LATEX          = NO
642
 
643
# The PAPER_TYPE tag can be used to set the paper type that is used 
644
# by the printer. Possible values are: a4, a4wide, letter, legal and 
645
# executive. If left blank a4wide will be used.
646
 
647
PAPER_TYPE             = a4wide
648
 
649
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
650
# packages that should be included in the LaTeX output.
651
 
652
EXTRA_PACKAGES         = 
653
 
654
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
655
# the generated latex document. The header should contain everything until 
656
# the first chapter. If it is left blank doxygen will generate a 
657
# standard header. Notice: only use this tag if you know what you are doing!
658
 
659
LATEX_HEADER           = 
660
 
661
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
662
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
663
# contain links (just like the HTML output) instead of page references 
664
# This makes the output suitable for online browsing using a pdf viewer.
665
 
666
PDF_HYPERLINKS         = NO
667
 
668
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
669
# plain latex in the generated Makefile. Set this option to YES to get a 
670
# higher quality PDF documentation.
671
 
672
USE_PDFLATEX           = NO
673
 
674
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
675
# command to the generated LaTeX files. This will instruct LaTeX to keep 
676
# running if errors occur, instead of asking the user for help. 
677
# This option is also used when generating formulas in HTML.
678
 
679
LATEX_BATCHMODE        = NO
680
 
681
# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
682
# include the index chapters (such as File Index, Compound Index, etc.) 
683
# in the output.
684
 
685
LATEX_HIDE_INDICES     = NO
686
 
687
#---------------------------------------------------------------------------
688
# configuration options related to the RTF output
689
#---------------------------------------------------------------------------
690
 
691
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
692
# The RTF output is optimised for Word 97 and may not look very pretty with 
693
# other RTF readers or editors.
694
 
695
GENERATE_RTF           = NO
696
 
697
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
698
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
699
# put in front of it. If left blank `rtf' will be used as the default path.
700
 
701
RTF_OUTPUT             = rtf
702
 
703
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
704
# RTF documents. This may be useful for small projects and may help to 
705
# save some trees in general.
706
 
707
COMPACT_RTF            = NO
708
 
709
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
710
# will contain hyperlink fields. The RTF file will 
711
# contain links (just like the HTML output) instead of page references. 
712
# This makes the output suitable for online browsing using WORD or other 
713
# programs which support those fields. 
714
# Note: wordpad (write) and others do not support links.
715
 
716
RTF_HYPERLINKS         = NO
717
 
718
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
719
# config file, i.e. a series of assigments. You only have to provide 
720
# replacements, missing definitions are set to their default value.
721
 
722
RTF_STYLESHEET_FILE    = 
723
 
724
# Set optional variables used in the generation of an rtf document. 
725
# Syntax is similar to doxygen's config file.
726
 
727
RTF_EXTENSIONS_FILE    = 
728
 
729
#---------------------------------------------------------------------------
730
# configuration options related to the man page output
731
#---------------------------------------------------------------------------
732
 
733
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
734
# generate man pages
735
 
736
GENERATE_MAN           = YES
737
 
738
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
739
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
740
# put in front of it. If left blank `man' will be used as the default path.
741
 
742
MAN_OUTPUT             = man
743
 
744
# The MAN_EXTENSION tag determines the extension that is added to 
745
# the generated man pages (default is the subroutine's section .3)
746
 
747
MAN_EXTENSION          = .3
748
 
749
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
750
# then it will generate one additional man file for each entity 
751
# documented in the real man page(s). These additional files 
752
# only source the real man page, but without them the man command 
753
# would be unable to find the correct page. The default is NO.
754
 
755
MAN_LINKS              = YES
756
 
757
#---------------------------------------------------------------------------
758
# configuration options related to the XML output
759
#---------------------------------------------------------------------------
760
 
761
# If the GENERATE_XML tag is set to YES Doxygen will 
762
# generate an XML file that captures the structure of 
763
# the code including all documentation. Note that this 
764
# feature is still experimental and incomplete at the 
765
# moment.
766
 
767
GENERATE_XML           = NO
768
 
769
# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
770
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
771
# put in front of it. If left blank `xml' will be used as the default path.
772
 
773
XML_OUTPUT             = xml
774
 
775
# The XML_SCHEMA tag can be used to specify an XML schema, 
776
# which can be used by a validating XML parser to check the 
777
# syntax of the XML files.
778
 
779
XML_SCHEMA             = 
780
 
781
# The XML_DTD tag can be used to specify an XML DTD, 
782
# which can be used by a validating XML parser to check the 
783
# syntax of the XML files.
784
 
785
XML_DTD                = 
786
 
787
#---------------------------------------------------------------------------
788
# configuration options for the AutoGen Definitions output
789
#---------------------------------------------------------------------------
790
 
791
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
792
# generate an AutoGen Definitions (see autogen.sf.net) file 
793
# that captures the structure of the code including all 
794
# documentation. Note that this feature is still experimental 
795
# and incomplete at the moment.
796
 
797
GENERATE_AUTOGEN_DEF   = NO
798
 
799
#---------------------------------------------------------------------------
800
# configuration options related to the Perl module output
801
#---------------------------------------------------------------------------
802
 
803
# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
804
# generate a Perl module file that captures the structure of 
805
# the code including all documentation. Note that this 
806
# feature is still experimental and incomplete at the 
807
# moment.
808
 
809
GENERATE_PERLMOD       = NO
810
 
811
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
812
# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
813
# to generate PDF and DVI output from the Perl module output.
814
 
815
PERLMOD_LATEX          = NO
816
 
817
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
818
# nicely formatted so it can be parsed by a human reader.  This is useful 
819
# if you want to understand what is going on.  On the other hand, if this 
820
# tag is set to NO the size of the Perl module output will be much smaller 
821
# and Perl will parse it just the same.
822
 
823
PERLMOD_PRETTY         = YES
824
 
825
# The names of the make variables in the generated doxyrules.make file 
826
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
827
# This is useful so different doxyrules.make files included by the same 
828
# Makefile don't overwrite each other's variables.
829
 
830
PERLMOD_MAKEVAR_PREFIX = 
831
 
832
#---------------------------------------------------------------------------
833
# Configuration options related to the preprocessor   
834
#---------------------------------------------------------------------------
835
 
836
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
837
# evaluate all C-preprocessor directives found in the sources and include 
838
# files.
839
 
840
ENABLE_PREPROCESSING   = YES
841
 
842
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
843
# names in the source code. If set to NO (the default) only conditional 
844
# compilation will be performed. Macro expansion can be done in a controlled 
845
# way by setting EXPAND_ONLY_PREDEF to YES.
846
 
847
MACRO_EXPANSION        = YES
848
 
849
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
850
# then the macro expansion is limited to the macros specified with the 
851
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
852
 
853
EXPAND_ONLY_PREDEF     = YES
854
 
855
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
856
# in the INCLUDE_PATH (see below) will be search if a #include is found.
857
 
858
SEARCH_INCLUDES        = YES
859
 
860
# The INCLUDE_PATH tag can be used to specify one or more directories that 
861
# contain include files that are not input files but should be processed by 
862
# the preprocessor.
863
 
864
INCLUDE_PATH           = 
865
 
866
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
867
# patterns (like *.h and *.hpp) to filter out the header-files in the 
868
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
869
# be used.
870
 
871
INCLUDE_FILE_PATTERNS  = 
872
 
873
# The PREDEFINED tag can be used to specify one or more macro names that 
874
# are defined before the preprocessor is started (similar to the -D option of 
875
# gcc). The argument of the tag is a list of macros of the form: name 
876
# or name=definition (no spaces). If the definition and the = are 
877
# omitted =1 is assumed.
878
 
879
PREDEFINED             = DOXYGEN_SHOULD_IGNORE_THIS=1 \
880
                         PHYSFS_DECL= \
881
                         PHYSFS_DEPRECATED=
882
 
883
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
884
# this tag can be used to specify a list of macro names that should be expanded. 
885
# The macro definition that is found in the sources will be used. 
886
# Use the PREDEFINED tag if you want to use a different macro definition.
887
 
888
EXPAND_AS_DEFINED      = 
889
 
890
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
891
# doxygen's preprocessor will remove all function-like macros that are alone 
892
# on a line, have an all uppercase name, and do not end with a semicolon. Such 
893
# function macros are typically used for boiler-plate code, and will confuse the 
894
# parser if not removed.
895
 
896
SKIP_FUNCTION_MACROS   = YES
897
 
898
#---------------------------------------------------------------------------
899
# Configuration::addtions related to external references   
900
#---------------------------------------------------------------------------
901
 
902
# The TAGFILES option can be used to specify one or more tagfiles. 
903
# Optionally an initial location of the external documentation 
904
# can be added for each tagfile. The format of a tag file without 
905
# this location is as follows: 
906
#   TAGFILES = file1 file2 ... 
907
# Adding location for the tag files is done as follows: 
908
#   TAGFILES = file1=loc1 "file2 = loc2" ... 
909
# where "loc1" and "loc2" can be relative or absolute paths or 
910
# URLs. If a location is present for each tag, the installdox tool 
911
# does not have to be run to correct the links.
912
# Note that each tag file must have a unique name
913
# (where the name does NOT include the path)
914
# If a tag file is not located in the directory in which doxygen 
915
# is run, you must also specify the path to the tagfile here.
916
 
917
TAGFILES               = 
918
 
919
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
920
# a tag file that is based on the input files it reads.
921
 
922
GENERATE_TAGFILE       = 
923
 
924
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
925
# in the class index. If set to NO only the inherited external classes 
926
# will be listed.
927
 
928
ALLEXTERNALS           = NO
929
 
930
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
931
# in the modules index. If set to NO, only the current project's groups will 
932
# be listed.
933
 
934
EXTERNAL_GROUPS        = YES
935
 
936
# The PERL_PATH should be the absolute path and name of the perl script 
937
# interpreter (i.e. the result of `which perl').
938
 
939
PERL_PATH              = /usr/bin/perl
940
 
941
#---------------------------------------------------------------------------
942
# Configuration options related to the dot tool   
943
#---------------------------------------------------------------------------
944
 
945
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
946
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or 
947
# super classes. Setting the tag to NO turns the diagrams off. Note that this 
948
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is 
949
# recommended to install and use dot, since it yields more powerful graphs.
950
 
951
CLASS_DIAGRAMS         = NO
952
 
953
# If set to YES, the inheritance and collaboration graphs will hide 
954
# inheritance and usage relations if the target is undocumented 
955
# or is not a class.
956
 
957
HIDE_UNDOC_RELATIONS   = YES
958
 
959
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
960
# available from the path. This tool is part of Graphviz, a graph visualization 
961
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
962
# have no effect if this option is set to NO (the default)
963
 
964
HAVE_DOT               = NO
965
 
966
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
967
# will generate a graph for each documented class showing the direct and 
968
# indirect inheritance relations. Setting this tag to YES will force the 
969
# the CLASS_DIAGRAMS tag to NO.
970
 
971
CLASS_GRAPH            = NO
972
 
973
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
974
# will generate a graph for each documented class showing the direct and 
975
# indirect implementation dependencies (inheritance, containment, and 
976
# class references variables) of the class with other documented classes.
977
 
978
COLLABORATION_GRAPH    = NO
979
 
980
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
981
# collaboration diagrams in a style similiar to the OMG's Unified Modeling 
982
# Language.
983
 
984
UML_LOOK               = NO
985
 
986
# If set to YES, the inheritance and collaboration graphs will show the 
987
# relations between templates and their instances.
988
 
989
TEMPLATE_RELATIONS     = NO
990
 
991
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
992
# tags are set to YES then doxygen will generate a graph for each documented 
993
# file showing the direct and indirect include dependencies of the file with 
994
# other documented files.
995
 
996
INCLUDE_GRAPH          = NO
997
 
998
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
999
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1000
# documented header file showing the documented files that directly or 
1001
# indirectly include this file.
1002
 
1003
INCLUDED_BY_GRAPH      = YES
1004
 
1005
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
1006
# generate a call dependency graph for every global function or class method. 
1007
# Note that enabling this option will significantly increase the time of a run. 
1008
# So in most cases it will be better to enable call graphs for selected 
1009
# functions only using the \callgraph command.
1010
 
1011
CALL_GRAPH             = NO
1012
 
1013
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1014
# will graphical hierarchy of all classes instead of a textual one.
1015
 
1016
GRAPHICAL_HIERARCHY    = YES
1017
 
1018
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1019
# generated by dot. Possible values are png, jpg, or gif
1020
# If left blank png will be used.
1021
 
1022
DOT_IMAGE_FORMAT       = png
1023
 
1024
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
1025
# found. If left blank, it is assumed the dot tool can be found on the path.
1026
 
1027
DOT_PATH               = 
1028
 
1029
# The DOTFILE_DIRS tag can be used to specify one or more directories that 
1030
# contain dot files that are included in the documentation (see the 
1031
# \dotfile command).
1032
 
1033
DOTFILE_DIRS           = 
1034
 
1035
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
1036
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
1037
# this value, doxygen will try to truncate the graph, so that it fits within 
1038
# the specified constraint. Beware that most browsers cannot cope with very 
1039
# large images.
1040
 
1041
MAX_DOT_GRAPH_WIDTH    = 1024
1042
 
1043
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
1044
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
1045
# this value, doxygen will try to truncate the graph, so that it fits within 
1046
# the specified constraint. Beware that most browsers cannot cope with very 
1047
# large images.
1048
 
1049
MAX_DOT_GRAPH_HEIGHT   = 1024
1050
 
1051
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1052
# graphs generated by dot. A depth value of 3 means that only nodes reachable 
1053
# from the root by following a path via at most 3 edges will be shown. Nodes that 
1054
# lay further from the root node will be omitted. Note that setting this option to 
1055
# 1 or 2 may greatly reduce the computation time needed for large code bases. Also 
1056
# note that a graph may be further truncated if the graph's image dimensions are 
1057
# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). 
1058
# If 0 is used for the depth value (the default), the graph is not depth-constrained.
1059
 
1060
MAX_DOT_GRAPH_DEPTH    = 0
1061
 
1062
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1063
# generate a legend page explaining the meaning of the various boxes and 
1064
# arrows in the dot generated graphs.
1065
 
1066
GENERATE_LEGEND        = YES
1067
 
1068
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1069
# remove the intermediate dot files that are used to generate 
1070
# the various graphs.
1071
 
1072
DOT_CLEANUP            = YES
1073
 
1074
#---------------------------------------------------------------------------
1075
# Configuration::addtions related to the search engine   
1076
#---------------------------------------------------------------------------
1077
 
1078
# The SEARCHENGINE tag specifies whether or not a search engine should be 
1079
# used. If set to NO the values of all tags below this one will be ignored.
1080
 
1081
SEARCHENGINE           = NO