Warning, /frameworks/syntax-highlighting/autotests/folding/Doxyfile.example.fold is written in an unsupported language. File is not indexed.
0001 # Doxyfile 1.8.11 0002 0003 # This file describes the settings to be used by the documentation system 0004 # doxygen (www.doxygen.org) for a project. 0005 # 0006 # All text after a double hash (##) is considered a comment and is placed in 0007 # front of the TAG it is preceding. 0008 # 0009 # All text after a single hash (#) is considered a comment and will be ignored. 0010 # The format is: 0011 # TAG = value [value, ...] 0012 # For lists, items can also be appended using: 0013 # TAG += value [value, ...] 0014 # Values that contain spaces should be placed between quotes (\" \"). 0015 0016 #--------------------------------------------------------------------------- 0017 # Project related configuration options 0018 #--------------------------------------------------------------------------- 0019 0020 # This tag specifies the encoding used for all characters in the config file 0021 # that follow. The default is UTF-8 which is also the encoding used for all text 0022 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 0023 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 0024 # for the list of possible encodings. 0025 # The default value is: UTF-8. 0026 0027 DOXYFILE_ENCODING = UTF-8 0028 0029 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 0030 # double-quotes, unless you are using Doxywizard) that should identify the 0031 # project for which the documentation is generated. This name is used in the 0032 # title of most generated pages and in a few other places. 0033 # The default value is: My Project. 0034 0035 PROJECT_NAME = "My Project" 0036 0037 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 0038 # could be handy for archiving the generated documentation or if some version 0039 # control system is used. 0040 0041 PROJECT_NUMBER = 0042 0043 # Using the PROJECT_BRIEF tag one can provide an optional one line description 0044 # for a project that appears at the top of each page and should give viewer a 0045 # quick idea about the purpose of the project. Keep the description short. 0046 0047 PROJECT_BRIEF = 0048 0049 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 0050 # in the documentation. The maximum height of the logo should not exceed 55 0051 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 0052 # the logo to the output directory. 0053 0054 PROJECT_LOGO = 0055 0056 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 0057 # into which the generated documentation will be written. If a relative path is 0058 # entered, it will be relative to the location where doxygen was started. If 0059 # left blank the current directory will be used. 0060 0061 OUTPUT_DIRECTORY = 0062 0063 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 0064 # directories (in 2 levels) under the output directory of each output format and 0065 # will distribute the generated files over these directories. Enabling this 0066 # option can be useful when feeding doxygen a huge amount of source files, where 0067 # putting all generated files in the same directory would otherwise causes 0068 # performance problems for the file system. 0069 # The default value is: NO. 0070 0071 CREATE_SUBDIRS = NO 0072 0073 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 0074 # characters to appear in the names of generated files. If set to NO, non-ASCII 0075 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 0076 # U+3044. 0077 # The default value is: NO. 0078 0079 ALLOW_UNICODE_NAMES = NO 0080 0081 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 0082 # documentation generated by doxygen is written. Doxygen will use this 0083 # information to generate all constant output in the proper language. 0084 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 0085 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 0086 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 0087 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 0088 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 0089 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 0090 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 0091 # Ukrainian and Vietnamese. 0092 # The default value is: English. 0093 0094 OUTPUT_LANGUAGE = English 0095 0096 # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 0097 # descriptions after the members that are listed in the file and class 0098 # documentation (similar to Javadoc). Set to NO to disable this. 0099 # The default value is: YES. 0100 0101 BRIEF_MEMBER_DESC = YES 0102 0103 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 0104 # description of a member or function before the detailed description 0105 # 0106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 0107 # brief descriptions will be completely suppressed. 0108 # The default value is: YES. 0109 0110 REPEAT_BRIEF = YES 0111 0112 # This tag implements a quasi-intelligent brief description abbreviator that is 0113 # used to form the text in various listings. Each string in this list, if found 0114 # as the leading text of the brief description, will be stripped from the text 0115 # and the result, after processing the whole list, is used as the annotated 0116 # text. Otherwise, the brief description is used as-is. If left blank, the 0117 # following values are used ($name is automatically replaced with the name of 0118 # the entity):The $name class, The $name widget, The $name file, is, provides, 0119 # specifies, contains, represents, a, an and the. 0120 0121 ABBREVIATE_BRIEF = 0122 0123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 0124 # doxygen will generate a detailed section even if there is only a brief 0125 # description. 0126 # The default value is: NO. 0127 0128 ALWAYS_DETAILED_SEC = NO 0129 0130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 0131 # inherited members of a class in the documentation of that class as if those 0132 # members were ordinary class members. Constructors, destructors and assignment 0133 # operators of the base classes will not be shown. 0134 # The default value is: NO. 0135 0136 INLINE_INHERITED_MEMB = NO 0137 0138 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 0139 # before files name in the file list and in the header files. If set to NO the 0140 # shortest path that makes the file name unique will be used 0141 # The default value is: YES. 0142 0143 FULL_PATH_NAMES = YES 0144 0145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 0146 # Stripping is only done if one of the specified strings matches the left-hand 0147 # part of the path. The tag can be used to show relative paths in the file list. 0148 # If left blank the directory from which doxygen is run is used as the path to 0149 # strip. 0150 # 0151 # Note that you can specify absolute paths here, but also relative paths, which 0152 # will be relative from the directory where doxygen is started. 0153 # This tag requires that the tag FULL_PATH_NAMES is set to YES. 0154 0155 STRIP_FROM_PATH = 0156 0157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 0158 # path mentioned in the documentation of a class, which tells the reader which 0159 # header file to include in order to use a class. If left blank only the name of 0160 # the header file containing the class definition is used. Otherwise one should 0161 # specify the list of include paths that are normally passed to the compiler 0162 # using the -I flag. 0163 0164 STRIP_FROM_INC_PATH = 0165 0166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 0167 # less readable) file names. This can be useful is your file systems doesn't 0168 # support long names like on DOS, Mac, or CD-ROM. 0169 # The default value is: NO. 0170 0171 SHORT_NAMES = NO 0172 0173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 0174 # first line (until the first dot) of a Javadoc-style comment as the brief 0175 # description. If set to NO, the Javadoc-style will behave just like regular Qt- 0176 # style comments (thus requiring an explicit @brief command for a brief 0177 # description.) 0178 # The default value is: NO. 0179 0180 JAVADOC_AUTOBRIEF = NO 0181 0182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 0183 # line (until the first dot) of a Qt-style comment as the brief description. If 0184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 0185 # requiring an explicit \brief command for a brief description.) 0186 # The default value is: NO. 0187 0188 QT_AUTOBRIEF = NO 0189 0190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 0191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 0192 # a brief description. This used to be the default behavior. The new default is 0193 # to treat a multi-line C++ comment block as a detailed description. Set this 0194 # tag to YES if you prefer the old behavior instead. 0195 # 0196 # Note that setting this tag to YES also means that rational rose comments are 0197 # not recognized any more. 0198 # The default value is: NO. 0199 0200 MULTILINE_CPP_IS_BRIEF = NO 0201 0202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 0203 # documentation from any documented member that it re-implements. 0204 # The default value is: YES. 0205 0206 INHERIT_DOCS = YES 0207 0208 # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 0209 # page for each member. If set to NO, the documentation of a member will be part 0210 # of the file/class/namespace that contains it. 0211 # The default value is: NO. 0212 0213 SEPARATE_MEMBER_PAGES = NO 0214 0215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 0216 # uses this value to replace tabs by spaces in code fragments. 0217 # Minimum value: 1, maximum value: 16, default value: 4. 0218 0219 TAB_SIZE = 4 0220 0221 # This tag can be used to specify a number of aliases that act as commands in 0222 # the documentation. An alias has the form: 0223 # name=value 0224 # For example adding 0225 # "sideeffect=@par Side Effects:\n" 0226 # will allow you to put the command \sideeffect (or @sideeffect) in the 0227 # documentation, which will result in a user-defined paragraph with heading 0228 # "Side Effects:". You can put \n's in the value part of an alias to insert 0229 # newlines. 0230 0231 ALIASES = 0232 0233 # This tag can be used to specify a number of word-keyword mappings (TCL only). 0234 # A mapping has the form "name=value". For example adding "class=itcl::class" 0235 # will allow you to use the command class in the itcl::class meaning. 0236 0237 TCL_SUBST = 0238 0239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 0240 # only. Doxygen will then generate output that is more tailored for C. For 0241 # instance, some of the names that are used will be different. The list of all 0242 # members will be omitted, etc. 0243 # The default value is: NO. 0244 0245 OPTIMIZE_OUTPUT_FOR_C = NO 0246 0247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 0248 # Python sources only. Doxygen will then generate output that is more tailored 0249 # for that language. For instance, namespaces will be presented as packages, 0250 # qualified scopes will look different, etc. 0251 # The default value is: NO. 0252 0253 OPTIMIZE_OUTPUT_JAVA = NO 0254 0255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 0256 # sources. Doxygen will then generate output that is tailored for Fortran. 0257 # The default value is: NO. 0258 0259 OPTIMIZE_FOR_FORTRAN = NO 0260 0261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 0262 # sources. Doxygen will then generate output that is tailored for VHDL. 0263 # The default value is: NO. 0264 0265 OPTIMIZE_OUTPUT_VHDL = NO 0266 0267 # Doxygen selects the parser to use depending on the extension of the files it 0268 # parses. With this tag you can assign which parser to use for a given 0269 # extension. Doxygen has a built-in mapping, but you can override or extend it 0270 # using this tag. The format is ext=language, where ext is a file extension, and 0271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 0272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 0273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 0274 # Fortran. In the later case the parser tries to guess whether the code is fixed 0275 # or free formatted code, this is the default for Fortran type files), VHDL. For 0276 # instance to make doxygen treat .inc files as Fortran files (default is PHP), 0277 # and .f files as C (default is Fortran), use: inc=Fortran f=C. 0278 # 0279 # Note: For files without extension you can use no_extension as a placeholder. 0280 # 0281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 0282 # the files are not read by doxygen. 0283 0284 EXTENSION_MAPPING = 0285 0286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 0287 # according to the Markdown format, which allows for more readable 0288 # documentation. See http://daringfireball.net/projects/markdown/ for details. 0289 # The output of markdown processing is further processed by doxygen, so you can 0290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 0291 # case of backward compatibilities issues. 0292 # The default value is: YES. 0293 0294 MARKDOWN_SUPPORT = YES 0295 0296 # When enabled doxygen tries to link words that correspond to documented 0297 # classes, or namespaces to their corresponding documentation. Such a link can 0298 # be prevented in individual cases by putting a % sign in front of the word or 0299 # globally by setting AUTOLINK_SUPPORT to NO. 0300 # The default value is: YES. 0301 0302 AUTOLINK_SUPPORT = YES 0303 0304 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 0305 # to include (a tag file for) the STL sources as input, then you should set this 0306 # tag to YES in order to let doxygen match functions declarations and 0307 # definitions whose arguments contain STL classes (e.g. func(std::string); 0308 # versus func(std::string) {}). This also make the inheritance and collaboration 0309 # diagrams that involve STL classes more complete and accurate. 0310 # The default value is: NO. 0311 0312 BUILTIN_STL_SUPPORT = NO 0313 0314 # If you use Microsoft's C++/CLI language, you should set this option to YES to 0315 # enable parsing support. 0316 # The default value is: NO. 0317 0318 CPP_CLI_SUPPORT = NO 0319 0320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 0321 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 0322 # will parse them like normal C++ but will assume all classes use public instead 0323 # of private inheritance when no explicit protection keyword is present. 0324 # The default value is: NO. 0325 0326 SIP_SUPPORT = NO 0327 0328 # For Microsoft's IDL there are propget and propput attributes to indicate 0329 # getter and setter methods for a property. Setting this option to YES will make 0330 # doxygen to replace the get and set methods by a property in the documentation. 0331 # This will only work if the methods are indeed getting or setting a simple 0332 # type. If this is not the case, or you want to show the methods anyway, you 0333 # should set this option to NO. 0334 # The default value is: YES. 0335 0336 IDL_PROPERTY_SUPPORT = YES 0337 0338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 0339 # tag is set to YES then doxygen will reuse the documentation of the first 0340 # member in the group (if any) for the other members of the group. By default 0341 # all members of a group must be documented explicitly. 0342 # The default value is: NO. 0343 0344 DISTRIBUTE_GROUP_DOC = NO 0345 0346 # If one adds a struct or class to a group and this option is enabled, then also 0347 # any nested class or struct is added to the same group. By default this option 0348 # is disabled and one has to add nested compounds explicitly via \ingroup. 0349 # The default value is: NO. 0350 0351 GROUP_NESTED_COMPOUNDS = NO 0352 0353 # Set the SUBGROUPING tag to YES to allow class member groups of the same type 0354 # (for instance a group of public functions) to be put as a subgroup of that 0355 # type (e.g. under the Public Functions section). Set it to NO to prevent 0356 # subgrouping. Alternatively, this can be done per class using the 0357 # \nosubgrouping command. 0358 # The default value is: YES. 0359 0360 SUBGROUPING = YES 0361 0362 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 0363 # are shown inside the group in which they are included (e.g. using \ingroup) 0364 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 0365 # and RTF). 0366 # 0367 # Note that this feature does not work in combination with 0368 # SEPARATE_MEMBER_PAGES. 0369 # The default value is: NO. 0370 0371 INLINE_GROUPED_CLASSES = NO 0372 0373 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 0374 # with only public data fields or simple typedef fields will be shown inline in 0375 # the documentation of the scope in which they are defined (i.e. file, 0376 # namespace, or group documentation), provided this scope is documented. If set 0377 # to NO, structs, classes, and unions are shown on a separate page (for HTML and 0378 # Man pages) or section (for LaTeX and RTF). 0379 # The default value is: NO. 0380 0381 INLINE_SIMPLE_STRUCTS = NO 0382 0383 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 0384 # enum is documented as struct, union, or enum with the name of the typedef. So 0385 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 0386 # with name TypeT. When disabled the typedef will appear as a member of a file, 0387 # namespace, or class. And the struct will be named TypeS. This can typically be 0388 # useful for C code in case the coding convention dictates that all compound 0389 # types are typedef'ed and only the typedef is referenced, never the tag name. 0390 # The default value is: NO. 0391 0392 TYPEDEF_HIDES_STRUCT = NO 0393 0394 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 0395 # cache is used to resolve symbols given their name and scope. Since this can be 0396 # an expensive process and often the same symbol appears multiple times in the 0397 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 0398 # doxygen will become slower. If the cache is too large, memory is wasted. The 0399 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 0400 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 0401 # symbols. At the end of a run doxygen will report the cache usage and suggest 0402 # the optimal cache size from a speed point of view. 0403 # Minimum value: 0, maximum value: 9, default value: 0. 0404 0405 LOOKUP_CACHE_SIZE = 0 0406 0407 #--------------------------------------------------------------------------- 0408 # Build related configuration options 0409 #--------------------------------------------------------------------------- 0410 0411 # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 0412 # documentation are documented, even if no documentation was available. Private 0413 # class members and static file members will be hidden unless the 0414 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 0415 # Note: This will also disable the warnings about undocumented members that are 0416 # normally produced when WARNINGS is set to YES. 0417 # The default value is: NO. 0418 0419 EXTRACT_ALL = NO 0420 0421 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 0422 # be included in the documentation. 0423 # The default value is: NO. 0424 0425 EXTRACT_PRIVATE = NO 0426 0427 # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 0428 # scope will be included in the documentation. 0429 # The default value is: NO. 0430 0431 EXTRACT_PACKAGE = NO 0432 0433 # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 0434 # included in the documentation. 0435 # The default value is: NO. 0436 0437 EXTRACT_STATIC = NO 0438 0439 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 0440 # locally in source files will be included in the documentation. If set to NO, 0441 # only classes defined in header files are included. Does not have any effect 0442 # for Java sources. 0443 # The default value is: YES. 0444 0445 EXTRACT_LOCAL_CLASSES = YES 0446 0447 # This flag is only useful for Objective-C code. If set to YES, local methods, 0448 # which are defined in the implementation section but not in the interface are 0449 # included in the documentation. If set to NO, only methods in the interface are 0450 # included. 0451 # The default value is: NO. 0452 0453 EXTRACT_LOCAL_METHODS = NO 0454 0455 # If this flag is set to YES, the members of anonymous namespaces will be 0456 # extracted and appear in the documentation as a namespace called 0457 # 'anonymous_namespace{file}', where file will be replaced with the base name of 0458 # the file that contains the anonymous namespace. By default anonymous namespace 0459 # are hidden. 0460 # The default value is: NO. 0461 0462 EXTRACT_ANON_NSPACES = NO 0463 0464 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 0465 # undocumented members inside documented classes or files. If set to NO these 0466 # members will be included in the various overviews, but no documentation 0467 # section is generated. This option has no effect if EXTRACT_ALL is enabled. 0468 # The default value is: NO. 0469 0470 HIDE_UNDOC_MEMBERS = NO 0471 0472 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 0473 # undocumented classes that are normally visible in the class hierarchy. If set 0474 # to NO, these classes will be included in the various overviews. This option 0475 # has no effect if EXTRACT_ALL is enabled. 0476 # The default value is: NO. 0477 0478 HIDE_UNDOC_CLASSES = NO 0479 0480 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 0481 # (class|struct|union) declarations. If set to NO, these declarations will be 0482 # included in the documentation. 0483 # The default value is: NO. 0484 0485 HIDE_FRIEND_COMPOUNDS = NO 0486 0487 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 0488 # documentation blocks found inside the body of a function. If set to NO, these 0489 # blocks will be appended to the function's detailed documentation block. 0490 # The default value is: NO. 0491 0492 HIDE_IN_BODY_DOCS = NO 0493 0494 # The INTERNAL_DOCS tag determines if documentation that is typed after a 0495 # \internal command is included. If the tag is set to NO then the documentation 0496 # will be excluded. Set it to YES to include the internal documentation. 0497 # The default value is: NO. 0498 0499 INTERNAL_DOCS = NO 0500 0501 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 0502 # names in lower-case letters. If set to YES, upper-case letters are also 0503 # allowed. This is useful if you have classes or files whose names only differ 0504 # in case and if your file system supports case sensitive file names. Windows 0505 # and Mac users are advised to set this option to NO. 0506 # The default value is: system dependent. 0507 0508 CASE_SENSE_NAMES = YES 0509 0510 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 0511 # their full class and namespace scopes in the documentation. If set to YES, the 0512 # scope will be hidden. 0513 # The default value is: NO. 0514 0515 HIDE_SCOPE_NAMES = NO 0516 0517 # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 0518 # append additional text to a page's title, such as Class Reference. If set to 0519 # YES the compound reference will be hidden. 0520 # The default value is: NO. 0521 0522 HIDE_COMPOUND_REFERENCE= NO 0523 0524 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 0525 # the files that are included by a file in the documentation of that file. 0526 # The default value is: YES. 0527 0528 SHOW_INCLUDE_FILES = YES 0529 0530 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 0531 # grouped member an include statement to the documentation, telling the reader 0532 # which file to include in order to use the member. 0533 # The default value is: NO. 0534 0535 SHOW_GROUPED_MEMB_INC = NO 0536 0537 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 0538 # files with double quotes in the documentation rather than with sharp brackets. 0539 # The default value is: NO. 0540 0541 FORCE_LOCAL_INCLUDES = NO 0542 0543 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 0544 # documentation for inline members. 0545 # The default value is: YES. 0546 0547 INLINE_INFO = YES 0548 0549 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 0550 # (detailed) documentation of file and class members alphabetically by member 0551 # name. If set to NO, the members will appear in declaration order. 0552 # The default value is: YES. 0553 0554 SORT_MEMBER_DOCS = YES 0555 0556 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 0557 # descriptions of file, namespace and class members alphabetically by member 0558 # name. If set to NO, the members will appear in declaration order. Note that 0559 # this will also influence the order of the classes in the class list. 0560 # The default value is: NO. 0561 0562 SORT_BRIEF_DOCS = NO 0563 0564 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 0565 # (brief and detailed) documentation of class members so that constructors and 0566 # destructors are listed first. If set to NO the constructors will appear in the 0567 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 0568 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 0569 # member documentation. 0570 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 0571 # detailed member documentation. 0572 # The default value is: NO. 0573 0574 SORT_MEMBERS_CTORS_1ST = NO 0575 0576 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 0577 # of group names into alphabetical order. If set to NO the group names will 0578 # appear in their defined order. 0579 # The default value is: NO. 0580 0581 SORT_GROUP_NAMES = NO 0582 0583 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 0584 # fully-qualified names, including namespaces. If set to NO, the class list will 0585 # be sorted only by class name, not including the namespace part. 0586 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 0587 # Note: This option applies only to the class list, not to the alphabetical 0588 # list. 0589 # The default value is: NO. 0590 0591 SORT_BY_SCOPE_NAME = NO 0592 0593 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 0594 # type resolution of all parameters of a function it will reject a match between 0595 # the prototype and the implementation of a member function even if there is 0596 # only one candidate or it is obvious which candidate to choose by doing a 0597 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 0598 # accept a match between prototype and implementation in such cases. 0599 # The default value is: NO. 0600 0601 STRICT_PROTO_MATCHING = NO 0602 0603 # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 0604 # list. This list is created by putting \todo commands in the documentation. 0605 # The default value is: YES. 0606 0607 GENERATE_TODOLIST = YES 0608 0609 # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 0610 # list. This list is created by putting \test commands in the documentation. 0611 # The default value is: YES. 0612 0613 GENERATE_TESTLIST = YES 0614 0615 # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 0616 # list. This list is created by putting \bug commands in the documentation. 0617 # The default value is: YES. 0618 0619 GENERATE_BUGLIST = YES 0620 0621 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 0622 # the deprecated list. This list is created by putting \deprecated commands in 0623 # the documentation. 0624 # The default value is: YES. 0625 0626 GENERATE_DEPRECATEDLIST= YES 0627 0628 # The ENABLED_SECTIONS tag can be used to enable conditional documentation 0629 # sections, marked by \if <section_label> ... \endif and \cond <section_label> 0630 # ... \endcond blocks. 0631 0632 ENABLED_SECTIONS = 0633 0634 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 0635 # initial value of a variable or macro / define can have for it to appear in the 0636 # documentation. If the initializer consists of more lines than specified here 0637 # it will be hidden. Use a value of 0 to hide initializers completely. The 0638 # appearance of the value of individual variables and macros / defines can be 0639 # controlled using \showinitializer or \hideinitializer command in the 0640 # documentation regardless of this setting. 0641 # Minimum value: 0, maximum value: 10000, default value: 30. 0642 0643 MAX_INITIALIZER_LINES = 30 0644 0645 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 0646 # the bottom of the documentation of classes and structs. If set to YES, the 0647 # list will mention the files that were used to generate the documentation. 0648 # The default value is: YES. 0649 0650 SHOW_USED_FILES = YES 0651 0652 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 0653 # will remove the Files entry from the Quick Index and from the Folder Tree View 0654 # (if specified). 0655 # The default value is: YES. 0656 0657 SHOW_FILES = YES 0658 0659 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 0660 # page. This will remove the Namespaces entry from the Quick Index and from the 0661 # Folder Tree View (if specified). 0662 # The default value is: YES. 0663 0664 SHOW_NAMESPACES = YES 0665 0666 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 0667 # doxygen should invoke to get the current version for each file (typically from 0668 # the version control system). Doxygen will invoke the program by executing (via 0669 # popen()) the command command input-file, where command is the value of the 0670 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 0671 # by doxygen. Whatever the program writes to standard output is used as the file 0672 # version. For an example see the documentation. 0673 0674 FILE_VERSION_FILTER = 0675 0676 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 0677 # by doxygen. The layout file controls the global structure of the generated 0678 # output files in an output format independent way. To create the layout file 0679 # that represents doxygen's defaults, run doxygen with the -l option. You can 0680 # optionally specify a file name after the option, if omitted DoxygenLayout.xml 0681 # will be used as the name of the layout file. 0682 # 0683 # Note that if you run doxygen from a directory containing a file called 0684 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 0685 # tag is left empty. 0686 0687 LAYOUT_FILE = 0688 0689 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 0690 # the reference definitions. This must be a list of .bib files. The .bib 0691 # extension is automatically appended if omitted. This requires the bibtex tool 0692 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 0693 # For LaTeX the style of the bibliography can be controlled using 0694 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 0695 # search path. See also \cite for info how to create references. 0696 0697 CITE_BIB_FILES = 0698 0699 #--------------------------------------------------------------------------- 0700 # Configuration options related to warning and progress messages 0701 #--------------------------------------------------------------------------- 0702 0703 # The QUIET tag can be used to turn on/off the messages that are generated to 0704 # standard output by doxygen. If QUIET is set to YES this implies that the 0705 # messages are off. 0706 # The default value is: NO. 0707 0708 QUIET = NO 0709 0710 # The WARNINGS tag can be used to turn on/off the warning messages that are 0711 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 0712 # this implies that the warnings are on. 0713 # 0714 # Tip: Turn warnings on while writing the documentation. 0715 # The default value is: YES. 0716 0717 WARNINGS = YES 0718 0719 # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 0720 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 0721 # will automatically be disabled. 0722 # The default value is: YES. 0723 0724 WARN_IF_UNDOCUMENTED = YES 0725 0726 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 0727 # potential errors in the documentation, such as not documenting some parameters 0728 # in a documented function, or documenting parameters that don't exist or using 0729 # markup commands wrongly. 0730 # The default value is: YES. 0731 0732 WARN_IF_DOC_ERROR = YES 0733 0734 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 0735 # are documented, but have no documentation for their parameters or return 0736 # value. If set to NO, doxygen will only warn about wrong or incomplete 0737 # parameter documentation, but not about the absence of documentation. 0738 # The default value is: NO. 0739 0740 WARN_NO_PARAMDOC = NO 0741 0742 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 0743 # a warning is encountered. 0744 # The default value is: NO. 0745 0746 WARN_AS_ERROR = NO 0747 0748 # The WARN_FORMAT tag determines the format of the warning messages that doxygen 0749 # can produce. The string should contain the $file, $line, and $text tags, which 0750 # will be replaced by the file and line number from which the warning originated 0751 # and the warning text. Optionally the format may contain $version, which will 0752 # be replaced by the version of the file (if it could be obtained via 0753 # FILE_VERSION_FILTER) 0754 # The default value is: $file:$line: $text. 0755 0756 WARN_FORMAT = "$file:$line: $text" 0757 0758 # The WARN_LOGFILE tag can be used to specify a file to which warning and error 0759 # messages should be written. If left blank the output is written to standard 0760 # error (stderr). 0761 0762 WARN_LOGFILE = 0763 0764 #--------------------------------------------------------------------------- 0765 # Configuration options related to the input files 0766 #--------------------------------------------------------------------------- 0767 0768 # The INPUT tag is used to specify the files and/or directories that contain 0769 # documented source files. You may enter file names like myfile.cpp or 0770 # directories like /usr/src/myproject. Separate the files or directories with 0771 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 0772 # Note: If this tag is empty the current directory is searched. 0773 0774 INPUT = 0775 0776 # This tag can be used to specify the character encoding of the source files 0777 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 0778 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 0779 # documentation (see: http://www.gnu.org/software/libiconv) for the list of 0780 # possible encodings. 0781 # The default value is: UTF-8. 0782 0783 INPUT_ENCODING = UTF-8 0784 0785 # If the value of the INPUT tag contains directories, you can use the 0786 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 0787 # *.h) to filter out the source-files in the directories. 0788 # 0789 # Note that for custom extensions or not directly supported extensions you also 0790 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 0791 # read by doxygen. 0792 # 0793 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 0794 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 0795 # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 0796 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, 0797 # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. 0798 0799 FILE_PATTERNS = 0800 0801 # The RECURSIVE tag can be used to specify whether or not subdirectories should 0802 # be searched for input files as well. 0803 # The default value is: NO. 0804 0805 RECURSIVE = NO 0806 0807 # The EXCLUDE tag can be used to specify files and/or directories that should be 0808 # excluded from the INPUT source files. This way you can easily exclude a 0809 # subdirectory from a directory tree whose root is specified with the INPUT tag. 0810 # 0811 # Note that relative paths are relative to the directory from which doxygen is 0812 # run. 0813 0814 EXCLUDE = 0815 0816 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 0817 # directories that are symbolic links (a Unix file system feature) are excluded 0818 # from the input. 0819 # The default value is: NO. 0820 0821 EXCLUDE_SYMLINKS = NO 0822 0823 # If the value of the INPUT tag contains directories, you can use the 0824 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 0825 # certain files from those directories. 0826 # 0827 # Note that the wildcards are matched against the file with absolute path, so to 0828 # exclude all test directories for example use the pattern */test/* 0829 0830 EXCLUDE_PATTERNS = 0831 0832 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 0833 # (namespaces, classes, functions, etc.) that should be excluded from the 0834 # output. The symbol name can be a fully qualified name, a word, or if the 0835 # wildcard * is used, a substring. Examples: ANamespace, AClass, 0836 # AClass::ANamespace, ANamespace::*Test 0837 # 0838 # Note that the wildcards are matched against the file with absolute path, so to 0839 # exclude all test directories use the pattern */test/* 0840 0841 EXCLUDE_SYMBOLS = 0842 0843 # The EXAMPLE_PATH tag can be used to specify one or more files or directories 0844 # that contain example code fragments that are included (see the \include 0845 # command). 0846 0847 EXAMPLE_PATH = 0848 0849 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 0850 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 0851 # *.h) to filter out the source-files in the directories. If left blank all 0852 # files are included. 0853 0854 EXAMPLE_PATTERNS = 0855 0856 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 0857 # searched for input files to be used with the \include or \dontinclude commands 0858 # irrespective of the value of the RECURSIVE tag. 0859 # The default value is: NO. 0860 0861 EXAMPLE_RECURSIVE = NO 0862 0863 # The IMAGE_PATH tag can be used to specify one or more files or directories 0864 # that contain images that are to be included in the documentation (see the 0865 # \image command). 0866 0867 IMAGE_PATH = 0868 0869 # The INPUT_FILTER tag can be used to specify a program that doxygen should 0870 # invoke to filter for each input file. Doxygen will invoke the filter program 0871 # by executing (via popen()) the command: 0872 # 0873 # <filter> <input-file> 0874 # 0875 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 0876 # name of an input file. Doxygen will then use the output that the filter 0877 # program writes to standard output. If FILTER_PATTERNS is specified, this tag 0878 # will be ignored. 0879 # 0880 # Note that the filter must not add or remove lines; it is applied before the 0881 # code is scanned, but not when the output code is generated. If lines are added 0882 # or removed, the anchors will not be placed correctly. 0883 # 0884 # Note that for custom extensions or not directly supported extensions you also 0885 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 0886 # properly processed by doxygen. 0887 0888 INPUT_FILTER = 0889 0890 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 0891 # basis. Doxygen will compare the file name with each pattern and apply the 0892 # filter if there is a match. The filters are a list of the form: pattern=filter 0893 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 0894 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 0895 # patterns match the file name, INPUT_FILTER is applied. 0896 # 0897 # Note that for custom extensions or not directly supported extensions you also 0898 # need to set EXTENSION_MAPPING for the extension otherwise the files are not 0899 # properly processed by doxygen. 0900 0901 FILTER_PATTERNS = 0902 0903 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 0904 # INPUT_FILTER) will also be used to filter the input files that are used for 0905 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 0906 # The default value is: NO. 0907 0908 FILTER_SOURCE_FILES = NO 0909 0910 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 0911 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 0912 # it is also possible to disable source filtering for a specific pattern using 0913 # *.ext= (so without naming a filter). 0914 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 0915 0916 FILTER_SOURCE_PATTERNS = 0917 0918 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 0919 # is part of the input, its contents will be placed on the main page 0920 # (index.html). This can be useful if you have a project on for instance GitHub 0921 # and want to reuse the introduction page also for the doxygen output. 0922 0923 USE_MDFILE_AS_MAINPAGE = 0924 0925 #--------------------------------------------------------------------------- 0926 # Configuration options related to source browsing 0927 #--------------------------------------------------------------------------- 0928 0929 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 0930 # generated. Documented entities will be cross-referenced with these sources. 0931 # 0932 # Note: To get rid of all source code in the generated output, make sure that 0933 # also VERBATIM_HEADERS is set to NO. 0934 # The default value is: NO. 0935 0936 SOURCE_BROWSER = NO 0937 0938 # Setting the INLINE_SOURCES tag to YES will include the body of functions, 0939 # classes and enums directly into the documentation. 0940 # The default value is: NO. 0941 0942 INLINE_SOURCES = NO 0943 0944 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 0945 # special comment blocks from generated source code fragments. Normal C, C++ and 0946 # Fortran comments will always remain visible. 0947 # The default value is: YES. 0948 0949 STRIP_CODE_COMMENTS = YES 0950 0951 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 0952 # function all documented functions referencing it will be listed. 0953 # The default value is: NO. 0954 0955 REFERENCED_BY_RELATION = NO 0956 0957 # If the REFERENCES_RELATION tag is set to YES then for each documented function 0958 # all documented entities called/used by that function will be listed. 0959 # The default value is: NO. 0960 0961 REFERENCES_RELATION = NO 0962 0963 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 0964 # to YES then the hyperlinks from functions in REFERENCES_RELATION and 0965 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 0966 # link to the documentation. 0967 # The default value is: YES. 0968 0969 REFERENCES_LINK_SOURCE = YES 0970 0971 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 0972 # source code will show a tooltip with additional information such as prototype, 0973 # brief description and links to the definition and documentation. Since this 0974 # will make the HTML file larger and loading of large files a bit slower, you 0975 # can opt to disable this feature. 0976 # The default value is: YES. 0977 # This tag requires that the tag SOURCE_BROWSER is set to YES. 0978 0979 SOURCE_TOOLTIPS = YES 0980 0981 # If the USE_HTAGS tag is set to YES then the references to source code will 0982 # point to the HTML generated by the htags(1) tool instead of doxygen built-in 0983 # source browser. The htags tool is part of GNU's global source tagging system 0984 # (see http://www.gnu.org/software/global/global.html). You will need version 0985 # 4.8.6 or higher. 0986 # 0987 # To use it do the following: 0988 # - Install the latest version of global 0989 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 0990 # - Make sure the INPUT points to the root of the source tree 0991 # - Run doxygen as normal 0992 # 0993 # Doxygen will invoke htags (and that will in turn invoke gtags), so these 0994 # tools must be available from the command line (i.e. in the search path). 0995 # 0996 # The result: instead of the source browser generated by doxygen, the links to 0997 # source code will now point to the output of htags. 0998 # The default value is: NO. 0999 # This tag requires that the tag SOURCE_BROWSER is set to YES. 1000 1001 USE_HTAGS = NO 1002 1003 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1004 # verbatim copy of the header file for each class for which an include is 1005 # specified. Set to NO to disable this. 1006 # See also: Section \class. 1007 # The default value is: YES. 1008 1009 VERBATIM_HEADERS = YES 1010 1011 #--------------------------------------------------------------------------- 1012 # Configuration options related to the alphabetical class index 1013 #--------------------------------------------------------------------------- 1014 1015 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1016 # compounds will be generated. Enable this if the project contains a lot of 1017 # classes, structs, unions or interfaces. 1018 # The default value is: YES. 1019 1020 ALPHABETICAL_INDEX = YES 1021 1022 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1023 # which the alphabetical index list will be split. 1024 # Minimum value: 1, maximum value: 20, default value: 5. 1025 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1026 1027 COLS_IN_ALPHA_INDEX = 5 1028 1029 # In case all classes in a project start with a common prefix, all classes will 1030 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1031 # can be used to specify a prefix (or a list of prefixes) that should be ignored 1032 # while generating the index headers. 1033 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1034 1035 IGNORE_PREFIX = 1036 1037 #--------------------------------------------------------------------------- 1038 # Configuration options related to the HTML output 1039 #--------------------------------------------------------------------------- 1040 1041 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1042 # The default value is: YES. 1043 1044 GENERATE_HTML = YES 1045 1046 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1047 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1048 # it. 1049 # The default directory is: html. 1050 # This tag requires that the tag GENERATE_HTML is set to YES. 1051 1052 HTML_OUTPUT = html 1053 1054 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1055 # generated HTML page (for example: .htm, .php, .asp). 1056 # The default value is: .html. 1057 # This tag requires that the tag GENERATE_HTML is set to YES. 1058 1059 HTML_FILE_EXTENSION = .html 1060 1061 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1062 # each generated HTML page. If the tag is left blank doxygen will generate a 1063 # standard header. 1064 # 1065 # To get valid HTML the header file that includes any scripts and style sheets 1066 # that doxygen needs, which is dependent on the configuration options used (e.g. 1067 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1068 # default header using 1069 # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1070 # YourConfigFile 1071 # and then modify the file new_header.html. See also section "Doxygen usage" 1072 # for information on how to generate the default header that doxygen normally 1073 # uses. 1074 # Note: The header is subject to change so you typically have to regenerate the 1075 # default header when upgrading to a newer version of doxygen. For a description 1076 # of the possible markers and block names see the documentation. 1077 # This tag requires that the tag GENERATE_HTML is set to YES. 1078 1079 HTML_HEADER = 1080 1081 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1082 # generated HTML page. If the tag is left blank doxygen will generate a standard 1083 # footer. See HTML_HEADER for more information on how to generate a default 1084 # footer and what special commands can be used inside the footer. See also 1085 # section "Doxygen usage" for information on how to generate the default footer 1086 # that doxygen normally uses. 1087 # This tag requires that the tag GENERATE_HTML is set to YES. 1088 1089 HTML_FOOTER = 1090 1091 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1092 # sheet that is used by each HTML page. It can be used to fine-tune the look of 1093 # the HTML output. If left blank doxygen will generate a default style sheet. 1094 # See also section "Doxygen usage" for information on how to generate the style 1095 # sheet that doxygen normally uses. 1096 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1097 # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1098 # obsolete. 1099 # This tag requires that the tag GENERATE_HTML is set to YES. 1100 1101 HTML_STYLESHEET = 1102 1103 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1104 # cascading style sheets that are included after the standard style sheets 1105 # created by doxygen. Using this option one can overrule certain style aspects. 1106 # This is preferred over using HTML_STYLESHEET since it does not replace the 1107 # standard style sheet and is therefore more robust against future updates. 1108 # Doxygen will copy the style sheet files to the output directory. 1109 # Note: The order of the extra style sheet files is of importance (e.g. the last 1110 # style sheet in the list overrules the setting of the previous ones in the 1111 # list). For an example see the documentation. 1112 # This tag requires that the tag GENERATE_HTML is set to YES. 1113 1114 HTML_EXTRA_STYLESHEET = 1115 1116 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1117 # other source files which should be copied to the HTML output directory. Note 1118 # that these files will be copied to the base HTML output directory. Use the 1119 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1120 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1121 # files will be copied as-is; there are no commands or markers available. 1122 # This tag requires that the tag GENERATE_HTML is set to YES. 1123 1124 HTML_EXTRA_FILES = 1125 1126 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1127 # will adjust the colors in the style sheet and background images according to 1128 # this color. Hue is specified as an angle on a colorwheel, see 1129 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1130 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1131 # purple, and 360 is red again. 1132 # Minimum value: 0, maximum value: 359, default value: 220. 1133 # This tag requires that the tag GENERATE_HTML is set to YES. 1134 1135 HTML_COLORSTYLE_HUE = 220 1136 1137 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1138 # in the HTML output. For a value of 0 the output will use grayscales only. A 1139 # value of 255 will produce the most vivid colors. 1140 # Minimum value: 0, maximum value: 255, default value: 100. 1141 # This tag requires that the tag GENERATE_HTML is set to YES. 1142 1143 HTML_COLORSTYLE_SAT = 100 1144 1145 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1146 # luminance component of the colors in the HTML output. Values below 100 1147 # gradually make the output lighter, whereas values above 100 make the output 1148 # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1149 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1150 # change the gamma. 1151 # Minimum value: 40, maximum value: 240, default value: 80. 1152 # This tag requires that the tag GENERATE_HTML is set to YES. 1153 1154 HTML_COLORSTYLE_GAMMA = 80 1155 1156 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1157 # page will contain the date and time when the page was generated. Setting this 1158 # to YES can help to show when doxygen was last run and thus if the 1159 # documentation is up to date. 1160 # The default value is: NO. 1161 # This tag requires that the tag GENERATE_HTML is set to YES. 1162 1163 HTML_TIMESTAMP = NO 1164 1165 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1166 # documentation will contain sections that can be hidden and shown after the 1167 # page has loaded. 1168 # The default value is: NO. 1169 # This tag requires that the tag GENERATE_HTML is set to YES. 1170 1171 HTML_DYNAMIC_SECTIONS = NO 1172 1173 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1174 # shown in the various tree structured indices initially; the user can expand 1175 # and collapse entries dynamically later on. Doxygen will expand the tree to 1176 # such a level that at most the specified number of entries are visible (unless 1177 # a fully collapsed tree already exceeds this amount). So setting the number of 1178 # entries 1 will produce a full collapsed tree by default. 0 is a special value 1179 # representing an infinite number of entries and will result in a full expanded 1180 # tree by default. 1181 # Minimum value: 0, maximum value: 9999, default value: 100. 1182 # This tag requires that the tag GENERATE_HTML is set to YES. 1183 1184 HTML_INDEX_NUM_ENTRIES = 100 1185 1186 # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1187 # generated that can be used as input for Apple's Xcode 3 integrated development 1188 # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1189 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1190 # Makefile in the HTML output directory. Running make will produce the docset in 1191 # that directory and running make install will install the docset in 1192 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1193 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1194 # for more information. 1195 # The default value is: NO. 1196 # This tag requires that the tag GENERATE_HTML is set to YES. 1197 1198 GENERATE_DOCSET = NO 1199 1200 # This tag determines the name of the docset feed. A documentation feed provides 1201 # an umbrella under which multiple documentation sets from a single provider 1202 # (such as a company or product suite) can be grouped. 1203 # The default value is: Doxygen generated docs. 1204 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1205 1206 DOCSET_FEEDNAME = "Doxygen generated docs" 1207 1208 # This tag specifies a string that should uniquely identify the documentation 1209 # set bundle. This should be a reverse domain-name style string, e.g. 1210 # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1211 # The default value is: org.doxygen.Project. 1212 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1213 1214 DOCSET_BUNDLE_ID = org.doxygen.Project 1215 1216 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1217 # the documentation publisher. This should be a reverse domain-name style 1218 # string, e.g. com.mycompany.MyDocSet.documentation. 1219 # The default value is: org.doxygen.Publisher. 1220 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1221 1222 DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1223 1224 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1225 # The default value is: Publisher. 1226 # This tag requires that the tag GENERATE_DOCSET is set to YES. 1227 1228 DOCSET_PUBLISHER_NAME = Publisher 1229 1230 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1231 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1232 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1233 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1234 # Windows. 1235 # 1236 # The HTML Help Workshop contains a compiler that can convert all HTML output 1237 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1238 # files are now used as the Windows 98 help format, and will replace the old 1239 # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1240 # HTML files also contain an index, a table of contents, and you can search for 1241 # words in the documentation. The HTML workshop also contains a viewer for 1242 # compressed HTML files. 1243 # The default value is: NO. 1244 # This tag requires that the tag GENERATE_HTML is set to YES. 1245 1246 GENERATE_HTMLHELP = NO 1247 1248 # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1249 # file. You can add a path in front of the file if the result should not be 1250 # written to the html output directory. 1251 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1252 1253 CHM_FILE = 1254 1255 # The HHC_LOCATION tag can be used to specify the location (absolute path 1256 # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1257 # doxygen will try to run the HTML help compiler on the generated index.hhp. 1258 # The file has to be specified with full path. 1259 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1260 1261 HHC_LOCATION = 1262 1263 # The GENERATE_CHI flag controls if a separate .chi index file is generated 1264 # (YES) or that it should be included in the master .chm file (NO). 1265 # The default value is: NO. 1266 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1267 1268 GENERATE_CHI = NO 1269 1270 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1271 # and project file content. 1272 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1273 1274 CHM_INDEX_ENCODING = 1275 1276 # The BINARY_TOC flag controls whether a binary table of contents is generated 1277 # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1278 # enables the Previous and Next buttons. 1279 # The default value is: NO. 1280 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1281 1282 BINARY_TOC = NO 1283 1284 # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1285 # the table of contents of the HTML help documentation and to the tree view. 1286 # The default value is: NO. 1287 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1288 1289 TOC_EXPAND = NO 1290 1291 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1292 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1293 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1294 # (.qch) of the generated HTML documentation. 1295 # The default value is: NO. 1296 # This tag requires that the tag GENERATE_HTML is set to YES. 1297 1298 GENERATE_QHP = NO 1299 1300 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1301 # the file name of the resulting .qch file. The path specified is relative to 1302 # the HTML output folder. 1303 # This tag requires that the tag GENERATE_QHP is set to YES. 1304 1305 QCH_FILE = 1306 1307 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1308 # Project output. For more information please see Qt Help Project / Namespace 1309 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1310 # The default value is: org.doxygen.Project. 1311 # This tag requires that the tag GENERATE_QHP is set to YES. 1312 1313 QHP_NAMESPACE = org.doxygen.Project 1314 1315 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1316 # Help Project output. For more information please see Qt Help Project / Virtual 1317 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1318 # folders). 1319 # The default value is: doc. 1320 # This tag requires that the tag GENERATE_QHP is set to YES. 1321 1322 QHP_VIRTUAL_FOLDER = doc 1323 1324 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1325 # filter to add. For more information please see Qt Help Project / Custom 1326 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1327 # filters). 1328 # This tag requires that the tag GENERATE_QHP is set to YES. 1329 1330 QHP_CUST_FILTER_NAME = 1331 1332 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1333 # custom filter to add. For more information please see Qt Help Project / Custom 1334 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1335 # filters). 1336 # This tag requires that the tag GENERATE_QHP is set to YES. 1337 1338 QHP_CUST_FILTER_ATTRS = 1339 1340 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1341 # project's filter section matches. Qt Help Project / Filter Attributes (see: 1342 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1343 # This tag requires that the tag GENERATE_QHP is set to YES. 1344 1345 QHP_SECT_FILTER_ATTRS = 1346 1347 # The QHG_LOCATION tag can be used to specify the location of Qt's 1348 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1349 # generated .qhp file. 1350 # This tag requires that the tag GENERATE_QHP is set to YES. 1351 1352 QHG_LOCATION = 1353 1354 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1355 # generated, together with the HTML files, they form an Eclipse help plugin. To 1356 # install this plugin and make it available under the help contents menu in 1357 # Eclipse, the contents of the directory containing the HTML and XML files needs 1358 # to be copied into the plugins directory of eclipse. The name of the directory 1359 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1360 # After copying Eclipse needs to be restarted before the help appears. 1361 # The default value is: NO. 1362 # This tag requires that the tag GENERATE_HTML is set to YES. 1363 1364 GENERATE_ECLIPSEHELP = NO 1365 1366 # A unique identifier for the Eclipse help plugin. When installing the plugin 1367 # the directory name containing the HTML and XML files should also have this 1368 # name. Each documentation set should have its own identifier. 1369 # The default value is: org.doxygen.Project. 1370 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1371 1372 ECLIPSE_DOC_ID = org.doxygen.Project 1373 1374 # If you want full control over the layout of the generated HTML pages it might 1375 # be necessary to disable the index and replace it with your own. The 1376 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1377 # of each HTML page. A value of NO enables the index and the value YES disables 1378 # it. Since the tabs in the index contain the same information as the navigation 1379 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1380 # The default value is: NO. 1381 # This tag requires that the tag GENERATE_HTML is set to YES. 1382 1383 DISABLE_INDEX = NO 1384 1385 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1386 # structure should be generated to display hierarchical information. If the tag 1387 # value is set to YES, a side panel will be generated containing a tree-like 1388 # index structure (just like the one that is generated for HTML Help). For this 1389 # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1390 # (i.e. any modern browser). Windows users are probably better off using the 1391 # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1392 # further fine-tune the look of the index. As an example, the default style 1393 # sheet generated by doxygen has an example that shows how to put an image at 1394 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1395 # the same information as the tab index, you could consider setting 1396 # DISABLE_INDEX to YES when enabling this option. 1397 # The default value is: NO. 1398 # This tag requires that the tag GENERATE_HTML is set to YES. 1399 1400 GENERATE_TREEVIEW = NO 1401 1402 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1403 # doxygen will group on one line in the generated HTML documentation. 1404 # 1405 # Note that a value of 0 will completely suppress the enum values from appearing 1406 # in the overview section. 1407 # Minimum value: 0, maximum value: 20, default value: 4. 1408 # This tag requires that the tag GENERATE_HTML is set to YES. 1409 1410 ENUM_VALUES_PER_LINE = 4 1411 1412 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1413 # to set the initial width (in pixels) of the frame in which the tree is shown. 1414 # Minimum value: 0, maximum value: 1500, default value: 250. 1415 # This tag requires that the tag GENERATE_HTML is set to YES. 1416 1417 TREEVIEW_WIDTH = 250 1418 1419 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1420 # external symbols imported via tag files in a separate window. 1421 # The default value is: NO. 1422 # This tag requires that the tag GENERATE_HTML is set to YES. 1423 1424 EXT_LINKS_IN_WINDOW = NO 1425 1426 # Use this tag to change the font size of LaTeX formulas included as images in 1427 # the HTML documentation. When you change the font size after a successful 1428 # doxygen run you need to manually remove any form_*.png images from the HTML 1429 # output directory to force them to be regenerated. 1430 # Minimum value: 8, maximum value: 50, default value: 10. 1431 # This tag requires that the tag GENERATE_HTML is set to YES. 1432 1433 FORMULA_FONTSIZE = 10 1434 1435 # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1436 # generated for formulas are transparent PNGs. Transparent PNGs are not 1437 # supported properly for IE 6.0, but are supported on all modern browsers. 1438 # 1439 # Note that when changing this option you need to delete any form_*.png files in 1440 # the HTML output directory before the changes have effect. 1441 # The default value is: YES. 1442 # This tag requires that the tag GENERATE_HTML is set to YES. 1443 1444 FORMULA_TRANSPARENT = YES 1445 1446 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1447 # http://www.mathjax.org) which uses client side Javascript for the rendering 1448 # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1449 # installed or if you want to formulas look prettier in the HTML output. When 1450 # enabled you may also need to install MathJax separately and configure the path 1451 # to it using the MATHJAX_RELPATH option. 1452 # The default value is: NO. 1453 # This tag requires that the tag GENERATE_HTML is set to YES. 1454 1455 USE_MATHJAX = NO 1456 1457 # When MathJax is enabled you can set the default output format to be used for 1458 # the MathJax output. See the MathJax site (see: 1459 # http://docs.mathjax.org/en/latest/output.html) for more details. 1460 # Possible values are: HTML-CSS (which is slower, but has the best 1461 # compatibility), NativeMML (i.e. MathML) and SVG. 1462 # The default value is: HTML-CSS. 1463 # This tag requires that the tag USE_MATHJAX is set to YES. 1464 1465 MATHJAX_FORMAT = HTML-CSS 1466 1467 # When MathJax is enabled you need to specify the location relative to the HTML 1468 # output directory using the MATHJAX_RELPATH option. The destination directory 1469 # should contain the MathJax.js script. For instance, if the mathjax directory 1470 # is located at the same level as the HTML output directory, then 1471 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1472 # Content Delivery Network so you can quickly see the result without installing 1473 # MathJax. However, it is strongly recommended to install a local copy of 1474 # MathJax from http://www.mathjax.org before deployment. 1475 # The default value is: http://cdn.mathjax.org/mathjax/latest. 1476 # This tag requires that the tag USE_MATHJAX is set to YES. 1477 1478 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1479 1480 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1481 # extension names that should be enabled during MathJax rendering. For example 1482 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1483 # This tag requires that the tag USE_MATHJAX is set to YES. 1484 1485 MATHJAX_EXTENSIONS = 1486 1487 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1488 # of code that will be used on startup of the MathJax code. See the MathJax site 1489 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1490 # example see the documentation. 1491 # This tag requires that the tag USE_MATHJAX is set to YES. 1492 1493 MATHJAX_CODEFILE = 1494 1495 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1496 # the HTML output. The underlying search engine uses javascript and DHTML and 1497 # should work on any modern browser. Note that when using HTML help 1498 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1499 # there is already a search function so this one should typically be disabled. 1500 # For large projects the javascript based search engine can be slow, then 1501 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1502 # search using the keyboard; to jump to the search box use <access key> + S 1503 # (what the <access key> is depends on the OS and browser, but it is typically 1504 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down 1505 # key> to jump into the search results window, the results can be navigated 1506 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel 1507 # the search. The filter options can be selected when the cursor is inside the 1508 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> 1509 # to select a filter and <Enter> or <escape> to activate or cancel the filter 1510 # option. 1511 # The default value is: YES. 1512 # This tag requires that the tag GENERATE_HTML is set to YES. 1513 1514 SEARCHENGINE = YES 1515 1516 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 1517 # implemented using a web server instead of a web client using Javascript. There 1518 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH 1519 # setting. When disabled, doxygen will generate a PHP script for searching and 1520 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing 1521 # and searching needs to be provided by external tools. See the section 1522 # "External Indexing and Searching" for details. 1523 # The default value is: NO. 1524 # This tag requires that the tag SEARCHENGINE is set to YES. 1525 1526 SERVER_BASED_SEARCH = NO 1527 1528 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP 1529 # script for searching. Instead the search results are written to an XML file 1530 # which needs to be processed by an external indexer. Doxygen will invoke an 1531 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the 1532 # search results. 1533 # 1534 # Doxygen ships with an example indexer (doxyindexer) and search engine 1535 # (doxysearch.cgi) which are based on the open source search engine library 1536 # Xapian (see: http://xapian.org/). 1537 # 1538 # See the section "External Indexing and Searching" for details. 1539 # The default value is: NO. 1540 # This tag requires that the tag SEARCHENGINE is set to YES. 1541 1542 EXTERNAL_SEARCH = NO 1543 1544 # The SEARCHENGINE_URL should point to a search engine hosted by a web server 1545 # which will return the search results when EXTERNAL_SEARCH is enabled. 1546 # 1547 # Doxygen ships with an example indexer (doxyindexer) and search engine 1548 # (doxysearch.cgi) which are based on the open source search engine library 1549 # Xapian (see: http://xapian.org/). See the section "External Indexing and 1550 # Searching" for details. 1551 # This tag requires that the tag SEARCHENGINE is set to YES. 1552 1553 SEARCHENGINE_URL = 1554 1555 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed 1556 # search data is written to a file for indexing by an external tool. With the 1557 # SEARCHDATA_FILE tag the name of this file can be specified. 1558 # The default file is: searchdata.xml. 1559 # This tag requires that the tag SEARCHENGINE is set to YES. 1560 1561 SEARCHDATA_FILE = searchdata.xml 1562 1563 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the 1564 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is 1565 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple 1566 # projects and redirect the results back to the right project. 1567 # This tag requires that the tag SEARCHENGINE is set to YES. 1568 1569 EXTERNAL_SEARCH_ID = 1570 1571 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen 1572 # projects other than the one defined by this configuration file, but that are 1573 # all added to the same external search index. Each project needs to have a 1574 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of 1575 # to a relative location where the documentation can be found. The format is: 1576 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... 1577 # This tag requires that the tag SEARCHENGINE is set to YES. 1578 1579 EXTRA_SEARCH_MAPPINGS = 1580 1581 #--------------------------------------------------------------------------- 1582 # Configuration options related to the LaTeX output 1583 #--------------------------------------------------------------------------- 1584 1585 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. 1586 # The default value is: YES. 1587 1588 GENERATE_LATEX = YES 1589 1590 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a 1591 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1592 # it. 1593 # The default directory is: latex. 1594 # This tag requires that the tag GENERATE_LATEX is set to YES. 1595 1596 LATEX_OUTPUT = latex 1597 1598 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 1599 # invoked. 1600 # 1601 # Note that when enabling USE_PDFLATEX this option is only used for generating 1602 # bitmaps for formulas in the HTML output, but not in the Makefile that is 1603 # written to the output directory. 1604 # The default file is: latex. 1605 # This tag requires that the tag GENERATE_LATEX is set to YES. 1606 1607 LATEX_CMD_NAME = latex 1608 1609 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate 1610 # index for LaTeX. 1611 # The default file is: makeindex. 1612 # This tag requires that the tag GENERATE_LATEX is set to YES. 1613 1614 MAKEINDEX_CMD_NAME = makeindex 1615 1616 # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX 1617 # documents. This may be useful for small projects and may help to save some 1618 # trees in general. 1619 # The default value is: NO. 1620 # This tag requires that the tag GENERATE_LATEX is set to YES. 1621 1622 COMPACT_LATEX = NO 1623 1624 # The PAPER_TYPE tag can be used to set the paper type that is used by the 1625 # printer. 1626 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 1627 # 14 inches) and executive (7.25 x 10.5 inches). 1628 # The default value is: a4. 1629 # This tag requires that the tag GENERATE_LATEX is set to YES. 1630 1631 PAPER_TYPE = a4 1632 1633 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names 1634 # that should be included in the LaTeX output. The package can be specified just 1635 # by its name or with the correct syntax as to be used with the LaTeX 1636 # \usepackage command. To get the times font for instance you can specify : 1637 # EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} 1638 # To use the option intlimits with the amsmath package you can specify: 1639 # EXTRA_PACKAGES=[intlimits]{amsmath} 1640 # If left blank no extra packages will be included. 1641 # This tag requires that the tag GENERATE_LATEX is set to YES. 1642 1643 EXTRA_PACKAGES = 1644 1645 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the 1646 # generated LaTeX document. The header should contain everything until the first 1647 # chapter. If it is left blank doxygen will generate a standard header. See 1648 # section "Doxygen usage" for information on how to let doxygen write the 1649 # default header to a separate file. 1650 # 1651 # Note: Only use a user-defined header if you know what you are doing! The 1652 # following commands have a special meaning inside the header: $title, 1653 # $datetime, $date, $doxygenversion, $projectname, $projectnumber, 1654 # $projectbrief, $projectlogo. Doxygen will replace $title with the empty 1655 # string, for the replacement values of the other commands the user is referred 1656 # to HTML_HEADER. 1657 # This tag requires that the tag GENERATE_LATEX is set to YES. 1658 1659 LATEX_HEADER = 1660 1661 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the 1662 # generated LaTeX document. The footer should contain everything after the last 1663 # chapter. If it is left blank doxygen will generate a standard footer. See 1664 # LATEX_HEADER for more information on how to generate a default footer and what 1665 # special commands can be used inside the footer. 1666 # 1667 # Note: Only use a user-defined footer if you know what you are doing! 1668 # This tag requires that the tag GENERATE_LATEX is set to YES. 1669 1670 LATEX_FOOTER = 1671 1672 # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1673 # LaTeX style sheets that are included after the standard style sheets created 1674 # by doxygen. Using this option one can overrule certain style aspects. Doxygen 1675 # will copy the style sheet files to the output directory. 1676 # Note: The order of the extra style sheet files is of importance (e.g. the last 1677 # style sheet in the list overrules the setting of the previous ones in the 1678 # list). 1679 # This tag requires that the tag GENERATE_LATEX is set to YES. 1680 1681 LATEX_EXTRA_STYLESHEET = 1682 1683 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or 1684 # other source files which should be copied to the LATEX_OUTPUT output 1685 # directory. Note that the files will be copied as-is; there are no commands or 1686 # markers available. 1687 # This tag requires that the tag GENERATE_LATEX is set to YES. 1688 1689 LATEX_EXTRA_FILES = 1690 1691 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is 1692 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will 1693 # contain links (just like the HTML output) instead of page references. This 1694 # makes the output suitable for online browsing using a PDF viewer. 1695 # The default value is: YES. 1696 # This tag requires that the tag GENERATE_LATEX is set to YES. 1697 1698 PDF_HYPERLINKS = YES 1699 1700 # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate 1701 # the PDF file directly from the LaTeX files. Set this option to YES, to get a 1702 # higher quality PDF documentation. 1703 # The default value is: YES. 1704 # This tag requires that the tag GENERATE_LATEX is set to YES. 1705 1706 USE_PDFLATEX = YES 1707 1708 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode 1709 # command to the generated LaTeX files. This will instruct LaTeX to keep running 1710 # if errors occur, instead of asking the user for help. This option is also used 1711 # when generating formulas in HTML. 1712 # The default value is: NO. 1713 # This tag requires that the tag GENERATE_LATEX is set to YES. 1714 1715 LATEX_BATCHMODE = NO 1716 1717 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the 1718 # index chapters (such as File Index, Compound Index, etc.) in the output. 1719 # The default value is: NO. 1720 # This tag requires that the tag GENERATE_LATEX is set to YES. 1721 1722 LATEX_HIDE_INDICES = NO 1723 1724 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source 1725 # code with syntax highlighting in the LaTeX output. 1726 # 1727 # Note that which sources are shown also depends on other settings such as 1728 # SOURCE_BROWSER. 1729 # The default value is: NO. 1730 # This tag requires that the tag GENERATE_LATEX is set to YES. 1731 1732 LATEX_SOURCE_CODE = NO 1733 1734 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the 1735 # bibliography, e.g. plainnat, or ieeetr. See 1736 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info. 1737 # The default value is: plain. 1738 # This tag requires that the tag GENERATE_LATEX is set to YES. 1739 1740 LATEX_BIB_STYLE = plain 1741 1742 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated 1743 # page will contain the date and time when the page was generated. Setting this 1744 # to NO can help when comparing the output of multiple runs. 1745 # The default value is: NO. 1746 # This tag requires that the tag GENERATE_LATEX is set to YES. 1747 1748 LATEX_TIMESTAMP = NO 1749 1750 #--------------------------------------------------------------------------- 1751 # Configuration options related to the RTF output 1752 #--------------------------------------------------------------------------- 1753 1754 # If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The 1755 # RTF output is optimized for Word 97 and may not look too pretty with other RTF 1756 # readers/editors. 1757 # The default value is: NO. 1758 1759 GENERATE_RTF = NO 1760 1761 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a 1762 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1763 # it. 1764 # The default directory is: rtf. 1765 # This tag requires that the tag GENERATE_RTF is set to YES. 1766 1767 RTF_OUTPUT = rtf 1768 1769 # If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF 1770 # documents. This may be useful for small projects and may help to save some 1771 # trees in general. 1772 # The default value is: NO. 1773 # This tag requires that the tag GENERATE_RTF is set to YES. 1774 1775 COMPACT_RTF = NO 1776 1777 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will 1778 # contain hyperlink fields. The RTF file will contain links (just like the HTML 1779 # output) instead of page references. This makes the output suitable for online 1780 # browsing using Word or some other Word compatible readers that support those 1781 # fields. 1782 # 1783 # Note: WordPad (write) and others do not support links. 1784 # The default value is: NO. 1785 # This tag requires that the tag GENERATE_RTF is set to YES. 1786 1787 RTF_HYPERLINKS = NO 1788 1789 # Load stylesheet definitions from file. Syntax is similar to doxygen's config 1790 # file, i.e. a series of assignments. You only have to provide replacements, 1791 # missing definitions are set to their default value. 1792 # 1793 # See also section "Doxygen usage" for information on how to generate the 1794 # default style sheet that doxygen normally uses. 1795 # This tag requires that the tag GENERATE_RTF is set to YES. 1796 1797 RTF_STYLESHEET_FILE = 1798 1799 # Set optional variables used in the generation of an RTF document. Syntax is 1800 # similar to doxygen's config file. A template extensions file can be generated 1801 # using doxygen -e rtf extensionFile. 1802 # This tag requires that the tag GENERATE_RTF is set to YES. 1803 1804 RTF_EXTENSIONS_FILE = 1805 1806 # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code 1807 # with syntax highlighting in the RTF output. 1808 # 1809 # Note that which sources are shown also depends on other settings such as 1810 # SOURCE_BROWSER. 1811 # The default value is: NO. 1812 # This tag requires that the tag GENERATE_RTF is set to YES. 1813 1814 RTF_SOURCE_CODE = NO 1815 1816 #--------------------------------------------------------------------------- 1817 # Configuration options related to the man page output 1818 #--------------------------------------------------------------------------- 1819 1820 # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for 1821 # classes and files. 1822 # The default value is: NO. 1823 1824 GENERATE_MAN = NO 1825 1826 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a 1827 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1828 # it. A directory man3 will be created inside the directory specified by 1829 # MAN_OUTPUT. 1830 # The default directory is: man. 1831 # This tag requires that the tag GENERATE_MAN is set to YES. 1832 1833 MAN_OUTPUT = man 1834 1835 # The MAN_EXTENSION tag determines the extension that is added to the generated 1836 # man pages. In case the manual section does not start with a number, the number 1837 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is 1838 # optional. 1839 # The default value is: .3. 1840 # This tag requires that the tag GENERATE_MAN is set to YES. 1841 1842 MAN_EXTENSION = .3 1843 1844 # The MAN_SUBDIR tag determines the name of the directory created within 1845 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by 1846 # MAN_EXTENSION with the initial . removed. 1847 # This tag requires that the tag GENERATE_MAN is set to YES. 1848 1849 MAN_SUBDIR = 1850 1851 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it 1852 # will generate one additional man file for each entity documented in the real 1853 # man page(s). These additional files only source the real man page, but without 1854 # them the man command would be unable to find the correct page. 1855 # The default value is: NO. 1856 # This tag requires that the tag GENERATE_MAN is set to YES. 1857 1858 MAN_LINKS = NO 1859 1860 #--------------------------------------------------------------------------- 1861 # Configuration options related to the XML output 1862 #--------------------------------------------------------------------------- 1863 1864 # If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that 1865 # captures the structure of the code including all documentation. 1866 # The default value is: NO. 1867 1868 GENERATE_XML = NO 1869 1870 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a 1871 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1872 # it. 1873 # The default directory is: xml. 1874 # This tag requires that the tag GENERATE_XML is set to YES. 1875 1876 XML_OUTPUT = xml 1877 1878 # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program 1879 # listings (including syntax highlighting and cross-referencing information) to 1880 # the XML output. Note that enabling this will significantly increase the size 1881 # of the XML output. 1882 # The default value is: YES. 1883 # This tag requires that the tag GENERATE_XML is set to YES. 1884 1885 XML_PROGRAMLISTING = YES 1886 1887 #--------------------------------------------------------------------------- 1888 # Configuration options related to the DOCBOOK output 1889 #--------------------------------------------------------------------------- 1890 1891 # If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files 1892 # that can be used to generate PDF. 1893 # The default value is: NO. 1894 1895 GENERATE_DOCBOOK = NO 1896 1897 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. 1898 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in 1899 # front of it. 1900 # The default directory is: docbook. 1901 # This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1902 1903 DOCBOOK_OUTPUT = docbook 1904 1905 # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the 1906 # program listings (including syntax highlighting and cross-referencing 1907 # information) to the DOCBOOK output. Note that enabling this will significantly 1908 # increase the size of the DOCBOOK output. 1909 # The default value is: NO. 1910 # This tag requires that the tag GENERATE_DOCBOOK is set to YES. 1911 1912 DOCBOOK_PROGRAMLISTING = NO 1913 1914 #--------------------------------------------------------------------------- 1915 # Configuration options for the AutoGen Definitions output 1916 #--------------------------------------------------------------------------- 1917 1918 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an 1919 # AutoGen Definitions (see http://autogen.sf.net) file that captures the 1920 # structure of the code including all documentation. Note that this feature is 1921 # still experimental and incomplete at the moment. 1922 # The default value is: NO. 1923 1924 GENERATE_AUTOGEN_DEF = NO 1925 1926 #--------------------------------------------------------------------------- 1927 # Configuration options related to the Perl module output 1928 #--------------------------------------------------------------------------- 1929 1930 # If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module 1931 # file that captures the structure of the code including all documentation. 1932 # 1933 # Note that this feature is still experimental and incomplete at the moment. 1934 # The default value is: NO. 1935 1936 GENERATE_PERLMOD = NO 1937 1938 # If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary 1939 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI 1940 # output from the Perl module output. 1941 # The default value is: NO. 1942 # This tag requires that the tag GENERATE_PERLMOD is set to YES. 1943 1944 PERLMOD_LATEX = NO 1945 1946 # If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely 1947 # formatted so it can be parsed by a human reader. This is useful if you want to 1948 # understand what is going on. On the other hand, if this tag is set to NO, the 1949 # size of the Perl module output will be much smaller and Perl will parse it 1950 # just the same. 1951 # The default value is: YES. 1952 # This tag requires that the tag GENERATE_PERLMOD is set to YES. 1953 1954 PERLMOD_PRETTY = YES 1955 1956 # The names of the make variables in the generated doxyrules.make file are 1957 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful 1958 # so different doxyrules.make files included by the same Makefile don't 1959 # overwrite each other's variables. 1960 # This tag requires that the tag GENERATE_PERLMOD is set to YES. 1961 1962 PERLMOD_MAKEVAR_PREFIX = 1963 1964 #--------------------------------------------------------------------------- 1965 # Configuration options related to the preprocessor 1966 #--------------------------------------------------------------------------- 1967 1968 # If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all 1969 # C-preprocessor directives found in the sources and include files. 1970 # The default value is: YES. 1971 1972 ENABLE_PREPROCESSING = YES 1973 1974 # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names 1975 # in the source code. If set to NO, only conditional compilation will be 1976 # performed. Macro expansion can be done in a controlled way by setting 1977 # EXPAND_ONLY_PREDEF to YES. 1978 # The default value is: NO. 1979 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1980 1981 MACRO_EXPANSION = NO 1982 1983 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 1984 # the macro expansion is limited to the macros specified with the PREDEFINED and 1985 # EXPAND_AS_DEFINED tags. 1986 # The default value is: NO. 1987 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1988 1989 EXPAND_ONLY_PREDEF = NO 1990 1991 # If the SEARCH_INCLUDES tag is set to YES, the include files in the 1992 # INCLUDE_PATH will be searched if a #include is found. 1993 # The default value is: YES. 1994 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 1995 1996 SEARCH_INCLUDES = YES 1997 1998 # The INCLUDE_PATH tag can be used to specify one or more directories that 1999 # contain include files that are not input files but should be processed by the 2000 # preprocessor. 2001 # This tag requires that the tag SEARCH_INCLUDES is set to YES. 2002 2003 INCLUDE_PATH = 2004 2005 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 2006 # patterns (like *.h and *.hpp) to filter out the header-files in the 2007 # directories. If left blank, the patterns specified with FILE_PATTERNS will be 2008 # used. 2009 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2010 2011 INCLUDE_FILE_PATTERNS = 2012 2013 # The PREDEFINED tag can be used to specify one or more macro names that are 2014 # defined before the preprocessor is started (similar to the -D option of e.g. 2015 # gcc). The argument of the tag is a list of macros of the form: name or 2016 # name=definition (no spaces). If the definition and the "=" are omitted, "=1" 2017 # is assumed. To prevent a macro definition from being undefined via #undef or 2018 # recursively expanded use the := operator instead of the = operator. 2019 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2020 2021 PREDEFINED = 2022 2023 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this 2024 # tag can be used to specify a list of macro names that should be expanded. The 2025 # macro definition that is found in the sources will be used. Use the PREDEFINED 2026 # tag if you want to use a different macro definition that overrules the 2027 # definition found in the source code. 2028 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2029 2030 EXPAND_AS_DEFINED = 2031 2032 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will 2033 # remove all references to function-like macros that are alone on a line, have 2034 # an all uppercase name, and do not end with a semicolon. Such function macros 2035 # are typically used for boiler-plate code, and will confuse the parser if not 2036 # removed. 2037 # The default value is: YES. 2038 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 2039 2040 SKIP_FUNCTION_MACROS = YES 2041 2042 #--------------------------------------------------------------------------- 2043 # Configuration options related to external references 2044 #--------------------------------------------------------------------------- 2045 2046 # The TAGFILES tag can be used to specify one or more tag files. For each tag 2047 # file the location of the external documentation should be added. The format of 2048 # a tag file without this location is as follows: 2049 # TAGFILES = file1 file2 ... 2050 # Adding location for the tag files is done as follows: 2051 # TAGFILES = file1=loc1 "file2 = loc2" ... 2052 # where loc1 and loc2 can be relative or absolute paths or URLs. See the 2053 # section "Linking to external documentation" for more information about the use 2054 # of tag files. 2055 # Note: Each tag file must have a unique name (where the name does NOT include 2056 # the path). If a tag file is not located in the directory in which doxygen is 2057 # run, you must also specify the path to the tagfile here. 2058 2059 TAGFILES = 2060 2061 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a 2062 # tag file that is based on the input files it reads. See section "Linking to 2063 # external documentation" for more information about the usage of tag files. 2064 2065 GENERATE_TAGFILE = 2066 2067 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in 2068 # the class index. If set to NO, only the inherited external classes will be 2069 # listed. 2070 # The default value is: NO. 2071 2072 ALLEXTERNALS = NO 2073 2074 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed 2075 # in the modules index. If set to NO, only the current project's groups will be 2076 # listed. 2077 # The default value is: YES. 2078 2079 EXTERNAL_GROUPS = YES 2080 2081 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in 2082 # the related pages index. If set to NO, only the current project's pages will 2083 # be listed. 2084 # The default value is: YES. 2085 2086 EXTERNAL_PAGES = YES 2087 2088 # The PERL_PATH should be the absolute path and name of the perl script 2089 # interpreter (i.e. the result of 'which perl'). 2090 # The default file (with absolute path) is: /usr/bin/perl. 2091 2092 PERL_PATH = /usr/bin/perl 2093 2094 #--------------------------------------------------------------------------- 2095 # Configuration options related to the dot tool 2096 #--------------------------------------------------------------------------- 2097 2098 # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram 2099 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to 2100 # NO turns the diagrams off. Note that this option also works with HAVE_DOT 2101 # disabled, but it is recommended to install and use dot, since it yields more 2102 # powerful graphs. 2103 # The default value is: YES. 2104 2105 CLASS_DIAGRAMS = YES 2106 2107 # You can define message sequence charts within doxygen comments using the \msc 2108 # command. Doxygen will then run the mscgen tool (see: 2109 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the 2110 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 2111 # the mscgen tool resides. If left empty the tool is assumed to be found in the 2112 # default search path. 2113 2114 MSCGEN_PATH = 2115 2116 # You can include diagrams made with dia in doxygen documentation. Doxygen will 2117 # then run dia to produce the diagram and insert it in the documentation. The 2118 # DIA_PATH tag allows you to specify the directory where the dia binary resides. 2119 # If left empty dia is assumed to be found in the default search path. 2120 2121 DIA_PATH = 2122 2123 # If set to YES the inheritance and collaboration graphs will hide inheritance 2124 # and usage relations if the target is undocumented or is not a class. 2125 # The default value is: YES. 2126 2127 HIDE_UNDOC_RELATIONS = YES 2128 2129 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 2130 # available from the path. This tool is part of Graphviz (see: 2131 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 2132 # Bell Labs. The other options in this section have no effect if this option is 2133 # set to NO 2134 # The default value is: NO. 2135 2136 HAVE_DOT = NO 2137 2138 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed 2139 # to run in parallel. When set to 0 doxygen will base this on the number of 2140 # processors available in the system. You can set it explicitly to a value 2141 # larger than 0 to get control over the balance between CPU load and processing 2142 # speed. 2143 # Minimum value: 0, maximum value: 32, default value: 0. 2144 # This tag requires that the tag HAVE_DOT is set to YES. 2145 2146 DOT_NUM_THREADS = 0 2147 2148 # When you want a differently looking font in the dot files that doxygen 2149 # generates you can specify the font name using DOT_FONTNAME. You need to make 2150 # sure dot is able to find the font, which can be done by putting it in a 2151 # standard location or by setting the DOTFONTPATH environment variable or by 2152 # setting DOT_FONTPATH to the directory containing the font. 2153 # The default value is: Helvetica. 2154 # This tag requires that the tag HAVE_DOT is set to YES. 2155 2156 DOT_FONTNAME = Helvetica 2157 2158 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of 2159 # dot graphs. 2160 # Minimum value: 4, maximum value: 24, default value: 10. 2161 # This tag requires that the tag HAVE_DOT is set to YES. 2162 2163 DOT_FONTSIZE = 10 2164 2165 # By default doxygen will tell dot to use the default font as specified with 2166 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set 2167 # the path where dot can find it using this tag. 2168 # This tag requires that the tag HAVE_DOT is set to YES. 2169 2170 DOT_FONTPATH = 2171 2172 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for 2173 # each documented class showing the direct and indirect inheritance relations. 2174 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. 2175 # The default value is: YES. 2176 # This tag requires that the tag HAVE_DOT is set to YES. 2177 2178 CLASS_GRAPH = YES 2179 2180 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a 2181 # graph for each documented class showing the direct and indirect implementation 2182 # dependencies (inheritance, containment, and class references variables) of the 2183 # class with other documented classes. 2184 # The default value is: YES. 2185 # This tag requires that the tag HAVE_DOT is set to YES. 2186 2187 COLLABORATION_GRAPH = YES 2188 2189 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for 2190 # groups, showing the direct groups dependencies. 2191 # The default value is: YES. 2192 # This tag requires that the tag HAVE_DOT is set to YES. 2193 2194 GROUP_GRAPHS = YES 2195 2196 # If the UML_LOOK tag is set to YES, doxygen will generate inheritance and 2197 # collaboration diagrams in a style similar to the OMG's Unified Modeling 2198 # Language. 2199 # The default value is: NO. 2200 # This tag requires that the tag HAVE_DOT is set to YES. 2201 2202 UML_LOOK = NO 2203 2204 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the 2205 # class node. If there are many fields or methods and many nodes the graph may 2206 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the 2207 # number of items for each type to make the size more manageable. Set this to 0 2208 # for no limit. Note that the threshold may be exceeded by 50% before the limit 2209 # is enforced. So when you set the threshold to 10, up to 15 fields may appear, 2210 # but if the number exceeds 15, the total amount of fields shown is limited to 2211 # 10. 2212 # Minimum value: 0, maximum value: 100, default value: 10. 2213 # This tag requires that the tag HAVE_DOT is set to YES. 2214 2215 UML_LIMIT_NUM_FIELDS = 10 2216 2217 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and 2218 # collaboration graphs will show the relations between templates and their 2219 # instances. 2220 # The default value is: NO. 2221 # This tag requires that the tag HAVE_DOT is set to YES. 2222 2223 TEMPLATE_RELATIONS = NO 2224 2225 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to 2226 # YES then doxygen will generate a graph for each documented file showing the 2227 # direct and indirect include dependencies of the file with other documented 2228 # files. 2229 # The default value is: YES. 2230 # This tag requires that the tag HAVE_DOT is set to YES. 2231 2232 INCLUDE_GRAPH = YES 2233 2234 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are 2235 # set to YES then doxygen will generate a graph for each documented file showing 2236 # the direct and indirect include dependencies of the file with other documented 2237 # files. 2238 # The default value is: YES. 2239 # This tag requires that the tag HAVE_DOT is set to YES. 2240 2241 INCLUDED_BY_GRAPH = YES 2242 2243 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call 2244 # dependency graph for every global function or class method. 2245 # 2246 # Note that enabling this option will significantly increase the time of a run. 2247 # So in most cases it will be better to enable call graphs for selected 2248 # functions only using the \callgraph command. Disabling a call graph can be 2249 # accomplished by means of the command \hidecallgraph. 2250 # The default value is: NO. 2251 # This tag requires that the tag HAVE_DOT is set to YES. 2252 2253 CALL_GRAPH = NO 2254 2255 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller 2256 # dependency graph for every global function or class method. 2257 # 2258 # Note that enabling this option will significantly increase the time of a run. 2259 # So in most cases it will be better to enable caller graphs for selected 2260 # functions only using the \callergraph command. Disabling a caller graph can be 2261 # accomplished by means of the command \hidecallergraph. 2262 # The default value is: NO. 2263 # This tag requires that the tag HAVE_DOT is set to YES. 2264 2265 CALLER_GRAPH = NO 2266 2267 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical 2268 # hierarchy of all classes instead of a textual one. 2269 # The default value is: YES. 2270 # This tag requires that the tag HAVE_DOT is set to YES. 2271 2272 GRAPHICAL_HIERARCHY = YES 2273 2274 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the 2275 # dependencies a directory has on other directories in a graphical way. The 2276 # dependency relations are determined by the #include relations between the 2277 # files in the directories. 2278 # The default value is: YES. 2279 # This tag requires that the tag HAVE_DOT is set to YES. 2280 2281 DIRECTORY_GRAPH = YES 2282 2283 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 2284 # generated by dot. For an explanation of the image formats see the section 2285 # output formats in the documentation of the dot tool (Graphviz (see: 2286 # http://www.graphviz.org/)). 2287 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order 2288 # to make the SVG files visible in IE 9+ (other browsers do not have this 2289 # requirement). 2290 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, 2291 # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and 2292 # png:gdiplus:gdiplus. 2293 # The default value is: png. 2294 # This tag requires that the tag HAVE_DOT is set to YES. 2295 2296 DOT_IMAGE_FORMAT = png 2297 2298 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to 2299 # enable generation of interactive SVG images that allow zooming and panning. 2300 # 2301 # Note that this requires a modern browser other than Internet Explorer. Tested 2302 # and working are Firefox, Chrome, Safari, and Opera. 2303 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make 2304 # the SVG files visible. Older versions of IE do not have SVG support. 2305 # The default value is: NO. 2306 # This tag requires that the tag HAVE_DOT is set to YES. 2307 2308 INTERACTIVE_SVG = NO 2309 2310 # The DOT_PATH tag can be used to specify the path where the dot tool can be 2311 # found. If left blank, it is assumed the dot tool can be found in the path. 2312 # This tag requires that the tag HAVE_DOT is set to YES. 2313 2314 DOT_PATH = 2315 2316 # The DOTFILE_DIRS tag can be used to specify one or more directories that 2317 # contain dot files that are included in the documentation (see the \dotfile 2318 # command). 2319 # This tag requires that the tag HAVE_DOT is set to YES. 2320 2321 DOTFILE_DIRS = 2322 2323 # The MSCFILE_DIRS tag can be used to specify one or more directories that 2324 # contain msc files that are included in the documentation (see the \mscfile 2325 # command). 2326 2327 MSCFILE_DIRS = 2328 2329 # The DIAFILE_DIRS tag can be used to specify one or more directories that 2330 # contain dia files that are included in the documentation (see the \diafile 2331 # command). 2332 2333 DIAFILE_DIRS = 2334 2335 # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the 2336 # path where java can find the plantuml.jar file. If left blank, it is assumed 2337 # PlantUML is not used or called during a preprocessing step. Doxygen will 2338 # generate a warning when it encounters a \startuml command in this case and 2339 # will not generate output for the diagram. 2340 2341 PLANTUML_JAR_PATH = 2342 2343 # When using plantuml, the specified paths are searched for files specified by 2344 # the !include statement in a plantuml block. 2345 2346 PLANTUML_INCLUDE_PATH = 2347 2348 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes 2349 # that will be shown in the graph. If the number of nodes in a graph becomes 2350 # larger than this value, doxygen will truncate the graph, which is visualized 2351 # by representing a node as a red box. Note that doxygen if the number of direct 2352 # children of the root node in a graph is already larger than 2353 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that 2354 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 2355 # Minimum value: 0, maximum value: 10000, default value: 50. 2356 # This tag requires that the tag HAVE_DOT is set to YES. 2357 2358 DOT_GRAPH_MAX_NODES = 50 2359 2360 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs 2361 # generated by dot. A depth value of 3 means that only nodes reachable from the 2362 # root by following a path via at most 3 edges will be shown. Nodes that lay 2363 # further from the root node will be omitted. Note that setting this option to 1 2364 # or 2 may greatly reduce the computation time needed for large code bases. Also 2365 # note that the size of a graph can be further restricted by 2366 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 2367 # Minimum value: 0, maximum value: 1000, default value: 0. 2368 # This tag requires that the tag HAVE_DOT is set to YES. 2369 2370 MAX_DOT_GRAPH_DEPTH = 0 2371 2372 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 2373 # background. This is disabled by default, because dot on Windows does not seem 2374 # to support this out of the box. 2375 # 2376 # Warning: Depending on the platform used, enabling this option may lead to 2377 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 2378 # read). 2379 # The default value is: NO. 2380 # This tag requires that the tag HAVE_DOT is set to YES. 2381 2382 DOT_TRANSPARENT = NO 2383 2384 # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output 2385 # files in one run (i.e. multiple -o and -T options on the command line). This 2386 # makes dot run faster, but since only newer versions of dot (>1.8.10) support 2387 # this, this feature is disabled by default. 2388 # The default value is: NO. 2389 # This tag requires that the tag HAVE_DOT is set to YES. 2390 2391 DOT_MULTI_TARGETS = NO 2392 2393 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page 2394 # explaining the meaning of the various boxes and arrows in the dot generated 2395 # graphs. 2396 # The default value is: YES. 2397 # This tag requires that the tag HAVE_DOT is set to YES. 2398 2399 GENERATE_LEGEND = YES 2400 2401 # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot 2402 # files that are used to generate the various graphs. 2403 # The default value is: YES. 2404 # This tag requires that the tag HAVE_DOT is set to YES. 2405 2406 DOT_CLEANUP = YES