Warning, /system/libdebconf-kde/Doxyfile 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 = libdebconf-kde 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 = 0.1 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 = docs 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 = YES 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 = NO 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 = YES 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 = 4 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 = YES 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 = YES 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 = NO 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 = NO 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 = YES 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 = NO 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 = NO 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 = NO 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 = NO 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 = src/DebconfGui.h 0466 # This tag can be used to specify the character encoding of the source files that 0467 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 0468 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 0469 # See http://www.gnu.org/software/libiconv for the list of possible encodings. 0470 0471 INPUT_ENCODING = UTF-8 0472 0473 # If the value of the INPUT tag contains directories, you can use the 0474 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 0475 # and *.h) to filter out the source-files in the directories. If left 0476 # blank the following patterns are tested: 0477 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 0478 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py 0479 0480 FILE_PATTERNS = 0481 0482 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 0483 # should be searched for input files as well. Possible values are YES and NO. 0484 # If left blank NO is used. 0485 0486 RECURSIVE = NO 0487 0488 # The EXCLUDE tag can be used to specify files and/or directories that should 0489 # excluded from the INPUT source files. This way you can easily exclude a 0490 # subdirectory from a directory tree whose root is specified with the INPUT tag. 0491 0492 EXCLUDE = 0493 0494 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 0495 # directories that are symbolic links (a Unix filesystem feature) are excluded 0496 # from the input. 0497 0498 EXCLUDE_SYMLINKS = NO 0499 0500 # If the value of the INPUT tag contains directories, you can use the 0501 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 0502 # certain files from those directories. Note that the wildcards are matched 0503 # against the file with absolute path, so to exclude all test directories 0504 # for example use the pattern */test/* 0505 0506 EXCLUDE_PATTERNS = *private* *proxy* polkitclient* util.* 0507 0508 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 0509 # (namespaces, classes, functions, etc.) that should be excluded from the output. 0510 # The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 0511 # a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test 0512 0513 # Exlude signal wrappers 0514 EXCLUDE_SYMBOLS = 0515 EXCLUDE_SYMBOLS += __emit* 0516 0517 # The EXAMPLE_PATH tag can be used to specify one or more files or 0518 # directories that contain example code fragments that are included (see 0519 # the \include command). 0520 0521 EXAMPLE_PATH = 0522 0523 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 0524 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 0525 # and *.h) to filter out the source-files in the directories. If left 0526 # blank all files are included. 0527 0528 EXAMPLE_PATTERNS = 0529 0530 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 0531 # searched for input files to be used with the \include or \dontinclude 0532 # commands irrespective of the value of the RECURSIVE tag. 0533 # Possible values are YES and NO. If left blank NO is used. 0534 0535 EXAMPLE_RECURSIVE = NO 0536 0537 # The IMAGE_PATH tag can be used to specify one or more files or 0538 # directories that contain image that are included in the documentation (see 0539 # the \image command). 0540 0541 IMAGE_PATH = 0542 0543 # The INPUT_FILTER tag can be used to specify a program that doxygen should 0544 # invoke to filter for each input file. Doxygen will invoke the filter program 0545 # by executing (via popen()) the command <filter> <input-file>, where <filter> 0546 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 0547 # input file. Doxygen will then use the output that the filter program writes 0548 # to standard output. If FILTER_PATTERNS is specified, this tag will be 0549 # ignored. 0550 0551 INPUT_FILTER = 0552 0553 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 0554 # basis. Doxygen will compare the file name with each pattern and apply the 0555 # filter if there is a match. The filters are a list of the form: 0556 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 0557 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 0558 # is applied to all files. 0559 0560 FILTER_PATTERNS = 0561 0562 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 0563 # INPUT_FILTER) will be used to filter the input files when producing source 0564 # files to browse (i.e. when SOURCE_BROWSER is set to YES). 0565 0566 FILTER_SOURCE_FILES = NO 0567 0568 #--------------------------------------------------------------------------- 0569 # configuration options related to source browsing 0570 #--------------------------------------------------------------------------- 0571 0572 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 0573 # be generated. Documented entities will be cross-referenced with these sources. 0574 # Note: To get rid of all source code in the generated output, make sure also 0575 # VERBATIM_HEADERS is set to NO. 0576 0577 SOURCE_BROWSER = NO 0578 0579 # Setting the INLINE_SOURCES tag to YES will include the body 0580 # of functions and classes directly in the documentation. 0581 0582 INLINE_SOURCES = NO 0583 0584 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 0585 # doxygen to hide any special comment blocks from generated source code 0586 # fragments. Normal C and C++ comments will always remain visible. 0587 0588 STRIP_CODE_COMMENTS = YES 0589 0590 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 0591 # then for each documented function all documented 0592 # functions referencing it will be listed. 0593 0594 REFERENCED_BY_RELATION = NO 0595 0596 # If the REFERENCES_RELATION tag is set to YES (the default) 0597 # then for each documented function all documented entities 0598 # called/used by that function will be listed. 0599 0600 REFERENCES_RELATION = NO 0601 0602 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 0603 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 0604 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 0605 # link to the source code. Otherwise they will link to the documentstion. 0606 0607 REFERENCES_LINK_SOURCE = NO 0608 0609 # If the USE_HTAGS tag is set to YES then the references to source code 0610 # will point to the HTML generated by the htags(1) tool instead of doxygen 0611 # built-in source browser. The htags tool is part of GNU's global source 0612 # tagging system (see http://www.gnu.org/software/global/global.html). You 0613 # will need version 4.8.6 or higher. 0614 0615 USE_HTAGS = NO 0616 0617 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 0618 # will generate a verbatim copy of the header file for each class for 0619 # which an include is specified. Set to NO to disable this. 0620 0621 VERBATIM_HEADERS = YES 0622 0623 #--------------------------------------------------------------------------- 0624 # configuration options related to the alphabetical class index 0625 #--------------------------------------------------------------------------- 0626 0627 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 0628 # of all compounds will be generated. Enable this if the project 0629 # contains a lot of classes, structs, unions or interfaces. 0630 0631 ALPHABETICAL_INDEX = NO 0632 0633 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 0634 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 0635 # in which this list will be split (can be a number in the range [1..20]) 0636 0637 COLS_IN_ALPHA_INDEX = 5 0638 0639 # In case all classes in a project start with a common prefix, all 0640 # classes will be put under the same header in the alphabetical index. 0641 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 0642 # should be ignored while generating the index headers. 0643 0644 IGNORE_PREFIX = 0645 0646 #--------------------------------------------------------------------------- 0647 # configuration options related to the HTML output 0648 #--------------------------------------------------------------------------- 0649 0650 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 0651 # generate HTML output. 0652 0653 GENERATE_HTML = YES 0654 0655 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 0656 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 0657 # put in front of it. If left blank `html' will be used as the default path. 0658 0659 HTML_OUTPUT = html 0660 0661 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 0662 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 0663 # doxygen will generate files with .html extension. 0664 0665 HTML_FILE_EXTENSION = .html 0666 0667 # The HTML_HEADER tag can be used to specify a personal HTML header for 0668 # each generated HTML page. If it is left blank doxygen will generate a 0669 # standard header. 0670 0671 HTML_HEADER = 0672 0673 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 0674 # each generated HTML page. If it is left blank doxygen will generate a 0675 # standard footer. 0676 0677 HTML_FOOTER = 0678 0679 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 0680 # style sheet that is used by each HTML page. It can be used to 0681 # fine-tune the look of the HTML output. If the tag is left blank doxygen 0682 # will generate a default style sheet. Note that doxygen will try to copy 0683 # the style sheet file to the HTML output directory, so don't put your own 0684 # stylesheet in the HTML output directory as well, or it will be erased! 0685 0686 HTML_STYLESHEET = 0687 0688 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 0689 # files or namespaces will be aligned in HTML using tables. If set to 0690 # NO a bullet list will be used. 0691 0692 HTML_ALIGN_MEMBERS = YES 0693 0694 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 0695 # will be generated that can be used as input for tools like the 0696 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 0697 # of the generated HTML documentation. 0698 0699 GENERATE_HTMLHELP = NO 0700 0701 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 0702 # be used to specify the file name of the resulting .chm file. You 0703 # can add a path in front of the file if the result should not be 0704 # written to the html output directory. 0705 0706 CHM_FILE = 0707 0708 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 0709 # be used to specify the location (absolute path including file name) of 0710 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 0711 # the HTML help compiler on the generated index.hhp. 0712 0713 HHC_LOCATION = 0714 0715 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 0716 # controls if a separate .chi index file is generated (YES) or that 0717 # it should be included in the master .chm file (NO). 0718 0719 GENERATE_CHI = NO 0720 0721 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 0722 # controls whether a binary table of contents is generated (YES) or a 0723 # normal table of contents (NO) in the .chm file. 0724 0725 BINARY_TOC = NO 0726 0727 # The TOC_EXPAND flag can be set to YES to add extra items for group members 0728 # to the contents of the HTML help documentation and to the tree view. 0729 0730 TOC_EXPAND = NO 0731 0732 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 0733 # top of each HTML page. The value NO (the default) enables the index and 0734 # the value YES disables it. 0735 0736 DISABLE_INDEX = NO 0737 0738 # This tag can be used to set the number of enum values (range [1..20]) 0739 # that doxygen will group on one line in the generated HTML documentation. 0740 0741 ENUM_VALUES_PER_LINE = 4 0742 0743 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 0744 # generated containing a tree-like index structure (just like the one that 0745 # is generated for HTML Help). For this to work a browser that supports 0746 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 0747 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 0748 # probably better off using the HTML help feature. 0749 0750 GENERATE_TREEVIEW = NO 0751 0752 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 0753 # used to set the initial width (in pixels) of the frame in which the tree 0754 # is shown. 0755 0756 TREEVIEW_WIDTH = 250 0757 0758 #--------------------------------------------------------------------------- 0759 # configuration options related to the LaTeX output 0760 #--------------------------------------------------------------------------- 0761 0762 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 0763 # generate Latex output. 0764 0765 GENERATE_LATEX = YES 0766 0767 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 0768 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 0769 # put in front of it. If left blank `latex' will be used as the default path. 0770 0771 LATEX_OUTPUT = latex 0772 0773 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 0774 # invoked. If left blank `latex' will be used as the default command name. 0775 0776 LATEX_CMD_NAME = latex 0777 0778 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 0779 # generate index for LaTeX. If left blank `makeindex' will be used as the 0780 # default command name. 0781 0782 MAKEINDEX_CMD_NAME = makeindex 0783 0784 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 0785 # LaTeX documents. This may be useful for small projects and may help to 0786 # save some trees in general. 0787 0788 COMPACT_LATEX = NO 0789 0790 # The PAPER_TYPE tag can be used to set the paper type that is used 0791 # by the printer. Possible values are: a4, a4wide, letter, legal and 0792 # executive. If left blank a4wide will be used. 0793 0794 PAPER_TYPE = a4wide 0795 0796 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 0797 # packages that should be included in the LaTeX output. 0798 0799 EXTRA_PACKAGES = 0800 0801 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 0802 # the generated latex document. The header should contain everything until 0803 # the first chapter. If it is left blank doxygen will generate a 0804 # standard header. Notice: only use this tag if you know what you are doing! 0805 0806 LATEX_HEADER = 0807 0808 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 0809 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 0810 # contain links (just like the HTML output) instead of page references 0811 # This makes the output suitable for online browsing using a pdf viewer. 0812 0813 PDF_HYPERLINKS = NO 0814 0815 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 0816 # plain latex in the generated Makefile. Set this option to YES to get a 0817 # higher quality PDF documentation. 0818 0819 USE_PDFLATEX = NO 0820 0821 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 0822 # command to the generated LaTeX files. This will instruct LaTeX to keep 0823 # running if errors occur, instead of asking the user for help. 0824 # This option is also used when generating formulas in HTML. 0825 0826 LATEX_BATCHMODE = NO 0827 0828 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 0829 # include the index chapters (such as File Index, Compound Index, etc.) 0830 # in the output. 0831 0832 LATEX_HIDE_INDICES = NO 0833 0834 #--------------------------------------------------------------------------- 0835 # configuration options related to the RTF output 0836 #--------------------------------------------------------------------------- 0837 0838 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 0839 # The RTF output is optimized for Word 97 and may not look very pretty with 0840 # other RTF readers or editors. 0841 0842 GENERATE_RTF = NO 0843 0844 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 0845 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 0846 # put in front of it. If left blank `rtf' will be used as the default path. 0847 0848 RTF_OUTPUT = rtf 0849 0850 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 0851 # RTF documents. This may be useful for small projects and may help to 0852 # save some trees in general. 0853 0854 COMPACT_RTF = NO 0855 0856 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 0857 # will contain hyperlink fields. The RTF file will 0858 # contain links (just like the HTML output) instead of page references. 0859 # This makes the output suitable for online browsing using WORD or other 0860 # programs which support those fields. 0861 # Note: wordpad (write) and others do not support links. 0862 0863 RTF_HYPERLINKS = NO 0864 0865 # Load stylesheet definitions from file. Syntax is similar to doxygen's 0866 # config file, i.e. a series of assignments. You only have to provide 0867 # replacements, missing definitions are set to their default value. 0868 0869 RTF_STYLESHEET_FILE = 0870 0871 # Set optional variables used in the generation of an rtf document. 0872 # Syntax is similar to doxygen's config file. 0873 0874 RTF_EXTENSIONS_FILE = 0875 0876 #--------------------------------------------------------------------------- 0877 # configuration options related to the man page output 0878 #--------------------------------------------------------------------------- 0879 0880 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 0881 # generate man pages 0882 0883 GENERATE_MAN = NO 0884 0885 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 0886 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 0887 # put in front of it. If left blank `man' will be used as the default path. 0888 0889 MAN_OUTPUT = man 0890 0891 # The MAN_EXTENSION tag determines the extension that is added to 0892 # the generated man pages (default is the subroutine's section .3) 0893 0894 MAN_EXTENSION = .3 0895 0896 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 0897 # then it will generate one additional man file for each entity 0898 # documented in the real man page(s). These additional files 0899 # only source the real man page, but without them the man command 0900 # would be unable to find the correct page. The default is NO. 0901 0902 MAN_LINKS = NO 0903 0904 #--------------------------------------------------------------------------- 0905 # configuration options related to the XML output 0906 #--------------------------------------------------------------------------- 0907 0908 # If the GENERATE_XML tag is set to YES Doxygen will 0909 # generate an XML file that captures the structure of 0910 # the code including all documentation. 0911 0912 GENERATE_XML = NO 0913 0914 # The XML_OUTPUT tag is used to specify where the XML 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 `xml' will be used as the default path. 0917 0918 XML_OUTPUT = xml 0919 0920 # The XML_SCHEMA tag can be used to specify an XML schema, 0921 # which can be used by a validating XML parser to check the 0922 # syntax of the XML files. 0923 0924 XML_SCHEMA = 0925 0926 # The XML_DTD tag can be used to specify an XML DTD, 0927 # which can be used by a validating XML parser to check the 0928 # syntax of the XML files. 0929 0930 XML_DTD = 0931 0932 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 0933 # dump the program listings (including syntax highlighting 0934 # and cross-referencing information) to the XML output. Note that 0935 # enabling this will significantly increase the size of the XML output. 0936 0937 XML_PROGRAMLISTING = YES 0938 0939 #--------------------------------------------------------------------------- 0940 # configuration options for the AutoGen Definitions output 0941 #--------------------------------------------------------------------------- 0942 0943 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 0944 # generate an AutoGen Definitions (see autogen.sf.net) file 0945 # that captures the structure of the code including all 0946 # documentation. Note that this feature is still experimental 0947 # and incomplete at the moment. 0948 0949 GENERATE_AUTOGEN_DEF = NO 0950 0951 #--------------------------------------------------------------------------- 0952 # configuration options related to the Perl module output 0953 #--------------------------------------------------------------------------- 0954 0955 # If the GENERATE_PERLMOD tag is set to YES Doxygen will 0956 # generate a Perl module file that captures the structure of 0957 # the code including all documentation. Note that this 0958 # feature is still experimental and incomplete at the 0959 # moment. 0960 0961 GENERATE_PERLMOD = NO 0962 0963 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 0964 # the necessary Makefile rules, Perl scripts and LaTeX code to be able 0965 # to generate PDF and DVI output from the Perl module output. 0966 0967 PERLMOD_LATEX = NO 0968 0969 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 0970 # nicely formatted so it can be parsed by a human reader. This is useful 0971 # if you want to understand what is going on. On the other hand, if this 0972 # tag is set to NO the size of the Perl module output will be much smaller 0973 # and Perl will parse it just the same. 0974 0975 PERLMOD_PRETTY = YES 0976 0977 # The names of the make variables in the generated doxyrules.make file 0978 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 0979 # This is useful so different doxyrules.make files included by the same 0980 # Makefile don't overwrite each other's variables. 0981 0982 PERLMOD_MAKEVAR_PREFIX = 0983 0984 #--------------------------------------------------------------------------- 0985 # Configuration options related to the preprocessor 0986 #--------------------------------------------------------------------------- 0987 0988 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 0989 # evaluate all C-preprocessor directives found in the sources and include 0990 # files. 0991 0992 ENABLE_PREPROCESSING = YES 0993 0994 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 0995 # names in the source code. If set to NO (the default) only conditional 0996 # compilation will be performed. Macro expansion can be done in a controlled 0997 # way by setting EXPAND_ONLY_PREDEF to YES. 0998 0999 MACRO_EXPANSION = NO 1000 1001 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1002 # then the macro expansion is limited to the macros specified with the 1003 # PREDEFINED and EXPAND_AS_DEFINED tags. 1004 1005 EXPAND_ONLY_PREDEF = NO 1006 1007 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1008 # in the INCLUDE_PATH (see below) will be search if a #include is found. 1009 1010 SEARCH_INCLUDES = YES 1011 1012 # The INCLUDE_PATH tag can be used to specify one or more directories that 1013 # contain include files that are not input files but should be processed by 1014 # the preprocessor. 1015 1016 INCLUDE_PATH = 1017 1018 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 1019 # patterns (like *.h and *.hpp) to filter out the header-files in the 1020 # directories. If left blank, the patterns specified with FILE_PATTERNS will 1021 # be used. 1022 1023 INCLUDE_FILE_PATTERNS = 1024 1025 # The PREDEFINED tag can be used to specify one or more macro names that 1026 # are defined before the preprocessor is started (similar to the -D option of 1027 # gcc). The argument of the tag is a list of macros of the form: name 1028 # or name=definition (no spaces). If the definition and the = are 1029 # omitted =1 is assumed. To prevent a macro definition from being 1030 # undefined via #undef or recursively expanded use the := operator 1031 # instead of the = operator. 1032 1033 PREDEFINED = 1034 1035 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1036 # this tag can be used to specify a list of macro names that should be expanded. 1037 # The macro definition that is found in the sources will be used. 1038 # Use the PREDEFINED tag if you want to use a different macro definition. 1039 1040 EXPAND_AS_DEFINED = 1041 1042 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 1043 # doxygen's preprocessor will remove all function-like macros that are alone 1044 # on a line, have an all uppercase name, and do not end with a semicolon. Such 1045 # function macros are typically used for boiler-plate code, and will confuse 1046 # the parser if not removed. 1047 1048 SKIP_FUNCTION_MACROS = YES 1049 1050 #--------------------------------------------------------------------------- 1051 # Configuration::additions related to external references 1052 #--------------------------------------------------------------------------- 1053 1054 # The TAGFILES option can be used to specify one or more tagfiles. 1055 # Optionally an initial location of the external documentation 1056 # can be added for each tagfile. The format of a tag file without 1057 # this location is as follows: 1058 # TAGFILES = file1 file2 ... 1059 # Adding location for the tag files is done as follows: 1060 # TAGFILES = file1=loc1 "file2 = loc2" ... 1061 # where "loc1" and "loc2" can be relative or absolute paths or 1062 # URLs. If a location is present for each tag, the installdox tool 1063 # does not have to be run to correct the links. 1064 # Note that each tag file must have a unique name 1065 # (where the name does NOT include the path) 1066 # If a tag file is not located in the directory in which doxygen 1067 # is run, you must also specify the path to the tagfile here. 1068 1069 TAGFILES = 1070 1071 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1072 # a tag file that is based on the input files it reads. 1073 1074 GENERATE_TAGFILE = 1075 1076 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1077 # in the class index. If set to NO only the inherited external classes 1078 # will be listed. 1079 1080 ALLEXTERNALS = NO 1081 1082 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 1083 # in the modules index. If set to NO, only the current project's groups will 1084 # be listed. 1085 1086 EXTERNAL_GROUPS = YES 1087 1088 # The PERL_PATH should be the absolute path and name of the perl script 1089 # interpreter (i.e. the result of `which perl'). 1090 1091 PERL_PATH = /usr/bin/perl 1092 1093 #--------------------------------------------------------------------------- 1094 # Configuration options related to the dot tool 1095 #--------------------------------------------------------------------------- 1096 1097 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 1098 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 1099 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1100 # this option is superseded by the HAVE_DOT option below. This is only a 1101 # fallback. It is recommended to install and use dot, since it yields more 1102 # powerful graphs. 1103 1104 CLASS_DIAGRAMS = YES 1105 1106 # You can define message sequence charts within doxygen comments using the \msc 1107 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 1108 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 1109 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to 1110 # be found in the default search path. 1111 1112 MSCGEN_PATH = 1113 1114 # If set to YES, the inheritance and collaboration graphs will hide 1115 # inheritance and usage relations if the target is undocumented 1116 # or is not a class. 1117 1118 HIDE_UNDOC_RELATIONS = YES 1119 1120 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1121 # available from the path. This tool is part of Graphviz, a graph visualization 1122 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1123 # have no effect if this option is set to NO (the default) 1124 1125 HAVE_DOT = NO 1126 1127 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1128 # will generate a graph for each documented class showing the direct and 1129 # indirect inheritance relations. Setting this tag to YES will force the 1130 # the CLASS_DIAGRAMS tag to NO. 1131 1132 CLASS_GRAPH = YES 1133 1134 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 1135 # will generate a graph for each documented class showing the direct and 1136 # indirect implementation dependencies (inheritance, containment, and 1137 # class references variables) of the class with other documented classes. 1138 1139 COLLABORATION_GRAPH = YES 1140 1141 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 1142 # will generate a graph for groups, showing the direct groups dependencies 1143 1144 GROUP_GRAPHS = YES 1145 1146 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 1147 # collaboration diagrams in a style similar to the OMG's Unified Modeling 1148 # Language. 1149 1150 UML_LOOK = NO 1151 1152 # If set to YES, the inheritance and collaboration graphs will show the 1153 # relations between templates and their instances. 1154 1155 TEMPLATE_RELATIONS = NO 1156 1157 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1158 # tags are set to YES then doxygen will generate a graph for each documented 1159 # file showing the direct and indirect include dependencies of the file with 1160 # other documented files. 1161 1162 INCLUDE_GRAPH = YES 1163 1164 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1165 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1166 # documented header file showing the documented files that directly or 1167 # indirectly include this file. 1168 1169 INCLUDED_BY_GRAPH = YES 1170 1171 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1172 # generate a call dependency graph for every global function or class method. 1173 # Note that enabling this option will significantly increase the time of a run. 1174 # So in most cases it will be better to enable call graphs for selected 1175 # functions only using the \callgraph command. 1176 1177 CALL_GRAPH = NO 1178 1179 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1180 # generate a caller dependency graph for every global function or class method. 1181 # Note that enabling this option will significantly increase the time of a run. 1182 # So in most cases it will be better to enable caller graphs for selected 1183 # functions only using the \callergraph command. 1184 1185 CALLER_GRAPH = NO 1186 1187 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1188 # will graphical hierarchy of all classes instead of a textual one. 1189 1190 GRAPHICAL_HIERARCHY = YES 1191 1192 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1193 # then doxygen will show the dependencies a directory has on other directories 1194 # in a graphical way. The dependency relations are determined by the #include 1195 # relations between the files in the directories. 1196 1197 DIRECTORY_GRAPH = YES 1198 1199 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1200 # generated by dot. Possible values are png, jpg, or gif 1201 # If left blank png will be used. 1202 1203 DOT_IMAGE_FORMAT = png 1204 1205 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1206 # found. If left blank, it is assumed the dot tool can be found in the path. 1207 1208 DOT_PATH = 1209 1210 # The DOTFILE_DIRS tag can be used to specify one or more directories that 1211 # contain dot files that are included in the documentation (see the 1212 # \dotfile command). 1213 1214 DOTFILE_DIRS = 1215 1216 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 1217 # nodes that will be shown in the graph. If the number of nodes in a graph 1218 # becomes larger than this value, doxygen will truncate the graph, which is 1219 # visualized by representing a node as a red box. Note that doxygen will always 1220 # show the root nodes and its direct children regardless of this setting. 1221 1222 DOT_GRAPH_MAX_NODES = 50 1223 1224 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1225 # background. This is disabled by default, which results in a white background. 1226 # Warning: Depending on the platform used, enabling this option may lead to 1227 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1228 # read). 1229 1230 DOT_TRANSPARENT = NO 1231 1232 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1233 # files in one run (i.e. multiple -o and -T options on the command line). This 1234 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1235 # support this, this feature is disabled by default. 1236 1237 DOT_MULTI_TARGETS = NO 1238 1239 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1240 # generate a legend page explaining the meaning of the various boxes and 1241 # arrows in the dot generated graphs. 1242 1243 GENERATE_LEGEND = YES 1244 1245 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 1246 # remove the intermediate dot files that are used to generate 1247 # the various graphs. 1248 1249 DOT_CLEANUP = YES 1250 1251 #--------------------------------------------------------------------------- 1252 # Configuration::additions related to the search engine 1253 #--------------------------------------------------------------------------- 1254 1255 # The SEARCHENGINE tag specifies whether or not a search engine should be 1256 # used. If set to NO the values of all tags below this one will be ignored. 1257 1258 SEARCHENGINE = NO