~ubuntu-branches/ubuntu/karmic/psicode/karmic

« back to all changes in this revision

Viewing changes to misc/psi3.dox

  • Committer: Bazaar Package Importer
  • Author(s): Michael Banck, Michael Banck, Daniel Leidert
  • Date: 2009-02-23 00:12:02 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090223001202-rutldoy3dimfpesc
Tags: 3.4.0-1
* New upstream release.

[ Michael Banck ]
* debian/patches/01_DESTDIR.dpatch: Refreshed.
* debian/patches/02_FHS.dpatch: Removed, applied upstream.
* debian/patches/03_debian_docdir: Likewise.
* debian/patches/04_man.dpatch: Likewise.
* debian/patches/06_466828_fix_gcc_43_ftbfs.dpatch: Likewise.
* debian/patches/07_464867_move_executables: Fixed and refreshed.
* debian/patches/00list: Adjusted.
* debian/control: Improved description.
* debian/patches-held: Removed.
* debian/rules (install/psi3): Do not ship the ruby bindings for now.

[ Daniel Leidert ]
* debian/rules: Fix txtdir via DEB_MAKE_INSTALL_TARGET.
* debian/patches/01_DESTDIR.dpatch: Refreshed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Doxyfile 1.2.5
2
 
 
3
 
# This file describes the settings to be used by doxygen for a project
4
 
#
5
 
# All text after a hash (#) is considered a comment and will be ignored
6
 
# The format is:
7
 
#       TAG = value [value, ...]
8
 
# For lists items can also be appended using:
9
 
#       TAG += value [value, ...]
10
 
# Values that contain spaces should be placed between quotes (" ")
11
 
 
12
 
#---------------------------------------------------------------------------
13
 
# General configuration options
14
 
#---------------------------------------------------------------------------
15
 
 
16
 
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
17
 
# by quotes) that should identify the project. 
18
 
 
19
 
PROJECT_NAME           =  PSI
20
 
 
21
 
# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
22
 
# This could be handy for archiving the generated documentation or 
23
 
# if some version control system is used.
24
 
 
25
 
PROJECT_NUMBER         = 3.3
26
 
 
27
 
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
28
 
# base path where the generated documentation will be put. 
29
 
# If a relative path is entered, it will be relative to the location 
30
 
# where doxygen was started. If left blank the current directory will be used.
31
 
 
32
 
OUTPUT_DIRECTORY       = doxygen
33
 
 
34
 
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
35
 
# documentation generated by doxygen is written. Doxygen will use this 
36
 
# information to generate all constant output in the proper language. 
37
 
# The default language is English, other supported languages are: 
38
 
# Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese, 
39
 
# Korean, Hungarian, Norwegian, Spanish, Romanian, Russian, Croatian, 
40
 
# Polish, Portuguese and Slovene.
41
 
 
42
 
OUTPUT_LANGUAGE        = English
43
 
 
44
 
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
45
 
# documentation are documented, even if no documentation was available. 
46
 
# Private class members and static file members will be hidden unless 
47
 
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 
48
 
 
49
 
EXTRACT_ALL            = NO
50
 
 
51
 
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
52
 
# will be included in the documentation. 
53
 
 
54
 
EXTRACT_PRIVATE        = NO
55
 
 
56
 
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
57
 
# will be included in the documentation. 
58
 
 
59
 
EXTRACT_STATIC         = NO
60
 
 
61
 
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
62
 
# undocumented members of documented classes, files or namespaces. 
63
 
# If set to NO (the default) these members will be included in the 
64
 
# various overviews, but no documentation section is generated. 
65
 
# This option has no effect if EXTRACT_ALL is enabled. 
66
 
 
67
 
HIDE_UNDOC_MEMBERS     = NO
68
 
 
69
 
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
70
 
# undocumented classes that are normally visible in the class hierarchy. 
71
 
# If set to NO (the default) these class will be included in the various 
72
 
# overviews. This option has no effect if EXTRACT_ALL is enabled. 
73
 
 
74
 
HIDE_UNDOC_CLASSES     = NO
75
 
 
76
 
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
77
 
# include brief member descriptions after the members that are listed in 
78
 
# the file and class documentation (similar to JavaDoc). 
79
 
# Set to NO to disable this. 
80
 
 
81
 
