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