repo/traffic-intelligence: Doxyfile annotate

annotate Doxyfile @ 1211:a095d4fbb2ea

work in progress

author	Nicolas Saunier <nicolas.saunier@polymtl.ca>
date	Tue, 02 May 2023 07:12:26 -0400
parents	fea680fb03ee
children

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

Mercurial Hosting > traffic-intelligence

annotate Doxyfile @ 1211:a095d4fbb2ea