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