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

« back to all changes in this revision

Viewing changes to doc/doxygen/doxygen.cfg.in

  • 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         = @PSI_VERSION@
 
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       = ./
 
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        = @top_srcdir@
 
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          = YES
 
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  = NO
 
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                  = @top_srcdir@/src/lib \
 
289
                         @top_srcdir@/src/bin \
 
290
                         @top_srcdir@/include
 
291
 
 
292
# If the value of the INPUT tag contains directories, you can use the 
 
293
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
 
294
# and *.h) to filter out the source-files in the directories. If left 
 
295
# blank all files are included. 
 
296
 
 
297
FILE_PATTERNS          = *.h *.hpp *.cc *.c *.dox
 
298
 
 
299
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
 
300
# should be searched for input files as well. Possible values are YES and NO. 
 
301
# If left blank NO is used. 
 
302
 
 
303
RECURSIVE              = YES
 
304
 
 
305
# The EXCLUDE tag can be used to specify files and/or directories that should 
 
306
# excluded from the INPUT source files. This way you can easily exclude a 
 
307
# subdirectory from a directory tree whose root is specified with the INPUT tag. 
 
308
 
 
309
EXCLUDE                = @top_srcdir@/src/lib/libmathtools \
 
310
                         @top_srcdir@/src/bin/psiclean
 
311
 
 
312
# If the value of the INPUT tag contains directories, you can use the 
 
313
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
 
314
# certain files from those directories. 
 
315
 
 
316
EXCLUDE_PATTERNS       = 
 
317
 
 
318
# The EXAMPLE_PATH tag can be used to specify one or more files or 
 
319
# directories that contain example code fragments that are included (see 
 
320
# the \include command). 
 
321
 
 
322
EXAMPLE_PATH           = 
 
323
 
 
324
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
 
325
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
 
326
# and *.h) to filter out the source-files in the directories. If left 
 
327
# blank all files are included. 
 
328
 
 
329
EXAMPLE_PATTERNS       = 
 
330
 
 
331
# The IMAGE_PATH tag can be used to specify one or more files or 
 
332
# directories that contain image that are included in the documentation (see 
 
333
# the \image command). 
 
334
 
 
335
IMAGE_PATH             = 
 
336
 
 
337
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
 
338
# invoke to filter for each input file. Doxygen will invoke the filter program 
 
339
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
 
340
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
 
341
# input file. Doxygen will then use the output that the filter program writes 
 
342
# to standard output. 
 
343
 
 
344
INPUT_FILTER           = 
 
345
 
 
346
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
 
347
# INPUT_FILTER) will be used to filter the input files when producing source 
 
348
# files to browse. 
 
349
 
 
350
FILTER_SOURCE_FILES    = NO
 
351
 
 
352
#---------------------------------------------------------------------------
 
353
# configuration options related to the alphabetical class index
 
354
#---------------------------------------------------------------------------
 
355
 
 
356
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
 
357
# of all compounds will be generated. Enable this if the project 
 
358
# contains a lot of classes, structs, unions or interfaces. 
 
359
 
 
360
ALPHABETICAL_INDEX     = NO
 
361
 
 
362
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
 
363
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
 
364
# in which this list will be split (can be a number in the range [1..20]) 
 
365
 
 
366
COLS_IN_ALPHA_INDEX    = 5
 
367
 
 
368
# In case all classes in a project start with a common prefix, all 
 
369
# classes will be put under the same header in the alphabetical index. 
 
370
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
 
371
# should be ignored while generating the index headers. 
 
372
 
 
373
IGNORE_PREFIX          = 
 
374
 
 
375
#---------------------------------------------------------------------------
 
376
# configuration options related to the HTML output
 
377
#---------------------------------------------------------------------------
 
378
 
 
379
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
 
380
# generate HTML output. 
 
381
 
 
382
GENERATE_HTML          = YES
 
383
 
 
384
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
 
385
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
 
386
# put in front of it. If left blank `html' will be used as the default path. 
 
387
 
 
388
HTML_OUTPUT            = html
 
389
 
 
390
# The HTML_HEADER tag can be used to specify a personal HTML header for 
 
391
# each generated HTML page. If it is left blank doxygen will generate a 
 
392
# standard header.
 
393
 
 
394
HTML_HEADER            = 
 
395
 
 
396
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
 
397
# each generated HTML page. If it is left blank doxygen will generate a 
 
398
# standard footer.
 
399
 
 
400
HTML_FOOTER            = 
 
