Doxyfile.objc.include - OpenGrok cross reference for /external/grpc-grpc/templates/tools/doxygen/Doxyfile.objc.include

Lines Matching +full:set +full:- +full:value
1 ## Populates source files for gRPC Objective-C Doxygen config
5 ## When "internal" is true, documentation for non-public headers
14   for dirpath, dirnames, filenames in os.walk('src/objective-c'):
16       if os.path.splitext(file)[1] == '.md' and dirpath.find('/Pods/') == -1:
36 # TAG = value [value, ...]
38 # TAG += value [value, ...]
41 #---------------------------------------------------------------------------
43 #---------------------------------------------------------------------------
46 # that follow. The default is UTF-8 which is also the encoding used for all text
50 # The default value is: UTF-8.
52 DOXYFILE_ENCODING      = UTF-8
55 # double-quotes, unless you are using Doxywizard) that should identify the
58 # The default value is: My Project.
60 PROJECT_NAME           = "GRPC Objective-C"
88 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
94 # The default value is: NO.
98 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
99 # characters to appear in the names of generated files. If set to NO, non-ASCII
102 # The default value is: NO.
110 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
112 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
113 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
115 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
117 # The default value is: English.
121 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
123 # documentation (similar to Javadoc). Set to NO to disable this.
124 # The default value is: YES.
128 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
131 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
133 # The default value is: YES.
137 # This tag implements a quasi-intelligent brief description abbreviator that is
141 # text. Otherwise, the brief description is used as-is. If left blank, the
148 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
151 # The default value is: NO.
155 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
159 # The default value is: NO.
163 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
164 # before files name in the file list and in the header files. If set to NO the
166 # The default value is: YES.
170 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
171 # Stripping is only done if one of the specified strings matches the left-hand
178 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
182 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
187 # using the -I flag.
191 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
193 # support long names like on DOS, Mac, or CD-ROM.
194 # The default value is: NO.
198 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
199 # first line (until the first dot) of a Javadoc-style comment as the brief
200 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
203 # The default value is: NO.
207 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
208 # line (until the first dot) of a Qt-style comment as the brief description. If
209 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
211 # The default value is: NO.
215 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
216 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
218 # to treat a multi-line C++ comment block as a detailed description. Set this
223 # The default value is: NO.
227 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
228 # documentation from any documented member that it re-implements.
229 # The default value is: YES.
233 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
234 # page for each member. If set to NO, the documentation of a member will be part
236 # The default value is: NO.
240 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
241 # uses this value to replace tabs by spaces in code fragments.
242 # Minimum value: 1, maximum value: 16, default value: 4.
248 # name=value
252 # documentation, which will result in a user-defined paragraph with heading
253 # "Side Effects:". You can put \n's in the value part of an alias to insert
258 # This tag can be used to specify a number of word-keyword mappings (TCL only).
259 # A mapping has the form "name=value". For example adding "class=itcl::class"
264 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
268 # The default value is: NO.
272 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
276 # The default value is: NO.
280 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
282 # The default value is: NO.
286 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
288 # The default value is: NO.
294 # extension. Doxygen has a built-in mapping, but you can override or extend it
297 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
306 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
311 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
317 # The default value is: YES.
325 # The default value is: YES.
330 # to include (a tag file for) the STL sources as input, then you should set this
335 # The default value is: NO.
339 # If you use Microsoft's C++/CLI language, you should set this option to YES to
341 # The default value is: NO.
345 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
349 # The default value is: NO.
355 # doxygen to replace the get and set methods by a property in the documentation.
358 # should set this option to NO.
359 # The default value is: YES.
364 # tag is set to YES then doxygen will reuse the documentation of the first
367 # The default value is: NO.
371 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
373 # type (e.g. under the Public Functions section). Set it to NO to prevent
376 # The default value is: YES.
380 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
387 # The default value is: NO.
391 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
394 # namespace, or group documentation), provided this scope is documented. If set
397 # The default value is: NO.
408 # The default value is: NO.
412 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
415 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
421 # Minimum value: 0, maximum value: 9, default value: 0.
425 #---------------------------------------------------------------------------
427 #---------------------------------------------------------------------------
429 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
432 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
434 # normally produced when WARNINGS is set to YES.
435 # The default value is: NO.
439 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
441 # The default value is: NO.
445 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
447 # The default value is: NO.
451 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
453 # The default value is: NO.
457 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
458 # locally in source files will be included in the documentation. If set to NO,
461 # The default value is: YES.
465 # This flag is only useful for Objective-C code. If set to YES, local methods,
467 # included in the documentation. If set to NO, only methods in the interface are
469 # The default value is: NO.
473 # If this flag is set to YES, the members of anonymous namespaces will be
478 # The default value is: NO.
482 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
483 # undocumented members inside documented classes or files. If set to NO these
486 # The default value is: NO.
490 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
491 # undocumented classes that are normally visible in the class hierarchy. If set
494 # The default value is: NO.
498 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
499 # (class|struct|union) declarations. If set to NO, these declarations will be
501 # The default value is: NO.
505 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
506 # documentation blocks found inside the body of a function. If set to NO, these
508 # The default value is: NO.
513 # \internal command is included. If the tag is set to NO then the documentation
514 # will be excluded. Set it to YES to include the internal documentation.
515 # The default value is: NO.
519 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
520 # names in lower-case letters. If set to YES, upper-case letters are also
523 # and Mac users are advised to set this option to NO.
524 # The default value is: system dependent.
528 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
529 # their full class and namespace scopes in the documentation. If set to YES, the
531 # The default value is: NO.
535 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
536 # append additional text to a page's title, such as Class Reference. If set to
538 # The default value is: NO.
542 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
544 # The default value is: YES.
548 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
551 # The default value is: NO.
555 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
557 # The default value is: NO.
561 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
563 # The default value is: YES.
567 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
569 # name. If set to NO, the members will appear in declaration order.
570 # The default value is: YES.
574 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
576 # name. If set to NO, the members will appear in declaration order. Note that
578 # The default value is: NO.
582 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
584 # destructors are listed first. If set to NO the constructors will appear in the
586 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
588 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
590 # The default value is: NO.
594 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
595 # of group names into alphabetical order. If set to NO the group names will
597 # The default value is: NO.
601 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
602 # fully-qualified names, including namespaces. If set to NO, the class list will
604 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
607 # The default value is: NO.
617 # The default value is: NO.
623 # The default value is: YES.
629 # The default value is: YES.
635 # The default value is: YES.
642 # The default value is: YES.
653 # initial value of a variable or macro / define can have for it to appear in the
655 # it will be hidden. Use a value of 0 to hide initializers completely. The
656 # appearance of the value of individual variables and macros / defines can be
659 # Minimum value: 0, maximum value: 10000, default value: 30.
663 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
664 # the bottom of the documentation of classes and structs. If set to YES, the
666 # The default value is: YES.
670 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
673 # The default value is: YES.
677 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
680 # The default value is: YES.
687 # popen()) the command command input-file, where command is the value of the
688 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
697 # that represents doxygen's defaults, run doxygen with the -l option. You can
717 #---------------------------------------------------------------------------
719 #---------------------------------------------------------------------------
722 # standard output by doxygen. If QUIET is set to YES this implies that the
724 # The default value is: NO.
729 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
733 # The default value is: YES.
737 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
738 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
740 # The default value is: YES.
744 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
748 # The default value is: YES.
754 # value. If set to NO, doxygen will only warn about wrong or incomplete
756 # The default value is: NO.
766 # The default value is: $file:$line: $text.
776 #---------------------------------------------------------------------------
778 #---------------------------------------------------------------------------
787     ' \\\n'.join(sorted(set(
789 …glob.glob('src/objective-c/GRPCClient/*.h') if not internal else glob_recursive('src/objective-c/G…
790             glob.glob('src/objective-c/ProtoRPC/*.h'),
791 …glob.glob('src/objective-c/RxLibrary/*.h') if not internal else glob_recursive('src/objective-c/Rx…
797 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
801 # The default value is: UTF-8.
803 INPUT_ENCODING         = UTF-8
805 # If the value of the INPUT tag contains directories, you can use the
807 # *.h) to filter out the source-files in the directories. If left blank the
818 # The default value is: NO.
834 # The default value is: NO.
838 # If the value of the INPUT tag contains directories, you can use the
864 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
866 # *.h) to filter out the source-files in the directories. If left blank all
871 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
873 # irrespective of the value of the RECURSIVE tag.
874 # The default value is: NO.
888 # <filter> <input-file>
890 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
910 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
912 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
913 # The default value is: NO.
921 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
932 #---------------------------------------------------------------------------
934 #---------------------------------------------------------------------------
936 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
937 # generated. Documented entities will be cross-referenced with these sources.
940 # also VERBATIM_HEADERS is set to NO.
941 # The default value is: NO.
947 # The default value is: NO.
954 # The default value is: YES.
958 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
960 # The default value is: NO.
964 # If the REFERENCES_RELATION tag is set to YES then for each documented function
966 # The default value is: NO.
970 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
974 # The default value is: YES.
983 # The default value is: YES.
984 # This tag requires that the tag SOURCE_BROWSER is set to YES.
988 # If the USE_HTAGS tag is set to YES then the references to source code will
989 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
995 # - Install the latest version of global
996 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
997 # - Make sure the INPUT points to the root of the source tree
998 # - Run doxygen as normal
1005 # The default value is: NO.
1006 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1010 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1012 # specified. Set to NO to disable this.
1014 # The default value is: YES.
1018 #---------------------------------------------------------------------------
1020 #---------------------------------------------------------------------------
1022 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1025 # The default value is: YES.
1031 # Minimum value: 1, maximum value: 20, default value: 5.
1032 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1040 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1044 #---------------------------------------------------------------------------
1046 #---------------------------------------------------------------------------
1048 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1049 # The default value is: YES.
1054 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1057 # This tag requires that the tag GENERATE_HTML is set to YES.
1063 # The default value is: .html.
1064 # This tag requires that the tag GENERATE_HTML is set to YES.
1068 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1076 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1084 # This tag requires that the tag GENERATE_HTML is set to YES.
1088 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1094 # This tag requires that the tag GENERATE_HTML is set to YES.
1098 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1099 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1106 # This tag requires that the tag GENERATE_HTML is set to YES.
1110 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1119 # This tag requires that the tag GENERATE_HTML is set to YES.
1128 # files will be copied as-is; there are no commands or markers available.
1129 # This tag requires that the tag GENERATE_HTML is set to YES.
1136 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1139 # Minimum value: 0, maximum value: 359, default value: 220.
1140 # This tag requires that the tag GENERATE_HTML is set to YES.
1145 # in the HTML output. For a value of 0 the output will use grayscales only. A
1146 # value of 255 will produce the most vivid colors.
1147 # Minimum value: 0, maximum value: 255, default value: 100.
1148 # This tag requires that the tag GENERATE_HTML is set to YES.
1155 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1156 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1158 # Minimum value: 40, maximum value: 240, default value: 80.
1159 # This tag requires that the tag GENERATE_HTML is set to YES.
1163 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1166 # The default value is: YES.
1167 # This tag requires that the tag GENERATE_HTML is set to YES.
1171 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1174 # The default value is: NO.
1175 # This tag requires that the tag GENERATE_HTML is set to YES.
1184 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1187 # Minimum value: 0, maximum value: 9999, default value: 100.
1188 # This tag requires that the tag GENERATE_HTML is set to YES.
1192 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1195 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1201 # The default value is: NO.
1202 # This tag requires that the tag GENERATE_HTML is set to YES.
1209 # The default value is: Doxygen generated docs.
1210 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1215 # set bundle. This should be a reverse domain-name style string, e.g.
1217 # The default value is: org.doxygen.Project.
1218 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1223 # the documentation publisher. This should be a reverse domain-name style
1225 # The default value is: org.doxygen.Publisher.
1226 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1231 # The default value is: Publisher.
1232 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1236 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1239 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1249 # The default value is: NO.
1250 # This tag requires that the tag GENERATE_HTML is set to YES.
1257 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1262 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1265 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1271 # The default value is: NO.
1272 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1278 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1285 # The default value is: NO.
1286 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1290 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1292 # The default value is: NO.
1293 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1297 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1298 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1301 # The default value is: NO.
1302 # This tag requires that the tag GENERATE_HTML is set to YES.
1309 # This tag requires that the tag GENERATE_QHP is set to YES.
1315 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1316 # The default value is: org.doxygen.Project.
1317 # This tag requires that the tag GENERATE_QHP is set to YES.
1323 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1325 # The default value is: doc.
1326 # This tag requires that the tag GENERATE_QHP is set to YES.
1330 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1332 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1334 # This tag requires that the tag GENERATE_QHP is set to YES.
1340 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1342 # This tag requires that the tag GENERATE_QHP is set to YES.
1348 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1349 # This tag requires that the tag GENERATE_QHP is set to YES.
1354 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1356 # This tag requires that the tag GENERATE_QHP is set to YES.
1360 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1365 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1367 # The default value is: NO.
1368 # This tag requires that the tag GENERATE_HTML is set to YES.
1374 # name. Each documentation set should have its own identifier.
1375 # The default value is: org.doxygen.Project.
1376 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1383 # of each HTML page. A value of NO enables the index and the value YES disables
1385 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1386 # The default value is: NO.
1387 # This tag requires that the tag GENERATE_HTML is set to YES.
1391 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1393 # value is set to YES, a side panel will be generated containing a tree-like
1398 # further fine-tune the look of the index. As an example, the default style
1403 # The default value is: NO.
1404 # This tag requires that the tag GENERATE_HTML is set to YES.
1408 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1411 # Note that a value of 0 will completely suppress the enum values from appearing
1413 # Minimum value: 0, maximum value: 20, default value: 4.
1414 # This tag requires that the tag GENERATE_HTML is set to YES.
1419 # to set the initial width (in pixels) of the frame in which the tree is shown.
1420 # Minimum value: 0, maximum value: 1500, default value: 250.
1421 # This tag requires that the tag GENERATE_HTML is set to YES.
1425 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1427 # The default value is: NO.
1428 # This tag requires that the tag GENERATE_HTML is set to YES.
1436 # Minimum value: 8, maximum value: 50, default value: 10.
1437 # This tag requires that the tag GENERATE_HTML is set to YES.
1447 # The default value is: YES.
1448 # This tag requires that the tag GENERATE_HTML is set to YES.
1454 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1458 # The default value is: NO.
1459 # This tag requires that the tag GENERATE_HTML is set to YES.
1463 # When MathJax is enabled you can set the default output format to be used for
1466 # Possible values are: HTML-CSS (which is slower, but has the best
1468 # The default value is: HTML-CSS.
1469 # This tag requires that the tag USE_MATHJAX is set to YES.
1471 MATHJAX_FORMAT         = HTML-CSS
1477 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1481 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1482 # This tag requires that the tag USE_MATHJAX is set to YES.
1489 # This tag requires that the tag USE_MATHJAX is set to YES.
1497 # This tag requires that the tag USE_MATHJAX is set to YES.
1517 # The default value is: YES.
1518 # This tag requires that the tag GENERATE_HTML is set to YES.
1529 # The default value is: NO.
1530 # This tag requires that the tag SEARCHENGINE is set to YES.
1545 # The default value is: NO.
1546 # This tag requires that the tag SEARCHENGINE is set to YES.
1557 # This tag requires that the tag SEARCHENGINE is set to YES.
1565 # This tag requires that the tag SEARCHENGINE is set to YES.
1573 # This tag requires that the tag SEARCHENGINE is set to YES.
1580 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1583 # This tag requires that the tag SEARCHENGINE is set to YES.
1587 #---------------------------------------------------------------------------
1589 #---------------------------------------------------------------------------
1591 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1592 # The default value is: YES.
1597 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1600 # This tag requires that the tag GENERATE_LATEX is set to YES.
1611 # This tag requires that the tag GENERATE_LATEX is set to YES.
1618 # This tag requires that the tag GENERATE_LATEX is set to YES.
1622 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1625 # The default value is: NO.
1626 # This tag requires that the tag GENERATE_LATEX is set to YES.
1630 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1634 # The default value is: a4.
1635 # This tag requires that the tag GENERATE_LATEX is set to YES.
1644 # This tag requires that the tag GENERATE_LATEX is set to YES.
1654 # Note: Only use a user-defined header if you know what you are doing! The
1660 # This tag requires that the tag GENERATE_LATEX is set to YES.
1670 # Note: Only use a user-defined footer if you know what you are doing!
1671 # This tag requires that the tag GENERATE_LATEX is set to YES.
1675 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1682 # This tag requires that the tag GENERATE_LATEX is set to YES.
1688 # directory. Note that the files will be copied as-is; there are no commands or
1690 # This tag requires that the tag GENERATE_LATEX is set to YES.
1694 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1698 # The default value is: YES.
1699 # This tag requires that the tag GENERATE_LATEX is set to YES.
1703 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1704 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1706 # The default value is: YES.
1707 # This tag requires that the tag GENERATE_LATEX is set to YES.
1711 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1715 # The default value is: NO.
1716 # This tag requires that the tag GENERATE_LATEX is set to YES.
1720 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1722 # The default value is: NO.
1723 # This tag requires that the tag GENERATE_LATEX is set to YES.
1727 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1732 # The default value is: NO.
1733 # This tag requires that the tag GENERATE_LATEX is set to YES.
1740 # The default value is: plain.
1741 # This tag requires that the tag GENERATE_LATEX is set to YES.
1745 #---------------------------------------------------------------------------
1747 #---------------------------------------------------------------------------
1749 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1752 # The default value is: NO.
1757 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1760 # This tag requires that the tag GENERATE_RTF is set to YES.
1764 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1767 # The default value is: NO.
1768 # This tag requires that the tag GENERATE_RTF is set to YES.
1772 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1779 # The default value is: NO.
1780 # This tag requires that the tag GENERATE_RTF is set to YES.
1786 # missing definitions are set to their default value.
1790 # This tag requires that the tag GENERATE_RTF is set to YES.
1794 # Set optional variables used in the generation of an RTF document. Syntax is
1796 # using doxygen -e rtf extensionFile.
1797 # This tag requires that the tag GENERATE_RTF is set to YES.
1801 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1806 # The default value is: NO.
1807 # This tag requires that the tag GENERATE_RTF is set to YES.
1811 #---------------------------------------------------------------------------
1813 #---------------------------------------------------------------------------
1815 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1817 # The default value is: NO.
1822 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1826 # This tag requires that the tag GENERATE_MAN is set to YES.
1834 # The default value is: .3.
1835 # This tag requires that the tag GENERATE_MAN is set to YES.
1842 # This tag requires that the tag GENERATE_MAN is set to YES.
1846 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1850 # The default value is: NO.
1851 # This tag requires that the tag GENERATE_MAN is set to YES.
1855 #---------------------------------------------------------------------------
1857 #---------------------------------------------------------------------------
1859 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1861 # The default value is: NO.
1866 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1869 # This tag requires that the tag GENERATE_XML is set to YES.
1873 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1874 # listings (including syntax highlighting and cross-referencing information) to
1877 # The default value is: YES.
1878 # This tag requires that the tag GENERATE_XML is set to YES.
1882 #---------------------------------------------------------------------------
1884 #---------------------------------------------------------------------------
1886 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1888 # The default value is: NO.
1893 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1896 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1900 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1901 # program listings (including syntax highlighting and cross-referencing
1904 # The default value is: NO.
1905 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1909 #---------------------------------------------------------------------------
1911 #---------------------------------------------------------------------------
1913 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1917 # The default value is: NO.
1921 #---------------------------------------------------------------------------
1923 #---------------------------------------------------------------------------
1925 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1929 # The default value is: NO.
1933 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1936 # The default value is: NO.
1937 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1941 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1943 # understand what is going on. On the other hand, if this tag is set to NO, the
1946 # The default value is: YES.
1947 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1955 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1959 #---------------------------------------------------------------------------
1961 #---------------------------------------------------------------------------
1963 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1964 # C-preprocessor directives found in the sources and include files.
1965 # The default value is: YES.
1969 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1970 # in the source code. If set to NO, only conditional compilation will be
1973 # The default value is: NO.
1974 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1978 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
1981 # The default value is: NO.
1982 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1986 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
1988 # The default value is: YES.
1989 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1996 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2001 # patterns (like *.h and *.hpp) to filter out the header-files in the
2004 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2009 # defined before the preprocessor is started (similar to the -D option of e.g.
2014 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2018 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2023 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2027 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2028 # remove all references to function-like macros that are alone on a line, have
2030 # are typically used for boiler-plate code, and will confuse the parser if not
2032 # The default value is: YES.
2033 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2037 #---------------------------------------------------------------------------
2039 #---------------------------------------------------------------------------
2062 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2063 # the class index. If set to NO, only the inherited external classes will be
2065 # The default value is: NO.
2069 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2070 # in the modules index. If set to NO, only the current project's groups will be
2072 # The default value is: YES.
2076 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2077 # the related pages index. If set to NO, only the current project's pages will
2079 # The default value is: YES.
2089 #---------------------------------------------------------------------------
2091 #---------------------------------------------------------------------------
2093 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2098 # The default value is: YES.
2118 # If set to YES the inheritance and collaboration graphs will hide inheritance
2120 # The default value is: YES.
2124 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2128 # set to NO
2129 # The default value is: NO.
2134 # to run in parallel. When set to 0 doxygen will base this on the number of
2135 # processors available in the system. You can set it explicitly to a value
2138 # Minimum value: 0, maximum value: 32, default value: 0.
2139 # This tag requires that the tag HAVE_DOT is set to YES.
2148 # The default value is: Helvetica.
2149 # This tag requires that the tag HAVE_DOT is set to YES.
2153 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2155 # Minimum value: 4, maximum value: 24, default value: 10.
2156 # This tag requires that the tag HAVE_DOT is set to YES.
2161 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2163 # This tag requires that the tag HAVE_DOT is set to YES.
2167 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2170 # The default value is: YES.
2171 # This tag requires that the tag HAVE_DOT is set to YES.
2175 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2179 # The default value is: YES.
2180 # This tag requires that the tag HAVE_DOT is set to YES.
2184 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2186 # The default value is: YES.
2187 # This tag requires that the tag HAVE_DOT is set to YES.
2191 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2194 # The default value is: NO.
2195 # This tag requires that the tag HAVE_DOT is set to YES.
2202 # number of items for each type to make the size more manageable. Set this to 0
2204 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2207 # Minimum value: 0, maximum value: 100, default value: 10.
2208 # This tag requires that the tag HAVE_DOT is set to YES.
2212 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2215 # The default value is: NO.
2216 # This tag requires that the tag HAVE_DOT is set to YES.
2220 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2224 # The default value is: YES.
2225 # This tag requires that the tag HAVE_DOT is set to YES.
2230 # set to YES then doxygen will generate a graph for each documented file showing
2233 # The default value is: YES.
2234 # This tag requires that the tag HAVE_DOT is set to YES.
2238 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2244 # The default value is: NO.
2245 # This tag requires that the tag HAVE_DOT is set to YES.
2249 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2255 # The default value is: NO.
2256 # This tag requires that the tag HAVE_DOT is set to YES.
2260 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2262 # The default value is: YES.
2263 # This tag requires that the tag HAVE_DOT is set to YES.
2267 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2271 # The default value is: YES.
2272 # This tag requires that the tag HAVE_DOT is set to YES.
2276 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2278 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2282 # The default value is: png.
2283 # This tag requires that the tag HAVE_DOT is set to YES.
2287 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2292 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2294 # The default value is: NO.
2295 # This tag requires that the tag HAVE_DOT is set to YES.
2301 # This tag requires that the tag HAVE_DOT is set to YES.
2308 # This tag requires that the tag HAVE_DOT is set to YES.
2337 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2339 # larger than this value, doxygen will truncate the graph, which is visualized
2344 # Minimum value: 0, maximum value: 10000, default value: 50.
2345 # This tag requires that the tag HAVE_DOT is set to YES.
2349 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2350 # generated by dot. A depth value of 3 means that only nodes reachable from the
2356 # Minimum value: 0, maximum value: 1000, default value: 0.
2357 # This tag requires that the tag HAVE_DOT is set to YES.
2361 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2366 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2368 # The default value is: NO.
2369 # This tag requires that the tag HAVE_DOT is set to YES.
2373 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2374 # files in one run (i.e. multiple -o and -T options on the command line). This
2377 # The default value is: NO.
2378 # This tag requires that the tag HAVE_DOT is set to YES.
2382 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2385 # The default value is: YES.
2386 # This tag requires that the tag HAVE_DOT is set to YES.
2390 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2392 # The default value is: YES.
2393 # This tag requires that the tag HAVE_DOT is set to YES.