graal-compiler: doc/graal.doxy annotate

annotate doc/graal.doxy @ 2858:a97605b0489b

Renamed Compare=>Materialize and introduced new C1XOption Inline.

author	Thomas Wuerthinger <thomas@wuerthinger.net>
date	Tue, 07 Jun 2011 16:11:26 +0200
parents	6d843cdd0bed
children

rev	line source
2627 6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1 # Doxyfile 1.7.1
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	2
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	3 # This file describes the settings to be used by the documentation system
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	4 # doxygen (www.doxygen.org) for a project
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	5 #
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	6 # All text after a hash (#) is considered a comment and will be ignored
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	7 # The format is:
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	8 # TAG = value [value, ...]
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	9 # For lists items can also be appended using:
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	10 # TAG += value [value, ...]
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	11 # Values that contain spaces should be placed between quotes (" ")
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	12
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	13 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	14 # Project related configuration options
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	15 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	16
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	17 # This tag specifies the encoding used for all characters in the config file
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	18 # that follow. The default is UTF-8 which is also the encoding used for all
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	19 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	20 # iconv built into libc) for the transcoding. See
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	21 # http://www.gnu.org/software/libiconv for the list of possible encodings.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	22
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	23 DOXYFILE_ENCODING = UTF-8
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	24
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	26 # by quotes) that should identify the project.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	27
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	28 PROJECT_NAME = GRAAL
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	29
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	30 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	31 # This could be handy for archiving the generated documentation or
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	32 # if some version control system is used.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	33
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	34 PROJECT_NUMBER =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	35
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	37 # base path where the generated documentation will be put.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	38 # If a relative path is entered, it will be relative to the location
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	39 # where doxygen was started. If left blank the current directory will be used.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	40
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	41 OUTPUT_DIRECTORY = .
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	42
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	44 # 4096 sub-directories (in 2 levels) under the output directory of each output
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	45 # format and will distribute the generated files over these directories.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	46 # Enabling this option can be useful when feeding doxygen a huge amount of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	47 # source files, where putting all generated files in the same directory would
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	48 # otherwise cause performance problems for the file system.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	49
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	50 CREATE_SUBDIRS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	51
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	53 # documentation generated by doxygen is written. Doxygen will use this
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	54 # information to generate all constant output in the proper language.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	55 # The default language is English, other supported languages are:
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	62
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	63 OUTPUT_LANGUAGE = English
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	64
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	66 # include brief member descriptions after the members that are listed in
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	67 # the file and class documentation (similar to JavaDoc).
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	68 # Set to NO to disable this.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	69
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	70 BRIEF_MEMBER_DESC = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	71
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	72 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	73 # the brief description of a member or function before the detailed description.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	74 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	75 # brief descriptions will be completely suppressed.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	76
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	77 REPEAT_BRIEF = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	78
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	79 # This tag implements a quasi-intelligent brief description abbreviator
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	80 # that is used to form the text in various listings. Each string
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	81 # in this list, if found as the leading text of the brief description, will be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	82 # stripped from the text and the result after processing the whole list, is
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	83 # used as the annotated text. Otherwise, the brief description is used as-is.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	84 # If left blank, the following values are used ("$name" is automatically
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	85 # replaced with the name of the entity): "The $name class" "The $name widget"
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	86 # "The $name file" "is" "provides" "specifies" "contains"
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	87 # "represents" "a" "an" "the"
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	88
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	89 ABBREVIATE_BRIEF = "The $name class" \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	90 "The $name widget" \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	91 "The $name file" \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	92 is \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	93 provides \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	94 specifies \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	95 contains \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	96 represents \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	97 a \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	98 an \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	99 the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	100
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	102 # Doxygen will generate a detailed section even if there is only a brief
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	103 # description.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	104
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	105 ALWAYS_DETAILED_SEC = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	106
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	108 # inherited members of a class in the documentation of that class as if those
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	109 # members were ordinary class members. Constructors, destructors and assignment
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	110 # operators of the base classes will not be shown.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	111
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	112 INLINE_INHERITED_MEMB = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	113
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	114 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	115 # path before files name in the file list and in the header files. If set
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	116 # to NO the shortest path that makes the file name unique will be used.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	117
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	118 FULL_PATH_NAMES = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	119
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	120 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	121 # can be used to strip a user-defined part of the path. Stripping is
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	122 # only done if one of the specified strings matches the left-hand part of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	123 # the path. The tag can be used to show relative paths in the file list.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	124 # If left blank the directory from which doxygen is run is used as the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	125 # path to strip.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	126
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	127 STRIP_FROM_PATH =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	128
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	129 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	130 # the path mentioned in the documentation of a class, which tells
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	131 # the reader which header file to include in order to use a class.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	132 # If left blank only the name of the header file containing the class
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	133 # definition is used. Otherwise one should specify the include paths that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	134 # are normally passed to the compiler using the -I flag.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	135
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	136 STRIP_FROM_INC_PATH =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	137
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	138 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	139 # (but less readable) file names. This can be useful is your file systems
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	140 # doesn't support long names like on DOS, Mac, or CD-ROM.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	141
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	142 SHORT_NAMES = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	143
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	144 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	145 # will interpret the first line (until the first dot) of a JavaDoc-style
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	146 # comment as the brief description. If set to NO, the JavaDoc
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	147 # comments will behave just like regular Qt-style comments
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	148 # (thus requiring an explicit @brief command for a brief description.)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	149
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	150 JAVADOC_AUTOBRIEF = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	151
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	152 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	153 # interpret the first line (until the first dot) of a Qt-style
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	154 # comment as the brief description. If set to NO, the comments
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	155 # will behave just like regular Qt-style comments (thus requiring
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	156 # an explicit \brief command for a brief description.)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	157
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	158 QT_AUTOBRIEF = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	159
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	160 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	161 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	162 # comments) as a brief description. This used to be the default behaviour.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	163 # The new default is to treat a multi-line C++ comment block as a detailed
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	164 # description. Set this tag to YES if you prefer the old behaviour instead.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	165
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	166 MULTILINE_CPP_IS_BRIEF = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	167
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	168 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	169 # member inherits the documentation from any documented member that it
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	170 # re-implements.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	171
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	172 INHERIT_DOCS = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	173
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	174 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	175 # a new page for each member. If set to NO, the documentation of a member will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	176 # be part of the file/class/namespace that contains it.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	177
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	178 SEPARATE_MEMBER_PAGES = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	179
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	180 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	181 # Doxygen uses this value to replace tabs by spaces in code fragments.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	182
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	183 TAB_SIZE = 8
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	184
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	185 # This tag can be used to specify a number of aliases that acts
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	186 # as commands in the documentation. An alias has the form "name=value".
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	187 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	188 # put the command \sideeffect (or @sideeffect) in the documentation, which
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	189 # will result in a user-defined paragraph with heading "Side Effects:".
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	190 # You can put \n's in the value part of an alias to insert newlines.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	191
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	192 ALIASES =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	193
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	194 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	195 # sources only. Doxygen will then generate output that is more tailored for C.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	196 # For instance, some of the names that are used will be different. The list
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	197 # of all members will be omitted, etc.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	198
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	199 OPTIMIZE_OUTPUT_FOR_C = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	200
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	201 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	202 # sources only. Doxygen will then generate output that is more tailored for
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	203 # Java. For instance, namespaces will be presented as packages, qualified
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	204 # scopes will look different, etc.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	205
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	206 OPTIMIZE_OUTPUT_JAVA = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	207
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	208 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	209 # sources only. Doxygen will then generate output that is more tailored for
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	210 # Fortran.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	211
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	212 OPTIMIZE_FOR_FORTRAN = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	213
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	214 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	215 # sources. Doxygen will then generate output that is tailored for
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	216 # VHDL.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	217
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	218 OPTIMIZE_OUTPUT_VHDL = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	219
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	220 # Doxygen selects the parser to use depending on the extension of the files it
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	221 # parses. With this tag you can assign which parser to use for a given extension.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	222 # Doxygen has a built-in mapping, but you can override or extend it using this
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	223 # tag. The format is ext=language, where ext is a file extension, and language
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	224 # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	225 # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	226 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	227 # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	228 # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	229
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	230 EXTENSION_MAPPING =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	231
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	232 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	233 # to include (a tag file for) the STL sources as input, then you should
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	234 # set this tag to YES in order to let doxygen match functions declarations and
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	235 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	236 # func(std::string) {}). This also make the inheritance and collaboration
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	237 # diagrams that involve STL classes more complete and accurate.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	238
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	239 BUILTIN_STL_SUPPORT = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	240
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	241 # If you use Microsoft's C++/CLI language, you should set this option to YES to
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	242 # enable parsing support.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	243
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	244 CPP_CLI_SUPPORT = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	245
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	246 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	247 # Doxygen will parse them like normal C++ but will assume all classes use public
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	248 # instead of private inheritance when no explicit protection keyword is present.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	249
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	250 SIP_SUPPORT = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	251
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	252 # For Microsoft's IDL there are propget and propput attributes to indicate getter
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	253 # and setter methods for a property. Setting this option to YES (the default)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	254 # will make doxygen to replace the get and set methods by a property in the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	255 # documentation. This will only work if the methods are indeed getting or
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	256 # setting a simple type. If this is not the case, or you want to show the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	257 # methods anyway, you should set this option to NO.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	258
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	259 IDL_PROPERTY_SUPPORT = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	260
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	261 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	262 # tag is set to YES, then doxygen will reuse the documentation of the first
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	263 # member in the group (if any) for the other members of the group. By default
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	264 # all members of a group must be documented explicitly.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	265
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	266 DISTRIBUTE_GROUP_DOC = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	267
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	268 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	269 # the same type (for instance a group of public functions) to be put as a
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	270 # subgroup of that type (e.g. under the Public Functions section). Set it to
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	271 # NO to prevent subgrouping. Alternatively, this can be done per class using
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	272 # the \nosubgrouping command.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	273
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	274 SUBGROUPING = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	275
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	276 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	277 # is documented as struct, union, or enum with the name of the typedef. So
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	278 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	279 # with name TypeT. When disabled the typedef will appear as a member of a file,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	280 # namespace, or class. And the struct will be named TypeS. This can typically
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	281 # be useful for C code in case the coding convention dictates that all compound
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	282 # types are typedef'ed and only the typedef is referenced, never the tag name.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	283
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	284 TYPEDEF_HIDES_STRUCT = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	285
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	286 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	287 # determine which symbols to keep in memory and which to flush to disk.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	288 # When the cache is full, less often used symbols will be written to disk.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	289 # For small to medium size projects (<1000 input files) the default value is
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	290 # probably good enough. For larger projects a too small cache size can cause
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	291 # doxygen to be busy swapping symbols to and from disk most of the time
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	292 # causing a significant performance penality.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	293 # If the system has enough physical memory increasing the cache will improve the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	294 # performance by keeping more symbols in memory. Note that the value works on
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	295 # a logarithmic scale so increasing the size by one will rougly double the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	296 # memory usage. The cache size is given by this formula:
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	297 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	298 # corresponding to a cache size of 2^16 = 65536 symbols
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	299
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	300 SYMBOL_CACHE_SIZE = 0
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	301
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	302 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	303 # Build related configuration options
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	304 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	305
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	306 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	307 # documentation are documented, even if no documentation was available.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	308 # Private class members and static file members will be hidden unless
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	309 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	310
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	311 EXTRACT_ALL = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	312
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	313 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	314 # will be included in the documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	315
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	316 EXTRACT_PRIVATE = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	317
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	318 # If the EXTRACT_STATIC tag is set to YES all static members of a file
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	319 # will be included in the documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	320
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	321 EXTRACT_STATIC = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	322
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	323 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	324 # defined locally in source files will be included in the documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	325 # If set to NO only classes defined in header files are included.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	326
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	327 EXTRACT_LOCAL_CLASSES = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	328
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	329 # This flag is only useful for Objective-C code. When set to YES local
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	330 # methods, which are defined in the implementation section but not in
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	331 # the interface are included in the documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	332 # If set to NO (the default) only methods in the interface are included.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	333
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	334 EXTRACT_LOCAL_METHODS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	335
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	336 # If this flag is set to YES, the members of anonymous namespaces will be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	337 # extracted and appear in the documentation as a namespace called
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	338 # 'anonymous_namespace{file}', where file will be replaced with the base
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	339 # name of the file that contains the anonymous namespace. By default
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	340 # anonymous namespace are hidden.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	341
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	342 EXTRACT_ANON_NSPACES = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	343
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	344 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	345 # undocumented members of documented classes, files or namespaces.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	346 # If set to NO (the default) these members will be included in the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	347 # various overviews, but no documentation section is generated.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	348 # This option has no effect if EXTRACT_ALL is enabled.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	349
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	350 HIDE_UNDOC_MEMBERS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	351
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	352 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	353 # undocumented classes that are normally visible in the class hierarchy.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	354 # If set to NO (the default) these classes will be included in the various
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	355 # overviews. This option has no effect if EXTRACT_ALL is enabled.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	356
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	357 HIDE_UNDOC_CLASSES = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	358
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	359 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	360 # friend (class\|struct\|union) declarations.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	361 # If set to NO (the default) these declarations will be included in the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	362 # documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	363
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	364 HIDE_FRIEND_COMPOUNDS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	365
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	366 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	367 # documentation blocks found inside the body of a function.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	368 # If set to NO (the default) these blocks will be appended to the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	369 # function's detailed documentation block.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	370
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	371 HIDE_IN_BODY_DOCS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	372
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	373 # The INTERNAL_DOCS tag determines if documentation
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	374 # that is typed after a \internal command is included. If the tag is set
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	375 # to NO (the default) then the documentation will be excluded.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	376 # Set it to YES to include the internal documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	377
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	378 INTERNAL_DOCS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	379
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	380 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	381 # file names in lower-case letters. If set to YES upper-case letters are also
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	382 # allowed. This is useful if you have classes or files whose names only differ
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	383 # in case and if your file system supports case sensitive file names. Windows
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	384 # and Mac users are advised to set this option to NO.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	385
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	386 CASE_SENSE_NAMES = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	387
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	388 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	389 # will show members with their full class and namespace scopes in the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	390 # documentation. If set to YES the scope will be hidden.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	391
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	392 HIDE_SCOPE_NAMES = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	393
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	394 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	395 # will put a list of the files that are included by a file in the documentation
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	396 # of that file.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	397
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	398 SHOW_INCLUDE_FILES = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	399
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	400 # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	401 # will list include files with double quotes in the documentation
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	402 # rather than with sharp brackets.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	403
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	404 FORCE_LOCAL_INCLUDES = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	405
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	406 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	407 # is inserted in the documentation for inline members.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	408
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	409 INLINE_INFO = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	410
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	411 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	412 # will sort the (detailed) documentation of file and class members
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	413 # alphabetically by member name. If set to NO the members will appear in
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	414 # declaration order.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	415
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	416 SORT_MEMBER_DOCS = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	417
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	418 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	419 # brief documentation of file, namespace and class members alphabetically
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	420 # by member name. If set to NO (the default) the members will appear in
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	421 # declaration order.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	422
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	423 SORT_BRIEF_DOCS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	424
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	425 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	426 # will sort the (brief and detailed) documentation of class members so that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	427 # constructors and destructors are listed first. If set to NO (the default)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	428 # the constructors will appear in the respective orders defined by
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	429 # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	430 # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	431 # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	432
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	433 SORT_MEMBERS_CTORS_1ST = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	434
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	435 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	436 # hierarchy of group names into alphabetical order. If set to NO (the default)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	437 # the group names will appear in their defined order.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	438
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	439 SORT_GROUP_NAMES = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	440
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	441 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	442 # sorted by fully-qualified names, including namespaces. If set to
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	443 # NO (the default), the class list will be sorted only by class name,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	444 # not including the namespace part.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	445 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	446 # Note: This option applies only to the class list, not to the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	447 # alphabetical list.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	448
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	449 SORT_BY_SCOPE_NAME = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	450
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	451 # The GENERATE_TODOLIST tag can be used to enable (YES) or
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	452 # disable (NO) the todo list. This list is created by putting \todo
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	453 # commands in the documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	454
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	455 GENERATE_TODOLIST = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	456
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	457 # The GENERATE_TESTLIST tag can be used to enable (YES) or
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	458 # disable (NO) the test list. This list is created by putting \test
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	459 # commands in the documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	460
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	461 GENERATE_TESTLIST = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	462
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	463 # The GENERATE_BUGLIST tag can be used to enable (YES) or
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	464 # disable (NO) the bug list. This list is created by putting \bug
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	465 # commands in the documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	466
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	467 GENERATE_BUGLIST = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	468
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	469 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	470 # disable (NO) the deprecated list. This list is created by putting
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	471 # \deprecated commands in the documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	472
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	473 GENERATE_DEPRECATEDLIST= YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	474
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	475 # The ENABLED_SECTIONS tag can be used to enable conditional
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	476 # documentation sections, marked by \if sectionname ... \endif.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	477
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	478 ENABLED_SECTIONS =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	479
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	480 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	481 # the initial value of a variable or define consists of for it to appear in
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	482 # the documentation. If the initializer consists of more lines than specified
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	483 # here it will be hidden. Use a value of 0 to hide initializers completely.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	484 # The appearance of the initializer of individual variables and defines in the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	485 # documentation can be controlled using \showinitializer or \hideinitializer
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	486 # command in the documentation regardless of this setting.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	487
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	488 MAX_INITIALIZER_LINES = 30
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	489
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	490 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	491 # at the bottom of the documentation of classes and structs. If set to YES the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	492 # list will mention the files that were used to generate the documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	493
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	494 SHOW_USED_FILES = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	495
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	496 # If the sources in your project are distributed over multiple directories
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	497 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	498 # in the documentation. The default is NO.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	499
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	500 SHOW_DIRECTORIES = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	501
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	502 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	503 # This will remove the Files entry from the Quick Index and from the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	504 # Folder Tree View (if specified). The default is YES.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	505
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	506 SHOW_FILES = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	507
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	508 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	509 # Namespaces page. This will remove the Namespaces entry from the Quick Index
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	510 # and from the Folder Tree View (if specified). The default is YES.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	511
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	512 SHOW_NAMESPACES = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	513
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	514 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	515 # doxygen should invoke to get the current version for each file (typically from
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	516 # the version control system). Doxygen will invoke the program by executing (via
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	517 # popen()) the command <command> <input-file>, where <command> is the value of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	518 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	519 # provided by doxygen. Whatever the program writes to standard output
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	520 # is used as the file version. See the manual for examples.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	521
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	522 FILE_VERSION_FILTER =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	523
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	524 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	525 # by doxygen. The layout file controls the global structure of the generated
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	526 # output files in an output format independent way. The create the layout file
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	527 # that represents doxygen's defaults, run doxygen with the -l option.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	528 # You can optionally specify a file name after the option, if omitted
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	529 # DoxygenLayout.xml will be used as the name of the layout file.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	530
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	531 LAYOUT_FILE =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	532
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	533 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	534 # configuration options related to warning and progress messages
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	535 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	536
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	537 # The QUIET tag can be used to turn on/off the messages that are generated
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	538 # by doxygen. Possible values are YES and NO. If left blank NO is used.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	539
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	540 QUIET = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	541
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	542 # The WARNINGS tag can be used to turn on/off the warning messages that are
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	543 # generated by doxygen. Possible values are YES and NO. If left blank
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	544 # NO is used.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	545
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	546 WARNINGS = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	547
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	548 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	549 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	550 # automatically be disabled.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	551
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	552 WARN_IF_UNDOCUMENTED = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	553
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	554 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	555 # potential errors in the documentation, such as not documenting some
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	556 # parameters in a documented function, or documenting parameters that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	557 # don't exist or using markup commands wrongly.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	558
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	559 WARN_IF_DOC_ERROR = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	560
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	561 # This WARN_NO_PARAMDOC option can be abled to get warnings for
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	562 # functions that are documented, but have no documentation for their parameters
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	563 # or return value. If set to NO (the default) doxygen will only warn about
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	564 # wrong or incomplete parameter documentation, but not about the absence of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	565 # documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	566
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	567 WARN_NO_PARAMDOC = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	568
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	569 # The WARN_FORMAT tag determines the format of the warning messages that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	570 # doxygen can produce. The string should contain the $file, $line, and $text
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	571 # tags, which will be replaced by the file and line number from which the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	572 # warning originated and the warning text. Optionally the format may contain
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	573 # $version, which will be replaced by the version of the file (if it could
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	574 # be obtained via FILE_VERSION_FILTER)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	575
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	576 WARN_FORMAT = "$file:$line: $text"
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	577
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	578 # The WARN_LOGFILE tag can be used to specify a file to which warning
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	579 # and error messages should be written. If left blank the output is written
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	580 # to stderr.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	581
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	582 WARN_LOGFILE =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	583
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	584 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	585 # configuration options related to the input files
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	586 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	587
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	588 # The INPUT tag can be used to specify the files and/or directories that contain
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	589 # documented source files. You may enter file names like "myfile.cpp" or
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	590 # directories like "/usr/src/myproject". Separate the files or directories
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	591 # with spaces.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	592
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	593 INPUT = src
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	594
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	595 # This tag can be used to specify the character encoding of the source files
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	596 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	597 # also the default input encoding. Doxygen uses libiconv (or the iconv built
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	598 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	599 # the list of possible encodings.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	600
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	601 INPUT_ENCODING = UTF-8
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	602
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	603 # If the value of the INPUT tag contains directories, you can use the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	604 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	605 # and *.h) to filter out the source-files in the directories. If left
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	606 # blank the following patterns are tested:
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	607 # .c .cc .cxx .cpp .c++ .java .ii .ixx .ipp .i++ .inl .h .hh .hxx
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	608 # .hpp .h++ .idl .odl .cs .php .php3 .inc .m .mm .py .f90
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	609
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	610 FILE_PATTERNS = *.c \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	611 *.cc \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	612 *.cxx \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	613 *.cpp \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	614 *.c++ \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	615 *.d \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	616 *.java \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	617 *.ii \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	618 *.ixx \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	619 *.ipp \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	620 *.i++ \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	621 *.inl \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	622 *.h \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	623 *.hh \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	624 *.hxx \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	625 *.hpp \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	626 *.h++ \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	627 *.idl \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	628 *.odl \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	629 *.cs \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	630 *.php \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	631 *.php3 \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	632 *.inc \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	633 *.m \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	634 *.mm \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	635 *.dox \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	636 *.py \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	637 *.f90 \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	638 *.f \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	639 *.vhd \
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	640 *.vhdl
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	641
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	642 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	643 # should be searched for input files as well. Possible values are YES and NO.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	644 # If left blank NO is used.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	645
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	646 RECURSIVE = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	647
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	648 # The EXCLUDE tag can be used to specify files and/or directories that should
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	649 # excluded from the INPUT source files. This way you can easily exclude a
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	650 # subdirectory from a directory tree whose root is specified with the INPUT tag.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	651
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	652 EXCLUDE =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	653
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	654 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	655 # directories that are symbolic links (a Unix filesystem feature) are excluded
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	656 # from the input.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	657
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	658 EXCLUDE_SYMLINKS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	659
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	660 # If the value of the INPUT tag contains directories, you can use the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	661 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	662 # certain files from those directories. Note that the wildcards are matched
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	663 # against the file with absolute path, so to exclude all test directories
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	664 # for example use the pattern /test/
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	665
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	666 EXCLUDE_PATTERNS =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	667
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	668 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	669 # (namespaces, classes, functions, etc.) that should be excluded from the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	670 # output. The symbol name can be a fully qualified name, a word, or if the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	671 # wildcard * is used, a substring. Examples: ANamespace, AClass,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	672 # AClass::ANamespace, ANamespace::*Test
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	673
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	674 EXCLUDE_SYMBOLS =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	675
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	676 # The EXAMPLE_PATH tag can be used to specify one or more files or
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	677 # directories that contain example code fragments that are included (see
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	678 # the \include command).
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	679
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	680 EXAMPLE_PATH =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	681
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	682 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	683 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	684 # and *.h) to filter out the source-files in the directories. If left
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	685 # blank all files are included.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	686
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	687 EXAMPLE_PATTERNS = *
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	688
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	689 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	690 # searched for input files to be used with the \include or \dontinclude
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	691 # commands irrespective of the value of the RECURSIVE tag.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	692 # Possible values are YES and NO. If left blank NO is used.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	693
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	694 EXAMPLE_RECURSIVE = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	695
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	696 # The IMAGE_PATH tag can be used to specify one or more files or
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	697 # directories that contain image that are included in the documentation (see
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	698 # the \image command).
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	699
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	700 IMAGE_PATH =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	701
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	702 # The INPUT_FILTER tag can be used to specify a program that doxygen should
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	703 # invoke to filter for each input file. Doxygen will invoke the filter program
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	704 # by executing (via popen()) the command <filter> <input-file>, where <filter>
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	705 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	706 # input file. Doxygen will then use the output that the filter program writes
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	707 # to standard output. If FILTER_PATTERNS is specified, this tag will be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	708 # ignored.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	709
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	710 INPUT_FILTER =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	711
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	712 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	713 # basis. Doxygen will compare the file name with each pattern and apply the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	714 # filter if there is a match. The filters are a list of the form:
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	715 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	716 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	717 # is applied to all files.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	718
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	719 FILTER_PATTERNS =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	720
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	721 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	722 # INPUT_FILTER) will be used to filter the input files when producing source
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	723 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	724
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	725 FILTER_SOURCE_FILES = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	726
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	727 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	728 # configuration options related to source browsing
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	729 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	730
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	731 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	732 # be generated. Documented entities will be cross-referenced with these sources.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	733 # Note: To get rid of all source code in the generated output, make sure also
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	734 # VERBATIM_HEADERS is set to NO.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	735
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	736 SOURCE_BROWSER = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	737
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	738 # Setting the INLINE_SOURCES tag to YES will include the body
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	739 # of functions and classes directly in the documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	740
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	741 INLINE_SOURCES = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	742
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	743 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	744 # doxygen to hide any special comment blocks from generated source code
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	745 # fragments. Normal C and C++ comments will always remain visible.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	746
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	747 STRIP_CODE_COMMENTS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	748
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	749 # If the REFERENCED_BY_RELATION tag is set to YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	750 # then for each documented function all documented
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	751 # functions referencing it will be listed.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	752
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	753 REFERENCED_BY_RELATION = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	754
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	755 # If the REFERENCES_RELATION tag is set to YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	756 # then for each documented function all documented entities
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	757 # called/used by that function will be listed.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	758
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	759 REFERENCES_RELATION = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	760
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	761 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	762 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	763 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	764 # link to the source code. Otherwise they will link to the documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	765
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	766 REFERENCES_LINK_SOURCE = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	767
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	768 # If the USE_HTAGS tag is set to YES then the references to source code
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	769 # will point to the HTML generated by the htags(1) tool instead of doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	770 # built-in source browser. The htags tool is part of GNU's global source
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	771 # tagging system (see http://www.gnu.org/software/global/global.html). You
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	772 # will need version 4.8.6 or higher.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	773
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	774 USE_HTAGS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	775
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	776 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	777 # will generate a verbatim copy of the header file for each class for
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	778 # which an include is specified. Set to NO to disable this.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	779
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	780 VERBATIM_HEADERS = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	781
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	782 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	783 # configuration options related to the alphabetical class index
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	784 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	785
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	786 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	787 # of all compounds will be generated. Enable this if the project
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	788 # contains a lot of classes, structs, unions or interfaces.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	789
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	790 ALPHABETICAL_INDEX = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	791
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	792 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	793 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	794 # in which this list will be split (can be a number in the range [1..20])
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	795
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	796 COLS_IN_ALPHA_INDEX = 5
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	797
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	798 # In case all classes in a project start with a common prefix, all
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	799 # classes will be put under the same header in the alphabetical index.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	800 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	801 # should be ignored while generating the index headers.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	802
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	803 IGNORE_PREFIX =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	804
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	805 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	806 # configuration options related to the HTML output
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	807 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	808
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	809 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	810 # generate HTML output.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	811
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	812 GENERATE_HTML = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	813
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	814 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	815 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	816 # put in front of it. If left blank `html' will be used as the default path.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	817
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	818 HTML_OUTPUT = html
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	819
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	820 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	821 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	822 # doxygen will generate files with .html extension.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	823
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	824 HTML_FILE_EXTENSION = .html
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	825
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	826 # The HTML_HEADER tag can be used to specify a personal HTML header for
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	827 # each generated HTML page. If it is left blank doxygen will generate a
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	828 # standard header.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	829
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	830 HTML_HEADER =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	831
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	832 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	833 # each generated HTML page. If it is left blank doxygen will generate a
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	834 # standard footer.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	835
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	836 HTML_FOOTER =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	837
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	838 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	839 # style sheet that is used by each HTML page. It can be used to
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	840 # fine-tune the look of the HTML output. If the tag is left blank doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	841 # will generate a default style sheet. Note that doxygen will try to copy
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	842 # the style sheet file to the HTML output directory, so don't put your own
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	843 # stylesheet in the HTML output directory as well, or it will be erased!
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	844
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	845 HTML_STYLESHEET =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	846
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	847 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	848 # Doxygen will adjust the colors in the stylesheet and background images
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	849 # according to this color. Hue is specified as an angle on a colorwheel,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	850 # see http://en.wikipedia.org/wiki/Hue for more information.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	851 # For instance the value 0 represents red, 60 is yellow, 120 is green,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	852 # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	853 # The allowed range is 0 to 359.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	854
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	855 HTML_COLORSTYLE_HUE = 220
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	856
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	857 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	858 # the colors in the HTML output. For a value of 0 the output will use
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	859 # grayscales only. A value of 255 will produce the most vivid colors.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	860
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	861 HTML_COLORSTYLE_SAT = 100
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	862
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	863 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	864 # the luminance component of the colors in the HTML output. Values below
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	865 # 100 gradually make the output lighter, whereas values above 100 make
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	866 # the output darker. The value divided by 100 is the actual gamma applied,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	867 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	868 # and 100 does not change the gamma.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	869
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	870 HTML_COLORSTYLE_GAMMA = 80
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	871
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	872 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	873 # page will contain the date and time when the page was generated. Setting
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	874 # this to NO can help when comparing the output of multiple runs.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	875
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	876 HTML_TIMESTAMP = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	877
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	878 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	879 # files or namespaces will be aligned in HTML using tables. If set to
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	880 # NO a bullet list will be used.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	881
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	882 HTML_ALIGN_MEMBERS = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	883
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	884 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	885 # documentation will contain sections that can be hidden and shown after the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	886 # page has loaded. For this to work a browser that supports
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	887 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	888 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	889
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	890 HTML_DYNAMIC_SECTIONS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	891
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	892 # If the GENERATE_DOCSET tag is set to YES, additional index files
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	893 # will be generated that can be used as input for Apple's Xcode 3
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	894 # integrated development environment, introduced with OSX 10.5 (Leopard).
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	895 # To create a documentation set, doxygen will generate a Makefile in the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	896 # HTML output directory. Running make will produce the docset in that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	897 # directory and running "make install" will install the docset in
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	898 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	899 # it at startup.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	900 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	901 # for more information.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	902
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	903 GENERATE_DOCSET = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	904
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	905 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	906 # feed. A documentation feed provides an umbrella under which multiple
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	907 # documentation sets from a single provider (such as a company or product suite)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	908 # can be grouped.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	909
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	910 DOCSET_FEEDNAME = "Doxygen generated docs"
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	911
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	912 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	913 # should uniquely identify the documentation set bundle. This should be a
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	914 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	915 # will append .docset to the name.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	916
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	917 DOCSET_BUNDLE_ID = org.doxygen.Project
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	918
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	919 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	920 # the documentation publisher. This should be a reverse domain-name style
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	921 # string, e.g. com.mycompany.MyDocSet.documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	922
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	923 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	924
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	925 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	926
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	927 DOCSET_PUBLISHER_NAME = Publisher
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	928
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	929 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	930 # will be generated that can be used as input for tools like the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	931 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	932 # of the generated HTML documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	933
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	934 GENERATE_HTMLHELP = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	935
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	936 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	937 # be used to specify the file name of the resulting .chm file. You
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	938 # can add a path in front of the file if the result should not be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	939 # written to the html output directory.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	940
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	941 CHM_FILE =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	942
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	943 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	944 # be used to specify the location (absolute path including file name) of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	945 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	946 # the HTML help compiler on the generated index.hhp.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	947
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	948 HHC_LOCATION =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	949
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	950 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	951 # controls if a separate .chi index file is generated (YES) or that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	952 # it should be included in the master .chm file (NO).
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	953
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	954 GENERATE_CHI = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	955
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	956 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	957 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	958 # content.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	959
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	960 CHM_INDEX_ENCODING =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	961
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	962 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	963 # controls whether a binary table of contents is generated (YES) or a
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	964 # normal table of contents (NO) in the .chm file.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	965
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	966 BINARY_TOC = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	967
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	968 # The TOC_EXPAND flag can be set to YES to add extra items for group members
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	969 # to the contents of the HTML help documentation and to the tree view.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	970
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	971 TOC_EXPAND = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	972
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	973 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	974 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	975 # that can be used as input for Qt's qhelpgenerator to generate a
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	976 # Qt Compressed Help (.qch) of the generated HTML documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	977
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	978 GENERATE_QHP = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	979
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	980 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	981 # be used to specify the file name of the resulting .qch file.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	982 # The path specified is relative to the HTML output folder.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	983
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	984 QCH_FILE =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	985
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	986 # The QHP_NAMESPACE tag specifies the namespace to use when generating
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	987 # Qt Help Project output. For more information please see
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	988 # http://doc.trolltech.com/qthelpproject.html#namespace
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	989
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	990 QHP_NAMESPACE = org.doxygen.Project
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	991
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	992 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	993 # Qt Help Project output. For more information please see
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	994 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	995
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	996 QHP_VIRTUAL_FOLDER = doc
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	997
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	998 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	999 # add. For more information please see
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1000 # http://doc.trolltech.com/qthelpproject.html#custom-filters
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1001
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1002 QHP_CUST_FILTER_NAME =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1003
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1004 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1005 # custom filter to add. For more information please see
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1006 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1007 # Qt Help Project / Custom Filters</a>.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1008
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1009 QHP_CUST_FILTER_ATTRS =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1010
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1011 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1012 # project's
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1013 # filter section matches.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1014 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1015 # Qt Help Project / Filter Attributes</a>.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1016
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1017 QHP_SECT_FILTER_ATTRS =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1018
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1019 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1020 # be used to specify the location of Qt's qhelpgenerator.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1021 # If non-empty doxygen will try to run qhelpgenerator on the generated
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1022 # .qhp file.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1023
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1024 QHG_LOCATION =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1025
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1026 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1027 # will be generated, which together with the HTML files, form an Eclipse help
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1028 # plugin. To install this plugin and make it available under the help contents
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1029 # menu in Eclipse, the contents of the directory containing the HTML and XML
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1030 # files needs to be copied into the plugins directory of eclipse. The name of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1031 # the directory within the plugins directory should be the same as
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1032 # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1033 # the help appears.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1034
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1035 GENERATE_ECLIPSEHELP = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1036
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1037 # A unique identifier for the eclipse help plugin. When installing the plugin
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1038 # the directory name containing the HTML and XML files should also have
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1039 # this name.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1040
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1041 ECLIPSE_DOC_ID = org.doxygen.Project
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1042
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1043 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1044 # top of each HTML page. The value NO (the default) enables the index and
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1045 # the value YES disables it.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1046
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1047 DISABLE_INDEX = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1048
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1049 # This tag can be used to set the number of enum values (range [1..20])
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1050 # that doxygen will group on one line in the generated HTML documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1051
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1052 ENUM_VALUES_PER_LINE = 4
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1053
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1054 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1055 # structure should be generated to display hierarchical information.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1056 # If the tag value is set to YES, a side panel will be generated
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1057 # containing a tree-like index structure (just like the one that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1058 # is generated for HTML Help). For this to work a browser that supports
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1059 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1060 # Windows users are probably better off using the HTML help feature.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1061
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1062 GENERATE_TREEVIEW = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1063
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1064 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1065 # and Class Hierarchy pages using a tree view instead of an ordered list.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1066
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1067 USE_INLINE_TREES = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1068
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1069 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1070 # used to set the initial width (in pixels) of the frame in which the tree
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1071 # is shown.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1072
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1073 TREEVIEW_WIDTH = 250
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1074
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1075 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1076 # links to external symbols imported via tag files in a separate window.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1077
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1078 EXT_LINKS_IN_WINDOW = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1079
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1080 # Use this tag to change the font size of Latex formulas included
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1081 # as images in the HTML documentation. The default is 10. Note that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1082 # when you change the font size after a successful doxygen run you need
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1083 # to manually remove any form_*.png images from the HTML output directory
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1084 # to force them to be regenerated.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1085
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1086 FORMULA_FONTSIZE = 10
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1087
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1088 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1089 # generated for formulas are transparent PNGs. Transparent PNGs are
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1090 # not supported properly for IE 6.0, but are supported on all modern browsers.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1091 # Note that when changing this option you need to delete any form_*.png files
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1092 # in the HTML output before the changes have effect.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1093
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1094 FORMULA_TRANSPARENT = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1095
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1096 # When the SEARCHENGINE tag is enabled doxygen will generate a search box
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1097 # for the HTML output. The underlying search engine uses javascript
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1098 # and DHTML and should work on any modern browser. Note that when using
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1099 # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1100 # (GENERATE_DOCSET) there is already a search function so this one should
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1101 # typically be disabled. For large projects the javascript based search engine
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1102 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1103
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1104 SEARCHENGINE = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1105
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1106 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1107 # implemented using a PHP enabled web server instead of at the web client
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1108 # using Javascript. Doxygen will generate the search PHP script and index
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1109 # file to put on the web server. The advantage of the server
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1110 # based approach is that it scales better to large projects and allows
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1111 # full text search. The disadvances is that it is more difficult to setup
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1112 # and does not have live searching capabilities.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1113
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1114 SERVER_BASED_SEARCH = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1115
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1116 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1117 # configuration options related to the LaTeX output
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1118 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1119
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1120 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1121 # generate Latex output.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1122
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1123 GENERATE_LATEX = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1124
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1125 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1126 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1127 # put in front of it. If left blank `latex' will be used as the default path.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1128
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1129 LATEX_OUTPUT = latex
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1130
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1131 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1132 # invoked. If left blank `latex' will be used as the default command name.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1133 # Note that when enabling USE_PDFLATEX this option is only used for
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1134 # generating bitmaps for formulas in the HTML output, but not in the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1135 # Makefile that is written to the output directory.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1136
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1137 LATEX_CMD_NAME = latex
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1138
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1139 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1140 # generate index for LaTeX. If left blank `makeindex' will be used as the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1141 # default command name.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1142
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1143 MAKEINDEX_CMD_NAME = makeindex
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1144
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1145 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1146 # LaTeX documents. This may be useful for small projects and may help to
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1147 # save some trees in general.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1148
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1149 COMPACT_LATEX = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1150
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1151 # The PAPER_TYPE tag can be used to set the paper type that is used
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1152 # by the printer. Possible values are: a4, a4wide, letter, legal and
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1153 # executive. If left blank a4wide will be used.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1154
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1155 PAPER_TYPE = a4wide
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1156
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1157 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1158 # packages that should be included in the LaTeX output.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1159
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1160 EXTRA_PACKAGES =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1161
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1162 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1163 # the generated latex document. The header should contain everything until
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1164 # the first chapter. If it is left blank doxygen will generate a
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1165 # standard header. Notice: only use this tag if you know what you are doing!
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1166
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1167 LATEX_HEADER =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1168
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1169 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1170 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1171 # contain links (just like the HTML output) instead of page references
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1172 # This makes the output suitable for online browsing using a pdf viewer.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1173
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1174 PDF_HYPERLINKS = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1175
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1176 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1177 # plain latex in the generated Makefile. Set this option to YES to get a
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1178 # higher quality PDF documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1179
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1180 USE_PDFLATEX = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1181
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1182 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1183 # command to the generated LaTeX files. This will instruct LaTeX to keep
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1184 # running if errors occur, instead of asking the user for help.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1185 # This option is also used when generating formulas in HTML.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1186
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1187 LATEX_BATCHMODE = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1188
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1189 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1190 # include the index chapters (such as File Index, Compound Index, etc.)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1191 # in the output.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1192
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1193 LATEX_HIDE_INDICES = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1194
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1195 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1196 # source code with syntax highlighting in the LaTeX output.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1197 # Note that which sources are shown also depends on other settings
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1198 # such as SOURCE_BROWSER.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1199
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1200 LATEX_SOURCE_CODE = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1201
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1202 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1203 # configuration options related to the RTF output
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1204 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1205
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1206 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1207 # The RTF output is optimized for Word 97 and may not look very pretty with
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1208 # other RTF readers or editors.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1209
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1210 GENERATE_RTF = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1211
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1212 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1213 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1214 # put in front of it. If left blank `rtf' will be used as the default path.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1215
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1216 RTF_OUTPUT = rtf
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1217
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1218 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1219 # RTF documents. This may be useful for small projects and may help to
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1220 # save some trees in general.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1221
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1222 COMPACT_RTF = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1223
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1224 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1225 # will contain hyperlink fields. The RTF file will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1226 # contain links (just like the HTML output) instead of page references.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1227 # This makes the output suitable for online browsing using WORD or other
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1228 # programs which support those fields.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1229 # Note: wordpad (write) and others do not support links.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1230
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1231 RTF_HYPERLINKS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1232
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1233 # Load stylesheet definitions from file. Syntax is similar to doxygen's
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1234 # config file, i.e. a series of assignments. You only have to provide
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1235 # replacements, missing definitions are set to their default value.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1236
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1237 RTF_STYLESHEET_FILE =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1238
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1239 # Set optional variables used in the generation of an rtf document.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1240 # Syntax is similar to doxygen's config file.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1241
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1242 RTF_EXTENSIONS_FILE =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1243
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1244 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1245 # configuration options related to the man page output
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1246 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1247
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1248 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1249 # generate man pages
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1250
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1251 GENERATE_MAN = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1252
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1253 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1254 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1255 # put in front of it. If left blank `man' will be used as the default path.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1256
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1257 MAN_OUTPUT = man
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1258
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1259 # The MAN_EXTENSION tag determines the extension that is added to
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1260 # the generated man pages (default is the subroutine's section .3)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1261
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1262 MAN_EXTENSION = .3
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1263
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1264 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1265 # then it will generate one additional man file for each entity
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1266 # documented in the real man page(s). These additional files
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1267 # only source the real man page, but without them the man command
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1268 # would be unable to find the correct page. The default is NO.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1269
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1270 MAN_LINKS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1271
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1272 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1273 # configuration options related to the XML output
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1274 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1275
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1276 # If the GENERATE_XML tag is set to YES Doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1277 # generate an XML file that captures the structure of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1278 # the code including all documentation.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1279
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1280 GENERATE_XML = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1281
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1282 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1283 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1284 # put in front of it. If left blank `xml' will be used as the default path.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1285
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1286 XML_OUTPUT = xml
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1287
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1288 # The XML_SCHEMA tag can be used to specify an XML schema,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1289 # which can be used by a validating XML parser to check the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1290 # syntax of the XML files.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1291
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1292 XML_SCHEMA =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1293
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1294 # The XML_DTD tag can be used to specify an XML DTD,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1295 # which can be used by a validating XML parser to check the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1296 # syntax of the XML files.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1297
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1298 XML_DTD =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1299
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1300 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1301 # dump the program listings (including syntax highlighting
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1302 # and cross-referencing information) to the XML output. Note that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1303 # enabling this will significantly increase the size of the XML output.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1304
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1305 XML_PROGRAMLISTING = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1306
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1307 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1308 # configuration options for the AutoGen Definitions output
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1309 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1310
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1311 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1312 # generate an AutoGen Definitions (see autogen.sf.net) file
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1313 # that captures the structure of the code including all
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1314 # documentation. Note that this feature is still experimental
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1315 # and incomplete at the moment.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1316
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1317 GENERATE_AUTOGEN_DEF = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1318
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1319 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1320 # configuration options related to the Perl module output
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1321 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1322
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1323 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1324 # generate a Perl module file that captures the structure of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1325 # the code including all documentation. Note that this
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1326 # feature is still experimental and incomplete at the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1327 # moment.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1328
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1329 GENERATE_PERLMOD = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1330
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1331 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1332 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1333 # to generate PDF and DVI output from the Perl module output.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1334
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1335 PERLMOD_LATEX = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1336
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1337 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1338 # nicely formatted so it can be parsed by a human reader. This is useful
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1339 # if you want to understand what is going on. On the other hand, if this
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1340 # tag is set to NO the size of the Perl module output will be much smaller
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1341 # and Perl will parse it just the same.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1342
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1343 PERLMOD_PRETTY = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1344
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1345 # The names of the make variables in the generated doxyrules.make file
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1346 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1347 # This is useful so different doxyrules.make files included by the same
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1348 # Makefile don't overwrite each other's variables.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1349
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1350 PERLMOD_MAKEVAR_PREFIX =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1351
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1352 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1353 # Configuration options related to the preprocessor
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1354 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1355
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1356 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1357 # evaluate all C-preprocessor directives found in the sources and include
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1358 # files.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1359
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1360 ENABLE_PREPROCESSING = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1361
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1362 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1363 # names in the source code. If set to NO (the default) only conditional
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1364 # compilation will be performed. Macro expansion can be done in a controlled
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1365 # way by setting EXPAND_ONLY_PREDEF to YES.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1366
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1367 MACRO_EXPANSION = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1368
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1369 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1370 # then the macro expansion is limited to the macros specified with the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1371 # PREDEFINED and EXPAND_AS_DEFINED tags.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1372
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1373 EXPAND_ONLY_PREDEF = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1374
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1375 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1376 # in the INCLUDE_PATH (see below) will be search if a #include is found.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1377
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1378 SEARCH_INCLUDES = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1379
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1380 # The INCLUDE_PATH tag can be used to specify one or more directories that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1381 # contain include files that are not input files but should be processed by
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1382 # the preprocessor.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1383
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1384 INCLUDE_PATH =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1385
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1386 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1387 # patterns (like .h and .hpp) to filter out the header-files in the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1388 # directories. If left blank, the patterns specified with FILE_PATTERNS will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1389 # be used.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1390
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1391 INCLUDE_FILE_PATTERNS =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1392
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1393 # The PREDEFINED tag can be used to specify one or more macro names that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1394 # are defined before the preprocessor is started (similar to the -D option of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1395 # gcc). The argument of the tag is a list of macros of the form: name
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1396 # or name=definition (no spaces). If the definition and the = are
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1397 # omitted =1 is assumed. To prevent a macro definition from being
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1398 # undefined via #undef or recursively expanded use the := operator
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1399 # instead of the = operator.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1400
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1401 PREDEFINED =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1402
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1403 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1404 # this tag can be used to specify a list of macro names that should be expanded.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1405 # The macro definition that is found in the sources will be used.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1406 # Use the PREDEFINED tag if you want to use a different macro definition.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1407
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1408 EXPAND_AS_DEFINED =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1409
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1410 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1411 # doxygen's preprocessor will remove all function-like macros that are alone
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1412 # on a line, have an all uppercase name, and do not end with a semicolon. Such
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1413 # function macros are typically used for boiler-plate code, and will confuse
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1414 # the parser if not removed.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1415
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1416 SKIP_FUNCTION_MACROS = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1417
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1418 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1419 # Configuration::additions related to external references
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1420 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1421
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1422 # The TAGFILES option can be used to specify one or more tagfiles.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1423 # Optionally an initial location of the external documentation
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1424 # can be added for each tagfile. The format of a tag file without
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1425 # this location is as follows:
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1426 # TAGFILES = file1 file2 ...
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1427 # Adding location for the tag files is done as follows:
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1428 # TAGFILES = file1=loc1 "file2 = loc2" ...
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1429 # where "loc1" and "loc2" can be relative or absolute paths or
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1430 # URLs. If a location is present for each tag, the installdox tool
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1431 # does not have to be run to correct the links.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1432 # Note that each tag file must have a unique name
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1433 # (where the name does NOT include the path)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1434 # If a tag file is not located in the directory in which doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1435 # is run, you must also specify the path to the tagfile here.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1436
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1437 TAGFILES =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1438
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1439 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1440 # a tag file that is based on the input files it reads.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1441
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1442 GENERATE_TAGFILE =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1443
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1444 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1445 # in the class index. If set to NO only the inherited external classes
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1446 # will be listed.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1447
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1448 ALLEXTERNALS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1449
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1450 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1451 # in the modules index. If set to NO, only the current project's groups will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1452 # be listed.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1453
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1454 EXTERNAL_GROUPS = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1455
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1456 # The PERL_PATH should be the absolute path and name of the perl script
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1457 # interpreter (i.e. the result of `which perl').
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1458
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1459 PERL_PATH = /usr/bin/perl
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1460
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1461 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1462 # Configuration options related to the dot tool
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1463 #---------------------------------------------------------------------------
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1464
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1465 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1466 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1467 # or super classes. Setting the tag to NO turns the diagrams off. Note that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1468 # this option is superseded by the HAVE_DOT option below. This is only a
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1469 # fallback. It is recommended to install and use dot, since it yields more
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1470 # powerful graphs.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1471
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1472 CLASS_DIAGRAMS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1473
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1474 # You can define message sequence charts within doxygen comments using the \msc
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1475 # command. Doxygen will then run the mscgen tool (see
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1476 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1477 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1478 # the mscgen tool resides. If left empty the tool is assumed to be found in the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1479 # default search path.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1480
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1481 MSCGEN_PATH =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1482
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1483 # If set to YES, the inheritance and collaboration graphs will hide
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1484 # inheritance and usage relations if the target is undocumented
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1485 # or is not a class.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1486
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1487 HIDE_UNDOC_RELATIONS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1488
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1489 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1490 # available from the path. This tool is part of Graphviz, a graph visualization
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1491 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1492 # have no effect if this option is set to NO (the default)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1493
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1494 HAVE_DOT = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1495
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1496 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1497 # allowed to run in parallel. When set to 0 (the default) doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1498 # base this on the number of processors available in the system. You can set it
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1499 # explicitly to a value larger than 0 to get control over the balance
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1500 # between CPU load and processing speed.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1501
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1502 DOT_NUM_THREADS = 0
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1503
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1504 # By default doxygen will write a font called FreeSans.ttf to the output
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1505 # directory and reference it in all dot files that doxygen generates. This
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1506 # font does not include all possible unicode characters however, so when you need
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1507 # these (or just want a differently looking font) you can specify the font name
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1508 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1509 # which can be done by putting it in a standard location or by setting the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1510 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1511 # containing the font.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1512
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1513 DOT_FONTNAME = FreeSans.ttf
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1514
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1515 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1516 # The default size is 10pt.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1517
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1518 DOT_FONTSIZE = 10
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1519
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1520 # By default doxygen will tell dot to use the output directory to look for the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1521 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1522 # different font using DOT_FONTNAME you can set the path where dot
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1523 # can find it using this tag.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1524
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1525 DOT_FONTPATH =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1526
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1527 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1528 # will generate a graph for each documented class showing the direct and
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1529 # indirect inheritance relations. Setting this tag to YES will force the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1530 # the CLASS_DIAGRAMS tag to NO.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1531
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1532 CLASS_GRAPH = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1533
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1534 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1535 # will generate a graph for each documented class showing the direct and
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1536 # indirect implementation dependencies (inheritance, containment, and
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1537 # class references variables) of the class with other documented classes.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1538
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1539 COLLABORATION_GRAPH = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1540
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1541 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1542 # will generate a graph for groups, showing the direct groups dependencies
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1543
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1544 GROUP_GRAPHS = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1545
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1546 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1547 # collaboration diagrams in a style similar to the OMG's Unified Modeling
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1548 # Language.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1549
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1550 UML_LOOK = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1551
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1552 # If set to YES, the inheritance and collaboration graphs will show the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1553 # relations between templates and their instances.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1554
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1555 TEMPLATE_RELATIONS = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1556
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1557 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1558 # tags are set to YES then doxygen will generate a graph for each documented
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1559 # file showing the direct and indirect include dependencies of the file with
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1560 # other documented files.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1561
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1562 INCLUDE_GRAPH = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1563
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1564 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1565 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1566 # documented header file showing the documented files that directly or
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1567 # indirectly include this file.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1568
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1569 INCLUDED_BY_GRAPH = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1570
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1571 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1572 # doxygen will generate a call dependency graph for every global function
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1573 # or class method. Note that enabling this option will significantly increase
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1574 # the time of a run. So in most cases it will be better to enable call graphs
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1575 # for selected functions only using the \callgraph command.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1576
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1577 CALL_GRAPH = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1578
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1579 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1580 # doxygen will generate a caller dependency graph for every global function
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1581 # or class method. Note that enabling this option will significantly increase
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1582 # the time of a run. So in most cases it will be better to enable caller
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1583 # graphs for selected functions only using the \callergraph command.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1584
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1585 CALLER_GRAPH = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1586
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1587 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1588 # will graphical hierarchy of all classes instead of a textual one.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1589
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1590 GRAPHICAL_HIERARCHY = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1591
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1592 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1593 # then doxygen will show the dependencies a directory has on other directories
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1594 # in a graphical way. The dependency relations are determined by the #include
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1595 # relations between the files in the directories.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1596
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1597 DIRECTORY_GRAPH = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1598
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1599 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1600 # generated by dot. Possible values are png, jpg, or gif
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1601 # If left blank png will be used.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1602
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1603 DOT_IMAGE_FORMAT = png
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1604
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1605 # The tag DOT_PATH can be used to specify the path where the dot tool can be
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1606 # found. If left blank, it is assumed the dot tool can be found in the path.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1607
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1608 DOT_PATH =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1609
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1610 # The DOTFILE_DIRS tag can be used to specify one or more directories that
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1611 # contain dot files that are included in the documentation (see the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1612 # \dotfile command).
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1613
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1614 DOTFILE_DIRS =
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1615
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1616 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1617 # nodes that will be shown in the graph. If the number of nodes in a graph
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1618 # becomes larger than this value, doxygen will truncate the graph, which is
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1619 # visualized by representing a node as a red box. Note that doxygen if the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1620 # number of direct children of the root node in a graph is already larger than
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1621 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1622 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1623
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1624 DOT_GRAPH_MAX_NODES = 500
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1625
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1626 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1627 # graphs generated by dot. A depth value of 3 means that only nodes reachable
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1628 # from the root by following a path via at most 3 edges will be shown. Nodes
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1629 # that lay further from the root node will be omitted. Note that setting this
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1630 # option to 1 or 2 may greatly reduce the computation time needed for large
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1631 # code bases. Also note that the size of a graph can be further restricted by
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1632 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1633
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1634 MAX_DOT_GRAPH_DEPTH = 0
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1635
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1636 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1637 # background. This is disabled by default, because dot on Windows does not
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1638 # seem to support this out of the box. Warning: Depending on the platform used,
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1639 # enabling this option may lead to badly anti-aliased labels on the edges of
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1640 # a graph (i.e. they become hard to read).
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1641
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1642 DOT_TRANSPARENT = NO
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1643
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1644 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1645 # files in one run (i.e. multiple -o and -T options on the command line). This
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1646 # makes dot run faster, but since only newer versions of dot (>1.8.10)
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1647 # support this, this feature is disabled by default.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1648
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1649 DOT_MULTI_TARGETS = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1650
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1651 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1652 # generate a legend page explaining the meaning of the various boxes and
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1653 # arrows in the dot generated graphs.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1654
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1655 GENERATE_LEGEND = YES
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1656
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1657 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1658 # remove the intermediate dot files that are used to generate
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1659 # the various graphs.
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1660
6d843cdd0bed added doxygen script and config file Lukas Stadler <lukas.stadler@jku.at> parents: diff changeset	1661 DOT_CLEANUP = YES

Mercurial > hg > graal-compiler

annotate doc/graal.doxy @ 2858:a97605b0489b