401
 
 
402
# The HTML_STYLESHEET tag can be used to specify a user defined cascading 
 
403
# style sheet that is used by each HTML page. It can be used to 
 
404
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
 
405
# will generate a default style sheet 
 
406
 
 
407
HTML_STYLESHEET        = 
 
408
 
 
409
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
 
410
# files or namespaces will be aligned in HTML using tables. If set to 
 
411
# NO a bullet list will be used. 
 
412
 
 
413
HTML_ALIGN_MEMBERS     = YES
 
414
 
 
415
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
 
416
# will be generated that can be used as input for tools like the 
 
417
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
 
418
# of the generated HTML documentation. 
 
419
 
 
420
GENERATE_HTMLHELP      = NO
 
421
 
 
422
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
 
423
# top of each HTML page. The value NO (the default) enables the index and 
 
424
# the value YES disables it. 
 
425
 
 
426
DISABLE_INDEX          = NO
 
427
 
 
428
# This tag can be used to set the number of enum values (range [1..20]) 
 
429
# that doxygen will group on one line in the generated HTML documentation. 
 
430
 
 
431
ENUM_VALUES_PER_LINE   = 4
 
432
 
 
433
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
 
434
# generated containing a tree-like index structure (just like the one that 
 
435
# is generated for HTML Help). For this to work a browser that supports 
 
436
# JavaScript and frames is required (for instance Netscape 4.0+ 
 
437
# or Internet explorer 4.0+). 
 
438
 
 
439
GENERATE_TREEVIEW      = NO
 
440
 
 
441
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
 
442
# used to set the initial width (in pixels) of the frame in which the tree 
 
443
# is shown. 
 
444
 
 
445
TREEVIEW_WIDTH         = 250
 
446
 
 
447
#---------------------------------------------------------------------------
 
448
# configuration options related to the LaTeX output
 
449
#---------------------------------------------------------------------------
 
450
 
 
451
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
 
452
# generate Latex output. 
 
453
 
 
454
GENERATE_LATEX         = NO
 
455
 
 
456
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
 
457
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
 
458
# put in front of it. If left blank `latex' will be used as the default path. 
 
459
 
 
460
LATEX_OUTPUT           = latex
 
461
 
 
462
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
 
463
# LaTeX documents. This may be useful for small projects and may help to 
 
464
# save some trees in general. 
 
465
 
 
466
COMPACT_LATEX          = NO
 
467
 
 
468
# The PAPER_TYPE tag can be used to set the paper type that is used 
 
469
# by the printer. Possible values are: a4, a4wide, letter, legal and 
 
470
# executive. If left blank a4wide will be used. 
 
471
 
 
472
PAPER_TYPE             = a4wide
 
473
 
 
474
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
 
475
# packages that should be included in the LaTeX output. 
 
476
 
 
477
EXTRA_PACKAGES         = 
 
478
 
 
479
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
 
480
# the generated latex document. The header should contain everything until 
 
481
# the first chapter. If it is left blank doxygen will generate a 
 
482
# standard header. Notice: only use this tag if you know what you are doing! 
 
483
 
 
484
LATEX_HEADER           = 
 
485
 
 
486
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
 
487
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
 
488
# contain links (just like the HTML output) instead of page references 
 
489
# This makes the output suitable for online browsing using a pdf viewer. 
 
490
 
 
491
PDF_HYPERLINKS         = NO
 
492
 
 
493
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
 
494
# plain latex in the generated Makefile. Set this option to YES to get a 
 
495
# higher quality PDF documentation. 
 
496
 
 
497
USE_PDFLATEX           = NO
 
498
 
 
499
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
 
500
# command to the generated LaTeX files. This will instruct LaTeX to keep 
 
501
# running if errors occur, instead of asking the user for help. 
 
502
# This option is also used when generating formulas in HTML. 
 
503
 
 
504
LATEX_BATCHMODE        = NO
 
505
 
 
506
#---------------------------------------------------------------------------
 
507
# configuration options related to the RTF output
 
508
#---------------------------------------------------------------------------
 
509
 
 
510
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
 
511
# The RTF output is optimised for Word 97 and may not look very pretty with 
 
512
# other RTF readers or editors.
 
513
 
 
514
GENERATE_RTF           = NO
 
515
 
 
516
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
 
517
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
 
518
# put in front of it. If left blank `rtf' will be used as the default path. 
 
519
 
 
520
RTF_OUTPUT             = rtf
 
521
 
 
522
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
 
523
# RTF documents. This may be useful for small projects and may help to 
 
524
# save some trees in general. 
 