BRIEF_MEMBER_DESC      = YES
82
 
 
83
 
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
84
 
# the brief description of a member or function before the detailed description. 
85
 
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
86
 
# brief descriptions will be completely suppressed. 
87
 
 
88
 
REPEAT_BRIEF           = YES
89
 
 
90
 
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
91
 
# Doxygen will generate a detailed section even if there is only a brief 
92
 
# description. 
93
 
 
94
 
ALWAYS_DETAILED_SEC    = NO
95
 
 
96
 
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
97
 
# path before files name in the file list and in the header files. If set 
98
 
# to NO the shortest path that makes the file name unique will be used. 
99
 
 
100
 
FULL_PATH_NAMES        = NO
101
 
 
102
 
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
103
 
# can be used to strip a user defined part of the path. Stripping is 
104
 
# only done if one of the specified strings matches the left-hand part of 
105
 
# the path. It is allowed to use relative paths in the argument list.
106
 
 
107
 
STRIP_FROM_PATH        = 
108
 
 
109
 
# The INTERNAL_DOCS tag determines if documentation 
110
 
# that is typed after a \internal command is included. If the tag is set 
111
 
# to NO (the default) then the documentation will be excluded. 
112
 
# Set it to YES to include the internal documentation. 
113
 
 
114
 
INTERNAL_DOCS          = NO
115
 
 
116
 
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
117
 
# generate a class diagram (in Html and LaTeX) for classes with base or 
118
 
# super classes. Setting the tag to NO turns the diagrams off. 
119
 
 
120
 
CLASS_DIAGRAMS         = YES
121
 
 
122
 
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
123
 
# be generated. Documented entities will be cross-referenced with these sources. 
124
 
 
125
 
SOURCE_BROWSER         = NO
126
 
 
127
 
# Setting the INLINE_SOURCES tag to YES will include the body 
128
 
# of functions and classes directly in the documentation. 
129
 
 
130
 
INLINE_SOURCES         = NO
131
 
 
132
 
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
133
 
# doxygen to hide any special comment blocks from generated source code 
134
 
# fragments. Normal C and C++ comments will always remain visible. 
135
 
 
136
 
STRIP_CODE_COMMENTS    = YES
137
 
 
138
 
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
139
 
# file names in lower case letters. If set to YES upper case letters are also 
140
 
# allowed. This is useful if you have classes or files whose names only differ 
141
 
# in case and if your file system supports case sensitive file names. Windows 
142
 
# users are adviced to set this option to NO.
143
 
 
144
 
CASE_SENSE_NAMES       = YES
145
 
 
146
 
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
147
 
# will show members with their full class and namespace scopes in the 
148
 
# documentation. If set to YES the scope will be hidden. 
149
 
 
150
 
HIDE_SCOPE_NAMES       = NO
151
 
 
152
 
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
153
 
# will generate a verbatim copy of the header file for each class for 
154
 
# which an include is specified. Set to NO to disable this. 
155
 
 
156
 
VERBATIM_HEADERS       = YES
157
 
 
158
 
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
159
 
# will put list of the files that are included by a file in the documentation 
160
 
# of that file. 
161
 
 
162
 
SHOW_INCLUDE_FILES     = YES
163
 
 
164
 
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
165
 
# will interpret the first line (until the first dot) of a JavaDoc-style 
166
 
# comment as the brief description. If set to NO, the JavaDoc 
167
 
# comments  will behave just like the Qt-style comments (thus requiring an 
168
 
# explict @brief command for a brief description. 
169
 
 
170
 
JAVADOC_AUTOBRIEF      = NO
171
 
 
172
 
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
173
 
# member inherits the documentation from any documented member that it 
174
 
# reimplements. 
175
 
 
176
 
INHERIT_DOCS           = YES
177
 
 
178
 
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
179
 
# is inserted in the documentation for inline members. 
180
 
 
181
 
INLINE_INFO            = YES
182
 
 
183
 
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
184
 
# will sort the (detailed) documentation of file and class members 
185
 
# alphabetically by member name. If set to NO the members will appear in 
186
 
# declaration order. 
187
 
 
188
 
SORT_MEMBER_DOCS       = YES
189
 
 
190
 
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
191
 
# tag is set to YES, then doxygen will reuse the documentation of the first 
192
 
# member in the group (if any) for the other members of the group. By default 
193
 
