OSDN Git Service

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