525
 
 
526
COMPACT_RTF            = NO
 
527
 
 
528
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
 
529
# will contain hyperlink fields. The RTF file will 
 
530
# contain links (just like the HTML output) instead of page references. 
 
531
# This makes the output suitable for online browsing using a WORD or other. 
 
532
# programs which support those fields. 
 
533
# Note: wordpad (write) and others do not support links. 
 
534
 
 
535
RTF_HYPERLINKS         = NO
 
536
 
 
537
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
 
538
# config file, i.e. a series of assigments. You only have to provide 
 
539
# replacements, missing definitions are set to their default value. 
 
540
 
 
541
RTF_STYLESHEET_FILE    = 
 
542
 
 
543
#---------------------------------------------------------------------------
 
544
# configuration options related to the man page output
 
545
#---------------------------------------------------------------------------
 
546
 
 
547
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
 
548
# generate man pages 
 
549
 
 
550
GENERATE_MAN           = NO
 
551
 
 
552
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
 
553
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
 
554
# put in front of it. If left blank `man' will be used as the default path. 
 
555
 
 
556
MAN_OUTPUT             = man
 
557
 
 
558
# The MAN_EXTENSION tag determines the extension that is added to 
 
559
# the generated man pages (default is the subroutine's section .3) 
 
560
 
 
561
MAN_EXTENSION          = .3
 
562
 
 
563
#---------------------------------------------------------------------------
 
564
# Configuration options related to the preprocessor   
 
565
#---------------------------------------------------------------------------
 
566
 
 
567
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
 
568
# evaluate all C-preprocessor directives found in the sources and include 
 
569
# files. 
 
570
 
 
571
ENABLE_PREPROCESSING   = YES
 
572
 
 
573
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
 
574
# names in the source code. If set to NO (the default) only conditional 
 
575
# compilation will be performed. Macro expansion can be done in a controlled 
 
576
# way by setting EXPAND_ONLY_PREDEF to YES. 
 
577
 
 
578
MACRO_EXPANSION        = NO
 
579
 
 
580
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
 
581
# then the macro expansion is limited to the macros specified with the 
 
582
# PREDEFINED and EXPAND_AS_PREDEFINED tags. 
 
583
 
 
584
EXPAND_ONLY_PREDEF     = NO
 
585
 
 
586
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
 
587
# in the INCLUDE_PATH (see below) will be search if a #include is found. 
 
588
 
 
589
SEARCH_INCLUDES        = YES
 
590
 
 
591
# The INCLUDE_PATH tag can be used to specify one or more directories that 
 
592
# contain include files that are not input files but should be processed by 
 
593
# the preprocessor. 
 
594
 
 
595
INCLUDE_PATH           = 
 
596
 
 
597
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
 
598
# patterns (like *.h and *.hpp) to filter out the header-files in the 
 
599
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
 
600
# be used. 
 
601
 
 
602
INCLUDE_FILE_PATTERNS  = 
 
603
 
 
604
# The PREDEFINED tag can be used to specify one or more macro names that 
 
605
# are defined before the preprocessor is started (similar to the -D option of 
 
606
# gcc). The argument of the tag is a list of macros of the form: name 
 
607
# or name=definition (no spaces). If the definition and the = are 
 
608
# omitted =1 is assumed. 
 
609
 
 
610
PREDEFINED             = 
 
611
 
 
612
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 
 
613
# this tag can be used to specify a list of macro names that should be expanded. 
 
614
# The macro definition that is found in the sources will be used. 
 
615
# Use the PREDEFINED tag if you want to use a different macro definition. 
 
616
 
 
617
EXPAND_AS_DEFINED      = 
 
618
 
 
619
#---------------------------------------------------------------------------
 
620
# Configuration::addtions related to external references   
 
621
#---------------------------------------------------------------------------
 
622
 
 
623
# The TAGFILES tag can be used to specify one or more tagfiles. 
 
624
 
 
625
TAGFILES               = 
 
626
 
 
627
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
 
628
# a tag file that is based on the input files it reads. 
 
629
 
 
630
GENERATE_TAGFILE       = 
 
631
 
 
632
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
 
633
# in the class index. If set to NO only the inherited external classes 
 
634
# will be listed. 
 
635
 
 
636
ALLEXTERNALS           = NO
 
637
 
 
638
# The PERL_PATH should be the absolute path and name of the perl script 
 
639
# interpreter (i.e. the result of `which perl'). 
 
640
 
 
641
PERL_PATH              = /usr/bin/perl
 
