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.
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 = Shaarli
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.
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 = "The personal, minimalist, super-fast, no-database delicious clone"
49 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50 # in the documentation. The maximum height of the logo should not exceed 55
51 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52 # the logo to the output directory.
54 PROJECT_LOGO = images/logo.png
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.
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.
73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74 # characters to appear in the names of generated files. If set to NO, non-ASCII
75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
77 # The default value is: NO.
79 ALLOW_UNICODE_NAMES = NO
81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
82 # documentation generated by doxygen is written. Doxygen will use this
83 # information to generate all constant output in the proper language.
84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91 # Ukrainian and Vietnamese.
92 # The default value is: English.
94 OUTPUT_LANGUAGE = English
96 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
97 # descriptions after the members that are listed in the file and class
98 # documentation (similar to Javadoc). Set to NO to disable this.
99 # The default value is: YES.
101 BRIEF_MEMBER_DESC = YES
103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104 # description of a member or function before the detailed description
106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107 # brief descriptions will be completely suppressed.
108 # The default value is: YES.
112 # This tag implements a quasi-intelligent brief description abbreviator that is
113 # used to form the text in various listings. Each string in this list, if found
114 # as the leading text of the brief description, will be stripped from the text
115 # and the result, after processing the whole list, is used as the annotated
116 # text. Otherwise, the brief description is used as-is. If left blank, the
117 # following values are used ($name is automatically replaced with the name of
118 # the entity):The $name class, The $name widget, The $name file, is, provides,
119 # specifies, contains, represents, a, an and the.
121 ABBREVIATE_BRIEF = "The $name class" \
133 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
134 # doxygen will generate a detailed section even if there is only a brief
136 # The default value is: NO.
138 ALWAYS_DETAILED_SEC = NO
140 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
141 # inherited members of a class in the documentation of that class as if those
142 # members were ordinary class members. Constructors, destructors and assignment
143 # operators of the base classes will not be shown.
144 # The default value is: NO.
146 INLINE_INHERITED_MEMB = NO
148 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
149 # before files name in the file list and in the header files. If set to NO the
150 # shortest path that makes the file name unique will be used
151 # The default value is: YES.
153 FULL_PATH_NAMES = YES
155 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
156 # Stripping is only done if one of the specified strings matches the left-hand
157 # part of the path. The tag can be used to show relative paths in the file list.
158 # If left blank the directory from which doxygen is run is used as the path to
161 # Note that you can specify absolute paths here, but also relative paths, which
162 # will be relative from the directory where doxygen is started.
163 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
167 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
168 # path mentioned in the documentation of a class, which tells the reader which
169 # header file to include in order to use a class. If left blank only the name of
170 # the header file containing the class definition is used. Otherwise one should
171 # specify the list of include paths that are normally passed to the compiler
174 STRIP_FROM_INC_PATH =
176 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
177 # less readable) file names. This can be useful is your file systems doesn't
178 # support long names like on DOS, Mac, or CD-ROM.
179 # The default value is: NO.
183 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
184 # first line (until the first dot) of a Javadoc-style comment as the brief
185 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
186 # style comments (thus requiring an explicit @brief command for a brief
188 # The default value is: NO.
190 JAVADOC_AUTOBRIEF = NO
192 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
193 # line (until the first dot) of a Qt-style comment as the brief description. If
194 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
195 # requiring an explicit \brief command for a brief description.)
196 # The default value is: NO.
200 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
201 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
202 # a brief description. This used to be the default behavior. The new default is
203 # to treat a multi-line C++ comment block as a detailed description. Set this
204 # tag to YES if you prefer the old behavior instead.
206 # Note that setting this tag to YES also means that rational rose comments are
207 # not recognized any more.
208 # The default value is: NO.
210 MULTILINE_CPP_IS_BRIEF = NO
212 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
213 # documentation from any documented member that it re-implements.
214 # The default value is: YES.
218 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
219 # page for each member. If set to NO, the documentation of a member will be part
220 # of the file/class/namespace that contains it.
221 # The default value is: NO.
223 SEPARATE_MEMBER_PAGES = NO
225 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
226 # uses this value to replace tabs by spaces in code fragments.
227 # Minimum value: 1, maximum value: 16, default value: 4.
231 # This tag can be used to specify a number of aliases that act as commands in
232 # the documentation. An alias has the form:
235 # "sideeffect=@par Side Effects:\n"
236 # will allow you to put the command \sideeffect (or @sideeffect) in the
237 # documentation, which will result in a user-defined paragraph with heading
238 # "Side Effects:". You can put \n's in the value part of an alias to insert
243 # This tag can be used to specify a number of word-keyword mappings (TCL only).
244 # A mapping has the form "name=value". For example adding "class=itcl::class"
245 # will allow you to use the command class in the itcl::class meaning.
249 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
250 # only. Doxygen will then generate output that is more tailored for C. For
251 # instance, some of the names that are used will be different. The list of all
252 # members will be omitted, etc.
253 # The default value is: NO.
255 OPTIMIZE_OUTPUT_FOR_C = YES
257 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
258 # Python sources only. Doxygen will then generate output that is more tailored
259 # for that language. For instance, namespaces will be presented as packages,
260 # qualified scopes will look different, etc.
261 # The default value is: NO.
263 OPTIMIZE_OUTPUT_JAVA = NO
265 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
266 # sources. Doxygen will then generate output that is tailored for Fortran.
267 # The default value is: NO.
269 OPTIMIZE_FOR_FORTRAN = NO
271 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
272 # sources. Doxygen will then generate output that is tailored for VHDL.
273 # The default value is: NO.
275 OPTIMIZE_OUTPUT_VHDL = NO
277 # Doxygen selects the parser to use depending on the extension of the files it
278 # parses. With this tag you can assign which parser to use for a given
279 # extension. Doxygen has a built-in mapping, but you can override or extend it
280 # using this tag. The format is ext=language, where ext is a file extension, and
281 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
282 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
283 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
284 # Fortran. In the later case the parser tries to guess whether the code is fixed
285 # or free formatted code, this is the default for Fortran type files), VHDL. For
286 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
287 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
289 # Note: For files without extension you can use no_extension as a placeholder.
291 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
292 # the files are not read by doxygen.
296 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
297 # according to the Markdown format, which allows for more readable
298 # documentation. See http://daringfireball.net/projects/markdown/ for details.
299 # The output of markdown processing is further processed by doxygen, so you can
300 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
301 # case of backward compatibilities issues.
302 # The default value is: YES.
304 MARKDOWN_SUPPORT = YES
306 # When enabled doxygen tries to link words that correspond to documented
307 # classes, or namespaces to their corresponding documentation. Such a link can
308 # be prevented in individual cases by putting a % sign in front of the word or
309 # globally by setting AUTOLINK_SUPPORT to NO.
310 # The default value is: YES.
312 AUTOLINK_SUPPORT = YES
314 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
315 # to include (a tag file for) the STL sources as input, then you should set this
316 # tag to YES in order to let doxygen match functions declarations and
317 # definitions whose arguments contain STL classes (e.g. func(std::string);
318 # versus func(std::string) {}). This also make the inheritance and collaboration
319 # diagrams that involve STL classes more complete and accurate.
320 # The default value is: NO.
322 BUILTIN_STL_SUPPORT = NO
324 # If you use Microsoft's C++/CLI language, you should set this option to YES to
325 # enable parsing support.
326 # The default value is: NO.
330 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
331 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
332 # will parse them like normal C++ but will assume all classes use public instead
333 # of private inheritance when no explicit protection keyword is present.
334 # The default value is: NO.
338 # For Microsoft's IDL there are propget and propput attributes to indicate
339 # getter and setter methods for a property. Setting this option to YES will make
340 # doxygen to replace the get and set methods by a property in the documentation.
341 # This will only work if the methods are indeed getting or setting a simple
342 # type. If this is not the case, or you want to show the methods anyway, you
343 # should set this option to NO.
344 # The default value is: YES.
346 IDL_PROPERTY_SUPPORT = YES
348 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
349 # tag is set to YES then doxygen will reuse the documentation of the first
350 # member in the group (if any) for the other members of the group. By default
351 # all members of a group must be documented explicitly.
352 # The default value is: NO.
354 DISTRIBUTE_GROUP_DOC = NO
356 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
357 # (for instance a group of public functions) to be put as a subgroup of that
358 # type (e.g. under the Public Functions section). Set it to NO to prevent
359 # subgrouping. Alternatively, this can be done per class using the
360 # \nosubgrouping command.
361 # The default value is: YES.
365 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
366 # are shown inside the group in which they are included (e.g. using \ingroup)
367 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
370 # Note that this feature does not work in combination with
371 # SEPARATE_MEMBER_PAGES.
372 # The default value is: NO.
374 INLINE_GROUPED_CLASSES = NO
376 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
377 # with only public data fields or simple typedef fields will be shown inline in
378 # the documentation of the scope in which they are defined (i.e. file,
379 # namespace, or group documentation), provided this scope is documented. If set
380 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
381 # Man pages) or section (for LaTeX and RTF).
382 # The default value is: NO.
384 INLINE_SIMPLE_STRUCTS = NO
386 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
387 # enum is documented as struct, union, or enum with the name of the typedef. So
388 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
389 # with name TypeT. When disabled the typedef will appear as a member of a file,
390 # namespace, or class. And the struct will be named TypeS. This can typically be
391 # useful for C code in case the coding convention dictates that all compound
392 # types are typedef'ed and only the typedef is referenced, never the tag name.
393 # The default value is: NO.
395 TYPEDEF_HIDES_STRUCT = NO
397 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
398 # cache is used to resolve symbols given their name and scope. Since this can be
399 # an expensive process and often the same symbol appears multiple times in the
400 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
401 # doxygen will become slower. If the cache is too large, memory is wasted. The
402 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
403 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
404 # symbols. At the end of a run doxygen will report the cache usage and suggest
405 # the optimal cache size from a speed point of view.
406 # Minimum value: 0, maximum value: 9, default value: 0.
408 LOOKUP_CACHE_SIZE = 0
410 #---------------------------------------------------------------------------
411 # Build related configuration options
412 #---------------------------------------------------------------------------
414 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
415 # documentation are documented, even if no documentation was available. Private
416 # class members and static file members will be hidden unless the
417 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
418 # Note: This will also disable the warnings about undocumented members that are
419 # normally produced when WARNINGS is set to YES.
420 # The default value is: NO.
424 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
425 # be included in the documentation.
426 # The default value is: NO.
428 EXTRACT_PRIVATE = YES
430 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
431 # scope will be included in the documentation.
432 # The default value is: NO.
434 EXTRACT_PACKAGE = YES
436 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
437 # included in the documentation.
438 # The default value is: NO.
442 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
443 # locally in source files will be included in the documentation. If set to NO,
444 # only classes defined in header files are included. Does not have any effect
446 # The default value is: YES.
448 EXTRACT_LOCAL_CLASSES = YES
450 # This flag is only useful for Objective-C code. If set to YES, local methods,
451 # which are defined in the implementation section but not in the interface are
452 # included in the documentation. If set to NO, only methods in the interface are
454 # The default value is: NO.
456 EXTRACT_LOCAL_METHODS = YES
458 # If this flag is set to YES, the members of anonymous namespaces will be
459 # extracted and appear in the documentation as a namespace called
460 # 'anonymous_namespace{file}', where file will be replaced with the base name of
461 # the file that contains the anonymous namespace. By default anonymous namespace
463 # The default value is: NO.
465 EXTRACT_ANON_NSPACES = YES
467 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
468 # undocumented members inside documented classes or files. If set to NO these
469 # members will be included in the various overviews, but no documentation
470 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
471 # The default value is: NO.
473 HIDE_UNDOC_MEMBERS = NO
475 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
476 # undocumented classes that are normally visible in the class hierarchy. If set
477 # to NO, these classes will be included in the various overviews. This option
478 # has no effect if EXTRACT_ALL is enabled.
479 # The default value is: NO.
481 HIDE_UNDOC_CLASSES = NO
483 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
484 # (class|struct|union) declarations. If set to NO, these declarations will be
485 # included in the documentation.
486 # The default value is: NO.
488 HIDE_FRIEND_COMPOUNDS = NO
490 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
491 # documentation blocks found inside the body of a function. If set to NO, these
492 # blocks will be appended to the function's detailed documentation block.
493 # The default value is: NO.
495 HIDE_IN_BODY_DOCS = NO
497 # The INTERNAL_DOCS tag determines if documentation that is typed after a
498 # \internal command is included. If the tag is set to NO then the documentation
499 # will be excluded. Set it to YES to include the internal documentation.
500 # The default value is: NO.
504 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
505 # names in lower-case letters. If set to YES, upper-case letters are also
506 # allowed. This is useful if you have classes or files whose names only differ
507 # in case and if your file system supports case sensitive file names. Windows
508 # and Mac users are advised to set this option to NO.
509 # The default value is: system dependent.
511 CASE_SENSE_NAMES = NO
513 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
514 # their full class and namespace scopes in the documentation. If set to YES, the
515 # scope will be hidden.
516 # The default value is: NO.
518 HIDE_SCOPE_NAMES = YES
520 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
521 # append additional text to a page's title, such as Class Reference. If set to
522 # YES the compound reference will be hidden.
523 # The default value is: NO.
525 HIDE_COMPOUND_REFERENCE= NO
527 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
528 # the files that are included by a file in the documentation of that file.
529 # The default value is: YES.
531 SHOW_INCLUDE_FILES = YES
533 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
534 # grouped member an include statement to the documentation, telling the reader
535 # which file to include in order to use the member.
536 # The default value is: NO.
538 SHOW_GROUPED_MEMB_INC = NO
540 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
541 # files with double quotes in the documentation rather than with sharp brackets.
542 # The default value is: NO.
544 FORCE_LOCAL_INCLUDES = NO
546 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
547 # documentation for inline members.
548 # The default value is: YES.
552 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
553 # (detailed) documentation of file and class members alphabetically by member
554 # name. If set to NO, the members will appear in declaration order.
555 # The default value is: YES.
557 SORT_MEMBER_DOCS = YES
559 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
560 # descriptions of file, namespace and class members alphabetically by member
561 # name. If set to NO, the members will appear in declaration order. Note that
562 # this will also influence the order of the classes in the class list.
563 # The default value is: NO.
567 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
568 # (brief and detailed) documentation of class members so that constructors and
569 # destructors are listed first. If set to NO the constructors will appear in the
570 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
571 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
572 # member documentation.
573 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
574 # detailed member documentation.
575 # The default value is: NO.
577 SORT_MEMBERS_CTORS_1ST = NO
579 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
580 # of group names into alphabetical order. If set to NO the group names will
581 # appear in their defined order.
582 # The default value is: NO.
584 SORT_GROUP_NAMES = NO
586 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
587 # fully-qualified names, including namespaces. If set to NO, the class list will
588 # be sorted only by class name, not including the namespace part.
589 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
590 # Note: This option applies only to the class list, not to the alphabetical
592 # The default value is: NO.
594 SORT_BY_SCOPE_NAME = NO
596 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
597 # type resolution of all parameters of a function it will reject a match between
598 # the prototype and the implementation of a member function even if there is
599 # only one candidate or it is obvious which candidate to choose by doing a
600 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
601 # accept a match between prototype and implementation in such cases.
602 # The default value is: NO.
604 STRICT_PROTO_MATCHING = NO
606 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
607 # list. This list is created by putting \todo commands in the documentation.
608 # The default value is: YES.
610 GENERATE_TODOLIST = YES
612 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
613 # list. This list is created by putting \test commands in the documentation.
614 # The default value is: YES.
616 GENERATE_TESTLIST = YES
618 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
619 # list. This list is created by putting \bug commands in the documentation.
620 # The default value is: YES.
622 GENERATE_BUGLIST = YES
624 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
625 # the deprecated list. This list is created by putting \deprecated commands in
627 # The default value is: YES.
629 GENERATE_DEPRECATEDLIST= YES
631 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
632 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
633 # ... \endcond blocks.
637 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
638 # initial value of a variable or macro / define can have for it to appear in the
639 # documentation. If the initializer consists of more lines than specified here
640 # it will be hidden. Use a value of 0 to hide initializers completely. The
641 # appearance of the value of individual variables and macros / defines can be
642 # controlled using \showinitializer or \hideinitializer command in the
643 # documentation regardless of this setting.
644 # Minimum value: 0, maximum value: 10000, default value: 30.
646 MAX_INITIALIZER_LINES = 30
648 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
649 # the bottom of the documentation of classes and structs. If set to YES, the
650 # list will mention the files that were used to generate the documentation.
651 # The default value is: YES.
653 SHOW_USED_FILES = YES
655 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
656 # will remove the Files entry from the Quick Index and from the Folder Tree View
658 # The default value is: YES.
662 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
663 # page. This will remove the Namespaces entry from the Quick Index and from the
664 # Folder Tree View (if specified).
665 # The default value is: YES.
669 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
670 # doxygen should invoke to get the current version for each file (typically from
671 # the version control system). Doxygen will invoke the program by executing (via
672 # popen()) the command command input-file, where command is the value of the
673 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
674 # by doxygen. Whatever the program writes to standard output is used as the file
675 # version. For an example see the documentation.
677 FILE_VERSION_FILTER =
679 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
680 # by doxygen. The layout file controls the global structure of the generated
681 # output files in an output format independent way. To create the layout file
682 # that represents doxygen's defaults, run doxygen with the -l option. You can
683 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
684 # will be used as the name of the layout file.
686 # Note that if you run doxygen from a directory containing a file called
687 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
692 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
693 # the reference definitions. This must be a list of .bib files. The .bib
694 # extension is automatically appended if omitted. This requires the bibtex tool
695 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
696 # For LaTeX the style of the bibliography can be controlled using
697 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
698 # search path. See also \cite for info how to create references.
702 #---------------------------------------------------------------------------
703 # Configuration options related to warning and progress messages
704 #---------------------------------------------------------------------------
706 # The QUIET tag can be used to turn on/off the messages that are generated to
707 # standard output by doxygen. If QUIET is set to YES this implies that the
709 # The default value is: NO.
713 # The WARNINGS tag can be used to turn on/off the warning messages that are
714 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
715 # this implies that the warnings are on.
717 # Tip: Turn warnings on while writing the documentation.
718 # The default value is: YES.
722 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
723 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
724 # will automatically be disabled.
725 # The default value is: YES.
727 WARN_IF_UNDOCUMENTED = YES
729 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
730 # potential errors in the documentation, such as not documenting some parameters
731 # in a documented function, or documenting parameters that don't exist or using
732 # markup commands wrongly.
733 # The default value is: YES.
735 WARN_IF_DOC_ERROR = YES
737 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
738 # are documented, but have no documentation for their parameters or return
739 # value. If set to NO, doxygen will only warn about wrong or incomplete
740 # parameter documentation, but not about the absence of documentation.
741 # The default value is: NO.
743 WARN_NO_PARAMDOC = NO
745 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
746 # can produce. The string should contain the $file, $line, and $text tags, which
747 # will be replaced by the file and line number from which the warning originated
748 # and the warning text. Optionally the format may contain $version, which will
749 # be replaced by the version of the file (if it could be obtained via
750 # FILE_VERSION_FILTER)
751 # The default value is: $file:$line: $text.
753 WARN_FORMAT = "$file:$line: $text"
755 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
756 # messages should be written. If left blank the output is written to standard
761 #---------------------------------------------------------------------------
762 # Configuration options related to the input files
763 #---------------------------------------------------------------------------
765 # The INPUT tag is used to specify the files and/or directories that contain
766 # documented source files. You may enter file names like myfile.cpp or
767 # directories like /usr/src/myproject. Separate the files or directories with
769 # Note: If this tag is empty the current directory is searched.
773 # This tag can be used to specify the character encoding of the source files
774 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
775 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
776 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
777 # possible encodings.
778 # The default value is: UTF-8.
780 INPUT_ENCODING = UTF-8
782 # If the value of the INPUT tag contains directories, you can use the
783 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
784 # *.h) to filter out the source-files in the directories. If left blank the
785 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
786 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
787 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
788 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
789 # *.qsf, *.as and *.js.
791 FILE_PATTERNS = *.php
793 # The RECURSIVE tag can be used to specify whether or not subdirectories should
794 # be searched for input files as well.
795 # The default value is: NO.
799 # The EXCLUDE tag can be used to specify files and/or directories that should be
800 # excluded from the INPUT source files. This way you can easily exclude a
801 # subdirectory from a directory tree whose root is specified with the INPUT tag.
803 # Note that relative paths are relative to the directory from which doxygen is
812 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
813 # directories that are symbolic links (a Unix file system feature) are excluded
815 # The default value is: NO.
817 EXCLUDE_SYMLINKS = YES
819 # If the value of the INPUT tag contains directories, you can use the
820 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
821 # certain files from those directories.
823 # Note that the wildcards are matched against the file with absolute path, so to
824 # exclude all test directories for example use the pattern */test/*
828 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
829 # (namespaces, classes, functions, etc.) that should be excluded from the
830 # output. The symbol name can be a fully qualified name, a word, or if the
831 # wildcard * is used, a substring. Examples: ANamespace, AClass,
832 # AClass::ANamespace, ANamespace::*Test
834 # Note that the wildcards are matched against the file with absolute path, so to
835 # exclude all test directories use the pattern */test/*
839 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
840 # that contain example code fragments that are included (see the \include
845 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
846 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
847 # *.h) to filter out the source-files in the directories. If left blank all
848 # files are included.
852 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
853 # searched for input files to be used with the \include or \dontinclude commands
854 # irrespective of the value of the RECURSIVE tag.
855 # The default value is: NO.
857 EXAMPLE_RECURSIVE = NO
859 # The IMAGE_PATH tag can be used to specify one or more files or directories
860 # that contain images that are to be included in the documentation (see the
865 # The INPUT_FILTER tag can be used to specify a program that doxygen should
866 # invoke to filter for each input file. Doxygen will invoke the filter program
867 # by executing (via popen()) the command:
869 # <filter> <input-file>
871 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
872 # name of an input file. Doxygen will then use the output that the filter
873 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
876 # Note that the filter must not add or remove lines; it is applied before the
877 # code is scanned, but not when the output code is generated. If lines are added
878 # or removed, the anchors will not be placed correctly.
882 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
883 # basis. Doxygen will compare the file name with each pattern and apply the
884 # filter if there is a match. The filters are a list of the form: pattern=filter
885 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
886 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
887 # patterns match the file name, INPUT_FILTER is applied.
891 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
892 # INPUT_FILTER) will also be used to filter the input files that are used for
893 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
894 # The default value is: NO.
896 FILTER_SOURCE_FILES = NO
898 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
899 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
900 # it is also possible to disable source filtering for a specific pattern using
901 # *.ext= (so without naming a filter).
902 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
904 FILTER_SOURCE_PATTERNS =
906 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
907 # is part of the input, its contents will be placed on the main page
908 # (index.html). This can be useful if you have a project on for instance GitHub
909 # and want to reuse the introduction page also for the doxygen output.
911 USE_MDFILE_AS_MAINPAGE =
913 #---------------------------------------------------------------------------
914 # Configuration options related to source browsing
915 #---------------------------------------------------------------------------
917 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
918 # generated. Documented entities will be cross-referenced with these sources.
920 # Note: To get rid of all source code in the generated output, make sure that
921 # also VERBATIM_HEADERS is set to NO.
922 # The default value is: NO.
926 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
927 # classes and enums directly into the documentation.
928 # The default value is: NO.
932 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
933 # special comment blocks from generated source code fragments. Normal C, C++ and
934 # Fortran comments will always remain visible.
935 # The default value is: YES.
937 STRIP_CODE_COMMENTS = YES
939 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
940 # function all documented functions referencing it will be listed.
941 # The default value is: NO.
943 REFERENCED_BY_RELATION = NO
945 # If the REFERENCES_RELATION tag is set to YES then for each documented function
946 # all documented entities called/used by that function will be listed.
947 # The default value is: NO.
949 REFERENCES_RELATION = NO
951 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
952 # to YES then the hyperlinks from functions in REFERENCES_RELATION and
953 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
954 # link to the documentation.
955 # The default value is: YES.
957 REFERENCES_LINK_SOURCE = YES
959 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
960 # source code will show a tooltip with additional information such as prototype,
961 # brief description and links to the definition and documentation. Since this
962 # will make the HTML file larger and loading of large files a bit slower, you
963 # can opt to disable this feature.
964 # The default value is: YES.
965 # This tag requires that the tag SOURCE_BROWSER is set to YES.
967 SOURCE_TOOLTIPS = YES
969 # If the USE_HTAGS tag is set to YES then the references to source code will
970 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
971 # source browser. The htags tool is part of GNU's global source tagging system
972 # (see http://www.gnu.org/software/global/global.html). You will need version
975 # To use it do the following:
976 # - Install the latest version of global
977 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
978 # - Make sure the INPUT points to the root of the source tree
979 # - Run doxygen as normal
981 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
982 # tools must be available from the command line (i.e. in the search path).
984 # The result: instead of the source browser generated by doxygen, the links to
985 # source code will now point to the output of htags.
986 # The default value is: NO.
987 # This tag requires that the tag SOURCE_BROWSER is set to YES.
991 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
992 # verbatim copy of the header file for each class for which an include is
993 # specified. Set to NO to disable this.
994 # See also: Section \class.
995 # The default value is: YES.
997 VERBATIM_HEADERS = YES
999 #---------------------------------------------------------------------------
1000 # Configuration options related to the alphabetical class index
1001 #---------------------------------------------------------------------------
1003 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1004 # compounds will be generated. Enable this if the project contains a lot of
1005 # classes, structs, unions or interfaces.
1006 # The default value is: YES.
1008 ALPHABETICAL_INDEX = YES
1010 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1011 # which the alphabetical index list will be split.
1012 # Minimum value: 1, maximum value: 20, default value: 5.
1013 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1015 COLS_IN_ALPHA_INDEX = 5
1017 # In case all classes in a project start with a common prefix, all classes will
1018 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1019 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1020 # while generating the index headers.
1021 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1025 #---------------------------------------------------------------------------
1026 # Configuration options related to the HTML output
1027 #---------------------------------------------------------------------------
1029 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1030 # The default value is: YES.
1034 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1035 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1037 # The default directory is: html.
1038 # This tag requires that the tag GENERATE_HTML is set to YES.
1040 HTML_OUTPUT = doxygen
1042 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1043 # generated HTML page (for example: .htm, .php, .asp).
1044 # The default value is: .html.
1045 # This tag requires that the tag GENERATE_HTML is set to YES.
1047 HTML_FILE_EXTENSION = .html
1049 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1050 # each generated HTML page. If the tag is left blank doxygen will generate a
1053 # To get valid HTML the header file that includes any scripts and style sheets
1054 # that doxygen needs, which is dependent on the configuration options used (e.g.
1055 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1056 # default header using
1057 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1059 # and then modify the file new_header.html. See also section "Doxygen usage"
1060 # for information on how to generate the default header that doxygen normally
1062 # Note: The header is subject to change so you typically have to regenerate the
1063 # default header when upgrading to a newer version of doxygen. For a description
1064 # of the possible markers and block names see the documentation.
1065 # This tag requires that the tag GENERATE_HTML is set to YES.
1069 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1070 # generated HTML page. If the tag is left blank doxygen will generate a standard
1071 # footer. See HTML_HEADER for more information on how to generate a default
1072 # footer and what special commands can be used inside the footer. See also
1073 # section "Doxygen usage" for information on how to generate the default footer
1074 # that doxygen normally uses.
1075 # This tag requires that the tag GENERATE_HTML is set to YES.
1079 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1080 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1081 # the HTML output. If left blank doxygen will generate a default style sheet.
1082 # See also section "Doxygen usage" for information on how to generate the style
1083 # sheet that doxygen normally uses.
1084 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1085 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1087 # This tag requires that the tag GENERATE_HTML is set to YES.
1091 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1092 # cascading style sheets that are included after the standard style sheets
1093 # created by doxygen. Using this option one can overrule certain style aspects.
1094 # This is preferred over using HTML_STYLESHEET since it does not replace the
1095 # standard style sheet and is therefore more robust against future updates.
1096 # Doxygen will copy the style sheet files to the output directory.
1097 # Note: The order of the extra style sheet files is of importance (e.g. the last
1098 # style sheet in the list overrules the setting of the previous ones in the
1099 # list). For an example see the documentation.
1100 # This tag requires that the tag GENERATE_HTML is set to YES.
1102 HTML_EXTRA_STYLESHEET =
1104 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1105 # other source files which should be copied to the HTML output directory. Note
1106 # that these files will be copied to the base HTML output directory. Use the
1107 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1108 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1109 # files will be copied as-is; there are no commands or markers available.
1110 # This tag requires that the tag GENERATE_HTML is set to YES.
1114 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1115 # will adjust the colors in the style sheet and background images according to
1116 # this color. Hue is specified as an angle on a colorwheel, see
1117 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1118 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1119 # purple, and 360 is red again.
1120 # Minimum value: 0, maximum value: 359, default value: 220.
1121 # This tag requires that the tag GENERATE_HTML is set to YES.
1123 HTML_COLORSTYLE_HUE = 220
1125 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1126 # in the HTML output. For a value of 0 the output will use grayscales only. A
1127 # value of 255 will produce the most vivid colors.
1128 # Minimum value: 0, maximum value: 255, default value: 100.
1129 # This tag requires that the tag GENERATE_HTML is set to YES.
1131 HTML_COLORSTYLE_SAT = 100
1133 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1134 # luminance component of the colors in the HTML output. Values below 100
1135 # gradually make the output lighter, whereas values above 100 make the output
1136 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1137 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1139 # Minimum value: 40, maximum value: 240, default value: 80.
1140 # This tag requires that the tag GENERATE_HTML is set to YES.
1142 HTML_COLORSTYLE_GAMMA = 80
1144 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1145 # page will contain the date and time when the page was generated. Setting this
1146 # to NO can help when comparing the output of multiple runs.
1147 # The default value is: YES.
1148 # This tag requires that the tag GENERATE_HTML is set to YES.
1150 HTML_TIMESTAMP = YES
1152 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1153 # documentation will contain sections that can be hidden and shown after the
1155 # The default value is: NO.
1156 # This tag requires that the tag GENERATE_HTML is set to YES.
1158 HTML_DYNAMIC_SECTIONS = NO
1160 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1161 # shown in the various tree structured indices initially; the user can expand
1162 # and collapse entries dynamically later on. Doxygen will expand the tree to
1163 # such a level that at most the specified number of entries are visible (unless
1164 # a fully collapsed tree already exceeds this amount). So setting the number of
1165 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1166 # representing an infinite number of entries and will result in a full expanded
1168 # Minimum value: 0, maximum value: 9999, default value: 100.
1169 # This tag requires that the tag GENERATE_HTML is set to YES.
1171 HTML_INDEX_NUM_ENTRIES = 100
1173 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1174 # generated that can be used as input for Apple's Xcode 3 integrated development
1175 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1176 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1177 # Makefile in the HTML output directory. Running make will produce the docset in
1178 # that directory and running make install will install the docset in
1179 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1180 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1181 # for more information.
1182 # The default value is: NO.
1183 # This tag requires that the tag GENERATE_HTML is set to YES.
1185 GENERATE_DOCSET = NO
1187 # This tag determines the name of the docset feed. A documentation feed provides
1188 # an umbrella under which multiple documentation sets from a single provider
1189 # (such as a company or product suite) can be grouped.
1190 # The default value is: Doxygen generated docs.
1191 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1193 DOCSET_FEEDNAME = "Doxygen generated docs"
1195 # This tag specifies a string that should uniquely identify the documentation
1196 # set bundle. This should be a reverse domain-name style string, e.g.
1197 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1198 # The default value is: org.doxygen.Project.
1199 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1201 DOCSET_BUNDLE_ID = org.doxygen.Project
1203 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1204 # the documentation publisher. This should be a reverse domain-name style
1205 # string, e.g. com.mycompany.MyDocSet.documentation.
1206 # The default value is: org.doxygen.Publisher.
1207 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1209 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1211 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1212 # The default value is: Publisher.
1213 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1215 DOCSET_PUBLISHER_NAME = Publisher
1217 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1218 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1219 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1220 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1223 # The HTML Help Workshop contains a compiler that can convert all HTML output
1224 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1225 # files are now used as the Windows 98 help format, and will replace the old
1226 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1227 # HTML files also contain an index, a table of contents, and you can search for
1228 # words in the documentation. The HTML workshop also contains a viewer for
1229 # compressed HTML files.
1230 # The default value is: NO.
1231 # This tag requires that the tag GENERATE_HTML is set to YES.
1233 GENERATE_HTMLHELP = NO
1235 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1236 # file. You can add a path in front of the file if the result should not be
1237 # written to the html output directory.
1238 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1242 # The HHC_LOCATION tag can be used to specify the location (absolute path
1243 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1244 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1245 # The file has to be specified with full path.
1246 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1250 # The GENERATE_CHI flag controls if a separate .chi index file is generated
1251 # (YES) or that it should be included in the master .chm file (NO).
1252 # The default value is: NO.
1253 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1257 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1258 # and project file content.
1259 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1261 CHM_INDEX_ENCODING =
1263 # The BINARY_TOC flag controls whether a binary table of contents is generated
1264 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1265 # enables the Previous and Next buttons.
1266 # The default value is: NO.
1267 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1271 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1272 # the table of contents of the HTML help documentation and to the tree view.
1273 # The default value is: NO.
1274 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1278 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1279 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1280 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1281 # (.qch) of the generated HTML documentation.
1282 # The default value is: NO.
1283 # This tag requires that the tag GENERATE_HTML is set to YES.
1287 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1288 # the file name of the resulting .qch file. The path specified is relative to
1289 # the HTML output folder.
1290 # This tag requires that the tag GENERATE_QHP is set to YES.
1294 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1295 # Project output. For more information please see Qt Help Project / Namespace
1296 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1297 # The default value is: org.doxygen.Project.
1298 # This tag requires that the tag GENERATE_QHP is set to YES.
1300 QHP_NAMESPACE = org.doxygen.Project
1302 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1303 # Help Project output. For more information please see Qt Help Project / Virtual
1304 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1306 # The default value is: doc.
1307 # This tag requires that the tag GENERATE_QHP is set to YES.
1309 QHP_VIRTUAL_FOLDER = doc
1311 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1312 # filter to add. For more information please see Qt Help Project / Custom
1313 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1315 # This tag requires that the tag GENERATE_QHP is set to YES.
1317 QHP_CUST_FILTER_NAME =
1319 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1320 # custom filter to add. For more information please see Qt Help Project / Custom
1321 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1323 # This tag requires that the tag GENERATE_QHP is set to YES.
1325 QHP_CUST_FILTER_ATTRS =
1327 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1328 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1329 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1330 # This tag requires that the tag GENERATE_QHP is set to YES.
1332 QHP_SECT_FILTER_ATTRS =
1334 # The QHG_LOCATION tag can be used to specify the location of Qt's
1335 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1336 # generated .qhp file.
1337 # This tag requires that the tag GENERATE_QHP is set to YES.
1341 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1342 # generated, together with the HTML files, they form an Eclipse help plugin. To
1343 # install this plugin and make it available under the help contents menu in
1344 # Eclipse, the contents of the directory containing the HTML and XML files needs
1345 # to be copied into the plugins directory of eclipse. The name of the directory
1346 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1347 # After copying Eclipse needs to be restarted before the help appears.
1348 # The default value is: NO.
1349 # This tag requires that the tag GENERATE_HTML is set to YES.
1351 GENERATE_ECLIPSEHELP = NO
1353 # A unique identifier for the Eclipse help plugin. When installing the plugin
1354 # the directory name containing the HTML and XML files should also have this
1355 # name. Each documentation set should have its own identifier.
1356 # The default value is: org.doxygen.Project.
1357 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1359 ECLIPSE_DOC_ID = org.doxygen.Project
1361 # If you want full control over the layout of the generated HTML pages it might
1362 # be necessary to disable the index and replace it with your own. The
1363 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1364 # of each HTML page. A value of NO enables the index and the value YES disables
1365 # it. Since the tabs in the index contain the same information as the navigation
1366 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1367 # The default value is: NO.
1368 # This tag requires that the tag GENERATE_HTML is set to YES.
1372 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1373 # structure should be generated to display hierarchical information. If the tag
1374 # value is set to YES, a side panel will be generated containing a tree-like
1375 # index structure (just like the one that is generated for HTML Help). For this
1376 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1377 # (i.e. any modern browser). Windows users are probably better off using the
1378 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1379 # further fine-tune the look of the index. As an example, the default style
1380 # sheet generated by doxygen has an example that shows how to put an image at
1381 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1382 # the same information as the tab index, you could consider setting
1383 # DISABLE_INDEX to YES when enabling this option.
1384 # The default value is: NO.
1385 # This tag requires that the tag GENERATE_HTML is set to YES.
1387 GENERATE_TREEVIEW = YES
1389 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1390 # doxygen will group on one line in the generated HTML documentation.
1392 # Note that a value of 0 will completely suppress the enum values from appearing
1393 # in the overview section.
1394 # Minimum value: 0, maximum value: 20, default value: 4.
1395 # This tag requires that the tag GENERATE_HTML is set to YES.
1397 ENUM_VALUES_PER_LINE = 4
1399 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1400 # to set the initial width (in pixels) of the frame in which the tree is shown.
1401 # Minimum value: 0, maximum value: 1500, default value: 250.
1402 # This tag requires that the tag GENERATE_HTML is set to YES.
1404 TREEVIEW_WIDTH = 250
1406 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1407 # external symbols imported via tag files in a separate window.
1408 # The default value is: NO.
1409 # This tag requires that the tag GENERATE_HTML is set to YES.
1411 EXT_LINKS_IN_WINDOW = NO
1413 # Use this tag to change the font size of LaTeX formulas included as images in
1414 # the HTML documentation. When you change the font size after a successful
1415 # doxygen run you need to manually remove any form_*.png images from the HTML
1416 # output directory to force them to be regenerated.
1417 # Minimum value: 8, maximum value: 50, default value: 10.
1418 # This tag requires that the tag GENERATE_HTML is set to YES.
1420 FORMULA_FONTSIZE = 10
1422 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1423 # generated for formulas are transparent PNGs. Transparent PNGs are not
1424 # supported properly for IE 6.0, but are supported on all modern browsers.
1426 # Note that when changing this option you need to delete any form_*.png files in
1427 # the HTML output directory before the changes have effect.
1428 # The default value is: YES.
1429 # This tag requires that the tag GENERATE_HTML is set to YES.
1431 FORMULA_TRANSPARENT = YES
1433 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1434 # http://www.mathjax.org) which uses client side Javascript for the rendering
1435 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1436 # installed or if you want to formulas look prettier in the HTML output. When
1437 # enabled you may also need to install MathJax separately and configure the path
1438 # to it using the MATHJAX_RELPATH option.
1439 # The default value is: NO.
1440 # This tag requires that the tag GENERATE_HTML is set to YES.
1444 # When MathJax is enabled you can set the default output format to be used for
1445 # the MathJax output. See the MathJax site (see:
1446 # http://docs.mathjax.org/en/latest/output.html) for more details.
1447 # Possible values are: HTML-CSS (which is slower, but has the best
1448 # compatibility), NativeMML (i.e. MathML) and SVG.
1449 # The default value is: HTML-CSS.
1450 # This tag requires that the tag USE_MATHJAX is set to YES.
1452 MATHJAX_FORMAT = HTML-CSS
1454 # When MathJax is enabled you need to specify the location relative to the HTML
1455 # output directory using the MATHJAX_RELPATH option. The destination directory
1456 # should contain the MathJax.js script. For instance, if the mathjax directory
1457 # is located at the same level as the HTML output directory, then
1458 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1459 # Content Delivery Network so you can quickly see the result without installing
1460 # MathJax. However, it is strongly recommended to install a local copy of
1461 # MathJax from http://www.mathjax.org before deployment.
1462 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1463 # This tag requires that the tag USE_MATHJAX is set to YES.
1465 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1467 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1468 # extension names that should be enabled during MathJax rendering. For example
1469 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1470 # This tag requires that the tag USE_MATHJAX is set to YES.
1472 MATHJAX_EXTENSIONS =
1474 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1475 # of code that will be used on startup of the MathJax code. See the MathJax site
1476 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1477 # example see the documentation.
1478 # This tag requires that the tag USE_MATHJAX is set to YES.
1482 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1483 # the HTML output. The underlying search engine uses javascript and DHTML and
1484 # should work on any modern browser. Note that when using HTML help
1485 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1486 # there is already a search function so this one should typically be disabled.
1487 # For large projects the javascript based search engine can be slow, then
1488 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1489 # search using the keyboard; to jump to the search box use <access key> + S
1490 # (what the <access key> is depends on the OS and browser, but it is typically
1491 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1492 # key> to jump into the search results window, the results can be navigated
1493 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1494 # the search. The filter options can be selected when the cursor is inside the
1495 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1496 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1498 # The default value is: YES.
1499 # This tag requires that the tag GENERATE_HTML is set to YES.
1503 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1504 # implemented using a web server instead of a web client using Javascript. There
1505 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1506 # setting. When disabled, doxygen will generate a PHP script for searching and
1507 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1508 # and searching needs to be provided by external tools. See the section
1509 # "External Indexing and Searching" for details.
1510 # The default value is: NO.
1511 # This tag requires that the tag SEARCHENGINE is set to YES.
1513 SERVER_BASED_SEARCH = NO
1515 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1516 # script for searching. Instead the search results are written to an XML file
1517 # which needs to be processed by an external indexer. Doxygen will invoke an
1518 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1521 # Doxygen ships with an example indexer (doxyindexer) and search engine
1522 # (doxysearch.cgi) which are based on the open source search engine library
1523 # Xapian (see: http://xapian.org/).
1525 # See the section "External Indexing and Searching" for details.
1526 # The default value is: NO.
1527 # This tag requires that the tag SEARCHENGINE is set to YES.
1529 EXTERNAL_SEARCH = NO
1531 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1532 # which will return the search results when EXTERNAL_SEARCH is enabled.
1534 # Doxygen ships with an example indexer (doxyindexer) and search engine
1535 # (doxysearch.cgi) which are based on the open source search engine library
1536 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1537 # Searching" for details.
1538 # This tag requires that the tag SEARCHENGINE is set to YES.
1542 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1543 # search data is written to a file for indexing by an external tool. With the
1544 # SEARCHDATA_FILE tag the name of this file can be specified.
1545 # The default file is: searchdata.xml.
1546 # This tag requires that the tag SEARCHENGINE is set to YES.
1548 SEARCHDATA_FILE = searchdata.xml
1550 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1551 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1552 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1553 # projects and redirect the results back to the right project.
1554 # This tag requires that the tag SEARCHENGINE is set to YES.
1556 EXTERNAL_SEARCH_ID =
1558 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1559 # projects other than the one defined by this configuration file, but that are
1560 # all added to the same external search index. Each project needs to have a
1561 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1562 # to a relative location where the documentation can be found. The format is:
1563 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1564 # This tag requires that the tag SEARCHENGINE is set to YES.
1566 EXTRA_SEARCH_MAPPINGS =
1568 #---------------------------------------------------------------------------
1569 # Configuration options related to the LaTeX output
1570 #---------------------------------------------------------------------------
1572 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1573 # The default value is: YES.
1577 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1578 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1580 # The default directory is: latex.
1581 # This tag requires that the tag GENERATE_LATEX is set to YES.
1583 LATEX_OUTPUT = latex
1585 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1588 # Note that when enabling USE_PDFLATEX this option is only used for generating
1589 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1590 # written to the output directory.
1591 # The default file is: latex.
1592 # This tag requires that the tag GENERATE_LATEX is set to YES.
1594 LATEX_CMD_NAME = latex
1596 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1598 # The default file is: makeindex.
1599 # This tag requires that the tag GENERATE_LATEX is set to YES.
1601 MAKEINDEX_CMD_NAME = makeindex
1603 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1604 # documents. This may be useful for small projects and may help to save some
1606 # The default value is: NO.
1607 # This tag requires that the tag GENERATE_LATEX is set to YES.
1611 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1613 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1614 # 14 inches) and executive (7.25 x 10.5 inches).
1615 # The default value is: a4.
1616 # This tag requires that the tag GENERATE_LATEX is set to YES.
1620 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1621 # that should be included in the LaTeX output. To get the times font for
1622 # instance you can specify
1623 # EXTRA_PACKAGES=times
1624 # If left blank no extra packages will be included.
1625 # This tag requires that the tag GENERATE_LATEX is set to YES.
1629 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1630 # generated LaTeX document. The header should contain everything until the first
1631 # chapter. If it is left blank doxygen will generate a standard header. See
1632 # section "Doxygen usage" for information on how to let doxygen write the
1633 # default header to a separate file.
1635 # Note: Only use a user-defined header if you know what you are doing! The
1636 # following commands have a special meaning inside the header: $title,
1637 # $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1638 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1639 # string, for the replacement values of the other commands the user is referred
1641 # This tag requires that the tag GENERATE_LATEX is set to YES.
1645 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1646 # generated LaTeX document. The footer should contain everything after the last
1647 # chapter. If it is left blank doxygen will generate a standard footer. See
1648 # LATEX_HEADER for more information on how to generate a default footer and what
1649 # special commands can be used inside the footer.
1651 # Note: Only use a user-defined footer if you know what you are doing!
1652 # This tag requires that the tag GENERATE_LATEX is set to YES.
1656 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1657 # LaTeX style sheets that are included after the standard style sheets created
1658 # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1659 # will copy the style sheet files to the output directory.
1660 # Note: The order of the extra style sheet files is of importance (e.g. the last
1661 # style sheet in the list overrules the setting of the previous ones in the
1663 # This tag requires that the tag GENERATE_LATEX is set to YES.
1665 LATEX_EXTRA_STYLESHEET =
1667 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1668 # other source files which should be copied to the LATEX_OUTPUT output
1669 # directory. Note that the files will be copied as-is; there are no commands or
1670 # markers available.
1671 # This tag requires that the tag GENERATE_LATEX is set to YES.
1675 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1676 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1677 # contain links (just like the HTML output) instead of page references. This
1678 # makes the output suitable for online browsing using a PDF viewer.
1679 # The default value is: YES.
1680 # This tag requires that the tag GENERATE_LATEX is set to YES.
1682 PDF_HYPERLINKS = YES
1684 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1685 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1686 # higher quality PDF documentation.
1687 # The default value is: YES.
1688 # This tag requires that the tag GENERATE_LATEX is set to YES.
1692 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1693 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1694 # if errors occur, instead of asking the user for help. This option is also used
1695 # when generating formulas in HTML.
1696 # The default value is: NO.
1697 # This tag requires that the tag GENERATE_LATEX is set to YES.
1699 LATEX_BATCHMODE = NO
1701 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1702 # index chapters (such as File Index, Compound Index, etc.) in the output.
1703 # The default value is: NO.
1704 # This tag requires that the tag GENERATE_LATEX is set to YES.
1706 LATEX_HIDE_INDICES = NO
1708 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1709 # code with syntax highlighting in the LaTeX output.
1711 # Note that which sources are shown also depends on other settings such as
1713 # The default value is: NO.
1714 # This tag requires that the tag GENERATE_LATEX is set to YES.
1716 LATEX_SOURCE_CODE = NO
1718 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1719 # bibliography, e.g. plainnat, or ieeetr. See
1720 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1721 # The default value is: plain.
1722 # This tag requires that the tag GENERATE_LATEX is set to YES.
1724 LATEX_BIB_STYLE = plain
1726 #---------------------------------------------------------------------------
1727 # Configuration options related to the RTF output
1728 #---------------------------------------------------------------------------
1730 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1731 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1733 # The default value is: NO.
1737 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1738 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1740 # The default directory is: rtf.
1741 # This tag requires that the tag GENERATE_RTF is set to YES.
1745 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1746 # documents. This may be useful for small projects and may help to save some
1748 # The default value is: NO.
1749 # This tag requires that the tag GENERATE_RTF is set to YES.
1753 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1754 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1755 # output) instead of page references. This makes the output suitable for online
1756 # browsing using Word or some other Word compatible readers that support those
1759 # Note: WordPad (write) and others do not support links.
1760 # The default value is: NO.
1761 # This tag requires that the tag GENERATE_RTF is set to YES.
1765 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1766 # file, i.e. a series of assignments. You only have to provide replacements,
1767 # missing definitions are set to their default value.
1769 # See also section "Doxygen usage" for information on how to generate the
1770 # default style sheet that doxygen normally uses.
1771 # This tag requires that the tag GENERATE_RTF is set to YES.
1773 RTF_STYLESHEET_FILE =
1775 # Set optional variables used in the generation of an RTF document. Syntax is
1776 # similar to doxygen's config file. A template extensions file can be generated
1777 # using doxygen -e rtf extensionFile.
1778 # This tag requires that the tag GENERATE_RTF is set to YES.
1780 RTF_EXTENSIONS_FILE =
1782 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1783 # with syntax highlighting in the RTF output.
1785 # Note that which sources are shown also depends on other settings such as
1787 # The default value is: NO.
1788 # This tag requires that the tag GENERATE_RTF is set to YES.
1790 RTF_SOURCE_CODE = NO
1792 #---------------------------------------------------------------------------
1793 # Configuration options related to the man page output
1794 #---------------------------------------------------------------------------
1796 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1797 # classes and files.
1798 # The default value is: NO.
1802 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1803 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1804 # it. A directory man3 will be created inside the directory specified by
1806 # The default directory is: man.
1807 # This tag requires that the tag GENERATE_MAN is set to YES.
1811 # The MAN_EXTENSION tag determines the extension that is added to the generated
1812 # man pages. In case the manual section does not start with a number, the number
1813 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1815 # The default value is: .3.
1816 # This tag requires that the tag GENERATE_MAN is set to YES.
1820 # The MAN_SUBDIR tag determines the name of the directory created within
1821 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1822 # MAN_EXTENSION with the initial . removed.
1823 # This tag requires that the tag GENERATE_MAN is set to YES.
1827 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1828 # will generate one additional man file for each entity documented in the real
1829 # man page(s). These additional files only source the real man page, but without
1830 # them the man command would be unable to find the correct page.
1831 # The default value is: NO.
1832 # This tag requires that the tag GENERATE_MAN is set to YES.
1836 #---------------------------------------------------------------------------
1837 # Configuration options related to the XML output
1838 #---------------------------------------------------------------------------
1840 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1841 # captures the structure of the code including all documentation.
1842 # The default value is: NO.
1846 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1847 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1849 # The default directory is: xml.
1850 # This tag requires that the tag GENERATE_XML is set to YES.
1854 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1855 # listings (including syntax highlighting and cross-referencing information) to
1856 # the XML output. Note that enabling this will significantly increase the size
1857 # of the XML output.
1858 # The default value is: YES.
1859 # This tag requires that the tag GENERATE_XML is set to YES.
1861 XML_PROGRAMLISTING = YES
1863 #---------------------------------------------------------------------------
1864 # Configuration options related to the DOCBOOK output
1865 #---------------------------------------------------------------------------
1867 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1868 # that can be used to generate PDF.
1869 # The default value is: NO.
1871 GENERATE_DOCBOOK = NO
1873 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1874 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1876 # The default directory is: docbook.
1877 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1879 DOCBOOK_OUTPUT = docbook
1881 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1882 # program listings (including syntax highlighting and cross-referencing
1883 # information) to the DOCBOOK output. Note that enabling this will significantly
1884 # increase the size of the DOCBOOK output.
1885 # The default value is: NO.
1886 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1888 DOCBOOK_PROGRAMLISTING = NO
1890 #---------------------------------------------------------------------------
1891 # Configuration options for the AutoGen Definitions output
1892 #---------------------------------------------------------------------------
1894 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1895 # AutoGen Definitions (see http://autogen.sf.net) file that captures the
1896 # structure of the code including all documentation. Note that this feature is
1897 # still experimental and incomplete at the moment.
1898 # The default value is: NO.
1900 GENERATE_AUTOGEN_DEF = NO
1902 #---------------------------------------------------------------------------
1903 # Configuration options related to the Perl module output
1904 #---------------------------------------------------------------------------
1906 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1907 # file that captures the structure of the code including all documentation.
1909 # Note that this feature is still experimental and incomplete at the moment.
1910 # The default value is: NO.
1912 GENERATE_PERLMOD = NO
1914 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1915 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1916 # output from the Perl module output.
1917 # The default value is: NO.
1918 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1922 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1923 # formatted so it can be parsed by a human reader. This is useful if you want to
1924 # understand what is going on. On the other hand, if this tag is set to NO, the
1925 # size of the Perl module output will be much smaller and Perl will parse it
1927 # The default value is: YES.
1928 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1930 PERLMOD_PRETTY = YES
1932 # The names of the make variables in the generated doxyrules.make file are
1933 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1934 # so different doxyrules.make files included by the same Makefile don't
1935 # overwrite each other's variables.
1936 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1938 PERLMOD_MAKEVAR_PREFIX =
1940 #---------------------------------------------------------------------------
1941 # Configuration options related to the preprocessor
1942 #---------------------------------------------------------------------------
1944 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1945 # C-preprocessor directives found in the sources and include files.
1946 # The default value is: YES.
1948 ENABLE_PREPROCESSING = YES
1950 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1951 # in the source code. If set to NO, only conditional compilation will be
1952 # performed. Macro expansion can be done in a controlled way by setting
1953 # EXPAND_ONLY_PREDEF to YES.
1954 # The default value is: NO.
1955 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1957 MACRO_EXPANSION = NO
1959 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1960 # the macro expansion is limited to the macros specified with the PREDEFINED and
1961 # EXPAND_AS_DEFINED tags.
1962 # The default value is: NO.
1963 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1965 EXPAND_ONLY_PREDEF = NO
1967 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
1968 # INCLUDE_PATH will be searched if a #include is found.
1969 # The default value is: YES.
1970 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1972 SEARCH_INCLUDES = YES
1974 # The INCLUDE_PATH tag can be used to specify one or more directories that
1975 # contain include files that are not input files but should be processed by the
1977 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1981 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1982 # patterns (like *.h and *.hpp) to filter out the header-files in the
1983 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1985 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1987 INCLUDE_FILE_PATTERNS =
1989 # The PREDEFINED tag can be used to specify one or more macro names that are
1990 # defined before the preprocessor is started (similar to the -D option of e.g.
1991 # gcc). The argument of the tag is a list of macros of the form: name or
1992 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
1993 # is assumed. To prevent a macro definition from being undefined via #undef or
1994 # recursively expanded use the := operator instead of the = operator.
1995 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1999 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2000 # tag can be used to specify a list of macro names that should be expanded. The
2001 # macro definition that is found in the sources will be used. Use the PREDEFINED
2002 # tag if you want to use a different macro definition that overrules the
2003 # definition found in the source code.
2004 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2008 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2009 # remove all references to function-like macros that are alone on a line, have
2010 # an all uppercase name, and do not end with a semicolon. Such function macros
2011 # are typically used for boiler-plate code, and will confuse the parser if not
2013 # The default value is: YES.
2014 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2016 SKIP_FUNCTION_MACROS = NO
2018 #---------------------------------------------------------------------------
2019 # Configuration options related to external references
2020 #---------------------------------------------------------------------------
2022 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2023 # file the location of the external documentation should be added. The format of
2024 # a tag file without this location is as follows:
2025 # TAGFILES = file1 file2 ...
2026 # Adding location for the tag files is done as follows:
2027 # TAGFILES = file1=loc1 "file2 = loc2" ...
2028 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2029 # section "Linking to external documentation" for more information about the use
2031 # Note: Each tag file must have a unique name (where the name does NOT include
2032 # the path). If a tag file is not located in the directory in which doxygen is
2033 # run, you must also specify the path to the tagfile here.
2037 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2038 # tag file that is based on the input files it reads. See section "Linking to
2039 # external documentation" for more information about the usage of tag files.
2043 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2044 # the class index. If set to NO, only the inherited external classes will be
2046 # The default value is: NO.
2050 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2051 # in the modules index. If set to NO, only the current project's groups will be
2053 # The default value is: YES.
2055 EXTERNAL_GROUPS = YES
2057 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2058 # the related pages index. If set to NO, only the current project's pages will
2060 # The default value is: YES.
2062 EXTERNAL_PAGES = YES
2064 # The PERL_PATH should be the absolute path and name of the perl script
2065 # interpreter (i.e. the result of 'which perl').
2066 # The default file (with absolute path) is: /usr/bin/perl.
2068 PERL_PATH = /usr/bin/perl
2070 #---------------------------------------------------------------------------
2071 # Configuration options related to the dot tool
2072 #---------------------------------------------------------------------------
2074 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2075 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2076 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2077 # disabled, but it is recommended to install and use dot, since it yields more
2079 # The default value is: YES.
2083 # You can define message sequence charts within doxygen comments using the \msc
2084 # command. Doxygen will then run the mscgen tool (see:
2085 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2086 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2087 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2088 # default search path.
2092 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2093 # then run dia to produce the diagram and insert it in the documentation. The
2094 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2095 # If left empty dia is assumed to be found in the default search path.
2099 # If set to YES the inheritance and collaboration graphs will hide inheritance
2100 # and usage relations if the target is undocumented or is not a class.
2101 # The default value is: YES.
2103 HIDE_UNDOC_RELATIONS = YES
2105 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2106 # available from the path. This tool is part of Graphviz (see:
2107 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2108 # Bell Labs. The other options in this section have no effect if this option is
2110 # The default value is: NO.
2114 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2115 # to run in parallel. When set to 0 doxygen will base this on the number of
2116 # processors available in the system. You can set it explicitly to a value
2117 # larger than 0 to get control over the balance between CPU load and processing
2119 # Minimum value: 0, maximum value: 32, default value: 0.
2120 # This tag requires that the tag HAVE_DOT is set to YES.
2124 # When you want a differently looking font in the dot files that doxygen
2125 # generates you can specify the font name using DOT_FONTNAME. You need to make
2126 # sure dot is able to find the font, which can be done by putting it in a
2127 # standard location or by setting the DOTFONTPATH environment variable or by
2128 # setting DOT_FONTPATH to the directory containing the font.
2129 # The default value is: Helvetica.
2130 # This tag requires that the tag HAVE_DOT is set to YES.
2132 DOT_FONTNAME = Helvetica
2134 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2136 # Minimum value: 4, maximum value: 24, default value: 10.
2137 # This tag requires that the tag HAVE_DOT is set to YES.
2141 # By default doxygen will tell dot to use the default font as specified with
2142 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2143 # the path where dot can find it using this tag.
2144 # This tag requires that the tag HAVE_DOT is set to YES.
2148 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2149 # each documented class showing the direct and indirect inheritance relations.
2150 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2151 # The default value is: YES.
2152 # This tag requires that the tag HAVE_DOT is set to YES.
2156 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2157 # graph for each documented class showing the direct and indirect implementation
2158 # dependencies (inheritance, containment, and class references variables) of the
2159 # class with other documented classes.
2160 # The default value is: YES.
2161 # This tag requires that the tag HAVE_DOT is set to YES.
2163 COLLABORATION_GRAPH = YES
2165 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2166 # groups, showing the direct groups dependencies.
2167 # The default value is: YES.
2168 # This tag requires that the tag HAVE_DOT is set to YES.
2172 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2173 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2175 # The default value is: NO.
2176 # This tag requires that the tag HAVE_DOT is set to YES.
2180 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2181 # class node. If there are many fields or methods and many nodes the graph may
2182 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2183 # number of items for each type to make the size more manageable. Set this to 0
2184 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2185 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2186 # but if the number exceeds 15, the total amount of fields shown is limited to
2188 # Minimum value: 0, maximum value: 100, default value: 10.
2189 # This tag requires that the tag HAVE_DOT is set to YES.
2191 UML_LIMIT_NUM_FIELDS = 10
2193 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2194 # collaboration graphs will show the relations between templates and their
2196 # The default value is: NO.
2197 # This tag requires that the tag HAVE_DOT is set to YES.
2199 TEMPLATE_RELATIONS = NO
2201 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2202 # YES then doxygen will generate a graph for each documented file showing the
2203 # direct and indirect include dependencies of the file with other documented
2205 # The default value is: YES.
2206 # This tag requires that the tag HAVE_DOT is set to YES.
2210 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2211 # set to YES then doxygen will generate a graph for each documented file showing
2212 # the direct and indirect include dependencies of the file with other documented
2214 # The default value is: YES.
2215 # This tag requires that the tag HAVE_DOT is set to YES.
2217 INCLUDED_BY_GRAPH = YES
2219 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2220 # dependency graph for every global function or class method.
2222 # Note that enabling this option will significantly increase the time of a run.
2223 # So in most cases it will be better to enable call graphs for selected
2224 # functions only using the \callgraph command.
2225 # The default value is: NO.
2226 # This tag requires that the tag HAVE_DOT is set to YES.
2230 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2231 # dependency graph for every global function or class method.
2233 # Note that enabling this option will significantly increase the time of a run.
2234 # So in most cases it will be better to enable caller graphs for selected
2235 # functions only using the \callergraph command.
2236 # The default value is: NO.
2237 # This tag requires that the tag HAVE_DOT is set to YES.
2241 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2242 # hierarchy of all classes instead of a textual one.
2243 # The default value is: YES.
2244 # This tag requires that the tag HAVE_DOT is set to YES.
2246 GRAPHICAL_HIERARCHY = YES
2248 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2249 # dependencies a directory has on other directories in a graphical way. The
2250 # dependency relations are determined by the #include relations between the
2251 # files in the directories.
2252 # The default value is: YES.
2253 # This tag requires that the tag HAVE_DOT is set to YES.
2255 DIRECTORY_GRAPH = YES
2257 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2259 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2260 # to make the SVG files visible in IE 9+ (other browsers do not have this
2262 # Possible values are: png, jpg, gif and svg.
2263 # The default value is: png.
2264 # This tag requires that the tag HAVE_DOT is set to YES.
2266 DOT_IMAGE_FORMAT = png
2268 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2269 # enable generation of interactive SVG images that allow zooming and panning.
2271 # Note that this requires a modern browser other than Internet Explorer. Tested
2272 # and working are Firefox, Chrome, Safari, and Opera.
2273 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2274 # the SVG files visible. Older versions of IE do not have SVG support.
2275 # The default value is: NO.
2276 # This tag requires that the tag HAVE_DOT is set to YES.
2278 INTERACTIVE_SVG = NO
2280 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2281 # found. If left blank, it is assumed the dot tool can be found in the path.
2282 # This tag requires that the tag HAVE_DOT is set to YES.
2286 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2287 # contain dot files that are included in the documentation (see the \dotfile
2289 # This tag requires that the tag HAVE_DOT is set to YES.
2293 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2294 # contain msc files that are included in the documentation (see the \mscfile
2299 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2300 # contain dia files that are included in the documentation (see the \diafile
2305 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2306 # path where java can find the plantuml.jar file. If left blank, it is assumed
2307 # PlantUML is not used or called during a preprocessing step. Doxygen will
2308 # generate a warning when it encounters a \startuml command in this case and
2309 # will not generate output for the diagram.
2313 # When using plantuml, the specified paths are searched for files specified by
2314 # the !include statement in a plantuml block.
2316 PLANTUML_INCLUDE_PATH =
2318 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2319 # that will be shown in the graph. If the number of nodes in a graph becomes
2320 # larger than this value, doxygen will truncate the graph, which is visualized
2321 # by representing a node as a red box. Note that doxygen if the number of direct
2322 # children of the root node in a graph is already larger than
2323 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2324 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2325 # Minimum value: 0, maximum value: 10000, default value: 50.
2326 # This tag requires that the tag HAVE_DOT is set to YES.
2328 DOT_GRAPH_MAX_NODES = 50
2330 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2331 # generated by dot. A depth value of 3 means that only nodes reachable from the
2332 # root by following a path via at most 3 edges will be shown. Nodes that lay
2333 # further from the root node will be omitted. Note that setting this option to 1
2334 # or 2 may greatly reduce the computation time needed for large code bases. Also
2335 # note that the size of a graph can be further restricted by
2336 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2337 # Minimum value: 0, maximum value: 1000, default value: 0.
2338 # This tag requires that the tag HAVE_DOT is set to YES.
2340 MAX_DOT_GRAPH_DEPTH = 0
2342 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2343 # background. This is disabled by default, because dot on Windows does not seem
2344 # to support this out of the box.
2346 # Warning: Depending on the platform used, enabling this option may lead to
2347 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2349 # The default value is: NO.
2350 # This tag requires that the tag HAVE_DOT is set to YES.
2352 DOT_TRANSPARENT = NO
2354 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2355 # files in one run (i.e. multiple -o and -T options on the command line). This
2356 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2357 # this, this feature is disabled by default.
2358 # The default value is: NO.
2359 # This tag requires that the tag HAVE_DOT is set to YES.
2361 DOT_MULTI_TARGETS = NO
2363 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2364 # explaining the meaning of the various boxes and arrows in the dot generated
2366 # The default value is: YES.
2367 # This tag requires that the tag HAVE_DOT is set to YES.
2369 GENERATE_LEGEND = YES
2371 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2372 # files that are used to generate the various graphs.
2373 # The default value is: YES.
2374 # This tag requires that the tag HAVE_DOT is set to YES.