archived/louis/perso/liblxcstats: Doxyfile.in annotate

annotate Doxyfile.in @ 12:dbf24a82f625 default tip

Fix doxygen comments and add a Doxyfile

author	Louis Opter <kalessin@kalessin.fr>
date	Fri, 07 Jan 2011 21:49:31 +0100
parents
children

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

Mercurial > archived > louis > perso > liblxcstats

annotate Doxyfile.in @ 12:dbf24a82f625 default tip