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