642
 
 
643
#---------------------------------------------------------------------------
 
644
# Configuration options related to the dot tool   
 
645
#---------------------------------------------------------------------------
 
646
 
 
647
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
 
648
# available from the path. This tool is part of Graphviz, a graph visualization 
 
649
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
 
650
# have no effect if this option is set to NO (the default) 
 
651
 
 
652
HAVE_DOT               = @HAVE_DOT@
 
653
 
 
654
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
 
655
# will generate a graph for each documented class showing the direct and 
 
656
# indirect inheritance relations. Setting this tag to YES will force the 
 
657
# the CLASS_DIAGRAMS tag to NO.
 
658
 
 
659
CLASS_GRAPH            = YES
 
660
 
 
661
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
 
662
# will generate a graph for each documented class showing the direct and 
 
663
# indirect implementation dependencies (inheritance, containment, and 
 
664
# class references variables) of the class with other documented classes. 
 
665
 
 
666
COLLABORATION_GRAPH    = YES
 
667
 
 
668
# If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to 
 
669
# YES then doxygen will generate a graph for each documented file showing 
 
670
# the direct and indirect include dependencies of the file with other 
 
671
# documented files. 
 
672
 
 
673
INCLUDE_GRAPH          = YES
 
674
 
 
675
# If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to 
 
676
# YES then doxygen will generate a graph for each documented header file showing 
 
677
# the documented files that directly or indirectly include this file 
 
678
 
 
679
INCLUDED_BY_GRAPH      = YES
 
680
 
 
681
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
 
682
# will graphical hierarchy of all classes instead of a textual one. 
 
683
 
 
684
GRAPHICAL_HIERARCHY    = YES
 
685
 
 
686
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
 
687
# found. If left blank, it is assumed the dot tool can be found on the path. 
 
688
 
 
689
DOT_PATH               = @DOT_PATH@
 
690
 
 
691
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
 
692
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
 
693
# this value, doxygen will try to truncate the graph, so that it fits within 
 
694
# the specified constraint. Beware that most browsers cannot cope with very 
 
695
# large images. 
 
696
 
 
697
MAX_DOT_GRAPH_WIDTH    = 1024
 
698
 
 
699
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
 
700
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
 
701
# this value, doxygen will try to truncate the graph, so that it fits within 
 
702
# the specified constraint. Beware that most browsers cannot cope with very 
 
703
# large images. 
 
704
 
 
705
MAX_DOT_GRAPH_HEIGHT   = 1024
 
706
 
 
707
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
 
708
# generate a legend page explaining the meaning of the various boxes and 
 
709
# arrows in the dot generated graphs. 
 
710
 
 
711
GENERATE_LEGEND        = YES
 
712
 
 
713
#---------------------------------------------------------------------------
 
714
# Configuration::addtions related to the search engine   
 
715
#---------------------------------------------------------------------------
 
716
 
 
717
# The SEARCHENGINE tag specifies whether or not a search engine should be 
 
718
# used. If set to NO the values of all tags below this one will be ignored. 
 
719
 
 
720
SEARCHENGINE           = NO
 
721
 
 
722
# The CGI_NAME tag should be the name of the CGI script that 
 
723
# starts the search engine (doxysearch) with the correct parameters. 
 
724
# A script with this name will be generated by doxygen. 
 
725
 
 
726
CGI_NAME               = search.cgi
 
727
 
 
728
# The CGI_URL tag should be the absolute URL to the directory where the 
 
729
# cgi binaries are located. See the documentation of your http daemon for 
 
730
# details. 
 
731
 
 
732
CGI_URL                = 
 
733
 
 
734
# The DOC_URL tag should be the absolute URL to the directory where the 
 
735
# documentation is located. If left blank the absolute path to the 
 
736
# documentation, with file:// prepended to it, will be used. 
 
737
 
 
738
DOC_URL                = 
 
739
 
 
740
# The DOC_ABSPATH tag should be the absolute path to the directory where the 
 
741
# documentation is located. If left blank the directory on the local machine 
 
742
# will be used. 
 
743
 
 
744
DOC_ABSPATH            = 
 
745
 
 
746
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary 
 
747
# is installed. 
 
748
 
 
749
BIN_ABSPATH            = /usr/local/bin/
 
750
 
 
751
# The EXT_DOC_PATHS tag can be used to specify one or more paths to 
 
752
# documentation generated for other projects. This allows doxysearch to search 
 
753
# the documentation for these projects as well. 
 
754
 
 
755
EXT_DOC_PATHS          =