1
# Doxyfile 1.2.6
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           = SimGear
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         = 2.2.0
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       = ../doxy
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     = YES
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     = YES
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         = YES
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      = YES
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
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
220
# disable (NO) the bug list. This list is created by putting \bug 
221
# commands in the documentation.
222
223
GENERATE_BUGLIST       = YES
224
225
# This tag can be used to specify a number of aliases that acts 
226
# as commands in the documentation. An alias has the form "name=value". 
227
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
228
# put the command \sideeffect (or @sideeffect) in the documentation, which 
229
# will result in a user defined paragraph with heading "Side Effects:". 
230
# You can put \n's in the value part of an alias to insert newlines. 
231
232
ALIASES                = 
233
234
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
235
# the initial value of a variable or define consist of for it to appear in 
236
# the documentation. If the initializer consists of more lines than specified 
237
# here it will be hidden. Use a value of 0 to hide initializers completely. 
238
# The appearance of the initializer of individual variables and defines in the 
239
# documentation can be controlled using \showinitializer or \hideinitializer 
240
# command in the documentation regardless of this setting. 
241
242
MAX_INITIALIZER_LINES  = 30
243
244
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
245
# only. Doxygen will then generate output that is more tailored for C. 
246
# For instance some of the names that are used will be different. The list 
247
# of all members will be omitted, etc. 
248
249
OPTIMIZE_OUTPUT_FOR_C  = NO
250
251
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
252
# at the bottom of the documentation of classes and structs. If set to YES the 
253
# list will mention the files that were used to generate the documentation. 
254
255
SHOW_USED_FILES        = YES
256
257
#---------------------------------------------------------------------------
258
# configuration options related to warning and progress messages
259
#---------------------------------------------------------------------------
260
261
# The QUIET tag can be used to turn on/off the messages that are generated 
262
# by doxygen. Possible values are YES and NO. If left blank NO is used. 
263
264
QUIET                  = NO
265
266
# The WARNINGS tag can be used to turn on/off the warning messages that are 
267
# generated by doxygen. Possible values are YES and NO. If left blank 
268
# NO is used. 
269
270
WARNINGS               = YES
271
272
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
273
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
274
# automatically be disabled. 
275
276
WARN_IF_UNDOCUMENTED   = YES
277
278
# The WARN_FORMAT tag determines the format of the warning messages that 
279
# doxygen can produce. The string should contain the $file, $line, and $text 
280
# tags, which will be replaced by the file and line number from which the 
281
# warning originated and the warning text. 
282
283
WARN_FORMAT            = "$file:$line: $text"
284
285
# The WARN_LOGFILE tag can be used to specify a file to which warning 
286
# and error messages should be written. If left blank the output is written 
287
# to stderr. 
288
289
WARN_LOGFILE           = 
290
291
#---------------------------------------------------------------------------
292
# configuration options related to the input files
293
#---------------------------------------------------------------------------
294
295
# The INPUT tag can be used to specify the files and/or directories that contain 
296
# documented source files. You may enter file names like "myfile.cpp" or 
297
# directories like "/usr/src/myproject". Separate the files or directories 
298
# with spaces. 
299
300
INPUT                  = \
301
        DoxygenMain.cxx \
302
	simgear/bucket \
303
	simgear/compiler.h \
304
	simgear/constants.h \
305
	simgear/debug \
306
	simgear/environment \
307
	simgear/ephemeris \
308
	simgear/io \
309
	simgear/magvar \
310
	simgear/math \
311
	simgear/misc \
312
	simgear/nasal \
313
        simgear/props \
314
	simgear/route \
315
	simgear/scene \
316
	simgear/screen \
317
	simgear/serial \
318
	simgear/structure \
319
	simgear/sg_inlines.h \
320
	simgear/sg_traits.hxx \
321
        simgear/sound \
322
	simgear/threads \
323
	simgear/timing \
324
	simgear/xml