# all members of a group must be documented explicitly.
194
 
 
195
 
DISTRIBUTE_GROUP_DOC   = NO
196
 
 
197
 
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
198
 
# Doxygen uses this value to replace tabs by spaces in code fragments. 
199
 
 
200
 
TAB_SIZE               = 8
201
 
 
202
 
# The ENABLE_SECTIONS tag can be used to enable conditional 
203
 
# documentation sections, marked by \if sectionname ... \endif. 
204
 
 
205
 
ENABLED_SECTIONS       = 
206
 
 
207
 
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
208
 
# disable (NO) the todo list. This list is created by putting \todo 
209
 
# commands in the documentation.
210
 
 
211
 
GENERATE_TODOLIST      = YES
212
 
 
213
 
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
214
 
# disable (NO) the test list. This list is created by putting \test 
215
 
# commands in the documentation.
216
 
 
217
 
GENERATE_TESTLIST      = YES
218
 
 
219
 
# This tag can be used to specify a number of aliases that acts 
220
 
# as commands in the documentation. An alias has the form "name=value". 
221
 
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
222
 
# put the command \sideeffect (or @sideeffect) in the documentation, which 
223
 
# will result in a user defined paragraph with heading "Side Effects:". 
224
 
# You can put \n's in the value part of an alias to insert newlines. 
225
 
 
226
 
ALIASES                = 
227
 
 
228
 
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
229
 
# the initial value of a variable or define consist of for it to appear in 
230
 
# the documentation. If the initializer consists of more lines than specified 
231
 
# here it will be hidden. Use a value of 0 to hide initializers completely. 
232
 
# The appearance of the initializer of individual variables and defines in the 
233
 
# documentation can be controlled using \showinitializer or \hideinitializer 
234
 
# command in the documentation regardless of this setting. 
235
 
 
236
 
MAX_INITIALIZER_LINES  = 30
237
 
 
238
 
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
239
 
# only. Doxygen will then generate output that is more tailored for C. 
240
 
# For instance some of the names that are used will be different. The list 
241
 
# of all members will be omitted, etc. 
242
 
 
243
 
OPTIMIZE_OUTPUT_FOR_C  = YES
244
 
 
245
 
#---------------------------------------------------------------------------
246
 
# configuration options related to warning and progress messages
247
 
#---------------------------------------------------------------------------
248
 
 
249
 
# The QUIET tag can be used to turn on/off the messages that are generated 
250
 
# by doxygen. Possible values are YES and NO. If left blank NO is used. 
251
 
 
252
 
QUIET                  = NO
253
 
 
254
 
# The WARNINGS tag can be used to turn on/off the warning messages that are 
255
 
# generated by doxygen. Possible values are YES and NO. If left blank 
256
 
# NO is used. 
257
 
 
258
 
WARNINGS               = YES
259
 
 
260
 
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
261
 
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
262
 
# automatically be disabled. 
263
 
 
264
 
WARN_IF_UNDOCUMENTED   = YES
265
 
 
266
 
# The WARN_FORMAT tag determines the format of the warning messages that 
267
 
# doxygen can produce. The string should contain the $file, $line, and $text 
268
 
# tags, which will be replaced by the file and line number from which the 
269
 
# warning originated and the warning text. 
270
 
 
271
 
WARN_FORMAT            = "$file:$line: $text"
272
 
 
273
 
# The WARN_LOGFILE tag can be used to specify a file to which warning 
274
 
# and error messages should be written. If left blank the output is written 
275
 
# to stderr. 
276
 
 
277
 
WARN_LOGFILE           = 
278
 
 
279
 
#---------------------------------------------------------------------------
280
 
# configuration options related to the input files
281
 
#---------------------------------------------------------------------------
282
 
 
283
 
# The INPUT tag can be used to specify the files and/or directories that contain 
284
 
# documented source files. You may enter file names like "myfile.cpp" or 
285
 
# directories like "/usr/src/myproject". Separate the files or directories 
286
 
# with spaces. 
287
 
 
288
 
INPUT                  = src/lib/
289
 
 
290
 
# If the value of the INPUT tag contains directories, you can use the 
291
 
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
292
 
# and *.h) to filter out the source-files in the directories. If left 
293
 
# blank all files are included. 
294
 
 
295
 
FILE_PATTERNS          = *.c *.h
296
 
 
297
 
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
298
 
