4 # Copyright 2015-2016 Nest Labs Inc. All Rights Reserved.
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
21 # This file describes the settings to be used by the
22 # documentation system # doxygen (www.doxygen.org) for Weave.
24 # This was initially autogenerated 'doxywizard' and then hand-tuned.
26 # All text after a hash (#) is considered a comment and will be
31 # TAG = value [value, ...]
33 # For lists items can also be appended using:
35 # TAG += value [value, ...]
37 # Values that contain spaces should be placed between quotes (" ")
40 #---------------------------------------------------------------------------
41 # Project related configuration options
42 #---------------------------------------------------------------------------
44 # This tag specifies the encoding used for all characters in the config file
45 # that follow. The default is UTF-8 which is also the encoding used for all text
46 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
47 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
48 # for the list of possible encodings.
49 # The default value is: UTF-8.
51 DOXYFILE_ENCODING = UTF-8
53 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
54 # double-quotes, unless you are using Doxywizard) that should identify the
55 # project for which the documentation is generated. This name is used in the
56 # title of most generated pages and in a few other places.
57 # The default value is: My Project.
59 PROJECT_NAME = @PACKAGE_NAME@
61 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
62 # could be handy for archiving the generated documentation or if some version
63 # control system is used.
65 PROJECT_NUMBER = @PACKAGE_VERSION@
67 # Using the PROJECT_BRIEF tag one can provide an optional one line description
68 # for a project that appears at the top of each page and should give viewer a
69 # quick idea about the purpose of the project. Keep the description short.
73 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
74 # the documentation. The maximum height of the logo should not exceed 55 pixels
75 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
76 # to the output directory.
80 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
81 # into which the generated documentation will be written. If a relative path is
82 # entered, it will be relative to the location where doxygen was started. If
83 # left blank the current directory will be used.
85 OUTPUT_DIRECTORY = @abs_builddir@
87 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
88 # directories (in 2 levels) under the output directory of each output format and
89 # will distribute the generated files over these directories. Enabling this
90 # option can be useful when feeding doxygen a huge amount of source files, where
91 # putting all generated files in the same directory would otherwise causes
92 # performance problems for the file system.
93 # The default value is: NO.
97 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
98 # documentation generated by doxygen is written. Doxygen will use this
99 # information to generate all constant output in the proper language.
100 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
101 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
102 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
103 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
104 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
105 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
106 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
107 # Ukrainian and Vietnamese.
108 # The default value is: English.
110 OUTPUT_LANGUAGE = English
112 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
113 # descriptions after the members that are listed in the file and class
114 # documentation (similar to Javadoc). Set to NO to disable this.
115 # The default value is: YES.
117 BRIEF_MEMBER_DESC = YES
119 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
120 # description of a member or function before the detailed description
122 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
123 # brief descriptions will be completely suppressed.
124 # The default value is: YES.
128 # This tag implements a quasi-intelligent brief description abbreviator that is
129 # used to form the text in various listings. Each string in this list, if found
130 # as the leading text of the brief description, will be stripped from the text
131 # and the result, after processing the whole list, is used as the annotated
132 # text. Otherwise, the brief description is used as-is. If left blank, the
133 # following values are used ($name is automatically replaced with the name of
134 # the entity):The $name class, The $name widget, The $name file, is, provides,
135 # specifies, contains, represents, a, an and the.
137 ABBREVIATE_BRIEF = "The $name class" \
149 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
150 # doxygen will generate a detailed section even if there is only a brief
152 # The default value is: NO.
154 ALWAYS_DETAILED_SEC = NO
156 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
157 # inherited members of a class in the documentation of that class as if those
158 # members were ordinary class members. Constructors, destructors and assignment
159 # operators of the base classes will not be shown.
160 # The default value is: NO.
162 INLINE_INHERITED_MEMB = NO
164 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
165 # before files name in the file list and in the header files. If set to NO the
166 # shortest path that makes the file name unique will be used
167 # The default value is: YES.
169 FULL_PATH_NAMES = YES
171 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
172 # Stripping is only done if one of the specified strings matches the left-hand
173 # part of the path. The tag can be used to show relative paths in the file list.
174 # If left blank the directory from which doxygen is run is used as the path to
177 # Note that you can specify absolute paths here, but also relative paths, which
178 # will be relative from the directory where doxygen is started.
179 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
181 STRIP_FROM_PATH = @abs_top_srcdir@ \
184 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
185 # path mentioned in the documentation of a class, which tells the reader which
186 # header file to include in order to use a class. If left blank only the name of
187 # the header file containing the class definition is used. Otherwise one should
188 # specify the list of include paths that are normally passed to the compiler
191 STRIP_FROM_INC_PATH = @abs_top_srcdir@
193 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
194 # less readable) file names. This can be useful is your file systems doesn't
195 # support long names like on DOS, Mac, or CD-ROM.
196 # The default value is: NO.
200 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
201 # first line (until the first dot) of a Javadoc-style comment as the brief
202 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
203 # style comments (thus requiring an explicit @brief command for a brief
205 # The default value is: NO.
207 JAVADOC_AUTOBRIEF = YES
209 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
210 # line (until the first dot) of a Qt-style comment as the brief description. If
211 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
212 # requiring an explicit \brief command for a brief description.)
213 # The default value is: NO.
217 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
218 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
219 # a brief description. This used to be the default behavior. The new default is
220 # to treat a multi-line C++ comment block as a detailed description. Set this
221 # tag to YES if you prefer the old behavior instead.
223 # Note that setting this tag to YES also means that rational rose comments are
224 # not recognized any more.
225 # The default value is: NO.
227 MULTILINE_CPP_IS_BRIEF = NO
229 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
230 # documentation from any documented member that it re-implements.
231 # The default value is: YES.
235 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
236 # new page for each member. If set to NO, the documentation of a member will be
237 # part of the file/class/namespace that contains it.
238 # The default value is: NO.
240 SEPARATE_MEMBER_PAGES = NO
242 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
243 # uses this value to replace tabs by spaces in code fragments.
244 # Minimum value: 1, maximum value: 16, default value: 4.
248 # This tag can be used to specify a number of aliases that act as commands in
249 # the documentation. An alias has the form:
252 # "sideeffect=@par Side Effects:\n"
253 # will allow you to put the command \sideeffect (or @sideeffect) in the
254 # documentation, which will result in a user-defined paragraph with heading
255 # "Side Effects:". You can put \n's in the value part of an alias to insert
260 # This tag can be used to specify a number of word-keyword mappings (TCL only).
261 # A mapping has the form "name=value". For example adding "class=itcl::class"
262 # will allow you to use the command class in the itcl::class meaning.
266 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
267 # only. Doxygen will then generate output that is more tailored for C. For
268 # instance, some of the names that are used will be different. The list of all
269 # members will be omitted, etc.
270 # The default value is: NO.
272 OPTIMIZE_OUTPUT_FOR_C = NO
274 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
275 # Python sources only. Doxygen will then generate output that is more tailored
276 # for that language. For instance, namespaces will be presented as packages,
277 # qualified scopes will look different, etc.
278 # The default value is: NO.
280 OPTIMIZE_OUTPUT_JAVA = NO
282 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
283 # sources. Doxygen will then generate output that is tailored for Fortran.
284 # The default value is: NO.
286 OPTIMIZE_FOR_FORTRAN = NO
288 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
289 # sources. Doxygen will then generate output that is tailored for VHDL.
290 # The default value is: NO.
292 OPTIMIZE_OUTPUT_VHDL = NO
294 # Doxygen selects the parser to use depending on the extension of the files it
295 # parses. With this tag you can assign which parser to use for a given
296 # extension. Doxygen has a built-in mapping, but you can override or extend it
297 # using this tag. The format is ext=language, where ext is a file extension, and
298 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
299 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
300 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
301 # (default is Fortran), use: inc=Fortran f=C.
303 # Note For files without extension you can use no_extension as a placeholder.
305 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
306 # the files are not read by doxygen.
310 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
311 # according to the Markdown format, which allows for more readable
312 # documentation. See http://daringfireball.net/projects/markdown/ for details.
313 # The output of markdown processing is further processed by doxygen, so you can
314 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
315 # case of backward compatibilities issues.
316 # The default value is: YES.
318 MARKDOWN_SUPPORT = YES
320 # When enabled doxygen tries to link words that correspond to documented
321 # classes, or namespaces to their corresponding documentation. Such a link can
322 # be prevented in individual cases by by putting a % sign in front of the word
323 # or globally by setting AUTOLINK_SUPPORT to NO.
324 # The default value is: YES.
326 AUTOLINK_SUPPORT = YES
328 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
329 # to include (a tag file for) the STL sources as input, then you should set this
330 # tag to YES in order to let doxygen match functions declarations and
331 # definitions whose arguments contain STL classes (e.g. func(std::string);
332 # versus func(std::string) {}). This also make the inheritance and collaboration
333 # diagrams that involve STL classes more complete and accurate.
334 # The default value is: NO.
336 BUILTIN_STL_SUPPORT = NO
338 # If you use Microsoft's C++/CLI language, you should set this option to YES to
339 # enable parsing support.
340 # The default value is: NO.
344 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
345 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
346 # will parse them like normal C++ but will assume all classes use public instead
347 # of private inheritance when no explicit protection keyword is present.
348 # The default value is: NO.
352 # For Microsoft's IDL there are propget and propput attributes to indicate
353 # getter and setter methods for a property. Setting this option to YES will make
354 # doxygen to replace the get and set methods by a property in the documentation.
355 # This will only work if the methods are indeed getting or setting a simple
356 # type. If this is not the case, or you want to show the methods anyway, you
357 # should set this option to NO.
358 # The default value is: YES.
360 IDL_PROPERTY_SUPPORT = YES
362 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
363 # tag is set to YES, then doxygen will reuse the documentation of the first
364 # member in the group (if any) for the other members of the group. By default
365 # all members of a group must be documented explicitly.
366 # The default value is: NO.
368 DISTRIBUTE_GROUP_DOC = NO
370 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
371 # (for instance a group of public functions) to be put as a subgroup of that
372 # type (e.g. under the Public Functions section). Set it to NO to prevent
373 # subgrouping. Alternatively, this can be done per class using the
374 # \nosubgrouping command.
375 # The default value is: YES.
379 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
380 # are shown inside the group in which they are included (e.g. using \ingroup)
381 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
384 # Note that this feature does not work in combination with
385 # SEPARATE_MEMBER_PAGES.
386 # The default value is: NO.
388 INLINE_GROUPED_CLASSES = NO
390 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
391 # with only public data fields or simple typedef fields will be shown inline in
392 # the documentation of the scope in which they are defined (i.e. file,
393 # namespace, or group documentation), provided this scope is documented. If set
394 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
395 # Man pages) or section (for LaTeX and RTF).
396 # The default value is: NO.
398 INLINE_SIMPLE_STRUCTS = NO
400 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
401 # enum is documented as struct, union, or enum with the name of the typedef. So
402 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
403 # with name TypeT. When disabled the typedef will appear as a member of a file,
404 # namespace, or class. And the struct will be named TypeS. This can typically be
405 # useful for C code in case the coding convention dictates that all compound
406 # types are typedef'ed and only the typedef is referenced, never the tag name.
407 # The default value is: NO.
409 TYPEDEF_HIDES_STRUCT = NO
411 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
412 # cache is used to resolve symbols given their name and scope. Since this can be
413 # an expensive process and often the same symbol appears multiple times in the
414 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
415 # doxygen will become slower. If the cache is too large, memory is wasted. The
416 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
417 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
418 # symbols. At the end of a run doxygen will report the cache usage and suggest
419 # the optimal cache size from a speed point of view.
420 # Minimum value: 0, maximum value: 9, default value: 0.
422 LOOKUP_CACHE_SIZE = 0
424 #---------------------------------------------------------------------------
425 # Build related configuration options
426 #---------------------------------------------------------------------------
428 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
429 # documentation are documented, even if no documentation was available. Private
430 # class members and static file members will be hidden unless the
431 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
432 # Note: This will also disable the warnings about undocumented members that are
433 # normally produced when WARNINGS is set to YES.
434 # The default value is: NO.
438 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
439 # be included in the documentation.
440 # The default value is: NO.
444 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
445 # scope will be included in the documentation.
446 # The default value is: NO.
450 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
451 # included in the documentation.
452 # The default value is: NO.
456 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
457 # locally in source files will be included in the documentation. If set to NO
458 # only classes defined in header files are included. Does not have any effect
460 # The default value is: YES.
462 EXTRACT_LOCAL_CLASSES = YES
464 # This flag is only useful for Objective-C code. When set to YES local methods,
465 # which are defined in the implementation section but not in the interface are
466 # included in the documentation. If set to NO only methods in the interface are
468 # The default value is: NO.
470 EXTRACT_LOCAL_METHODS = NO
472 # If this flag is set to YES, the members of anonymous namespaces will be
473 # extracted and appear in the documentation as a namespace called
474 # 'anonymous_namespace{file}', where file will be replaced with the base name of
475 # the file that contains the anonymous namespace. By default anonymous namespace
477 # The default value is: NO.
479 EXTRACT_ANON_NSPACES = NO
481 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
482 # undocumented members inside documented classes or files. If set to NO these
483 # members will be included in the various overviews, but no documentation
484 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
485 # The default value is: NO.
487 HIDE_UNDOC_MEMBERS = NO
489 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
490 # undocumented classes that are normally visible in the class hierarchy. If set
491 # to NO these classes will be included in the various overviews. This option has
492 # no effect if EXTRACT_ALL is enabled.
493 # The default value is: NO.
495 HIDE_UNDOC_CLASSES = NO
497 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
498 # (class|struct|union) declarations. If set to NO these declarations will be
499 # included in the documentation.
500 # The default value is: NO.
502 HIDE_FRIEND_COMPOUNDS = NO
504 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
505 # documentation blocks found inside the body of a function. If set to NO these
506 # blocks will be appended to the function's detailed documentation block.
507 # The default value is: NO.
509 HIDE_IN_BODY_DOCS = NO
511 # The INTERNAL_DOCS tag determines if documentation that is typed after a
512 # \internal command is included. If the tag is set to NO then the documentation
513 # will be excluded. Set it to YES to include the internal documentation.
514 # The default value is: NO.
518 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
519 # names in lower-case letters. If set to YES upper-case letters are also
520 # allowed. This is useful if you have classes or files whose names only differ
521 # in case and if your file system supports case sensitive file names. Windows
522 # and Mac users are advised to set this option to NO.
523 # The default value is: system dependent.
525 CASE_SENSE_NAMES = YES
527 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
528 # their full class and namespace scopes in the documentation. If set to YES the
529 # scope will be hidden.
530 # The default value is: NO.
532 HIDE_SCOPE_NAMES = NO
534 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
535 # the files that are included by a file in the documentation of that file.
536 # The default value is: YES.
538 SHOW_INCLUDE_FILES = YES
540 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
541 # grouped member an include statement to the documentation, telling the reader
542 # which file to include in order to use the member.
543 # The default value is: NO.
545 SHOW_GROUPED_MEMB_INC = NO
547 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
548 # files with double quotes in the documentation rather than with sharp brackets.
549 # The default value is: NO.
551 FORCE_LOCAL_INCLUDES = NO
553 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
554 # documentation for inline members.
555 # The default value is: YES.
559 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
560 # (detailed) documentation of file and class members alphabetically by member
561 # name. If set to NO the members will appear in declaration order.
562 # The default value is: YES.
564 SORT_MEMBER_DOCS = YES
566 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
567 # descriptions of file, namespace and class members alphabetically by member
568 # name. If set to NO the members will appear in declaration order. Note that
569 # this will also influence the order of the classes in the class list.
570 # The default value is: NO.
574 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
575 # (brief and detailed) documentation of class members so that constructors and
576 # destructors are listed first. If set to NO the constructors will appear in the
577 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
578 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
579 # member documentation.
580 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
581 # detailed member documentation.
582 # The default value is: NO.
584 SORT_MEMBERS_CTORS_1ST = NO
586 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
587 # of group names into alphabetical order. If set to NO the group names will
588 # appear in their defined order.
589 # The default value is: NO.
591 SORT_GROUP_NAMES = NO
593 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
594 # fully-qualified names, including namespaces. If set to NO, the class list will
595 # be sorted only by class name, not including the namespace part.
596 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
597 # Note: This option applies only to the class list, not to the alphabetical
599 # The default value is: NO.
601 SORT_BY_SCOPE_NAME = NO
603 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
604 # type resolution of all parameters of a function it will reject a match between
605 # the prototype and the implementation of a member function even if there is
606 # only one candidate or it is obvious which candidate to choose by doing a
607 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
608 # accept a match between prototype and implementation in such cases.
609 # The default value is: NO.
611 STRICT_PROTO_MATCHING = NO
613 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
614 # todo list. This list is created by putting \todo commands in the
616 # The default value is: YES.
618 GENERATE_TODOLIST = YES
620 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
621 # test list. This list is created by putting \test commands in the
623 # The default value is: YES.
625 GENERATE_TESTLIST = YES
627 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
628 # list. This list is created by putting \bug commands in the documentation.
629 # The default value is: YES.
631 GENERATE_BUGLIST = YES
633 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
634 # the deprecated list. This list is created by putting \deprecated commands in
636 # The default value is: YES.
638 GENERATE_DEPRECATEDLIST= YES
640 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
641 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
642 # ... \endcond blocks.
646 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
647 # initial value of a variable or macro / define can have for it to appear in the
648 # documentation. If the initializer consists of more lines than specified here
649 # it will be hidden. Use a value of 0 to hide initializers completely. The
650 # appearance of the value of individual variables and macros / defines can be
651 # controlled using \showinitializer or \hideinitializer command in the
652 # documentation regardless of this setting.
653 # Minimum value: 0, maximum value: 10000, default value: 30.
655 MAX_INITIALIZER_LINES = 30
657 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
658 # the bottom of the documentation of classes and structs. If set to YES the list
659 # will mention the files that were used to generate the documentation.
660 # The default value is: YES.
662 SHOW_USED_FILES = YES
664 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
665 # will remove the Files entry from the Quick Index and from the Folder Tree View
667 # The default value is: YES.
671 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
672 # page. This will remove the Namespaces entry from the Quick Index and from the
673 # Folder Tree View (if specified).
674 # The default value is: YES.
676 SHOW_NAMESPACES = YES
678 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
679 # doxygen should invoke to get the current version for each file (typically from
680 # the version control system). Doxygen will invoke the program by executing (via
681 # popen()) the command command input-file, where command is the value of the
682 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
683 # by doxygen. Whatever the program writes to standard output is used as the file
684 # version. For an example see the documentation.
686 FILE_VERSION_FILTER =
688 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
689 # by doxygen. The layout file controls the global structure of the generated
690 # output files in an output format independent way. To create the layout file
691 # that represents doxygen's defaults, run doxygen with the -l option. You can
692 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
693 # will be used as the name of the layout file.
695 # Note that if you run doxygen from a directory containing a file called
696 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
701 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
702 # the reference definitions. This must be a list of .bib files. The .bib
703 # extension is automatically appended if omitted. This requires the bibtex tool
704 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
705 # For LaTeX the style of the bibliography can be controlled using
706 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
707 # search path. Do not use file names with spaces, bibtex cannot handle them. See
708 # also \cite for info how to create references.
712 #---------------------------------------------------------------------------
713 # Configuration options related to warning and progress messages
714 #---------------------------------------------------------------------------
716 # The QUIET tag can be used to turn on/off the messages that are generated to
717 # standard output by doxygen. If QUIET is set to YES this implies that the
719 # The default value is: NO.
723 # The WARNINGS tag can be used to turn on/off the warning messages that are
724 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
725 # this implies that the warnings are on.
727 # Tip: Turn warnings on while writing the documentation.
728 # The default value is: YES.
732 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
733 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
734 # will automatically be disabled.
735 # The default value is: YES.
737 WARN_IF_UNDOCUMENTED = YES
739 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
740 # potential errors in the documentation, such as not documenting some parameters
741 # in a documented function, or documenting parameters that don't exist or using
742 # markup commands wrongly.
743 # The default value is: YES.
745 WARN_IF_DOC_ERROR = YES
747 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
748 # are documented, but have no documentation for their parameters or return
749 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
750 # documentation, but not about the absence of documentation.
751 # The default value is: NO.
753 WARN_NO_PARAMDOC = NO
755 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
756 # can produce. The string should contain the $file, $line, and $text tags, which
757 # will be replaced by the file and line number from which the warning originated
758 # and the warning text. Optionally the format may contain $version, which will
759 # be replaced by the version of the file (if it could be obtained via
760 # FILE_VERSION_FILTER)
761 # The default value is: $file:$line: $text.
763 WARN_FORMAT = "$file:$line: $text"
765 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
766 # messages should be written. If left blank the output is written to standard
771 #---------------------------------------------------------------------------
772 # Configuration options related to the input files
773 #---------------------------------------------------------------------------
775 # The INPUT tag is used to specify the files and/or directories that contain
776 # documented source files. You may enter file names like myfile.cpp or
777 # directories like /usr/src/myproject. Separate the files or directories with
779 # Note: If this tag is empty the current directory is searched.
781 INPUT = @abs_top_srcdir@/src \
782 @abs_top_srcdir@/doc \
783 @abs_top_srcdir@/README.md \
785 # This tag can be used to specify the character encoding of the source files
786 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
787 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
788 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
789 # possible encodings.
790 # The default value is: UTF-8.
792 INPUT_ENCODING = UTF-8
794 # If the value of the INPUT tag contains directories, you can use the
795 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
796 # *.h) to filter out the source-files in the directories. If left blank the
797 # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
798 # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
799 # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
800 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
801 # *.qsf, *.as and *.js.
803 FILE_PATTERNS = *.c \
836 # The RECURSIVE tag can be used to specify whether or not subdirectories should
837 # be searched for input files as well.
838 # The default value is: NO.
842 # The EXCLUDE tag can be used to specify files and/or directories that should be
843 # excluded from the INPUT source files. This way you can easily exclude a
844 # subdirectory from a directory tree whose root is specified with the INPUT tag.
846 # Note that relative paths are relative to the directory from which doxygen is
851 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
852 # directories that are symbolic links (a Unix file system feature) are excluded
854 # The default value is: NO.
856 EXCLUDE_SYMLINKS = NO
858 # If the value of the INPUT tag contains directories, you can use the
859 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
860 # certain files from those directories.
862 # Note that the wildcards are matched against the file with absolute path, so to
863 # exclude all test directories for example use the pattern */test/*
867 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
868 # (namespaces, classes, functions, etc.) that should be excluded from the
869 # output. The symbol name can be a fully qualified name, a word, or if the
870 # wildcard * is used, a substring. Examples: ANamespace, AClass,
871 # AClass::ANamespace, ANamespace::*Test
873 # Note that the wildcards are matched against the file with absolute path, so to
874 # exclude all test directories use the pattern */test/*
876 EXCLUDE_SYMBOLS = _NL_TEST_ASSIGN
878 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
879 # that contain example code fragments that are included (see the \include
884 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
885 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
886 # *.h) to filter out the source-files in the directories. If left blank all
887 # files are included.
891 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
892 # searched for input files to be used with the \include or \dontinclude commands
893 # irrespective of the value of the RECURSIVE tag.
894 # The default value is: NO.
896 EXAMPLE_RECURSIVE = NO
898 # The IMAGE_PATH tag can be used to specify one or more files or directories
899 # that contain images that are to be included in the documentation (see the
904 # The INPUT_FILTER tag can be used to specify a program that doxygen should
905 # invoke to filter for each input file. Doxygen will invoke the filter program
906 # by executing (via popen()) the command:
908 # <filter> <input-file>
910 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
911 # name of an input file. Doxygen will then use the output that the filter
912 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
915 # Note that the filter must not add or remove lines; it is applied before the
916 # code is scanned, but not when the output code is generated. If lines are added
917 # or removed, the anchors will not be placed correctly.
921 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
922 # basis. Doxygen will compare the file name with each pattern and apply the
923 # filter if there is a match. The filters are a list of the form: pattern=filter
924 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
925 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
926 # patterns match the file name, INPUT_FILTER is applied.
930 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
931 # INPUT_FILTER ) will also be used to filter the input files that are used for
932 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
933 # The default value is: NO.
935 FILTER_SOURCE_FILES = NO
937 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
938 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
939 # it is also possible to disable source filtering for a specific pattern using
940 # *.ext= (so without naming a filter).
941 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
943 FILTER_SOURCE_PATTERNS =
945 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
946 # is part of the input, its contents will be placed on the main page
947 # (index.html). This can be useful if you have a project on for instance GitHub
948 # and want to reuse the introduction page also for the doxygen output.
950 USE_MDFILE_AS_MAINPAGE = README.md
952 #---------------------------------------------------------------------------
953 # Configuration options related to source browsing
954 #---------------------------------------------------------------------------
956 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
957 # generated. Documented entities will be cross-referenced with these sources.
959 # Note: To get rid of all source code in the generated output, make sure that
960 # also VERBATIM_HEADERS is set to NO.
961 # The default value is: NO.
965 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
966 # classes and enums directly into the documentation.
967 # The default value is: NO.
971 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
972 # special comment blocks from generated source code fragments. Normal C, C++ and
973 # Fortran comments will always remain visible.
974 # The default value is: YES.
976 STRIP_CODE_COMMENTS = YES
978 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
979 # function all documented functions referencing it will be listed.
980 # The default value is: NO.
982 REFERENCED_BY_RELATION = NO
984 # If the REFERENCES_RELATION tag is set to YES then for each documented function
985 # all documented entities called/used by that function will be listed.
986 # The default value is: NO.
988 REFERENCES_RELATION = NO
990 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
991 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
992 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
993 # link to the documentation.
994 # The default value is: YES.
996 REFERENCES_LINK_SOURCE = YES
998 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
999 # source code will show a tooltip with additional information such as prototype,
1000 # brief description and links to the definition and documentation. Since this
1001 # will make the HTML file larger and loading of large files a bit slower, you
1002 # can opt to disable this feature.
1003 # The default value is: YES.
1004 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1006 SOURCE_TOOLTIPS = YES
1008 # If the USE_HTAGS tag is set to YES then the references to source code will
1009 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1010 # source browser. The htags tool is part of GNU's global source tagging system
1011 # (see http://www.gnu.org/software/global/global.html). You will need version
1014 # To use it do the following:
1015 # - Install the latest version of global
1016 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1017 # - Make sure the INPUT points to the root of the source tree
1018 # - Run doxygen as normal
1020 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
1021 # tools must be available from the command line (i.e. in the search path).
1023 # The result: instead of the source browser generated by doxygen, the links to
1024 # source code will now point to the output of htags.
1025 # The default value is: NO.
1026 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1030 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1031 # verbatim copy of the header file for each class for which an include is
1032 # specified. Set to NO to disable this.
1033 # See also: Section \class.
1034 # The default value is: YES.
1036 VERBATIM_HEADERS = YES
1038 #---------------------------------------------------------------------------
1039 # Configuration options related to the alphabetical class index
1040 #---------------------------------------------------------------------------
1042 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1043 # compounds will be generated. Enable this if the project contains a lot of
1044 # classes, structs, unions or interfaces.
1045 # The default value is: YES.
1047 ALPHABETICAL_INDEX = YES
1049 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1050 # which the alphabetical index list will be split.
1051 # Minimum value: 1, maximum value: 20, default value: 5.
1052 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1054 COLS_IN_ALPHA_INDEX = 5
1056 # In case all classes in a project start with a common prefix, all classes will
1057 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1058 # can be used to specify a prefix (or a list of prefixes) that should be ignored
1059 # while generating the index headers.
1060 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1064 #---------------------------------------------------------------------------
1065 # Configuration options related to the HTML output
1066 #---------------------------------------------------------------------------
1068 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1069 # The default value is: YES.
1073 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1074 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1076 # The default directory is: html.
1077 # This tag requires that the tag GENERATE_HTML is set to YES.
1081 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1082 # generated HTML page (for example: .htm, .php, .asp).
1083 # The default value is: .html.
1084 # This tag requires that the tag GENERATE_HTML is set to YES.
1086 HTML_FILE_EXTENSION = .html
1088 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1089 # each generated HTML page. If the tag is left blank doxygen will generate a
1092 # To get valid HTML the header file that includes any scripts and style sheets
1093 # that doxygen needs, which is dependent on the configuration options used (e.g.
1094 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1095 # default header using
1096 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1098 # and then modify the file new_header.html. See also section "Doxygen usage"
1099 # for information on how to generate the default header that doxygen normally
1101 # Note: The header is subject to change so you typically have to regenerate the
1102 # default header when upgrading to a newer version of doxygen. For a description
1103 # of the possible markers and block names see the documentation.
1104 # This tag requires that the tag GENERATE_HTML is set to YES.
1108 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1109 # generated HTML page. If the tag is left blank doxygen will generate a standard
1110 # footer. See HTML_HEADER for more information on how to generate a default
1111 # footer and what special commands can be used inside the footer. See also
1112 # section "Doxygen usage" for information on how to generate the default footer
1113 # that doxygen normally uses.
1114 # This tag requires that the tag GENERATE_HTML is set to YES.
1118 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1119 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1120 # the HTML output. If left blank doxygen will generate a default style sheet.
1121 # See also section "Doxygen usage" for information on how to generate the style
1122 # sheet that doxygen normally uses.
1123 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1124 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1126 # This tag requires that the tag GENERATE_HTML is set to YES.
1130 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1131 # defined cascading style sheet that is included after the standard style sheets
1132 # created by doxygen. Using this option one can overrule certain style aspects.
1133 # This is preferred over using HTML_STYLESHEET since it does not replace the
1134 # standard style sheet and is therefor more robust against future updates.
1135 # Doxygen will copy the style sheet file to the output directory. For an example
1136 # see the documentation.
1137 # This tag requires that the tag GENERATE_HTML is set to YES.
1139 HTML_EXTRA_STYLESHEET =
1141 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1142 # other source files which should be copied to the HTML output directory. Note
1143 # that these files will be copied to the base HTML output directory. Use the
1144 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1145 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1146 # files will be copied as-is; there are no commands or markers available.
1147 # This tag requires that the tag GENERATE_HTML is set to YES.
1151 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1152 # will adjust the colors in the stylesheet and background images according to
1153 # this color. Hue is specified as an angle on a colorwheel, see
1154 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1155 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1156 # purple, and 360 is red again.
1157 # Minimum value: 0, maximum value: 359, default value: 220.
1158 # This tag requires that the tag GENERATE_HTML is set to YES.
1160 HTML_COLORSTYLE_HUE = 220
1162 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1163 # in the HTML output. For a value of 0 the output will use grayscales only. A
1164 # value of 255 will produce the most vivid colors.
1165 # Minimum value: 0, maximum value: 255, default value: 100.
1166 # This tag requires that the tag GENERATE_HTML is set to YES.
1168 HTML_COLORSTYLE_SAT = 100
1170 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1171 # luminance component of the colors in the HTML output. Values below 100
1172 # gradually make the output lighter, whereas values above 100 make the output
1173 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1174 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1176 # Minimum value: 40, maximum value: 240, default value: 80.
1177 # This tag requires that the tag GENERATE_HTML is set to YES.
1179 HTML_COLORSTYLE_GAMMA = 80
1181 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1182 # page will contain the date and time when the page was generated. Setting this
1183 # to NO can help when comparing the output of multiple runs.
1184 # The default value is: YES.
1185 # This tag requires that the tag GENERATE_HTML is set to YES.
1187 HTML_TIMESTAMP = YES
1189 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1190 # documentation will contain sections that can be hidden and shown after the
1192 # The default value is: NO.
1193 # This tag requires that the tag GENERATE_HTML is set to YES.
1195 HTML_DYNAMIC_SECTIONS = NO
1197 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1198 # shown in the various tree structured indices initially; the user can expand
1199 # and collapse entries dynamically later on. Doxygen will expand the tree to
1200 # such a level that at most the specified number of entries are visible (unless
1201 # a fully collapsed tree already exceeds this amount). So setting the number of
1202 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1203 # representing an infinite number of entries and will result in a full expanded
1205 # Minimum value: 0, maximum value: 9999, default value: 100.
1206 # This tag requires that the tag GENERATE_HTML is set to YES.
1208 HTML_INDEX_NUM_ENTRIES = 100
1210 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1211 # generated that can be used as input for Apple's Xcode 3 integrated development
1212 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
1213 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1214 # Makefile in the HTML output directory. Running make will produce the docset in
1215 # that directory and running make install will install the docset in
1216 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1217 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1218 # for more information.
1219 # The default value is: NO.
1220 # This tag requires that the tag GENERATE_HTML is set to YES.
1222 GENERATE_DOCSET = NO
1224 # This tag determines the name of the docset feed. A documentation feed provides
1225 # an umbrella under which multiple documentation sets from a single provider
1226 # (such as a company or product suite) can be grouped.
1227 # The default value is: Doxygen generated docs.
1228 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1230 DOCSET_FEEDNAME = "Doxygen generated docs"
1232 # This tag specifies a string that should uniquely identify the documentation
1233 # set bundle. This should be a reverse domain-name style string, e.g.
1234 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1235 # The default value is: org.doxygen.Project.
1236 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1238 DOCSET_BUNDLE_ID = org.doxygen.Project
1240 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1241 # the documentation publisher. This should be a reverse domain-name style
1242 # string, e.g. com.mycompany.MyDocSet.documentation.
1243 # The default value is: org.doxygen.Publisher.
1244 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1246 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1248 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1249 # The default value is: Publisher.
1250 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1252 DOCSET_PUBLISHER_NAME = Publisher
1254 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1255 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1256 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1257 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1260 # The HTML Help Workshop contains a compiler that can convert all HTML output
1261 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1262 # files are now used as the Windows 98 help format, and will replace the old
1263 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
1264 # HTML files also contain an index, a table of contents, and you can search for
1265 # words in the documentation. The HTML workshop also contains a viewer for
1266 # compressed HTML files.
1267 # The default value is: NO.
1268 # This tag requires that the tag GENERATE_HTML is set to YES.
1270 GENERATE_HTMLHELP = NO
1272 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
1273 # file. You can add a path in front of the file if the result should not be
1274 # written to the html output directory.
1275 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1279 # The HHC_LOCATION tag can be used to specify the location (absolute path
1280 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
1281 # doxygen will try to run the HTML help compiler on the generated index.hhp.
1282 # The file has to be specified with full path.
1283 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1287 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
1288 # YES) or that it should be included in the master .chm file ( NO).
1289 # The default value is: NO.
1290 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1294 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1295 # and project file content.
1296 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1298 CHM_INDEX_ENCODING =
1300 # The BINARY_TOC flag controls whether a binary table of contents is generated (
1301 # YES) or a normal table of contents ( NO) in the .chm file.
1302 # The default value is: NO.
1303 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1307 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1308 # the table of contents of the HTML help documentation and to the tree view.
1309 # The default value is: NO.
1310 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1314 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1315 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1316 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1317 # (.qch) of the generated HTML documentation.
1318 # The default value is: NO.
1319 # This tag requires that the tag GENERATE_HTML is set to YES.
1323 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1324 # the file name of the resulting .qch file. The path specified is relative to
1325 # the HTML output folder.
1326 # This tag requires that the tag GENERATE_QHP is set to YES.
1330 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1331 # Project output. For more information please see Qt Help Project / Namespace
1332 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1333 # The default value is: org.doxygen.Project.
1334 # This tag requires that the tag GENERATE_QHP is set to YES.
1336 QHP_NAMESPACE = org.doxygen.Project
1338 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1339 # Help Project output. For more information please see Qt Help Project / Virtual
1340 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1342 # The default value is: doc.
1343 # This tag requires that the tag GENERATE_QHP is set to YES.
1345 QHP_VIRTUAL_FOLDER = doc
1347 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1348 # filter to add. For more information please see Qt Help Project / Custom
1349 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1351 # This tag requires that the tag GENERATE_QHP is set to YES.
1353 QHP_CUST_FILTER_NAME =
1355 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1356 # custom filter to add. For more information please see Qt Help Project / Custom
1357 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1359 # This tag requires that the tag GENERATE_QHP is set to YES.
1361 QHP_CUST_FILTER_ATTRS =
1363 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1364 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1365 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1366 # This tag requires that the tag GENERATE_QHP is set to YES.
1368 QHP_SECT_FILTER_ATTRS =
1370 # The QHG_LOCATION tag can be used to specify the location of Qt's
1371 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1372 # generated .qhp file.
1373 # This tag requires that the tag GENERATE_QHP is set to YES.
1377 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1378 # generated, together with the HTML files, they form an Eclipse help plugin. To
1379 # install this plugin and make it available under the help contents menu in
1380 # Eclipse, the contents of the directory containing the HTML and XML files needs
1381 # to be copied into the plugins directory of eclipse. The name of the directory
1382 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1383 # After copying Eclipse needs to be restarted before the help appears.
1384 # The default value is: NO.
1385 # This tag requires that the tag GENERATE_HTML is set to YES.
1387 GENERATE_ECLIPSEHELP = NO
1389 # A unique identifier for the Eclipse help plugin. When installing the plugin
1390 # the directory name containing the HTML and XML files should also have this
1391 # name. Each documentation set should have its own identifier.
1392 # The default value is: org.doxygen.Project.
1393 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1395 ECLIPSE_DOC_ID = org.doxygen.Project
1397 # If you want full control over the layout of the generated HTML pages it might
1398 # be necessary to disable the index and replace it with your own. The
1399 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1400 # of each HTML page. A value of NO enables the index and the value YES disables
1401 # it. Since the tabs in the index contain the same information as the navigation
1402 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1403 # The default value is: NO.
1404 # This tag requires that the tag GENERATE_HTML is set to YES.
1408 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1409 # structure should be generated to display hierarchical information. If the tag
1410 # value is set to YES, a side panel will be generated containing a tree-like
1411 # index structure (just like the one that is generated for HTML Help). For this
1412 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1413 # (i.e. any modern browser). Windows users are probably better off using the
1414 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1415 # further fine-tune the look of the index. As an example, the default style
1416 # sheet generated by doxygen has an example that shows how to put an image at
1417 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1418 # the same information as the tab index, you could consider setting
1419 # DISABLE_INDEX to YES when enabling this option.
1420 # The default value is: NO.
1421 # This tag requires that the tag GENERATE_HTML is set to YES.
1423 GENERATE_TREEVIEW = YES
1425 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1426 # doxygen will group on one line in the generated HTML documentation.
1428 # Note that a value of 0 will completely suppress the enum values from appearing
1429 # in the overview section.
1430 # Minimum value: 0, maximum value: 20, default value: 4.
1431 # This tag requires that the tag GENERATE_HTML is set to YES.
1433 ENUM_VALUES_PER_LINE = 1
1435 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1436 # to set the initial width (in pixels) of the frame in which the tree is shown.
1437 # Minimum value: 0, maximum value: 1500, default value: 250.
1438 # This tag requires that the tag GENERATE_HTML is set to YES.
1440 TREEVIEW_WIDTH = 250
1442 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1443 # external symbols imported via tag files in a separate window.
1444 # The default value is: NO.
1445 # This tag requires that the tag GENERATE_HTML is set to YES.
1447 EXT_LINKS_IN_WINDOW = NO
1449 # Use this tag to change the font size of LaTeX formulas included as images in
1450 # the HTML documentation. When you change the font size after a successful
1451 # doxygen run you need to manually remove any form_*.png images from the HTML
1452 # output directory to force them to be regenerated.
1453 # Minimum value: 8, maximum value: 50, default value: 10.
1454 # This tag requires that the tag GENERATE_HTML is set to YES.
1456 FORMULA_FONTSIZE = 10
1458 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1459 # generated for formulas are transparent PNGs. Transparent PNGs are not
1460 # supported properly for IE 6.0, but are supported on all modern browsers.
1462 # Note that when changing this option you need to delete any form_*.png files in
1463 # the HTML output directory before the changes have effect.
1464 # The default value is: YES.
1465 # This tag requires that the tag GENERATE_HTML is set to YES.
1467 FORMULA_TRANSPARENT = YES
1469 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1470 # http://www.mathjax.org) which uses client side Javascript for the rendering
1471 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
1472 # installed or if you want to formulas look prettier in the HTML output. When
1473 # enabled you may also need to install MathJax separately and configure the path
1474 # to it using the MATHJAX_RELPATH option.
1475 # The default value is: NO.
1476 # This tag requires that the tag GENERATE_HTML is set to YES.
1480 # When MathJax is enabled you can set the default output format to be used for
1481 # the MathJax output. See the MathJax site (see:
1482 # http://docs.mathjax.org/en/latest/output.html) for more details.
1483 # Possible values are: HTML-CSS (which is slower, but has the best
1484 # compatibility), NativeMML (i.e. MathML) and SVG.
1485 # The default value is: HTML-CSS.
1486 # This tag requires that the tag USE_MATHJAX is set to YES.
1488 MATHJAX_FORMAT = HTML-CSS
1490 # When MathJax is enabled you need to specify the location relative to the HTML
1491 # output directory using the MATHJAX_RELPATH option. The destination directory
1492 # should contain the MathJax.js script. For instance, if the mathjax directory
1493 # is located at the same level as the HTML output directory, then
1494 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1495 # Content Delivery Network so you can quickly see the result without installing
1496 # MathJax. However, it is strongly recommended to install a local copy of
1497 # MathJax from http://www.mathjax.org before deployment.
1498 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1499 # This tag requires that the tag USE_MATHJAX is set to YES.
1501 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1503 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1504 # extension names that should be enabled during MathJax rendering. For example
1505 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1506 # This tag requires that the tag USE_MATHJAX is set to YES.
1508 MATHJAX_EXTENSIONS =
1510 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1511 # of code that will be used on startup of the MathJax code. See the MathJax site
1512 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1513 # example see the documentation.
1514 # This tag requires that the tag USE_MATHJAX is set to YES.
1518 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1519 # the HTML output. The underlying search engine uses javascript and DHTML and
1520 # should work on any modern browser. Note that when using HTML help
1521 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1522 # there is already a search function so this one should typically be disabled.
1523 # For large projects the javascript based search engine can be slow, then
1524 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1525 # search using the keyboard; to jump to the search box use <access key> + S
1526 # (what the <access key> is depends on the OS and browser, but it is typically
1527 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1528 # key> to jump into the search results window, the results can be navigated
1529 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1530 # the search. The filter options can be selected when the cursor is inside the
1531 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1532 # to select a filter and <Enter> or <escape> to activate or cancel the filter
1534 # The default value is: YES.
1535 # This tag requires that the tag GENERATE_HTML is set to YES.
1539 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1540 # implemented using a web server instead of a web client using Javascript. There
1541 # are two flavours of web server based searching depending on the
1542 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1543 # searching and an index file used by the script. When EXTERNAL_SEARCH is
1544 # enabled the indexing and searching needs to be provided by external tools. See
1545 # the section "External Indexing and Searching" for details.
1546 # The default value is: NO.
1547 # This tag requires that the tag SEARCHENGINE is set to YES.
1549 SERVER_BASED_SEARCH = NO
1551 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1552 # script for searching. Instead the search results are written to an XML file
1553 # which needs to be processed by an external indexer. Doxygen will invoke an
1554 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1557 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1558 # (doxysearch.cgi) which are based on the open source search engine library
1559 # Xapian (see: http://xapian.org/).
1561 # See the section "External Indexing and Searching" for details.
1562 # The default value is: NO.
1563 # This tag requires that the tag SEARCHENGINE is set to YES.
1565 EXTERNAL_SEARCH = NO
1567 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1568 # which will return the search results when EXTERNAL_SEARCH is enabled.
1570 # Doxygen ships with an example indexer ( doxyindexer) and search engine
1571 # (doxysearch.cgi) which are based on the open source search engine library
1572 # Xapian (see: http://xapian.org/). See the section "External Indexing and
1573 # Searching" for details.
1574 # This tag requires that the tag SEARCHENGINE is set to YES.
1578 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1579 # search data is written to a file for indexing by an external tool. With the
1580 # SEARCHDATA_FILE tag the name of this file can be specified.
1581 # The default file is: searchdata.xml.
1582 # This tag requires that the tag SEARCHENGINE is set to YES.
1584 SEARCHDATA_FILE = searchdata.xml
1586 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1587 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1588 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1589 # projects and redirect the results back to the right project.
1590 # This tag requires that the tag SEARCHENGINE is set to YES.
1592 EXTERNAL_SEARCH_ID =
1594 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1595 # projects other than the one defined by this configuration file, but that are
1596 # all added to the same external search index. Each project needs to have a
1597 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1598 # to a relative location where the documentation can be found. The format is:
1599 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1600 # This tag requires that the tag SEARCHENGINE is set to YES.
1602 EXTRA_SEARCH_MAPPINGS =
1604 #---------------------------------------------------------------------------
1605 # Configuration options related to the LaTeX output
1606 #---------------------------------------------------------------------------
1608 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1609 # The default value is: YES.
1613 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1614 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1616 # The default directory is: latex.
1617 # This tag requires that the tag GENERATE_LATEX is set to YES.
1619 LATEX_OUTPUT = latex
1621 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1624 # Note that when enabling USE_PDFLATEX this option is only used for generating
1625 # bitmaps for formulas in the HTML output, but not in the Makefile that is
1626 # written to the output directory.
1627 # The default file is: latex.
1628 # This tag requires that the tag GENERATE_LATEX is set to YES.
1630 LATEX_CMD_NAME = latex
1632 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1634 # The default file is: makeindex.
1635 # This tag requires that the tag GENERATE_LATEX is set to YES.
1637 MAKEINDEX_CMD_NAME = makeindex
1639 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1640 # documents. This may be useful for small projects and may help to save some
1642 # The default value is: NO.
1643 # This tag requires that the tag GENERATE_LATEX is set to YES.
1647 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1649 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1650 # 14 inches) and executive (7.25 x 10.5 inches).
1651 # The default value is: a4.
1652 # This tag requires that the tag GENERATE_LATEX is set to YES.
1656 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1657 # that should be included in the LaTeX output. To get the times font for
1658 # instance you can specify
1659 # EXTRA_PACKAGES=times
1660 # If left blank no extra packages will be included.
1661 # This tag requires that the tag GENERATE_LATEX is set to YES.
1665 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1666 # generated LaTeX document. The header should contain everything until the first
1667 # chapter. If it is left blank doxygen will generate a standard header. See
1668 # section "Doxygen usage" for information on how to let doxygen write the
1669 # default header to a separate file.
1671 # Note: Only use a user-defined header if you know what you are doing! The
1672 # following commands have a special meaning inside the header: $title,
1673 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1674 # replace them by respectively the title of the page, the current date and time,
1675 # only the current date, the version number of doxygen, the project name (see
1676 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1677 # This tag requires that the tag GENERATE_LATEX is set to YES.
1681 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1682 # generated LaTeX document. The footer should contain everything after the last
1683 # chapter. If it is left blank doxygen will generate a standard footer.
1685 # Note: Only use a user-defined footer if you know what you are doing!
1686 # This tag requires that the tag GENERATE_LATEX is set to YES.
1690 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1691 # other source files which should be copied to the LATEX_OUTPUT output
1692 # directory. Note that the files will be copied as-is; there are no commands or
1693 # markers available.
1694 # This tag requires that the tag GENERATE_LATEX is set to YES.
1698 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1699 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1700 # contain links (just like the HTML output) instead of page references. This
1701 # makes the output suitable for online browsing using a PDF viewer.
1702 # The default value is: YES.
1703 # This tag requires that the tag GENERATE_LATEX is set to YES.
1705 PDF_HYPERLINKS = YES
1707 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1708 # the PDF file directly from the LaTeX files. Set this option to YES to get a
1709 # higher quality PDF documentation.
1710 # The default value is: YES.
1711 # This tag requires that the tag GENERATE_LATEX is set to YES.
1715 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1716 # command to the generated LaTeX files. This will instruct LaTeX to keep running
1717 # if errors occur, instead of asking the user for help. This option is also used
1718 # when generating formulas in HTML.
1719 # The default value is: NO.
1720 # This tag requires that the tag GENERATE_LATEX is set to YES.
1722 LATEX_BATCHMODE = NO
1724 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1725 # index chapters (such as File Index, Compound Index, etc.) in the output.
1726 # The default value is: NO.
1727 # This tag requires that the tag GENERATE_LATEX is set to YES.
1729 LATEX_HIDE_INDICES = NO
1731 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1732 # code with syntax highlighting in the LaTeX output.
1734 # Note that which sources are shown also depends on other settings such as
1736 # The default value is: NO.
1737 # This tag requires that the tag GENERATE_LATEX is set to YES.
1739 LATEX_SOURCE_CODE = NO
1741 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1742 # bibliography, e.g. plainnat, or ieeetr. See
1743 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1744 # The default value is: plain.
1745 # This tag requires that the tag GENERATE_LATEX is set to YES.
1747 LATEX_BIB_STYLE = plain
1749 #---------------------------------------------------------------------------
1750 # Configuration options related to the RTF output
1751 #---------------------------------------------------------------------------
1753 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1754 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1756 # The default value is: NO.
1760 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1761 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1763 # The default directory is: rtf.
1764 # This tag requires that the tag GENERATE_RTF is set to YES.
1768 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1769 # documents. This may be useful for small projects and may help to save some
1771 # The default value is: NO.
1772 # This tag requires that the tag GENERATE_RTF is set to YES.
1776 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1777 # contain hyperlink fields. The RTF file will contain links (just like the HTML
1778 # output) instead of page references. This makes the output suitable for online
1779 # browsing using Word or some other Word compatible readers that support those
1782 # Note: WordPad (write) and others do not support links.
1783 # The default value is: NO.
1784 # This tag requires that the tag GENERATE_RTF is set to YES.
1788 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
1789 # file, i.e. a series of assignments. You only have to provide replacements,
1790 # missing definitions are set to their default value.
1792 # See also section "Doxygen usage" for information on how to generate the
1793 # default style sheet that doxygen normally uses.
1794 # This tag requires that the tag GENERATE_RTF is set to YES.
1796 RTF_STYLESHEET_FILE =
1798 # Set optional variables used in the generation of an RTF document. Syntax is
1799 # similar to doxygen's config file. A template extensions file can be generated
1800 # using doxygen -e rtf extensionFile.
1801 # This tag requires that the tag GENERATE_RTF is set to YES.
1803 RTF_EXTENSIONS_FILE =
1805 #---------------------------------------------------------------------------
1806 # Configuration options related to the man page output
1807 #---------------------------------------------------------------------------
1809 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1810 # classes and files.
1811 # The default value is: NO.
1815 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1816 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1817 # it. A directory man3 will be created inside the directory specified by
1819 # The default directory is: man.
1820 # This tag requires that the tag GENERATE_MAN is set to YES.
1824 # The MAN_EXTENSION tag determines the extension that is added to the generated
1825 # man pages. In case the manual section does not start with a number, the number
1826 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1828 # The default value is: .3.
1829 # This tag requires that the tag GENERATE_MAN is set to YES.
1833 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1834 # will generate one additional man file for each entity documented in the real
1835 # man page(s). These additional files only source the real man page, but without
1836 # them the man command would be unable to find the correct page.
1837 # The default value is: NO.
1838 # This tag requires that the tag GENERATE_MAN is set to YES.
1842 #---------------------------------------------------------------------------
1843 # Configuration options related to the XML output
1844 #---------------------------------------------------------------------------
1846 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1847 # captures the structure of the code including all documentation.
1848 # The default value is: NO.
1852 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1853 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1855 # The default directory is: xml.
1856 # This tag requires that the tag GENERATE_XML is set to YES.
1860 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1861 # validating XML parser to check the syntax of the XML files.
1862 # This tag requires that the tag GENERATE_XML is set to YES.
1866 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1867 # validating XML parser to check the syntax of the XML files.
1868 # This tag requires that the tag GENERATE_XML is set to YES.
1872 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1873 # listings (including syntax highlighting and cross-referencing information) to
1874 # the XML output. Note that enabling this will significantly increase the size
1875 # of the XML output.
1876 # The default value is: YES.
1877 # This tag requires that the tag GENERATE_XML is set to YES.
1879 XML_PROGRAMLISTING = YES
1881 #---------------------------------------------------------------------------
1882 # Configuration options related to the DOCBOOK output
1883 #---------------------------------------------------------------------------
1885 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1886 # that can be used to generate PDF.
1887 # The default value is: NO.
1889 GENERATE_DOCBOOK = NO
1891 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1892 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1894 # The default directory is: docbook.
1895 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1897 DOCBOOK_OUTPUT = docbook
1899 #---------------------------------------------------------------------------
1900 # Configuration options for the AutoGen Definitions output
1901 #---------------------------------------------------------------------------
1903 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1904 # Definitions (see http://autogen.sf.net) file that captures the structure of
1905 # the code including all documentation. Note that this feature is still
1906 # experimental and incomplete at the moment.
1907 # The default value is: NO.
1909 GENERATE_AUTOGEN_DEF = NO
1911 #---------------------------------------------------------------------------
1912 # Configuration options related to the Perl module output
1913 #---------------------------------------------------------------------------
1915 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1916 # file that captures the structure of the code including all documentation.
1918 # Note that this feature is still experimental and incomplete at the moment.
1919 # The default value is: NO.
1921 GENERATE_PERLMOD = NO
1923 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1924 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1925 # output from the Perl module output.
1926 # The default value is: NO.
1927 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1931 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1932 # formatted so it can be parsed by a human reader. This is useful if you want to
1933 # understand what is going on. On the other hand, if this tag is set to NO the
1934 # size of the Perl module output will be much smaller and Perl will parse it
1936 # The default value is: YES.
1937 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1939 PERLMOD_PRETTY = YES
1941 # The names of the make variables in the generated doxyrules.make file are
1942 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
1943 # so different doxyrules.make files included by the same Makefile don't
1944 # overwrite each other's variables.
1945 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1947 PERLMOD_MAKEVAR_PREFIX =
1949 #---------------------------------------------------------------------------
1950 # Configuration options related to the preprocessor
1951 #---------------------------------------------------------------------------
1953 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1954 # C-preprocessor directives found in the sources and include files.
1955 # The default value is: YES.
1957 ENABLE_PREPROCESSING = YES
1959 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1960 # in the source code. If set to NO only conditional compilation will be
1961 # performed. Macro expansion can be done in a controlled way by setting
1962 # EXPAND_ONLY_PREDEF to YES.
1963 # The default value is: NO.
1964 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1966 MACRO_EXPANSION = NO
1968 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1969 # the macro expansion is limited to the macros specified with the PREDEFINED and
1970 # EXPAND_AS_DEFINED tags.
1971 # The default value is: NO.
1972 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1974 EXPAND_ONLY_PREDEF = NO
1976 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
1977 # INCLUDE_PATH will be searched if a #include is found.
1978 # The default value is: YES.
1979 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1981 SEARCH_INCLUDES = YES
1983 # The INCLUDE_PATH tag can be used to specify one or more directories that
1984 # contain include files that are not input files but should be processed by the
1986 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
1990 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1991 # patterns (like *.h and *.hpp) to filter out the header-files in the
1992 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
1994 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1996 INCLUDE_FILE_PATTERNS =
1998 # The PREDEFINED tag can be used to specify one or more macro names that are
1999 # defined before the preprocessor is started (similar to the -D option of e.g.
2000 # gcc). The argument of the tag is a list of macros of the form: name or
2001 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2002 # is assumed. To prevent a macro definition from being undefined via #undef or
2003 # recursively expanded use the := operator instead of the = operator.
2004 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2008 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2009 # tag can be used to specify a list of macro names that should be expanded. The
2010 # macro definition that is found in the sources will be used. Use the PREDEFINED
2011 # tag if you want to use a different macro definition that overrules the
2012 # definition found in the source code.
2013 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2017 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2018 # remove all refrences to function-like macros that are alone on a line, have an
2019 # all uppercase name, and do not end with a semicolon. Such function macros are
2020 # typically used for boiler-plate code, and will confuse the parser if not
2022 # The default value is: YES.
2023 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2025 SKIP_FUNCTION_MACROS = YES
2027 #---------------------------------------------------------------------------
2028 # Configuration options related to external references
2029 #---------------------------------------------------------------------------
2031 # The TAGFILES tag can be used to specify one or more tag files. For each tag
2032 # file the location of the external documentation should be added. The format of
2033 # a tag file without this location is as follows:
2034 # TAGFILES = file1 file2 ...
2035 # Adding location for the tag files is done as follows:
2036 # TAGFILES = file1=loc1 "file2 = loc2" ...
2037 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
2038 # section "Linking to external documentation" for more information about the use
2040 # Note: Each tag file must have an unique name (where the name does NOT include
2041 # the path). If a tag file is not located in the directory in which doxygen is
2042 # run, you must also specify the path to the tagfile here.
2046 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2047 # tag file that is based on the input files it reads. See section "Linking to
2048 # external documentation" for more information about the usage of tag files.
2052 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2053 # class index. If set to NO only the inherited external classes will be listed.
2054 # The default value is: NO.
2058 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2059 # the modules index. If set to NO, only the current project's groups will be
2061 # The default value is: YES.
2063 EXTERNAL_GROUPS = YES
2065 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2066 # the related pages index. If set to NO, only the current project's pages will
2068 # The default value is: YES.
2070 EXTERNAL_PAGES = YES
2072 # The PERL_PATH should be the absolute path and name of the perl script
2073 # interpreter (i.e. the result of 'which perl').
2074 # The default file (with absolute path) is: /usr/bin/perl.
2078 #---------------------------------------------------------------------------
2079 # Configuration options related to the dot tool
2080 #---------------------------------------------------------------------------
2082 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2083 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2084 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2085 # disabled, but it is recommended to install and use dot, since it yields more
2087 # The default value is: YES.
2089 CLASS_DIAGRAMS = YES
2091 # You can define message sequence charts within doxygen comments using the \msc
2092 # command. Doxygen will then run the mscgen tool (see:
2093 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2094 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2095 # the mscgen tool resides. If left empty the tool is assumed to be found in the
2096 # default search path.
2100 # You can include diagrams made with dia in doxygen documentation. Doxygen will
2101 # then run dia to produce the diagram and insert it in the documentation. The
2102 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
2103 # If left empty dia is assumed to be found in the default search path.
2107 # If set to YES, the inheritance and collaboration graphs will hide inheritance
2108 # and usage relations if the target is undocumented or is not a class.
2109 # The default value is: YES.
2111 HIDE_UNDOC_RELATIONS = YES
2113 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2114 # available from the path. This tool is part of Graphviz (see:
2115 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2116 # Bell Labs. The other options in this section have no effect if this option is
2118 # The default value is: NO.
2120 HAVE_DOT = @DOXYGEN_USE_DOT@
2122 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2123 # to run in parallel. When set to 0 doxygen will base this on the number of
2124 # processors available in the system. You can set it explicitly to a value
2125 # larger than 0 to get control over the balance between CPU load and processing
2127 # Minimum value: 0, maximum value: 32, default value: 0.
2128 # This tag requires that the tag HAVE_DOT is set to YES.
2132 # When you want a differently looking font n the dot files that doxygen
2133 # generates you can specify the font name using DOT_FONTNAME. You need to make
2134 # sure dot is able to find the font, which can be done by putting it in a
2135 # standard location or by setting the DOTFONTPATH environment variable or by
2136 # setting DOT_FONTPATH to the directory containing the font.
2137 # The default value is: Helvetica.
2138 # This tag requires that the tag HAVE_DOT is set to YES.
2140 DOT_FONTNAME = Helvetica
2142 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2144 # Minimum value: 4, maximum value: 24, default value: 10.
2145 # This tag requires that the tag HAVE_DOT is set to YES.
2149 # By default doxygen will tell dot to use the default font as specified with
2150 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2151 # the path where dot can find it using this tag.
2152 # This tag requires that the tag HAVE_DOT is set to YES.
2156 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2157 # each documented class showing the direct and indirect inheritance relations.
2158 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2159 # The default value is: YES.
2160 # This tag requires that the tag HAVE_DOT is set to YES.
2164 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2165 # graph for each documented class showing the direct and indirect implementation
2166 # dependencies (inheritance, containment, and class references variables) of the
2167 # class with other documented classes.
2168 # The default value is: YES.
2169 # This tag requires that the tag HAVE_DOT is set to YES.
2171 COLLABORATION_GRAPH = YES
2173 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2174 # groups, showing the direct groups dependencies.
2175 # The default value is: YES.
2176 # This tag requires that the tag HAVE_DOT is set to YES.
2180 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2181 # collaboration diagrams in a style similar to the OMG's Unified Modeling
2183 # The default value is: NO.
2184 # This tag requires that the tag HAVE_DOT is set to YES.
2188 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2189 # class node. If there are many fields or methods and many nodes the graph may
2190 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2191 # number of items for each type to make the size more manageable. Set this to 0
2192 # for no limit. Note that the threshold may be exceeded by 50% before the limit
2193 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2194 # but if the number exceeds 15, the total amount of fields shown is limited to
2196 # Minimum value: 0, maximum value: 100, default value: 10.
2197 # This tag requires that the tag HAVE_DOT is set to YES.
2199 UML_LIMIT_NUM_FIELDS = 10
2201 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2202 # collaboration graphs will show the relations between templates and their
2204 # The default value is: NO.
2205 # This tag requires that the tag HAVE_DOT is set to YES.
2207 TEMPLATE_RELATIONS = NO
2209 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2210 # YES then doxygen will generate a graph for each documented file showing the
2211 # direct and indirect include dependencies of the file with other documented
2213 # The default value is: YES.
2214 # This tag requires that the tag HAVE_DOT is set to YES.
2218 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2219 # set to YES then doxygen will generate a graph for each documented file showing
2220 # the direct and indirect include dependencies of the file with other documented
2222 # The default value is: YES.
2223 # This tag requires that the tag HAVE_DOT is set to YES.
2225 INCLUDED_BY_GRAPH = YES
2227 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2228 # dependency graph for every global function or class method.
2230 # Note that enabling this option will significantly increase the time of a run.
2231 # So in most cases it will be better to enable call graphs for selected
2232 # functions only using the \callgraph command.
2233 # The default value is: NO.
2234 # This tag requires that the tag HAVE_DOT is set to YES.
2238 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2239 # dependency graph for every global function or class method.
2241 # Note that enabling this option will significantly increase the time of a run.
2242 # So in most cases it will be better to enable caller graphs for selected
2243 # functions only using the \callergraph command.
2244 # The default value is: NO.
2245 # This tag requires that the tag HAVE_DOT is set to YES.
2249 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2250 # hierarchy of all classes instead of a textual one.
2251 # The default value is: YES.
2252 # This tag requires that the tag HAVE_DOT is set to YES.
2254 GRAPHICAL_HIERARCHY = YES
2256 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2257 # dependencies a directory has on other directories in a graphical way. The
2258 # dependency relations are determined by the #include relations between the
2259 # files in the directories.
2260 # The default value is: YES.
2261 # This tag requires that the tag HAVE_DOT is set to YES.
2263 DIRECTORY_GRAPH = YES
2265 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2267 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2268 # to make the SVG files visible in IE 9+ (other browsers do not have this
2270 # Possible values are: png, jpg, gif and svg.
2271 # The default value is: png.
2272 # This tag requires that the tag HAVE_DOT is set to YES.
2274 DOT_IMAGE_FORMAT = png
2276 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2277 # enable generation of interactive SVG images that allow zooming and panning.
2279 # Note that this requires a modern browser other than Internet Explorer. Tested
2280 # and working are Firefox, Chrome, Safari, and Opera.
2281 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2282 # the SVG files visible. Older versions of IE do not have SVG support.
2283 # The default value is: NO.
2284 # This tag requires that the tag HAVE_DOT is set to YES.
2286 INTERACTIVE_SVG = NO
2288 # The DOT_PATH tag can be used to specify the path where the dot tool can be
2289 # found. If left blank, it is assumed the dot tool can be found in the path.
2290 # This tag requires that the tag HAVE_DOT is set to YES.
2294 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2295 # contain dot files that are included in the documentation (see the \dotfile
2297 # This tag requires that the tag HAVE_DOT is set to YES.
2301 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2302 # contain msc files that are included in the documentation (see the \mscfile
2307 # The DIAFILE_DIRS tag can be used to specify one or more directories that
2308 # contain dia files that are included in the documentation (see the \diafile
2313 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2314 # that will be shown in the graph. If the number of nodes in a graph becomes
2315 # larger than this value, doxygen will truncate the graph, which is visualized
2316 # by representing a node as a red box. Note that doxygen if the number of direct
2317 # children of the root node in a graph is already larger than
2318 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2319 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2320 # Minimum value: 0, maximum value: 10000, default value: 50.
2321 # This tag requires that the tag HAVE_DOT is set to YES.
2323 DOT_GRAPH_MAX_NODES = 50
2325 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2326 # generated by dot. A depth value of 3 means that only nodes reachable from the
2327 # root by following a path via at most 3 edges will be shown. Nodes that lay
2328 # further from the root node will be omitted. Note that setting this option to 1
2329 # or 2 may greatly reduce the computation time needed for large code bases. Also
2330 # note that the size of a graph can be further restricted by
2331 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2332 # Minimum value: 0, maximum value: 1000, default value: 0.
2333 # This tag requires that the tag HAVE_DOT is set to YES.
2335 MAX_DOT_GRAPH_DEPTH = 0
2337 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2338 # background. This is disabled by default, because dot on Windows does not seem
2339 # to support this out of the box.
2341 # Warning: Depending on the platform used, enabling this option may lead to
2342 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2344 # The default value is: NO.
2345 # This tag requires that the tag HAVE_DOT is set to YES.
2347 DOT_TRANSPARENT = NO
2349 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2350 # files in one run (i.e. multiple -o and -T options on the command line). This
2351 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2352 # this, this feature is disabled by default.
2353 # The default value is: NO.
2354 # This tag requires that the tag HAVE_DOT is set to YES.
2356 DOT_MULTI_TARGETS = YES
2358 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2359 # explaining the meaning of the various boxes and arrows in the dot generated
2361 # The default value is: YES.
2362 # This tag requires that the tag HAVE_DOT is set to YES.
2364 GENERATE_LEGEND = YES
2366 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2367 # files that are used to generate the various graphs.
2368 # The default value is: YES.
2369 # This tag requires that the tag HAVE_DOT is set to YES.