OSDN Git Service

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