Warning, /libraries/qca/Doxyfile.in is written in an unsupported language. File is not indexed.
0001 # Doxyfile 1.5.2 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 that 0018 # follow. The default is UTF-8 which is also the encoding used for all text before 0019 # the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into 0020 # libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of 0021 # 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 = "Qt Cryptographic Architecture" 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 = 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 = apidocs 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, Finnish, French, German, Greek, Hungarian, 0058 # Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 0059 # Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 0060 # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. 0061 0062 OUTPUT_LANGUAGE = English 0063 0064 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 0065 # include brief member descriptions after the members that are listed in 0066 # the file and class documentation (similar to JavaDoc). 0067 # Set to NO to disable this. 0068 0069 BRIEF_MEMBER_DESC = NO 0070 0071 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 0072 # the brief description of a member or function before the detailed description. 0073 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 0074 # brief descriptions will be completely suppressed. 0075 0076 REPEAT_BRIEF = YES 0077 0078 # This tag implements a quasi-intelligent brief description abbreviator 0079 # that is used to form the text in various listings. Each string 0080 # in this list, if found as the leading text of the brief description, will be 0081 # stripped from the text and the result after processing the whole list, is 0082 # used as the annotated text. Otherwise, the brief description is used as-is. 0083 # If left blank, the following values are used ("$name" is automatically 0084 # replaced with the name of the entity): "The $name class" "The $name widget" 0085 # "The $name file" "is" "provides" "specifies" "contains" 0086 # "represents" "a" "an" "the" 0087 0088 ABBREVIATE_BRIEF = 0089 0090 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 0091 # Doxygen will generate a detailed section even if there is only a brief 0092 # description. 0093 0094 ALWAYS_DETAILED_SEC = YES 0095 0096 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 0097 # inherited members of a class in the documentation of that class as if those 0098 # members were ordinary class members. Constructors, destructors and assignment 0099 # operators of the base classes will not be shown. 0100 0101 INLINE_INHERITED_MEMB = NO 0102 0103 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 0104 # path before files name in the file list and in the header files. If set 0105 # to NO the shortest path that makes the file name unique will be used. 0106 0107 FULL_PATH_NAMES = NO 0108 0109 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 0110 # can be used to strip a user-defined part of the path. Stripping is 0111 # only done if one of the specified strings matches the left-hand part of 0112 # the path. The tag can be used to show relative paths in the file list. 0113 # If left blank the directory from which doxygen is run is used as the 0114 # path to strip. 0115 0116 STRIP_FROM_PATH = 0117 0118 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 0119 # the path mentioned in the documentation of a class, which tells 0120 # the reader which header file to include in order to use a class. 0121 # If left blank only the name of the header file containing the class 0122 # definition is used. Otherwise one should specify the include paths that 0123 # are normally passed to the compiler using the -I flag. 0124 0125 STRIP_FROM_INC_PATH = 0126 0127 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 0128 # (but less readable) file names. This can be useful is your file systems 0129 # doesn't support long names like on DOS, Mac, or CD-ROM. 0130 0131 SHORT_NAMES = NO 0132 0133 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 0134 # will interpret the first line (until the first dot) of a JavaDoc-style 0135 # comment as the brief description. If set to NO, the JavaDoc 0136 # comments will behave just like the Qt-style comments (thus requiring an 0137 # explicit @brief command for a brief description. 0138 0139 JAVADOC_AUTOBRIEF = YES 0140 0141 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 0142 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 0143 # comments) as a brief description. This used to be the default behaviour. 0144 # The new default is to treat a multi-line C++ comment block as a detailed 0145 # description. Set this tag to YES if you prefer the old behaviour instead. 0146 0147 MULTILINE_CPP_IS_BRIEF = NO 0148 0149 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 0150 # will output the detailed description near the top, like JavaDoc. 0151 # If set to NO, the detailed description appears after the member 0152 # documentation. 0153 0154 DETAILS_AT_TOP = NO 0155 0156 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 0157 # member inherits the documentation from any documented member that it 0158 # re-implements. 0159 0160 INHERIT_DOCS = YES 0161 0162 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 0163 # a new page for each member. If set to NO, the documentation of a member will 0164 # be part of the file/class/namespace that contains it. 0165 0166 SEPARATE_MEMBER_PAGES = NO 0167 0168 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 0169 # Doxygen uses this value to replace tabs by spaces in code fragments. 0170 0171 TAB_SIZE = 8 0172 0173 # This tag can be used to specify a number of aliases that acts 0174 # as commands in the documentation. An alias has the form "name=value". 0175 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 0176 # put the command \sideeffect (or @sideeffect) in the documentation, which 0177 # will result in a user-defined paragraph with heading "Side Effects:". 0178 # You can put \n's in the value part of an alias to insert newlines. 0179 0180 ALIASES = 0181 0182 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 0183 # sources only. Doxygen will then generate output that is more tailored for C. 0184 # For instance, some of the names that are used will be different. The list 0185 # of all members will be omitted, etc. 0186 0187 OPTIMIZE_OUTPUT_FOR_C = NO 0188 0189 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 0190 # sources only. Doxygen will then generate output that is more tailored for Java. 0191 # For instance, namespaces will be presented as packages, qualified scopes 0192 # will look different, etc. 0193 0194 OPTIMIZE_OUTPUT_JAVA = NO 0195 0196 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 0197 # include (a tag file for) the STL sources as input, then you should 0198 # set this tag to YES in order to let doxygen match functions declarations and 0199 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 0200 # func(std::string) {}). This also make the inheritance and collaboration 0201 # diagrams that involve STL classes more complete and accurate. 0202 0203 BUILTIN_STL_SUPPORT = NO 0204 0205 # If you use Microsoft's C++/CLI language, you should set this option to YES to 0206 # enable parsing support. 0207 0208 CPP_CLI_SUPPORT = NO 0209 0210 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 0211 # tag is set to YES, then doxygen will reuse the documentation of the first 0212 # member in the group (if any) for the other members of the group. By default 0213 # all members of a group must be documented explicitly. 0214 0215 DISTRIBUTE_GROUP_DOC = NO 0216 0217 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 0218 # the same type (for instance a group of public functions) to be put as a 0219 # subgroup of that type (e.g. under the Public Functions section). Set it to 0220 # NO to prevent subgrouping. Alternatively, this can be done per class using 0221 # the \nosubgrouping command. 0222 0223 SUBGROUPING = YES 0224 0225 #--------------------------------------------------------------------------- 0226 # Build related configuration options 0227 #--------------------------------------------------------------------------- 0228 0229 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 0230 # documentation are documented, even if no documentation was available. 0231 # Private class members and static file members will be hidden unless 0232 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 0233 0234 EXTRACT_ALL = NO 0235 0236 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 0237 # will be included in the documentation. 0238 0239 EXTRACT_PRIVATE = NO 0240 0241 # If the EXTRACT_STATIC tag is set to YES all static members of a file 0242 # will be included in the documentation. 0243 0244 EXTRACT_STATIC = NO 0245 0246 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 0247 # defined locally in source files will be included in the documentation. 0248 # If set to NO only classes defined in header files are included. 0249 0250 EXTRACT_LOCAL_CLASSES = YES 0251 0252 # This flag is only useful for Objective-C code. When set to YES local 0253 # methods, which are defined in the implementation section but not in 0254 # the interface are included in the documentation. 0255 # If set to NO (the default) only methods in the interface are included. 0256 0257 EXTRACT_LOCAL_METHODS = NO 0258 0259 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 0260 # undocumented members of documented classes, files or namespaces. 0261 # If set to NO (the default) these members will be included in the 0262 # various overviews, but no documentation section is generated. 0263 # This option has no effect if EXTRACT_ALL is enabled. 0264 0265 HIDE_UNDOC_MEMBERS = NO 0266 0267 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 0268 # undocumented classes that are normally visible in the class hierarchy. 0269 # If set to NO (the default) these classes will be included in the various 0270 # overviews. This option has no effect if EXTRACT_ALL is enabled. 0271 0272 HIDE_UNDOC_CLASSES = NO 0273 0274 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 0275 # friend (class|struct|union) declarations. 0276 # If set to NO (the default) these declarations will be included in the 0277 # documentation. 0278 0279 HIDE_FRIEND_COMPOUNDS = NO 0280 0281 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 0282 # documentation blocks found inside the body of a function. 0283 # If set to NO (the default) these blocks will be appended to the 0284 # function's detailed documentation block. 0285 0286 HIDE_IN_BODY_DOCS = NO 0287 0288 # The INTERNAL_DOCS tag determines if documentation 0289 # that is typed after a \internal command is included. If the tag is set 0290 # to NO (the default) then the documentation will be excluded. 0291 # Set it to YES to include the internal documentation. 0292 0293 INTERNAL_DOCS = YES 0294 0295 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 0296 # file names in lower-case letters. If set to YES upper-case letters are also 0297 # allowed. This is useful if you have classes or files whose names only differ 0298 # in case and if your file system supports case sensitive file names. Windows 0299 # and Mac users are advised to set this option to NO. 0300 0301 CASE_SENSE_NAMES = YES 0302 0303 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 0304 # will show members with their full class and namespace scopes in the 0305 # documentation. If set to YES the scope will be hidden. 0306 0307 HIDE_SCOPE_NAMES = NO 0308 0309 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 0310 # will put a list of the files that are included by a file in the documentation 0311 # of that file. 0312 0313 SHOW_INCLUDE_FILES = YES 0314 0315 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 0316 # is inserted in the documentation for inline members. 0317 0318 INLINE_INFO = YES 0319 0320 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 0321 # will sort the (detailed) documentation of file and class members 0322 # alphabetically by member name. If set to NO the members will appear in 0323 # declaration order. 0324 0325 SORT_MEMBER_DOCS = NO 0326 0327 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 0328 # brief documentation of file, namespace and class members alphabetically 0329 # by member name. If set to NO (the default) the members will appear in 0330 # declaration order. 0331 0332 SORT_BRIEF_DOCS = YES 0333 0334 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 0335 # sorted by fully-qualified names, including namespaces. If set to 0336 # NO (the default), the class list will be sorted only by class name, 0337 # not including the namespace part. 0338 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 0339 # Note: This option applies only to the class list, not to the 0340 # alphabetical list. 0341 0342 SORT_BY_SCOPE_NAME = NO 0343 0344 # The GENERATE_TODOLIST tag can be used to enable (YES) or 0345 # disable (NO) the todo list. This list is created by putting \todo 0346 # commands in the documentation. 0347 0348 GENERATE_TODOLIST = YES 0349 0350 # The GENERATE_TESTLIST tag can be used to enable (YES) or 0351 # disable (NO) the test list. This list is created by putting \test 0352 # commands in the documentation. 0353 0354 GENERATE_TESTLIST = YES 0355 0356 # The GENERATE_BUGLIST tag can be used to enable (YES) or 0357 # disable (NO) the bug list. This list is created by putting \bug 0358 # commands in the documentation. 0359 0360 GENERATE_BUGLIST = YES 0361 0362 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 0363 # disable (NO) the deprecated list. This list is created by putting 0364 # \deprecated commands in the documentation. 0365 0366 GENERATE_DEPRECATEDLIST= YES 0367 0368 # The ENABLED_SECTIONS tag can be used to enable conditional 0369 # documentation sections, marked by \if sectionname ... \endif. 0370 0371 ENABLED_SECTIONS = 0372 0373 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 0374 # the initial value of a variable or define consists of for it to appear in 0375 # the documentation. If the initializer consists of more lines than specified 0376 # here it will be hidden. Use a value of 0 to hide initializers completely. 0377 # The appearance of the initializer of individual variables and defines in the 0378 # documentation can be controlled using \showinitializer or \hideinitializer 0379 # command in the documentation regardless of this setting. 0380 0381 MAX_INITIALIZER_LINES = 30 0382 0383 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 0384 # at the bottom of the documentation of classes and structs. If set to YES the 0385 # list will mention the files that were used to generate the documentation. 0386 0387 SHOW_USED_FILES = YES 0388 0389 # If the sources in your project are distributed over multiple directories 0390 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 0391 # in the documentation. The default is NO. 0392 0393 SHOW_DIRECTORIES = YES 0394 0395 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 0396 # doxygen should invoke to get the current version for each file (typically from the 0397 # version control system). Doxygen will invoke the program by executing (via 0398 # popen()) the command <command> <input-file>, where <command> is the value of 0399 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 0400 # provided by doxygen. Whatever the program writes to standard output 0401 # is used as the file version. See the manual for examples. 0402 0403 FILE_VERSION_FILTER = 0404 0405 #--------------------------------------------------------------------------- 0406 # configuration options related to warning and progress messages 0407 #--------------------------------------------------------------------------- 0408 0409 # The QUIET tag can be used to turn on/off the messages that are generated 0410 # by doxygen. Possible values are YES and NO. If left blank NO is used. 0411 0412 QUIET = YES 0413 0414 # The WARNINGS tag can be used to turn on/off the warning messages that are 0415 # generated by doxygen. Possible values are YES and NO. If left blank 0416 # NO is used. 0417 0418 WARNINGS = YES 0419 0420 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 0421 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 0422 # automatically be disabled. 0423 0424 WARN_IF_UNDOCUMENTED = YES 0425 0426 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 0427 # potential errors in the documentation, such as not documenting some 0428 # parameters in a documented function, or documenting parameters that 0429 # don't exist or using markup commands wrongly. 0430 0431 WARN_IF_DOC_ERROR = YES 0432 0433 # This WARN_NO_PARAMDOC option can be abled to get warnings for 0434 # functions that are documented, but have no documentation for their parameters 0435 # or return value. If set to NO (the default) doxygen will only warn about 0436 # wrong or incomplete parameter documentation, but not about the absence of 0437 # documentation. 0438 0439 WARN_NO_PARAMDOC = YES 0440 0441 # The WARN_FORMAT tag determines the format of the warning messages that 0442 # doxygen can produce. The string should contain the $file, $line, and $text 0443 # tags, which will be replaced by the file and line number from which the 0444 # warning originated and the warning text. Optionally the format may contain 0445 # $version, which will be replaced by the version of the file (if it could 0446 # be obtained via FILE_VERSION_FILTER) 0447 0448 WARN_FORMAT = "$file:$line: $text" 0449 0450 # The WARN_LOGFILE tag can be used to specify a file to which warning 0451 # and error messages should be written. If left blank the output is written 0452 # to stderr. 0453 0454 WARN_LOGFILE = 0455 0456 #--------------------------------------------------------------------------- 0457 # configuration options related to the input files 0458 #--------------------------------------------------------------------------- 0459 0460 # The INPUT tag can be used to specify the files and/or directories that contain 0461 # documented source files. You may enter file names like "myfile.cpp" or 0462 # directories like "/usr/src/myproject". Separate the files or directories 0463 # with spaces. 0464 0465 INPUT = @CMAKE_SOURCE_DIR@/examples \ 0466 @CMAKE_SOURCE_DIR@ \ 0467 @CMAKE_SOURCE_DIR@/include/QtCrypto \ 0468 @CMAKE_BINARY_DIR@/qca_version.h 0469 0470 # This tag can be used to specify the character encoding of the source files that 0471 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 0472 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 0473 # See http://www.gnu.org/software/libiconv for the list of possible encodings. 0474 0475 INPUT_ENCODING = UTF-8 0476 0477 # If the value of the INPUT tag contains directories, you can use the 0478 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 0479 # and *.h) to filter out the source-files in the directories. If left 0480 # blank the following patterns are tested: 0481 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 0482 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py 0483 0484 FILE_PATTERNS = *.h \ 0485 *.doco \ 0486 Mainpage.dox 0487 0488 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 0489 # should be searched for input files as well. Possible values are YES and NO. 0490 # If left blank NO is used. 0491 0492 RECURSIVE = NO 0493 0494 # The EXCLUDE tag can be used to specify files and/or directories that should 0495 # excluded from the INPUT source files. This way you can easily exclude a 0496 # subdirectory from a directory tree whose root is specified with the INPUT tag. 0497 0498 EXCLUDE = @CMAKE_BINARY_DIR@/import_plugins.h 0499 0500 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 0501 # directories that are symbolic links (a Unix filesystem feature) are excluded 0502 # from the input. 0503 0504 EXCLUDE_SYMLINKS = NO 0505 0506 # If the value of the INPUT tag contains directories, you can use the 0507 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 0508 # certain files from those directories. Note that the wildcards are matched 0509 # against the file with absolute path, so to exclude all test directories 0510 # for example use the pattern */test/* 0511 0512 EXCLUDE_PATTERNS = *.moc.* \ 0513 moc* \ 0514 *.all_cpp.* \ 0515 *unload.* \ 0516 */test/* \ 0517 */tests/* 0518 0519 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 0520 # (namespaces, classes, functions, etc.) that should be excluded from the output. 0521 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 0522 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test 0523 0524 EXCLUDE_SYMBOLS = 0525 0526 # The EXAMPLE_PATH tag can be used to specify one or more files or 0527 # directories that contain example code fragments that are included (see 0528 # the \include command). 0529 0530 EXAMPLE_PATH = @CMAKE_SOURCE_DIR@/examples/aes-cmac \ 0531 @CMAKE_SOURCE_DIR@/examples/base64test \ 0532 @CMAKE_SOURCE_DIR@/examples/certtest \ 0533 @CMAKE_SOURCE_DIR@/examples/ciphertest \ 0534 @CMAKE_SOURCE_DIR@/examples/cms \ 0535 @CMAKE_SOURCE_DIR@/examples/cmssigner \ 0536 @CMAKE_SOURCE_DIR@/examples/eventhandlerdemo \ 0537 @CMAKE_SOURCE_DIR@/examples/hashtest \ 0538 @CMAKE_SOURCE_DIR@/examples/hextest \ 0539 @CMAKE_SOURCE_DIR@/examples/keyloader \ 0540 @CMAKE_SOURCE_DIR@/examples/mactest \ 0541 @CMAKE_SOURCE_DIR@/examples/md5crypt \ 0542 @CMAKE_SOURCE_DIR@/examples/providertest \ 0543 @CMAKE_SOURCE_DIR@/examples/publickeyexample \ 0544 @CMAKE_SOURCE_DIR@/examples/randomtest \ 0545 @CMAKE_SOURCE_DIR@/examples/rsatest \ 0546 @CMAKE_SOURCE_DIR@/examples/saslclient \ 0547 @CMAKE_SOURCE_DIR@/examples/saslserver \ 0548 @CMAKE_SOURCE_DIR@/examples/ssltest \ 0549 @CMAKE_SOURCE_DIR@/examples/sslservtest \ 0550 @CMAKE_SOURCE_DIR@/examples/tlssocket 0551 0552 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 0553 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 0554 # and *.h) to filter out the source-files in the directories. If left 0555 # blank all files are included. 0556 0557 EXAMPLE_PATTERNS = 0558 0559 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 0560 # searched for input files to be used with the \include or \dontinclude 0561 # commands irrespective of the value of the RECURSIVE tag. 0562 # Possible values are YES and NO. If left blank NO is used. 0563 0564 EXAMPLE_RECURSIVE = NO 0565 0566 # The IMAGE_PATH tag can be used to specify one or more files or 0567 # directories that contain image that are included in the documentation (see 0568 # the \image command). 0569 0570 IMAGE_PATH = @CMAKE_SOURCE_DIR@/docs/pics 0571 0572 # The INPUT_FILTER tag can be used to specify a program that doxygen should 0573 # invoke to filter for each input file. Doxygen will invoke the filter program 0574 # by executing (via popen()) the command <filter> <input-file>, where <filter> 0575 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 0576 # input file. Doxygen will then use the output that the filter program writes 0577 # to standard output. If FILTER_PATTERNS is specified, this tag will be 0578 # ignored. 0579 0580 INPUT_FILTER = 0581 0582 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 0583 # basis. Doxygen will compare the file name with each pattern and apply the 0584 # filter if there is a match. The filters are a list of the form: 0585 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 0586 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 0587 # is applied to all files. 0588 0589 FILTER_PATTERNS = 0590 0591 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 0592 # INPUT_FILTER) will be used to filter the input files when producing source 0593 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 0594 0595 FILTER_SOURCE_FILES = NO 0596 0597 #--------------------------------------------------------------------------- 0598 # configuration options related to source browsing 0599 #--------------------------------------------------------------------------- 0600 0601 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 0602 # be generated. Documented entities will be cross-referenced with these sources. 0603 # Note: To get rid of all source code in the generated output, make sure also 0604 # VERBATIM_HEADERS is set to NO. 0605 0606 SOURCE_BROWSER = NO 0607 0608 # Setting the INLINE_SOURCES tag to YES will include the body 0609 # of functions and classes directly in the documentation. 0610 0611 INLINE_SOURCES = NO 0612 0613 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 0614 # doxygen to hide any special comment blocks from generated source code 0615 # fragments. Normal C and C++ comments will always remain visible. 0616 0617 STRIP_CODE_COMMENTS = YES 0618 0619 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 0620 # then for each documented function all documented 0621 # functions referencing it will be listed. 0622 0623 REFERENCED_BY_RELATION = YES 0624 0625 # If the REFERENCES_RELATION tag is set to YES (the default) 0626 # then for each documented function all documented entities 0627 # called/used by that function will be listed. 0628 0629 REFERENCES_RELATION = YES 0630 0631 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 0632 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 0633 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 0634 # link to the source code. Otherwise they will link to the documentstion. 0635 0636 REFERENCES_LINK_SOURCE = YES 0637 0638 # If the USE_HTAGS tag is set to YES then the references to source code 0639 # will point to the HTML generated by the htags(1) tool instead of doxygen 0640 # built-in source browser. The htags tool is part of GNU's global source 0641 # tagging system (see http://www.gnu.org/software/global/global.html). You 0642 # will need version 4.8.6 or higher. 0643 0644 USE_HTAGS = NO 0645 0646 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 0647 # will generate a verbatim copy of the header file for each class for 0648 # which an include is specified. Set to NO to disable this. 0649 0650 VERBATIM_HEADERS = YES 0651 0652 #--------------------------------------------------------------------------- 0653 # configuration options related to the alphabetical class index 0654 #--------------------------------------------------------------------------- 0655 0656 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 0657 # of all compounds will be generated. Enable this if the project 0658 # contains a lot of classes, structs, unions or interfaces. 0659 0660 ALPHABETICAL_INDEX = NO 0661 0662 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 0663 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 0664 # in which this list will be split (can be a number in the range [1..20]) 0665 0666 COLS_IN_ALPHA_INDEX = 5 0667 0668 # In case all classes in a project start with a common prefix, all 0669 # classes will be put under the same header in the alphabetical index. 0670 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 0671 # should be ignored while generating the index headers. 0672 0673 IGNORE_PREFIX = 0674 0675 #--------------------------------------------------------------------------- 0676 # configuration options related to the HTML output 0677 #--------------------------------------------------------------------------- 0678 0679 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 0680 # generate HTML output. 0681 0682 GENERATE_HTML = YES 0683 0684 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 0685 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 0686 # put in front of it. If left blank `html' will be used as the default path. 0687 0688 HTML_OUTPUT = html 0689 0690 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 0691 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 0692 # doxygen will generate files with .html extension. 0693 0694 HTML_FILE_EXTENSION = .html 0695 0696 # The HTML_HEADER tag can be used to specify a personal HTML header for 0697 # each generated HTML page. If it is left blank doxygen will generate a 0698 # standard header. 0699 0700 HTML_HEADER = 0701 0702 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 0703 # each generated HTML page. If it is left blank doxygen will generate a 0704 # standard footer. 0705 0706 HTML_FOOTER = 0707 0708 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 0709 # style sheet that is used by each HTML page. It can be used to 0710 # fine-tune the look of the HTML output. If the tag is left blank doxygen 0711 # will generate a default style sheet. Note that doxygen will try to copy 0712 # the style sheet file to the HTML output directory, so don't put your own 0713 # stylesheet in the HTML output directory as well, or it will be erased! 0714 0715 HTML_STYLESHEET = 0716 0717 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 0718 # files or namespaces will be aligned in HTML using tables. If set to 0719 # NO a bullet list will be used. 0720 0721 HTML_ALIGN_MEMBERS = YES 0722 0723 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 0724 # will be generated that can be used as input for tools like the 0725 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 0726 # of the generated HTML documentation. 0727 0728 GENERATE_HTMLHELP = NO 0729 0730 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 0731 # be used to specify the file name of the resulting .chm file. You 0732 # can add a path in front of the file if the result should not be 0733 # written to the html output directory. 0734 0735 CHM_FILE = 0736 0737 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 0738 # be used to specify the location (absolute path including file name) of 0739 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 0740 # the HTML help compiler on the generated index.hhp. 0741 0742 HHC_LOCATION = 0743 0744 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 0745 # controls if a separate .chi index file is generated (YES) or that 0746 # it should be included in the master .chm file (NO). 0747 0748 GENERATE_CHI = NO 0749 0750 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 0751 # controls whether a binary table of contents is generated (YES) or a 0752 # normal table of contents (NO) in the .chm file. 0753 0754 BINARY_TOC = NO 0755 0756 # The TOC_EXPAND flag can be set to YES to add extra items for group members 0757 # to the contents of the HTML help documentation and to the tree view. 0758 0759 TOC_EXPAND = NO 0760 0761 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 0762 # top of each HTML page. The value NO (the default) enables the index and 0763 # the value YES disables it. 0764 0765 DISABLE_INDEX = NO 0766 0767 # This tag can be used to set the number of enum values (range [1..20]) 0768 # that doxygen will group on one line in the generated HTML documentation. 0769 0770 ENUM_VALUES_PER_LINE = 4 0771 0772 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 0773 # generated containing a tree-like index structure (just like the one that 0774 # is generated for HTML Help). For this to work a browser that supports 0775 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 0776 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 0777 # probably better off using the HTML help feature. 0778 0779 GENERATE_TREEVIEW = NO 0780 0781 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 0782 # used to set the initial width (in pixels) of the frame in which the tree 0783 # is shown. 0784 0785 TREEVIEW_WIDTH = 250 0786 0787 #--------------------------------------------------------------------------- 0788 # configuration options related to the LaTeX output 0789 #--------------------------------------------------------------------------- 0790 0791 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 0792 # generate Latex output. 0793 0794 GENERATE_LATEX = NO 0795 0796 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 0797 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 0798 # put in front of it. If left blank `latex' will be used as the default path. 0799 0800 LATEX_OUTPUT = latex 0801 0802 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 0803 # invoked. If left blank `latex' will be used as the default command name. 0804 0805 LATEX_CMD_NAME = latex 0806 0807 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 0808 # generate index for LaTeX. If left blank `makeindex' will be used as the 0809 # default command name. 0810 0811 MAKEINDEX_CMD_NAME = makeindex 0812 0813 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 0814 # LaTeX documents. This may be useful for small projects and may help to 0815 # save some trees in general. 0816 0817 COMPACT_LATEX = NO 0818 0819 # The PAPER_TYPE tag can be used to set the paper type that is used 0820 # by the printer. Possible values are: a4, a4wide, letter, legal and 0821 # executive. If left blank a4wide will be used. 0822 0823 PAPER_TYPE = a4wide 0824 0825 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 0826 # packages that should be included in the LaTeX output. 0827 0828 EXTRA_PACKAGES = 0829 0830 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 0831 # the generated latex document. The header should contain everything until 0832 # the first chapter. If it is left blank doxygen will generate a 0833 # standard header. Notice: only use this tag if you know what you are doing! 0834 0835 LATEX_HEADER = 0836 0837 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 0838 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 0839 # contain links (just like the HTML output) instead of page references 0840 # This makes the output suitable for online browsing using a pdf viewer. 0841 0842 PDF_HYPERLINKS = YES 0843 0844 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 0845 # plain latex in the generated Makefile. Set this option to YES to get a 0846 # higher quality PDF documentation. 0847 0848 USE_PDFLATEX = YES 0849 0850 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 0851 # command to the generated LaTeX files. This will instruct LaTeX to keep 0852 # running if errors occur, instead of asking the user for help. 0853 # This option is also used when generating formulas in HTML. 0854 0855 LATEX_BATCHMODE = YES 0856 0857 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 0858 # include the index chapters (such as File Index, Compound Index, etc.) 0859 # in the output. 0860 0861 LATEX_HIDE_INDICES = NO 0862 0863 #--------------------------------------------------------------------------- 0864 # configuration options related to the RTF output 0865 #--------------------------------------------------------------------------- 0866 0867 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 0868 # The RTF output is optimized for Word 97 and may not look very pretty with 0869 # other RTF readers or editors. 0870 0871 GENERATE_RTF = NO 0872 0873 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 0874 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 0875 # put in front of it. If left blank `rtf' will be used as the default path. 0876 0877 RTF_OUTPUT = rtf 0878 0879 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 0880 # RTF documents. This may be useful for small projects and may help to 0881 # save some trees in general. 0882 0883 COMPACT_RTF = NO 0884 0885 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 0886 # will contain hyperlink fields. The RTF file will 0887 # contain links (just like the HTML output) instead of page references. 0888 # This makes the output suitable for online browsing using WORD or other 0889 # programs which support those fields. 0890 # Note: wordpad (write) and others do not support links. 0891 0892 RTF_HYPERLINKS = NO 0893 0894 # Load stylesheet definitions from file. Syntax is similar to doxygen's 0895 # config file, i.e. a series of assignments. You only have to provide 0896 # replacements, missing definitions are set to their default value. 0897 0898 RTF_STYLESHEET_FILE = 0899 0900 # Set optional variables used in the generation of an rtf document. 0901 # Syntax is similar to doxygen's config file. 0902 0903 RTF_EXTENSIONS_FILE = 0904 0905 #--------------------------------------------------------------------------- 0906 # configuration options related to the man page output 0907 #--------------------------------------------------------------------------- 0908 0909 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 0910 # generate man pages 0911 0912 GENERATE_MAN = NO 0913 0914 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 0915 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 0916 # put in front of it. If left blank `man' will be used as the default path. 0917 0918 MAN_OUTPUT = man 0919 0920 # The MAN_EXTENSION tag determines the extension that is added to 0921 # the generated man pages (default is the subroutine's section .3) 0922 0923 MAN_EXTENSION = .3 0924 0925 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 0926 # then it will generate one additional man file for each entity 0927 # documented in the real man page(s). These additional files 0928 # only source the real man page, but without them the man command 0929 # would be unable to find the correct page. The default is NO. 0930 0931 MAN_LINKS = NO 0932 0933 #--------------------------------------------------------------------------- 0934 # configuration options related to the XML output 0935 #--------------------------------------------------------------------------- 0936 0937 # If the GENERATE_XML tag is set to YES Doxygen will 0938 # generate an XML file that captures the structure of 0939 # the code including all documentation. 0940 0941 GENERATE_XML = NO 0942 0943 # The XML_OUTPUT tag is used to specify where the XML pages will be put. 0944 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 0945 # put in front of it. If left blank `xml' will be used as the default path. 0946 0947 XML_OUTPUT = xml 0948 0949 # The XML_SCHEMA tag can be used to specify an XML schema, 0950 # which can be used by a validating XML parser to check the 0951 # syntax of the XML files. 0952 0953 XML_SCHEMA = 0954 0955 # The XML_DTD tag can be used to specify an XML DTD, 0956 # which can be used by a validating XML parser to check the 0957 # syntax of the XML files. 0958 0959 XML_DTD = 0960 0961 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 0962 # dump the program listings (including syntax highlighting 0963 # and cross-referencing information) to the XML output. Note that 0964 # enabling this will significantly increase the size of the XML output. 0965 0966 XML_PROGRAMLISTING = YES 0967 0968 #--------------------------------------------------------------------------- 0969 # configuration options for the AutoGen Definitions output 0970 #--------------------------------------------------------------------------- 0971 0972 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 0973 # generate an AutoGen Definitions (see autogen.sf.net) file 0974 # that captures the structure of the code including all 0975 # documentation. Note that this feature is still experimental 0976 # and incomplete at the moment. 0977 0978 GENERATE_AUTOGEN_DEF = NO 0979 0980 #--------------------------------------------------------------------------- 0981 # configuration options related to the Perl module output 0982 #--------------------------------------------------------------------------- 0983 0984 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 0985 # generate a Perl module file that captures the structure of 0986 # the code including all documentation. Note that this 0987 # feature is still experimental and incomplete at the 0988 # moment. 0989 0990 GENERATE_PERLMOD = NO 0991 0992 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 0993 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 0994 # to generate PDF and DVI output from the Perl module output. 0995 0996 PERLMOD_LATEX = NO 0997 0998 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 0999 # nicely formatted so it can be parsed by a human reader. This is useful 1000 # if you want to understand what is going on. On the other hand, if this 1001 # tag is set to NO the size of the Perl module output will be much smaller 1002 # and Perl will parse it just the same. 1003 1004 PERLMOD_PRETTY = YES 1005 1006 # The names of the make variables in the generated doxyrules.make file 1007 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 1008 # This is useful so different doxyrules.make files included by the same 1009 # Makefile don't overwrite each other's variables. 1010 1011 PERLMOD_MAKEVAR_PREFIX = 1012 1013 #--------------------------------------------------------------------------- 1014 # Configuration options related to the preprocessor 1015 #--------------------------------------------------------------------------- 1016 1017 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 1018 # evaluate all C-preprocessor directives found in the sources and include 1019 # files. 1020 1021 ENABLE_PREPROCESSING = YES 1022 1023 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 1024 # names in the source code. If set to NO (the default) only conditional 1025 # compilation will be performed. Macro expansion can be done in a controlled 1026 # way by setting EXPAND_ONLY_PREDEF to YES. 1027 1028 MACRO_EXPANSION = NO 1029 1030 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1031 # then the macro expansion is limited to the macros specified with the 1032 # PREDEFINED and EXPAND_AS_DEFINED tags. 1033 1034 EXPAND_ONLY_PREDEF = NO 1035 1036 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1037 # in the INCLUDE_PATH (see below) will be search if a #include is found. 1038 1039 SEARCH_INCLUDES = YES 1040 1041 # The INCLUDE_PATH tag can be used to specify one or more directories that 1042 # contain include files that are not input files but should be processed by 1043 # the preprocessor. 1044 1045 INCLUDE_PATH = 1046 1047 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1048 # patterns (like *.h and *.hpp) to filter out the header-files in the 1049 # directories. If left blank, the patterns specified with FILE_PATTERNS will 1050 # be used. 1051 1052 INCLUDE_FILE_PATTERNS = 1053 1054 # The PREDEFINED tag can be used to specify one or more macro names that 1055 # are defined before the preprocessor is started (similar to the -D option of 1056 # gcc). The argument of the tag is a list of macros of the form: name 1057 # or name=definition (no spaces). If the definition and the = are 1058 # omitted =1 is assumed. To prevent a macro definition from being 1059 # undefined via #undef or recursively expanded use the := operator 1060 # instead of the = operator. 1061 1062 # add DOXYGEN_NO_PROVIDER_API here to disable generation of the 1063 # Provider API documentation with Doxygen. 1064 PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \ 1065 QPIPE_SECURE 1066 1067 1068 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1069 # this tag can be used to specify a list of macro names that should be expanded. 1070 # The macro definition that is found in the sources will be used. 1071 # Use the PREDEFINED tag if you want to use a different macro definition. 1072 1073 EXPAND_AS_DEFINED = QCA_EXPORT QCA_NOEXCEPT 1074 1075 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1076 # doxygen's preprocessor will remove all function-like macros that are alone 1077 # on a line, have an all uppercase name, and do not end with a semicolon. Such 1078 # function macros are typically used for boiler-plate code, and will confuse 1079 # the parser if not removed. 1080 1081 SKIP_FUNCTION_MACROS = YES 1082 1083 #--------------------------------------------------------------------------- 1084 # Configuration::additions related to external references 1085 #--------------------------------------------------------------------------- 1086 1087 # The TAGFILES option can be used to specify one or more tagfiles. 1088 # Optionally an initial location of the external documentation 1089 # can be added for each tagfile. The format of a tag file without 1090 # this location is as follows: 1091 # TAGFILES = file1 file2 ... 1092 # Adding location for the tag files is done as follows: 1093 # TAGFILES = file1=loc1 "file2 = loc2" ... 1094 # where "loc1" and "loc2" can be relative or absolute paths or 1095 # URLs. If a location is present for each tag, the installdox tool 1096 # does not have to be run to correct the links. 1097 # Note that each tag file must have a unique name 1098 # (where the name does NOT include the path) 1099 # If a tag file is not located in the directory in which doxygen 1100 # is run, you must also specify the path to the tagfile here. 1101 1102 TAGFILES = 1103 1104 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1105 # a tag file that is based on the input files it reads. 1106 1107 GENERATE_TAGFILE = 1108 1109 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1110 # in the class index. If set to NO only the inherited external classes 1111 # will be listed. 1112 1113 ALLEXTERNALS = NO 1114 1115 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1116 # in the modules index. If set to NO, only the current project's groups will 1117 # be listed. 1118 1119 EXTERNAL_GROUPS = YES 1120 1121 # The PERL_PATH should be the absolute path and name of the perl script 1122 # interpreter (i.e. the result of `which perl'). 1123 1124 PERL_PATH = /usr/bin/perl 1125 1126 #--------------------------------------------------------------------------- 1127 # Configuration options related to the dot tool 1128 #--------------------------------------------------------------------------- 1129 1130 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1131 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1132 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1133 # this option is superseded by the HAVE_DOT option below. This is only a 1134 # fallback. It is recommended to install and use dot, since it yields more 1135 # powerful graphs. 1136 1137 CLASS_DIAGRAMS = YES 1138 1139 # You can define message sequence charts within doxygen comments using the \msc 1140 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 1141 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 1142 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to 1143 # be found in the default search path. 1144 1145 MSCGEN_PATH = 1146 1147 # If set to YES, the inheritance and collaboration graphs will hide 1148 # inheritance and usage relations if the target is undocumented 1149 # or is not a class. 1150 1151 HIDE_UNDOC_RELATIONS = NO 1152 1153 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1154 # available from the path. This tool is part of Graphviz, a graph visualization 1155 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1156 # have no effect if this option is set to NO (the default) 1157 1158 HAVE_DOT = YES 1159 1160 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1161 # will generate a graph for each documented class showing the direct and 1162 # indirect inheritance relations. Setting this tag to YES will force the 1163 # the CLASS_DIAGRAMS tag to NO. 1164 1165 CLASS_GRAPH = NO 1166 1167 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1168 # will generate a graph for each documented class showing the direct and 1169 # indirect implementation dependencies (inheritance, containment, and 1170 # class references variables) of the class with other documented classes. 1171 1172 COLLABORATION_GRAPH = YES 1173 1174 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1175 # will generate a graph for groups, showing the direct groups dependencies 1176 1177 GROUP_GRAPHS = YES 1178 1179 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1180 # collaboration diagrams in a style similar to the OMG's Unified Modeling 1181 # Language. 1182 1183 UML_LOOK = NO 1184 1185 # If set to YES, the inheritance and collaboration graphs will show the 1186 # relations between templates and their instances. 1187 1188 TEMPLATE_RELATIONS = NO 1189 1190 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1191 # tags are set to YES then doxygen will generate a graph for each documented 1192 # file showing the direct and indirect include dependencies of the file with 1193 # other documented files. 1194 1195 INCLUDE_GRAPH = YES 1196 1197 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1198 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1199 # documented header file showing the documented files that directly or 1200 # indirectly include this file. 1201 1202 INCLUDED_BY_GRAPH = YES 1203 1204 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1205 # generate a call dependency graph for every global function or class method. 1206 # Note that enabling this option will significantly increase the time of a run. 1207 # So in most cases it will be better to enable call graphs for selected 1208 # functions only using the \callgraph command. 1209 1210 CALL_GRAPH = NO 1211 1212 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1213 # generate a caller dependency graph for every global function or class method. 1214 # Note that enabling this option will significantly increase the time of a run. 1215 # So in most cases it will be better to enable caller graphs for selected 1216 # functions only using the \callergraph command. 1217 1218 CALLER_GRAPH = NO 1219 1220 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1221 # will graphical hierarchy of all classes instead of a textual one. 1222 1223 GRAPHICAL_HIERARCHY = YES 1224 1225 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1226 # then doxygen will show the dependencies a directory has on other directories 1227 # in a graphical way. The dependency relations are determined by the #include 1228 # relations between the files in the directories. 1229 1230 DIRECTORY_GRAPH = YES 1231 1232 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1233 # generated by dot. Possible values are png, jpg, or gif 1234 # If left blank png will be used. 1235 1236 DOT_IMAGE_FORMAT = png 1237 1238 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1239 # found. If left blank, it is assumed the dot tool can be found in the path. 1240 1241 DOT_PATH = 1242 1243 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1244 # contain dot files that are included in the documentation (see the 1245 # \dotfile command). 1246 1247 DOTFILE_DIRS = 1248 1249 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1250 # nodes that will be shown in the graph. If the number of nodes in a graph 1251 # becomes larger than this value, doxygen will truncate the graph, which is 1252 # visualized by representing a node as a red box. Note that doxygen will always 1253 # show the root nodes and its direct children regardless of this setting. 1254 1255 DOT_GRAPH_MAX_NODES = 50 1256 1257 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1258 # background. This is disabled by default, which results in a white background. 1259 # Warning: Depending on the platform used, enabling this option may lead to 1260 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1261 # read). 1262 1263 DOT_TRANSPARENT = NO 1264 1265 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1266 # files in one run (i.e. multiple -o and -T options on the command line). This 1267 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1268 # support this, this feature is disabled by default. 1269 1270 DOT_MULTI_TARGETS = NO 1271 1272 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1273 # generate a legend page explaining the meaning of the various boxes and 1274 # arrows in the dot generated graphs. 1275 1276 GENERATE_LEGEND = YES 1277 1278 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1279 # remove the intermediate dot files that are used to generate 1280 # the various graphs. 1281 1282 DOT_CLEANUP = YES 1283 1284 #--------------------------------------------------------------------------- 1285 # Configuration::additions related to the search engine 1286 #--------------------------------------------------------------------------- 1287 1288 # The SEARCHENGINE tag specifies whether or not a search engine should be 1289 # used. If set to NO the values of all tags below this one will be ignored. 1290 1291 SEARCHENGINE = NO