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