OSDN Git Service

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