libpst: xml/Doxyfile annotate

annotate xml/Doxyfile @ 359:a3e674fade6c

From Jeffrey Morlan: pst_parse_block misreads Table Contexts (aka "type 2") with a multi-block Row Matrix ("ind2"). Rows are never split between blocks - every block except the last has padding at the end which should be ignored. I've only seen this affect the recipients table, but presumably it could affect attachments too. This was causing out-of-bounds memory ranges to be returned from pst_getBlockOffset and later access; patch fixes both the table reading issue and adds a missing bounds check to pst_getBlockOffset (so as not to risk a segfault if the PST is corrupted).

author	Carl Byington <carl@five-ten-sg.com>
date	Wed, 06 Jul 2016 10:20:12 -0700
parents	2d1111fd70cf
children

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

Mercurial > libpst

annotate xml/Doxyfile @ 359:a3e674fade6c