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