[CMake] Install import libraries
[llvm-complete.git] / docs / doxygen.cfg.in
blobfc11f6863ac8158c9eadcad8f8a188f5e0ce192d
1 # Doxyfile 1.8.6
3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project.
6 # All text after a double hash (##) is considered a comment and is placed in
7 # front of the TAG it is preceding.
9 # All text after a single hash (#) is considered a comment and will be ignored.
10 # The format is:
11 # TAG = value [value, ...]
12 # For lists, items can also be appended using:
13 # TAG += value [value, ...]
14 # Values that contain spaces should be placed between quotes (\" \").
16 #---------------------------------------------------------------------------
17 # Project related configuration options
18 #---------------------------------------------------------------------------
20 # This tag specifies the encoding used for all characters in the config file
21 # that follow. The default is UTF-8 which is also the encoding used for all text
22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24 # for the list of possible encodings.
25 # The default value is: UTF-8.
27 DOXYFILE_ENCODING      = UTF-8
29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30 # double-quotes, unless you are using Doxywizard) that should identify the
31 # project for which the documentation is generated. This name is used in the
32 # title of most generated pages and in a few other places.
33 # The default value is: My Project.
35 PROJECT_NAME           = LLVM
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
39 # control system is used.
41 PROJECT_NUMBER         = @PACKAGE_VERSION@
43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
44 # for a project that appears at the top of each page and should give viewer a
45 # quick idea about the purpose of the project. Keep the description short.
47 PROJECT_BRIEF          =
49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50 # the documentation. The maximum height of the logo should not exceed 55 pixels
51 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52 # to the output directory.
54 PROJECT_LOGO           =
56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
61 OUTPUT_DIRECTORY       = @abs_top_builddir@/doxygen
63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
64 # directories (in 2 levels) under the output directory of each output format and
65 # will distribute the generated files over these directories. Enabling this
66 # option can be useful when feeding doxygen a huge amount of source files, where
67 # putting all generated files in the same directory would otherwise causes
68 # performance problems for the file system.
69 # The default value is: NO.
71 CREATE_SUBDIRS         = NO
73 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
74 # documentation generated by doxygen is written. Doxygen will use this
75 # information to generate all constant output in the proper language.
76 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
77 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
78 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
79 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
80 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
81 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
82 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
83 # Ukrainian and Vietnamese.
84 # The default value is: English.
86 OUTPUT_LANGUAGE        = English
88 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
89 # descriptions after the members that are listed in the file and class
90 # documentation (similar to Javadoc). Set to NO to disable this.
91 # The default value is: YES.
93 BRIEF_MEMBER_DESC      = YES
95 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
96 # description of a member or function before the detailed description
98 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
99 # brief descriptions will be completely suppressed.
100 # The default value is: YES.
102 REPEAT_BRIEF           = YES
104 # This tag implements a quasi-intelligent brief description abbreviator that is
105 # used to form the text in various listings. Each string in this list, if found
106 # as the leading text of the brief description, will be stripped from the text
107 # and the result, after processing the whole list, is used as the annotated
108 # text. Otherwise, the brief description is used as-is. If left blank, the
109 # following values are used ($name is automatically replaced with the name of
110 # the entity):The $name class, The $name widget, The $name file, is, provides,
111 # specifies, contains, represents, a, an and the.
113 ABBREVIATE_BRIEF       =
115 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
116 # doxygen will generate a detailed section even if there is only a brief
117 # description.
118 # The default value is: NO.
120 ALWAYS_DETAILED_SEC    = NO
122 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
123 # inherited members of a class in the documentation of that class as if those
124 # members were ordinary class members. Constructors, destructors and assignment
125 # operators of the base classes will not be shown.
126 # The default value is: NO.
128 INLINE_INHERITED_MEMB  = NO
130 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
131 # before files name in the file list and in the header files. If set to NO the
132 # shortest path that makes the file name unique will be used
133 # The default value is: YES.
135 FULL_PATH_NAMES        = YES
137 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
138 # Stripping is only done if one of the specified strings matches the left-hand
139 # part of 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 path to
141 # strip.
143 # Note that you can specify absolute paths here, but also relative paths, which
144 # will be relative from the directory where doxygen is started.
145 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
147 STRIP_FROM_PATH        = @abs_top_srcdir@/..
149 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
150 # path mentioned in the documentation of a class, which tells the reader which
151 # header file to include in order to use a class. If left blank only the name of
152 # the header file containing the class definition is used. Otherwise one should
153 # specify the list of include paths that are normally passed to the compiler
154 # using the -I flag.
156 STRIP_FROM_INC_PATH    = @abs_top_srcdir@/../include
157 STRIP_FROM_INC_PATH    += @abs_top_srcdir@/../lib
159 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
160 # less readable) file names. This can be useful is your file systems doesn't
161 # support long names like on DOS, Mac, or CD-ROM.
162 # The default value is: NO.
164 SHORT_NAMES            = NO
166 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
167 # first line (until the first dot) of a Javadoc-style comment as the brief
168 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
169 # style comments (thus requiring an explicit @brief command for a brief
170 # description.)
171 # The default value is: NO.
173 JAVADOC_AUTOBRIEF      = YES
175 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
176 # line (until the first dot) of a Qt-style comment as the brief description. If
177 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
178 # requiring an explicit \brief command for a brief description.)
179 # The default value is: NO.
181 QT_AUTOBRIEF           = YES
183 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
184 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
185 # a brief description. This used to be the default behavior. The new default is
186 # to treat a multi-line C++ comment block as a detailed description. Set this
187 # tag to YES if you prefer the old behavior instead.
189 # Note that setting this tag to YES also means that rational rose comments are
190 # not recognized any more.
191 # The default value is: NO.
193 MULTILINE_CPP_IS_BRIEF = NO
195 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
196 # documentation from any documented member that it re-implements.
197 # The default value is: YES.
199 INHERIT_DOCS           = YES
201 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
202 # new page for each member. If set to NO, the documentation of a member will be
203 # part of the file/class/namespace that contains it.
204 # The default value is: NO.
206 SEPARATE_MEMBER_PAGES  = NO
208 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
209 # uses this value to replace tabs by spaces in code fragments.
210 # Minimum value: 1, maximum value: 16, default value: 4.
212 TAB_SIZE               = 2
214 # This tag can be used to specify a number of aliases that act as commands in
215 # the documentation. An alias has the form:
216 # name=value
217 # For example adding
218 # "sideeffect=@par Side Effects:\n"
219 # will allow you to put the command \sideeffect (or @sideeffect) in the
220 # documentation, which will result in a user-defined paragraph with heading
221 # "Side Effects:". You can put \n's in the value part of an alias to insert
222 # newlines.
224 ALIASES                =
226 # This tag can be used to specify a number of word-keyword mappings (TCL only).
227 # A mapping has the form "name=value". For example adding "class=itcl::class"
228 # will allow you to use the command class in the itcl::class meaning.
230 TCL_SUBST              =
232 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
233 # only. Doxygen will then generate output that is more tailored for C. For
234 # instance, some of the names that are used will be different. The list of all
235 # members will be omitted, etc.
236 # The default value is: NO.
238 OPTIMIZE_OUTPUT_FOR_C  = NO
240 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
241 # Python sources only. Doxygen will then generate output that is more tailored
242 # for that language. For instance, namespaces will be presented as packages,
243 # qualified scopes will look different, etc.
244 # The default value is: NO.
246 OPTIMIZE_OUTPUT_JAVA   = NO
248 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
249 # sources. Doxygen will then generate output that is tailored for Fortran.
250 # The default value is: NO.
252 OPTIMIZE_FOR_FORTRAN   = NO
254 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
255 # sources. Doxygen will then generate output that is tailored for VHDL.
256 # The default value is: NO.
258 OPTIMIZE_OUTPUT_VHDL   = NO
260 # Doxygen selects the parser to use depending on the extension of the files it
261 # parses. With this tag you can assign which parser to use for a given
262 # extension. Doxygen has a built-in mapping, but you can override or extend it
263 # using this tag. The format is ext=language, where ext is a file extension, and
264 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
265 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
266 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
267 # (default is Fortran), use: inc=Fortran f=C.
269 # Note For files without extension you can use no_extension as a placeholder.
271 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
272 # the files are not read by doxygen.
274 EXTENSION_MAPPING      =
276 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
277 # according to the Markdown format, which allows for more readable
278 # documentation. See http://daringfireball.net/projects/markdown/ for details.
279 # The output of markdown processing is further processed by doxygen, so you can
280 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
281 # case of backward compatibilities issues.
282 # The default value is: YES.
284 MARKDOWN_SUPPORT       = YES
286 # When enabled doxygen tries to link words that correspond to documented
287 # classes, or namespaces to their corresponding documentation. Such a link can
288 # be prevented in individual cases by putting a % sign in front of the word
289 # or globally by setting AUTOLINK_SUPPORT to NO.
290 # The default value is: YES.
292 AUTOLINK_SUPPORT       = YES
294 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
295 # to include (a tag file for) the STL sources as input, then you should set this
296 # tag to YES in order to let doxygen match functions declarations and
297 # definitions whose arguments contain STL classes (e.g. func(std::string);
298 # versus func(std::string) {}). This also make the inheritance and collaboration
299 # diagrams that involve STL classes more complete and accurate.
300 # The default value is: NO.
302 BUILTIN_STL_SUPPORT    = NO
304 # If you use Microsoft's C++/CLI language, you should set this option to YES to
305 # enable parsing support.
306 # The default value is: NO.
308 CPP_CLI_SUPPORT        = NO
310 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
311 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
312 # will parse them like normal C++ but will assume all classes use public instead
313 # of private inheritance when no explicit protection keyword is present.
314 # The default value is: NO.
316 SIP_SUPPORT            = NO
318 # For Microsoft's IDL there are propget and propput attributes to indicate
319 # getter and setter methods for a property. Setting this option to YES will make
320 # doxygen to replace the get and set methods by a property in the documentation.
321 # This will only work if the methods are indeed getting or setting a simple
322 # type. If this is not the case, or you want to show the methods anyway, you
323 # should set this option to NO.
324 # The default value is: YES.
326 IDL_PROPERTY_SUPPORT   = YES
328 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
329 # tag is set to YES, then doxygen will reuse the documentation of the first
330 # member in the group (if any) for the other members of the group. By default
331 # all members of a group must be documented explicitly.
332 # The default value is: NO.
334 DISTRIBUTE_GROUP_DOC   = NO
336 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
337 # (for instance a group of public functions) to be put as a subgroup of that
338 # type (e.g. under the Public Functions section). Set it to NO to prevent
339 # subgrouping. Alternatively, this can be done per class using the
340 # \nosubgrouping command.
341 # The default value is: YES.
343 SUBGROUPING            = YES
345 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
346 # are shown inside the group in which they are included (e.g. using \ingroup)
347 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
348 # and RTF).
350 # Note that this feature does not work in combination with
351 # SEPARATE_MEMBER_PAGES.
352 # The default value is: NO.
354 INLINE_GROUPED_CLASSES = NO
356 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
357 # with only public data fields or simple typedef fields will be shown inline in
358 # the documentation of the scope in which they are defined (i.e. file,
359 # namespace, or group documentation), provided this scope is documented. If set
360 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
361 # Man pages) or section (for LaTeX and RTF).
362 # The default value is: NO.
364 INLINE_SIMPLE_STRUCTS  = NO
366 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
367 # enum is documented as struct, union, or enum with the name of the typedef. So
368 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
369 # with name TypeT. When disabled the typedef will appear as a member of a file,
370 # namespace, or class. And the struct will be named TypeS. This can typically be
371 # useful for C code in case the coding convention dictates that all compound
372 # types are typedef'ed and only the typedef is referenced, never the tag name.
373 # The default value is: NO.
375 TYPEDEF_HIDES_STRUCT   = NO
377 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
378 # cache is used to resolve symbols given their name and scope. Since this can be
379 # an expensive process and often the same symbol appears multiple times in the
380 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
381 # doxygen will become slower. If the cache is too large, memory is wasted. The
382 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
383 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
384 # symbols. At the end of a run doxygen will report the cache usage and suggest
385 # the optimal cache size from a speed point of view.
386 # Minimum value: 0, maximum value: 9, default value: 0.
388 LOOKUP_CACHE_SIZE      = 2
390 #---------------------------------------------------------------------------
391 # Build related configuration options
392 #---------------------------------------------------------------------------
394 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
395 # documentation are documented, even if no documentation was available. Private
396 # class members and static file members will be hidden unless the
397 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
398 # Note: This will also disable the warnings about undocumented members that are
399 # normally produced when WARNINGS is set to YES.
400 # The default value is: NO.
402 EXTRACT_ALL            = YES
404 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
405 # be included in the documentation.
406 # The default value is: NO.
408 EXTRACT_PRIVATE        = NO
410 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
411 # scope will be included in the documentation.
412 # The default value is: NO.
414 EXTRACT_PACKAGE        = NO
416 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
417 # included in the documentation.
418 # The default value is: NO.
420 EXTRACT_STATIC         = YES
422 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
423 # locally in source files will be included in the documentation. If set to NO
424 # only classes defined in header files are included. Does not have any effect
425 # for Java sources.
426 # The default value is: YES.
428 EXTRACT_LOCAL_CLASSES  = YES
430 # This flag is only useful for Objective-C code. When set to YES local methods,
431 # which are defined in the implementation section but not in the interface are
432 # included in the documentation. If set to NO only methods in the interface are
433 # included.
434 # The default value is: NO.
436 EXTRACT_LOCAL_METHODS  = NO
438 # If this flag is set to YES, the members of anonymous namespaces will be
439 # extracted and appear in the documentation as a namespace called
440 # 'anonymous_namespace{file}', where file will be replaced with the base name of
441 # the file that contains the anonymous namespace. By default anonymous namespace
442 # are hidden.
443 # The default value is: NO.
445 EXTRACT_ANON_NSPACES   = NO
447 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
448 # undocumented members inside documented classes or files. If set to NO these
449 # members will be included in the various overviews, but no documentation
450 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
451 # The default value is: NO.
453 HIDE_UNDOC_MEMBERS     = NO
455 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
456 # undocumented classes that are normally visible in the class hierarchy. If set
457 # to NO these classes will be included in the various overviews. This option has
458 # no effect if EXTRACT_ALL is enabled.
459 # The default value is: NO.
461 HIDE_UNDOC_CLASSES     = NO
463 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
464 # (class|struct|union) declarations. If set to NO these declarations will be
465 # included in the documentation.
466 # The default value is: NO.
468 HIDE_FRIEND_COMPOUNDS  = NO
470 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
471 # documentation blocks found inside the body of a function. If set to NO these
472 # blocks will be appended to the function's detailed documentation block.
473 # The default value is: NO.
475 HIDE_IN_BODY_DOCS      = NO
477 # The INTERNAL_DOCS tag determines if documentation that is typed after a
478 # \internal command is included. If the tag is set to NO then the documentation
479 # will be excluded. Set it to YES to include the internal documentation.
480 # The default value is: NO.
482 INTERNAL_DOCS          = NO
484 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
485 # names in lower-case letters. If set to YES upper-case letters are also
486 # allowed. This is useful if you have classes or files whose names only differ
487 # in case and if your file system supports case sensitive file names. Windows
488 # and Mac users are advised to set this option to NO.
489 # The default value is: system dependent.
491 CASE_SENSE_NAMES       = YES
493 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
494 # their full class and namespace scopes in the documentation. If set to YES the
495 # scope will be hidden.
496 # The default value is: NO.
498 HIDE_SCOPE_NAMES       = NO
500 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
501 # the files that are included by a file in the documentation of that file.
502 # The default value is: YES.
504 SHOW_INCLUDE_FILES     = YES
506 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
507 # grouped member an include statement to the documentation, telling the reader
508 # which file to include in order to use the member.
509 # The default value is: NO.
511 SHOW_GROUPED_MEMB_INC  = NO
513 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
514 # files with double quotes in the documentation rather than with sharp brackets.
515 # The default value is: NO.
517 FORCE_LOCAL_INCLUDES   = YES
519 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
520 # documentation for inline members.
521 # The default value is: YES.
523 INLINE_INFO            = YES
525 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
526 # (detailed) documentation of file and class members alphabetically by member
527 # name. If set to NO the members will appear in declaration order.
528 # The default value is: YES.
530 SORT_MEMBER_DOCS       = YES
532 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
533 # descriptions of file, namespace and class members alphabetically by member
534 # name. If set to NO the members will appear in declaration order. Note that
535 # this will also influence the order of the classes in the class list.
536 # The default value is: NO.
538 SORT_BRIEF_DOCS        = NO
540 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
541 # (brief and detailed) documentation of class members so that constructors and
542 # destructors are listed first. If set to NO the constructors will appear in the
543 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
544 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
545 # member documentation.
546 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
547 # detailed member documentation.
548 # The default value is: NO.
550 SORT_MEMBERS_CTORS_1ST = NO
552 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
553 # of group names into alphabetical order. If set to NO the group names will
554 # appear in their defined order.
555 # The default value is: NO.
557 SORT_GROUP_NAMES       = NO
559 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
560 # fully-qualified names, including namespaces. If set to NO, the class list will
561 # be sorted only by class name, not including the namespace part.
562 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
563 # Note: This option applies only to the class list, not to the alphabetical
564 # list.
565 # The default value is: NO.
567 SORT_BY_SCOPE_NAME     = NO
569 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
570 # type resolution of all parameters of a function it will reject a match between
571 # the prototype and the implementation of a member function even if there is
572 # only one candidate or it is obvious which candidate to choose by doing a
573 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
574 # accept a match between prototype and implementation in such cases.
575 # The default value is: NO.
577 STRICT_PROTO_MATCHING  = NO
579 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
580 # todo list. This list is created by putting \todo commands in the
581 # documentation.
582 # The default value is: YES.
584 GENERATE_TODOLIST      = YES
586 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
587 # test list. This list is created by putting \test commands in the
588 # documentation.
589 # The default value is: YES.
591 GENERATE_TESTLIST      = YES
593 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
594 # list. This list is created by putting \bug commands in the documentation.
595 # The default value is: YES.
597 GENERATE_BUGLIST       = YES
599 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
600 # the deprecated list. This list is created by putting \deprecated commands in
601 # the documentation.
602 # The default value is: YES.
604 GENERATE_DEPRECATEDLIST= YES
606 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
607 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
608 # ... \endcond blocks.
610 ENABLED_SECTIONS       =
612 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
613 # initial value of a variable or macro / define can have for it to appear in the
614 # documentation. If the initializer consists of more lines than specified here
615 # it will be hidden. Use a value of 0 to hide initializers completely. The
616 # appearance of the value of individual variables and macros / defines can be
617 # controlled using \showinitializer or \hideinitializer command in the
618 # documentation regardless of this setting.
619 # Minimum value: 0, maximum value: 10000, default value: 30.
621 MAX_INITIALIZER_LINES  = 30
623 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
624 # the bottom of the documentation of classes and structs. If set to YES the list
625 # will mention the files that were used to generate the documentation.
626 # The default value is: YES.
628 SHOW_USED_FILES        = YES
630 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
631 # will remove the Files entry from the Quick Index and from the Folder Tree View
632 # (if specified).
633 # The default value is: YES.
635 SHOW_FILES             = YES
637 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
638 # page. This will remove the Namespaces entry from the Quick Index and from the
639 # Folder Tree View (if specified).
640 # The default value is: YES.
642 SHOW_NAMESPACES        = YES
644 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
645 # doxygen should invoke to get the current version for each file (typically from
646 # the version control system). Doxygen will invoke the program by executing (via
647 # popen()) the command command input-file, where command is the value of the
648 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
649 # by doxygen. Whatever the program writes to standard output is used as the file
650 # version. For an example see the documentation.
652 FILE_VERSION_FILTER    =
654 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
655 # by doxygen. The layout file controls the global structure of the generated
656 # output files in an output format independent way. To create the layout file
657 # that represents doxygen's defaults, run doxygen with the -l option. You can
658 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
659 # will be used as the name of the layout file.
661 # Note that if you run doxygen from a directory containing a file called
662 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
663 # tag is left empty.
665 LAYOUT_FILE            =
667 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
668 # the reference definitions. This must be a list of .bib files. The .bib
669 # extension is automatically appended if omitted. This requires the bibtex tool
670 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
671 # For LaTeX the style of the bibliography can be controlled using
672 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
673 # search path. Do not use file names with spaces, bibtex cannot handle them. See
674 # also \cite for info how to create references.
676 CITE_BIB_FILES         =
678 #---------------------------------------------------------------------------
679 # Configuration options related to warning and progress messages
680 #---------------------------------------------------------------------------
682 # The QUIET tag can be used to turn on/off the messages that are generated to
683 # standard output by doxygen. If QUIET is set to YES this implies that the
684 # messages are off.
685 # The default value is: NO.
687 QUIET                  = NO
689 # The WARNINGS tag can be used to turn on/off the warning messages that are
690 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
691 # this implies that the warnings are on.
693 # Tip: Turn warnings on while writing the documentation.
694 # The default value is: YES.
696 WARNINGS               = NO
698 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
699 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
700 # will automatically be disabled.
701 # The default value is: YES.
703 WARN_IF_UNDOCUMENTED   = NO
705 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
706 # potential errors in the documentation, such as not documenting some parameters
707 # in a documented function, or documenting parameters that don't exist or using
708 # markup commands wrongly.
709 # The default value is: YES.
711 WARN_IF_DOC_ERROR      = YES
713 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
714 # are documented, but have no documentation for their parameters or return
715 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
716 # documentation, but not about the absence of documentation.
717 # The default value is: NO.
719 WARN_NO_PARAMDOC       = NO
721 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
722 # can produce. The string should contain the $file, $line, and $text tags, which
723 # will be replaced by the file and line number from which the warning originated
724 # and the warning text. Optionally the format may contain $version, which will
725 # be replaced by the version of the file (if it could be obtained via
726 # FILE_VERSION_FILTER)
727 # The default value is: $file:$line: $text.
729 WARN_FORMAT            = "$file:$line: $text"
731 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
732 # messages should be written. If left blank the output is written to standard
733 # error (stderr).
735 WARN_LOGFILE           =
737 #---------------------------------------------------------------------------
738 # Configuration options related to the input files
739 #---------------------------------------------------------------------------
741 # The INPUT tag is used to specify the files and/or directories that contain
742 # documented source files. You may enter file names like myfile.cpp or
743 # directories like /usr/src/myproject. Separate the files or directories with
744 # spaces.
745 # Note: If this tag is empty the current directory is searched.
747 INPUT                  = @abs_top_srcdir@/../include \
748                          @abs_top_srcdir@/../lib \
749                          @abs_top_srcdir@/doxygen-mainpage.dox
751 # This tag can be used to specify the character encoding of the source files
752 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
753 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
754 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
755 # possible encodings.
756 # The default value is: UTF-8.
758 INPUT_ENCODING         = UTF-8
760 # If the value of the INPUT tag contains directories, you can use the
761 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
762 # *.h) to filter out the source-files in the directories. If left blank the
763 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
764 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
765 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
766 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
767 # *.qsf, *.as and *.js.
769 FILE_PATTERNS          =
771 # The RECURSIVE tag can be used to specify whether or not subdirectories should
772 # be searched for input files as well.
773 # The default value is: NO.
775 RECURSIVE              = YES
777 # The EXCLUDE tag can be used to specify files and/or directories that should be
778 # excluded from the INPUT source files. This way you can easily exclude a
779 # subdirectory from a directory tree whose root is specified with the INPUT tag.
781 # Note that relative paths are relative to the directory from which doxygen is
782 # run.
784 EXCLUDE                =
786 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
787 # directories that are symbolic links (a Unix file system feature) are excluded
788 # from the input.
789 # The default value is: NO.
791 EXCLUDE_SYMLINKS       = NO
793 # If the value of the INPUT tag contains directories, you can use the
794 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
795 # certain files from those directories.
797 # Note that the wildcards are matched against the file with absolute path, so to
798 # exclude all test directories for example use the pattern */test/*
800 EXCLUDE_PATTERNS       =
802 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
803 # (namespaces, classes, functions, etc.) that should be excluded from the
804 # output. The symbol name can be a fully qualified name, a word, or if the
805 # wildcard * is used, a substring. Examples: ANamespace, AClass,
806 # AClass::ANamespace, ANamespace::*Test
808 # Note that the wildcards are matched against the file with absolute path, so to
809 # exclude all test directories use the pattern */test/*
811 EXCLUDE_SYMBOLS        =
813 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
814 # that contain example code fragments that are included (see the \include
815 # command).
817 EXAMPLE_PATH           = @abs_top_srcdir@/../examples
819 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
820 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
821 # *.h) to filter out the source-files in the directories. If left blank all
822 # files are included.
824 EXAMPLE_PATTERNS       =
826 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
827 # searched for input files to be used with the \include or \dontinclude commands
828 # irrespective of the value of the RECURSIVE tag.
829 # The default value is: NO.
831 EXAMPLE_RECURSIVE      = YES
833 # The IMAGE_PATH tag can be used to specify one or more files or directories
834 # that contain images that are to be included in the documentation (see the
835 # \image command).
837 IMAGE_PATH             = @abs_top_srcdir@/img
839 # The INPUT_FILTER tag can be used to specify a program that doxygen should
840 # invoke to filter for each input file. Doxygen will invoke the filter program
841 # by executing (via popen()) the command:
843 # <filter> <input-file>
845 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
846 # name of an input file. Doxygen will then use the output that the filter
847 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
848 # will be ignored.
850 # Note that the filter must not add or remove lines; it is applied before the
851 # code is scanned, but not when the output code is generated. If lines are added
852 # or removed, the anchors will not be placed correctly.
854 INPUT_FILTER           =
856 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
857 # basis. Doxygen will compare the file name with each pattern and apply the
858 # filter if there is a match. The filters are a list of the form: pattern=filter
859 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
860 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
861 # patterns match the file name, INPUT_FILTER is applied.
863 FILTER_PATTERNS        =
865 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
866 # INPUT_FILTER ) will also be used to filter the input files that are used for
867 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
868 # The default value is: NO.
870 FILTER_SOURCE_FILES    = NO
872 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
873 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
874 # it is also possible to disable source filtering for a specific pattern using
875 # *.ext= (so without naming a filter).
876 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
878 FILTER_SOURCE_PATTERNS =
880 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
881 # is part of the input, its contents will be placed on the main page
882 # (index.html). This can be useful if you have a project on for instance GitHub
883 # and want to reuse the introduction page also for the doxygen output.
885 USE_MDFILE_AS_MAINPAGE =
887 #---------------------------------------------------------------------------
888 # Configuration options related to source browsing
889 #---------------------------------------------------------------------------
891 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
892 # generated. Documented entities will be cross-referenced with these sources.
894 # Note: To get rid of all source code in the generated output, make sure that
895 # also VERBATIM_HEADERS is set to NO.
896 # The default value is: NO.
898 SOURCE_BROWSER         = YES
900 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
901 # classes and enums directly into the documentation.
902 # The default value is: NO.
904 INLINE_SOURCES         = NO
906 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
907 # special comment blocks from generated source code fragments. Normal C, C++ and
908 # Fortran comments will always remain visible.
909 # The default value is: YES.
911 STRIP_CODE_COMMENTS    = NO
913 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
914 # function all documented functions referencing it will be listed.
915 # The default value is: NO.
917 REFERENCED_BY_RELATION = YES
919 # If the REFERENCES_RELATION tag is set to YES then for each documented function
920 # all documented entities called/used by that function will be listed.
921 # The default value is: NO.
923 REFERENCES_RELATION    = YES
925 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
926 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
927 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
928 # link to the documentation.
929 # The default value is: YES.
931 REFERENCES_LINK_SOURCE = YES
933 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
934 # source code will show a tooltip with additional information such as prototype,
935 # brief description and links to the definition and documentation. Since this
936 # will make the HTML file larger and loading of large files a bit slower, you
937 # can opt to disable this feature.
938 # The default value is: YES.
939 # This tag requires that the tag SOURCE_BROWSER is set to YES.
941 SOURCE_TOOLTIPS        = YES
943 # If the USE_HTAGS tag is set to YES then the references to source code will
944 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
945 # source browser. The htags tool is part of GNU's global source tagging system
946 # (see http://www.gnu.org/software/global/global.html). You will need version
947 # 4.8.6 or higher.
949 # To use it do the following:
950 # - Install the latest version of global
951 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
952 # - Make sure the INPUT points to the root of the source tree
953 # - Run doxygen as normal
955 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
956 # tools must be available from the command line (i.e. in the search path).
958 # The result: instead of the source browser generated by doxygen, the links to
959 # source code will now point to the output of htags.
960 # The default value is: NO.
961 # This tag requires that the tag SOURCE_BROWSER is set to YES.
963 USE_HTAGS              = NO
965 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
966 # verbatim copy of the header file for each class for which an include is
967 # specified. Set to NO to disable this.
968 # See also: Section \class.
969 # The default value is: YES.
971 VERBATIM_HEADERS       = YES
973 #---------------------------------------------------------------------------
974 # Configuration options related to the alphabetical class index
975 #---------------------------------------------------------------------------
977 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
978 # compounds will be generated. Enable this if the project contains a lot of
979 # classes, structs, unions or interfaces.
980 # The default value is: YES.
982 ALPHABETICAL_INDEX     = YES
984 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
985 # which the alphabetical index list will be split.
986 # Minimum value: 1, maximum value: 20, default value: 5.
987 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
989 COLS_IN_ALPHA_INDEX    = 4
991 # In case all classes in a project start with a common prefix, all classes will
992 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
993 # can be used to specify a prefix (or a list of prefixes) that should be ignored
994 # while generating the index headers.
995 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
997 IGNORE_PREFIX          = llvm::
999 #---------------------------------------------------------------------------
1000 # Configuration options related to the HTML output
1001 #---------------------------------------------------------------------------
1003 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1004 # The default value is: YES.
1006 GENERATE_HTML          = YES
1008 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1009 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1010 # it.
1011 # The default directory is: html.
1012 # This tag requires that the tag GENERATE_HTML is set to YES.
1014 HTML_OUTPUT            = html
1016 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1017 # generated HTML page (for example: .htm, .php, .asp).
1018 # The default value is: .html.
1019 # This tag requires that the tag GENERATE_HTML is set to YES.
1021 HTML_FILE_EXTENSION    = .html
1023 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1024 # each generated HTML page. If the tag is left blank doxygen will generate a
1025 # standard header.
1027 # To get valid HTML the header file that includes any scripts and style sheets
1028 # that doxygen needs, which is dependent on the configuration options used (e.g.
1029 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1030 # default header using
1031 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1032 # YourConfigFile
1033 # and then modify the file new_header.html. See also section "Doxygen usage"
1034 # for information on how to generate the default header that doxygen normally
1035 # uses.
1036 # Note: The header is subject to change so you typically have to regenerate the
1037 # default header when upgrading to a newer version of doxygen. For a description
1038 # of the possible markers and block names see the documentation.
1039 # This tag requires that the tag GENERATE_HTML is set to YES.
1041 HTML_HEADER            =
1043 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1044 # generated HTML page. If the tag is left blank doxygen will generate a standard
1045 # footer. See HTML_HEADER for more information on how to generate a default
1046 # footer and what special commands can be used inside the footer. See also
1047 # section "Doxygen usage" for information on how to generate the default footer
1048 # that doxygen normally uses.
1049 # This tag requires that the tag GENERATE_HTML is set to YES.
1051 HTML_FOOTER            =
1053 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1054 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1055 # the HTML output. If left blank doxygen will generate a default style sheet.
1056 # See also section "Doxygen usage" for information on how to generate the style
1057 # sheet that doxygen normally uses.
1058 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1059 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1060 # obsolete.
1061 # This tag requires that the tag GENERATE_HTML is set to YES.
1063 HTML_STYLESHEET        =
1065 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1066 # defined cascading style sheet that is included after the standard style sheets
1067 # created by doxygen. Using this option one can overrule certain style aspects.
1068 # This is preferred over using HTML_STYLESHEET since it does not replace the
1069 # standard style sheet and is therefor more robust against future updates.
1070 # Doxygen will copy the style sheet file to the output directory. For an example
1071 # see the documentation.
1072 # This tag requires that the tag GENERATE_HTML is set to YES.
1074 HTML_EXTRA_STYLESHEET  =
1076 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1077 # other source files which should be copied to the HTML output directory. Note
1078 # that these files will be copied to the base HTML output directory. Use the
1079 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1080 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1081 # files will be copied as-is; there are no commands or markers available.
1082 # This tag requires that the tag GENERATE_HTML is set to YES.
1084 HTML_EXTRA_FILES       =
1086 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1087 # will adjust the colors in the stylesheet and background images according to
1088 # this color. Hue is specified as an angle on a colorwheel, see
1089 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1090 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1091 # purple, and 360 is red again.
1092 # Minimum value: 0, maximum value: 359, default value: 220.
1093 # This tag requires that the tag GENERATE_HTML is set to YES.
1095 HTML_COLORSTYLE_HUE    = 220
1097 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1098 # in the HTML output. For a value of 0 the output will use grayscales only. A
1099 # value of 255 will produce the most vivid colors.
1100 # Minimum value: 0, maximum value: 255, default value: 100.
1101 # This tag requires that the tag GENERATE_HTML is set to YES.
1103 HTML_COLORSTYLE_SAT    = 100
1105 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1106 # luminance component of the colors in the HTML output. Values below 100
1107 # gradually make the output lighter, whereas values above 100 make the output
1108 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1109 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1110 # change the gamma.
1111 # Minimum value: 40, maximum value: 240, default value: 80.
1112 # This tag requires that the tag GENERATE_HTML is set to YES.
1114 HTML_COLORSTYLE_GAMMA  = 80
1116 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1117 # page will contain the date and time when the page was generated. Setting this
1118 # to NO can help when comparing the output of multiple runs.
1119 # The default value is: YES.
1120 # This tag requires that the tag GENERATE_HTML is set to YES.
1122 HTML_TIMESTAMP         = YES
1124 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1125 # documentation will contain sections that can be hidden and shown after the
1126 # page has loaded.
1127 # The default value is: NO.
1128 # This tag requires that the tag GENERATE_HTML is set to YES.
1130 HTML_DYNAMIC_SECTIONS  = NO
1132 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1133 # shown in the various tree structured indices initially; the user can expand
1134 # and collapse entries dynamically later on. Doxygen will expand the tree to
1135 # such a level that at most the specified number of entries are visible (unless
1136 # a fully collapsed tree already exceeds this amount). So setting the number of
1137 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1138 # representing an infinite number of entries and will result in a full expanded
1139 # tree by default.
1140 # Minimum value: 0, maximum value: 9999, default value: 100.
1141 # This tag requires that the tag GENERATE_HTML is set to YES.
1143 HTML_INDEX_NUM_ENTRIES = 100
1145 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1146 # generated that can be used as input for Apple's Xcode 3 integrated development
1147 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1148 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1149 # Makefile in the HTML output directory. Running make will produce the docset in
1150 # that directory and running make install will install the docset in
1151 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1152 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1153 # for more information.
1154 # The default value is: NO.
1155 # This tag requires that the tag GENERATE_HTML is set to YES.
1157 GENERATE_DOCSET        = NO
1159 # This tag determines the name of the docset feed. A documentation feed provides
1160 # an umbrella under which multiple documentation sets from a single provider
1161 # (such as a company or product suite) can be grouped.
1162 # The default value is: Doxygen generated docs.
1163 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1165 DOCSET_FEEDNAME        = "Doxygen generated docs"
1167 # This tag specifies a string that should uniquely identify the documentation
1168 # set bundle. This should be a reverse domain-name style string, e.g.
1169 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1170 # The default value is: org.doxygen.Project.
1171 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1173 DOCSET_BUNDLE_ID       = org.doxygen.Project
1175 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1176 # the documentation publisher. This should be a reverse domain-name style
1177 # string, e.g. com.mycompany.MyDocSet.documentation.
1178 # The default value is: org.doxygen.Publisher.
1179 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1181 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1183 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1184 # The default value is: Publisher.
1185 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1187 DOCSET_PUBLISHER_NAME  = Publisher
1189 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1190 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1191 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1192 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1193 # Windows.
1195 # The HTML Help Workshop contains a compiler that can convert all HTML output
1196 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1197 # files are now used as the Windows 98 help format, and will replace the old
1198 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1199 # HTML files also contain an index, a table of contents, and you can search for
1200 # words in the documentation. The HTML workshop also contains a viewer for
1201 # compressed HTML files.
1202 # The default value is: NO.
1203 # This tag requires that the tag GENERATE_HTML is set to YES.
1205 GENERATE_HTMLHELP      = NO
1207 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1208 # file. You can add a path in front of the file if the result should not be
1209 # written to the html output directory.
1210 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1212 CHM_FILE               =
1214 # The HHC_LOCATION tag can be used to specify the location (absolute path
1215 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1216 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1217 # The file has to be specified with full path.
1218 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1220 HHC_LOCATION           =
1222 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1223 # YES) or that it should be included in the master .chm file ( NO).
1224 # The default value is: NO.
1225 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1227 GENERATE_CHI           = NO
1229 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1230 # and project file content.
1231 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1233 CHM_INDEX_ENCODING     =
1235 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1236 # YES) or a normal table of contents ( NO) in the .chm file.
1237 # The default value is: NO.
1238 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1240 BINARY_TOC             = NO
1242 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1243 # the table of contents of the HTML help documentation and to the tree view.
1244 # The default value is: NO.
1245 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1247 TOC_EXPAND             = NO
1249 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1250 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1251 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1252 # (.qch) of the generated HTML documentation.
1253 # The default value is: NO.
1254 # This tag requires that the tag GENERATE_HTML is set to YES.
1256 GENERATE_QHP           = @llvm_doxygen_generate_qhp@
1258 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1259 # the file name of the resulting .qch file. The path specified is relative to
1260 # the HTML output folder.
1261 # This tag requires that the tag GENERATE_QHP is set to YES.
1263 QCH_FILE               = @llvm_doxygen_qch_filename@
1265 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1266 # Project output. For more information please see Qt Help Project / Namespace
1267 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1268 # The default value is: org.doxygen.Project.
1269 # This tag requires that the tag GENERATE_QHP is set to YES.
1271 QHP_NAMESPACE          = @llvm_doxygen_qhp_namespace@
1273 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1274 # Help Project output. For more information please see Qt Help Project / Virtual
1275 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1276 # folders).
1277 # The default value is: doc.
1278 # This tag requires that the tag GENERATE_QHP is set to YES.
1280 QHP_VIRTUAL_FOLDER     = doc
1282 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1283 # filter to add. For more information please see Qt Help Project / Custom
1284 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1285 # filters).
1286 # This tag requires that the tag GENERATE_QHP is set to YES.
1288 QHP_CUST_FILTER_NAME   = @llvm_doxygen_qhp_cust_filter_name@
1290 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1291 # custom filter to add. For more information please see Qt Help Project / Custom
1292 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1293 # filters).
1294 # This tag requires that the tag GENERATE_QHP is set to YES.
1296 QHP_CUST_FILTER_ATTRS  = @llvm_doxygen_qhp_cust_filter_attrs@
1298 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1299 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1300 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1301 # This tag requires that the tag GENERATE_QHP is set to YES.
1303 QHP_SECT_FILTER_ATTRS  =
1305 # The QHG_LOCATION tag can be used to specify the location of Qt's
1306 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1307 # generated .qhp file.
1308 # This tag requires that the tag GENERATE_QHP is set to YES.
1310 QHG_LOCATION           = @llvm_doxygen_qhelpgenerator_path@
1312 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1313 # generated, together with the HTML files, they form an Eclipse help plugin. To
1314 # install this plugin and make it available under the help contents menu in
1315 # Eclipse, the contents of the directory containing the HTML and XML files needs
1316 # to be copied into the plugins directory of eclipse. The name of the directory
1317 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1318 # After copying Eclipse needs to be restarted before the help appears.
1319 # The default value is: NO.
1320 # This tag requires that the tag GENERATE_HTML is set to YES.
1322 GENERATE_ECLIPSEHELP   = NO
1324 # A unique identifier for the Eclipse help plugin. When installing the plugin
1325 # the directory name containing the HTML and XML files should also have this
1326 # name. Each documentation set should have its own identifier.
1327 # The default value is: org.doxygen.Project.
1328 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1330 ECLIPSE_DOC_ID         = org.doxygen.Project
1332 # If you want full control over the layout of the generated HTML pages it might
1333 # be necessary to disable the index and replace it with your own. The
1334 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1335 # of each HTML page. A value of NO enables the index and the value YES disables
1336 # it. Since the tabs in the index contain the same information as the navigation
1337 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1338 # The default value is: NO.
1339 # This tag requires that the tag GENERATE_HTML is set to YES.
1341 DISABLE_INDEX          = NO
1343 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1344 # structure should be generated to display hierarchical information. If the tag
1345 # value is set to YES, a side panel will be generated containing a tree-like
1346 # index structure (just like the one that is generated for HTML Help). For this
1347 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1348 # (i.e. any modern browser). Windows users are probably better off using the
1349 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1350 # further fine-tune the look of the index. As an example, the default style
1351 # sheet generated by doxygen has an example that shows how to put an image at
1352 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1353 # the same information as the tab index, you could consider setting
1354 # DISABLE_INDEX to YES when enabling this option.
1355 # The default value is: NO.
1356 # This tag requires that the tag GENERATE_HTML is set to YES.
1358 GENERATE_TREEVIEW      = NO
1360 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1361 # doxygen will group on one line in the generated HTML documentation.
1363 # Note that a value of 0 will completely suppress the enum values from appearing
1364 # in the overview section.
1365 # Minimum value: 0, maximum value: 20, default value: 4.
1366 # This tag requires that the tag GENERATE_HTML is set to YES.
1368 ENUM_VALUES_PER_LINE   = 4
1370 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1371 # to set the initial width (in pixels) of the frame in which the tree is shown.
1372 # Minimum value: 0, maximum value: 1500, default value: 250.
1373 # This tag requires that the tag GENERATE_HTML is set to YES.
1375 TREEVIEW_WIDTH         = 250
1377 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1378 # external symbols imported via tag files in a separate window.
1379 # The default value is: NO.
1380 # This tag requires that the tag GENERATE_HTML is set to YES.
1382 EXT_LINKS_IN_WINDOW    = NO
1384 # Use this tag to change the font size of LaTeX formulas included as images in
1385 # the HTML documentation. When you change the font size after a successful
1386 # doxygen run you need to manually remove any form_*.png images from the HTML
1387 # output directory to force them to be regenerated.
1388 # Minimum value: 8, maximum value: 50, default value: 10.
1389 # This tag requires that the tag GENERATE_HTML is set to YES.
1391 FORMULA_FONTSIZE       = 10
1393 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1394 # generated for formulas are transparent PNGs. Transparent PNGs are not
1395 # supported properly for IE 6.0, but are supported on all modern browsers.
1397 # Note that when changing this option you need to delete any form_*.png files in
1398 # the HTML output directory before the changes have effect.
1399 # The default value is: YES.
1400 # This tag requires that the tag GENERATE_HTML is set to YES.
1402 FORMULA_TRANSPARENT    = YES
1404 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1405 # http://www.mathjax.org) which uses client side Javascript for the rendering
1406 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1407 # installed or if you want to formulas look prettier in the HTML output. When
1408 # enabled you may also need to install MathJax separately and configure the path
1409 # to it using the MATHJAX_RELPATH option.
1410 # The default value is: NO.
1411 # This tag requires that the tag GENERATE_HTML is set to YES.
1413 USE_MATHJAX            = YES
1415 # When MathJax is enabled you can set the default output format to be used for
1416 # the MathJax output. See the MathJax site (see:
1417 # http://docs.mathjax.org/en/latest/output.html) for more details.
1418 # Possible values are: HTML-CSS (which is slower, but has the best
1419 # compatibility), NativeMML (i.e. MathML) and SVG.
1420 # The default value is: HTML-CSS.
1421 # This tag requires that the tag USE_MATHJAX is set to YES.
1423 MATHJAX_FORMAT         = HTML-CSS
1425 # When MathJax is enabled you need to specify the location relative to the HTML
1426 # output directory using the MATHJAX_RELPATH option. The destination directory
1427 # should contain the MathJax.js script. For instance, if the mathjax directory
1428 # is located at the same level as the HTML output directory, then
1429 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1430 # Content Delivery Network so you can quickly see the result without installing
1431 # MathJax. However, it is strongly recommended to install a local copy of
1432 # MathJax from http://www.mathjax.org before deployment.
1433 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1434 # This tag requires that the tag USE_MATHJAX is set to YES.
1436 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1438 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1439 # extension names that should be enabled during MathJax rendering. For example
1440 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1441 # This tag requires that the tag USE_MATHJAX is set to YES.
1443 MATHJAX_EXTENSIONS     =
1445 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1446 # of code that will be used on startup of the MathJax code. See the MathJax site
1447 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1448 # example see the documentation.
1449 # This tag requires that the tag USE_MATHJAX is set to YES.
1451 MATHJAX_CODEFILE       =
1453 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1454 # the HTML output. The underlying search engine uses javascript and DHTML and
1455 # should work on any modern browser. Note that when using HTML help
1456 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1457 # there is already a search function so this one should typically be disabled.
1458 # For large projects the javascript based search engine can be slow, then
1459 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1460 # search using the keyboard; to jump to the search box use <access key> + S
1461 # (what the <access key> is depends on the OS and browser, but it is typically
1462 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1463 # key> to jump into the search results window, the results can be navigated
1464 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1465 # the search. The filter options can be selected when the cursor is inside the
1466 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1467 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1468 # option.
1469 # The default value is: YES.
1470 # This tag requires that the tag GENERATE_HTML is set to YES.
1472 SEARCHENGINE           = @enable_searchengine@
1474 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1475 # implemented using a web server instead of a web client using Javascript. There
1476 # are two flavours of web server based searching depending on the
1477 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1478 # searching and an index file used by the script. When EXTERNAL_SEARCH is
1479 # enabled the indexing and searching needs to be provided by external tools. See
1480 # the section "External Indexing and Searching" for details.
1481 # The default value is: NO.
1482 # This tag requires that the tag SEARCHENGINE is set to YES.
1484 SERVER_BASED_SEARCH    = @enable_server_based_search@
1486 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1487 # script for searching. Instead the search results are written to an XML file
1488 # which needs to be processed by an external indexer. Doxygen will invoke an
1489 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1490 # search results.
1492 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1493 # (doxysearch.cgi) which are based on the open source search engine library
1494 # Xapian (see: http://xapian.org/).
1496 # See the section "External Indexing and Searching" for details.
1497 # The default value is: NO.
1498 # This tag requires that the tag SEARCHENGINE is set to YES.
1500 EXTERNAL_SEARCH        = @enable_external_search@
1502 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1503 # which will return the search results when EXTERNAL_SEARCH is enabled.
1505 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1506 # (doxysearch.cgi) which are based on the open source search engine library
1507 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1508 # Searching" for details.
1509 # This tag requires that the tag SEARCHENGINE is set to YES.
1511 SEARCHENGINE_URL       = @searchengine_url@
1513 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1514 # search data is written to a file for indexing by an external tool. With the
1515 # SEARCHDATA_FILE tag the name of this file can be specified.
1516 # The default file is: searchdata.xml.
1517 # This tag requires that the tag SEARCHENGINE is set to YES.
1519 SEARCHDATA_FILE        = searchdata.xml
1521 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1522 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1523 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1524 # projects and redirect the results back to the right project.
1525 # This tag requires that the tag SEARCHENGINE is set to YES.
1527 EXTERNAL_SEARCH_ID     = llvm
1529 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1530 # projects other than the one defined by this configuration file, but that are
1531 # all added to the same external search index. Each project needs to have a
1532 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1533 # to a relative location where the documentation can be found. The format is:
1534 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1535 # This tag requires that the tag SEARCHENGINE is set to YES.
1537 EXTRA_SEARCH_MAPPINGS  = @extra_search_mappings@
1539 #---------------------------------------------------------------------------
1540 # Configuration options related to the LaTeX output
1541 #---------------------------------------------------------------------------
1543 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1544 # The default value is: YES.
1546 GENERATE_LATEX         = NO
1548 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1549 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1550 # it.
1551 # The default directory is: latex.
1552 # This tag requires that the tag GENERATE_LATEX is set to YES.
1554 LATEX_OUTPUT           = latex
1556 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1557 # invoked.
1559 # Note that when enabling USE_PDFLATEX this option is only used for generating
1560 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1561 # written to the output directory.
1562 # The default file is: latex.
1563 # This tag requires that the tag GENERATE_LATEX is set to YES.
1565 LATEX_CMD_NAME         = latex
1567 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1568 # index for LaTeX.
1569 # The default file is: makeindex.
1570 # This tag requires that the tag GENERATE_LATEX is set to YES.
1572 MAKEINDEX_CMD_NAME     = makeindex
1574 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1575 # documents. This may be useful for small projects and may help to save some
1576 # trees in general.
1577 # The default value is: NO.
1578 # This tag requires that the tag GENERATE_LATEX is set to YES.
1580 COMPACT_LATEX          = NO
1582 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1583 # printer.
1584 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1585 # 14 inches) and executive (7.25 x 10.5 inches).
1586 # The default value is: a4.
1587 # This tag requires that the tag GENERATE_LATEX is set to YES.
1589 PAPER_TYPE             = a4
1591 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1592 # that should be included in the LaTeX output. To get the times font for
1593 # instance you can specify
1594 # EXTRA_PACKAGES=times
1595 # If left blank no extra packages will be included.
1596 # This tag requires that the tag GENERATE_LATEX is set to YES.
1598 EXTRA_PACKAGES         =
1600 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1601 # generated LaTeX document. The header should contain everything until the first
1602 # chapter. If it is left blank doxygen will generate a standard header. See
1603 # section "Doxygen usage" for information on how to let doxygen write the
1604 # default header to a separate file.
1606 # Note: Only use a user-defined header if you know what you are doing! The
1607 # following commands have a special meaning inside the header: $title,
1608 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1609 # replace them by respectively the title of the page, the current date and time,
1610 # only the current date, the version number of doxygen, the project name (see
1611 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1612 # This tag requires that the tag GENERATE_LATEX is set to YES.
1614 LATEX_HEADER           =
1616 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1617 # generated LaTeX document. The footer should contain everything after the last
1618 # chapter. If it is left blank doxygen will generate a standard footer.
1620 # Note: Only use a user-defined footer if you know what you are doing!
1621 # This tag requires that the tag GENERATE_LATEX is set to YES.
1623 LATEX_FOOTER           =
1625 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1626 # other source files which should be copied to the LATEX_OUTPUT output
1627 # directory. Note that the files will be copied as-is; there are no commands or
1628 # markers available.
1629 # This tag requires that the tag GENERATE_LATEX is set to YES.
1631 LATEX_EXTRA_FILES      =
1633 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1634 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1635 # contain links (just like the HTML output) instead of page references. This
1636 # makes the output suitable for online browsing using a PDF viewer.
1637 # The default value is: YES.
1638 # This tag requires that the tag GENERATE_LATEX is set to YES.
1640 PDF_HYPERLINKS         = YES
1642 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1643 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1644 # higher quality PDF documentation.
1645 # The default value is: YES.
1646 # This tag requires that the tag GENERATE_LATEX is set to YES.
1648 USE_PDFLATEX           = YES
1650 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1651 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1652 # if errors occur, instead of asking the user for help. This option is also used
1653 # when generating formulas in HTML.
1654 # The default value is: NO.
1655 # This tag requires that the tag GENERATE_LATEX is set to YES.
1657 LATEX_BATCHMODE        = NO
1659 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1660 # index chapters (such as File Index, Compound Index, etc.) in the output.
1661 # The default value is: NO.
1662 # This tag requires that the tag GENERATE_LATEX is set to YES.
1664 LATEX_HIDE_INDICES     = NO
1666 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1667 # code with syntax highlighting in the LaTeX output.
1669 # Note that which sources are shown also depends on other settings such as
1670 # SOURCE_BROWSER.
1671 # The default value is: NO.
1672 # This tag requires that the tag GENERATE_LATEX is set to YES.
1674 LATEX_SOURCE_CODE      = NO
1676 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1677 # bibliography, e.g. plainnat, or ieeetr. See
1678 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1679 # The default value is: plain.
1680 # This tag requires that the tag GENERATE_LATEX is set to YES.
1682 LATEX_BIB_STYLE        = plain
1684 #---------------------------------------------------------------------------
1685 # Configuration options related to the RTF output
1686 #---------------------------------------------------------------------------
1688 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1689 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1690 # readers/editors.
1691 # The default value is: NO.
1693 GENERATE_RTF           = NO
1695 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1696 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1697 # it.
1698 # The default directory is: rtf.
1699 # This tag requires that the tag GENERATE_RTF is set to YES.
1701 RTF_OUTPUT             = rtf
1703 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1704 # documents. This may be useful for small projects and may help to save some
1705 # trees in general.
1706 # The default value is: NO.
1707 # This tag requires that the tag GENERATE_RTF is set to YES.
1709 COMPACT_RTF            = NO
1711 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1712 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1713 # output) instead of page references. This makes the output suitable for online
1714 # browsing using Word or some other Word compatible readers that support those
1715 # fields.
1717 # Note: WordPad (write) and others do not support links.
1718 # The default value is: NO.
1719 # This tag requires that the tag GENERATE_RTF is set to YES.
1721 RTF_HYPERLINKS         = NO
1723 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1724 # file, i.e. a series of assignments. You only have to provide replacements,
1725 # missing definitions are set to their default value.
1727 # See also section "Doxygen usage" for information on how to generate the
1728 # default style sheet that doxygen normally uses.
1729 # This tag requires that the tag GENERATE_RTF is set to YES.
1731 RTF_STYLESHEET_FILE    =
1733 # Set optional variables used in the generation of an RTF document. Syntax is
1734 # similar to doxygen's config file. A template extensions file can be generated
1735 # using doxygen -e rtf extensionFile.
1736 # This tag requires that the tag GENERATE_RTF is set to YES.
1738 RTF_EXTENSIONS_FILE    =
1740 #---------------------------------------------------------------------------
1741 # Configuration options related to the man page output
1742 #---------------------------------------------------------------------------
1744 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1745 # classes and files.
1746 # The default value is: NO.
1748 GENERATE_MAN           = NO
1750 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1751 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1752 # it. A directory man3 will be created inside the directory specified by
1753 # MAN_OUTPUT.
1754 # The default directory is: man.
1755 # This tag requires that the tag GENERATE_MAN is set to YES.
1757 MAN_OUTPUT             = man
1759 # The MAN_EXTENSION tag determines the extension that is added to the generated
1760 # man pages. In case the manual section does not start with a number, the number
1761 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1762 # optional.
1763 # The default value is: .3.
1764 # This tag requires that the tag GENERATE_MAN is set to YES.
1766 MAN_EXTENSION          = .3
1768 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1769 # will generate one additional man file for each entity documented in the real
1770 # man page(s). These additional files only source the real man page, but without
1771 # them the man command would be unable to find the correct page.
1772 # The default value is: NO.
1773 # This tag requires that the tag GENERATE_MAN is set to YES.
1775 MAN_LINKS              = NO
1777 #---------------------------------------------------------------------------
1778 # Configuration options related to the XML output
1779 #---------------------------------------------------------------------------
1781 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1782 # captures the structure of the code including all documentation.
1783 # The default value is: NO.
1785 GENERATE_XML           = NO
1787 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1788 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1789 # it.
1790 # The default directory is: xml.
1791 # This tag requires that the tag GENERATE_XML is set to YES.
1793 XML_OUTPUT             = xml
1795 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1796 # listings (including syntax highlighting and cross-referencing information) to
1797 # the XML output. Note that enabling this will significantly increase the size
1798 # of the XML output.
1799 # The default value is: YES.
1800 # This tag requires that the tag GENERATE_XML is set to YES.
1802 XML_PROGRAMLISTING     = YES
1804 #---------------------------------------------------------------------------
1805 # Configuration options related to the DOCBOOK output
1806 #---------------------------------------------------------------------------
1808 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1809 # that can be used to generate PDF.
1810 # The default value is: NO.
1812 GENERATE_DOCBOOK       = NO
1814 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1815 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1816 # front of it.
1817 # The default directory is: docbook.
1818 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1820 DOCBOOK_OUTPUT         = docbook
1822 #---------------------------------------------------------------------------
1823 # Configuration options for the AutoGen Definitions output
1824 #---------------------------------------------------------------------------
1826 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1827 # Definitions (see http://autogen.sf.net) file that captures the structure of
1828 # the code including all documentation. Note that this feature is still
1829 # experimental and incomplete at the moment.
1830 # The default value is: NO.
1832 GENERATE_AUTOGEN_DEF   = NO
1834 #---------------------------------------------------------------------------
1835 # Configuration options related to the Perl module output
1836 #---------------------------------------------------------------------------
1838 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1839 # file that captures the structure of the code including all documentation.
1841 # Note that this feature is still experimental and incomplete at the moment.
1842 # The default value is: NO.
1844 GENERATE_PERLMOD       = NO
1846 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1847 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1848 # output from the Perl module output.
1849 # The default value is: NO.
1850 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1852 PERLMOD_LATEX          = NO
1854 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1855 # formatted so it can be parsed by a human reader. This is useful if you want to
1856 # understand what is going on. On the other hand, if this tag is set to NO the
1857 # size of the Perl module output will be much smaller and Perl will parse it
1858 # just the same.
1859 # The default value is: YES.
1860 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1862 PERLMOD_PRETTY         = YES
1864 # The names of the make variables in the generated doxyrules.make file are
1865 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1866 # so different doxyrules.make files included by the same Makefile don't
1867 # overwrite each other's variables.
1868 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1870 PERLMOD_MAKEVAR_PREFIX =
1872 #---------------------------------------------------------------------------
1873 # Configuration options related to the preprocessor
1874 #---------------------------------------------------------------------------
1876 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1877 # C-preprocessor directives found in the sources and include files.
1878 # The default value is: YES.
1880 ENABLE_PREPROCESSING   = YES
1882 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1883 # in the source code. If set to NO only conditional compilation will be
1884 # performed. Macro expansion can be done in a controlled way by setting
1885 # EXPAND_ONLY_PREDEF to YES.
1886 # The default value is: NO.
1887 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1889 MACRO_EXPANSION        = YES
1891 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1892 # the macro expansion is limited to the macros specified with the PREDEFINED and
1893 # EXPAND_AS_DEFINED tags.
1894 # The default value is: NO.
1895 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1897 EXPAND_ONLY_PREDEF     = YES
1899 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1900 # INCLUDE_PATH will be searched if a #include is found.
1901 # The default value is: YES.
1902 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1904 SEARCH_INCLUDES        = YES
1906 # The INCLUDE_PATH tag can be used to specify one or more directories that
1907 # contain include files that are not input files but should be processed by the
1908 # preprocessor.
1909 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1911 INCLUDE_PATH           = ../include
1913 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1914 # patterns (like *.h and *.hpp) to filter out the header-files in the
1915 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1916 # used.
1917 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1919 INCLUDE_FILE_PATTERNS  =
1921 # The PREDEFINED tag can be used to specify one or more macro names that are
1922 # defined before the preprocessor is started (similar to the -D option of e.g.
1923 # gcc). The argument of the tag is a list of macros of the form: name or
1924 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1925 # is assumed. To prevent a macro definition from being undefined via #undef or
1926 # recursively expanded use the := operator instead of the = operator.
1927 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1929 PREDEFINED             = LLVM_ALIGNAS(x)=
1931 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
1932 # tag can be used to specify a list of macro names that should be expanded. The
1933 # macro definition that is found in the sources will be used. Use the PREDEFINED
1934 # tag if you want to use a different macro definition that overrules the
1935 # definition found in the source code.
1936 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1938 EXPAND_AS_DEFINED      =
1940 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1941 # remove all references to function-like macros that are alone on a line, have an
1942 # all uppercase name, and do not end with a semicolon. Such function macros are
1943 # typically used for boiler-plate code, and will confuse the parser if not
1944 # removed.
1945 # The default value is: YES.
1946 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1948 SKIP_FUNCTION_MACROS   = YES
1950 #---------------------------------------------------------------------------
1951 # Configuration options related to external references
1952 #---------------------------------------------------------------------------
1954 # The TAGFILES tag can be used to specify one or more tag files. For each tag
1955 # file the location of the external documentation should be added. The format of
1956 # a tag file without this location is as follows:
1957 # TAGFILES = file1 file2 ...
1958 # Adding location for the tag files is done as follows:
1959 # TAGFILES = file1=loc1 "file2 = loc2" ...
1960 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
1961 # section "Linking to external documentation" for more information about the use
1962 # of tag files.
1963 # Note: Each tag file must have an unique name (where the name does NOT include
1964 # the path). If a tag file is not located in the directory in which doxygen is
1965 # run, you must also specify the path to the tagfile here.
1967 TAGFILES               =
1969 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
1970 # tag file that is based on the input files it reads. See section "Linking to
1971 # external documentation" for more information about the usage of tag files.
1973 GENERATE_TAGFILE       =
1975 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1976 # class index. If set to NO only the inherited external classes will be listed.
1977 # The default value is: NO.
1979 ALLEXTERNALS           = YES
1981 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
1982 # the modules index. If set to NO, only the current project's groups will be
1983 # listed.
1984 # The default value is: YES.
1986 EXTERNAL_GROUPS        = YES
1988 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
1989 # the related pages index. If set to NO, only the current project's pages will
1990 # be listed.
1991 # The default value is: YES.
1993 EXTERNAL_PAGES         = YES
1995 # The PERL_PATH should be the absolute path and name of the perl script
1996 # interpreter (i.e. the result of 'which perl').
1997 # The default file (with absolute path) is: /usr/bin/perl.
1999 PERL_PATH              = /usr/bin/perl
2001 #---------------------------------------------------------------------------
2002 # Configuration options related to the dot tool
2003 #---------------------------------------------------------------------------
2005 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2006 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2007 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2008 # disabled, but it is recommended to install and use dot, since it yields more
2009 # powerful graphs.
2010 # The default value is: YES.
2012 CLASS_DIAGRAMS         = YES
2014 # You can define message sequence charts within doxygen comments using the \msc
2015 # command. Doxygen will then run the mscgen tool (see:
2016 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2017 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2018 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2019 # default search path.
2021 MSCGEN_PATH            =
2023 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2024 # then run dia to produce the diagram and insert it in the documentation. The
2025 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2026 # If left empty dia is assumed to be found in the default search path.
2028 DIA_PATH               =
2030 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2031 # and usage relations if the target is undocumented or is not a class.
2032 # The default value is: YES.
2034 HIDE_UNDOC_RELATIONS   = NO
2036 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2037 # available from the path. This tool is part of Graphviz (see:
2038 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2039 # Bell Labs. The other options in this section have no effect if this option is
2040 # set to NO
2041 # The default value is: NO.
2043 HAVE_DOT               = YES
2045 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2046 # to run in parallel. When set to 0 doxygen will base this on the number of
2047 # processors available in the system. You can set it explicitly to a value
2048 # larger than 0 to get control over the balance between CPU load and processing
2049 # speed.
2050 # Minimum value: 0, maximum value: 32, default value: 0.
2051 # This tag requires that the tag HAVE_DOT is set to YES.
2053 DOT_NUM_THREADS        = 0
2055 # When you want a differently looking font n the dot files that doxygen
2056 # generates you can specify the font name using DOT_FONTNAME. You need to make
2057 # sure dot is able to find the font, which can be done by putting it in a
2058 # standard location or by setting the DOTFONTPATH environment variable or by
2059 # setting DOT_FONTPATH to the directory containing the font.
2060 # The default value is: Helvetica.
2061 # This tag requires that the tag HAVE_DOT is set to YES.
2063 DOT_FONTNAME           = Helvetica
2065 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2066 # dot graphs.
2067 # Minimum value: 4, maximum value: 24, default value: 10.
2068 # This tag requires that the tag HAVE_DOT is set to YES.
2070 DOT_FONTSIZE           = 10
2072 # By default doxygen will tell dot to use the default font as specified with
2073 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2074 # the path where dot can find it using this tag.
2075 # This tag requires that the tag HAVE_DOT is set to YES.
2077 DOT_FONTPATH           =
2079 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2080 # each documented class showing the direct and indirect inheritance relations.
2081 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2082 # The default value is: YES.
2083 # This tag requires that the tag HAVE_DOT is set to YES.
2085 CLASS_GRAPH            = YES
2087 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2088 # graph for each documented class showing the direct and indirect implementation
2089 # dependencies (inheritance, containment, and class references variables) of the
2090 # class with other documented classes.
2091 # The default value is: YES.
2092 # This tag requires that the tag HAVE_DOT is set to YES.
2094 COLLABORATION_GRAPH    = YES
2096 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2097 # groups, showing the direct groups dependencies.
2098 # The default value is: YES.
2099 # This tag requires that the tag HAVE_DOT is set to YES.
2101 GROUP_GRAPHS           = YES
2103 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2104 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2105 # Language.
2106 # The default value is: NO.
2107 # This tag requires that the tag HAVE_DOT is set to YES.
2109 UML_LOOK               = NO
2111 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2112 # class node. If there are many fields or methods and many nodes the graph may
2113 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2114 # number of items for each type to make the size more manageable. Set this to 0
2115 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2116 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2117 # but if the number exceeds 15, the total amount of fields shown is limited to
2118 # 10.
2119 # Minimum value: 0, maximum value: 100, default value: 10.
2120 # This tag requires that the tag HAVE_DOT is set to YES.
2122 UML_LIMIT_NUM_FIELDS   = 10
2124 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2125 # collaboration graphs will show the relations between templates and their
2126 # instances.
2127 # The default value is: NO.
2128 # This tag requires that the tag HAVE_DOT is set to YES.
2130 TEMPLATE_RELATIONS     = YES
2132 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2133 # YES then doxygen will generate a graph for each documented file showing the
2134 # direct and indirect include dependencies of the file with other documented
2135 # files.
2136 # The default value is: YES.
2137 # This tag requires that the tag HAVE_DOT is set to YES.
2139 INCLUDE_GRAPH          = YES
2141 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2142 # set to YES then doxygen will generate a graph for each documented file showing
2143 # the direct and indirect include dependencies of the file with other documented
2144 # files.
2145 # The default value is: YES.
2146 # This tag requires that the tag HAVE_DOT is set to YES.
2148 INCLUDED_BY_GRAPH      = YES
2150 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2151 # dependency graph for every global function or class method.
2153 # Note that enabling this option will significantly increase the time of a run.
2154 # So in most cases it will be better to enable call graphs for selected
2155 # functions only using the \callgraph command.
2156 # The default value is: NO.
2157 # This tag requires that the tag HAVE_DOT is set to YES.
2159 CALL_GRAPH             = NO
2161 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2162 # dependency graph for every global function or class method.
2164 # Note that enabling this option will significantly increase the time of a run.
2165 # So in most cases it will be better to enable caller graphs for selected
2166 # functions only using the \callergraph command.
2167 # The default value is: NO.
2168 # This tag requires that the tag HAVE_DOT is set to YES.
2170 CALLER_GRAPH           = NO
2172 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2173 # hierarchy of all classes instead of a textual one.
2174 # The default value is: YES.
2175 # This tag requires that the tag HAVE_DOT is set to YES.
2177 GRAPHICAL_HIERARCHY    = YES
2179 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2180 # dependencies a directory has on other directories in a graphical way. The
2181 # dependency relations are determined by the #include relations between the
2182 # files in the directories.
2183 # The default value is: YES.
2184 # This tag requires that the tag HAVE_DOT is set to YES.
2186 DIRECTORY_GRAPH        = YES
2188 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2189 # generated by dot.
2190 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2191 # to make the SVG files visible in IE 9+ (other browsers do not have this
2192 # requirement).
2193 # Possible values are: png, jpg, gif and svg.
2194 # The default value is: png.
2195 # This tag requires that the tag HAVE_DOT is set to YES.
2197 DOT_IMAGE_FORMAT       = @DOT_IMAGE_FORMAT@
2199 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2200 # enable generation of interactive SVG images that allow zooming and panning.
2202 # Note that this requires a modern browser other than Internet Explorer. Tested
2203 # and working are Firefox, Chrome, Safari, and Opera.
2204 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2205 # the SVG files visible. Older versions of IE do not have SVG support.
2206 # The default value is: NO.
2207 # This tag requires that the tag HAVE_DOT is set to YES.
2209 INTERACTIVE_SVG        = NO
2211 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2212 # found. If left blank, it is assumed the dot tool can be found in the path.
2213 # This tag requires that the tag HAVE_DOT is set to YES.
2215 DOT_PATH               = @DOT@
2217 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2218 # contain dot files that are included in the documentation (see the \dotfile
2219 # command).
2220 # This tag requires that the tag HAVE_DOT is set to YES.
2222 DOTFILE_DIRS           =
2224 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2225 # contain msc files that are included in the documentation (see the \mscfile
2226 # command).
2228 MSCFILE_DIRS           =
2230 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2231 # contain dia files that are included in the documentation (see the \diafile
2232 # command).
2234 DIAFILE_DIRS           =
2236 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2237 # that will be shown in the graph. If the number of nodes in a graph becomes
2238 # larger than this value, doxygen will truncate the graph, which is visualized
2239 # by representing a node as a red box. Note that doxygen if the number of direct
2240 # children of the root node in a graph is already larger than
2241 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2242 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2243 # Minimum value: 0, maximum value: 10000, default value: 50.
2244 # This tag requires that the tag HAVE_DOT is set to YES.
2246 DOT_GRAPH_MAX_NODES    = 50
2248 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2249 # generated by dot. A depth value of 3 means that only nodes reachable from the
2250 # root by following a path via at most 3 edges will be shown. Nodes that lay
2251 # further from the root node will be omitted. Note that setting this option to 1
2252 # or 2 may greatly reduce the computation time needed for large code bases. Also
2253 # note that the size of a graph can be further restricted by
2254 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2255 # Minimum value: 0, maximum value: 1000, default value: 0.
2256 # This tag requires that the tag HAVE_DOT is set to YES.
2258 MAX_DOT_GRAPH_DEPTH    = 0
2260 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2261 # background. This is disabled by default, because dot on Windows does not seem
2262 # to support this out of the box.
2264 # Warning: Depending on the platform used, enabling this option may lead to
2265 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2266 # read).
2267 # The default value is: NO.
2268 # This tag requires that the tag HAVE_DOT is set to YES.
2270 DOT_TRANSPARENT        = YES
2272 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2273 # files in one run (i.e. multiple -o and -T options on the command line). This
2274 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2275 # this, this feature is disabled by default.
2276 # The default value is: NO.
2277 # This tag requires that the tag HAVE_DOT is set to YES.
2279 DOT_MULTI_TARGETS      = YES
2281 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2282 # explaining the meaning of the various boxes and arrows in the dot generated
2283 # graphs.
2284 # The default value is: YES.
2285 # This tag requires that the tag HAVE_DOT is set to YES.
2287 GENERATE_LEGEND        = YES
2289 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2290 # files that are used to generate the various graphs.
2291 # The default value is: YES.
2292 # This tag requires that the tag HAVE_DOT is set to YES.
2294 DOT_CLEANUP            = YES