ia64/xen-unstable

annotate docs/Doxyfile @ 9488:0a6f5527ca4b

[IA64] set itv handoff as masked and enable reading irr[0-3]

Set initial vcpu itv handoff state to mask the timer vector.
This seems to match hardware and makes logical sense from a
spurious interrupt perspective. Enable vcpu_get_irr[0-3]
functions as they seem to work and have the proper backing.
This enables the check_sal_cache_flush() in arch/ia64/kernel.sal.c
to work unmodified, allowing us to remove the Xen changes from
the file (and thus the file from the sparse tree).

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