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

Lines Matching +full:set +full:- +full:value
13 # TAG = value [value, ...]
15 # TAG += value [value, ...]
18 #---------------------------------------------------------------------------
20 #---------------------------------------------------------------------------
23 # that follow. The default is UTF-8 which is also the encoding used for all text
27 # The default value is: UTF-8.
29 DOXYFILE_ENCODING      = UTF-8
32 # double-quotes, unless you are using Doxywizard) that should identify the
35 # The default value is: My Project.
37 PROJECT_NAME           = "GRPC Objective-C"
65 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
71 # The default value is: NO.
75 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
76 # characters to appear in the names of generated files. If set to NO, non-ASCII
79 # The default value is: NO.
87 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
89 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
90 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
92 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
94 # The default value is: English.
98 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
100 # documentation (similar to Javadoc). Set to NO to disable this.
101 # The default value is: YES.
105 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
108 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
110 # The default value is: YES.
114 # This tag implements a quasi-intelligent brief description abbreviator that is
118 # text. Otherwise, the brief description is used as-is. If left blank, the
125 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
128 # The default value is: NO.
132 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
136 # The default value is: NO.
140 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
141 # before files name in the file list and in the header files. If set to NO the
143 # The default value is: YES.
147 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
148 # Stripping is only done if one of the specified strings matches the left-hand
155 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
159 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
164 # using the -I flag.
168 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
170 # support long names like on DOS, Mac, or CD-ROM.
171 # The default value is: NO.
175 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
176 # first line (until the first dot) of a Javadoc-style comment as the brief
177 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
180 # The default value is: NO.
184 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
185 # line (until the first dot) of a Qt-style comment as the brief description. If
186 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
188 # The default value is: NO.
192 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
193 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
195 # to treat a multi-line C++ comment block as a detailed description. Set this
200 # The default value is: NO.
204 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
205 # documentation from any documented member that it re-implements.
206 # The default value is: YES.
210 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
211 # page for each member. If set to NO, the documentation of a member will be part
213 # The default value is: NO.
217 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
218 # uses this value to replace tabs by spaces in code fragments.
219 # Minimum value: 1, maximum value: 16, default value: 4.
225 # name=value
229 # documentation, which will result in a user-defined paragraph with heading
230 # "Side Effects:". You can put \n's in the value part of an alias to insert
235 # This tag can be used to specify a number of word-keyword mappings (TCL only).
236 # A mapping has the form "name=value". For example adding "class=itcl::class"
241 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
245 # The default value is: NO.
249 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
253 # The default value is: NO.
257 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
259 # The default value is: NO.
263 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
265 # The default value is: NO.
271 # extension. Doxygen has a built-in mapping, but you can override or extend it
274 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
283 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
288 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
294 # The default value is: YES.
302 # The default value is: YES.
307 # to include (a tag file for) the STL sources as input, then you should set this
312 # The default value is: NO.
316 # If you use Microsoft's C++/CLI language, you should set this option to YES to
318 # The default value is: NO.
322 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
326 # The default value is: NO.
332 # doxygen to replace the get and set methods by a property in the documentation.
335 # should set this option to NO.
336 # The default value is: YES.
341 # tag is set to YES then doxygen will reuse the documentation of the first
344 # The default value is: NO.
348 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
350 # type (e.g. under the Public Functions section). Set it to NO to prevent
353 # The default value is: YES.
357 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
364 # The default value is: NO.
368 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
371 # namespace, or group documentation), provided this scope is documented. If set
374 # The default value is: NO.
385 # The default value is: NO.
389 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
392 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
398 # Minimum value: 0, maximum value: 9, default value: 0.
402 #---------------------------------------------------------------------------
404 #---------------------------------------------------------------------------
406 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
409 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
411 # normally produced when WARNINGS is set to YES.
412 # The default value is: NO.
416 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
418 # The default value is: NO.
422 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
424 # The default value is: NO.
428 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
430 # The default value is: NO.
434 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
435 # locally in source files will be included in the documentation. If set to NO,
438 # The default value is: YES.
442 # This flag is only useful for Objective-C code. If set to YES, local methods,
444 # included in the documentation. If set to NO, only methods in the interface are
446 # The default value is: NO.
450 # If this flag is set to YES, the members of anonymous namespaces will be
455 # The default value is: NO.
459 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
460 # undocumented members inside documented classes or files. If set to NO these
463 # The default value is: NO.
467 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
468 # undocumented classes that are normally visible in the class hierarchy. If set
471 # The default value is: NO.
475 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
476 # (class|struct|union) declarations. If set to NO, these declarations will be
478 # The default value is: NO.
482 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
483 # documentation blocks found inside the body of a function. If set to NO, these
485 # The default value is: NO.
490 # \internal command is included. If the tag is set to NO then the documentation
491 # will be excluded. Set it to YES to include the internal documentation.
492 # The default value is: NO.
496 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
497 # names in lower-case letters. If set to YES, upper-case letters are also
500 # and Mac users are advised to set this option to NO.
501 # The default value is: system dependent.
505 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
506 # their full class and namespace scopes in the documentation. If set to YES, the
508 # The default value is: NO.
512 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
513 # append additional text to a page's title, such as Class Reference. If set to
515 # The default value is: NO.
519 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
521 # The default value is: YES.
525 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
528 # The default value is: NO.
532 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
534 # The default value is: NO.
538 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
540 # The default value is: YES.
544 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
546 # name. If set to NO, the members will appear in declaration order.
547 # The default value is: YES.
551 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
553 # name. If set to NO, the members will appear in declaration order. Note that
555 # The default value is: NO.
559 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
561 # destructors are listed first. If set to NO the constructors will appear in the
563 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
565 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
567 # The default value is: NO.
571 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
572 # of group names into alphabetical order. If set to NO the group names will
574 # The default value is: NO.
578 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
579 # fully-qualified names, including namespaces. If set to NO, the class list will
581 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
584 # The default value is: NO.
594 # The default value is: NO.
600 # The default value is: YES.
606 # The default value is: YES.
612 # The default value is: YES.
619 # The default value is: YES.
630 # initial value of a variable or macro / define can have for it to appear in the
632 # it will be hidden. Use a value of 0 to hide initializers completely. The
633 # appearance of the value of individual variables and macros / defines can be
636 # Minimum value: 0, maximum value: 10000, default value: 30.
640 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
641 # the bottom of the documentation of classes and structs. If set to YES, the
643 # The default value is: YES.
647 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
650 # The default value is: YES.
654 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
657 # The default value is: YES.
664 # popen()) the command command input-file, where command is the value of the
665 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
674 # that represents doxygen's defaults, run doxygen with the -l option. You can
694 #---------------------------------------------------------------------------
696 #---------------------------------------------------------------------------
699 # standard output by doxygen. If QUIET is set to YES this implies that the
701 # The default value is: NO.
706 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
710 # The default value is: YES.
714 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
715 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
717 # The default value is: YES.
721 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
725 # The default value is: YES.
731 # value. If set to NO, doxygen will only warn about wrong or incomplete
733 # The default value is: NO.
743 # The default value is: $file:$line: $text.
753 #---------------------------------------------------------------------------
755 #---------------------------------------------------------------------------
763 INPUT                  = doc/PROTOCOL-HTTP2.md \
764 doc/PROTOCOL-WEB.md \
766 doc/binary-logging.md \
767 doc/c-style-guide.md \
771 doc/connection-backoff-interop-test-description.md \
772 doc/connection-backoff.md \
773 doc/connectivity-semantics-and-api.md \
774 doc/cpp-style-guide.md \
781 doc/health-checking.md \
782 doc/http-grpc-status-mapping.md \
783 doc/http2-interop-test-descriptions.md \
785 doc/interop-test-descriptions.md \
787 doc/load-balancing.md \
789 doc/qos-dscp.md \
791 doc/server-reflection.md \
795 doc/ssl-performance.md \
800 doc/wait-for-ready.md \
802 doc/xds-test-descriptions.md \
803 src/objective-c/GRPCClient/GRPCCall+ChannelArg.h \
804 src/objective-c/GRPCClient/GRPCCall+ChannelCredentials.h \
805 src/objective-c/GRPCClient/GRPCCall+Cronet.h \
806 src/objective-c/GRPCClient/GRPCCall+GID.h \
807 src/objective-c/GRPCClient/GRPCCall+Interceptor.h \
808 src/objective-c/GRPCClient/GRPCCall+OAuth2.h \
809 src/objective-c/GRPCClient/GRPCCall+Tests.h \
810 src/objective-c/GRPCClient/GRPCCall.h \
811 src/objective-c/GRPCClient/GRPCCallLegacy.h \
812 src/objective-c/GRPCClient/GRPCCallOptions.h \
813 src/objective-c/GRPCClient/GRPCDispatchable.h \
814 src/objective-c/GRPCClient/GRPCInterceptor.h \
815 src/objective-c/GRPCClient/GRPCTransport.h \
816 src/objective-c/GRPCClient/GRPCTypes.h \
817 src/objective-c/GRPCClient/README.md \
818 src/objective-c/GRPCClient/version.h \
819 src/objective-c/NetworkTransitionBehavior.md \
820 src/objective-c/ProtoRPC/ProtoMethod.h \
821 src/objective-c/ProtoRPC/ProtoRPC.h \
822 src/objective-c/ProtoRPC/ProtoRPCLegacy.h \
823 src/objective-c/ProtoRPC/ProtoService.h \
824 src/objective-c/ProtoRPC/ProtoServiceLegacy.h \
825 src/objective-c/README-CFSTREAM.md \
826 src/objective-c/README.md \
827 src/objective-c/RxLibrary/GRXBufferedPipe.h \
828 src/objective-c/RxLibrary/GRXConcurrentWriteable.h \
829 src/objective-c/RxLibrary/GRXForwardingWriter.h \
830 src/objective-c/RxLibrary/GRXImmediateSingleWriter.h \
831 src/objective-c/RxLibrary/GRXImmediateWriter.h \
832 src/objective-c/RxLibrary/GRXMappingWriter.h \
833 src/objective-c/RxLibrary/GRXWriteable.h \
834 src/objective-c/RxLibrary/GRXWriter+Immediate.h \
835 src/objective-c/RxLibrary/GRXWriter+Transformations.h \
836 src/objective-c/RxLibrary/GRXWriter.h \
837 src/objective-c/RxLibrary/NSEnumerator+GRXUtil.h \
838 src/objective-c/RxLibrary/README.md \
839 src/objective-c/examples/Sample/README.md \
840 src/objective-c/tests/Connectivity/README.md
843 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
847 # The default value is: UTF-8.
849 INPUT_ENCODING         = UTF-8
851 # If the value of the INPUT tag contains directories, you can use the
853 # *.h) to filter out the source-files in the directories. If left blank the
864 # The default value is: NO.
880 # The default value is: NO.
884 # If the value of the INPUT tag contains directories, you can use the
910 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
912 # *.h) to filter out the source-files in the directories. If left blank all
917 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
919 # irrespective of the value of the RECURSIVE tag.
920 # The default value is: NO.
934 # <filter> <input-file>
936 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
956 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
958 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
959 # The default value is: NO.
967 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
978 #---------------------------------------------------------------------------
980 #---------------------------------------------------------------------------
982 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
983 # generated. Documented entities will be cross-referenced with these sources.
986 # also VERBATIM_HEADERS is set to NO.
987 # The default value is: NO.
993 # The default value is: NO.
1000 # The default value is: YES.
1004 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1006 # The default value is: NO.
1010 # If the REFERENCES_RELATION tag is set to YES then for each documented function
1012 # The default value is: NO.
1016 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1020 # The default value is: YES.
1029 # The default value is: YES.
1030 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1034 # If the USE_HTAGS tag is set to YES then the references to source code will
1035 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
1041 # - Install the latest version of global
1042 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1043 # - Make sure the INPUT points to the root of the source tree
1044 # - Run doxygen as normal
1051 # The default value is: NO.
1052 # This tag requires that the tag SOURCE_BROWSER is set to YES.
1056 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1058 # specified. Set to NO to disable this.
1060 # The default value is: YES.
1064 #---------------------------------------------------------------------------
1066 #---------------------------------------------------------------------------
1068 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1071 # The default value is: YES.
1077 # Minimum value: 1, maximum value: 20, default value: 5.
1078 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1086 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1090 #---------------------------------------------------------------------------
1092 #---------------------------------------------------------------------------
1094 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1095 # The default value is: YES.
1100 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1103 # This tag requires that the tag GENERATE_HTML is set to YES.
1109 # The default value is: .html.
1110 # This tag requires that the tag GENERATE_HTML is set to YES.
1114 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1122 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
1130 # This tag requires that the tag GENERATE_HTML is set to YES.
1134 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1140 # This tag requires that the tag GENERATE_HTML is set to YES.
1144 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1145 # sheet that is used by each HTML page. It can be used to fine-tune the look of
1152 # This tag requires that the tag GENERATE_HTML is set to YES.
1156 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1165 # This tag requires that the tag GENERATE_HTML is set to YES.
1174 # files will be copied as-is; there are no commands or markers available.
1175 # This tag requires that the tag GENERATE_HTML is set to YES.
1182 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1185 # Minimum value: 0, maximum value: 359, default value: 220.
1186 # This tag requires that the tag GENERATE_HTML is set to YES.
1191 # in the HTML output. For a value of 0 the output will use grayscales only. A
1192 # value of 255 will produce the most vivid colors.
1193 # Minimum value: 0, maximum value: 255, default value: 100.
1194 # This tag requires that the tag GENERATE_HTML is set to YES.
1201 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
1202 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1204 # Minimum value: 40, maximum value: 240, default value: 80.
1205 # This tag requires that the tag GENERATE_HTML is set to YES.
1209 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1212 # The default value is: YES.
1213 # This tag requires that the tag GENERATE_HTML is set to YES.
1217 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1220 # The default value is: NO.
1221 # This tag requires that the tag GENERATE_HTML is set to YES.
1230 # entries 1 will produce a full collapsed tree by default. 0 is a special value
1233 # Minimum value: 0, maximum value: 9999, default value: 100.
1234 # This tag requires that the tag GENERATE_HTML is set to YES.
1238 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1241 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1247 # The default value is: NO.
1248 # This tag requires that the tag GENERATE_HTML is set to YES.
1255 # The default value is: Doxygen generated docs.
1256 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1261 # set bundle. This should be a reverse domain-name style string, e.g.
1263 # The default value is: org.doxygen.Project.
1264 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1269 # the documentation publisher. This should be a reverse domain-name style
1271 # The default value is: org.doxygen.Publisher.
1272 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1277 # The default value is: Publisher.
1278 # This tag requires that the tag GENERATE_DOCSET is set to YES.
1282 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1285 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1295 # The default value is: NO.
1296 # This tag requires that the tag GENERATE_HTML is set to YES.
1303 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1308 # including file name) of the HTML help compiler (hhc.exe). If non-empty,
1311 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1317 # The default value is: NO.
1318 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1324 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1331 # The default value is: NO.
1332 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1336 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1338 # The default value is: NO.
1339 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1343 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1344 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1347 # The default value is: NO.
1348 # This tag requires that the tag GENERATE_HTML is set to YES.
1355 # This tag requires that the tag GENERATE_QHP is set to YES.
1361 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1362 # The default value is: org.doxygen.Project.
1363 # This tag requires that the tag GENERATE_QHP is set to YES.
1369 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1371 # The default value is: doc.
1372 # This tag requires that the tag GENERATE_QHP is set to YES.
1376 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1378 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1380 # This tag requires that the tag GENERATE_QHP is set to YES.
1386 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1388 # This tag requires that the tag GENERATE_QHP is set to YES.
1394 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1395 # This tag requires that the tag GENERATE_QHP is set to YES.
1400 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1402 # This tag requires that the tag GENERATE_QHP is set to YES.
1406 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1411 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1413 # The default value is: NO.
1414 # This tag requires that the tag GENERATE_HTML is set to YES.
1420 # name. Each documentation set should have its own identifier.
1421 # The default value is: org.doxygen.Project.
1422 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1429 # of each HTML page. A value of NO enables the index and the value YES disables
1431 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1432 # The default value is: NO.
1433 # This tag requires that the tag GENERATE_HTML is set to YES.
1437 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1439 # value is set to YES, a side panel will be generated containing a tree-like
1444 # further fine-tune the look of the index. As an example, the default style
1449 # The default value is: NO.
1450 # This tag requires that the tag GENERATE_HTML is set to YES.
1454 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1457 # Note that a value of 0 will completely suppress the enum values from appearing
1459 # Minimum value: 0, maximum value: 20, default value: 4.
1460 # This tag requires that the tag GENERATE_HTML is set to YES.
1465 # to set the initial width (in pixels) of the frame in which the tree is shown.
1466 # Minimum value: 0, maximum value: 1500, default value: 250.
1467 # This tag requires that the tag GENERATE_HTML is set to YES.
1471 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1473 # The default value is: NO.
1474 # This tag requires that the tag GENERATE_HTML is set to YES.
1482 # Minimum value: 8, maximum value: 50, default value: 10.
1483 # This tag requires that the tag GENERATE_HTML is set to YES.
1493 # The default value is: YES.
1494 # This tag requires that the tag GENERATE_HTML is set to YES.
1500 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1504 # The default value is: NO.
1505 # This tag requires that the tag GENERATE_HTML is set to YES.
1509 # When MathJax is enabled you can set the default output format to be used for
1512 # Possible values are: HTML-CSS (which is slower, but has the best
1514 # The default value is: HTML-CSS.
1515 # This tag requires that the tag USE_MATHJAX is set to YES.
1517 MATHJAX_FORMAT         = HTML-CSS
1523 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1527 # The default value is: http://cdn.mathjax.org/mathjax/latest.
1528 # This tag requires that the tag USE_MATHJAX is set to YES.
1535 # This tag requires that the tag USE_MATHJAX is set to YES.
1543 # This tag requires that the tag USE_MATHJAX is set to YES.
1563 # The default value is: YES.
1564 # This tag requires that the tag GENERATE_HTML is set to YES.
1575 # The default value is: NO.
1576 # This tag requires that the tag SEARCHENGINE is set to YES.
1591 # The default value is: NO.
1592 # This tag requires that the tag SEARCHENGINE is set to YES.
1603 # This tag requires that the tag SEARCHENGINE is set to YES.
1611 # This tag requires that the tag SEARCHENGINE is set to YES.
1619 # This tag requires that the tag SEARCHENGINE is set to YES.
1626 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1629 # This tag requires that the tag SEARCHENGINE is set to YES.
1633 #---------------------------------------------------------------------------
1635 #---------------------------------------------------------------------------
1637 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1638 # The default value is: YES.
1643 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1646 # This tag requires that the tag GENERATE_LATEX is set to YES.
1657 # This tag requires that the tag GENERATE_LATEX is set to YES.
1664 # This tag requires that the tag GENERATE_LATEX is set to YES.
1668 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1671 # The default value is: NO.
1672 # This tag requires that the tag GENERATE_LATEX is set to YES.
1676 # The PAPER_TYPE tag can be used to set the paper type that is used by the
1680 # The default value is: a4.
1681 # This tag requires that the tag GENERATE_LATEX is set to YES.
1690 # This tag requires that the tag GENERATE_LATEX is set to YES.
1700 # Note: Only use a user-defined header if you know what you are doing! The
1706 # This tag requires that the tag GENERATE_LATEX is set to YES.
1716 # Note: Only use a user-defined footer if you know what you are doing!
1717 # This tag requires that the tag GENERATE_LATEX is set to YES.
1721 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1728 # This tag requires that the tag GENERATE_LATEX is set to YES.
1734 # directory. Note that the files will be copied as-is; there are no commands or
1736 # This tag requires that the tag GENERATE_LATEX is set to YES.
1740 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1744 # The default value is: YES.
1745 # This tag requires that the tag GENERATE_LATEX is set to YES.
1749 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1750 # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1752 # The default value is: YES.
1753 # This tag requires that the tag GENERATE_LATEX is set to YES.
1757 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1761 # The default value is: NO.
1762 # This tag requires that the tag GENERATE_LATEX is set to YES.
1766 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1768 # The default value is: NO.
1769 # This tag requires that the tag GENERATE_LATEX is set to YES.
1773 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1778 # The default value is: NO.
1779 # This tag requires that the tag GENERATE_LATEX is set to YES.
1786 # The default value is: plain.
1787 # This tag requires that the tag GENERATE_LATEX is set to YES.
1791 #---------------------------------------------------------------------------
1793 #---------------------------------------------------------------------------
1795 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1798 # The default value is: NO.
1803 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1806 # This tag requires that the tag GENERATE_RTF is set to YES.
1810 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1813 # The default value is: NO.
1814 # This tag requires that the tag GENERATE_RTF is set to YES.
1818 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1825 # The default value is: NO.
1826 # This tag requires that the tag GENERATE_RTF is set to YES.
1832 # missing definitions are set to their default value.
1836 # This tag requires that the tag GENERATE_RTF is set to YES.
1840 # Set optional variables used in the generation of an RTF document. Syntax is
1842 # using doxygen -e rtf extensionFile.
1843 # This tag requires that the tag GENERATE_RTF is set to YES.
1847 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1852 # The default value is: NO.
1853 # This tag requires that the tag GENERATE_RTF is set to YES.
1857 #---------------------------------------------------------------------------
1859 #---------------------------------------------------------------------------
1861 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1863 # The default value is: NO.
1868 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1872 # This tag requires that the tag GENERATE_MAN is set to YES.
1880 # The default value is: .3.
1881 # This tag requires that the tag GENERATE_MAN is set to YES.
1888 # This tag requires that the tag GENERATE_MAN is set to YES.
1892 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1896 # The default value is: NO.
1897 # This tag requires that the tag GENERATE_MAN is set to YES.
1901 #---------------------------------------------------------------------------
1903 #---------------------------------------------------------------------------
1905 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1907 # The default value is: NO.
1912 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1915 # This tag requires that the tag GENERATE_XML is set to YES.
1919 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1920 # listings (including syntax highlighting and cross-referencing information) to
1923 # The default value is: YES.
1924 # This tag requires that the tag GENERATE_XML is set to YES.
1928 #---------------------------------------------------------------------------
1930 #---------------------------------------------------------------------------
1932 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1934 # The default value is: NO.
1939 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1942 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1946 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1947 # program listings (including syntax highlighting and cross-referencing
1950 # The default value is: NO.
1951 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1955 #---------------------------------------------------------------------------
1957 #---------------------------------------------------------------------------
1959 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1963 # The default value is: NO.
1967 #---------------------------------------------------------------------------
1969 #---------------------------------------------------------------------------
1971 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1975 # The default value is: NO.
1979 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1982 # The default value is: NO.
1983 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1987 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1989 # understand what is going on. On the other hand, if this tag is set to NO, the
1992 # The default value is: YES.
1993 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2001 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
2005 #---------------------------------------------------------------------------
2007 #---------------------------------------------------------------------------
2009 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2010 # C-preprocessor directives found in the sources and include files.
2011 # The default value is: YES.
2015 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2016 # in the source code. If set to NO, only conditional compilation will be
2019 # The default value is: NO.
2020 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2024 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2027 # The default value is: NO.
2028 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2032 # If the SEARCH_INCLUDES tag is set to YES, the include files in the
2034 # The default value is: YES.
2035 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2042 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
2047 # patterns (like *.h and *.hpp) to filter out the header-files in the
2050 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2055 # defined before the preprocessor is started (similar to the -D option of e.g.
2060 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2064 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2069 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2073 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2074 # remove all references to function-like macros that are alone on a line, have
2076 # are typically used for boiler-plate code, and will confuse the parser if not
2078 # The default value is: YES.
2079 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2083 #---------------------------------------------------------------------------
2085 #---------------------------------------------------------------------------
2108 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2109 # the class index. If set to NO, only the inherited external classes will be
2111 # The default value is: NO.
2115 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2116 # in the modules index. If set to NO, only the current project's groups will be
2118 # The default value is: YES.
2122 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2123 # the related pages index. If set to NO, only the current project's pages will
2125 # The default value is: YES.
2135 #---------------------------------------------------------------------------
2137 #---------------------------------------------------------------------------
2139 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2144 # The default value is: YES.
2164 # If set to YES the inheritance and collaboration graphs will hide inheritance
2166 # The default value is: YES.
2170 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2174 # set to NO
2175 # The default value is: NO.
2180 # to run in parallel. When set to 0 doxygen will base this on the number of
2181 # processors available in the system. You can set it explicitly to a value
2184 # Minimum value: 0, maximum value: 32, default value: 0.
2185 # This tag requires that the tag HAVE_DOT is set to YES.
2194 # The default value is: Helvetica.
2195 # This tag requires that the tag HAVE_DOT is set to YES.
2199 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2201 # Minimum value: 4, maximum value: 24, default value: 10.
2202 # This tag requires that the tag HAVE_DOT is set to YES.
2207 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2209 # This tag requires that the tag HAVE_DOT is set to YES.
2213 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2216 # The default value is: YES.
2217 # This tag requires that the tag HAVE_DOT is set to YES.
2221 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2225 # The default value is: YES.
2226 # This tag requires that the tag HAVE_DOT is set to YES.
2230 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2232 # The default value is: YES.
2233 # This tag requires that the tag HAVE_DOT is set to YES.
2237 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2240 # The default value is: NO.
2241 # This tag requires that the tag HAVE_DOT is set to YES.
2248 # number of items for each type to make the size more manageable. Set this to 0
2250 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2253 # Minimum value: 0, maximum value: 100, default value: 10.
2254 # This tag requires that the tag HAVE_DOT is set to YES.
2258 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2261 # The default value is: NO.
2262 # This tag requires that the tag HAVE_DOT is set to YES.
2266 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2270 # The default value is: YES.
2271 # This tag requires that the tag HAVE_DOT is set to YES.
2276 # set to YES then doxygen will generate a graph for each documented file showing
2279 # The default value is: YES.
2280 # This tag requires that the tag HAVE_DOT is set to YES.
2284 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2290 # The default value is: NO.
2291 # This tag requires that the tag HAVE_DOT is set to YES.
2295 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2301 # The default value is: NO.
2302 # This tag requires that the tag HAVE_DOT is set to YES.
2306 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2308 # The default value is: YES.
2309 # This tag requires that the tag HAVE_DOT is set to YES.
2313 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2317 # The default value is: YES.
2318 # This tag requires that the tag HAVE_DOT is set to YES.
2322 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2324 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2328 # The default value is: png.
2329 # This tag requires that the tag HAVE_DOT is set to YES.
2333 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2338 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2340 # The default value is: NO.
2341 # This tag requires that the tag HAVE_DOT is set to YES.
2347 # This tag requires that the tag HAVE_DOT is set to YES.
2354 # This tag requires that the tag HAVE_DOT is set to YES.
2383 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2385 # larger than this value, doxygen will truncate the graph, which is visualized
2390 # Minimum value: 0, maximum value: 10000, default value: 50.
2391 # This tag requires that the tag HAVE_DOT is set to YES.
2395 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2396 # generated by dot. A depth value of 3 means that only nodes reachable from the
2402 # Minimum value: 0, maximum value: 1000, default value: 0.
2403 # This tag requires that the tag HAVE_DOT is set to YES.
2407 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2412 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2414 # The default value is: NO.
2415 # This tag requires that the tag HAVE_DOT is set to YES.
2419 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2420 # files in one run (i.e. multiple -o and -T options on the command line). This
2423 # The default value is: NO.
2424 # This tag requires that the tag HAVE_DOT is set to YES.
2428 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2431 # The default value is: YES.
2432 # This tag requires that the tag HAVE_DOT is set to YES.
2436 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2438 # The default value is: YES.
2439 # This tag requires that the tag HAVE_DOT is set to YES.