projects/ldc: Doxyfile annotate

annotate Doxyfile @ 1578:1dee66f6ec0b

Removed a chunk of code in favour of a shorter and more portable method

author	Robert Clipsham <robert@octarineparrot.com>
date	Tue, 08 Sep 2009 11:21:30 +0100
parents	79758fd2f48a
children

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

Mercurial > projects > ldc

annotate Doxyfile @ 1578:1dee66f6ec0b