Warning, /office/alkimia/src/libalkimia.doxygen.in is written in an unsupported language. File is not indexed.
0001 # Doxyfile 1.5.8 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 a sequence of words surrounded 0026 # by quotes) that should identify the project. 0027 0028 PROJECT_NAME = ${PROJECT_NAME} 0029 0030 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 0031 # This could be handy for archiving the generated documentation or 0032 # if some version control system is used. 0033 0034 PROJECT_NUMBER = ${ALKIMIA_LIB_VERSION}${VERSION_SUFFIX} 0035 0036 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 0037 # base path where the generated documentation will be put. 0038 # If a relative path is entered, it will be relative to the location 0039 # where doxygen was started. If left blank the current directory will be used. 0040 0041 OUTPUT_DIRECTORY = ${APIDOC_DIR} 0042 0043 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 0044 # 4096 sub-directories (in 2 levels) under the output directory of each output 0045 # format and will distribute the generated files over these directories. 0046 # Enabling this option can be useful when feeding doxygen a huge amount of 0047 # source files, where putting all generated files in the same directory would 0048 # otherwise cause performance problems for the file system. 0049 0050 CREATE_SUBDIRS = NO 0051 0052 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 0053 # documentation generated by doxygen is written. Doxygen will use this 0054 # information to generate all constant output in the proper language. 0055 # The default language is English, other supported languages are: 0056 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 0057 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 0058 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 0059 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 0060 # Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, 0061 # Spanish, Swedish, and Ukrainian. 0062 0063 OUTPUT_LANGUAGE = English 0064 0065 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 0066 # include brief member descriptions after the members that are listed in 0067 # the file and class documentation (similar to JavaDoc). 0068 # Set to NO to disable this. 0069 0070 BRIEF_MEMBER_DESC = YES 0071 0072 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 0073 # the brief description of a member or function before the detailed description. 0074 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 0075 # brief descriptions will be completely suppressed. 0076 0077 REPEAT_BRIEF = YES 0078 0079 # This tag implements a quasi-intelligent brief description abbreviator 0080 # that is used to form the text in various listings. Each string 0081 # in this list, if found as the leading text of the brief description, will be 0082 # stripped from the text and the result after processing the whole list, is 0083 # used as the annotated text. Otherwise, the brief description is used as-is. 0084 # If left blank, the following values are used ("$name" is automatically 0085 # replaced with the name of the entity): "The $name class" "The $name widget" 0086 # "The $name file" "is" "provides" "specifies" "contains" 0087 # "represents" "a" "an" "the" 0088 0089 ABBREVIATE_BRIEF = 0090 0091 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 0092 # Doxygen will generate a detailed section even if there is only a brief 0093 # description. 0094 0095 ALWAYS_DETAILED_SEC = NO 0096 0097 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 0098 # inherited members of a class in the documentation of that class as if those 0099 # members were ordinary class members. Constructors, destructors and assignment 0100 # operators of the base classes will not be shown. 0101 0102 INLINE_INHERITED_MEMB = NO 0103 0104 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 0105 # path before files name in the file list and in the header files. If set 0106 # to NO the shortest path that makes the file name unique will be used. 0107 0108 FULL_PATH_NAMES = NO 0109 0110 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 0111 # can be used to strip a user-defined part of the path. Stripping is 0112 # only done if one of the specified strings matches the left-hand part of 0113 # the path. The tag can be used to show relative paths in the file list. 0114 # If left blank the directory from which doxygen is run is used as the 0115 # path to strip. 0116 0117 STRIP_FROM_PATH = 0118 0119 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 0120 # the path mentioned in the documentation of a class, which tells 0121 # the reader which header file to include in order to use a class. 0122 # If left blank only the name of the header file containing the class 0123 # definition is used. Otherwise one should specify the include paths that 0124 # are normally passed to the compiler using the -I flag. 0125 0126 STRIP_FROM_INC_PATH = 0127 0128 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 0129 # (but less readable) file names. This can be useful is your file systems 0130 # doesn't support long names like on DOS, Mac, or CD-ROM. 0131 0132 SHORT_NAMES = NO 0133 0134 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 0135 # will interpret the first line (until the first dot) of a JavaDoc-style 0136 # comment as the brief description. If set to NO, the JavaDoc 0137 # comments will behave just like regular Qt-style comments 0138 # (thus requiring an explicit @brief command for a brief description.) 0139 0140 JAVADOC_AUTOBRIEF = NO 0141 0142 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 0143 # interpret the first line (until the first dot) of a Qt-style 0144 # comment as the brief description. If set to NO, the comments 0145 # will behave just like regular Qt-style comments (thus requiring 0146 # an explicit \brief command for a brief description.) 0147 0148 QT_AUTOBRIEF = NO 0149 0150 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 0151 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 0152 # comments) as a brief description. This used to be the default behaviour. 0153 # The new default is to treat a multi-line C++ comment block as a detailed 0154 # description. Set this tag to YES if you prefer the old behaviour instead. 0155 0156 MULTILINE_CPP_IS_BRIEF = NO 0157 0158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 0159 # member inherits the documentation from any documented member that it 0160 # re-implements. 0161 0162 INHERIT_DOCS = YES 0163 0164 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 0165 # a new page for each member. If set to NO, the documentation of a member will 0166 # be part of the file/class/namespace that contains it. 0167 0168 SEPARATE_MEMBER_PAGES = NO 0169 0170 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 0171 # Doxygen uses this value to replace tabs by spaces in code fragments. 0172 0173 TAB_SIZE = 4 0174 0175 # This tag can be used to specify a number of aliases that acts 0176 # as commands in the documentation. An alias has the form "name=value". 0177 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 0178 # put the command \sideeffect (or @sideeffect) in the documentation, which 0179 # will result in a user-defined paragraph with heading "Side Effects:". 0180 # You can put \n's in the value part of an alias to insert newlines. 0181 0182 ALIASES = 0183 0184 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 0185 # sources only. Doxygen will then generate output that is more tailored for C. 0186 # For instance, some of the names that are used will be different. The list 0187 # of all members will be omitted, etc. 0188 0189 OPTIMIZE_OUTPUT_FOR_C = NO 0190 0191 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 0192 # sources only. Doxygen will then generate output that is more tailored for 0193 # Java. For instance, namespaces will be presented as packages, qualified 0194 # scopes will look different, etc. 0195 0196 OPTIMIZE_OUTPUT_JAVA = NO 0197 0198 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 0199 # sources only. Doxygen will then generate output that is more tailored for 0200 # Fortran. 0201 0202 OPTIMIZE_FOR_FORTRAN = NO 0203 0204 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 0205 # sources. Doxygen will then generate output that is tailored for 0206 # VHDL. 0207 0208 OPTIMIZE_OUTPUT_VHDL = NO 0209 0210 # Doxygen selects the parser to use depending on the extension of the files it parses. 0211 # With this tag you can assign which parser to use for a given extension. 0212 # Doxygen has a built-in mapping, but you can override or extend it using this tag. 0213 # The format is ext=language, where ext is a file extension, and language is one of 0214 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, 0215 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat 0216 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), 0217 # use: inc=Fortran f=C 0218 0219 EXTENSION_MAPPING = 0220 0221 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 0222 # to include (a tag file for) the STL sources as input, then you should 0223 # set this tag to YES in order to let doxygen match functions declarations and 0224 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 0225 # func(std::string) {}). This also make the inheritance and collaboration 0226 # diagrams that involve STL classes more complete and accurate. 0227 0228 BUILTIN_STL_SUPPORT = NO 0229 0230 # If you use Microsoft's C++/CLI language, you should set this option to YES to 0231 # enable parsing support. 0232 0233 CPP_CLI_SUPPORT = NO 0234 0235 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 0236 # Doxygen will parse them like normal C++ but will assume all classes use public 0237 # instead of private inheritance when no explicit protection keyword is present. 0238 0239 SIP_SUPPORT = NO 0240 0241 # For Microsoft's IDL there are propget and propput attributes to indicate getter 0242 # and setter methods for a property. Setting this option to YES (the default) 0243 # will make doxygen to replace the get and set methods by a property in the 0244 # documentation. This will only work if the methods are indeed getting or 0245 # setting a simple type. If this is not the case, or you want to show the 0246 # methods anyway, you should set this option to NO. 0247 0248 IDL_PROPERTY_SUPPORT = YES 0249 0250 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 0251 # tag is set to YES, then doxygen will reuse the documentation of the first 0252 # member in the group (if any) for the other members of the group. By default 0253 # all members of a group must be documented explicitly. 0254 0255 DISTRIBUTE_GROUP_DOC = NO 0256 0257 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 0258 # the same type (for instance a group of public functions) to be put as a 0259 # subgroup of that type (e.g. under the Public Functions section). Set it to 0260 # NO to prevent subgrouping. Alternatively, this can be done per class using 0261 # the \nosubgrouping command. 0262 0263 SUBGROUPING = YES 0264 0265 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 0266 # is documented as struct, union, or enum with the name of the typedef. So 0267 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 0268 # with name TypeT. When disabled the typedef will appear as a member of a file, 0269 # namespace, or class. And the struct will be named TypeS. This can typically 0270 # be useful for C code in case the coding convention dictates that all compound 0271 # types are typedef'ed and only the typedef is referenced, never the tag name. 0272 0273 TYPEDEF_HIDES_STRUCT = NO 0274 0275 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 0276 # determine which symbols to keep in memory and which to flush to disk. 0277 # When the cache is full, less often used symbols will be written to disk. 0278 # For small to medium size projects (<1000 input files) the default value is 0279 # probably good enough. For larger projects a too small cache size can cause 0280 # doxygen to be busy swapping symbols to and from disk most of the time 0281 # causing a significant performance penality. 0282 # If the system has enough physical memory increasing the cache will improve the 0283 # performance by keeping more symbols in memory. Note that the value works on 0284 # a logarithmic scale so increasing the size by one will rougly double the 0285 # memory usage. The cache size is given by this formula: 0286 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 0287 # corresponding to a cache size of 2^16 = 65536 symbols 0288 0289 SYMBOL_CACHE_SIZE = 0 0290 0291 #--------------------------------------------------------------------------- 0292 # Build related configuration options 0293 #--------------------------------------------------------------------------- 0294 0295 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 0296 # documentation are documented, even if no documentation was available. 0297 # Private class members and static file members will be hidden unless 0298 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 0299 0300 EXTRACT_ALL = YES 0301 0302 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 0303 # will be included in the documentation. 0304 0305 EXTRACT_PRIVATE = YES 0306 0307 # If the EXTRACT_STATIC tag is set to YES all static members of a file 0308 # will be included in the documentation. 0309 0310 EXTRACT_STATIC = YES 0311 0312 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 0313 # defined locally in source files will be included in the documentation. 0314 # If set to NO only classes defined in header files are included. 0315 0316 EXTRACT_LOCAL_CLASSES = YES 0317 0318 # This flag is only useful for Objective-C code. When set to YES local 0319 # methods, which are defined in the implementation section but not in 0320 # the interface are included in the documentation. 0321 # If set to NO (the default) only methods in the interface are included. 0322 0323 EXTRACT_LOCAL_METHODS = NO 0324 0325 # If this flag is set to YES, the members of anonymous namespaces will be 0326 # extracted and appear in the documentation as a namespace called 0327 # 'anonymous_namespace{file}', where file will be replaced with the base 0328 # name of the file that contains the anonymous namespace. By default 0329 # anonymous namespace are hidden. 0330 0331 EXTRACT_ANON_NSPACES = NO 0332 0333 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 0334 # undocumented members of documented classes, files or namespaces. 0335 # If set to NO (the default) these members will be included in the 0336 # various overviews, but no documentation section is generated. 0337 # This option has no effect if EXTRACT_ALL is enabled. 0338 0339 HIDE_UNDOC_MEMBERS = NO 0340 0341 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 0342 # undocumented classes that are normally visible in the class hierarchy. 0343 # If set to NO (the default) these classes will be included in the various 0344 # overviews. This option has no effect if EXTRACT_ALL is enabled. 0345 0346 HIDE_UNDOC_CLASSES = NO 0347 0348 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 0349 # friend (class|struct|union) declarations. 0350 # If set to NO (the default) these declarations will be included in the 0351 # documentation. 0352 0353 HIDE_FRIEND_COMPOUNDS = NO 0354 0355 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 0356 # documentation blocks found inside the body of a function. 0357 # If set to NO (the default) these blocks will be appended to the 0358 # function's detailed documentation block. 0359 0360 HIDE_IN_BODY_DOCS = NO 0361 0362 # The INTERNAL_DOCS tag determines if documentation 0363 # that is typed after a \internal command is included. If the tag is set 0364 # to NO (the default) then the documentation will be excluded. 0365 # Set it to YES to include the internal documentation. 0366 0367 INTERNAL_DOCS = NO 0368 0369 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 0370 # file names in lower-case letters. If set to YES upper-case letters are also 0371 # allowed. This is useful if you have classes or files whose names only differ 0372 # in case and if your file system supports case sensitive file names. Windows 0373 # and Mac users are advised to set this option to NO. 0374 0375 CASE_SENSE_NAMES = YES 0376 0377 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 0378 # will show members with their full class and namespace scopes in the 0379 # documentation. If set to YES the scope will be hidden. 0380 0381 HIDE_SCOPE_NAMES = NO 0382 0383 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 0384 # will put a list of the files that are included by a file in the documentation 0385 # of that file. 0386 0387 SHOW_INCLUDE_FILES = YES 0388 0389 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 0390 # is inserted in the documentation for inline members. 0391 0392 INLINE_INFO = YES 0393 0394 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 0395 # will sort the (detailed) documentation of file and class members 0396 # alphabetically by member name. If set to NO the members will appear in 0397 # declaration order. 0398 0399 SORT_MEMBER_DOCS = YES 0400 0401 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 0402 # brief documentation of file, namespace and class members alphabetically 0403 # by member name. If set to NO (the default) the members will appear in 0404 # declaration order. 0405 0406 SORT_BRIEF_DOCS = NO 0407 0408 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 0409 # hierarchy of group names into alphabetical order. If set to NO (the default) 0410 # the group names will appear in their defined order. 0411 0412 SORT_GROUP_NAMES = NO 0413 0414 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 0415 # sorted by fully-qualified names, including namespaces. If set to 0416 # NO (the default), the class list will be sorted only by class name, 0417 # not including the namespace part. 0418 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 0419 # Note: This option applies only to the class list, not to the 0420 # alphabetical list. 0421 0422 SORT_BY_SCOPE_NAME = NO 0423 0424 # The GENERATE_TODOLIST tag can be used to enable (YES) or 0425 # disable (NO) the todo list. This list is created by putting \todo 0426 # commands in the documentation. 0427 0428 GENERATE_TODOLIST = YES 0429 0430 # The GENERATE_TESTLIST tag can be used to enable (YES) or 0431 # disable (NO) the test list. This list is created by putting \test 0432 # commands in the documentation. 0433 0434 GENERATE_TESTLIST = YES 0435 0436 # The GENERATE_BUGLIST tag can be used to enable (YES) or 0437 # disable (NO) the bug list. This list is created by putting \bug 0438 # commands in the documentation. 0439 0440 GENERATE_BUGLIST = YES 0441 0442 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 0443 # disable (NO) the deprecated list. This list is created by putting 0444 # \deprecated commands in the documentation. 0445 0446 GENERATE_DEPRECATEDLIST= YES 0447 0448 # The ENABLED_SECTIONS tag can be used to enable conditional 0449 # documentation sections, marked by \if sectionname ... \endif. 0450 0451 ENABLED_SECTIONS = 0452 0453 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 0454 # the initial value of a variable or define consists of for it to appear in 0455 # the documentation. If the initializer consists of more lines than specified 0456 # here it will be hidden. Use a value of 0 to hide initializers completely. 0457 # The appearance of the initializer of individual variables and defines in the 0458 # documentation can be controlled using \showinitializer or \hideinitializer 0459 # command in the documentation regardless of this setting. 0460 0461 MAX_INITIALIZER_LINES = 30 0462 0463 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 0464 # at the bottom of the documentation of classes and structs. If set to YES the 0465 # list will mention the files that were used to generate the documentation. 0466 0467 SHOW_USED_FILES = YES 0468 0469 # If the sources in your project are distributed over multiple directories 0470 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 0471 # in the documentation. The default is NO. 0472 0473 SHOW_DIRECTORIES = NO 0474 0475 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 0476 # This will remove the Files entry from the Quick Index and from the 0477 # Folder Tree View (if specified). The default is YES. 0478 0479 SHOW_FILES = YES 0480 0481 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 0482 # Namespaces page. 0483 # This will remove the Namespaces entry from the Quick Index 0484 # and from the Folder Tree View (if specified). The default is YES. 0485 0486 SHOW_NAMESPACES = YES 0487 0488 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 0489 # doxygen should invoke to get the current version for each file (typically from 0490 # the version control system). Doxygen will invoke the program by executing (via 0491 # popen()) the command <command> <input-file>, where <command> is the value of 0492 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 0493 # provided by doxygen. Whatever the program writes to standard output 0494 # is used as the file version. See the manual for examples. 0495 0496 FILE_VERSION_FILTER = 0497 0498 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by 0499 # doxygen. The layout file controls the global structure of the generated output files 0500 # in an output format independent way. The create the layout file that represents 0501 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a 0502 # file name after the option, if omitted DoxygenLayout.xml will be used as the name 0503 # of the layout file. 0504 0505 LAYOUT_FILE = 0506 0507 #--------------------------------------------------------------------------- 0508 # configuration options related to warning and progress messages 0509 #--------------------------------------------------------------------------- 0510 0511 # The QUIET tag can be used to turn on/off the messages that are generated 0512 # by doxygen. Possible values are YES and NO. If left blank NO is used. 0513 0514 QUIET = YES 0515 0516 # The WARNINGS tag can be used to turn on/off the warning messages that are 0517 # generated by doxygen. Possible values are YES and NO. If left blank 0518 # NO is used. 0519 0520 WARNINGS = YES 0521 0522 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 0523 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 0524 # automatically be disabled. 0525 0526 WARN_IF_UNDOCUMENTED = YES 0527 0528 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 0529 # potential errors in the documentation, such as not documenting some 0530 # parameters in a documented function, or documenting parameters that 0531 # don't exist or using markup commands wrongly. 0532 0533 WARN_IF_DOC_ERROR = YES 0534 0535 # This WARN_NO_PARAMDOC option can be abled to get warnings for 0536 # functions that are documented, but have no documentation for their parameters 0537 # or return value. If set to NO (the default) doxygen will only warn about 0538 # wrong or incomplete parameter documentation, but not about the absence of 0539 # documentation. 0540 0541 WARN_NO_PARAMDOC = NO 0542 0543 # The WARN_FORMAT tag determines the format of the warning messages that 0544 # doxygen can produce. The string should contain the $file, $line, and $text 0545 # tags, which will be replaced by the file and line number from which the 0546 # warning originated and the warning text. Optionally the format may contain 0547 # $version, which will be replaced by the version of the file (if it could 0548 # be obtained via FILE_VERSION_FILTER) 0549 0550 WARN_FORMAT = "$file:$line: $text" 0551 0552 # The WARN_LOGFILE tag can be used to specify a file to which warning 0553 # and error messages should be written. If left blank the output is written 0554 # to stderr. 0555 0556 WARN_LOGFILE = 0557 0558 #--------------------------------------------------------------------------- 0559 # configuration options related to the input files 0560 #--------------------------------------------------------------------------- 0561 0562 # The INPUT tag can be used to specify the files and/or directories that contain 0563 # documented source files. You may enter file names like "myfile.cpp" or 0564 # directories like "/usr/src/myproject". Separate the files or directories 0565 # with spaces. 0566 0567 INPUT = ${CMAKE_CURRENT_SOURCE_DIR} 0568 0569 # This tag can be used to specify the character encoding of the source files 0570 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 0571 # also the default input encoding. Doxygen uses libiconv (or the iconv built 0572 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 0573 # the list of possible encodings. 0574 0575 INPUT_ENCODING = UTF-8 0576 0577 # If the value of the INPUT tag contains directories, you can use the 0578 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 0579 # and *.h) to filter out the source-files in the directories. If left 0580 # blank the following patterns are tested: 0581 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 0582 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 0583 0584 FILE_PATTERNS = *.h \ 0585 *.hh \ 0586 *.H \ 0587 *.cpp 0588 0589 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 0590 # should be searched for input files as well. Possible values are YES and NO. 0591 # If left blank NO is used. 0592 0593 RECURSIVE = YES 0594 0595 # The EXCLUDE tag can be used to specify files and/or directories that should 0596 # excluded from the INPUT source files. This way you can easily exclude a 0597 # subdirectory from a directory tree whose root is specified with the INPUT tag. 0598 0599 EXCLUDE = ${CMAKE_CURRENT_SOURCE_DIR}/main.cpp ${CMAKE_CURRENT_BINARY_DIR} 0600 0601 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 0602 # directories that are symbolic links (a Unix filesystem feature) are excluded 0603 # from the input. 0604 0605 EXCLUDE_SYMLINKS = NO 0606 0607 # If the value of the INPUT tag contains directories, you can use the 0608 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 0609 # certain files from those directories. Note that the wildcards are matched 0610 # against the file with absolute path, so to exclude all test directories 0611 # for example use the pattern */test/* 0612 0613 EXCLUDE_PATTERNS = ${CMAKE_CURRENT_SOURCE_DIR}/alkvaluetest.* 0614 0615 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 0616 # (namespaces, classes, functions, etc.) that should be excluded from the 0617 # output. The symbol name can be a fully qualified name, a word, or if the 0618 # wildcard * is used, a substring. Examples: ANamespace, AClass, 0619 # AClass::ANamespace, ANamespace::*Test 0620 0621 EXCLUDE_SYMBOLS = 0622 0623 # The EXAMPLE_PATH tag can be used to specify one or more files or 0624 # directories that contain example code fragments that are included (see 0625 # the \include command). 0626 0627 EXAMPLE_PATH = 0628 0629 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 0630 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 0631 # and *.h) to filter out the source-files in the directories. If left 0632 # blank all files are included. 0633 0634 EXAMPLE_PATTERNS = 0635 0636 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 0637 # searched for input files to be used with the \include or \dontinclude 0638 # commands irrespective of the value of the RECURSIVE tag. 0639 # Possible values are YES and NO. If left blank NO is used. 0640 0641 EXAMPLE_RECURSIVE = NO 0642 0643 # The IMAGE_PATH tag can be used to specify one or more files or 0644 # directories that contain image that are included in the documentation (see 0645 # the \image command). 0646 0647 IMAGE_PATH = 0648 0649 # The INPUT_FILTER tag can be used to specify a program that doxygen should 0650 # invoke to filter for each input file. Doxygen will invoke the filter program 0651 # by executing (via popen()) the command <filter> <input-file>, where <filter> 0652 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 0653 # input file. Doxygen will then use the output that the filter program writes 0654 # to standard output. 0655 # If FILTER_PATTERNS is specified, this tag will be 0656 # ignored. 0657 0658 INPUT_FILTER = 0659 0660 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 0661 # basis. 0662 # Doxygen will compare the file name with each pattern and apply the 0663 # filter if there is a match. 0664 # The filters are a list of the form: 0665 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 0666 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 0667 # is applied to all files. 0668 0669 FILTER_PATTERNS = 0670 0671 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 0672 # INPUT_FILTER) will be used to filter the input files when producing source 0673 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 0674 0675 FILTER_SOURCE_FILES = NO 0676 0677 #--------------------------------------------------------------------------- 0678 # configuration options related to source browsing 0679 #--------------------------------------------------------------------------- 0680 0681 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 0682 # be generated. Documented entities will be cross-referenced with these sources. 0683 # Note: To get rid of all source code in the generated output, make sure also 0684 # VERBATIM_HEADERS is set to NO. 0685 0686 SOURCE_BROWSER = YES 0687 0688 # Setting the INLINE_SOURCES tag to YES will include the body 0689 # of functions and classes directly in the documentation. 0690 0691 INLINE_SOURCES = NO 0692 0693 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 0694 # doxygen to hide any special comment blocks from generated source code 0695 # fragments. Normal C and C++ comments will always remain visible. 0696 0697 STRIP_CODE_COMMENTS = YES 0698 0699 # If the REFERENCED_BY_RELATION tag is set to YES 0700 # then for each documented function all documented 0701 # functions referencing it will be listed. 0702 0703 REFERENCED_BY_RELATION = YES 0704 0705 # If the REFERENCES_RELATION tag is set to YES 0706 # then for each documented function all documented entities 0707 # called/used by that function will be listed. 0708 0709 REFERENCES_RELATION = YES 0710 0711 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 0712 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 0713 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 0714 # link to the source code. 0715 # Otherwise they will link to the documentation. 0716 0717 REFERENCES_LINK_SOURCE = YES 0718 0719 # If the USE_HTAGS tag is set to YES then the references to source code 0720 # will point to the HTML generated by the htags(1) tool instead of doxygen 0721 # built-in source browser. The htags tool is part of GNU's global source 0722 # tagging system (see http://www.gnu.org/software/global/global.html). You 0723 # will need version 4.8.6 or higher. 0724 0725 USE_HTAGS = NO 0726 0727 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 0728 # will generate a verbatim copy of the header file for each class for 0729 # which an include is specified. Set to NO to disable this. 0730 0731 VERBATIM_HEADERS = YES 0732 0733 #--------------------------------------------------------------------------- 0734 # configuration options related to the alphabetical class index 0735 #--------------------------------------------------------------------------- 0736 0737 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 0738 # of all compounds will be generated. Enable this if the project 0739 # contains a lot of classes, structs, unions or interfaces. 0740 0741 ALPHABETICAL_INDEX = YES 0742 0743 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 0744 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 0745 # in which this list will be split (can be a number in the range [1..20]) 0746 0747 COLS_IN_ALPHA_INDEX = 5 0748 0749 # In case all classes in a project start with a common prefix, all 0750 # classes will be put under the same header in the alphabetical index. 0751 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 0752 # should be ignored while generating the index headers. 0753 0754 IGNORE_PREFIX = 0755 0756 #--------------------------------------------------------------------------- 0757 # configuration options related to the HTML output 0758 #--------------------------------------------------------------------------- 0759 0760 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 0761 # generate HTML output. 0762 0763 GENERATE_HTML = YES 0764 0765 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 0766 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 0767 # put in front of it. If left blank `html' will be used as the default path. 0768 0769 HTML_OUTPUT = html 0770 0771 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 0772 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 0773 # doxygen will generate files with .html extension. 0774 0775 HTML_FILE_EXTENSION = .html 0776 0777 # The HTML_HEADER tag can be used to specify a personal HTML header for 0778 # each generated HTML page. If it is left blank doxygen will generate a 0779 # standard header. 0780 0781 HTML_HEADER = 0782 0783 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 0784 # each generated HTML page. If it is left blank doxygen will generate a 0785 # standard footer. 0786 0787 HTML_FOOTER = 0788 0789 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 0790 # style sheet that is used by each HTML page. It can be used to 0791 # fine-tune the look of the HTML output. If the tag is left blank doxygen 0792 # will generate a default style sheet. Note that doxygen will try to copy 0793 # the style sheet file to the HTML output directory, so don't put your own 0794 # stylesheet in the HTML output directory as well, or it will be erased! 0795 0796 HTML_STYLESHEET = 0797 0798 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 0799 # files or namespaces will be aligned in HTML using tables. If set to 0800 # NO a bullet list will be used. 0801 0802 HTML_ALIGN_MEMBERS = YES 0803 0804 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 0805 # documentation will contain sections that can be hidden and shown after the 0806 # page has loaded. For this to work a browser that supports 0807 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 0808 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 0809 0810 HTML_DYNAMIC_SECTIONS = NO 0811 0812 # If the GENERATE_DOCSET tag is set to YES, additional index files 0813 # will be generated that can be used as input for Apple's Xcode 3 0814 # integrated development environment, introduced with OSX 10.5 (Leopard). 0815 # To create a documentation set, doxygen will generate a Makefile in the 0816 # HTML output directory. Running make will produce the docset in that 0817 # directory and running "make install" will install the docset in 0818 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 0819 # it at startup. 0820 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. 0821 0822 GENERATE_DOCSET = NO 0823 0824 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 0825 # feed. A documentation feed provides an umbrella under which multiple 0826 # documentation sets from a single provider (such as a company or product suite) 0827 # can be grouped. 0828 0829 DOCSET_FEEDNAME = "Doxygen generated docs" 0830 0831 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 0832 # should uniquely identify the documentation set bundle. This should be a 0833 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 0834 # will append .docset to the name. 0835 0836 DOCSET_BUNDLE_ID = org.doxygen.Project 0837 0838 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 0839 # will be generated that can be used as input for tools like the 0840 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 0841 # of the generated HTML documentation. 0842 0843 GENERATE_HTMLHELP = NO 0844 0845 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 0846 # be used to specify the file name of the resulting .chm file. You 0847 # can add a path in front of the file if the result should not be 0848 # written to the html output directory. 0849 0850 CHM_FILE = 0851 0852 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 0853 # be used to specify the location (absolute path including file name) of 0854 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 0855 # the HTML help compiler on the generated index.hhp. 0856 0857 HHC_LOCATION = 0858 0859 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 0860 # controls if a separate .chi index file is generated (YES) or that 0861 # it should be included in the master .chm file (NO). 0862 0863 GENERATE_CHI = NO 0864 0865 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 0866 # is used to encode HtmlHelp index (hhk), content (hhc) and project file 0867 # content. 0868 0869 CHM_INDEX_ENCODING = 0870 0871 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 0872 # controls whether a binary table of contents is generated (YES) or a 0873 # normal table of contents (NO) in the .chm file. 0874 0875 BINARY_TOC = NO 0876 0877 # The TOC_EXPAND flag can be set to YES to add extra items for group members 0878 # to the contents of the HTML help documentation and to the tree view. 0879 0880 TOC_EXPAND = NO 0881 0882 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER 0883 # are set, an additional index file will be generated that can be used as input for 0884 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated 0885 # HTML documentation. 0886 0887 GENERATE_QHP = NO 0888 0889 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 0890 # be used to specify the file name of the resulting .qch file. 0891 # The path specified is relative to the HTML output folder. 0892 0893 QCH_FILE = 0894 0895 # The QHP_NAMESPACE tag specifies the namespace to use when generating 0896 # Qt Help Project output. For more information please see 0897 # http://doc.trolltech.com/qthelpproject.html#namespace 0898 0899 QHP_NAMESPACE = 0900 0901 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 0902 # Qt Help Project output. For more information please see 0903 # http://doc.trolltech.com/qthelpproject.html#virtual-folders 0904 0905 QHP_VIRTUAL_FOLDER = doc 0906 0907 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. 0908 # For more information please see 0909 # http://doc.trolltech.com/qthelpproject.html#custom-filters 0910 0911 QHP_CUST_FILTER_NAME = 0912 0913 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see 0914 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. 0915 0916 QHP_CUST_FILTER_ATTRS = 0917 0918 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's 0919 # filter section matches. 0920 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. 0921 0922 QHP_SECT_FILTER_ATTRS = 0923 0924 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 0925 # be used to specify the location of Qt's qhelpgenerator. 0926 # If non-empty doxygen will try to run qhelpgenerator on the generated 0927 # .qhp file. 0928 0929 QHG_LOCATION = 0930 0931 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 0932 # top of each HTML page. The value NO (the default) enables the index and 0933 # the value YES disables it. 0934 0935 DISABLE_INDEX = NO 0936 0937 # This tag can be used to set the number of enum values (range [1..20]) 0938 # that doxygen will group on one line in the generated HTML documentation. 0939 0940 ENUM_VALUES_PER_LINE = 1 0941 0942 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 0943 # structure should be generated to display hierarchical information. 0944 # If the tag value is set to FRAME, a side panel will be generated 0945 # containing a tree-like index structure (just like the one that 0946 # is generated for HTML Help). For this to work a browser that supports 0947 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 0948 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 0949 # probably better off using the HTML help feature. Other possible values 0950 # for this tag are: HIERARCHIES, which will generate the Groups, Directories, 0951 # and Class Hierarchy pages using a tree view instead of an ordered list; 0952 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which 0953 # disables this behavior completely. For backwards compatibility with previous 0954 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE 0955 # respectively. 0956 0957 GENERATE_TREEVIEW = NO 0958 0959 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 0960 # used to set the initial width (in pixels) of the frame in which the tree 0961 # is shown. 0962 0963 TREEVIEW_WIDTH = 250 0964 0965 # Use this tag to change the font size of Latex formulas included 0966 # as images in the HTML documentation. The default is 10. Note that 0967 # when you change the font size after a successful doxygen run you need 0968 # to manually remove any form_*.png images from the HTML output directory 0969 # to force them to be regenerated. 0970 0971 FORMULA_FONTSIZE = 10 0972 0973 #--------------------------------------------------------------------------- 0974 # configuration options related to the LaTeX output 0975 #--------------------------------------------------------------------------- 0976 0977 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 0978 # generate Latex output. 0979 0980 GENERATE_LATEX = NO 0981 0982 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 0983 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 0984 # put in front of it. If left blank `latex' will be used as the default path. 0985 0986 LATEX_OUTPUT = latex 0987 0988 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 0989 # invoked. If left blank `latex' will be used as the default command name. 0990 0991 LATEX_CMD_NAME = latex 0992 0993 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 0994 # generate index for LaTeX. If left blank `makeindex' will be used as the 0995 # default command name. 0996 0997 MAKEINDEX_CMD_NAME = makeindex 0998 0999 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 1000 # LaTeX documents. This may be useful for small projects and may help to 1001 # save some trees in general. 1002 1003 COMPACT_LATEX = NO 1004 1005 # The PAPER_TYPE tag can be used to set the paper type that is used 1006 # by the printer. Possible values are: a4, a4wide, letter, legal and 1007 # executive. If left blank a4wide will be used. 1008 1009 PAPER_TYPE = a4wide 1010 1011 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 1012 # packages that should be included in the LaTeX output. 1013 1014 EXTRA_PACKAGES = 1015 1016 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 1017 # the generated latex document. The header should contain everything until 1018 # the first chapter. If it is left blank doxygen will generate a 1019 # standard header. Notice: only use this tag if you know what you are doing! 1020 1021 LATEX_HEADER = 1022 1023 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1024 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 1025 # contain links (just like the HTML output) instead of page references 1026 # This makes the output suitable for online browsing using a pdf viewer. 1027 1028 PDF_HYPERLINKS = NO 1029 1030 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1031 # plain latex in the generated Makefile. Set this option to YES to get a 1032 # higher quality PDF documentation. 1033 1034 USE_PDFLATEX = NO 1035 1036 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1037 # command to the generated LaTeX files. This will instruct LaTeX to keep 1038 # running if errors occur, instead of asking the user for help. 1039 # This option is also used when generating formulas in HTML. 1040 1041 LATEX_BATCHMODE = NO 1042 1043 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 1044 # include the index chapters (such as File Index, Compound Index, etc.) 1045 # in the output. 1046 1047 LATEX_HIDE_INDICES = NO 1048 1049 #--------------------------------------------------------------------------- 1050 # configuration options related to the RTF output 1051 #--------------------------------------------------------------------------- 1052 1053 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 1054 # The RTF output is optimized for Word 97 and may not look very pretty with 1055 # other RTF readers or editors. 1056 1057 GENERATE_RTF = NO 1058 1059 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 1060 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1061 # put in front of it. If left blank `rtf' will be used as the default path. 1062 1063 RTF_OUTPUT = rtf 1064 1065 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 1066 # RTF documents. This may be useful for small projects and may help to 1067 # save some trees in general. 1068 1069 COMPACT_RTF = NO 1070 1071 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 1072 # will contain hyperlink fields. The RTF file will 1073 # contain links (just like the HTML output) instead of page references. 1074 # This makes the output suitable for online browsing using WORD or other 1075 # programs which support those fields. 1076 # Note: wordpad (write) and others do not support links. 1077 1078 RTF_HYPERLINKS = NO 1079 1080 # Load stylesheet definitions from file. Syntax is similar to doxygen's 1081 # config file, i.e. a series of assignments. You only have to provide 1082 # replacements, missing definitions are set to their default value. 1083 1084 RTF_STYLESHEET_FILE = 1085 1086 # Set optional variables used in the generation of an rtf document. 1087 # Syntax is similar to doxygen's config file. 1088 1089 RTF_EXTENSIONS_FILE = 1090 1091 #--------------------------------------------------------------------------- 1092 # configuration options related to the man page output 1093 #--------------------------------------------------------------------------- 1094 1095 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1096 # generate man pages 1097 1098 GENERATE_MAN = NO 1099 1100 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 1101 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1102 # put in front of it. If left blank `man' will be used as the default path. 1103 1104 MAN_OUTPUT = man 1105 1106 # The MAN_EXTENSION tag determines the extension that is added to 1107 # the generated man pages (default is the subroutine's section .3) 1108 1109 MAN_EXTENSION = .3 1110 1111 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 1112 # then it will generate one additional man file for each entity 1113 # documented in the real man page(s). These additional files 1114 # only source the real man page, but without them the man command 1115 # would be unable to find the correct page. The default is NO. 1116 1117 MAN_LINKS = NO 1118 1119 #--------------------------------------------------------------------------- 1120 # configuration options related to the XML output 1121 #--------------------------------------------------------------------------- 1122 1123 # If the GENERATE_XML tag is set to YES Doxygen will 1124 # generate an XML file that captures the structure of 1125 # the code including all documentation. 1126 1127 GENERATE_XML = NO 1128 1129 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 1130 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1131 # put in front of it. If left blank `xml' will be used as the default path. 1132 1133 XML_OUTPUT = xml 1134 1135 # The XML_SCHEMA tag can be used to specify an XML schema, 1136 # which can be used by a validating XML parser to check the 1137 # syntax of the XML files. 1138 1139 XML_SCHEMA = 1140 1141 # The XML_DTD tag can be used to specify an XML DTD, 1142 # which can be used by a validating XML parser to check the 1143 # syntax of the XML files. 1144 1145 XML_DTD = 1146 1147 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 1148 # dump the program listings (including syntax highlighting 1149 # and cross-referencing information) to the XML output. Note that 1150 # enabling this will significantly increase the size of the XML output. 1151 1152 XML_PROGRAMLISTING = YES 1153 1154 #--------------------------------------------------------------------------- 1155 # configuration options for the AutoGen Definitions output 1156 #--------------------------------------------------------------------------- 1157 1158 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 1159 # generate an AutoGen Definitions (see autogen.sf.net) file 1160 # that captures the structure of the code including all 1161 # documentation. Note that this feature is still experimental 1162 # and incomplete at the moment. 1163 1164 GENERATE_AUTOGEN_DEF = NO 1165 1166 #--------------------------------------------------------------------------- 1167 # configuration options related to the Perl module output 1168 #--------------------------------------------------------------------------- 1169 1170 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 1171 # generate a Perl module file that captures the structure of 1172 # the code including all documentation. Note that this 1173 # feature is still experimental and incomplete at the 1174 # moment. 1175 1176 GENERATE_PERLMOD = NO 1177 1178 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 1179 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 1180 # to generate PDF and DVI output from the Perl module output. 1181 1182 PERLMOD_LATEX = NO 1183 1184 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 1185 # nicely formatted so it can be parsed by a human reader. 1186 # This is useful 1187 # if you want to understand what is going on. 1188 # On the other hand, if this 1189 # tag is set to NO the size of the Perl module output will be much smaller 1190 # and Perl will parse it just the same. 1191 1192 PERLMOD_PRETTY = YES 1193 1194 # The names of the make variables in the generated doxyrules.make file 1195 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1196 # This is useful so different doxyrules.make files included by the same 1197 # Makefile don't overwrite each other's variables. 1198 1199 PERLMOD_MAKEVAR_PREFIX = 1200 1201 #--------------------------------------------------------------------------- 1202 # Configuration options related to the preprocessor 1203 #--------------------------------------------------------------------------- 1204 1205 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1206 # evaluate all C-preprocessor directives found in the sources and include 1207 # files. 1208 1209 ENABLE_PREPROCESSING = YES 1210 1211 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1212 # names in the source code. If set to NO (the default) only conditional 1213 # compilation will be performed. Macro expansion can be done in a controlled 1214 # way by setting EXPAND_ONLY_PREDEF to YES. 1215 1216 MACRO_EXPANSION = NO 1217 1218 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1219 # then the macro expansion is limited to the macros specified with the 1220 # PREDEFINED and EXPAND_AS_DEFINED tags. 1221 1222 EXPAND_ONLY_PREDEF = NO 1223 1224 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1225 # in the INCLUDE_PATH (see below) will be search if a #include is found. 1226 1227 SEARCH_INCLUDES = YES 1228 1229 # The INCLUDE_PATH tag can be used to specify one or more directories that 1230 # contain include files that are not input files but should be processed by 1231 # the preprocessor. 1232 1233 INCLUDE_PATH = ${KDE4_INCLUDE_DIR} \ 1234 ${QT_INCLUDE_DIR} 1235 1236 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1237 # patterns (like *.h and *.hpp) to filter out the header-files in the 1238 # directories. If left blank, the patterns specified with FILE_PATTERNS will 1239 # be used. 1240 1241 INCLUDE_FILE_PATTERNS = 1242 1243 # The PREDEFINED tag can be used to specify one or more macro names that 1244 # are defined before the preprocessor is started (similar to the -D option of 1245 # gcc). The argument of the tag is a list of macros of the form: name 1246 # or name=definition (no spaces). If the definition and the = are 1247 # omitted =1 is assumed. To prevent a macro definition from being 1248 # undefined via #undef or recursively expanded use the := operator 1249 # instead of the = operator. 1250 1251 PREDEFINED = 1252 1253 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1254 # this tag can be used to specify a list of macro names that should be expanded. 1255 # The macro definition that is found in the sources will be used. 1256 # Use the PREDEFINED tag if you want to use a different macro definition. 1257 1258 EXPAND_AS_DEFINED = 1259 1260 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1261 # doxygen's preprocessor will remove all function-like macros that are alone 1262 # on a line, have an all uppercase name, and do not end with a semicolon. Such 1263 # function macros are typically used for boiler-plate code, and will confuse 1264 # the parser if not removed. 1265 1266 SKIP_FUNCTION_MACROS = YES 1267 1268 #--------------------------------------------------------------------------- 1269 # Configuration::additions related to external references 1270 #--------------------------------------------------------------------------- 1271 1272 # The TAGFILES option can be used to specify one or more tagfiles. 1273 # Optionally an initial location of the external documentation 1274 # can be added for each tagfile. The format of a tag file without 1275 # this location is as follows: 1276 # 1277 # TAGFILES = file1 file2 ... 1278 # Adding location for the tag files is done as follows: 1279 # 1280 # TAGFILES = file1=loc1 "file2 = loc2" ... 1281 # where "loc1" and "loc2" can be relative or absolute paths or 1282 # URLs. If a location is present for each tag, the installdox tool 1283 # does not have to be run to correct the links. 1284 # Note that each tag file must have a unique name 1285 # (where the name does NOT include the path) 1286 # If a tag file is not located in the directory in which doxygen 1287 # is run, you must also specify the path to the tagfile here. 1288 1289 TAGFILES = 1290 1291 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1292 # a tag file that is based on the input files it reads. 1293 1294 GENERATE_TAGFILE = 1295 1296 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1297 # in the class index. If set to NO only the inherited external classes 1298 # will be listed. 1299 1300 ALLEXTERNALS = NO 1301 1302 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1303 # in the modules index. If set to NO, only the current project's groups will 1304 # be listed. 1305 1306 EXTERNAL_GROUPS = YES 1307 1308 # The PERL_PATH should be the absolute path and name of the perl script 1309 # interpreter (i.e. the result of `which perl'). 1310 1311 PERL_PATH = /usr/bin/perl 1312 1313 #--------------------------------------------------------------------------- 1314 # Configuration options related to the dot tool 1315 #--------------------------------------------------------------------------- 1316 1317 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1318 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1319 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1320 # this option is superseded by the HAVE_DOT option below. This is only a 1321 # fallback. It is recommended to install and use dot, since it yields more 1322 # powerful graphs. 1323 1324 CLASS_DIAGRAMS = YES 1325 1326 # You can define message sequence charts within doxygen comments using the \msc 1327 # command. Doxygen will then run the mscgen tool (see 1328 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 1329 # documentation. The MSCGEN_PATH tag allows you to specify the directory where 1330 # the mscgen tool resides. If left empty the tool is assumed to be found in the 1331 # default search path. 1332 1333 MSCGEN_PATH = 1334 1335 # If set to YES, the inheritance and collaboration graphs will hide 1336 # inheritance and usage relations if the target is undocumented 1337 # or is not a class. 1338 1339 HIDE_UNDOC_RELATIONS = YES 1340 1341 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1342 # available from the path. This tool is part of Graphviz, a graph visualization 1343 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1344 # have no effect if this option is set to NO (the default) 1345 1346 HAVE_DOT = NO 1347 1348 # By default doxygen will write a font called FreeSans.ttf to the output 1349 # directory and reference it in all dot files that doxygen generates. This 1350 # font does not include all possible unicode characters however, so when you need 1351 # these (or just want a differently looking font) you can specify the font name 1352 # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 1353 # which can be done by putting it in a standard location or by setting the 1354 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 1355 # containing the font. 1356 1357 DOT_FONTNAME = FreeSans 1358 1359 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 1360 # The default size is 10pt. 1361 1362 DOT_FONTSIZE = 10 1363 1364 # By default doxygen will tell dot to use the output directory to look for the 1365 # FreeSans.ttf font (which doxygen will put there itself). If you specify a 1366 # different font using DOT_FONTNAME you can set the path where dot 1367 # can find it using this tag. 1368 1369 DOT_FONTPATH = 1370 1371 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1372 # will generate a graph for each documented class showing the direct and 1373 # indirect inheritance relations. Setting this tag to YES will force the 1374 # the CLASS_DIAGRAMS tag to NO. 1375 1376 CLASS_GRAPH = YES 1377 1378 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1379 # will generate a graph for each documented class showing the direct and 1380 # indirect implementation dependencies (inheritance, containment, and 1381 # class references variables) of the class with other documented classes. 1382 1383 COLLABORATION_GRAPH = YES 1384 1385 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1386 # will generate a graph for groups, showing the direct groups dependencies 1387 1388 GROUP_GRAPHS = YES 1389 1390 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1391 # collaboration diagrams in a style similar to the OMG's Unified Modeling 1392 # Language. 1393 1394 UML_LOOK = NO 1395 1396 # If set to YES, the inheritance and collaboration graphs will show the 1397 # relations between templates and their instances. 1398 1399 TEMPLATE_RELATIONS = YES 1400 1401 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1402 # tags are set to YES then doxygen will generate a graph for each documented 1403 # file showing the direct and indirect include dependencies of the file with 1404 # other documented files. 1405 1406 INCLUDE_GRAPH = YES 1407 1408 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1409 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1410 # documented header file showing the documented files that directly or 1411 # indirectly include this file. 1412 1413 INCLUDED_BY_GRAPH = YES 1414 1415 # If the CALL_GRAPH and HAVE_DOT options are set to YES then 1416 # doxygen will generate a call dependency graph for every global function 1417 # or class method. Note that enabling this option will significantly increase 1418 # the time of a run. So in most cases it will be better to enable call graphs 1419 # for selected functions only using the \callgraph command. 1420 1421 CALL_GRAPH = NO 1422 1423 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 1424 # doxygen will generate a caller dependency graph for every global function 1425 # or class method. Note that enabling this option will significantly increase 1426 # the time of a run. So in most cases it will be better to enable caller 1427 # graphs for selected functions only using the \callergraph command. 1428 1429 CALLER_GRAPH = NO 1430 1431 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1432 # will graphical hierarchy of all classes instead of a textual one. 1433 1434 GRAPHICAL_HIERARCHY = YES 1435 1436 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1437 # then doxygen will show the dependencies a directory has on other directories 1438 # in a graphical way. The dependency relations are determined by the #include 1439 # relations between the files in the directories. 1440 1441 DIRECTORY_GRAPH = YES 1442 1443 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1444 # generated by dot. Possible values are png, jpg, or gif 1445 # If left blank png will be used. 1446 1447 DOT_IMAGE_FORMAT = png 1448 1449 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1450 # found. If left blank, it is assumed the dot tool can be found in the path. 1451 1452 DOT_PATH = 1453 1454 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1455 # contain dot files that are included in the documentation (see the 1456 # \dotfile command). 1457 1458 DOTFILE_DIRS = 1459 1460 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1461 # nodes that will be shown in the graph. If the number of nodes in a graph 1462 # becomes larger than this value, doxygen will truncate the graph, which is 1463 # visualized by representing a node as a red box. Note that doxygen if the 1464 # number of direct children of the root node in a graph is already larger than 1465 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 1466 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 1467 1468 DOT_GRAPH_MAX_NODES = 50 1469 1470 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1471 # graphs generated by dot. A depth value of 3 means that only nodes reachable 1472 # from the root by following a path via at most 3 edges will be shown. Nodes 1473 # that lay further from the root node will be omitted. Note that setting this 1474 # option to 1 or 2 may greatly reduce the computation time needed for large 1475 # code bases. Also note that the size of a graph can be further restricted by 1476 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 1477 1478 MAX_DOT_GRAPH_DEPTH = 0 1479 1480 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1481 # background. This is disabled by default, because dot on Windows does not 1482 # seem to support this out of the box. Warning: Depending on the platform used, 1483 # enabling this option may lead to badly anti-aliased labels on the edges of 1484 # a graph (i.e. they become hard to read). 1485 1486 DOT_TRANSPARENT = NO 1487 1488 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1489 # files in one run (i.e. multiple -o and -T options on the command line). This 1490 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1491 # support this, this feature is disabled by default. 1492 1493 DOT_MULTI_TARGETS = NO 1494 1495 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1496 # generate a legend page explaining the meaning of the various boxes and 1497 # arrows in the dot generated graphs. 1498 1499 GENERATE_LEGEND = YES 1500 1501 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1502 # remove the intermediate dot files that are used to generate 1503 # the various graphs. 1504 1505 DOT_CLEANUP = YES 1506 1507 #--------------------------------------------------------------------------- 1508 # Options related to the search engine 1509 #--------------------------------------------------------------------------- 1510 1511 # The SEARCHENGINE tag specifies whether or not a search engine should be 1512 # used. If set to NO the values of all tags below this one will be ignored. 1513 1514 SEARCHENGINE = NO