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