# should be searched for input files as well. Possible values are YES and NO. 
299
 
# If left blank NO is used. 
300
 
 
301
 
RECURSIVE              = YES
302
 
 
303
 
# The EXCLUDE tag can be used to specify files and/or directories that should 
304
 
# excluded from the INPUT source files. This way you can easily exclude a 
305
 
# subdirectory from a directory tree whose root is specified with the INPUT tag. 
306
 
 
307
 
EXCLUDE                = src/lib/libmathtools
308
 
 
309
 
# If the value of the INPUT tag contains directories, you can use the 
310
 
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
311
 
# certain files from those directories. 
312
 
 
313
 
EXCLUDE_PATTERNS       = 
314
 
 
315
 
# The EXAMPLE_PATH tag can be used to specify one or more files or 
316
 
# directories that contain example code fragments that are included (see 
317
 
# the \include command). 
318
 
 
319
 
EXAMPLE_PATH           = 
320
 
 
321
 
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
322
 
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
323
 
# and *.h) to filter out the source-files in the directories. If left 
324
 
# blank all files are included. 
325
 
 
326
 
EXAMPLE_PATTERNS       = 
327
 
 
328
 
# The IMAGE_PATH tag can be used to specify one or more files or 
329
 
# directories that contain image that are included in the documentation (see 
330
 
# the \image command). 
331
 
 
332
 
IMAGE_PATH             = 
333
 
 
334
 
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
335
 
# invoke to filter for each input file. Doxygen will invoke the filter program 
336
 
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
337
 
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
338
 
# input file. Doxygen will then use the output that the filter program writes 
339
 
# to standard output. 
340
 
 
341
 
INPUT_FILTER           = 
342
 
 
343
 
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
344
 
# INPUT_FILTER) will be used to filter the input files when producing source 
345
 
# files to browse. 
346
 
 
347
 
FILTER_SOURCE_FILES    = NO
348
 
 
349
 
#---------------------------------------------------------------------------
350
 
# configuration options related to the alphabetical class index
351
 
#---------------------------------------------------------------------------
352
 
 
353
 
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
354
 
# of all compounds will be generated. Enable this if the project 
355
 
# contains a lot of classes, structs, unions or interfaces. 
356
 
 
357
 
ALPHABETICAL_INDEX     = NO
358
 
 
359
 
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
360
 
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
361
 
# in which this list will be split (can be a number in the range [1..20]) 
362
 
 
363
 
COLS_IN_ALPHA_INDEX    = 5
364
 
 
365
 
# In case all classes in a project start with a common prefix, all 
366
 
# classes will be put under the same header in the alphabetical index. 
367
 
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
368
 
# should be ignored while generating the index headers. 
369
 
 
370
 
IGNORE_PREFIX          = 
371
 
 
372
 
#---------------------------------------------------------------------------
373
 
# configuration options related to the HTML output
374
 
#---------------------------------------------------------------------------
375
 
 
376
 
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
377
 
# generate HTML output. 
378
 
 
379
 
GENERATE_HTML          = YES
380
 
 
381
 
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
382
 
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
383
 
# put in front of it. If left blank `html' will be used as the default path. 
384
 
 
385
 
HTML_OUTPUT            = html
386
 
 
387
 
# The HTML_HEADER tag can be used to specify a personal HTML header for 
388
 
# each generated HTML page. If it is left blank doxygen will generate a 
389
 
# standard header.
390
 
 
391
 
HTML_HEADER            = 
392
 
 
393
 
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
394
 
# each generated HTML page. If it is left blank doxygen will generate a 
395
 
# standard footer.
396
 
 
397
 
HTML_FOOTER            = 
398
 
 
399
 
# The HTML_STYLESHEET tag can be used to specify a user defined cascading 
400
 
# style sheet that is used by each HTML page. It can be used to 
401
 
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
402
 
# will generate a default style sheet 
403
 
 
404
 
HTML_STYLESHEET        = 
405
 
 
406
 
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
407
 
# files or namespaces will be aligned in HTML using tables. If set to 
408
 
# NO a bullet list will be used. 
409
 
 
410
 
HTML_ALIGN_MEMBERS     = YES
411
 
 
412
 
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
413
 
# will be generated that can be used as input for tools like the 
414
 
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
415
 
