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