325
326
# If the value of the INPUT tag contains directories, you can use the 
327
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
328
# and *.h) to filter out the source-files in the directories. If left 
329
# blank all files are included. 
330
331
FILE_PATTERNS          = *.h *.hxx *.c *.cxx *.cpp
332
333
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
334
# should be searched for input files as well. Possible values are YES and NO. 
335
# If left blank NO is used. 
336
337
RECURSIVE              = YES
338
339
# The EXCLUDE tag can be used to specify files and/or directories that should 
340
# excluded from the INPUT source files. This way you can easily exclude a 
341
# subdirectory from a directory tree whose root is specified with the INPUT tag. 
342
343
EXCLUDE                = simgear/scene/sky/clouds3d
344
345
# If the value of the INPUT tag contains directories, you can use the 
346
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
347
# certain files from those directories. 
348
349
EXCLUDE_PATTERNS       = 
350
351
# The EXAMPLE_PATH tag can be used to specify one or more files or 
352
# directories that contain example code fragments that are included (see 
353
# the \include command). 
354
355
EXAMPLE_PATH           = 
356
357
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
358
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
359
# and *.h) to filter out the source-files in the directories. If left 
360
# blank all files are included. 
361
362
EXAMPLE_PATTERNS       = 
363
364
# The IMAGE_PATH tag can be used to specify one or more files or 
365
# directories that contain image that are included in the documentation (see 
366
# the \image command). 
367
368
IMAGE_PATH             = 
369
370
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
371
# invoke to filter for each input file. Doxygen will invoke the filter program 
372
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
373
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
374
# input file. Doxygen will then use the output that the filter program writes 
375
# to standard output. 
376
377
INPUT_FILTER           = 
378
379
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
380
# INPUT_FILTER) will be used to filter the input files when producing source 
381
# files to browse. 
382
383
FILTER_SOURCE_FILES    = NO
384
385
#---------------------------------------------------------------------------
386
# configuration options related to the alphabetical class index
387
#---------------------------------------------------------------------------
388
389
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
390
# of all compounds will be generated. Enable this if the project 
391
# contains a lot of classes, structs, unions or interfaces. 
392
393
ALPHABETICAL_INDEX     = YES
394
395
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
396
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
397
# in which this list will be split (can be a number in the range [1..20]) 
398
399
COLS_IN_ALPHA_INDEX    = 5
400
401
# In case all classes in a project start with a common prefix, all 
402
# classes will be put under the same header in the alphabetical index. 
403
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
404
# should be ignored while generating the index headers. 
405
406
IGNORE_PREFIX          = 
407
408
#---------------------------------------------------------------------------
409
# configuration options related to the HTML output
410
#---------------------------------------------------------------------------
411
412
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
413
# generate HTML output. 
414
415
GENERATE_HTML          = YES
416
417
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
418
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
419
# put in front of it. If left blank `html' will be used as the default path. 
420
421
HTML_OUTPUT            = html
422
423
# The HTML_HEADER tag can be used to specify a personal HTML header for 
424
# each generated HTML page. If it is left blank doxygen will generate a 
425
# standard header.
426
427
HTML_HEADER            = 
428
429
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
430
# each generated HTML page. If it is left blank doxygen will generate a 
431
# standard footer.
432
433
HTML_FOOTER            = 
434
435
# The HTML_STYLESHEET tag can be used to specify a user defined cascading 
436
# style sheet that is used by each HTML page. It can be used to 
437
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
438
# will generate a default style sheet 
439
440
HTML_STYLESHEET        = 
441
442
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
443
# files or namespaces will be aligned in HTML using tables. If set to 
444
# NO a bullet list will be used. 
445
446
HTML_ALIGN_MEMBERS     = YES
447
448
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
449
# will be generated that can be used as input for tools like the 
450
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
451
# of the generated HTML documentation. 
452
453
GENERATE_HTMLHELP      = NO
454
455
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
456
# controls if a separate .chi index file is generated (YES) or that 
457
# it should be included in the master .chm file (NO).
458
459
GENERATE_CHI           = NO
460
461
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
462
# controls whether a binary table of contents is generated (YES) or a 
463
# normal table of contents (NO) in the .chm file.
464
465
BINARY_TOC             = NO
466
467
# The TOC_EXPAND flag can be set YES to add extra items for group members 
468
# to the contents of the Html help documentation and to the tree view. 
469
470
TOC_EXPAND             = NO
471
472
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
473
# top of each HTML page. The value NO (the default) enables the index and 
474
# the value YES disables it. 
475
476
DISABLE_INDEX          = NO
477
478
# This tag can be used to set the number of enum values (range [1..20]) 
479
# that doxygen will group on one line in the generated HTML documentation. 
480
481
ENUM_VALUES_PER_LINE   = 4
482
483
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
484
# generated containing a tree-like index structure (just like the one that 
485
# is generated for HTML Help). For this to work a browser that supports 
486
# JavaScript and frames is required (for instance Netscape 4.0+ 
487
# or Internet explorer 4.0+). 
488
489
GENERATE_TREEVIEW      = NO
490
491
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
492
# used to set the initial width (in pixels) of the frame in which the tree 
493
# is shown. 
494
495
TREEVIEW_WIDTH         = 250
496
497
#---------------------------------------------------------------------------
498
# configuration options related to the LaTeX output
499
#---------------------------------------------------------------------------
500
501
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
502
# generate Latex output. 
503
504
GENERATE_LATEX         = YES
505
506
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
507
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
508
# put in front of it. If left blank `latex' will be used as the default path. 
509
510
LATEX_OUTPUT           = latex
511
512
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
513
# LaTeX documents. This may be useful for small projects and may help to 
514
# save some trees in general. 
515
516
COMPACT_LATEX          = NO
517
518
# The PAPER_TYPE tag can be used to set the paper type that is used 
519
# by the printer. Possible values are: a4, a4wide, letter, legal and 
520
# executive. If left blank a4wide will be used. 
521
522
PAPER_TYPE             = letter
523
524
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
525
# packages that should be included in the LaTeX output. 
526
527
EXTRA_PACKAGES         = 
528
529
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
530
# the generated latex document. The header should contain everything until 
531
# the first chapter. If it is left blank doxygen will generate a 
532
# standard header. Notice: only use this tag if you know what you are doing! 
533
534
LATEX_HEADER           = 
535
536
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
537
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
538
# contain links (just like the HTML output) instead of page references 
539
# This makes the output suitable for online browsing using a pdf viewer. 
540
541
PDF_HYPERLINKS         = NO
542
543
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
544
# plain latex in the generated Makefile. Set this option to YES to get a 
545
# higher quality PDF documentation. 
546
547
USE_PDFLATEX           = NO
548
549
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
550
# command to the generated LaTeX files. This will instruct LaTeX to keep 
551
# running if errors occur, instead of asking the user for help. 
552
# This option is also used when generating formulas in HTML. 
553
554
LATEX_BATCHMODE        = NO
555
556
#---------------------------------------------------------------------------
557
# configuration options related to the RTF output
558
#---------------------------------------------------------------------------
559
560
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
561
# The RTF output is optimised for Word 97 and may not look very pretty with 
562
# other RTF readers or editors.
563
564
GENERATE_RTF           = YES
565
566
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
567
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
568
# put in front of it. If left blank `rtf' will be used as the default path. 
569
570
RTF_OUTPUT             = rtf
571
572
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
573
# RTF documents. This may be useful for small projects and may help to 
574
# save some trees in general. 
575
576
COMPACT_RTF            = NO
577
578
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
579
# will contain hyperlink fields. The RTF file will 
580
# contain links (just like the HTML output) instead of page references. 
581
# This makes the output suitable for online browsing using a WORD or other. 
582
# programs which support those fields. 
583
# Note: wordpad (write) and others do not support links. 
584
585
RTF_HYPERLINKS         = NO
586
587
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
588
# config file, i.e. a series of assigments. You only have to provide 
589
# replacements, missing definitions are set to their default value. 
590
591
RTF_STYLESHEET_FILE    = 
592
593
#---------------------------------------------------------------------------
594
# configuration options related to the man page output
595
#---------------------------------------------------------------------------
596
597
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
598
# generate man pages 
599
600
GENERATE_MAN           = YES
601
602
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
603
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
604
# put in front of it. If left blank `man' will be used as the default path. 
605
606
MAN_OUTPUT             = man
607
608
# The MAN_EXTENSION tag determines the extension that is added to 
609
# the generated man pages (default is the subroutine's section .3) 
610
611
MAN_EXTENSION          = .3
612
613
#---------------------------------------------------------------------------
614
# Configuration options related to the preprocessor   
615
#---------------------------------------------------------------------------
616
617
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
618
# evaluate all C-preprocessor directives found in the sources and include 
619
# files. 
620
621
ENABLE_PREPROCESSING   = YES
622
623
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
624
# names in the source code. If set to NO (the default) only conditional 
625
# compilation will be performed. Macro expansion can be done in a controlled 
626
# way by setting EXPAND_ONLY_PREDEF to YES. 
627
628
MACRO_EXPANSION        = NO
629
630
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
631
# then the macro expansion is limited to the macros specified with the 
632
# PREDEFINED and EXPAND_AS_PREDEFINED tags. 
633
634
EXPAND_ONLY_PREDEF     = NO
635
636
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
637
# in the INCLUDE_PATH (see below) will be search if a #include is found. 
638
639
SEARCH_INCLUDES        = YES
640
641
# The INCLUDE_PATH tag can be used to specify one or more directories that 
642
# contain include files that are not input files but should be processed by 
643
# the preprocessor. 
644
645
INCLUDE_PATH           = 
646
647
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
648
# patterns (like *.h and *.hpp) to filter out the header-files in the 
649
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
650
# be used. 
651
652
INCLUDE_FILE_PATTERNS  = 
653
654
# The PREDEFINED tag can be used to specify one or more macro names that 
655
# are defined before the preprocessor is started (similar to the -D option of 
656
# gcc). The argument of the tag is a list of macros of the form: name 
657
# or name=definition (no spaces). If the definition and the = are 
658
# omitted =1 is assumed. 
659
660
PREDEFINED             = 
661
662
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then 
663
# this tag can be used to specify a list of macro names that should be expanded. 
664
# The macro definition that is found in the sources will be used. 
665
# Use the PREDEFINED tag if you want to use a different macro definition. 
666
667
EXPAND_AS_DEFINED      = 
668
669
#---------------------------------------------------------------------------
670
# Configuration::addtions related to external references   
671
#---------------------------------------------------------------------------
672
673
# The TAGFILES tag can be used to specify one or more tagfiles. 
674
675
TAGFILES               = 
676
677
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
678
# a tag file that is based on the input files it reads. 
679
680
GENERATE_TAGFILE       = 
681
682
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
683
# in the class index. If set to NO only the inherited external classes 
684
# will be listed. 
685
686
ALLEXTERNALS           = NO
687
688
# The PERL_PATH should be the absolute path and name of the perl script 
689
# interpreter (i.e. the result of `which perl'). 
690
691
PERL_PATH              = /usr/bin/perl
692
693
#---------------------------------------------------------------------------
694
# Configuration options related to the dot tool   
695
#---------------------------------------------------------------------------
696
697
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
698
# available from the path. This tool is part of Graphviz, a graph visualization 
699
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
700
# have no effect if this option is set to NO (the default) 
701
702
HAVE_DOT               = NO
703
704
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
705
# will generate a graph for each documented class showing the direct and 
706
# indirect inheritance relations. Setting this tag to YES will force the 
707
# the CLASS_DIAGRAMS tag to NO.
708
709
CLASS_GRAPH            = YES
710
711
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
712
# will generate a graph for each documented class showing the direct and 
713
# indirect implementation dependencies (inheritance, containment, and 
714
# class references variables) of the class with other documented classes. 
715
716
COLLABORATION_GRAPH    = YES
717
718
# If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to 
719
# YES then doxygen will generate a graph for each documented file showing 
720
# the direct and indirect include dependencies of the file with other 
721
# documented files. 
722
723
INCLUDE_GRAPH          = YES
724
725
# If the ENABLE_PREPROCESSING, INCLUDED_BY_GRAPH, and HAVE_DOT tags are set to 
726
# YES then doxygen will generate a graph for each documented header file showing 
727
# the documented files that directly or indirectly include this file 
728
729
INCLUDED_BY_GRAPH      = YES
730
731
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
732
# will graphical hierarchy of all classes instead of a textual one. 
733
734
GRAPHICAL_HIERARCHY    = YES
735
736
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
737
# found. If left blank, it is assumed the dot tool can be found on the path. 
738
739
DOT_PATH               = 
740
741
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
742
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
743
# this value, doxygen will try to truncate the graph, so that it fits within 
744
# the specified constraint. Beware that most browsers cannot cope with very 
745
# large images. 
746
747
MAX_DOT_GRAPH_WIDTH    = 1024
748
749
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
750
# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
751
# this value, doxygen will try to truncate the graph, so that it fits within 
752
# the specified constraint. Beware that most browsers cannot cope with very 
753
# large images. 
754
755
MAX_DOT_GRAPH_HEIGHT   = 1024
756
757
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
758
# generate a legend page explaining the meaning of the various boxes and 
759
# arrows in the dot generated graphs. 
760
761
GENERATE_LEGEND        = YES
762
763
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
764
# remove the intermedate dot files that are used to generate 
765
# the various graphs. 
766
767
DOT_CLEANUP            = YES
768
769
#---------------------------------------------------------------------------
770
# Configuration::addtions related to the search engine   
771
#---------------------------------------------------------------------------
772
773
# The SEARCHENGINE tag specifies whether or not a search engine should be 
774
# used. If set to NO the values of all tags below this one will be ignored. 
775
776
SEARCHENGINE           = NO
777
778
# The CGI_NAME tag should be the name of the CGI script that 
779
# starts the search engine (doxysearch) with the correct parameters. 
780
# A script with this name will be generated by doxygen. 
781
782
CGI_NAME               = search.cgi
783
784
# The CGI_URL tag should be the absolute URL to the directory where the 
785
# cgi binaries are located. See the documentation of your http daemon for 
786
# details. 
787
788
CGI_URL                = 
789
790
# The DOC_URL tag should be the absolute URL to the directory where the 
791
# documentation is located. If left blank the absolute path to the 
792
# documentation, with file:// prepended to it, will be used. 
793
794
DOC_URL                = 
795
796
# The DOC_ABSPATH tag should be the absolute path to the directory where the 
797
# documentation is located. If left blank the directory on the local machine 
798
# will be used. 
799
800
DOC_ABSPATH            = 
801
802
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary 
803
# is installed. 
804
805
BIN_ABSPATH            = /usr/local/bin/
806
807
# The EXT_DOC_PATHS tag can be used to specify one or more paths to 
808
# documentation generated for other projects. This allows doxysearch to search 
809
# the documentation for these projects as well. 
810
811
EXT_DOC_PATHS          =