| 1 | # Doxyfile 1.4.2␊ |
| 2 | ␊ |
| 3 | # This file describes the settings to be used by the documentation system␊ |
| 4 | # doxygen (www.doxygen.org) for a project␊ |
| 5 | #␊ |
| 6 | # All text after a hash (#) is considered a comment and will be ignored␊ |
| 7 | # The format is:␊ |
| 8 | # TAG = value [value, ...]␊ |
| 9 | # For lists items can also be appended using:␊ |
| 10 | # TAG += value [value, ...]␊ |
| 11 | # Values that contain spaces should be placed between quotes (" ")␊ |
| 12 | ␊ |
| 13 | #---------------------------------------------------------------------------␊ |
| 14 | # Project related configuration options␊ |
| 15 | #---------------------------------------------------------------------------␊ |
| 16 | ␊ |
| 17 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded ␊ |
| 18 | # by quotes) that should identify the project.␊ |
| 19 | ␊ |
| 20 | PROJECT_NAME = Monotone␊ |
| 21 | ␊ |
| 22 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. ␊ |
| 23 | # This could be handy for archiving the generated documentation or ␊ |
| 24 | # if some version control system is used.␊ |
| 25 | ␊ |
| 26 | PROJECT_NUMBER = 0.18␊ |
| 27 | ␊ |
| 28 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) ␊ |
| 29 | # base path where the generated documentation will be put. ␊ |
| 30 | # If a relative path is entered, it will be relative to the location ␊ |
| 31 | # where doxygen was started. If left blank the current directory will be used.␊ |
| 32 | ␊ |
| 33 | OUTPUT_DIRECTORY = apidocs␊ |
| 34 | ␊ |
| 35 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create ␊ |
| 36 | # 4096 sub-directories (in 2 levels) under the output directory of each output ␊ |
| 37 | # format and will distribute the generated files over these directories. ␊ |
| 38 | # Enabling this option can be useful when feeding doxygen a huge amount of ␊ |
| 39 | # source files, where putting all generated files in the same directory would ␊ |
| 40 | # otherwise cause performance problems for the file system.␊ |
| 41 | ␊ |
| 42 | CREATE_SUBDIRS = NO␊ |
| 43 | ␊ |
| 44 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all ␊ |
| 45 | # documentation generated by doxygen is written. Doxygen will use this ␊ |
| 46 | # information to generate all constant output in the proper language. ␊ |
| 47 | # The default language is English, other supported languages are: ␊ |
| 48 | # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, ␊ |
| 49 | # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, ␊ |
| 50 | # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, ␊ |
| 51 | # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, ␊ |
| 52 | # Swedish, and Ukrainian.␊ |
| 53 | ␊ |
| 54 | OUTPUT_LANGUAGE = English␊ |
| 55 | ␊ |
| 56 | # This tag can be used to specify the encoding used in the generated output. ␊ |
| 57 | # The encoding is not always determined by the language that is chosen, ␊ |
| 58 | # but also whether or not the output is meant for Windows or non-Windows users. ␊ |
| 59 | # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES ␊ |
| 60 | # forces the Windows encoding (this is the default for the Windows binary), ␊ |
| 61 | # whereas setting the tag to NO uses a Unix-style encoding (the default for ␊ |
| 62 | # all platforms other than Windows).␊ |
| 63 | ␊ |
| 64 | USE_WINDOWS_ENCODING = NO␊ |
| 65 | ␊ |
| 66 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will ␊ |
| 67 | # include brief member descriptions after the members that are listed in ␊ |
| 68 | # the file and class documentation (similar to JavaDoc). ␊ |
| 69 | # Set to NO to disable this.␊ |
| 70 | ␊ |
| 71 | BRIEF_MEMBER_DESC = YES␊ |
| 72 | ␊ |
| 73 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend ␊ |
| 74 | # the brief description of a member or function before the detailed description. ␊ |
| 75 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the ␊ |
| 76 | # brief descriptions will be completely suppressed.␊ |
| 77 | ␊ |
| 78 | REPEAT_BRIEF = YES␊ |
| 79 | ␊ |
| 80 | # This tag implements a quasi-intelligent brief description abbreviator ␊ |
| 81 | # that is used to form the text in various listings. Each string ␊ |
| 82 | # in this list, if found as the leading text of the brief description, will be ␊ |
| 83 | # stripped from the text and the result after processing the whole list, is ␊ |
| 84 | # used as the annotated text. Otherwise, the brief description is used as-is. ␊ |
| 85 | # If left blank, the following values are used ("$name" is automatically ␊ |
| 86 | # replaced with the name of the entity): "The $name class" "The $name widget" ␊ |
| 87 | # "The $name file" "is" "provides" "specifies" "contains" ␊ |
| 88 | # "represents" "a" "an" "the"␊ |
| 89 | ␊ |
| 90 | ABBREVIATE_BRIEF = ␊ |
| 91 | ␊ |
| 92 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then ␊ |
| 93 | # Doxygen will generate a detailed section even if there is only a brief ␊ |
| 94 | # description.␊ |
| 95 | ␊ |
| 96 | ALWAYS_DETAILED_SEC = NO␊ |
| 97 | ␊ |
| 98 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all ␊ |
| 99 | # inherited members of a class in the documentation of that class as if those ␊ |
| 100 | # members were ordinary class members. Constructors, destructors and assignment ␊ |
| 101 | # operators of the base classes will not be shown.␊ |
| 102 | ␊ |
| 103 | INLINE_INHERITED_MEMB = NO␊ |
| 104 | ␊ |
| 105 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full ␊ |
| 106 | # path before files name in the file list and in the header files. If set ␊ |
| 107 | # to NO the shortest path that makes the file name unique will be used.␊ |
| 108 | ␊ |
| 109 | FULL_PATH_NAMES = YES␊ |
| 110 | ␊ |
| 111 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag ␊ |
| 112 | # can be used to strip a user-defined part of the path. Stripping is ␊ |
| 113 | # only done if one of the specified strings matches the left-hand part of ␊ |
| 114 | # the path. The tag can be used to show relative paths in the file list. ␊ |
| 115 | # If left blank the directory from which doxygen is run is used as the ␊ |
| 116 | # path to strip.␊ |
| 117 | ␊ |
| 118 | STRIP_FROM_PATH = ␊ |
| 119 | ␊ |
| 120 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of ␊ |
| 121 | # the path mentioned in the documentation of a class, which tells ␊ |
| 122 | # the reader which header file to include in order to use a class. ␊ |
| 123 | # If left blank only the name of the header file containing the class ␊ |
| 124 | # definition is used. Otherwise one should specify the include paths that ␊ |
| 125 | # are normally passed to the compiler using the -I flag.␊ |
| 126 | ␊ |
| 127 | STRIP_FROM_INC_PATH = ␊ |
| 128 | ␊ |
| 129 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter ␊ |
| 130 | # (but less readable) file names. This can be useful is your file systems ␊ |
| 131 | # doesn't support long names like on DOS, Mac, or CD-ROM.␊ |
| 132 | ␊ |
| 133 | SHORT_NAMES = NO␊ |
| 134 | ␊ |
| 135 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen ␊ |
| 136 | # will interpret the first line (until the first dot) of a JavaDoc-style ␊ |
| 137 | # comment as the brief description. If set to NO, the JavaDoc ␊ |
| 138 | # comments will behave just like the Qt-style comments (thus requiring an ␊ |
| 139 | # explicit @brief command for a brief description.␊ |
| 140 | ␊ |
| 141 | JAVADOC_AUTOBRIEF = YES␊ |
| 142 | ␊ |
| 143 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen ␊ |
| 144 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// ␊ |
| 145 | # comments) as a brief description. This used to be the default behaviour. ␊ |
| 146 | # The new default is to treat a multi-line C++ comment block as a detailed ␊ |
| 147 | # description. Set this tag to YES if you prefer the old behaviour instead.␊ |
| 148 | ␊ |
| 149 | MULTILINE_CPP_IS_BRIEF = NO␊ |
| 150 | ␊ |
| 151 | # If the DETAILS_AT_TOP tag is set to YES then Doxygen ␊ |
| 152 | # will output the detailed description near the top, like JavaDoc.␊ |
| 153 | # If set to NO, the detailed description appears after the member ␊ |
| 154 | # documentation.␊ |
| 155 | ␊ |
| 156 | DETAILS_AT_TOP = NO␊ |
| 157 | ␊ |
| 158 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented ␊ |
| 159 | # member inherits the documentation from any documented member that it ␊ |
| 160 | # re-implements.␊ |
| 161 | ␊ |
| 162 | INHERIT_DOCS = YES␊ |
| 163 | ␊ |
| 164 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC ␊ |
| 165 | # tag is set to YES, then doxygen will reuse the documentation of the first ␊ |
| 166 | # member in the group (if any) for the other members of the group. By default ␊ |
| 167 | # all members of a group must be documented explicitly.␊ |
| 168 | ␊ |
| 169 | DISTRIBUTE_GROUP_DOC = NO␊ |
| 170 | ␊ |
| 171 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce ␊ |
| 172 | # a new page for each member. If set to NO, the documentation of a member will ␊ |
| 173 | # be part of the file/class/namespace that contains it.␊ |
| 174 | ␊ |
| 175 | SEPARATE_MEMBER_PAGES = NO␊ |
| 176 | ␊ |
| 177 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. ␊ |
| 178 | # Doxygen uses this value to replace tabs by spaces in code fragments.␊ |
| 179 | ␊ |
| 180 | TAB_SIZE = 4␊ |
| 181 | ␊ |
| 182 | # This tag can be used to specify a number of aliases that acts ␊ |
| 183 | # as commands in the documentation. An alias has the form "name=value". ␊ |
| 184 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to ␊ |
| 185 | # put the command \sideeffect (or @sideeffect) in the documentation, which ␊ |
| 186 | # will result in a user-defined paragraph with heading "Side Effects:". ␊ |
| 187 | # You can put \n's in the value part of an alias to insert newlines.␊ |
| 188 | ␊ |
| 189 | ALIASES = ␊ |
| 190 | ␊ |
| 191 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C ␊ |
| 192 | # sources only. Doxygen will then generate output that is more tailored for C. ␊ |
| 193 | # For instance, some of the names that are used will be different. The list ␊ |
| 194 | # of all members will be omitted, etc.␊ |
| 195 | ␊ |
| 196 | OPTIMIZE_OUTPUT_FOR_C = NO␊ |
| 197 | ␊ |
| 198 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources ␊ |
| 199 | # only. Doxygen will then generate output that is more tailored for Java. ␊ |
| 200 | # For instance, namespaces will be presented as packages, qualified scopes ␊ |
| 201 | # will look different, etc.␊ |
| 202 | ␊ |
| 203 | OPTIMIZE_OUTPUT_JAVA = NO␊ |
| 204 | ␊ |
| 205 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of ␊ |
| 206 | # the same type (for instance a group of public functions) to be put as a ␊ |
| 207 | # subgroup of that type (e.g. under the Public Functions section). Set it to ␊ |
| 208 | # NO to prevent subgrouping. Alternatively, this can be done per class using ␊ |
| 209 | # the \nosubgrouping command.␊ |
| 210 | ␊ |
| 211 | SUBGROUPING = YES␊ |
| 212 | ␊ |
| 213 | #---------------------------------------------------------------------------␊ |
| 214 | # Build related configuration options␊ |
| 215 | #---------------------------------------------------------------------------␊ |
| 216 | ␊ |
| 217 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in ␊ |
| 218 | # documentation are documented, even if no documentation was available. ␊ |
| 219 | # Private class members and static file members will be hidden unless ␊ |
| 220 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES␊ |
| 221 | ␊ |
| 222 | EXTRACT_ALL = YES␊ |
| 223 | ␊ |
| 224 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class ␊ |
| 225 | # will be included in the documentation.␊ |
| 226 | ␊ |
| 227 | EXTRACT_PRIVATE = NO␊ |
| 228 | ␊ |
| 229 | # If the EXTRACT_STATIC tag is set to YES all static members of a file ␊ |
| 230 | # will be included in the documentation.␊ |
| 231 | ␊ |
| 232 | EXTRACT_STATIC = NO␊ |
| 233 | ␊ |
| 234 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) ␊ |
| 235 | # defined locally in source files will be included in the documentation. ␊ |
| 236 | # If set to NO only classes defined in header files are included.␊ |
| 237 | ␊ |
| 238 | EXTRACT_LOCAL_CLASSES = YES␊ |
| 239 | ␊ |
| 240 | # This flag is only useful for Objective-C code. When set to YES local ␊ |
| 241 | # methods, which are defined in the implementation section but not in ␊ |
| 242 | # the interface are included in the documentation. ␊ |
| 243 | # If set to NO (the default) only methods in the interface are included.␊ |
| 244 | ␊ |
| 245 | EXTRACT_LOCAL_METHODS = NO␊ |
| 246 | ␊ |
| 247 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all ␊ |
| 248 | # undocumented members of documented classes, files or namespaces. ␊ |
| 249 | # If set to NO (the default) these members will be included in the ␊ |
| 250 | # various overviews, but no documentation section is generated. ␊ |
| 251 | # This option has no effect if EXTRACT_ALL is enabled.␊ |
| 252 | ␊ |
| 253 | HIDE_UNDOC_MEMBERS = NO␊ |
| 254 | ␊ |
| 255 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all ␊ |
| 256 | # undocumented classes that are normally visible in the class hierarchy. ␊ |
| 257 | # If set to NO (the default) these classes will be included in the various ␊ |
| 258 | # overviews. This option has no effect if EXTRACT_ALL is enabled.␊ |
| 259 | ␊ |
| 260 | HIDE_UNDOC_CLASSES = NO␊ |
| 261 | ␊ |
| 262 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all ␊ |
| 263 | # friend (class|struct|union) declarations. ␊ |
| 264 | # If set to NO (the default) these declarations will be included in the ␊ |
| 265 | # documentation.␊ |
| 266 | ␊ |
| 267 | HIDE_FRIEND_COMPOUNDS = NO␊ |
| 268 | ␊ |
| 269 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any ␊ |
| 270 | # documentation blocks found inside the body of a function. ␊ |
| 271 | # If set to NO (the default) these blocks will be appended to the ␊ |
| 272 | # function's detailed documentation block.␊ |
| 273 | ␊ |
| 274 | HIDE_IN_BODY_DOCS = NO␊ |
| 275 | ␊ |
| 276 | # The INTERNAL_DOCS tag determines if documentation ␊ |
| 277 | # that is typed after a \internal command is included. If the tag is set ␊ |
| 278 | # to NO (the default) then the documentation will be excluded. ␊ |
| 279 | # Set it to YES to include the internal documentation.␊ |
| 280 | ␊ |
| 281 | INTERNAL_DOCS = NO␊ |
| 282 | ␊ |
| 283 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate ␊ |
| 284 | # file names in lower-case letters. If set to YES upper-case letters are also ␊ |
| 285 | # allowed. This is useful if you have classes or files whose names only differ ␊ |
| 286 | # in case and if your file system supports case sensitive file names. Windows ␊ |
| 287 | # and Mac users are advised to set this option to NO.␊ |
| 288 | ␊ |
| 289 | CASE_SENSE_NAMES = YES␊ |
| 290 | ␊ |
| 291 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen ␊ |
| 292 | # will show members with their full class and namespace scopes in the ␊ |
| 293 | # documentation. If set to YES the scope will be hidden.␊ |
| 294 | ␊ |
| 295 | HIDE_SCOPE_NAMES = NO␊ |
| 296 | ␊ |
| 297 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen ␊ |
| 298 | # will put a list of the files that are included by a file in the documentation ␊ |
| 299 | # of that file.␊ |
| 300 | ␊ |
| 301 | SHOW_INCLUDE_FILES = YES␊ |
| 302 | ␊ |
| 303 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] ␊ |
| 304 | # is inserted in the documentation for inline members.␊ |
| 305 | ␊ |
| 306 | INLINE_INFO = YES␊ |
| 307 | ␊ |
| 308 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen ␊ |
| 309 | # will sort the (detailed) documentation of file and class members ␊ |
| 310 | # alphabetically by member name. If set to NO the members will appear in ␊ |
| 311 | # declaration order.␊ |
| 312 | ␊ |
| 313 | SORT_MEMBER_DOCS = YES␊ |
| 314 | ␊ |
| 315 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the ␊ |
| 316 | # brief documentation of file, namespace and class members alphabetically ␊ |
| 317 | # by member name. If set to NO (the default) the members will appear in ␊ |
| 318 | # declaration order.␊ |
| 319 | ␊ |
| 320 | SORT_BRIEF_DOCS = NO␊ |
| 321 | ␊ |
| 322 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be ␊ |
| 323 | # sorted by fully-qualified names, including namespaces. If set to ␊ |
| 324 | # NO (the default), the class list will be sorted only by class name, ␊ |
| 325 | # not including the namespace part. ␊ |
| 326 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.␊ |
| 327 | # Note: This option applies only to the class list, not to the ␊ |
| 328 | # alphabetical list.␊ |
| 329 | ␊ |
| 330 | SORT_BY_SCOPE_NAME = NO␊ |
| 331 | ␊ |
| 332 | # The GENERATE_TODOLIST tag can be used to enable (YES) or ␊ |
| 333 | # disable (NO) the todo list. This list is created by putting \todo ␊ |
| 334 | # commands in the documentation.␊ |
| 335 | ␊ |
| 336 | GENERATE_TODOLIST = YES␊ |
| 337 | ␊ |
| 338 | # The GENERATE_TESTLIST tag can be used to enable (YES) or ␊ |
| 339 | # disable (NO) the test list. This list is created by putting \test ␊ |
| 340 | # commands in the documentation.␊ |
| 341 | ␊ |
| 342 | GENERATE_TESTLIST = YES␊ |
| 343 | ␊ |
| 344 | # The GENERATE_BUGLIST tag can be used to enable (YES) or ␊ |
| 345 | # disable (NO) the bug list. This list is created by putting \bug ␊ |
| 346 | # commands in the documentation.␊ |
| 347 | ␊ |
| 348 | GENERATE_BUGLIST = YES␊ |
| 349 | ␊ |
| 350 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or ␊ |
| 351 | # disable (NO) the deprecated list. This list is created by putting ␊ |
| 352 | # \deprecated commands in the documentation.␊ |
| 353 | ␊ |
| 354 | GENERATE_DEPRECATEDLIST= YES␊ |
| 355 | ␊ |
| 356 | # The ENABLED_SECTIONS tag can be used to enable conditional ␊ |
| 357 | # documentation sections, marked by \if sectionname ... \endif.␊ |
| 358 | ␊ |
| 359 | ENABLED_SECTIONS = ␊ |
| 360 | ␊ |
| 361 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines ␊ |
| 362 | # the initial value of a variable or define consists of for it to appear in ␊ |
| 363 | # the documentation. If the initializer consists of more lines than specified ␊ |
| 364 | # here it will be hidden. Use a value of 0 to hide initializers completely. ␊ |
| 365 | # The appearance of the initializer of individual variables and defines in the ␊ |
| 366 | # documentation can be controlled using \showinitializer or \hideinitializer ␊ |
| 367 | # command in the documentation regardless of this setting.␊ |
| 368 | ␊ |
| 369 | MAX_INITIALIZER_LINES = 30␊ |
| 370 | ␊ |
| 371 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated ␊ |
| 372 | # at the bottom of the documentation of classes and structs. If set to YES the ␊ |
| 373 | # list will mention the files that were used to generate the documentation.␊ |
| 374 | ␊ |
| 375 | SHOW_USED_FILES = YES␊ |
| 376 | ␊ |
| 377 | # If the sources in your project are distributed over multiple directories ␊ |
| 378 | # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy ␊ |
| 379 | # in the documentation.␊ |
| 380 | ␊ |
| 381 | SHOW_DIRECTORIES = YES␊ |
| 382 | ␊ |
| 383 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that ␊ |
| 384 | # doxygen should invoke to get the current version for each file (typically from the ␊ |
| 385 | # version control system). Doxygen will invoke the program by executing (via ␊ |
| 386 | # popen()) the command <command> <input-file>, where <command> is the value of ␊ |
| 387 | # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file ␊ |
| 388 | # provided by doxygen. Whatever the progam writes to standard output ␊ |
| 389 | # is used as the file version. See the manual for examples.␊ |
| 390 | ␊ |
| 391 | FILE_VERSION_FILTER = ␊ |
| 392 | ␊ |
| 393 | #---------------------------------------------------------------------------␊ |
| 394 | # configuration options related to warning and progress messages␊ |
| 395 | #---------------------------------------------------------------------------␊ |
| 396 | ␊ |
| 397 | # The QUIET tag can be used to turn on/off the messages that are generated ␊ |
| 398 | # by doxygen. Possible values are YES and NO. If left blank NO is used.␊ |
| 399 | ␊ |
| 400 | QUIET = NO␊ |
| 401 | ␊ |
| 402 | # The WARNINGS tag can be used to turn on/off the warning messages that are ␊ |
| 403 | # generated by doxygen. Possible values are YES and NO. If left blank ␊ |
| 404 | # NO is used.␊ |
| 405 | ␊ |
| 406 | WARNINGS = YES␊ |
| 407 | ␊ |
| 408 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings ␊ |
| 409 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will ␊ |
| 410 | # automatically be disabled.␊ |
| 411 | ␊ |
| 412 | WARN_IF_UNDOCUMENTED = YES␊ |
| 413 | ␊ |
| 414 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for ␊ |
| 415 | # potential errors in the documentation, such as not documenting some ␊ |
| 416 | # parameters in a documented function, or documenting parameters that ␊ |
| 417 | # don't exist or using markup commands wrongly.␊ |
| 418 | ␊ |
| 419 | WARN_IF_DOC_ERROR = YES␊ |
| 420 | ␊ |
| 421 | # This WARN_NO_PARAMDOC option can be abled to get warnings for ␊ |
| 422 | # functions that are documented, but have no documentation for their parameters ␊ |
| 423 | # or return value. If set to NO (the default) doxygen will only warn about ␊ |
| 424 | # wrong or incomplete parameter documentation, but not about the absence of ␊ |
| 425 | # documentation.␊ |
| 426 | ␊ |
| 427 | WARN_NO_PARAMDOC = NO␊ |
| 428 | ␊ |
| 429 | # The WARN_FORMAT tag determines the format of the warning messages that ␊ |
| 430 | # doxygen can produce. The string should contain the $file, $line, and $text ␊ |
| 431 | # tags, which will be replaced by the file and line number from which the ␊ |
| 432 | # warning originated and the warning text. Optionally the format may contain ␊ |
| 433 | # $version, which will be replaced by the version of the file (if it could ␊ |
| 434 | # be obtained via FILE_VERSION_FILTER)␊ |
| 435 | ␊ |
| 436 | WARN_FORMAT = "$file:$line: $text"␊ |
| 437 | ␊ |
| 438 | # The WARN_LOGFILE tag can be used to specify a file to which warning ␊ |
| 439 | # and error messages should be written. If left blank the output is written ␊ |
| 440 | # to stderr.␊ |
| 441 | ␊ |
| 442 | WARN_LOGFILE = ␊ |
| 443 | ␊ |
| 444 | #---------------------------------------------------------------------------␊ |
| 445 | # configuration options related to the input files␊ |
| 446 | #---------------------------------------------------------------------------␊ |
| 447 | ␊ |
| 448 | # The INPUT tag can be used to specify the files and/or directories that contain ␊ |
| 449 | # documented source files. You may enter file names like "myfile.cpp" or ␊ |
| 450 | # directories like "/usr/src/myproject". Separate the files or directories ␊ |
| 451 | # with spaces.␊ |
| 452 | ␊ |
| 453 | INPUT = ␊ |
| 454 | ␊ |
| 455 | # If the value of the INPUT tag contains directories, you can use the ␊ |
| 456 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp ␊ |
| 457 | # and *.h) to filter out the source-files in the directories. If left ␊ |
| 458 | # blank the following patterns are tested: ␊ |
| 459 | # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx ␊ |
| 460 | # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm␊ |
| 461 | ␊ |
| 462 | FILE_PATTERNS = *.cc *.hh␊ |
| 463 | ␊ |
| 464 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories ␊ |
| 465 | # should be searched for input files as well. Possible values are YES and NO. ␊ |
| 466 | # If left blank NO is used.␊ |
| 467 | ␊ |
| 468 | RECURSIVE = NO␊ |
| 469 | ␊ |
| 470 | # The EXCLUDE tag can be used to specify files and/or directories that should ␊ |
| 471 | # excluded from the INPUT source files. This way you can easily exclude a ␊ |
| 472 | # subdirectory from a directory tree whose root is specified with the INPUT tag.␊ |
| 473 | ␊ |
| 474 | EXCLUDE = ␊ |
| 475 | ␊ |
| 476 | # The EXCLUDE_SYMLINKS tag can be used select whether or not files or ␊ |
| 477 | # directories that are symbolic links (a Unix filesystem feature) are excluded ␊ |
| 478 | # from the input.␊ |
| 479 | ␊ |
| 480 | EXCLUDE_SYMLINKS = NO␊ |
| 481 | ␊ |
| 482 | # If the value of the INPUT tag contains directories, you can use the ␊ |
| 483 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude ␊ |
| 484 | # certain files from those directories.␊ |
| 485 | ␊ |
| 486 | EXCLUDE_PATTERNS = ␊ |
| 487 | ␊ |
| 488 | # The EXAMPLE_PATH tag can be used to specify one or more files or ␊ |
| 489 | # directories that contain example code fragments that are included (see ␊ |
| 490 | # the \include command).␊ |
| 491 | ␊ |
| 492 | EXAMPLE_PATH = ␊ |
| 493 | ␊ |
| 494 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the ␊ |
| 495 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp ␊ |
| 496 | # and *.h) to filter out the source-files in the directories. If left ␊ |
| 497 | # blank all files are included.␊ |
| 498 | ␊ |
| 499 | EXAMPLE_PATTERNS = ␊ |
| 500 | ␊ |
| 501 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be ␊ |
| 502 | # searched for input files to be used with the \include or \dontinclude ␊ |
| 503 | # commands irrespective of the value of the RECURSIVE tag. ␊ |
| 504 | # Possible values are YES and NO. If left blank NO is used.␊ |
| 505 | ␊ |
| 506 | EXAMPLE_RECURSIVE = NO␊ |
| 507 | ␊ |
| 508 | # The IMAGE_PATH tag can be used to specify one or more files or ␊ |
| 509 | # directories that contain image that are included in the documentation (see ␊ |
| 510 | # the \image command).␊ |
| 511 | ␊ |
| 512 | IMAGE_PATH = ␊ |
| 513 | ␊ |
| 514 | # The INPUT_FILTER tag can be used to specify a program that doxygen should ␊ |
| 515 | # invoke to filter for each input file. Doxygen will invoke the filter program ␊ |
| 516 | # by executing (via popen()) the command <filter> <input-file>, where <filter> ␊ |
| 517 | # is the value of the INPUT_FILTER tag, and <input-file> is the name of an ␊ |
| 518 | # input file. Doxygen will then use the output that the filter program writes ␊ |
| 519 | # to standard output. If FILTER_PATTERNS is specified, this tag will be ␊ |
| 520 | # ignored.␊ |
| 521 | ␊ |
| 522 | INPUT_FILTER = ␊ |
| 523 | ␊ |
| 524 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern ␊ |
| 525 | # basis. Doxygen will compare the file name with each pattern and apply the ␊ |
| 526 | # filter if there is a match. The filters are a list of the form: ␊ |
| 527 | # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further ␊ |
| 528 | # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER ␊ |
| 529 | # is applied to all files.␊ |
| 530 | ␊ |
| 531 | FILTER_PATTERNS = ␊ |
| 532 | ␊ |
| 533 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using ␊ |
| 534 | # INPUT_FILTER) will be used to filter the input files when producing source ␊ |
| 535 | # files to browse (i.e. when SOURCE_BROWSER is set to YES).␊ |
| 536 | ␊ |
| 537 | FILTER_SOURCE_FILES = NO␊ |
| 538 | ␊ |
| 539 | #---------------------------------------------------------------------------␊ |
| 540 | # configuration options related to source browsing␊ |
| 541 | #---------------------------------------------------------------------------␊ |
| 542 | ␊ |
| 543 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will ␊ |
| 544 | # be generated. Documented entities will be cross-referenced with these sources. ␊ |
| 545 | # Note: To get rid of all source code in the generated output, make sure also ␊ |
| 546 | # VERBATIM_HEADERS is set to NO.␊ |
| 547 | ␊ |
| 548 | SOURCE_BROWSER = YES␊ |
| 549 | ␊ |
| 550 | # Setting the INLINE_SOURCES tag to YES will include the body ␊ |
| 551 | # of functions and classes directly in the documentation.␊ |
| 552 | ␊ |
| 553 | INLINE_SOURCES = NO␊ |
| 554 | ␊ |
| 555 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct ␊ |
| 556 | # doxygen to hide any special comment blocks from generated source code ␊ |
| 557 | # fragments. Normal C and C++ comments will always remain visible.␊ |
| 558 | ␊ |
| 559 | STRIP_CODE_COMMENTS = YES␊ |
| 560 | ␊ |
| 561 | # If the REFERENCED_BY_RELATION tag is set to YES (the default) ␊ |
| 562 | # then for each documented function all documented ␊ |
| 563 | # functions referencing it will be listed.␊ |
| 564 | ␊ |
| 565 | REFERENCED_BY_RELATION = YES␊ |
| 566 | ␊ |
| 567 | # If the REFERENCES_RELATION tag is set to YES (the default) ␊ |
| 568 | # then for each documented function all documented entities ␊ |
| 569 | # called/used by that function will be listed.␊ |
| 570 | ␊ |
| 571 | REFERENCES_RELATION = YES␊ |
| 572 | ␊ |
| 573 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen ␊ |
| 574 | # will generate a verbatim copy of the header file for each class for ␊ |
| 575 | # which an include is specified. Set to NO to disable this.␊ |
| 576 | ␊ |
| 577 | VERBATIM_HEADERS = YES␊ |
| 578 | ␊ |
| 579 | #---------------------------------------------------------------------------␊ |
| 580 | # configuration options related to the alphabetical class index␊ |
| 581 | #---------------------------------------------------------------------------␊ |
| 582 | ␊ |
| 583 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index ␊ |
| 584 | # of all compounds will be generated. Enable this if the project ␊ |
| 585 | # contains a lot of classes, structs, unions or interfaces.␊ |
| 586 | ␊ |
| 587 | ALPHABETICAL_INDEX = YES␊ |
| 588 | ␊ |
| 589 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then ␊ |
| 590 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns ␊ |
| 591 | # in which this list will be split (can be a number in the range [1..20])␊ |
| 592 | ␊ |
| 593 | COLS_IN_ALPHA_INDEX = 5␊ |
| 594 | ␊ |
| 595 | # In case all classes in a project start with a common prefix, all ␊ |
| 596 | # classes will be put under the same header in the alphabetical index. ␊ |
| 597 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that ␊ |
| 598 | # should be ignored while generating the index headers.␊ |
| 599 | ␊ |
| 600 | IGNORE_PREFIX = ␊ |
| 601 | ␊ |
| 602 | #---------------------------------------------------------------------------␊ |
| 603 | # configuration options related to the HTML output␊ |
| 604 | #---------------------------------------------------------------------------␊ |
| 605 | ␊ |
| 606 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will ␊ |
| 607 | # generate HTML output.␊ |
| 608 | ␊ |
| 609 | GENERATE_HTML = YES␊ |
| 610 | ␊ |
| 611 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. ␊ |
| 612 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be ␊ |
| 613 | # put in front of it. If left blank `html' will be used as the default path.␊ |
| 614 | ␊ |
| 615 | HTML_OUTPUT = html␊ |
| 616 | ␊ |
| 617 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for ␊ |
| 618 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank ␊ |
| 619 | # doxygen will generate files with .html extension.␊ |
| 620 | ␊ |
| 621 | HTML_FILE_EXTENSION = .html␊ |
| 622 | ␊ |
| 623 | # The HTML_HEADER tag can be used to specify a personal HTML header for ␊ |
| 624 | # each generated HTML page. If it is left blank doxygen will generate a ␊ |
| 625 | # standard header.␊ |
| 626 | ␊ |
| 627 | HTML_HEADER = ␊ |
| 628 | ␊ |
| 629 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for ␊ |
| 630 | # each generated HTML page. If it is left blank doxygen will generate a ␊ |
| 631 | # standard footer.␊ |
| 632 | ␊ |
| 633 | HTML_FOOTER = ␊ |
| 634 | ␊ |
| 635 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading ␊ |
| 636 | # style sheet that is used by each HTML page. It can be used to ␊ |
| 637 | # fine-tune the look of the HTML output. If the tag is left blank doxygen ␊ |
| 638 | # will generate a default style sheet. Note that doxygen will try to copy ␊ |
| 639 | # the style sheet file to the HTML output directory, so don't put your own ␊ |
| 640 | # stylesheet in the HTML output directory as well, or it will be erased!␊ |
| 641 | ␊ |
| 642 | HTML_STYLESHEET = ␊ |
| 643 | ␊ |
| 644 | # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, ␊ |
| 645 | # files or namespaces will be aligned in HTML using tables. If set to ␊ |
| 646 | # NO a bullet list will be used.␊ |
| 647 | ␊ |
| 648 | HTML_ALIGN_MEMBERS = YES␊ |
| 649 | ␊ |
| 650 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files ␊ |
| 651 | # will be generated that can be used as input for tools like the ␊ |
| 652 | # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) ␊ |
| 653 | # of the generated HTML documentation.␊ |
| 654 | ␊ |
| 655 | GENERATE_HTMLHELP = NO␊ |
| 656 | ␊ |
| 657 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can ␊ |
| 658 | # be used to specify the file name of the resulting .chm file. You ␊ |
| 659 | # can add a path in front of the file if the result should not be ␊ |
| 660 | # written to the html output directory.␊ |
| 661 | ␊ |
| 662 | CHM_FILE = ␊ |
| 663 | ␊ |
| 664 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can ␊ |
| 665 | # be used to specify the location (absolute path including file name) of ␊ |
| 666 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run ␊ |
| 667 | # the HTML help compiler on the generated index.hhp.␊ |
| 668 | ␊ |
| 669 | HHC_LOCATION = ␊ |
| 670 | ␊ |
| 671 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag ␊ |
| 672 | # controls if a separate .chi index file is generated (YES) or that ␊ |
| 673 | # it should be included in the master .chm file (NO).␊ |
| 674 | ␊ |
| 675 | GENERATE_CHI = NO␊ |
| 676 | ␊ |
| 677 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag ␊ |
| 678 | # controls whether a binary table of contents is generated (YES) or a ␊ |
| 679 | # normal table of contents (NO) in the .chm file.␊ |
| 680 | ␊ |
| 681 | BINARY_TOC = NO␊ |
| 682 | ␊ |
| 683 | # The TOC_EXPAND flag can be set to YES to add extra items for group members ␊ |
| 684 | # to the contents of the HTML help documentation and to the tree view.␊ |
| 685 | ␊ |
| 686 | TOC_EXPAND = NO␊ |
| 687 | ␊ |
| 688 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index at ␊ |
| 689 | # top of each HTML page. The value NO (the default) enables the index and ␊ |
| 690 | # the value YES disables it.␊ |
| 691 | ␊ |
| 692 | DISABLE_INDEX = NO␊ |
| 693 | ␊ |
| 694 | # This tag can be used to set the number of enum values (range [1..20]) ␊ |
| 695 | # that doxygen will group on one line in the generated HTML documentation.␊ |
| 696 | ␊ |
| 697 | ENUM_VALUES_PER_LINE = 4␊ |
| 698 | ␊ |
| 699 | # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be␊ |
| 700 | # generated containing a tree-like index structure (just like the one that ␊ |
| 701 | # is generated for HTML Help). For this to work a browser that supports ␊ |
| 702 | # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, ␊ |
| 703 | # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are ␊ |
| 704 | # probably better off using the HTML help feature.␊ |
| 705 | ␊ |
| 706 | GENERATE_TREEVIEW = NO␊ |
| 707 | ␊ |
| 708 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be ␊ |
| 709 | # used to set the initial width (in pixels) of the frame in which the tree ␊ |
| 710 | # is shown.␊ |
| 711 | ␊ |
| 712 | TREEVIEW_WIDTH = 250␊ |
| 713 | ␊ |
| 714 | #---------------------------------------------------------------------------␊ |
| 715 | # configuration options related to the LaTeX output␊ |
| 716 | #---------------------------------------------------------------------------␊ |
| 717 | ␊ |
| 718 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will ␊ |
| 719 | # generate Latex output.␊ |
| 720 | ␊ |
| 721 | GENERATE_LATEX = NO␊ |
| 722 | ␊ |
| 723 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. ␊ |
| 724 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be ␊ |
| 725 | # put in front of it. If left blank `latex' will be used as the default path.␊ |
| 726 | ␊ |
| 727 | LATEX_OUTPUT = latex␊ |
| 728 | ␊ |
| 729 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be ␊ |
| 730 | # invoked. If left blank `latex' will be used as the default command name.␊ |
| 731 | ␊ |
| 732 | LATEX_CMD_NAME = latex␊ |
| 733 | ␊ |
| 734 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to ␊ |
| 735 | # generate index for LaTeX. If left blank `makeindex' will be used as the ␊ |
| 736 | # default command name.␊ |
| 737 | ␊ |
| 738 | MAKEINDEX_CMD_NAME = makeindex␊ |
| 739 | ␊ |
| 740 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact ␊ |
| 741 | # LaTeX documents. This may be useful for small projects and may help to ␊ |
| 742 | # save some trees in general.␊ |
| 743 | ␊ |
| 744 | COMPACT_LATEX = NO␊ |
| 745 | ␊ |
| 746 | # The PAPER_TYPE tag can be used to set the paper type that is used ␊ |
| 747 | # by the printer. Possible values are: a4, a4wide, letter, legal and ␊ |
| 748 | # executive. If left blank a4wide will be used.␊ |
| 749 | ␊ |
| 750 | PAPER_TYPE = a4wide␊ |
| 751 | ␊ |
| 752 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX ␊ |
| 753 | # packages that should be included in the LaTeX output.␊ |
| 754 | ␊ |
| 755 | EXTRA_PACKAGES = ␊ |
| 756 | ␊ |
| 757 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for ␊ |
| 758 | # the generated latex document. The header should contain everything until ␊ |
| 759 | # the first chapter. If it is left blank doxygen will generate a ␊ |
| 760 | # standard header. Notice: only use this tag if you know what you are doing!␊ |
| 761 | ␊ |
| 762 | LATEX_HEADER = ␊ |
| 763 | ␊ |
| 764 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated ␊ |
| 765 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will ␊ |
| 766 | # contain links (just like the HTML output) instead of page references ␊ |
| 767 | # This makes the output suitable for online browsing using a pdf viewer.␊ |
| 768 | ␊ |
| 769 | PDF_HYPERLINKS = NO␊ |
| 770 | ␊ |
| 771 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of ␊ |
| 772 | # plain latex in the generated Makefile. Set this option to YES to get a ␊ |
| 773 | # higher quality PDF documentation.␊ |
| 774 | ␊ |
| 775 | USE_PDFLATEX = NO␊ |
| 776 | ␊ |
| 777 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. ␊ |
| 778 | # command to the generated LaTeX files. This will instruct LaTeX to keep ␊ |
| 779 | # running if errors occur, instead of asking the user for help. ␊ |
| 780 | # This option is also used when generating formulas in HTML.␊ |
| 781 | ␊ |
| 782 | LATEX_BATCHMODE = NO␊ |
| 783 | ␊ |
| 784 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not ␊ |
| 785 | # include the index chapters (such as File Index, Compound Index, etc.) ␊ |
| 786 | # in the output.␊ |
| 787 | ␊ |
| 788 | LATEX_HIDE_INDICES = NO␊ |
| 789 | ␊ |
| 790 | #---------------------------------------------------------------------------␊ |
| 791 | # configuration options related to the RTF output␊ |
| 792 | #---------------------------------------------------------------------------␊ |
| 793 | ␊ |
| 794 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output ␊ |
| 795 | # The RTF output is optimized for Word 97 and may not look very pretty with ␊ |
| 796 | # other RTF readers or editors.␊ |
| 797 | ␊ |
| 798 | GENERATE_RTF = NO␊ |
| 799 | ␊ |
| 800 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. ␊ |
| 801 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be ␊ |
| 802 | # put in front of it. If left blank `rtf' will be used as the default path.␊ |
| 803 | ␊ |
| 804 | RTF_OUTPUT = rtf␊ |
| 805 | ␊ |
| 806 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact ␊ |
| 807 | # RTF documents. This may be useful for small projects and may help to ␊ |
| 808 | # save some trees in general.␊ |
| 809 | ␊ |
| 810 | COMPACT_RTF = NO␊ |
| 811 | ␊ |
| 812 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated ␊ |
| 813 | # will contain hyperlink fields. The RTF file will ␊ |
| 814 | # contain links (just like the HTML output) instead of page references. ␊ |
| 815 | # This makes the output suitable for online browsing using WORD or other ␊ |
| 816 | # programs which support those fields. ␊ |
| 817 | # Note: wordpad (write) and others do not support links.␊ |
| 818 | ␊ |
| 819 | RTF_HYPERLINKS = NO␊ |
| 820 | ␊ |
| 821 | # Load stylesheet definitions from file. Syntax is similar to doxygen's ␊ |
| 822 | # config file, i.e. a series of assignments. You only have to provide ␊ |
| 823 | # replacements, missing definitions are set to their default value.␊ |
| 824 | ␊ |
| 825 | RTF_STYLESHEET_FILE = ␊ |
| 826 | ␊ |
| 827 | # Set optional variables used in the generation of an rtf document. ␊ |
| 828 | # Syntax is similar to doxygen's config file.␊ |
| 829 | ␊ |
| 830 | RTF_EXTENSIONS_FILE = ␊ |
| 831 | ␊ |
| 832 | #---------------------------------------------------------------------------␊ |
| 833 | # configuration options related to the man page output␊ |
| 834 | #---------------------------------------------------------------------------␊ |
| 835 | ␊ |
| 836 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will ␊ |
| 837 | # generate man pages␊ |
| 838 | ␊ |
| 839 | GENERATE_MAN = NO␊ |
| 840 | ␊ |
| 841 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. ␊ |
| 842 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be ␊ |
| 843 | # put in front of it. If left blank `man' will be used as the default path.␊ |
| 844 | ␊ |
| 845 | MAN_OUTPUT = man␊ |
| 846 | ␊ |
| 847 | # The MAN_EXTENSION tag determines the extension that is added to ␊ |
| 848 | # the generated man pages (default is the subroutine's section .3)␊ |
| 849 | ␊ |
| 850 | MAN_EXTENSION = .3␊ |
| 851 | ␊ |
| 852 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output, ␊ |
| 853 | # then it will generate one additional man file for each entity ␊ |
| 854 | # documented in the real man page(s). These additional files ␊ |
| 855 | # only source the real man page, but without them the man command ␊ |
| 856 | # would be unable to find the correct page. The default is NO.␊ |
| 857 | ␊ |
| 858 | MAN_LINKS = NO␊ |
| 859 | ␊ |
| 860 | #---------------------------------------------------------------------------␊ |
| 861 | # configuration options related to the XML output␊ |
| 862 | #---------------------------------------------------------------------------␊ |
| 863 | ␊ |
| 864 | # If the GENERATE_XML tag is set to YES Doxygen will ␊ |
| 865 | # generate an XML file that captures the structure of ␊ |
| 866 | # the code including all documentation.␊ |
| 867 | ␊ |
| 868 | GENERATE_XML = NO␊ |
| 869 | ␊ |
| 870 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. ␊ |
| 871 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be ␊ |
| 872 | # put in front of it. If left blank `xml' will be used as the default path.␊ |
| 873 | ␊ |
| 874 | XML_OUTPUT = xml␊ |
| 875 | ␊ |
| 876 | # The XML_SCHEMA tag can be used to specify an XML schema, ␊ |
| 877 | # which can be used by a validating XML parser to check the ␊ |
| 878 | # syntax of the XML files.␊ |
| 879 | ␊ |
| 880 | XML_SCHEMA = ␊ |
| 881 | ␊ |
| 882 | # The XML_DTD tag can be used to specify an XML DTD, ␊ |
| 883 | # which can be used by a validating XML parser to check the ␊ |
| 884 | # syntax of the XML files.␊ |
| 885 | ␊ |
| 886 | XML_DTD = ␊ |
| 887 | ␊ |
| 888 | # If the XML_PROGRAMLISTING tag is set to YES Doxygen will ␊ |
| 889 | # dump the program listings (including syntax highlighting ␊ |
| 890 | # and cross-referencing information) to the XML output. Note that ␊ |
| 891 | # enabling this will significantly increase the size of the XML output.␊ |
| 892 | ␊ |
| 893 | XML_PROGRAMLISTING = YES␊ |
| 894 | ␊ |
| 895 | #---------------------------------------------------------------------------␊ |
| 896 | # configuration options for the AutoGen Definitions output␊ |
| 897 | #---------------------------------------------------------------------------␊ |
| 898 | ␊ |
| 899 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will ␊ |
| 900 | # generate an AutoGen Definitions (see autogen.sf.net) file ␊ |
| 901 | # that captures the structure of the code including all ␊ |
| 902 | # documentation. Note that this feature is still experimental ␊ |
| 903 | # and incomplete at the moment.␊ |
| 904 | ␊ |
| 905 | GENERATE_AUTOGEN_DEF = NO␊ |
| 906 | ␊ |
| 907 | #---------------------------------------------------------------------------␊ |
| 908 | # configuration options related to the Perl module output␊ |
| 909 | #---------------------------------------------------------------------------␊ |
| 910 | ␊ |
| 911 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will ␊ |
| 912 | # generate a Perl module file that captures the structure of ␊ |
| 913 | # the code including all documentation. Note that this ␊ |
| 914 | # feature is still experimental and incomplete at the ␊ |
| 915 | # moment.␊ |
| 916 | ␊ |
| 917 | GENERATE_PERLMOD = NO␊ |
| 918 | ␊ |
| 919 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate ␊ |
| 920 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able ␊ |
| 921 | # to generate PDF and DVI output from the Perl module output.␊ |
| 922 | ␊ |
| 923 | PERLMOD_LATEX = NO␊ |
| 924 | ␊ |
| 925 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be ␊ |
| 926 | # nicely formatted so it can be parsed by a human reader. This is useful ␊ |
| 927 | # if you want to understand what is going on. On the other hand, if this ␊ |
| 928 | # tag is set to NO the size of the Perl module output will be much smaller ␊ |
| 929 | # and Perl will parse it just the same.␊ |
| 930 | ␊ |
| 931 | PERLMOD_PRETTY = YES␊ |
| 932 | ␊ |
| 933 | # The names of the make variables in the generated doxyrules.make file ␊ |
| 934 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. ␊ |
| 935 | # This is useful so different doxyrules.make files included by the same ␊ |
| 936 | # Makefile don't overwrite each other's variables.␊ |
| 937 | ␊ |
| 938 | PERLMOD_MAKEVAR_PREFIX = ␊ |
| 939 | ␊ |
| 940 | #---------------------------------------------------------------------------␊ |
| 941 | # Configuration options related to the preprocessor ␊ |
| 942 | #---------------------------------------------------------------------------␊ |
| 943 | ␊ |
| 944 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will ␊ |
| 945 | # evaluate all C-preprocessor directives found in the sources and include ␊ |
| 946 | # files.␊ |
| 947 | ␊ |
| 948 | ENABLE_PREPROCESSING = YES␊ |
| 949 | ␊ |
| 950 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro ␊ |
| 951 | # names in the source code. If set to NO (the default) only conditional ␊ |
| 952 | # compilation will be performed. Macro expansion can be done in a controlled ␊ |
| 953 | # way by setting EXPAND_ONLY_PREDEF to YES.␊ |
| 954 | ␊ |
| 955 | MACRO_EXPANSION = NO␊ |
| 956 | ␊ |
| 957 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES ␊ |
| 958 | # then the macro expansion is limited to the macros specified with the ␊ |
| 959 | # PREDEFINED and EXPAND_AS_PREDEFINED tags.␊ |
| 960 | ␊ |
| 961 | EXPAND_ONLY_PREDEF = NO␊ |
| 962 | ␊ |
| 963 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files ␊ |
| 964 | # in the INCLUDE_PATH (see below) will be search if a #include is found.␊ |
| 965 | ␊ |
| 966 | SEARCH_INCLUDES = YES␊ |
| 967 | ␊ |
| 968 | # The INCLUDE_PATH tag can be used to specify one or more directories that ␊ |
| 969 | # contain include files that are not input files but should be processed by ␊ |
| 970 | # the preprocessor.␊ |
| 971 | ␊ |
| 972 | INCLUDE_PATH = ␊ |
| 973 | ␊ |
| 974 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard ␊ |
| 975 | # patterns (like *.h and *.hpp) to filter out the header-files in the ␊ |
| 976 | # directories. If left blank, the patterns specified with FILE_PATTERNS will ␊ |
| 977 | # be used.␊ |
| 978 | ␊ |
| 979 | INCLUDE_FILE_PATTERNS = ␊ |
| 980 | ␊ |
| 981 | # The PREDEFINED tag can be used to specify one or more macro names that ␊ |
| 982 | # are defined before the preprocessor is started (similar to the -D option of ␊ |
| 983 | # gcc). The argument of the tag is a list of macros of the form: name ␊ |
| 984 | # or name=definition (no spaces). If the definition and the = are ␊ |
| 985 | # omitted =1 is assumed. To prevent a macro definition from being ␊ |
| 986 | # undefined via #undef or recursively expanded use the := operator ␊ |
| 987 | # instead of the = operator.␊ |
| 988 | ␊ |
| 989 | PREDEFINED = ␊ |
| 990 | ␊ |
| 991 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then ␊ |
| 992 | # this tag can be used to specify a list of macro names that should be expanded. ␊ |
| 993 | # The macro definition that is found in the sources will be used. ␊ |
| 994 | # Use the PREDEFINED tag if you want to use a different macro definition.␊ |
| 995 | ␊ |
| 996 | EXPAND_AS_DEFINED = ␊ |
| 997 | ␊ |
| 998 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then ␊ |
| 999 | # doxygen's preprocessor will remove all function-like macros that are alone ␊ |
| 1000 | # on a line, have an all uppercase name, and do not end with a semicolon. Such ␊ |
| 1001 | # function macros are typically used for boiler-plate code, and will confuse ␊ |
| 1002 | # the parser if not removed.␊ |
| 1003 | ␊ |
| 1004 | SKIP_FUNCTION_MACROS = YES␊ |
| 1005 | ␊ |
| 1006 | #---------------------------------------------------------------------------␊ |
| 1007 | # Configuration::additions related to external references ␊ |
| 1008 | #---------------------------------------------------------------------------␊ |
| 1009 | ␊ |
| 1010 | # The TAGFILES option can be used to specify one or more tagfiles. ␊ |
| 1011 | # Optionally an initial location of the external documentation ␊ |
| 1012 | # can be added for each tagfile. The format of a tag file without ␊ |
| 1013 | # this location is as follows: ␊ |
| 1014 | # TAGFILES = file1 file2 ... ␊ |
| 1015 | # Adding location for the tag files is done as follows: ␊ |
| 1016 | # TAGFILES = file1=loc1 "file2 = loc2" ... ␊ |
| 1017 | # where "loc1" and "loc2" can be relative or absolute paths or ␊ |
| 1018 | # URLs. If a location is present for each tag, the installdox tool ␊ |
| 1019 | # does not have to be run to correct the links.␊ |
| 1020 | # Note that each tag file must have a unique name␊ |
| 1021 | # (where the name does NOT include the path)␊ |
| 1022 | # If a tag file is not located in the directory in which doxygen ␊ |
| 1023 | # is run, you must also specify the path to the tagfile here.␊ |
| 1024 | ␊ |
| 1025 | TAGFILES = ␊ |
| 1026 | ␊ |
| 1027 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create ␊ |
| 1028 | # a tag file that is based on the input files it reads.␊ |
| 1029 | ␊ |
| 1030 | GENERATE_TAGFILE = ␊ |
| 1031 | ␊ |
| 1032 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed ␊ |
| 1033 | # in the class index. If set to NO only the inherited external classes ␊ |
| 1034 | # will be listed.␊ |
| 1035 | ␊ |
| 1036 | ALLEXTERNALS = NO␊ |
| 1037 | ␊ |
| 1038 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed ␊ |
| 1039 | # in the modules index. If set to NO, only the current project's groups will ␊ |
| 1040 | # be listed.␊ |
| 1041 | ␊ |
| 1042 | EXTERNAL_GROUPS = YES␊ |
| 1043 | ␊ |
| 1044 | # The PERL_PATH should be the absolute path and name of the perl script ␊ |
| 1045 | # interpreter (i.e. the result of `which perl').␊ |
| 1046 | ␊ |
| 1047 | PERL_PATH = /usr/bin/perl␊ |
| 1048 | ␊ |
| 1049 | #---------------------------------------------------------------------------␊ |
| 1050 | # Configuration options related to the dot tool ␊ |
| 1051 | #---------------------------------------------------------------------------␊ |
| 1052 | ␊ |
| 1053 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will ␊ |
| 1054 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base ␊ |
| 1055 | # or super classes. Setting the tag to NO turns the diagrams off. Note that ␊ |
| 1056 | # this option is superseded by the HAVE_DOT option below. This is only a ␊ |
| 1057 | # fallback. It is recommended to install and use dot, since it yields more ␊ |
| 1058 | # powerful graphs.␊ |
| 1059 | ␊ |
| 1060 | CLASS_DIAGRAMS = YES␊ |
| 1061 | ␊ |
| 1062 | # If set to YES, the inheritance and collaboration graphs will hide ␊ |
| 1063 | # inheritance and usage relations if the target is undocumented ␊ |
| 1064 | # or is not a class.␊ |
| 1065 | ␊ |
| 1066 | HIDE_UNDOC_RELATIONS = YES␊ |
| 1067 | ␊ |
| 1068 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is ␊ |
| 1069 | # available from the path. This tool is part of Graphviz, a graph visualization ␊ |
| 1070 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section ␊ |
| 1071 | # have no effect if this option is set to NO (the default)␊ |
| 1072 | ␊ |
| 1073 | HAVE_DOT = YES␊ |
| 1074 | ␊ |
| 1075 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen ␊ |
| 1076 | # will generate a graph for each documented class showing the direct and ␊ |
| 1077 | # indirect inheritance relations. Setting this tag to YES will force the ␊ |
| 1078 | # the CLASS_DIAGRAMS tag to NO.␊ |
| 1079 | ␊ |
| 1080 | CLASS_GRAPH = YES␊ |
| 1081 | ␊ |
| 1082 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen ␊ |
| 1083 | # will generate a graph for each documented class showing the direct and ␊ |
| 1084 | # indirect implementation dependencies (inheritance, containment, and ␊ |
| 1085 | # class references variables) of the class with other documented classes.␊ |
| 1086 | ␊ |
| 1087 | COLLABORATION_GRAPH = YES␊ |
| 1088 | ␊ |
| 1089 | # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen ␊ |
| 1090 | # will generate a graph for groups, showing the direct groups dependencies␊ |
| 1091 | ␊ |
| 1092 | GROUP_GRAPHS = YES␊ |
| 1093 | ␊ |
| 1094 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and ␊ |
| 1095 | # collaboration diagrams in a style similar to the OMG's Unified Modeling ␊ |
| 1096 | # Language.␊ |
| 1097 | ␊ |
| 1098 | UML_LOOK = NO␊ |
| 1099 | ␊ |
| 1100 | # If set to YES, the inheritance and collaboration graphs will show the ␊ |
| 1101 | # relations between templates and their instances.␊ |
| 1102 | ␊ |
| 1103 | TEMPLATE_RELATIONS = NO␊ |
| 1104 | ␊ |
| 1105 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT ␊ |
| 1106 | # tags are set to YES then doxygen will generate a graph for each documented ␊ |
| 1107 | # file showing the direct and indirect include dependencies of the file with ␊ |
| 1108 | # other documented files.␊ |
| 1109 | ␊ |
| 1110 | INCLUDE_GRAPH = YES␊ |
| 1111 | ␊ |
| 1112 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and ␊ |
| 1113 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each ␊ |
| 1114 | # documented header file showing the documented files that directly or ␊ |
| 1115 | # indirectly include this file.␊ |
| 1116 | ␊ |
| 1117 | INCLUDED_BY_GRAPH = YES␊ |
| 1118 | ␊ |
| 1119 | # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will ␊ |
| 1120 | # generate a call dependency graph for every global function or class method. ␊ |
| 1121 | # Note that enabling this option will significantly increase the time of a run. ␊ |
| 1122 | # So in most cases it will be better to enable call graphs for selected ␊ |
| 1123 | # functions only using the \callgraph command.␊ |
| 1124 | ␊ |
| 1125 | CALL_GRAPH = NO␊ |
| 1126 | ␊ |
| 1127 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen ␊ |
| 1128 | # will graphical hierarchy of all classes instead of a textual one.␊ |
| 1129 | ␊ |
| 1130 | GRAPHICAL_HIERARCHY = YES␊ |
| 1131 | ␊ |
| 1132 | # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES ␊ |
| 1133 | # then doxygen will show the dependencies a directory has on other directories ␊ |
| 1134 | # in a graphical way. The dependency relations are determined by the #include␊ |
| 1135 | # relations between the files in the directories.␊ |
| 1136 | ␊ |
| 1137 | DIRECTORY_GRAPH = YES␊ |
| 1138 | ␊ |
| 1139 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images ␊ |
| 1140 | # generated by dot. Possible values are png, jpg, or gif␊ |
| 1141 | # If left blank png will be used.␊ |
| 1142 | ␊ |
| 1143 | DOT_IMAGE_FORMAT = png␊ |
| 1144 | ␊ |
| 1145 | # The tag DOT_PATH can be used to specify the path where the dot tool can be ␊ |
| 1146 | # found. If left blank, it is assumed the dot tool can be found in the path.␊ |
| 1147 | ␊ |
| 1148 | DOT_PATH = ␊ |
| 1149 | ␊ |
| 1150 | # The DOTFILE_DIRS tag can be used to specify one or more directories that ␊ |
| 1151 | # contain dot files that are included in the documentation (see the ␊ |
| 1152 | # \dotfile command).␊ |
| 1153 | ␊ |
| 1154 | DOTFILE_DIRS = ␊ |
| 1155 | ␊ |
| 1156 | # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width ␊ |
| 1157 | # (in pixels) of the graphs generated by dot. If a graph becomes larger than ␊ |
| 1158 | # this value, doxygen will try to truncate the graph, so that it fits within ␊ |
| 1159 | # the specified constraint. Beware that most browsers cannot cope with very ␊ |
| 1160 | # large images.␊ |
| 1161 | ␊ |
| 1162 | MAX_DOT_GRAPH_WIDTH = 1024␊ |
| 1163 | ␊ |
| 1164 | # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height ␊ |
| 1165 | # (in pixels) of the graphs generated by dot. If a graph becomes larger than ␊ |
| 1166 | # this value, doxygen will try to truncate the graph, so that it fits within ␊ |
| 1167 | # the specified constraint. Beware that most browsers cannot cope with very ␊ |
| 1168 | # large images.␊ |
| 1169 | ␊ |
| 1170 | MAX_DOT_GRAPH_HEIGHT = 1024␊ |
| 1171 | ␊ |
| 1172 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the ␊ |
| 1173 | # graphs generated by dot. A depth value of 3 means that only nodes reachable ␊ |
| 1174 | # from the root by following a path via at most 3 edges will be shown. Nodes ␊ |
| 1175 | # that lay further from the root node will be omitted. Note that setting this ␊ |
| 1176 | # option to 1 or 2 may greatly reduce the computation time needed for large ␊ |
| 1177 | # code bases. Also note that a graph may be further truncated if the graph's ␊ |
| 1178 | # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH ␊ |
| 1179 | # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), ␊ |
| 1180 | # the graph is not depth-constrained.␊ |
| 1181 | ␊ |
| 1182 | MAX_DOT_GRAPH_DEPTH = 0␊ |
| 1183 | ␊ |
| 1184 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent ␊ |
| 1185 | # background. This is disabled by default, which results in a white background. ␊ |
| 1186 | # Warning: Depending on the platform used, enabling this option may lead to ␊ |
| 1187 | # badly anti-aliased labels on the edges of a graph (i.e. they become hard to ␊ |
| 1188 | # read).␊ |
| 1189 | ␊ |
| 1190 | DOT_TRANSPARENT = NO␊ |
| 1191 | ␊ |
| 1192 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output ␊ |
| 1193 | # files in one run (i.e. multiple -o and -T options on the command line). This ␊ |
| 1194 | # makes dot run faster, but since only newer versions of dot (>1.8.10) ␊ |
| 1195 | # support this, this feature is disabled by default.␊ |
| 1196 | ␊ |
| 1197 | DOT_MULTI_TARGETS = NO␊ |
| 1198 | ␊ |
| 1199 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will ␊ |
| 1200 | # generate a legend page explaining the meaning of the various boxes and ␊ |
| 1201 | # arrows in the dot generated graphs.␊ |
| 1202 | ␊ |
| 1203 | GENERATE_LEGEND = YES␊ |
| 1204 | ␊ |
| 1205 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will ␊ |
| 1206 | # remove the intermediate dot files that are used to generate ␊ |
| 1207 | # the various graphs.␊ |
| 1208 | ␊ |
| 1209 | DOT_CLEANUP = YES␊ |
| 1210 | ␊ |
| 1211 | #---------------------------------------------------------------------------␊ |
| 1212 | # Configuration::additions related to the search engine ␊ |
| 1213 | #---------------------------------------------------------------------------␊ |
| 1214 | ␊ |
| 1215 | # The SEARCHENGINE tag specifies whether or not a search engine should be ␊ |
| 1216 | # used. If set to NO the values of all tags below this one will be ignored.␊ |
| 1217 | ␊ |
| 1218 | SEARCHENGINE = NO␊ |
