doxygen: blenkernel under core as module.
[blender.git] / doc / Doxyfile
1 # Doxyfile 1.7.3
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 # Project related configuration options
15 #---------------------------------------------------------------------------
16
17 # This tag specifies the encoding used for all characters in the config file 
18 # that follow. The default is UTF-8 which is also the encoding used for all 
19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the 
20 # iconv built into libc) for the transcoding. See 
21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23 DOXYFILE_ENCODING      = UTF-8
24
25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
26 # by quotes) that should identify the project.
27
28 PROJECT_NAME           = Blender
29
30 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
31 # This could be handy for archiving the generated documentation or 
32 # if some version control system is used.
33
34 PROJECT_NUMBER         = "V2.56a BETA"
35
36 # Using the PROJECT_BRIEF tag one can provide an optional one line description
37 # for a project that appears at the top of each page and should give viewer
38 # a quick idea about the purpose of the project. Keep the description short.
39
40 PROJECT_BRIEF          = 
41
42 # With the PROJECT_LOGO tag one can specify an logo or icon that is 
43 # included in the documentation. The maximum height of the logo should not 
44 # exceed 55 pixels and the maximum width should not exceed 200 pixels. 
45 # Doxygen will copy the logo to the output directory.
46
47 PROJECT_LOGO           = ../release/freedesktop/icons/48x48/blender.png
48
49 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
50 # base path where the generated documentation will be put. 
51 # If a relative path is entered, it will be relative to the location 
52 # where doxygen was started. If left blank the current directory will be used.
53
54 OUTPUT_DIRECTORY       = 
55
56 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
57 # 4096 sub-directories (in 2 levels) under the output directory of each output 
58 # format and will distribute the generated files over these directories. 
59 # Enabling this option can be useful when feeding doxygen a huge amount of 
60 # source files, where putting all generated files in the same directory would 
61 # otherwise cause performance problems for the file system.
62
63 CREATE_SUBDIRS         = YES
64
65 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
66 # documentation generated by doxygen is written. Doxygen will use this 
67 # information to generate all constant output in the proper language. 
68 # The default language is English, other supported languages are: 
69 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
70 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 
71 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 
72 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 
73 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, 
74 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
75
76 OUTPUT_LANGUAGE        = English
77
78 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
79 # include brief member descriptions after the members that are listed in 
80 # the file and class documentation (similar to JavaDoc). 
81 # Set to NO to disable this.
82
83 BRIEF_MEMBER_DESC      = YES
84
85 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
86 # the brief description of a member or function before the detailed description. 
87 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
88 # brief descriptions will be completely suppressed.
89
90 REPEAT_BRIEF           = YES
91
92 # This tag implements a quasi-intelligent brief description abbreviator 
93 # that is used to form the text in various listings. Each string 
94 # in this list, if found as the leading text of the brief description, will be 
95 # stripped from the text and the result after processing the whole list, is 
96 # used as the annotated text. Otherwise, the brief description is used as-is. 
97 # If left blank, the following values are used ("$name" is automatically 
98 # replaced with the name of the entity): "The $name class" "The $name widget" 
99 # "The $name file" "is" "provides" "specifies" "contains" 
100 # "represents" "a" "an" "the"
101
102 ABBREVIATE_BRIEF       = "The $name class" \
103                          "The $name widget" \
104                          "The $name file" \
105                          is \
106                          provides \
107                          specifies \
108                          contains \
109                          represents \
110                          a \
111                          an \
112                          the
113
114 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
115 # Doxygen will generate a detailed section even if there is only a brief 
116 # description.
117
118 ALWAYS_DETAILED_SEC    = NO
119
120 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
121 # inherited members of a class in the documentation of that class as if those 
122 # members were ordinary class members. Constructors, destructors and assignment 
123 # operators of the base classes will not be shown.
124
125 INLINE_INHERITED_MEMB  = NO
126
127 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
128 # path before files name in the file list and in the header files. If set 
129 # to NO the shortest path that makes the file name unique will be used.
130
131 FULL_PATH_NAMES        = NO
132
133 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
134 # can be used to strip a user-defined part of the path. Stripping is 
135 # only done if one of the specified strings matches the left-hand part of 
136 # the path. The tag can be used to show relative paths in the file list. 
137 # If left blank the directory from which doxygen is run is used as the 
138 # path to strip.
139
140 STRIP_FROM_PATH        = 
141
142 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
143 # the path mentioned in the documentation of a class, which tells 
144 # the reader which header file to include in order to use a class. 
145 # If left blank only the name of the header file containing the class 
146 # definition is used. Otherwise one should specify the include paths that 
147 # are normally passed to the compiler using the -I flag.
148
149 STRIP_FROM_INC_PATH    = 
150
151 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
152 # (but less readable) file names. This can be useful if your file system 
153 # doesn't support long names like on DOS, Mac, or CD-ROM.
154
155 SHORT_NAMES            = NO
156
157 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
158 # will interpret the first line (until the first dot) of a JavaDoc-style 
159 # comment as the brief description. If set to NO, the JavaDoc 
160 # comments will behave just like regular Qt-style comments 
161 # (thus requiring an explicit @brief command for a brief description.)
162
163 JAVADOC_AUTOBRIEF      = NO
164
165 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
166 # interpret the first line (until the first dot) of a Qt-style 
167 # comment as the brief description. If set to NO, the comments 
168 # will behave just like regular Qt-style comments (thus requiring 
169 # an explicit \brief command for a brief description.)
170
171 QT_AUTOBRIEF           = NO
172
173 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
174 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
175 # comments) as a brief description. This used to be the default behaviour. 
176 # The new default is to treat a multi-line C++ comment block as a detailed 
177 # description. Set this tag to YES if you prefer the old behaviour instead.
178
179 MULTILINE_CPP_IS_BRIEF = NO
180
181 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
182 # member inherits the documentation from any documented member that it 
183 # re-implements.
184
185 INHERIT_DOCS           = YES
186
187 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
188 # a new page for each member. If set to NO, the documentation of a member will 
189 # be part of the file/class/namespace that contains it.
190
191 SEPARATE_MEMBER_PAGES  = NO
192
193 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
194 # Doxygen uses this value to replace tabs by spaces in code fragments.
195
196 TAB_SIZE               = 8
197
198 # This tag can be used to specify a number of aliases that acts 
199 # as commands in the documentation. An alias has the form "name=value". 
200 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
201 # put the command \sideeffect (or @sideeffect) in the documentation, which 
202 # will result in a user-defined paragraph with heading "Side Effects:". 
203 # You can put \n's in the value part of an alias to insert newlines.
204
205 ALIASES                = 
206
207 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
208 # sources only. Doxygen will then generate output that is more tailored for C. 
209 # For instance, some of the names that are used will be different. The list 
210 # of all members will be omitted, etc.
211
212 OPTIMIZE_OUTPUT_FOR_C  = NO
213
214 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
215 # sources only. Doxygen will then generate output that is more tailored for 
216 # Java. For instance, namespaces will be presented as packages, qualified 
217 # scopes will look different, etc.
218
219 OPTIMIZE_OUTPUT_JAVA   = NO
220
221 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
222 # sources only. Doxygen will then generate output that is more tailored for 
223 # Fortran.
224
225 OPTIMIZE_FOR_FORTRAN   = NO
226
227 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
228 # sources. Doxygen will then generate output that is tailored for 
229 # VHDL.
230
231 OPTIMIZE_OUTPUT_VHDL   = NO
232
233 # Doxygen selects the parser to use depending on the extension of the files it 
234 # parses. With this tag you can assign which parser to use for a given extension. 
235 # Doxygen has a built-in mapping, but you can override or extend it using this 
236 # tag. The format is ext=language, where ext is a file extension, and language 
237 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 
238 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 
239 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 
240 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 
241 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
242
243 EXTENSION_MAPPING      = 
244
245 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
246 # to include (a tag file for) the STL sources as input, then you should 
247 # set this tag to YES in order to let doxygen match functions declarations and 
248 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
249 # func(std::string) {}). This also makes the inheritance and collaboration 
250 # diagrams that involve STL classes more complete and accurate.
251
252 BUILTIN_STL_SUPPORT    = NO
253
254 # If you use Microsoft's C++/CLI language, you should set this option to YES to 
255 # enable parsing support.
256
257 CPP_CLI_SUPPORT        = NO
258
259 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
260 # Doxygen will parse them like normal C++ but will assume all classes use public 
261 # instead of private inheritance when no explicit protection keyword is present.
262
263 SIP_SUPPORT            = NO
264
265 # For Microsoft's IDL there are propget and propput attributes to indicate getter 
266 # and setter methods for a property. Setting this option to YES (the default) 
267 # will make doxygen replace the get and set methods by a property in the 
268 # documentation. This will only work if the methods are indeed getting or 
269 # setting a simple type. If this is not the case, or you want to show the 
270 # methods anyway, you should set this option to NO.
271
272 IDL_PROPERTY_SUPPORT   = YES
273
274 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
275 # tag is set to YES, then doxygen will reuse the documentation of the first 
276 # member in the group (if any) for the other members of the group. By default 
277 # all members of a group must be documented explicitly.
278
279 DISTRIBUTE_GROUP_DOC   = YES
280
281 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
282 # the same type (for instance a group of public functions) to be put as a 
283 # subgroup of that type (e.g. under the Public Functions section). Set it to 
284 # NO to prevent subgrouping. Alternatively, this can be done per class using 
285 # the \nosubgrouping command.
286
287 SUBGROUPING            = YES
288
289 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
290 # is documented as struct, union, or enum with the name of the typedef. So 
291 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
292 # with name TypeT. When disabled the typedef will appear as a member of a file, 
293 # namespace, or class. And the struct will be named TypeS. This can typically 
294 # be useful for C code in case the coding convention dictates that all compound 
295 # types are typedef'ed and only the typedef is referenced, never the tag name.
296
297 TYPEDEF_HIDES_STRUCT   = NO
298
299 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
300 # determine which symbols to keep in memory and which to flush to disk. 
301 # When the cache is full, less often used symbols will be written to disk. 
302 # For small to medium size projects (<1000 input files) the default value is 
303 # probably good enough. For larger projects a too small cache size can cause 
304 # doxygen to be busy swapping symbols to and from disk most of the time 
305 # causing a significant performance penalty. 
306 # If the system has enough physical memory increasing the cache will improve the 
307 # performance by keeping more symbols in memory. Note that the value works on 
308 # a logarithmic scale so increasing the size by one will roughly double the 
309 # memory usage. The cache size is given by this formula: 
310 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
311 # corresponding to a cache size of 2^16 = 65536 symbols
312
313 SYMBOL_CACHE_SIZE      = 0
314
315 #---------------------------------------------------------------------------
316 # Build related configuration options
317 #---------------------------------------------------------------------------
318
319 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
320 # documentation are documented, even if no documentation was available. 
321 # Private class members and static file members will be hidden unless 
322 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
323
324 EXTRACT_ALL            = YES
325
326 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
327 # will be included in the documentation.
328
329 EXTRACT_PRIVATE        = NO
330
331 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
332 # will be included in the documentation.
333
334 EXTRACT_STATIC         = YES
335
336 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
337 # defined locally in source files will be included in the documentation. 
338 # If set to NO only classes defined in header files are included.
339
340 EXTRACT_LOCAL_CLASSES  = YES
341
342 # This flag is only useful for Objective-C code. When set to YES local 
343 # methods, which are defined in the implementation section but not in 
344 # the interface are included in the documentation. 
345 # If set to NO (the default) only methods in the interface are included.
346
347 EXTRACT_LOCAL_METHODS  = NO
348
349 # If this flag is set to YES, the members of anonymous namespaces will be 
350 # extracted and appear in the documentation as a namespace called 
351 # 'anonymous_namespace{file}', where file will be replaced with the base 
352 # name of the file that contains the anonymous namespace. By default 
353 # anonymous namespaces are hidden.
354
355 EXTRACT_ANON_NSPACES   = NO
356
357 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
358 # undocumented members of documented classes, files or namespaces. 
359 # If set to NO (the default) these members will be included in the 
360 # various overviews, but no documentation section is generated. 
361 # This option has no effect if EXTRACT_ALL is enabled.
362
363 HIDE_UNDOC_MEMBERS     = NO
364
365 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
366 # undocumented classes that are normally visible in the class hierarchy. 
367 # If set to NO (the default) these classes will be included in the various 
368 # overviews. This option has no effect if EXTRACT_ALL is enabled.
369
370 HIDE_UNDOC_CLASSES     = NO
371
372 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
373 # friend (class|struct|union) declarations. 
374 # If set to NO (the default) these declarations will be included in the 
375 # documentation.
376
377 HIDE_FRIEND_COMPOUNDS  = NO
378
379 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
380 # documentation blocks found inside the body of a function. 
381 # If set to NO (the default) these blocks will be appended to the 
382 # function's detailed documentation block.
383
384 HIDE_IN_BODY_DOCS      = NO
385
386 # The INTERNAL_DOCS tag determines if documentation 
387 # that is typed after a \internal command is included. If the tag is set 
388 # to NO (the default) then the documentation will be excluded. 
389 # Set it to YES to include the internal documentation.
390
391 INTERNAL_DOCS          = YES
392
393 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
394 # file names in lower-case letters. If set to YES upper-case letters are also 
395 # allowed. This is useful if you have classes or files whose names only differ 
396 # in case and if your file system supports case sensitive file names. Windows 
397 # and Mac users are advised to set this option to NO.
398
399 CASE_SENSE_NAMES       = YES
400
401 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
402 # will show members with their full class and namespace scopes in the 
403 # documentation. If set to YES the scope will be hidden.
404
405 HIDE_SCOPE_NAMES       = NO
406
407 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
408 # will put a list of the files that are included by a file in the documentation 
409 # of that file.
410
411 SHOW_INCLUDE_FILES     = YES
412
413 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 
414 # will list include files with double quotes in the documentation 
415 # rather than with sharp brackets.
416
417 FORCE_LOCAL_INCLUDES   = NO
418
419 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
420 # is inserted in the documentation for inline members.
421
422 INLINE_INFO            = YES
423
424 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
425 # will sort the (detailed) documentation of file and class members 
426 # alphabetically by member name. If set to NO the members will appear in 
427 # declaration order.
428
429 SORT_MEMBER_DOCS       = YES
430
431 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
432 # brief documentation of file, namespace and class members alphabetically 
433 # by member name. If set to NO (the default) the members will appear in 
434 # declaration order.
435
436 SORT_BRIEF_DOCS        = NO
437
438 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 
439 # will sort the (brief and detailed) documentation of class members so that 
440 # constructors and destructors are listed first. If set to NO (the default) 
441 # the constructors will appear in the respective orders defined by 
442 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 
443 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 
444 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
445
446 SORT_MEMBERS_CTORS_1ST = NO
447
448 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
449 # hierarchy of group names into alphabetical order. If set to NO (the default) 
450 # the group names will appear in their defined order.
451
452 SORT_GROUP_NAMES       = NO
453
454 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
455 # sorted by fully-qualified names, including namespaces. If set to 
456 # NO (the default), the class list will be sorted only by class name, 
457 # not including the namespace part. 
458 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
459 # Note: This option applies only to the class list, not to the 
460 # alphabetical list.
461
462 SORT_BY_SCOPE_NAME     = NO
463
464 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
465 # do proper type resolution of all parameters of a function it will reject a 
466 # match between the prototype and the implementation of a member function even
467 # if there is only one candidate or it is obvious which candidate to choose
468 # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen 
469 # will still accept a match between prototype and implementation in such cases.
470
471 STRICT_PROTO_MATCHING  = NO
472
473 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
474 # disable (NO) the todo list. This list is created by putting \todo 
475 # commands in the documentation.
476
477 GENERATE_TODOLIST      = YES
478
479 # The GENERATE_TESTLIST tag can be used to enable (YES) or 
480 # disable (NO) the test list. This list is created by putting \test 
481 # commands in the documentation.
482
483 GENERATE_TESTLIST      = YES
484
485 # The GENERATE_BUGLIST tag can be used to enable (YES) or 
486 # disable (NO) the bug list. This list is created by putting \bug 
487 # commands in the documentation.
488
489 GENERATE_BUGLIST       = YES
490
491 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
492 # disable (NO) the deprecated list. This list is created by putting 
493 # \deprecated commands in the documentation.
494
495 GENERATE_DEPRECATEDLIST= YES
496
497 # The ENABLED_SECTIONS tag can be used to enable conditional 
498 # documentation sections, marked by \if sectionname ... \endif.
499
500 ENABLED_SECTIONS       = 
501
502 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
503 # the initial value of a variable or macro consists of for it to appear in 
504 # the documentation. If the initializer consists of more lines than specified 
505 # here it will be hidden. Use a value of 0 to hide initializers completely. 
506 # The appearance of the initializer of individual variables and macros in the 
507 # documentation can be controlled using \showinitializer or \hideinitializer 
508 # command in the documentation regardless of this setting.
509
510 MAX_INITIALIZER_LINES  = 30
511
512 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
513 # at the bottom of the documentation of classes and structs. If set to YES the 
514 # list will mention the files that were used to generate the documentation.
515
516 SHOW_USED_FILES        = YES
517
518 # If the sources in your project are distributed over multiple directories 
519 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
520 # in the documentation. The default is NO.
521
522 SHOW_DIRECTORIES       = NO
523
524 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 
525 # This will remove the Files entry from the Quick Index and from the 
526 # Folder Tree View (if specified). The default is YES.
527
528 SHOW_FILES             = YES
529
530 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
531 # Namespaces page.  This will remove the Namespaces entry from the Quick Index 
532 # and from the Folder Tree View (if specified). The default is YES.
533
534 SHOW_NAMESPACES        = YES
535
536 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 
537 # doxygen should invoke to get the current version for each file (typically from 
538 # the version control system). Doxygen will invoke the program by executing (via 
539 # popen()) the command <command> <input-file>, where <command> is the value of 
540 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
541 # provided by doxygen. Whatever the program writes to standard output 
542 # is used as the file version. See the manual for examples.
543
544 FILE_VERSION_FILTER    = 
545
546 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 
547 # by doxygen. The layout file controls the global structure of the generated 
548 # output files in an output format independent way. The create the layout file 
549 # that represents doxygen's defaults, run doxygen with the -l option. 
550 # You can optionally specify a file name after the option, if omitted 
551 # DoxygenLayout.xml will be used as the name of the layout file.
552
553 LAYOUT_FILE            = 
554
555 #---------------------------------------------------------------------------
556 # configuration options related to warning and progress messages
557 #---------------------------------------------------------------------------
558
559 # The QUIET tag can be used to turn on/off the messages that are generated 
560 # by doxygen. Possible values are YES and NO. If left blank NO is used.
561
562 QUIET                  = NO
563
564 # The WARNINGS tag can be used to turn on/off the warning messages that are 
565 # generated by doxygen. Possible values are YES and NO. If left blank 
566 # NO is used.
567
568 WARNINGS               = YES
569
570 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
571 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
572 # automatically be disabled.
573
574 WARN_IF_UNDOCUMENTED   = YES
575
576 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
577 # potential errors in the documentation, such as not documenting some 
578 # parameters in a documented function, or documenting parameters that 
579 # don't exist or using markup commands wrongly.
580
581 WARN_IF_DOC_ERROR      = YES
582
583 # The WARN_NO_PARAMDOC option can be enabled to get warnings for 
584 # functions that are documented, but have no documentation for their parameters 
585 # or return value. If set to NO (the default) doxygen will only warn about 
586 # wrong or incomplete parameter documentation, but not about the absence of 
587 # documentation.
588
589 WARN_NO_PARAMDOC       = NO
590
591 # The WARN_FORMAT tag determines the format of the warning messages that 
592 # doxygen can produce. The string should contain the $file, $line, and $text 
593 # tags, which will be replaced by the file and line number from which the 
594 # warning originated and the warning text. Optionally the format may contain 
595 # $version, which will be replaced by the version of the file (if it could 
596 # be obtained via FILE_VERSION_FILTER)
597
598 WARN_FORMAT            = "$file:$line: $text"
599
600 # The WARN_LOGFILE tag can be used to specify a file to which warning 
601 # and error messages should be written. If left blank the output is written 
602 # to stderr.
603
604 WARN_LOGFILE           = 
605
606 #---------------------------------------------------------------------------
607 # configuration options related to the input files
608 #---------------------------------------------------------------------------
609
610 # The INPUT tag can be used to specify the files and/or directories that contain 
611 # documented source files. You may enter file names like "myfile.cpp" or 
612 # directories like "/usr/src/myproject". Separate the files or directories 
613 # with spaces.
614
615 INPUT                  = doxygen.main \
616                          ../intern/mikktspace \
617                          ../source/blender/imbuf \
618                          ../source/blender/blenkernel \
619                          ../source/blender/collada \
620                          ../source/blender/editors/interface \
621                          ../source/blender/editors/include \
622                          ../source/blender/windowmanager \
623                          ../source/blender/makesdna \
624                          ../source/blender/makesrna \
625                          ../intern/ghost \
626                          ../source/blender/blenloader \
627                          ../source/blender/readblenfile \
628                          ../source/blender/blenkernel
629
630 # This tag can be used to specify the character encoding of the source files 
631 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
632 # also the default input encoding. Doxygen uses libiconv (or the iconv built 
633 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
634 # the list of possible encodings.
635
636 INPUT_ENCODING         = UTF-8
637
638 # If the value of the INPUT tag contains directories, you can use the 
639 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
640 # and *.h) to filter out the source-files in the directories. If left 
641 # blank the following patterns are tested: 
642 # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh 
643 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py 
644 # *.f90 *.f *.for *.vhd *.vhdl
645
646 FILE_PATTERNS          = 
647
648 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
649 # should be searched for input files as well. Possible values are YES and NO. 
650 # If left blank NO is used.
651
652 RECURSIVE              = YES
653
654 # The EXCLUDE tag can be used to specify files and/or directories that should 
655 # excluded from the INPUT source files. This way you can easily exclude a 
656 # subdirectory from a directory tree whose root is specified with the INPUT tag.
657
658 EXCLUDE                = 
659
660 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
661 # directories that are symbolic links (a Unix file system feature) are excluded 
662 # from the input.
663
664 EXCLUDE_SYMLINKS       = NO
665
666 # If the value of the INPUT tag contains directories, you can use the 
667 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
668 # certain files from those directories. Note that the wildcards are matched 
669 # against the file with absolute path, so to exclude all test directories 
670 # for example use the pattern */test/*
671
672 EXCLUDE_PATTERNS       = .svn
673
674 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
675 # (namespaces, classes, functions, etc.) that should be excluded from the 
676 # output. The symbol name can be a fully qualified name, a word, or if the 
677 # wildcard * is used, a substring. Examples: ANamespace, AClass, 
678 # AClass::ANamespace, ANamespace::*Test
679
680 EXCLUDE_SYMBOLS        = 
681
682 # The EXAMPLE_PATH tag can be used to specify one or more files or 
683 # directories that contain example code fragments that are included (see 
684 # the \include command).
685
686 EXAMPLE_PATH           = 
687
688 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
689 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
690 # and *.h) to filter out the source-files in the directories. If left 
691 # blank all files are included.
692
693 EXAMPLE_PATTERNS       = 
694
695 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
696 # searched for input files to be used with the \include or \dontinclude 
697 # commands irrespective of the value of the RECURSIVE tag. 
698 # Possible values are YES and NO. If left blank NO is used.
699
700 EXAMPLE_RECURSIVE      = NO
701
702 # The IMAGE_PATH tag can be used to specify one or more files or 
703 # directories that contain image that are included in the documentation (see 
704 # the \image command).
705
706 IMAGE_PATH             = 
707
708 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
709 # invoke to filter for each input file. Doxygen will invoke the filter program 
710 # by executing (via popen()) the command <filter> <input-file>, where <filter> 
711 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
712 # input file. Doxygen will then use the output that the filter program writes 
713 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
714 # ignored.
715
716 INPUT_FILTER           = 
717
718 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
719 # basis.  Doxygen will compare the file name with each pattern and apply the 
720 # filter if there is a match.  The filters are a list of the form: 
721 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
722 # info on how filters are used. If FILTER_PATTERNS is empty or if 
723 # non of the patterns match the file name, INPUT_FILTER is applied.
724
725 FILTER_PATTERNS        = 
726
727 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
728 # INPUT_FILTER) will be used to filter the input files when producing source 
729 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
730
731 FILTER_SOURCE_FILES    = NO
732
733 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 
734 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) 
735 # and it is also possible to disable source filtering for a specific pattern 
736 # using *.ext= (so without naming a filter). This option only has effect when 
737 # FILTER_SOURCE_FILES is enabled.
738
739 FILTER_SOURCE_PATTERNS = 
740
741 #---------------------------------------------------------------------------
742 # configuration options related to source browsing
743 #---------------------------------------------------------------------------
744
745 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
746 # be generated. Documented entities will be cross-referenced with these sources. 
747 # Note: To get rid of all source code in the generated output, make sure also 
748 # VERBATIM_HEADERS is set to NO.
749
750 SOURCE_BROWSER         = YES
751
752 # Setting the INLINE_SOURCES tag to YES will include the body 
753 # of functions and classes directly in the documentation.
754
755 INLINE_SOURCES         = NO
756
757 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
758 # doxygen to hide any special comment blocks from generated source code 
759 # fragments. Normal C and C++ comments will always remain visible.
760
761 STRIP_CODE_COMMENTS    = YES
762
763 # If the REFERENCED_BY_RELATION tag is set to YES 
764 # then for each documented function all documented 
765 # functions referencing it will be listed.
766
767 REFERENCED_BY_RELATION = YES
768
769 # If the REFERENCES_RELATION tag is set to YES 
770 # then for each documented function all documented entities 
771 # called/used by that function will be listed.
772
773 REFERENCES_RELATION    = YES
774
775 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
776 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
777 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
778 # link to the source code.  Otherwise they will link to the documentation.
779
780 REFERENCES_LINK_SOURCE = YES
781
782 # If the USE_HTAGS tag is set to YES then the references to source code 
783 # will point to the HTML generated by the htags(1) tool instead of doxygen 
784 # built-in source browser. The htags tool is part of GNU's global source 
785 # tagging system (see http://www.gnu.org/software/global/global.html). You 
786 # will need version 4.8.6 or higher.
787
788 USE_HTAGS              = NO
789
790 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
791 # will generate a verbatim copy of the header file for each class for 
792 # which an include is specified. Set to NO to disable this.
793
794 VERBATIM_HEADERS       = YES
795
796 #---------------------------------------------------------------------------
797 # configuration options related to the alphabetical class index
798 #---------------------------------------------------------------------------
799
800 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
801 # of all compounds will be generated. Enable this if the project 
802 # contains a lot of classes, structs, unions or interfaces.
803
804 ALPHABETICAL_INDEX     = YES
805
806 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
807 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
808 # in which this list will be split (can be a number in the range [1..20])
809
810 COLS_IN_ALPHA_INDEX    = 5
811
812 # In case all classes in a project start with a common prefix, all 
813 # classes will be put under the same header in the alphabetical index. 
814 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
815 # should be ignored while generating the index headers.
816
817 IGNORE_PREFIX          = 
818
819 #---------------------------------------------------------------------------
820 # configuration options related to the HTML output
821 #---------------------------------------------------------------------------
822
823 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
824 # generate HTML output.
825
826 GENERATE_HTML          = YES
827
828 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
829 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
830 # put in front of it. If left blank `html' will be used as the default path.
831
832 HTML_OUTPUT            = html
833
834 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
835 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
836 # doxygen will generate files with .html extension.
837
838 HTML_FILE_EXTENSION    = .html
839
840 # The HTML_HEADER tag can be used to specify a personal HTML header for 
841 # each generated HTML page. If it is left blank doxygen will generate a 
842 # standard header.
843
844 HTML_HEADER            = 
845
846 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
847 # each generated HTML page. If it is left blank doxygen will generate a 
848 # standard footer.
849
850 HTML_FOOTER            = 
851
852 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
853 # style sheet that is used by each HTML page. It can be used to 
854 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
855 # will generate a default style sheet. Note that doxygen will try to copy 
856 # the style sheet file to the HTML output directory, so don't put your own 
857 # stylesheet in the HTML output directory as well, or it will be erased!
858
859 HTML_STYLESHEET        = 
860
861 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 
862 # Doxygen will adjust the colors in the stylesheet and background images 
863 # according to this color. Hue is specified as an angle on a colorwheel, 
864 # see http://en.wikipedia.org/wiki/Hue for more information. 
865 # For instance the value 0 represents red, 60 is yellow, 120 is green, 
866 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 
867 # The allowed range is 0 to 359.
868
869 HTML_COLORSTYLE_HUE    = 220
870
871 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 
872 # the colors in the HTML output. For a value of 0 the output will use 
873 # grayscales only. A value of 255 will produce the most vivid colors.
874
875 HTML_COLORSTYLE_SAT    = 100
876
877 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 
878 # the luminance component of the colors in the HTML output. Values below 
879 # 100 gradually make the output lighter, whereas values above 100 make 
880 # the output darker. The value divided by 100 is the actual gamma applied, 
881 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 
882 # and 100 does not change the gamma.
883
884 HTML_COLORSTYLE_GAMMA  = 80
885
886 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 
887 # page will contain the date and time when the page was generated. Setting 
888 # this to NO can help when comparing the output of multiple runs.
889
890 HTML_TIMESTAMP         = YES
891
892 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
893 # files or namespaces will be aligned in HTML using tables. If set to 
894 # NO a bullet list will be used.
895
896 HTML_ALIGN_MEMBERS     = YES
897
898 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
899 # documentation will contain sections that can be hidden and shown after the 
900 # page has loaded. For this to work a browser that supports 
901 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
902 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
903
904 HTML_DYNAMIC_SECTIONS  = NO
905
906 # If the GENERATE_DOCSET tag is set to YES, additional index files 
907 # will be generated that can be used as input for Apple's Xcode 3 
908 # integrated development environment, introduced with OSX 10.5 (Leopard). 
909 # To create a documentation set, doxygen will generate a Makefile in the 
910 # HTML output directory. Running make will produce the docset in that 
911 # directory and running "make install" will install the docset in 
912 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
913 # it at startup. 
914 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 
915 # for more information.
916
917 GENERATE_DOCSET        = NO
918
919 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
920 # feed. A documentation feed provides an umbrella under which multiple 
921 # documentation sets from a single provider (such as a company or product suite) 
922 # can be grouped.
923
924 DOCSET_FEEDNAME        = "Doxygen generated docs"
925
926 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
927 # should uniquely identify the documentation set bundle. This should be a 
928 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
929 # will append .docset to the name.
930
931 DOCSET_BUNDLE_ID       = org.doxygen.Project
932
933 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 
934 # the documentation publisher. This should be a reverse domain-name style 
935 # string, e.g. com.mycompany.MyDocSet.documentation.
936
937 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
938
939 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
940
941 DOCSET_PUBLISHER_NAME  = Publisher
942
943 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
944 # will be generated that can be used as input for tools like the 
945 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
946 # of the generated HTML documentation.
947
948 GENERATE_HTMLHELP      = YES
949
950 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
951 # be used to specify the file name of the resulting .chm file. You 
952 # can add a path in front of the file if the result should not be 
953 # written to the html output directory.
954
955 CHM_FILE               = 
956
957 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
958 # be used to specify the location (absolute path including file name) of 
959 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
960 # the HTML help compiler on the generated index.hhp.
961
962 HHC_LOCATION           = 
963
964 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
965 # controls if a separate .chi index file is generated (YES) or that 
966 # it should be included in the master .chm file (NO).
967
968 GENERATE_CHI           = NO
969
970 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
971 # is used to encode HtmlHelp index (hhk), content (hhc) and project file 
972 # content.
973
974 CHM_INDEX_ENCODING     = 
975
976 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
977 # controls whether a binary table of contents is generated (YES) or a 
978 # normal table of contents (NO) in the .chm file.
979
980 BINARY_TOC             = NO
981
982 # The TOC_EXPAND flag can be set to YES to add extra items for group members 
983 # to the contents of the HTML help documentation and to the tree view.
984
985 TOC_EXPAND             = NO
986
987 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 
988 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 
989 # that can be used as input for Qt's qhelpgenerator to generate a 
990 # Qt Compressed Help (.qch) of the generated HTML documentation.
991
992 GENERATE_QHP           = NO
993
994 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
995 # be used to specify the file name of the resulting .qch file. 
996 # The path specified is relative to the HTML output folder.
997
998 QCH_FILE               = 
999
1000 # The QHP_NAMESPACE tag specifies the namespace to use when generating 
1001 # Qt Help Project output. For more information please see 
1002 # http://doc.trolltech.com/qthelpproject.html#namespace
1003
1004 QHP_NAMESPACE          = org.doxygen.Project
1005
1006 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
1007 # Qt Help Project output. For more information please see 
1008 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
1009
1010 QHP_VIRTUAL_FOLDER     = doc
1011
1012 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 
1013 # add. For more information please see 
1014 # http://doc.trolltech.com/qthelpproject.html#custom-filters
1015
1016 QHP_CUST_FILTER_NAME   = 
1017
1018 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 
1019 # custom filter to add. For more information please see 
1020 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 
1021 # Qt Help Project / Custom Filters</a>.
1022
1023 QHP_CUST_FILTER_ATTRS  = 
1024
1025 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 
1026 # project's 
1027 # filter section matches. 
1028 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 
1029 # Qt Help Project / Filter Attributes</a>.
1030
1031 QHP_SECT_FILTER_ATTRS  = 
1032
1033 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
1034 # be used to specify the location of Qt's qhelpgenerator. 
1035 # If non-empty doxygen will try to run qhelpgenerator on the generated 
1036 # .qhp file.
1037
1038 QHG_LOCATION           = 
1039
1040 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files  
1041 # will be generated, which together with the HTML files, form an Eclipse help 
1042 # plugin. To install this plugin and make it available under the help contents 
1043 # menu in Eclipse, the contents of the directory containing the HTML and XML 
1044 # files needs to be copied into the plugins directory of eclipse. The name of 
1045 # the directory within the plugins directory should be the same as 
1046 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 
1047 # the help appears.
1048
1049 GENERATE_ECLIPSEHELP   = NO
1050
1051 # A unique identifier for the eclipse help plugin. When installing the plugin 
1052 # the directory name containing the HTML and XML files should also have 
1053 # this name.
1054
1055 ECLIPSE_DOC_ID         = org.doxygen.Project
1056
1057 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
1058 # top of each HTML page. The value NO (the default) enables the index and 
1059 # the value YES disables it.
1060
1061 DISABLE_INDEX          = NO
1062
1063 # This tag can be used to set the number of enum values (range [0,1..20]) 
1064 # that doxygen will group on one line in the generated HTML documentation. 
1065 # Note that a value of 0 will completely suppress the enum values from
1066 # appearing in the overview section.
1067
1068 ENUM_VALUES_PER_LINE   = 4
1069
1070 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
1071 # structure should be generated to display hierarchical information. 
1072 # If the tag value is set to YES, a side panel will be generated 
1073 # containing a tree-like index structure (just like the one that 
1074 # is generated for HTML Help). For this to work a browser that supports 
1075 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 
1076 # Windows users are probably better off using the HTML help feature.
1077
1078 GENERATE_TREEVIEW      = NO
1079
1080 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 
1081 # and Class Hierarchy pages using a tree view instead of an ordered list.
1082
1083 USE_INLINE_TREES       = NO
1084
1085 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
1086 # used to set the initial width (in pixels) of the frame in which the tree 
1087 # is shown.
1088
1089 TREEVIEW_WIDTH         = 250
1090
1091 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 
1092 # links to external symbols imported via tag files in a separate window.
1093
1094 EXT_LINKS_IN_WINDOW    = NO
1095
1096 # Use this tag to change the font size of Latex formulas included 
1097 # as images in the HTML documentation. The default is 10. Note that 
1098 # when you change the font size after a successful doxygen run you need 
1099 # to manually remove any form_*.png images from the HTML output directory 
1100 # to force them to be regenerated.
1101
1102 FORMULA_FONTSIZE       = 10
1103
1104 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 
1105 # generated for formulas are transparent PNGs. Transparent PNGs are 
1106 # not supported properly for IE 6.0, but are supported on all modern browsers. 
1107 # Note that when changing this option you need to delete any form_*.png files 
1108 # in the HTML output before the changes have effect.
1109
1110 FORMULA_TRANSPARENT    = YES
1111
1112 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax 
1113 # (see http://www.mathjax.org) which uses client side Javascript for the 
1114 # rendering instead of using prerendered bitmaps. Use this if you do not 
1115 # have LaTeX installed or if you want to formulas look prettier in the HTML 
1116 # output. When enabled you also need to install MathJax separately and 
1117 # configure the path to it using the MATHJAX_RELPATH option.
1118
1119 USE_MATHJAX            = NO
1120
1121 # When MathJax is enabled you need to specify the location relative to the 
1122 # HTML output directory using the MATHJAX_RELPATH option. The destination 
1123 # directory should contain the MathJax.js script. For instance, if the mathjax 
1124 # directory is located at the same level as the HTML output directory, then 
1125 # MATHJAX_RELPATH should be ../mathjax. The default value points to the
1126 # mathjax.org site, so you can quickly see the result without installing 
1127 # MathJax, but it is strongly recommended to install a local copy of MathJax 
1128 # before deployment.
1129
1130 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
1131
1132 # When the SEARCHENGINE tag is enabled doxygen will generate a search box 
1133 # for the HTML output. The underlying search engine uses javascript 
1134 # and DHTML and should work on any modern browser. Note that when using 
1135 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 
1136 # (GENERATE_DOCSET) there is already a search function so this one should 
1137 # typically be disabled. For large projects the javascript based search engine 
1138 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1139
1140 SEARCHENGINE           = NO
1141
1142 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 
1143 # implemented using a PHP enabled web server instead of at the web client 
1144 # using Javascript. Doxygen will generate the search PHP script and index 
1145 # file to put on the web server. The advantage of the server 
1146 # based approach is that it scales better to large projects and allows 
1147 # full text search. The disadvantages are that it is more difficult to setup 
1148 # and does not have live searching capabilities.
1149
1150 SERVER_BASED_SEARCH    = NO
1151
1152 #---------------------------------------------------------------------------
1153 # configuration options related to the LaTeX output
1154 #---------------------------------------------------------------------------
1155
1156 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
1157 # generate Latex output.
1158
1159 GENERATE_LATEX         = NO
1160
1161 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
1162 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1163 # put in front of it. If left blank `latex' will be used as the default path.
1164
1165 LATEX_OUTPUT           = latex
1166
1167 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
1168 # invoked. If left blank `latex' will be used as the default command name. 
1169 # Note that when enabling USE_PDFLATEX this option is only used for 
1170 # generating bitmaps for formulas in the HTML output, but not in the 
1171 # Makefile that is written to the output directory.
1172
1173 LATEX_CMD_NAME         = latex
1174
1175 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
1176 # generate index for LaTeX. If left blank `makeindex' will be used as the 
1177 # default command name.
1178
1179 MAKEINDEX_CMD_NAME     = makeindex
1180
1181 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
1182 # LaTeX documents. This may be useful for small projects and may help to 
1183 # save some trees in general.
1184
1185 COMPACT_LATEX          = NO
1186
1187 # The PAPER_TYPE tag can be used to set the paper type that is used 
1188 # by the printer. Possible values are: a4, letter, legal and 
1189 # executive. If left blank a4wide will be used.
1190
1191 PAPER_TYPE             = a4wide
1192
1193 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
1194 # packages that should be included in the LaTeX output.
1195
1196 EXTRA_PACKAGES         = 
1197
1198 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
1199 # the generated latex document. The header should contain everything until 
1200 # the first chapter. If it is left blank doxygen will generate a 
1201 # standard header. Notice: only use this tag if you know what you are doing!
1202
1203 LATEX_HEADER           = 
1204
1205 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
1206 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
1207 # contain links (just like the HTML output) instead of page references 
1208 # This makes the output suitable for online browsing using a pdf viewer.
1209
1210 PDF_HYPERLINKS         = NO
1211
1212 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
1213 # plain latex in the generated Makefile. Set this option to YES to get a 
1214 # higher quality PDF documentation.
1215
1216 USE_PDFLATEX           = NO
1217
1218 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
1219 # command to the generated LaTeX files. This will instruct LaTeX to keep 
1220 # running if errors occur, instead of asking the user for help. 
1221 # This option is also used when generating formulas in HTML.
1222
1223 LATEX_BATCHMODE        = NO
1224
1225 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
1226 # include the index chapters (such as File Index, Compound Index, etc.) 
1227 # in the output.
1228
1229 LATEX_HIDE_INDICES     = NO
1230
1231 # If LATEX_SOURCE_CODE is set to YES then doxygen will include 
1232 # source code with syntax highlighting in the LaTeX output. 
1233 # Note that which sources are shown also depends on other settings 
1234 # such as SOURCE_BROWSER.
1235
1236 LATEX_SOURCE_CODE      = NO
1237
1238 #---------------------------------------------------------------------------
1239 # configuration options related to the RTF output
1240 #---------------------------------------------------------------------------
1241
1242 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
1243 # The RTF output is optimized for Word 97 and may not look very pretty with 
1244 # other RTF readers or editors.
1245
1246 GENERATE_RTF           = NO
1247
1248 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
1249 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1250 # put in front of it. If left blank `rtf' will be used as the default path.
1251
1252 RTF_OUTPUT             = rtf
1253
1254 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
1255 # RTF documents. This may be useful for small projects and may help to 
1256 # save some trees in general.
1257
1258 COMPACT_RTF            = NO
1259
1260 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
1261 # will contain hyperlink fields. The RTF file will 
1262 # contain links (just like the HTML output) instead of page references. 
1263 # This makes the output suitable for online browsing using WORD or other 
1264 # programs which support those fields. 
1265 # Note: wordpad (write) and others do not support links.
1266
1267 RTF_HYPERLINKS         = NO
1268
1269 # Load stylesheet definitions from file. Syntax is similar to doxygen's 
1270 # config file, i.e. a series of assignments. You only have to provide 
1271 # replacements, missing definitions are set to their default value.
1272
1273 RTF_STYLESHEET_FILE    = 
1274
1275 # Set optional variables used in the generation of an rtf document. 
1276 # Syntax is similar to doxygen's config file.
1277
1278 RTF_EXTENSIONS_FILE    = 
1279
1280 #---------------------------------------------------------------------------
1281 # configuration options related to the man page output
1282 #---------------------------------------------------------------------------
1283
1284 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
1285 # generate man pages
1286
1287 GENERATE_MAN           = NO
1288
1289 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
1290 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1291 # put in front of it. If left blank `man' will be used as the default path.
1292
1293 MAN_OUTPUT             = man
1294
1295 # The MAN_EXTENSION tag determines the extension that is added to 
1296 # the generated man pages (default is the subroutine's section .3)
1297
1298 MAN_EXTENSION          = .3
1299
1300 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
1301 # then it will generate one additional man file for each entity 
1302 # documented in the real man page(s). These additional files 
1303 # only source the real man page, but without them the man command 
1304 # would be unable to find the correct page. The default is NO.
1305
1306 MAN_LINKS              = NO
1307
1308 #---------------------------------------------------------------------------
1309 # configuration options related to the XML output
1310 #---------------------------------------------------------------------------
1311
1312 # If the GENERATE_XML tag is set to YES Doxygen will 
1313 # generate an XML file that captures the structure of 
1314 # the code including all documentation.
1315
1316 GENERATE_XML           = NO
1317
1318 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
1319 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1320 # put in front of it. If left blank `xml' will be used as the default path.
1321
1322 XML_OUTPUT             = xml
1323
1324 # The XML_SCHEMA tag can be used to specify an XML schema, 
1325 # which can be used by a validating XML parser to check the 
1326 # syntax of the XML files.
1327
1328 XML_SCHEMA             = 
1329
1330 # The XML_DTD tag can be used to specify an XML DTD, 
1331 # which can be used by a validating XML parser to check the 
1332 # syntax of the XML files.
1333
1334 XML_DTD                = 
1335
1336 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
1337 # dump the program listings (including syntax highlighting 
1338 # and cross-referencing information) to the XML output. Note that 
1339 # enabling this will significantly increase the size of the XML output.
1340
1341 XML_PROGRAMLISTING     = YES
1342
1343 #---------------------------------------------------------------------------
1344 # configuration options for the AutoGen Definitions output
1345 #---------------------------------------------------------------------------
1346
1347 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
1348 # generate an AutoGen Definitions (see autogen.sf.net) file 
1349 # that captures the structure of the code including all 
1350 # documentation. Note that this feature is still experimental 
1351 # and incomplete at the moment.
1352
1353 GENERATE_AUTOGEN_DEF   = NO
1354
1355 #---------------------------------------------------------------------------
1356 # configuration options related to the Perl module output
1357 #---------------------------------------------------------------------------
1358
1359 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
1360 # generate a Perl module file that captures the structure of 
1361 # the code including all documentation. Note that this 
1362 # feature is still experimental and incomplete at the 
1363 # moment.
1364
1365 GENERATE_PERLMOD       = NO
1366
1367 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
1368 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
1369 # to generate PDF and DVI output from the Perl module output.
1370
1371 PERLMOD_LATEX          = NO
1372
1373 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
1374 # nicely formatted so it can be parsed by a human reader.  This is useful 
1375 # if you want to understand what is going on.  On the other hand, if this 
1376 # tag is set to NO the size of the Perl module output will be much smaller 
1377 # and Perl will parse it just the same.
1378
1379 PERLMOD_PRETTY         = YES
1380
1381 # The names of the make variables in the generated doxyrules.make file 
1382 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
1383 # This is useful so different doxyrules.make files included by the same 
1384 # Makefile don't overwrite each other's variables.
1385
1386 PERLMOD_MAKEVAR_PREFIX = 
1387
1388 #---------------------------------------------------------------------------
1389 # Configuration options related to the preprocessor
1390 #---------------------------------------------------------------------------
1391
1392 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
1393 # evaluate all C-preprocessor directives found in the sources and include 
1394 # files.
1395
1396 ENABLE_PREPROCESSING   = YES
1397
1398 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
1399 # names in the source code. If set to NO (the default) only conditional 
1400 # compilation will be performed. Macro expansion can be done in a controlled 
1401 # way by setting EXPAND_ONLY_PREDEF to YES.
1402
1403 MACRO_EXPANSION        = NO
1404
1405 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
1406 # then the macro expansion is limited to the macros specified with the 
1407 # PREDEFINED and EXPAND_AS_DEFINED tags.
1408
1409 EXPAND_ONLY_PREDEF     = NO
1410
1411 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
1412 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1413
1414 SEARCH_INCLUDES        = YES
1415
1416 # The INCLUDE_PATH tag can be used to specify one or more directories that 
1417 # contain include files that are not input files but should be processed by 
1418 # the preprocessor.
1419
1420 INCLUDE_PATH           = 
1421
1422 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1423 # patterns (like *.h and *.hpp) to filter out the header-files in the 
1424 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
1425 # be used.
1426
1427 INCLUDE_FILE_PATTERNS  = 
1428
1429 # The PREDEFINED tag can be used to specify one or more macro names that 
1430 # are defined before the preprocessor is started (similar to the -D option of 
1431 # gcc). The argument of the tag is a list of macros of the form: name 
1432 # or name=definition (no spaces). If the definition and the = are 
1433 # omitted =1 is assumed. To prevent a macro definition from being 
1434 # undefined via #undef or recursively expanded use the := operator 
1435 # instead of the = operator.
1436
1437 PREDEFINED             = BUILD_DATE
1438
1439 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
1440 # this tag can be used to specify a list of macro names that should be expanded. 
1441 # The macro definition that is found in the sources will be used. 
1442 # Use the PREDEFINED tag if you want to use a different macro definition that
1443 # overrules the definition found in the source code.
1444
1445 EXPAND_AS_DEFINED      = 
1446
1447 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
1448 # doxygen's preprocessor will remove all references to function-like macros 
1449 # that are alone on a line, have an all uppercase name, and do not end with a 
1450 # semicolon, because these will confuse the parser if not removed.
1451
1452 SKIP_FUNCTION_MACROS   = YES
1453
1454 #---------------------------------------------------------------------------
1455 # Configuration::additions related to external references
1456 #---------------------------------------------------------------------------
1457
1458 # The TAGFILES option can be used to specify one or more tagfiles. 
1459 # Optionally an initial location of the external documentation 
1460 # can be added for each tagfile. The format of a tag file without 
1461 # this location is as follows: 
1462 #   TAGFILES = file1 file2 ... 
1463 # Adding location for the tag files is done as follows: 
1464 #   TAGFILES = file1=loc1 "file2 = loc2" ... 
1465 # where "loc1" and "loc2" can be relative or absolute paths or 
1466 # URLs. If a location is present for each tag, the installdox tool 
1467 # does not have to be run to correct the links. 
1468 # Note that each tag file must have a unique name 
1469 # (where the name does NOT include the path) 
1470 # If a tag file is not located in the directory in which doxygen 
1471 # is run, you must also specify the path to the tagfile here.
1472
1473 TAGFILES               = 
1474
1475 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1476 # a tag file that is based on the input files it reads.
1477
1478 GENERATE_TAGFILE       = 
1479
1480 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1481 # in the class index. If set to NO only the inherited external classes 
1482 # will be listed.
1483
1484 ALLEXTERNALS           = NO
1485
1486 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1487 # in the modules index. If set to NO, only the current project's groups will 
1488 # be listed.
1489
1490 EXTERNAL_GROUPS        = YES
1491
1492 # The PERL_PATH should be the absolute path and name of the perl script 
1493 # interpreter (i.e. the result of `which perl').
1494
1495 PERL_PATH              = /usr/bin/perl
1496
1497 #---------------------------------------------------------------------------
1498 # Configuration options related to the dot tool
1499 #---------------------------------------------------------------------------
1500
1501 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1502 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
1503 # or super classes. Setting the tag to NO turns the diagrams off. Note that 
1504 # this option also works with HAVE_DOT disabled, but it is recommended to 
1505 # install and use dot, since it yields more powerful graphs.
1506
1507 CLASS_DIAGRAMS         = NO
1508
1509 # You can define message sequence charts within doxygen comments using the \msc 
1510 # command. Doxygen will then run the mscgen tool (see 
1511 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
1512 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 
1513 # the mscgen tool resides. If left empty the tool is assumed to be found in the 
1514 # default search path.
1515
1516 MSCGEN_PATH            = 
1517
1518 # If set to YES, the inheritance and collaboration graphs will hide 
1519 # inheritance and usage relations if the target is undocumented 
1520 # or is not a class.
1521
1522 HIDE_UNDOC_RELATIONS   = YES
1523
1524 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1525 # available from the path. This tool is part of Graphviz, a graph visualization 
1526 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
1527 # have no effect if this option is set to NO (the default)
1528
1529 HAVE_DOT               = YES
1530
1531 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 
1532 # allowed to run in parallel. When set to 0 (the default) doxygen will 
1533 # base this on the number of processors available in the system. You can set it 
1534 # explicitly to a value larger than 0 to get control over the balance 
1535 # between CPU load and processing speed.
1536
1537 DOT_NUM_THREADS        = 0
1538
1539 # By default doxygen will write a font called Helvetica to the output 
1540 # directory and reference it in all dot files that doxygen generates. 
1541 # When you want a differently looking font you can specify the font name 
1542 # using DOT_FONTNAME. You need to make sure dot is able to find the font, 
1543 # which can be done by putting it in a standard location or by setting the 
1544 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
1545 # containing the font.
1546
1547 DOT_FONTNAME           = Helvetica
1548
1549 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 
1550 # The default size is 10pt.
1551
1552 DOT_FONTSIZE           = 10
1553
1554 # By default doxygen will tell dot to use the output directory to look for the 
1555 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 
1556 # different font using DOT_FONTNAME you can set the path where dot 
1557 # can find it using this tag.
1558
1559 DOT_FONTPATH           = 
1560
1561 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1562 # will generate a graph for each documented class showing the direct and 
1563 # indirect inheritance relations. Setting this tag to YES will force the 
1564 # the CLASS_DIAGRAMS tag to NO.
1565
1566 CLASS_GRAPH            = YES
1567
1568 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1569 # will generate a graph for each documented class showing the direct and 
1570 # indirect implementation dependencies (inheritance, containment, and 
1571 # class references variables) of the class with other documented classes.
1572
1573 COLLABORATION_GRAPH    = NO
1574
1575 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1576 # will generate a graph for groups, showing the direct groups dependencies
1577
1578 GROUP_GRAPHS           = YES
1579
1580 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1581 # collaboration diagrams in a style similar to the OMG's Unified Modeling 
1582 # Language.
1583
1584 UML_LOOK               = YES
1585
1586 # If set to YES, the inheritance and collaboration graphs will show the 
1587 # relations between templates and their instances.
1588
1589 TEMPLATE_RELATIONS     = YES
1590
1591 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1592 # tags are set to YES then doxygen will generate a graph for each documented 
1593 # file showing the direct and indirect include dependencies of the file with 
1594 # other documented files.
1595
1596 INCLUDE_GRAPH          = NO
1597
1598 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1599 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1600 # documented header file showing the documented files that directly or 
1601 # indirectly include this file.
1602
1603 INCLUDED_BY_GRAPH      = NO
1604
1605 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 
1606 # doxygen will generate a call dependency graph for every global function 
1607 # or class method. Note that enabling this option will significantly increase 
1608 # the time of a run. So in most cases it will be better to enable call graphs 
1609 # for selected functions only using the \callgraph command.
1610
1611 CALL_GRAPH             = NO
1612
1613 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
1614 # doxygen will generate a caller dependency graph for every global function 
1615 # or class method. Note that enabling this option will significantly increase 
1616 # the time of a run. So in most cases it will be better to enable caller 
1617 # graphs for selected functions only using the \callergraph command.
1618
1619 CALLER_GRAPH           = NO
1620
1621 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1622 # will generate a graphical hierarchy of all classes instead of a textual one.
1623
1624 GRAPHICAL_HIERARCHY    = YES
1625
1626 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1627 # then doxygen will show the dependencies a directory has on other directories 
1628 # in a graphical way. The dependency relations are determined by the #include 
1629 # relations between the files in the directories.
1630
1631 DIRECTORY_GRAPH        = YES
1632
1633 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1634 # generated by dot. Possible values are png, svg, gif or svg. 
1635 # If left blank png will be used.
1636
1637 DOT_IMAGE_FORMAT       = png
1638
1639 # The tag DOT_PATH can be used to specify the path where the dot tool can be 
1640 # found. If left blank, it is assumed the dot tool can be found in the path.
1641
1642 DOT_PATH               = 
1643
1644 # The DOTFILE_DIRS tag can be used to specify one or more directories that 
1645 # contain dot files that are included in the documentation (see the 
1646 # \dotfile command).
1647
1648 DOTFILE_DIRS           = 
1649
1650 # The MSCFILE_DIRS tag can be used to specify one or more directories that 
1651 # contain msc files that are included in the documentation (see the 
1652 # \mscfile command).
1653
1654 MSCFILE_DIRS           = 
1655
1656 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
1657 # nodes that will be shown in the graph. If the number of nodes in a graph 
1658 # becomes larger than this value, doxygen will truncate the graph, which is 
1659 # visualized by representing a node as a red box. Note that doxygen if the 
1660 # number of direct children of the root node in a graph is already larger than 
1661 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
1662 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1663
1664 DOT_GRAPH_MAX_NODES    = 50
1665
1666 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1667 # graphs generated by dot. A depth value of 3 means that only nodes reachable 
1668 # from the root by following a path via at most 3 edges will be shown. Nodes 
1669 # that lay further from the root node will be omitted. Note that setting this 
1670 # option to 1 or 2 may greatly reduce the computation time needed for large 
1671 # code bases. Also note that the size of a graph can be further restricted by 
1672 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1673
1674 MAX_DOT_GRAPH_DEPTH    = 0
1675
1676 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1677 # background. This is disabled by default, because dot on Windows does not 
1678 # seem to support this out of the box. Warning: Depending on the platform used, 
1679 # enabling this option may lead to badly anti-aliased labels on the edges of 
1680 # a graph (i.e. they become hard to read).
1681
1682 DOT_TRANSPARENT        = NO
1683
1684 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1685 # files in one run (i.e. multiple -o and -T options on the command line). This 
1686 # makes dot run faster, but since only newer versions of dot (>1.8.10) 
1687 # support this, this feature is disabled by default.
1688
1689 DOT_MULTI_TARGETS      = YES
1690
1691 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1692 # generate a legend page explaining the meaning of the various boxes and 
1693 # arrows in the dot generated graphs.
1694
1695 GENERATE_LEGEND        = YES
1696
1697 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1698 # remove the intermediate dot files that are used to generate 
1699 # the various graphs.
1700
1701 DOT_CLEANUP            = YES