# of the generated HTML documentation. 
416
 
 
417
 
GENERATE_HTMLHELP      = NO
418
 
 
419
 
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
420
 
# top of each HTML page. The value NO (the default) enables the index and 
421
 
# the value YES disables it. 
422
 
 
423
 
DISABLE_INDEX          = NO
424
 
 
425
 
# This tag can be used to set the number of enum values (range [1..20]) 
426
 
# that doxygen will group on one line in the generated HTML documentation. 
427
 
 
428
 
ENUM_VALUES_PER_LINE   = 4
429
 
 
430
 
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
431
 
# generated containing a tree-like index structure (just like the one that 
432
 
# is generated for HTML Help). For this to work a browser that supports 
433
 
# JavaScript and frames is required (for instance Netscape 4.0+ 
434
 
# or Internet explorer 4.0+). 
435
 
 
436
 
GENERATE_TREEVIEW      = NO
437
 
 
438
 
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
439
 
# used to set the initial width (in pixels) of the frame in which the tree 
440
 
# is shown. 
441
 
 
442
 
TREEVIEW_WIDTH         = 250
443
 
 
444
 
#---------------------------------------------------------------------------
445
 
# configuration options related to the LaTeX output
446
 
#---------------------------------------------------------------------------
447
 
 
448
 
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
449
 
# generate Latex output. 
450
 
 
451
 
GENERATE_LATEX         = YES
452
 
 
453
 
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
454
 
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
455
 
# put in front of it. If left blank `latex' will be used as the default path. 
456
 
 
457
 
LATEX_OUTPUT           = latex
458
 
 
459
 
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
460
 
# LaTeX documents. This may be useful for small projects and may help to 
461
 
# save some trees in general. 
462
 
 
463
 
COMPACT_LATEX          = NO
464
 
 
465
 
# The PAPER_TYPE tag can be used to set the paper type that is used 
466
 
# by the printer. Possible values are: a4, a4wide, letter, legal and 
467
 
# executive. If left blank a4wide will be used. 
468
 
 
469
 
PAPER_TYPE             = a4wide
470
 
 
471
 
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
472
 
# packages that should be included in the LaTeX output. 
473
 
 
474
 
EXTRA_PACKAGES         = 
475
 
 
476
 
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
477
 
# the generated latex document. The header should contain everything until 
478
 
# the first chapter. If it is left blank doxygen will generate a 
479
 
# standard header. Notice: only use this tag if you know what you are doing! 
480
 
 
481
 
LATEX_HEADER           = 
482
 
 
483
 
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
484
 
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
485
 
# contain links (just like the HTML output) instead of page references 
486
 
# This makes the output suitable for online browsing using a pdf viewer. 
487
 
 
488
 
PDF_HYPERLINKS         = NO
489
 
 
490
 
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
491
 
# plain latex in the generated Makefile. Set this option to YES to get a 
492
 
# higher quality PDF documentation. 
493
 
 
494
 
USE_PDFLATEX           = NO
495
 
 
496
 
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
497
 
# command to the generated LaTeX files. This will instruct LaTeX to keep 
498
 
# running if errors occur, instead of asking the user for help. 
499
 
# This option is also used when generating formulas in HTML. 
500
 
 
501
 
LATEX_BATCHMODE        = NO
502
 
 
503
 
#---------------------------------------------------------------------------
504
 
# configuration options related to the RTF output
505
 
#---------------------------------------------------------------------------
506
 
 
507
 
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
508
 
# The RTF output is optimised for Word 97 and may not look very pretty with 
509
 
# other RTF readers or editors.
510
 
 
511
 
GENERATE_RTF           = YES
512
 
 
513
 
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
514
 
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
515
 
# put in front of it. If left blank `rtf' will be used as the default path. 
516
 
 
517
 
RTF_OUTPUT             = rtf
518
 
 
519
 
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
520
 
# RTF documents. This may be useful for small projects and may help to 
521
 
# save some trees in general. 
522
 
 
523
 
COMPACT_RTF            = NO
524
 
 
525
 
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
526
 
# will contain hyperlink fields. The RTF file will 
527
 
# contain links (just like the HTML output) instead of page references. 
528
 
# This makes the output suitable for online browsing using a WORD or other. 
529
 
# programs which support those fields. 
530
 
# Note: wordpad (write) and others do not support links. 
531
 
 
532
 
