Warning, /graphics/libkexiv2/src/Doxyfile is written in an unsupported language. File is not indexed.
0001 # Doxyfile 1.3.5
0002
0003 # This file describes the settings to be used by the documentation system
0004 # doxygen (www.doxygen.org) for a project
0005 #
0006 # All text after a hash (#) is considered a comment and will be ignored
0007 # The format is:
0008 # TAG = value [value, ...]
0009 # For lists items can also be appended using:
0010 # TAG += value [value, ...]
0011 # Values that contain spaces should be placed between quotes (" ")
0012
0013 #---------------------------------------------------------------------------
0014 # Project related configuration options
0015 #---------------------------------------------------------------------------
0016
0017 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
0018 # by quotes) that should identify the project.
0019
0020 PROJECT_NAME = libKExiv2
0021
0022 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
0023 # This could be handy for archiving the generated documentation or
0024 # if some version control system is used.
0025
0026 PROJECT_NUMBER =
0027
0028 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
0029 # base path where the generated documentation will be put.
0030 # If a relative path is entered, it will be relative to the location
0031 # where doxygen was started. If left blank the current directory will be used.
0032
0033 OUTPUT_DIRECTORY =
0034
0035 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
0036 # documentation generated by doxygen is written. Doxygen will use this
0037 # information to generate all constant output in the proper language.
0038 # The default language is English, other supported languages are:
0039 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
0040 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
0041 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
0042 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
0043
0044 OUTPUT_LANGUAGE = English
0045
0046 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
0047 # include brief member descriptions after the members that are listed in
0048 # the file and class documentation (similar to JavaDoc).
0049 # Set to NO to disable this.
0050
0051 BRIEF_MEMBER_DESC = YES
0052
0053 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
0054 # the brief description of a member or function before the detailed description.
0055 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
0056 # brief descriptions will be completely suppressed.
0057
0058 REPEAT_BRIEF = YES
0059
0060 # This tag implements a quasi-intelligent brief description abbreviator
0061 # that is used to form the text in various listings. Each string
0062 # in this list, if found as the leading text of the brief description, will be
0063 # stripped from the text and the result after processing the whole list, is used
0064 # as the annotated text. Otherwise, the brief description is used as-is. If left
0065 # blank, the following values are used ("$name" is automatically replaced with the
0066 # name of the entity): "The $name class" "The $name widget" "The $name file"
0067 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
0068
0069 ABBREVIATE_BRIEF =
0070
0071 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
0072 # Doxygen will generate a detailed section even if there is only a brief
0073 # description.
0074
0075 ALWAYS_DETAILED_SEC = NO
0076
0077 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
0078 # members of a class in the documentation of that class as if those members were
0079 # ordinary class members. Constructors, destructors and assignment operators of
0080 # the base classes will not be shown.
0081
0082 INLINE_INHERITED_MEMB = NO
0083
0084 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
0085 # path before files name in the file list and in the header files. If set
0086 # to NO the shortest path that makes the file name unique will be used.
0087
0088 FULL_PATH_NAMES = NO
0089
0090 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
0091 # can be used to strip a user-defined part of the path. Stripping is
0092 # only done if one of the specified strings matches the left-hand part of
0093 # the path. It is allowed to use relative paths in the argument list.
0094
0095 STRIP_FROM_PATH =
0096
0097 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
0098 # (but less readable) file names. This can be useful is your file systems
0099 # doesn't support long names like on DOS, Mac, or CD-ROM.
0100
0101 SHORT_NAMES = NO
0102
0103 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
0104 # will interpret the first line (until the first dot) of a JavaDoc-style
0105 # comment as the brief description. If set to NO, the JavaDoc
0106 # comments will behave just like the Qt-style comments (thus requiring an
0107 # explicit @brief command for a brief description.
0108
0109 JAVADOC_AUTOBRIEF = NO
0110
0111 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
0112 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
0113 # comments) as a brief description. This used to be the default behaviour.
0114 # The new default is to treat a multi-line C++ comment block as a detailed
0115 # description. Set this tag to YES if you prefer the old behaviour instead.
0116
0117 MULTILINE_CPP_IS_BRIEF = NO
0118
0119 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
0120 # member inherits the documentation from any documented member that it
0121 # re-implements.
0122
0123 INHERIT_DOCS = YES
0124
0125 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
0126 # tag is set to YES, then doxygen will reuse the documentation of the first
0127 # member in the group (if any) for the other members of the group. By default
0128 # all members of a group must be documented explicitly.
0129
0130 DISTRIBUTE_GROUP_DOC = NO
0131
0132 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
0133 # Doxygen uses this value to replace tabs by spaces in code fragments.
0134
0135 TAB_SIZE = 8
0136
0137 # This tag can be used to specify a number of aliases that acts
0138 # as commands in the documentation. An alias has the form "name=value".
0139 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
0140 # put the command \sideeffect (or @sideeffect) in the documentation, which
0141 # will result in a user-defined paragraph with heading "Side Effects:".
0142 # You can put \n's in the value part of an alias to insert newlines.
0143
0144 ALIASES =
0145
0146 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
0147 # only. Doxygen will then generate output that is more tailored for C.
0148 # For instance, some of the names that are used will be different. The list
0149 # of all members will be omitted, etc.
0150
0151 OPTIMIZE_OUTPUT_FOR_C = NO
0152
0153 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
0154 # only. Doxygen will then generate output that is more tailored for Java.
0155 # For instance, namespaces will be presented as packages, qualified scopes
0156 # will look different, etc.
0157
0158 OPTIMIZE_OUTPUT_JAVA = NO
0159
0160 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
0161 # the same type (for instance a group of public functions) to be put as a
0162 # subgroup of that type (e.g. under the Public Functions section). Set it to
0163 # NO to prevent subgrouping. Alternatively, this can be done per class using
0164 # the \nosubgrouping command.
0165
0166 SUBGROUPING = YES
0167
0168 #---------------------------------------------------------------------------
0169 # Build related configuration options
0170 #---------------------------------------------------------------------------
0171
0172 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
0173 # documentation are documented, even if no documentation was available.
0174 # Private class members and static file members will be hidden unless
0175 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
0176
0177 EXTRACT_ALL = YES
0178
0179 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
0180 # will be included in the documentation.
0181
0182 EXTRACT_PRIVATE = NO
0183
0184 # If the EXTRACT_STATIC tag is set to YES all static members of a file
0185 # will be included in the documentation.
0186
0187 EXTRACT_STATIC = NO
0188
0189 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
0190 # defined locally in source files will be included in the documentation.
0191 # If set to NO only classes defined in header files are included.
0192
0193 EXTRACT_LOCAL_CLASSES = YES
0194
0195 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
0196 # undocumented members of documented classes, files or namespaces.
0197 # If set to NO (the default) these members will be included in the
0198 # various overviews, but no documentation section is generated.
0199 # This option has no effect if EXTRACT_ALL is enabled.
0200
0201 HIDE_UNDOC_MEMBERS = NO
0202
0203 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
0204 # undocumented classes that are normally visible in the class hierarchy.
0205 # If set to NO (the default) these classes will be included in the various
0206 # overviews. This option has no effect if EXTRACT_ALL is enabled.
0207
0208 HIDE_UNDOC_CLASSES = NO
0209
0210 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
0211 # friend (class|struct|union) declarations.
0212 # If set to NO (the default) these declarations will be included in the
0213 # documentation.
0214
0215 HIDE_FRIEND_COMPOUNDS = NO
0216
0217 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
0218 # documentation blocks found inside the body of a function.
0219 # If set to NO (the default) these blocks will be appended to the
0220 # function's detailed documentation block.
0221
0222 HIDE_IN_BODY_DOCS = NO
0223
0224 # The INTERNAL_DOCS tag determines if documentation
0225 # that is typed after a \internal command is included. If the tag is set
0226 # to NO (the default) then the documentation will be excluded.
0227 # Set it to YES to include the internal documentation.
0228
0229 INTERNAL_DOCS = NO
0230
0231 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
0232 # file names in lower-case letters. If set to YES upper-case letters are also
0233 # allowed. This is useful if you have classes or files whose names only differ
0234 # in case and if your file system supports case sensitive file names. Windows
0235 # users are advised to set this option to NO.
0236
0237 CASE_SENSE_NAMES = YES
0238
0239 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
0240 # will show members with their full class and namespace scopes in the
0241 # documentation. If set to YES the scope will be hidden.
0242
0243 HIDE_SCOPE_NAMES = NO
0244
0245 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
0246 # will put a list of the files that are included by a file in the documentation
0247 # of that file.
0248
0249 SHOW_INCLUDE_FILES = YES
0250
0251 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
0252 # is inserted in the documentation for inline members.
0253
0254 INLINE_INFO = YES
0255
0256 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
0257 # will sort the (detailed) documentation of file and class members
0258 # alphabetically by member name. If set to NO the members will appear in
0259 # declaration order.
0260
0261 SORT_MEMBER_DOCS = YES
0262
0263 # The GENERATE_TODOLIST tag can be used to enable (YES) or
0264 # disable (NO) the todo list. This list is created by putting \todo
0265 # commands in the documentation.
0266
0267 GENERATE_TODOLIST = NO
0268
0269 # The GENERATE_TESTLIST tag can be used to enable (YES) or
0270 # disable (NO) the test list. This list is created by putting \test
0271 # commands in the documentation.
0272
0273 GENERATE_TESTLIST = YES
0274
0275 # The GENERATE_BUGLIST tag can be used to enable (YES) or
0276 # disable (NO) the bug list. This list is created by putting \bug
0277 # commands in the documentation.
0278
0279 GENERATE_BUGLIST = YES
0280
0281 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
0282 # disable (NO) the deprecated list. This list is created by putting
0283 # \deprecated commands in the documentation.
0284
0285 GENERATE_DEPRECATEDLIST= YES
0286
0287 # The ENABLED_SECTIONS tag can be used to enable conditional
0288 # documentation sections, marked by \if sectionname ... \endif.
0289
0290 ENABLED_SECTIONS =
0291
0292 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
0293 # the initial value of a variable or define consists of for it to appear in
0294 # the documentation. If the initializer consists of more lines than specified
0295 # here it will be hidden. Use a value of 0 to hide initializers completely.
0296 # The appearance of the initializer of individual variables and defines in the
0297 # documentation can be controlled using \showinitializer or \hideinitializer
0298 # command in the documentation regardless of this setting.
0299
0300 MAX_INITIALIZER_LINES = 30
0301
0302 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
0303 # at the bottom of the documentation of classes and structs. If set to YES the
0304 # list will mention the files that were used to generate the documentation.
0305
0306 SHOW_USED_FILES = YES
0307
0308 #---------------------------------------------------------------------------
0309 # configuration options related to warning and progress messages
0310 #---------------------------------------------------------------------------
0311
0312 # The QUIET tag can be used to turn on/off the messages that are generated
0313 # by doxygen. Possible values are YES and NO. If left blank NO is used.
0314
0315 QUIET = YES
0316
0317 # The WARNINGS tag can be used to turn on/off the warning messages that are
0318 # generated by doxygen. Possible values are YES and NO. If left blank
0319 # NO is used.
0320
0321 WARNINGS = YES
0322
0323 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
0324 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
0325 # automatically be disabled.
0326
0327 WARN_IF_UNDOCUMENTED = NO
0328
0329 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
0330 # potential errors in the documentation, such as not documenting some
0331 # parameters in a documented function, or documenting parameters that
0332 # don't exist or using markup commands wrongly.
0333
0334 WARN_IF_DOC_ERROR = YES
0335
0336 # The WARN_FORMAT tag determines the format of the warning messages that
0337 # doxygen can produce. The string should contain the $file, $line, and $text
0338 # tags, which will be replaced by the file and line number from which the
0339 # warning originated and the warning text.
0340
0341 WARN_FORMAT = "$file:$line: $text"
0342
0343 # The WARN_LOGFILE tag can be used to specify a file to which warning
0344 # and error messages should be written. If left blank the output is written
0345 # to stderr.
0346
0347 WARN_LOGFILE =
0348
0349 #---------------------------------------------------------------------------
0350 # configuration options related to the input files
0351 #---------------------------------------------------------------------------
0352
0353 # The INPUT tag can be used to specify the files and/or directories that contain
0354 # documented source files. You may enter file names like "myfile.cpp" or
0355 # directories like "/usr/src/myproject". Separate the files or directories
0356 # with spaces.
0357
0358 INPUT = ./
0359 INPUT += ./Mainpage.dox
0360
0361 # If the value of the INPUT tag contains directories, you can use the
0362 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
0363 # and *.h) to filter out the source-files in the directories. If left
0364 # blank the following patterns are tested:
0365 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
0366 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
0367
0368 FILE_PATTERNS = *.cpp \
0369 *.h
0370
0371 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
0372 # should be searched for input files as well. Possible values are YES and NO.
0373 # If left blank NO is used.
0374
0375 RECURSIVE = NO
0376
0377 # The EXCLUDE tag can be used to specify files and/or directories that should
0378 # excluded from the INPUT source files. This way you can easily exclude a
0379 # subdirectory from a directory tree whose root is specified with the INPUT tag.
0380
0381 EXCLUDE =
0382
0383 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
0384 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
0385
0386 EXCLUDE_SYMLINKS = NO
0387
0388 # If the value of the INPUT tag contains directories, you can use the
0389 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
0390 # certain files from those directories.
0391
0392 EXCLUDE_PATTERNS =
0393
0394 # The EXAMPLE_PATH tag can be used to specify one or more files or
0395 # directories that contain example code fragments that are included (see
0396 # the \include command).
0397
0398 EXAMPLE_PATH =
0399
0400 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
0401 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
0402 # and *.h) to filter out the source-files in the directories. If left
0403 # blank all files are included.
0404
0405 EXAMPLE_PATTERNS =
0406
0407 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
0408 # searched for input files to be used with the \include or \dontinclude
0409 # commands irrespective of the value of the RECURSIVE tag.
0410 # Possible values are YES and NO. If left blank NO is used.
0411
0412 EXAMPLE_RECURSIVE = NO
0413
0414 # The IMAGE_PATH tag can be used to specify one or more files or
0415 # directories that contain image that are included in the documentation (see
0416 # the \image command).
0417
0418 IMAGE_PATH =
0419
0420 # The INPUT_FILTER tag can be used to specify a program that doxygen should
0421 # invoke to filter for each input file. Doxygen will invoke the filter program
0422 # by executing (via popen()) the command <filter> <input-file>, where <filter>
0423 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
0424 # input file. Doxygen will then use the output that the filter program writes
0425 # to standard output.
0426
0427 INPUT_FILTER =
0428
0429 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
0430 # INPUT_FILTER) will be used to filter the input files when producing source
0431 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
0432
0433 FILTER_SOURCE_FILES = NO
0434
0435 #---------------------------------------------------------------------------
0436 # configuration options related to source browsing
0437 #---------------------------------------------------------------------------
0438
0439 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
0440 # be generated. Documented entities will be cross-referenced with these sources.
0441 # Note: To get rid of all source code in the generated output, make sure also
0442 # VERBATIM_HEADERS is set to NO.
0443
0444 SOURCE_BROWSER = NO
0445
0446 # Setting the INLINE_SOURCES tag to YES will include the body
0447 # of functions and classes directly in the documentation.
0448
0449 INLINE_SOURCES = NO
0450
0451 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
0452 # doxygen to hide any special comment blocks from generated source code
0453 # fragments. Normal C and C++ comments will always remain visible.
0454
0455 STRIP_CODE_COMMENTS = YES
0456
0457 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
0458 # then for each documented function all documented
0459 # functions referencing it will be listed.
0460
0461 REFERENCED_BY_RELATION = YES
0462
0463 # If the REFERENCES_RELATION tag is set to YES (the default)
0464 # then for each documented function all documented entities
0465 # called/used by that function will be listed.
0466
0467 REFERENCES_RELATION = YES
0468
0469 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
0470 # will generate a verbatim copy of the header file for each class for
0471 # which an include is specified. Set to NO to disable this.
0472
0473 VERBATIM_HEADERS = YES
0474
0475 #---------------------------------------------------------------------------
0476 # configuration options related to the alphabetical class index
0477 #---------------------------------------------------------------------------
0478
0479 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
0480 # of all compounds will be generated. Enable this if the project
0481 # contains a lot of classes, structs, unions or interfaces.
0482
0483 ALPHABETICAL_INDEX = NO
0484
0485 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
0486 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
0487 # in which this list will be split (can be a number in the range [1..20])
0488
0489 COLS_IN_ALPHA_INDEX = 5
0490
0491 # In case all classes in a project start with a common prefix, all
0492 # classes will be put under the same header in the alphabetical index.
0493 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
0494 # should be ignored while generating the index headers.
0495
0496 IGNORE_PREFIX =
0497
0498 #---------------------------------------------------------------------------
0499 # configuration options related to the HTML output
0500 #---------------------------------------------------------------------------
0501
0502 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
0503 # generate HTML output.
0504
0505 GENERATE_HTML = YES
0506
0507 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
0508 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0509 # put in front of it. If left blank `html' will be used as the default path.
0510
0511 HTML_OUTPUT = html
0512
0513 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
0514 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
0515 # doxygen will generate files with .html extension.
0516
0517 HTML_FILE_EXTENSION = .html
0518
0519 # The HTML_HEADER tag can be used to specify a personal HTML header for
0520 # each generated HTML page. If it is left blank doxygen will generate a
0521 # standard header.
0522
0523 HTML_HEADER =
0524
0525 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
0526 # each generated HTML page. If it is left blank doxygen will generate a
0527 # standard footer.
0528
0529 HTML_FOOTER =
0530
0531 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
0532 # style sheet that is used by each HTML page. It can be used to
0533 # fine-tune the look of the HTML output. If the tag is left blank doxygen
0534 # will generate a default style sheet. Note that doxygen will try to copy
0535 # the style sheet file to the HTML output directory, so don't put your own
0536 # stylesheet in the HTML output directory as well, or it will be erased!
0537
0538 HTML_STYLESHEET =
0539
0540 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
0541 # files or namespaces will be aligned in HTML using tables. If set to
0542 # NO a bullet list will be used.
0543
0544 HTML_ALIGN_MEMBERS = YES
0545
0546 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
0547 # will be generated that can be used as input for tools like the
0548 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
0549 # of the generated HTML documentation.
0550
0551 GENERATE_HTMLHELP = NO
0552
0553 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
0554 # be used to specify the file name of the resulting .chm file. You
0555 # can add a path in front of the file if the result should not be
0556 # written to the html output directory.
0557
0558 CHM_FILE =
0559
0560 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
0561 # be used to specify the location (absolute path including file name) of
0562 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
0563 # the HTML help compiler on the generated index.hhp.
0564
0565 HHC_LOCATION =
0566
0567 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
0568 # controls if a separate .chi index file is generated (YES) or that
0569 # it should be included in the master .chm file (NO).
0570
0571 GENERATE_CHI = NO
0572
0573 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
0574 # controls whether a binary table of contents is generated (YES) or a
0575 # normal table of contents (NO) in the .chm file.
0576
0577 BINARY_TOC = NO
0578
0579 # The TOC_EXPAND flag can be set to YES to add extra items for group members
0580 # to the contents of the HTML help documentation and to the tree view.
0581
0582 TOC_EXPAND = NO
0583
0584 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
0585 # top of each HTML page. The value NO (the default) enables the index and
0586 # the value YES disables it.
0587
0588 DISABLE_INDEX = NO
0589
0590 # This tag can be used to set the number of enum values (range [1..20])
0591 # that doxygen will group on one line in the generated HTML documentation.
0592
0593 ENUM_VALUES_PER_LINE = 4
0594
0595 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
0596 # generated containing a tree-like index structure (just like the one that
0597 # is generated for HTML Help). For this to work a browser that supports
0598 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
0599 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
0600 # probably better off using the HTML help feature.
0601
0602 GENERATE_TREEVIEW = NO
0603
0604 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
0605 # used to set the initial width (in pixels) of the frame in which the tree
0606 # is shown.
0607
0608 TREEVIEW_WIDTH = 250
0609
0610 #---------------------------------------------------------------------------
0611 # configuration options related to the LaTeX output
0612 #---------------------------------------------------------------------------
0613
0614 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
0615 # generate Latex output.
0616
0617 GENERATE_LATEX = NO
0618
0619 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
0620 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0621 # put in front of it. If left blank `latex' will be used as the default path.
0622
0623 LATEX_OUTPUT = latex
0624
0625 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
0626 # invoked. If left blank `latex' will be used as the default command name.
0627
0628 LATEX_CMD_NAME = latex
0629
0630 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
0631 # generate index for LaTeX. If left blank `makeindex' will be used as the
0632 # default command name.
0633
0634 MAKEINDEX_CMD_NAME = makeindex
0635
0636 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
0637 # LaTeX documents. This may be useful for small projects and may help to
0638 # save some trees in general.
0639
0640 COMPACT_LATEX = NO
0641
0642 # The PAPER_TYPE tag can be used to set the paper type that is used
0643 # by the printer. Possible values are: a4, a4wide, letter, legal and
0644 # executive. If left blank a4wide will be used.
0645
0646 PAPER_TYPE = a4
0647
0648 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
0649 # packages that should be included in the LaTeX output.
0650
0651 EXTRA_PACKAGES =
0652
0653 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
0654 # the generated latex document. The header should contain everything until
0655 # the first chapter. If it is left blank doxygen will generate a
0656 # standard header. Notice: only use this tag if you know what you are doing!
0657
0658 LATEX_HEADER =
0659
0660 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
0661 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
0662 # contain links (just like the HTML output) instead of page references
0663 # This makes the output suitable for online browsing using a pdf viewer.
0664
0665 PDF_HYPERLINKS = NO
0666
0667 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
0668 # plain latex in the generated Makefile. Set this option to YES to get a
0669 # higher quality PDF documentation.
0670
0671 USE_PDFLATEX = YES
0672
0673 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
0674 # command to the generated LaTeX files. This will instruct LaTeX to keep
0675 # running if errors occur, instead of asking the user for help.
0676 # This option is also used when generating formulas in HTML.
0677
0678 LATEX_BATCHMODE = NO
0679
0680 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
0681 # include the index chapters (such as File Index, Compound Index, etc.)
0682 # in the output.
0683
0684 LATEX_HIDE_INDICES = NO
0685
0686 #---------------------------------------------------------------------------
0687 # configuration options related to the RTF output
0688 #---------------------------------------------------------------------------
0689
0690 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
0691 # The RTF output is optimized for Word 97 and may not look very pretty with
0692 # other RTF readers or editors.
0693
0694 GENERATE_RTF = NO
0695
0696 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
0697 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0698 # put in front of it. If left blank `rtf' will be used as the default path.
0699
0700 RTF_OUTPUT = rtf
0701
0702 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
0703 # RTF documents. This may be useful for small projects and may help to
0704 # save some trees in general.
0705
0706 COMPACT_RTF = NO
0707
0708 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
0709 # will contain hyperlink fields. The RTF file will
0710 # contain links (just like the HTML output) instead of page references.
0711 # This makes the output suitable for online browsing using WORD or other
0712 # programs which support those fields.
0713 # Note: wordpad (write) and others do not support links.
0714
0715 RTF_HYPERLINKS = NO
0716
0717 # Load stylesheet definitions from file. Syntax is similar to doxygen's
0718 # config file, i.e. a series of assignments. You only have to provide
0719 # replacements, missing definitions are set to their default value.
0720
0721 RTF_STYLESHEET_FILE =
0722
0723 # Set optional variables used in the generation of an rtf document.
0724 # Syntax is similar to doxygen's config file.
0725
0726 RTF_EXTENSIONS_FILE =
0727
0728 #---------------------------------------------------------------------------
0729 # configuration options related to the man page output
0730 #---------------------------------------------------------------------------
0731
0732 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
0733 # generate man pages
0734
0735 GENERATE_MAN = NO
0736
0737 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
0738 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0739 # put in front of it. If left blank `man' will be used as the default path.
0740
0741 MAN_OUTPUT = man
0742
0743 # The MAN_EXTENSION tag determines the extension that is added to
0744 # the generated man pages (default is the subroutine's section .3)
0745
0746 MAN_EXTENSION = .3
0747
0748 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
0749 # then it will generate one additional man file for each entity
0750 # documented in the real man page(s). These additional files
0751 # only source the real man page, but without them the man command
0752 # would be unable to find the correct page. The default is NO.
0753
0754 MAN_LINKS = NO
0755
0756 #---------------------------------------------------------------------------
0757 # configuration options related to the XML output
0758 #---------------------------------------------------------------------------
0759
0760 # If the GENERATE_XML tag is set to YES Doxygen will
0761 # generate an XML file that captures the structure of
0762 # the code including all documentation.
0763
0764 GENERATE_XML = NO
0765
0766 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
0767 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0768 # put in front of it. If left blank `xml' will be used as the default path.
0769
0770 XML_OUTPUT = xml
0771
0772 # The XML_SCHEMA tag can be used to specify an XML schema,
0773 # which can be used by a validating XML parser to check the
0774 # syntax of the XML files.
0775
0776 XML_SCHEMA =
0777
0778 # The XML_DTD tag can be used to specify an XML DTD,
0779 # which can be used by a validating XML parser to check the
0780 # syntax of the XML files.
0781
0782 XML_DTD =
0783
0784 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
0785 # dump the program listings (including syntax highlighting
0786 # and cross-referencing information) to the XML output. Note that
0787 # enabling this will significantly increase the size of the XML output.
0788
0789 XML_PROGRAMLISTING = YES
0790
0791 #---------------------------------------------------------------------------
0792 # configuration options for the AutoGen Definitions output
0793 #---------------------------------------------------------------------------
0794
0795 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
0796 # generate an AutoGen Definitions (see autogen.sf.net) file
0797 # that captures the structure of the code including all
0798 # documentation. Note that this feature is still experimental
0799 # and incomplete at the moment.
0800
0801 GENERATE_AUTOGEN_DEF = NO
0802
0803 #---------------------------------------------------------------------------
0804 # configuration options related to the Perl module output
0805 #---------------------------------------------------------------------------
0806
0807 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
0808 # generate a Perl module file that captures the structure of
0809 # the code including all documentation. Note that this
0810 # feature is still experimental and incomplete at the
0811 # moment.
0812
0813 GENERATE_PERLMOD = NO
0814
0815 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
0816 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
0817 # to generate PDF and DVI output from the Perl module output.
0818
0819 PERLMOD_LATEX = NO
0820
0821 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
0822 # nicely formatted so it can be parsed by a human reader. This is useful
0823 # if you want to understand what is going on. On the other hand, if this
0824 # tag is set to NO the size of the Perl module output will be much smaller
0825 # and Perl will parse it just the same.
0826
0827 PERLMOD_PRETTY = YES
0828
0829 # The names of the make variables in the generated doxyrules.make file
0830 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
0831 # This is useful so different doxyrules.make files included by the same
0832 # Makefile don't overwrite each other's variables.
0833
0834 PERLMOD_MAKEVAR_PREFIX =
0835
0836 #---------------------------------------------------------------------------
0837 # Configuration options related to the preprocessor
0838 #---------------------------------------------------------------------------
0839
0840 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
0841 # evaluate all C-preprocessor directives found in the sources and include
0842 # files.
0843
0844 ENABLE_PREPROCESSING = YES
0845
0846 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
0847 # names in the source code. If set to NO (the default) only conditional
0848 # compilation will be performed. Macro expansion can be done in a controlled
0849 # way by setting EXPAND_ONLY_PREDEF to YES.
0850
0851 MACRO_EXPANSION = NO
0852
0853 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
0854 # then the macro expansion is limited to the macros specified with the
0855 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
0856
0857 EXPAND_ONLY_PREDEF = NO
0858
0859 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
0860 # in the INCLUDE_PATH (see below) will be search if a #include is found.
0861
0862 SEARCH_INCLUDES = YES
0863
0864 # The INCLUDE_PATH tag can be used to specify one or more directories that
0865 # contain include files that are not input files but should be processed by
0866 # the preprocessor.
0867
0868 INCLUDE_PATH =
0869
0870 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
0871 # patterns (like *.h and *.hpp) to filter out the header-files in the
0872 # directories. If left blank, the patterns specified with FILE_PATTERNS will
0873 # be used.
0874
0875 INCLUDE_FILE_PATTERNS =
0876
0877 # The PREDEFINED tag can be used to specify one or more macro names that
0878 # are defined before the preprocessor is started (similar to the -D option of
0879 # gcc). The argument of the tag is a list of macros of the form: name
0880 # or name=definition (no spaces). If the definition and the = are
0881 # omitted =1 is assumed.
0882
0883 PREDEFINED = _XMP_SUPPORT_
0884
0885 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
0886 # this tag can be used to specify a list of macro names that should be expanded.
0887 # The macro definition that is found in the sources will be used.
0888 # Use the PREDEFINED tag if you want to use a different macro definition.
0889
0890 EXPAND_AS_DEFINED =
0891
0892 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
0893 # doxygen's preprocessor will remove all function-like macros that are alone
0894 # on a line, have an all uppercase name, and do not end with a semicolon. Such
0895 # function macros are typically used for boiler-plate code, and will confuse the
0896 # parser if not removed.
0897
0898 SKIP_FUNCTION_MACROS = YES
0899
0900 #---------------------------------------------------------------------------
0901 # Configuration::addtions related to external references
0902 #---------------------------------------------------------------------------
0903
0904 # The TAGFILES option can be used to specify one or more tagfiles.
0905 # Optionally an initial location of the external documentation
0906 # can be added for each tagfile. The format of a tag file without
0907 # this location is as follows:
0908 # TAGFILES = file1 file2 ...
0909 # Adding location for the tag files is done as follows:
0910 # TAGFILES = file1=loc1 "file2 = loc2" ...
0911 # where "loc1" and "loc2" can be relative or absolute paths or
0912 # URLs. If a location is present for each tag, the installdox tool
0913 # does not have to be run to correct the links.
0914 # Note that each tag file must have a unique name
0915 # (where the name does NOT include the path)
0916 # If a tag file is not located in the directory in which doxygen
0917 # is run, you must also specify the path to the tagfile here.
0918
0919 TAGFILES =
0920
0921 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
0922 # a tag file that is based on the input files it reads.
0923
0924 GENERATE_TAGFILE =
0925
0926 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
0927 # in the class index. If set to NO only the inherited external classes
0928 # will be listed.
0929
0930 ALLEXTERNALS = NO
0931
0932 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
0933 # in the modules index. If set to NO, only the current project's groups will
0934 # be listed.
0935
0936 EXTERNAL_GROUPS = YES
0937
0938 # The PERL_PATH should be the absolute path and name of the perl script
0939 # interpreter (i.e. the result of `which perl').
0940
0941 PERL_PATH = /usr/bin/perl
0942
0943 #---------------------------------------------------------------------------
0944 # Configuration options related to the dot tool
0945 #---------------------------------------------------------------------------
0946
0947 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
0948 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
0949 # super classes. Setting the tag to NO turns the diagrams off. Note that this
0950 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is
0951 # recommended to install and use dot, since it yields more powerful graphs.
0952
0953 CLASS_DIAGRAMS = YES
0954
0955 # If set to YES, the inheritance and collaboration graphs will hide
0956 # inheritance and usage relations if the target is undocumented
0957 # or is not a class.
0958
0959 HIDE_UNDOC_RELATIONS = YES
0960
0961 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
0962 # available from the path. This tool is part of Graphviz, a graph visualization
0963 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
0964 # have no effect if this option is set to NO (the default)
0965
0966 HAVE_DOT = YES
0967
0968 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
0969 # will generate a graph for each documented class showing the direct and
0970 # indirect inheritance relations. Setting this tag to YES will force the
0971 # the CLASS_DIAGRAMS tag to NO.
0972
0973 CLASS_GRAPH = YES
0974
0975 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
0976 # will generate a graph for each documented class showing the direct and
0977 # indirect implementation dependencies (inheritance, containment, and
0978 # class references variables) of the class with other documented classes.
0979
0980 COLLABORATION_GRAPH = YES
0981
0982 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
0983 # collaboration diagrams in a style similar to the OMG's Unified Modeling
0984 # Language.
0985
0986 UML_LOOK = YES
0987
0988 # If set to YES, the inheritance and collaboration graphs will show the
0989 # relations between templates and their instances.
0990
0991 TEMPLATE_RELATIONS = YES
0992
0993 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
0994 # tags are set to YES then doxygen will generate a graph for each documented
0995 # file showing the direct and indirect include dependencies of the file with
0996 # other documented files.
0997
0998 INCLUDE_GRAPH = YES
0999
1000 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1001 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1002 # documented header file showing the documented files that directly or
1003 # indirectly include this file.
1004
1005 INCLUDED_BY_GRAPH = YES
1006
1007 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
1008 # generate a call dependency graph for every global function or class method.
1009 # Note that enabling this option will significantly increase the time of a run.
1010 # So in most cases it will be better to enable call graphs for selected
1011 # functions only using the \callgraph command.
1012
1013 CALL_GRAPH = YES
1014
1015 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1016 # will graphical hierarchy of all classes instead of a textual one.
1017
1018 GRAPHICAL_HIERARCHY = YES
1019
1020 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1021 # generated by dot. Possible values are png, jpg, or gif
1022 # If left blank png will be used.
1023
1024 DOT_IMAGE_FORMAT = png
1025
1026 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1027 # found. If left blank, it is assumed the dot tool can be found on the path.
1028
1029 DOT_PATH =
1030
1031 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1032 # contain dot files that are included in the documentation (see the
1033 # \dotfile command).
1034
1035 DOTFILE_DIRS =
1036
1037 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1038 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1039 # from the root by following a path via at most 3 edges will be shown. Nodes that
1040 # lay further from the root node will be omitted. Note that setting this option to
1041 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also
1042 # note that a graph may be further truncated if the graph's image dimensions are
1043 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
1044 # If 0 is used for the depth value (the default), the graph is not depth-constrained.
1045
1046 MAX_DOT_GRAPH_DEPTH = 0
1047
1048 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1049 # generate a legend page explaining the meaning of the various boxes and
1050 # arrows in the dot generated graphs.
1051
1052 GENERATE_LEGEND = YES
1053
1054 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1055 # remove the intermediate dot files that are used to generate
1056 # the various graphs.
1057
1058 DOT_CLEANUP = YES
1059
1060 #---------------------------------------------------------------------------
1061 # Configuration::addtions related to the search engine
1062 #---------------------------------------------------------------------------
1063
1064 # The SEARCHENGINE tag specifies whether or not a search engine should be
1065 # used. If set to NO the values of all tags below this one will be ignored.
1066
1067 SEARCHENGINE = NO