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