RTF_HYPERLINKS         = NO
533
 
 
534
 
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
535
 
# config file, i.e. a series of assigments. You only have to provide 
536
 
# replacements, missing definitions are set to their default value. 
537
 
 
538
 
RTF_STYLESHEET_FILE    = 
539
 
 
540
 
#---------------------------------------------------------------------------
541
 
# configuration options related to the man page output
542
 
#---------------------------------------------------------------------------
543
 
 
544
 
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
545
 
# generate man pages 
546
 
 
547
 
GENERATE_MAN           = YES
548
 
 
549
 
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
550
 
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
551
 
# put in front of it. If left blank `man' will be used as the default path. 
552
 
 
553
 
MAN_OUTPUT             = man
554
 
 
555
 
# The MAN_EXTENSION tag determines the extension that is added to 
556
 
# the generated man pages (default is the subroutine's section .3) 
557
 
 
558
 
MAN_EXTENSION          = .3
559
 
 
560
 
#---------------------------------------------------------------------------
561
 
# Configuration options related to the preprocessor   
562
 
#---------------------------------------------------------------------------
563
 
 
564
 
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
565
 
# evaluate all C-preprocessor directives found in the sources and include 
566
 
# files. 
567
 
 
568
 
ENABLE_PREPROCESSING   = YES
569
 
 
570
 
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
571
 
# names in the source code. If set to NO (the default) only conditional 
572
 
# compilation will be performed. Macro expansion can be done in a controlled 
573
 
# way by setting EXPAND_ONLY_PREDEF to YES. 
574
 
 
575
 
MACRO_EXPANSION        = NO
576
 
 
577
 
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
578
 
# then the macro expansion is limited to the macros specified with the 
579
 
# PREDEFINED and EXPAND_AS_PREDEFINED tags. 
580
 
 
581
 
EXPAND_ONLY_PREDEF     = NO
582
 
 
583
 
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
584
 
# in the INCLUDE_PATH (see below) will be search if a #include is found. 
585
 
 
586
 
SEARCH_INCLUDES        = YES
587
 
 
588
 
# The INCLUDE_PATH tag can be used to specify one or more directories that 
589
 
# contain include files that are not input files but should be processed by 
590
 
# the preprocessor. 
591
 
 
592
 
INCLUDE_PATH           = 
593
 
 
594
 
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
595
 
# patterns (like *.h and *.hpp) to filter out the header-files in the 
596
 
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
597
 
# be used. 
598
 
 
599
 
INCLUDE_FILE_PATTERNS  = 
600
 
 
601
 
# The PREDEFINED tag can be used to specify one or more macro names that 
602
 
# are defined before the preprocessor is started (similar to the -D option of 
603
 
# gcc). The argument of the tag is a list of macros of the form: name 
604
 
# or name=definition (no spaces). If the definition and the = are 
605
 
# omitted =1 is assumed. 
606
 
 
607
 
PREDEFINED             = 
608
 
 
609
 
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 
610
 
# this tag can be used to specify a list of macro names that should be expanded. 
611
 
# The macro definition that is found in the sources will be used. 
612
 
# Use the PREDEFINED tag if you want to use a different macro definition. 
613
 
 
614
 
EXPAND_AS_DEFINED      = 
615
 
 
616
 
#---------------------------------------------------------------------------
617
 
# Configuration::addtions related to external references   
618
 
#---------------------------------------------------------------------------
619
 
 
620
 
# The TAGFILES tag can be used to specify one or more tagfiles. 
621
 
 
622
 
TAGFILES               = 
623
 
 
624
 
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
625
 
# a tag file that is based on the input files it reads. 
626
 
 
627
 
GENERATE_TAGFILE       = 
628
 
 
629
 
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
630
 
# in the class index. If set to NO only the inherited external classes 
631
 
# will be listed. 
632
 
 
633
 
ALLEXTERNALS           = NO
634
 
 
635
 
# The PERL_PATH should be the absolute path and name of the perl script 
636
 
# interpreter (i.e. the result of `which perl'). 
637
 
 
638
 
PERL_PATH              = /usr/bin/perl
639
 
 
640
 
#---------------------------------------------------------------------------
641
 
# Configuration options related to the dot tool   
642
 
#---------------------------------------------------------------------------
643
 
 
644
 
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
645
 
# available from the path. This tool is part of Graphviz, a graph visualization 
646
 
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
647
 
# have no effect if this option is set to NO (the default) 
648
 
 
649
 
HAVE_DOT               = NO
650
 
 
651
 
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
652
 
# will generate a graph for each documented class showing the direct and 
653
 
# indirect inheritance relations. Setting this tag to YES will force the 
654
 
# the CLASS_DIAGRAMS tag to NO.
655
 
 
656
 
CLASS_GRAPH            = YES
657
 
 
658
 
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
659
 
# will generate a graph for each documented class showing the direct and 
660
 
# indirect implementation dependencies (inheritance, containment, and 
661
 
# class references variables) of the class with other documented classes. 
662
 
 
663
 
COLLABORATION_GRAPH    = YES
664
 
 
665
 
# If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to 
666
 
# YES then doxygen will generate a graph for each documented file showing 
667
 
# the direct and indirect include dependencies of the file with other 
668
 
# documented files. 
669
 
 
670
 
INCLUDE_GRAPH          = YES
671
 
 
672
 
# If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to 
673
 
# YES then doxygen will generate a graph for each documented header file showing 
674
 
# the documented files that directly or indirectly include this file 
675
 
 
676
 
INCLUDED_BY_GRAPH      = YES
677
 
 
678
 
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
679
 
# will graphical hierarchy of all classes instead of a textual one. 
680
 
 
681
 
GRAPHICAL_HIERARCHY    = YES
682
 
 
683
 
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
684
 
# found. If left blank, it is assumed the dot tool can be found on the path. 
685
 
 
686
 
DOT_PATH               = 
687
 
 
688
 
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
689
 
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
690
 
# this value, doxygen will try to truncate the graph, so that it fits within 
691
 
# the specified constraint. Beware that most browsers cannot cope with very 
692
 
# large images. 
693
 
 
694
 
MAX_DOT_GRAPH_WIDTH    = 1024
695
 
 
696
 
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
697
 
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
698
 
# this value, doxygen will try to truncate the graph, so that it fits within 
699
 
# the specified constraint. Beware that most browsers cannot cope with very 
700
 
# large images. 
701
 
 
702
 
MAX_DOT_GRAPH_HEIGHT   = 1024
703
 
 
704
 
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
705
 
# generate a legend page explaining the meaning of the various boxes and 
706
 
# arrows in the dot generated graphs. 
707
 
 
708
 
GENERATE_LEGEND        = YES
709
 
 
710
 
#---------------------------------------------------------------------------
711
 
# Configuration::addtions related to the search engine   
712
 
#---------------------------------------------------------------------------
713
 
 
714
 
# The SEARCHENGINE tag specifies whether or not a search engine should be 
715
 
# used. If set to NO the values of all tags below this one will be ignored. 
716
 
 
717
 
SEARCHENGINE           = NO
718
 
 
719
 
# The CGI_NAME tag should be the name of the CGI script that 
720
 
# starts the search engine (doxysearch) with the correct parameters. 
721
 
# A script with this name will be generated by doxygen. 
722
 
 
723
 
CGI_NAME               = search.cgi
724
 
 
725
 
# The CGI_URL tag should be the absolute URL to the directory where the 
726
 
# cgi binaries are located. See the documentation of your http daemon for 
727
 
# details. 
728
 
 
729
 
CGI_URL                = 
730
 
 
731
 
# The DOC_URL tag should be the absolute URL to the directory where the 
732
 
# documentation is located. If left blank the absolute path to the 
733
 
# documentation, with file:// prepended to it, will be used. 
734
 
 
735
 
DOC_URL                = 
736
 
 
737
 
# The DOC_ABSPATH tag should be the absolute path to the directory where the 
738
 
# documentation is located. If left blank the directory on the local machine 
739
 
# will be used. 
740
 
 
741
 
DOC_ABSPATH            = 
742
 
 
743
 
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary 
744
 
# is installed. 
745
 
 
746
 
BIN_ABSPATH            = /usr/local/bin/
747
 
 
748
 
# The EXT_DOC_PATHS tag can be used to specify one or more paths to 
749
 
# documentation generated for other projects. This allows doxysearch to search 
750
 
# the documentation for these projects as well. 
751
 
 
752
 
EXT_DOC_PATHS          =