orthanc: OrthancServer/Resources/Orthanc.doxygen annotate

annotate OrthancServer/Resources/Orthanc.doxygen @ 4072:3dda0d73193c framework

fix doxygen, more tolerant WebServiceParameters::SetUrl()

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Mon, 15 Jun 2020 16:28:03 +0200
parents	d25f4c0fa160
children	19a2f1d2b816

rev	line source
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1 # Doxyfile 1.8.7
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3 # This file describes the settings to be used by the documentation system
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4 # doxygen (www.doxygen.org) for a project.
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	5 #
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	6 # All text after a double hash (##) is considered a comment and is placed in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	7 # front of the TAG it is preceding.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	8 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	9 # All text after a single hash (#) is considered a comment and will be ignored.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	10 # The format is:
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	11 # TAG = value [value, ...]
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	12 # For lists, items can also be appended using:
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	13 # TAG += value [value, ...]
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	14 # Values that contain spaces should be placed between quotes (\" \").
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	15
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	16 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	17 # Project related configuration options
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	18 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	19
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	20 # This tag specifies the encoding used for all characters in the config file
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	21 # that follow. The default is UTF-8 which is also the encoding used for all text
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	22 # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	23 # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	24 # for the list of possible encodings.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	25 # The default value is: UTF-8.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	26
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	27 DOXYFILE_ENCODING = UTF-8
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	28
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	29 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	30 # double-quotes, unless you are using Doxywizard) that should identify the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	31 # project for which the documentation is generated. This name is used in the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	32 # title of most generated pages and in a few other places.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	33 # The default value is: My Project.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	34
64 71c4a4abe90b renaming of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 58 diff changeset	35 PROJECT_NAME = Orthanc
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	36
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	38 # could be handy for archiving the generated documentation or if some version
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	39 # control system is used.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	40
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	41 PROJECT_NUMBER =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	42
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	43 # Using the PROJECT_BRIEF tag one can provide an optional one line description
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	44 # for a project that appears at the top of each page and should give viewer a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	45 # quick idea about the purpose of the project. Keep the description short.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	46
573 8fb9867d8089 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 64 diff changeset	47 PROJECT_BRIEF = "Internal documentation of Orthanc"
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	48
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	49 # With the PROJECT_LOGO tag one can specify an logo or icon that is included in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	50 # the documentation. The maximum height of the logo should not exceed 55 pixels
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	51 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	52 # to the output directory.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	53
4072 3dda0d73193c fix doxygen, more tolerant WebServiceParameters::SetUrl() Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	54 PROJECT_LOGO = @CMAKE_SOURCE_DIR@/OrthancServer/Resources/OrthancLogoDocumentation.png
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	55
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	56 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	57 # into which the generated documentation will be written. If a relative path is
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	58 # entered, it will be relative to the location where doxygen was started. If
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	59 # left blank the current directory will be used.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	60
573 8fb9867d8089 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 64 diff changeset	61 OUTPUT_DIRECTORY = OrthancInternalDocumentation
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	62
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	63 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	64 # directories (in 2 levels) under the output directory of each output format and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	65 # will distribute the generated files over these directories. Enabling this
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	66 # option can be useful when feeding doxygen a huge amount of source files, where
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	67 # putting all generated files in the same directory would otherwise causes
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	68 # performance problems for the file system.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	69 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	70
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	71 CREATE_SUBDIRS = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	72
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	73 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	74 # characters to appear in the names of generated files. If set to NO, non-ASCII
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	75 # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	76 # U+3044.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	77 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	78
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	79 ALLOW_UNICODE_NAMES = NO
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	80
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	81 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	82 # documentation generated by doxygen is written. Doxygen will use this
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	83 # information to generate all constant output in the proper language.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	84 # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	85 # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	86 # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	87 # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	88 # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	89 # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	90 # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	91 # Ukrainian and Vietnamese.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	92 # The default value is: English.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	93
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	94 OUTPUT_LANGUAGE = English
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	95
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	96 # If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	97 # descriptions after the members that are listed in the file and class
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	98 # documentation (similar to Javadoc). Set to NO to disable this.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	99 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	100
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	101 BRIEF_MEMBER_DESC = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	102
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	103 # If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	104 # description of a member or function before the detailed description
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	105 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	106 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	107 # brief descriptions will be completely suppressed.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	108 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	109
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	110 REPEAT_BRIEF = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	111
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	112 # This tag implements a quasi-intelligent brief description abbreviator that is
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	113 # used to form the text in various listings. Each string in this list, if found
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	114 # as the leading text of the brief description, will be stripped from the text
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	115 # and the result, after processing the whole list, is used as the annotated
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	116 # text. Otherwise, the brief description is used as-is. If left blank, the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	117 # following values are used ($name is automatically replaced with the name of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	118 # the entity):The $name class, The $name widget, The $name file, is, provides,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	119 # specifies, contains, represents, a, an and the.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	120
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	121 ABBREVIATE_BRIEF =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	122
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	123 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	124 # doxygen will generate a detailed section even if there is only a brief
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	125 # description.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	126 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	127
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	128 ALWAYS_DETAILED_SEC = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	129
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	130 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	131 # inherited members of a class in the documentation of that class as if those
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	132 # members were ordinary class members. Constructors, destructors and assignment
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	133 # operators of the base classes will not be shown.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	134 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	135
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	136 INLINE_INHERITED_MEMB = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	137
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	138 # If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	139 # before files name in the file list and in the header files. If set to NO the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	140 # shortest path that makes the file name unique will be used
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	141 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	142
593 9d2592c08919 documentation completed Sebastien Jodogne <s.jodogne@gmail.com> parents: 573 diff changeset	143 FULL_PATH_NAMES = NO
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	144
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	145 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	146 # Stripping is only done if one of the specified strings matches the left-hand
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	147 # part of the path. The tag can be used to show relative paths in the file list.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	148 # If left blank the directory from which doxygen is run is used as the path to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	149 # strip.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	150 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	151 # Note that you can specify absolute paths here, but also relative paths, which
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	152 # will be relative from the directory where doxygen is started.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	153 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	154
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	155 STRIP_FROM_PATH =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	156
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	157 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	158 # path mentioned in the documentation of a class, which tells the reader which
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	159 # header file to include in order to use a class. If left blank only the name of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	160 # the header file containing the class definition is used. Otherwise one should
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	161 # specify the list of include paths that are normally passed to the compiler
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	162 # using the -I flag.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	163
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	164 STRIP_FROM_INC_PATH =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	165
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	166 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	167 # less readable) file names. This can be useful is your file systems doesn't
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	168 # support long names like on DOS, Mac, or CD-ROM.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	169 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	170
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	171 SHORT_NAMES = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	172
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	173 # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	174 # first line (until the first dot) of a Javadoc-style comment as the brief
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	175 # description. If set to NO, the Javadoc-style will behave just like regular Qt-
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	176 # style comments (thus requiring an explicit @brief command for a brief
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	177 # description.)
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	178 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	179
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	180 JAVADOC_AUTOBRIEF = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	181
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	182 # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	183 # line (until the first dot) of a Qt-style comment as the brief description. If
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	184 # set to NO, the Qt-style will behave just like regular Qt-style comments (thus
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	185 # requiring an explicit \brief command for a brief description.)
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	186 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	187
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	188 QT_AUTOBRIEF = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	189
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	190 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	191 # multi-line C++ special comment block (i.e. a block of //! or /// comments) as
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	192 # a brief description. This used to be the default behavior. The new default is
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	193 # to treat a multi-line C++ comment block as a detailed description. Set this
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	194 # tag to YES if you prefer the old behavior instead.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	195 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	196 # Note that setting this tag to YES also means that rational rose comments are
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	197 # not recognized any more.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	198 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	199
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	200 MULTILINE_CPP_IS_BRIEF = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	201
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	202 # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	203 # documentation from any documented member that it re-implements.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	204 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	205
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	206 INHERIT_DOCS = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	207
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	208 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	209 # new page for each member. If set to NO, the documentation of a member will be
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	210 # part of the file/class/namespace that contains it.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	211 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	212
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	213 SEPARATE_MEMBER_PAGES = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	214
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	215 # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	216 # uses this value to replace tabs by spaces in code fragments.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	217 # Minimum value: 1, maximum value: 16, default value: 4.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	218
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	219 TAB_SIZE = 8
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	220
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	221 # This tag can be used to specify a number of aliases that act as commands in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	222 # the documentation. An alias has the form:
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	223 # name=value
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	224 # For example adding
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	225 # "sideeffect=@par Side Effects:\n"
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	226 # will allow you to put the command \sideeffect (or @sideeffect) in the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	227 # documentation, which will result in a user-defined paragraph with heading
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	228 # "Side Effects:". You can put \n's in the value part of an alias to insert
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	229 # newlines.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	230
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	231 ALIASES =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	232
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	233 # This tag can be used to specify a number of word-keyword mappings (TCL only).
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	234 # A mapping has the form "name=value". For example adding "class=itcl::class"
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	235 # will allow you to use the command class in the itcl::class meaning.
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	236
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	237 TCL_SUBST =
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	238
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	239 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	240 # only. Doxygen will then generate output that is more tailored for C. For
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	241 # instance, some of the names that are used will be different. The list of all
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	242 # members will be omitted, etc.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	243 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	244
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	245 OPTIMIZE_OUTPUT_FOR_C = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	246
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	247 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	248 # Python sources only. Doxygen will then generate output that is more tailored
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	249 # for that language. For instance, namespaces will be presented as packages,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	250 # qualified scopes will look different, etc.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	251 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	252
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	253 OPTIMIZE_OUTPUT_JAVA = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	254
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	255 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	256 # sources. Doxygen will then generate output that is tailored for Fortran.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	257 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	258
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	259 OPTIMIZE_FOR_FORTRAN = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	260
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	261 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	262 # sources. Doxygen will then generate output that is tailored for VHDL.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	263 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	264
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	265 OPTIMIZE_OUTPUT_VHDL = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	266
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	267 # Doxygen selects the parser to use depending on the extension of the files it
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	268 # parses. With this tag you can assign which parser to use for a given
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	269 # extension. Doxygen has a built-in mapping, but you can override or extend it
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	270 # using this tag. The format is ext=language, where ext is a file extension, and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	271 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	272 # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	273 # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	274 # Fortran. In the later case the parser tries to guess whether the code is fixed
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	275 # or free formatted code, this is the default for Fortran type files), VHDL. For
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	276 # instance to make doxygen treat .inc files as Fortran files (default is PHP),
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	277 # and .f files as C (default is Fortran), use: inc=Fortran f=C.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	278 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	279 # Note For files without extension you can use no_extension as a placeholder.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	280 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	281 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	282 # the files are not read by doxygen.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	283
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	284 EXTENSION_MAPPING =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	285
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	286 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	287 # according to the Markdown format, which allows for more readable
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	288 # documentation. See http://daringfireball.net/projects/markdown/ for details.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	289 # The output of markdown processing is further processed by doxygen, so you can
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	290 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	291 # case of backward compatibilities issues.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	292 # The default value is: YES.
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	293
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	294 MARKDOWN_SUPPORT = YES
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	295
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	296 # When enabled doxygen tries to link words that correspond to documented
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	297 # classes, or namespaces to their corresponding documentation. Such a link can
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	298 # be prevented in individual cases by by putting a % sign in front of the word
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	299 # or globally by setting AUTOLINK_SUPPORT to NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	300 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	301
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	302 AUTOLINK_SUPPORT = YES
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	303
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	304 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	305 # to include (a tag file for) the STL sources as input, then you should set this
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	306 # tag to YES in order to let doxygen match functions declarations and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	307 # definitions whose arguments contain STL classes (e.g. func(std::string);
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	308 # versus func(std::string) {}). This also make the inheritance and collaboration
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	309 # diagrams that involve STL classes more complete and accurate.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	310 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	311
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	312 BUILTIN_STL_SUPPORT = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	313
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	314 # If you use Microsoft's C++/CLI language, you should set this option to YES to
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	315 # enable parsing support.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	316 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	317
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	318 CPP_CLI_SUPPORT = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	319
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	320 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	321 # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	322 # will parse them like normal C++ but will assume all classes use public instead
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	323 # of private inheritance when no explicit protection keyword is present.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	324 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	325
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	326 SIP_SUPPORT = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	327
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	328 # For Microsoft's IDL there are propget and propput attributes to indicate
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	329 # getter and setter methods for a property. Setting this option to YES will make
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	330 # doxygen to replace the get and set methods by a property in the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	331 # This will only work if the methods are indeed getting or setting a simple
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	332 # type. If this is not the case, or you want to show the methods anyway, you
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	333 # should set this option to NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	334 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	335
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	336 IDL_PROPERTY_SUPPORT = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	337
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	338 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	339 # tag is set to YES, then doxygen will reuse the documentation of the first
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	340 # member in the group (if any) for the other members of the group. By default
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	341 # all members of a group must be documented explicitly.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	342 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	343
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	344 DISTRIBUTE_GROUP_DOC = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	345
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	346 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	347 # (for instance a group of public functions) to be put as a subgroup of that
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	348 # type (e.g. under the Public Functions section). Set it to NO to prevent
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	349 # subgrouping. Alternatively, this can be done per class using the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	350 # \nosubgrouping command.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	351 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	352
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	353 SUBGROUPING = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	354
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	355 # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	356 # are shown inside the group in which they are included (e.g. using \ingroup)
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	357 # instead of on a separate page (for HTML and Man pages) or section (for LaTeX
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	358 # and RTF).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	359 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	360 # Note that this feature does not work in combination with
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	361 # SEPARATE_MEMBER_PAGES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	362 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	363
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	364 INLINE_GROUPED_CLASSES = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	365
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	366 # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	367 # with only public data fields or simple typedef fields will be shown inline in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	368 # the documentation of the scope in which they are defined (i.e. file,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	369 # namespace, or group documentation), provided this scope is documented. If set
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	370 # to NO, structs, classes, and unions are shown on a separate page (for HTML and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	371 # Man pages) or section (for LaTeX and RTF).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	372 # The default value is: NO.
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	373
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	374 INLINE_SIMPLE_STRUCTS = NO
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	375
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	376 # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	377 # enum is documented as struct, union, or enum with the name of the typedef. So
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	378 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	379 # with name TypeT. When disabled the typedef will appear as a member of a file,
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	380 # namespace, or class. And the struct will be named TypeS. This can typically be
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	381 # useful for C code in case the coding convention dictates that all compound
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	382 # types are typedef'ed and only the typedef is referenced, never the tag name.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	383 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	384
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	385 TYPEDEF_HIDES_STRUCT = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	386
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	387 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	388 # cache is used to resolve symbols given their name and scope. Since this can be
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	389 # an expensive process and often the same symbol appears multiple times in the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	390 # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	391 # doxygen will become slower. If the cache is too large, memory is wasted. The
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	392 # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	393 # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	394 # symbols. At the end of a run doxygen will report the cache usage and suggest
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	395 # the optimal cache size from a speed point of view.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	396 # Minimum value: 0, maximum value: 9, default value: 0.
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	397
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	398 LOOKUP_CACHE_SIZE = 0
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	399
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	400 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	401 # Build related configuration options
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	402 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	403
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	404 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	405 # documentation are documented, even if no documentation was available. Private
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	406 # class members and static file members will be hidden unless the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	407 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	408 # Note: This will also disable the warnings about undocumented members that are
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	409 # normally produced when WARNINGS is set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	410 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	411
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	412 EXTRACT_ALL = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	413
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	414 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	415 # be included in the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	416 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	417
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	418 EXTRACT_PRIVATE = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	419
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	420 # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	421 # scope will be included in the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	422 # The default value is: NO.
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	423
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	424 EXTRACT_PACKAGE = NO
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	425
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	426 # If the EXTRACT_STATIC tag is set to YES all static members of a file will be
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	427 # included in the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	428 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	429
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	430 EXTRACT_STATIC = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	431
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	432 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	433 # locally in source files will be included in the documentation. If set to NO
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	434 # only classes defined in header files are included. Does not have any effect
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	435 # for Java sources.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	436 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	437
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	438 EXTRACT_LOCAL_CLASSES = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	439
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	440 # This flag is only useful for Objective-C code. When set to YES local methods,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	441 # which are defined in the implementation section but not in the interface are
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	442 # included in the documentation. If set to NO only methods in the interface are
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	443 # included.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	444 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	445
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	446 EXTRACT_LOCAL_METHODS = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	447
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	448 # If this flag is set to YES, the members of anonymous namespaces will be
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	449 # extracted and appear in the documentation as a namespace called
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	450 # 'anonymous_namespace{file}', where file will be replaced with the base name of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	451 # the file that contains the anonymous namespace. By default anonymous namespace
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	452 # are hidden.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	453 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	454
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	455 EXTRACT_ANON_NSPACES = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	456
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	457 # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	458 # undocumented members inside documented classes or files. If set to NO these
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	459 # members will be included in the various overviews, but no documentation
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	460 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	461 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	462
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	463 HIDE_UNDOC_MEMBERS = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	464
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	465 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	466 # undocumented classes that are normally visible in the class hierarchy. If set
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	467 # to NO these classes will be included in the various overviews. This option has
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	468 # no effect if EXTRACT_ALL is enabled.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	469 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	470
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	471 HIDE_UNDOC_CLASSES = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	472
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	473 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	474 # (class\|struct\|union) declarations. If set to NO these declarations will be
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	475 # included in the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	476 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	477
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	478 HIDE_FRIEND_COMPOUNDS = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	479
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	480 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	481 # documentation blocks found inside the body of a function. If set to NO these
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	482 # blocks will be appended to the function's detailed documentation block.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	483 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	484
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	485 HIDE_IN_BODY_DOCS = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	486
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	487 # The INTERNAL_DOCS tag determines if documentation that is typed after a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	488 # \internal command is included. If the tag is set to NO then the documentation
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	489 # will be excluded. Set it to YES to include the internal documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	490 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	491
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	492 INTERNAL_DOCS = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	493
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	494 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	495 # names in lower-case letters. If set to YES upper-case letters are also
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	496 # allowed. This is useful if you have classes or files whose names only differ
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	497 # in case and if your file system supports case sensitive file names. Windows
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	498 # and Mac users are advised to set this option to NO.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	499 # The default value is: system dependent.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	500
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	501 CASE_SENSE_NAMES = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	502
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	503 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	504 # their full class and namespace scopes in the documentation. If set to YES the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	505 # scope will be hidden.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	506 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	507
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	508 HIDE_SCOPE_NAMES = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	509
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	510 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	511 # the files that are included by a file in the documentation of that file.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	512 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	513
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	514 SHOW_INCLUDE_FILES = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	515
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	516 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	517 # grouped member an include statement to the documentation, telling the reader
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	518 # which file to include in order to use the member.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	519 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	520
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	521 SHOW_GROUPED_MEMB_INC = NO
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	522
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	523 # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	524 # files with double quotes in the documentation rather than with sharp brackets.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	525 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	526
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	527 FORCE_LOCAL_INCLUDES = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	528
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	529 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	530 # documentation for inline members.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	531 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	532
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	533 INLINE_INFO = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	534
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	535 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	536 # (detailed) documentation of file and class members alphabetically by member
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	537 # name. If set to NO the members will appear in declaration order.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	538 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	539
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	540 SORT_MEMBER_DOCS = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	541
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	542 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	543 # descriptions of file, namespace and class members alphabetically by member
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	544 # name. If set to NO the members will appear in declaration order. Note that
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	545 # this will also influence the order of the classes in the class list.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	546 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	547
3937 41eec97c23ef documented new primitives in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 2224 diff changeset	548 SORT_BRIEF_DOCS = YES
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	549
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	550 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	551 # (brief and detailed) documentation of class members so that constructors and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	552 # destructors are listed first. If set to NO the constructors will appear in the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	553 # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	554 # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	555 # member documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	556 # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	557 # detailed member documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	558 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	559
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	560 SORT_MEMBERS_CTORS_1ST = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	561
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	562 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	563 # of group names into alphabetical order. If set to NO the group names will
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	564 # appear in their defined order.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	565 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	566
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	567 SORT_GROUP_NAMES = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	568
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	569 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	570 # fully-qualified names, including namespaces. If set to NO, the class list will
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	571 # be sorted only by class name, not including the namespace part.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	572 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	573 # Note: This option applies only to the class list, not to the alphabetical
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	574 # list.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	575 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	576
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	577 SORT_BY_SCOPE_NAME = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	578
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	579 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	580 # type resolution of all parameters of a function it will reject a match between
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	581 # the prototype and the implementation of a member function even if there is
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	582 # only one candidate or it is obvious which candidate to choose by doing a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	583 # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	584 # accept a match between prototype and implementation in such cases.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	585 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	586
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	587 STRICT_PROTO_MATCHING = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	588
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	589 # The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	590 # todo list. This list is created by putting \todo commands in the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	591 # documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	592 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	593
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	594 GENERATE_TODOLIST = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	595
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	596 # The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	597 # test list. This list is created by putting \test commands in the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	598 # documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	599 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	600
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	601 GENERATE_TESTLIST = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	602
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	603 # The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	604 # list. This list is created by putting \bug commands in the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	605 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	606
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	607 GENERATE_BUGLIST = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	608
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	609 # The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	610 # the deprecated list. This list is created by putting \deprecated commands in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	611 # the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	612 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	613
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	614 GENERATE_DEPRECATEDLIST= YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	615
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	616 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	617 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	618 # ... \endcond blocks.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	619
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	620 ENABLED_SECTIONS =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	621
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	622 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	623 # initial value of a variable or macro / define can have for it to appear in the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	624 # documentation. If the initializer consists of more lines than specified here
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	625 # it will be hidden. Use a value of 0 to hide initializers completely. The
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	626 # appearance of the value of individual variables and macros / defines can be
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	627 # controlled using \showinitializer or \hideinitializer command in the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	628 # documentation regardless of this setting.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	629 # Minimum value: 0, maximum value: 10000, default value: 30.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	630
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	631 MAX_INITIALIZER_LINES = 30
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	632
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	633 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	634 # the bottom of the documentation of classes and structs. If set to YES the list
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	635 # will mention the files that were used to generate the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	636 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	637
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	638 SHOW_USED_FILES = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	639
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	640 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	641 # will remove the Files entry from the Quick Index and from the Folder Tree View
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	642 # (if specified).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	643 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	644
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	645 SHOW_FILES = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	646
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	647 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	648 # page. This will remove the Namespaces entry from the Quick Index and from the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	649 # Folder Tree View (if specified).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	650 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	651
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	652 SHOW_NAMESPACES = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	653
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	654 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	655 # doxygen should invoke to get the current version for each file (typically from
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	656 # the version control system). Doxygen will invoke the program by executing (via
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	657 # popen()) the command command input-file, where command is the value of the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	658 # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	659 # by doxygen. Whatever the program writes to standard output is used as the file
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	660 # version. For an example see the documentation.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	661
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	662 FILE_VERSION_FILTER =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	663
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	664 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	665 # by doxygen. The layout file controls the global structure of the generated
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	666 # output files in an output format independent way. To create the layout file
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	667 # that represents doxygen's defaults, run doxygen with the -l option. You can
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	668 # optionally specify a file name after the option, if omitted DoxygenLayout.xml
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	669 # will be used as the name of the layout file.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	670 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	671 # Note that if you run doxygen from a directory containing a file called
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	672 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	673 # tag is left empty.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	674
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	675 LAYOUT_FILE =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	676
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	677 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	678 # the reference definitions. This must be a list of .bib files. The .bib
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	679 # extension is automatically appended if omitted. This requires the bibtex tool
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	680 # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	681 # For LaTeX the style of the bibliography can be controlled using
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	682 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	683 # search path. Do not use file names with spaces, bibtex cannot handle them. See
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	684 # also \cite for info how to create references.
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	685
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	686 CITE_BIB_FILES =
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	687
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	688 #---------------------------------------------------------------------------
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	689 # Configuration options related to warning and progress messages
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	690 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	691
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	692 # The QUIET tag can be used to turn on/off the messages that are generated to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	693 # standard output by doxygen. If QUIET is set to YES this implies that the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	694 # messages are off.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	695 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	696
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	697 QUIET = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	698
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	699 # The WARNINGS tag can be used to turn on/off the warning messages that are
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	700 # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	701 # this implies that the warnings are on.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	702 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	703 # Tip: Turn warnings on while writing the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	704 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	705
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	706 WARNINGS = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	707
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	708 # If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	709 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	710 # will automatically be disabled.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	711 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	712
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	713 WARN_IF_UNDOCUMENTED = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	714
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	715 # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	716 # potential errors in the documentation, such as not documenting some parameters
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	717 # in a documented function, or documenting parameters that don't exist or using
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	718 # markup commands wrongly.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	719 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	720
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	721 WARN_IF_DOC_ERROR = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	722
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	723 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	724 # are documented, but have no documentation for their parameters or return
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	725 # value. If set to NO doxygen will only warn about wrong or incomplete parameter
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	726 # documentation, but not about the absence of documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	727 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	728
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	729 WARN_NO_PARAMDOC = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	730
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	731 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	732 # can produce. The string should contain the $file, $line, and $text tags, which
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	733 # will be replaced by the file and line number from which the warning originated
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	734 # and the warning text. Optionally the format may contain $version, which will
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	735 # be replaced by the version of the file (if it could be obtained via
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	736 # FILE_VERSION_FILTER)
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	737 # The default value is: $file:$line: $text.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	738
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	739 WARN_FORMAT = "$file:$line: $text"
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	740
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	741 # The WARN_LOGFILE tag can be used to specify a file to which warning and error
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	742 # messages should be written. If left blank the output is written to standard
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	743 # error (stderr).
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	744
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	745 WARN_LOGFILE =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	746
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	747 #---------------------------------------------------------------------------
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	748 # Configuration options related to the input files
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	749 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	750
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	751 # The INPUT tag is used to specify the files and/or directories that contain
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	752 # documented source files. You may enter file names like myfile.cpp or
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	753 # directories like /usr/src/myproject. Separate the files or directories with
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	754 # spaces.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	755 # Note: If this tag is empty the current directory is searched.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	756
4072 3dda0d73193c fix doxygen, more tolerant WebServiceParameters::SetUrl() Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	757 INPUT = @CMAKE_SOURCE_DIR@/OrthancFramework/Sources \
3dda0d73193c fix doxygen, more tolerant WebServiceParameters::SetUrl() Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	758 @CMAKE_SOURCE_DIR@/OrthancServer/Sources
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	759
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	760 # This tag can be used to specify the character encoding of the source files
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	761 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	762 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	763 # documentation (see: http://www.gnu.org/software/libiconv) for the list of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	764 # possible encodings.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	765 # The default value is: UTF-8.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	766
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	767 INPUT_ENCODING = UTF-8
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	768
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	769 # If the value of the INPUT tag contains directories, you can use the
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	770 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	771 # *.h) to filter out the source-files in the directories. If left blank the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	772 # following patterns are tested:.c, .cc, .cxx, .cpp, .c++, .java, *.ii,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	773 # .ixx, .ipp, .i++, .inl, .idl, .ddl, .odl, .h, .hh, .hxx, *.hpp,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	774 # .h++, .cs, .d, .php, .php4, .php5, .phtml, .inc, .m, .markdown,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	775 # .md, .mm, .dox, .py, .f90, .f, .for, .tcl, .vhd, .vhdl, *.ucf,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	776 # .qsf, .as and *.js.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	777
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	778 FILE_PATTERNS = *.h
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	779
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	780 # The RECURSIVE tag can be used to specify whether or not subdirectories should
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	781 # be searched for input files as well.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	782 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	783
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	784 RECURSIVE = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	785
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	786 # The EXCLUDE tag can be used to specify files and/or directories that should be
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	787 # excluded from the INPUT source files. This way you can easily exclude a
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	788 # subdirectory from a directory tree whose root is specified with the INPUT tag.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	789 #
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	790 # Note that relative paths are relative to the directory from which doxygen is
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	791 # run.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	792
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	793 EXCLUDE =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	794
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	795 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	796 # directories that are symbolic links (a Unix file system feature) are excluded
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	797 # from the input.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	798 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	799
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	800 EXCLUDE_SYMLINKS = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	801
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	802 # If the value of the INPUT tag contains directories, you can use the
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	803 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	804 # certain files from those directories.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	805 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	806 # Note that the wildcards are matched against the file with absolute path, so to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	807 # exclude all test directories for example use the pattern /test/
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	808
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	809 EXCLUDE_PATTERNS =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	810
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	811 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	812 # (namespaces, classes, functions, etc.) that should be excluded from the
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	813 # output. The symbol name can be a fully qualified name, a word, or if the
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	814 # wildcard * is used, a substring. Examples: ANamespace, AClass,
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	815 # AClass::ANamespace, ANamespace::*Test
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	816 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	817 # Note that the wildcards are matched against the file with absolute path, so to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	818 # exclude all test directories use the pattern /test/
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	819
64 71c4a4abe90b renaming of resources Sebastien Jodogne <s.jodogne@gmail.com> parents: 58 diff changeset	820 EXCLUDE_SYMBOLS = Orthanc::Internals
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	821
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	822 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	823 # that contain example code fragments that are included (see the \include
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	824 # command).
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	825
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	826 EXAMPLE_PATH =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	827
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	828 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	829 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	830 # *.h) to filter out the source-files in the directories. If left blank all
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	831 # files are included.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	832
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	833 EXAMPLE_PATTERNS =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	834
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	835 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	836 # searched for input files to be used with the \include or \dontinclude commands
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	837 # irrespective of the value of the RECURSIVE tag.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	838 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	839
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	840 EXAMPLE_RECURSIVE = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	841
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	842 # The IMAGE_PATH tag can be used to specify one or more files or directories
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	843 # that contain images that are to be included in the documentation (see the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	844 # \image command).
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	845
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	846 IMAGE_PATH =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	847
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	848 # The INPUT_FILTER tag can be used to specify a program that doxygen should
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	849 # invoke to filter for each input file. Doxygen will invoke the filter program
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	850 # by executing (via popen()) the command:
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	851 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	852 # <filter> <input-file>
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	853 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	854 # where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	855 # name of an input file. Doxygen will then use the output that the filter
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	856 # program writes to standard output. If FILTER_PATTERNS is specified, this tag
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	857 # will be ignored.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	858 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	859 # Note that the filter must not add or remove lines; it is applied before the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	860 # code is scanned, but not when the output code is generated. If lines are added
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	861 # or removed, the anchors will not be placed correctly.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	862
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	863 INPUT_FILTER =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	864
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	865 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	866 # basis. Doxygen will compare the file name with each pattern and apply the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	867 # filter if there is a match. The filters are a list of the form: pattern=filter
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	868 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	869 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	870 # patterns match the file name, INPUT_FILTER is applied.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	871
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	872 FILTER_PATTERNS =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	873
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	874 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	875 # INPUT_FILTER ) will also be used to filter the input files that are used for
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	876 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	877 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	878
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	879 FILTER_SOURCE_FILES = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	880
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	881 # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	882 # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	883 # it is also possible to disable source filtering for a specific pattern using
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	884 # *.ext= (so without naming a filter).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	885 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	886
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	887 FILTER_SOURCE_PATTERNS =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	888
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	889 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	890 # is part of the input, its contents will be placed on the main page
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	891 # (index.html). This can be useful if you have a project on for instance GitHub
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	892 # and want to reuse the introduction page also for the doxygen output.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	893
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	894 USE_MDFILE_AS_MAINPAGE =
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	895
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	896 #---------------------------------------------------------------------------
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	897 # Configuration options related to source browsing
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	898 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	899
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	900 # If the SOURCE_BROWSER tag is set to YES then a list of source files will be
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	901 # generated. Documented entities will be cross-referenced with these sources.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	902 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	903 # Note: To get rid of all source code in the generated output, make sure that
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	904 # also VERBATIM_HEADERS is set to NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	905 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	906
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	907 SOURCE_BROWSER = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	908
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	909 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	910 # classes and enums directly into the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	911 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	912
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	913 INLINE_SOURCES = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	914
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	915 # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	916 # special comment blocks from generated source code fragments. Normal C, C++ and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	917 # Fortran comments will always remain visible.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	918 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	919
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	920 STRIP_CODE_COMMENTS = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	921
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	922 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	923 # function all documented functions referencing it will be listed.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	924 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	925
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	926 REFERENCED_BY_RELATION = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	927
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	928 # If the REFERENCES_RELATION tag is set to YES then for each documented function
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	929 # all documented entities called/used by that function will be listed.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	930 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	931
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	932 REFERENCES_RELATION = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	933
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	934 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	935 # to YES, then the hyperlinks from functions in REFERENCES_RELATION and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	936 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	937 # link to the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	938 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	939
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	940 REFERENCES_LINK_SOURCE = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	941
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	942 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	943 # source code will show a tooltip with additional information such as prototype,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	944 # brief description and links to the definition and documentation. Since this
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	945 # will make the HTML file larger and loading of large files a bit slower, you
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	946 # can opt to disable this feature.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	947 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	948 # This tag requires that the tag SOURCE_BROWSER is set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	949
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	950 SOURCE_TOOLTIPS = YES
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	951
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	952 # If the USE_HTAGS tag is set to YES then the references to source code will
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	953 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	954 # source browser. The htags tool is part of GNU's global source tagging system
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	955 # (see http://www.gnu.org/software/global/global.html). You will need version
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	956 # 4.8.6 or higher.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	957 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	958 # To use it do the following:
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	959 # - Install the latest version of global
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	960 # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	961 # - Make sure the INPUT points to the root of the source tree
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	962 # - Run doxygen as normal
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	963 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	964 # Doxygen will invoke htags (and that will in turn invoke gtags), so these
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	965 # tools must be available from the command line (i.e. in the search path).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	966 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	967 # The result: instead of the source browser generated by doxygen, the links to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	968 # source code will now point to the output of htags.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	969 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	970 # This tag requires that the tag SOURCE_BROWSER is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	971
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	972 USE_HTAGS = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	973
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	974 # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	975 # verbatim copy of the header file for each class for which an include is
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	976 # specified. Set to NO to disable this.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	977 # See also: Section \class.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	978 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	979
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	980 VERBATIM_HEADERS = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	981
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	982 #---------------------------------------------------------------------------
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	983 # Configuration options related to the alphabetical class index
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	984 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	985
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	986 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	987 # compounds will be generated. Enable this if the project contains a lot of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	988 # classes, structs, unions or interfaces.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	989 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	990
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	991 ALPHABETICAL_INDEX = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	992
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	993 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	994 # which the alphabetical index list will be split.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	995 # Minimum value: 1, maximum value: 20, default value: 5.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	996 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	997
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	998 COLS_IN_ALPHA_INDEX = 5
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	999
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1000 # In case all classes in a project start with a common prefix, all classes will
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1001 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1002 # can be used to specify a prefix (or a list of prefixes) that should be ignored
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1003 # while generating the index headers.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1004 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1005
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1006 IGNORE_PREFIX =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1007
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1008 #---------------------------------------------------------------------------
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1009 # Configuration options related to the HTML output
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1010 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1011
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1012 # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1013 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1014
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1015 GENERATE_HTML = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1016
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1017 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1018 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1019 # it.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1020 # The default directory is: html.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1021 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1022
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1023 HTML_OUTPUT = doc
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1024
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1025 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1026 # generated HTML page (for example: .htm, .php, .asp).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1027 # The default value is: .html.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1028 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1029
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1030 HTML_FILE_EXTENSION = .html
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1031
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1032 # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1033 # each generated HTML page. If the tag is left blank doxygen will generate a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1034 # standard header.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1035 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1036 # To get valid HTML the header file that includes any scripts and style sheets
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1037 # that doxygen needs, which is dependent on the configuration options used (e.g.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1038 # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1039 # default header using
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1040 # doxygen -w html new_header.html new_footer.html new_stylesheet.css
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1041 # YourConfigFile
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1042 # and then modify the file new_header.html. See also section "Doxygen usage"
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1043 # for information on how to generate the default header that doxygen normally
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1044 # uses.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1045 # Note: The header is subject to change so you typically have to regenerate the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1046 # default header when upgrading to a newer version of doxygen. For a description
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1047 # of the possible markers and block names see the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1048 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1049
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1050 HTML_HEADER =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1051
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1052 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1053 # generated HTML page. If the tag is left blank doxygen will generate a standard
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1054 # footer. See HTML_HEADER for more information on how to generate a default
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1055 # footer and what special commands can be used inside the footer. See also
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1056 # section "Doxygen usage" for information on how to generate the default footer
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1057 # that doxygen normally uses.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1058 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1059
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1060 HTML_FOOTER =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1061
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1062 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1063 # sheet that is used by each HTML page. It can be used to fine-tune the look of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1064 # the HTML output. If left blank doxygen will generate a default style sheet.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1065 # See also section "Doxygen usage" for information on how to generate the style
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1066 # sheet that doxygen normally uses.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1067 # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1068 # it is more robust and this tag (HTML_STYLESHEET) will in the future become
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1069 # obsolete.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1070 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1071
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1072 HTML_STYLESHEET =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1073
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1074 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1075 # defined cascading style sheet that is included after the standard style sheets
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1076 # created by doxygen. Using this option one can overrule certain style aspects.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1077 # This is preferred over using HTML_STYLESHEET since it does not replace the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1078 # standard style sheet and is therefor more robust against future updates.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1079 # Doxygen will copy the style sheet file to the output directory. For an example
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1080 # see the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1081 # This tag requires that the tag GENERATE_HTML is set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1082
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1083 HTML_EXTRA_STYLESHEET =
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1084
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1085 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1086 # other source files which should be copied to the HTML output directory. Note
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1087 # that these files will be copied to the base HTML output directory. Use the
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1088 # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1089 # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1090 # files will be copied as-is; there are no commands or markers available.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1091 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1092
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1093 HTML_EXTRA_FILES =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1094
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1095 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1096 # will adjust the colors in the stylesheet and background images according to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1097 # this color. Hue is specified as an angle on a colorwheel, see
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1098 # http://en.wikipedia.org/wiki/Hue for more information. For instance the value
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1099 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1100 # purple, and 360 is red again.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1101 # Minimum value: 0, maximum value: 359, default value: 220.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1102 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1103
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1104 HTML_COLORSTYLE_HUE = 220
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1105
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1106 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1107 # in the HTML output. For a value of 0 the output will use grayscales only. A
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1108 # value of 255 will produce the most vivid colors.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1109 # Minimum value: 0, maximum value: 255, default value: 100.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1110 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1111
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1112 HTML_COLORSTYLE_SAT = 100
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1113
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1114 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1115 # luminance component of the colors in the HTML output. Values below 100
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1116 # gradually make the output lighter, whereas values above 100 make the output
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1117 # darker. The value divided by 100 is the actual gamma applied, so 80 represents
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1118 # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1119 # change the gamma.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1120 # Minimum value: 40, maximum value: 240, default value: 80.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1121 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1122
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1123 HTML_COLORSTYLE_GAMMA = 80
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1124
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1125 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1126 # page will contain the date and time when the page was generated. Setting this
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1127 # to NO can help when comparing the output of multiple runs.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1128 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1129 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1130
1327 6ed49334d5c1 removal of timestamps in Doxgen documentation for build reproducibility Sebastien Jodogne <s.jodogne@gmail.com> parents: 660 diff changeset	1131 HTML_TIMESTAMP = NO
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1132
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1133 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1134 # documentation will contain sections that can be hidden and shown after the
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	1135 # page has loaded.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1136 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1137 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1138
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1139 HTML_DYNAMIC_SECTIONS = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1140
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1141 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1142 # shown in the various tree structured indices initially; the user can expand
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1143 # and collapse entries dynamically later on. Doxygen will expand the tree to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1144 # such a level that at most the specified number of entries are visible (unless
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1145 # a fully collapsed tree already exceeds this amount). So setting the number of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1146 # entries 1 will produce a full collapsed tree by default. 0 is a special value
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1147 # representing an infinite number of entries and will result in a full expanded
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1148 # tree by default.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1149 # Minimum value: 0, maximum value: 9999, default value: 100.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1150 # This tag requires that the tag GENERATE_HTML is set to YES.
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	1151
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	1152 HTML_INDEX_NUM_ENTRIES = 100
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	1153
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1154 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1155 # generated that can be used as input for Apple's Xcode 3 integrated development
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1156 # environment (see: http://developer.apple.com/tools/xcode/), introduced with
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1157 # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1158 # Makefile in the HTML output directory. Running make will produce the docset in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1159 # that directory and running make install will install the docset in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1160 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1161 # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1162 # for more information.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1163 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1164 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1165
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1166 GENERATE_DOCSET = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1167
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1168 # This tag determines the name of the docset feed. A documentation feed provides
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1169 # an umbrella under which multiple documentation sets from a single provider
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1170 # (such as a company or product suite) can be grouped.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1171 # The default value is: Doxygen generated docs.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1172 # This tag requires that the tag GENERATE_DOCSET is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1173
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1174 DOCSET_FEEDNAME = "Doxygen generated docs"
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1175
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1176 # This tag specifies a string that should uniquely identify the documentation
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1177 # set bundle. This should be a reverse domain-name style string, e.g.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1178 # com.mycompany.MyDocSet. Doxygen will append .docset to the name.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1179 # The default value is: org.doxygen.Project.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1180 # This tag requires that the tag GENERATE_DOCSET is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1181
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1182 DOCSET_BUNDLE_ID = org.doxygen.Project
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1183
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1184 # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1185 # the documentation publisher. This should be a reverse domain-name style
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1186 # string, e.g. com.mycompany.MyDocSet.documentation.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1187 # The default value is: org.doxygen.Publisher.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1188 # This tag requires that the tag GENERATE_DOCSET is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1189
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1190 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1191
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1192 # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1193 # The default value is: Publisher.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1194 # This tag requires that the tag GENERATE_DOCSET is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1195
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1196 DOCSET_PUBLISHER_NAME = Publisher
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1197
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1198 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1199 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1200 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1201 # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1202 # Windows.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1203 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1204 # The HTML Help Workshop contains a compiler that can convert all HTML output
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1205 # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1206 # files are now used as the Windows 98 help format, and will replace the old
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1207 # Windows help format (.hlp) on all Windows platforms in the future. Compressed
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1208 # HTML files also contain an index, a table of contents, and you can search for
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1209 # words in the documentation. The HTML workshop also contains a viewer for
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1210 # compressed HTML files.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1211 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1212 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1213
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1214 GENERATE_HTMLHELP = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1215
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1216 # The CHM_FILE tag can be used to specify the file name of the resulting .chm
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1217 # file. You can add a path in front of the file if the result should not be
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1218 # written to the html output directory.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1219 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1220
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1221 CHM_FILE =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1222
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1223 # The HHC_LOCATION tag can be used to specify the location (absolute path
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1224 # including file name) of the HTML help compiler ( hhc.exe). If non-empty
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1225 # doxygen will try to run the HTML help compiler on the generated index.hhp.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1226 # The file has to be specified with full path.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1227 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1228
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1229 HHC_LOCATION =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1230
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1231 # The GENERATE_CHI flag controls if a separate .chi index file is generated (
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1232 # YES) or that it should be included in the master .chm file ( NO).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1233 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1234 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1235
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1236 GENERATE_CHI = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1237
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1238 # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1239 # and project file content.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1240 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1241
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1242 CHM_INDEX_ENCODING =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1243
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1244 # The BINARY_TOC flag controls whether a binary table of contents is generated (
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1245 # YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1246 # enables the Previous and Next buttons.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1247 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1248 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1249
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1250 BINARY_TOC = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1251
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1252 # The TOC_EXPAND flag can be set to YES to add extra items for group members to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1253 # the table of contents of the HTML help documentation and to the tree view.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1254 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1255 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1256
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1257 TOC_EXPAND = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1258
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1259 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1260 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1261 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1262 # (.qch) of the generated HTML documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1263 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1264 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1265
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1266 GENERATE_QHP = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1267
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1268 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1269 # the file name of the resulting .qch file. The path specified is relative to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1270 # the HTML output folder.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1271 # This tag requires that the tag GENERATE_QHP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1272
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1273 QCH_FILE =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1274
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1275 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1276 # Project output. For more information please see Qt Help Project / Namespace
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1277 # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1278 # The default value is: org.doxygen.Project.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1279 # This tag requires that the tag GENERATE_QHP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1280
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1281 QHP_NAMESPACE = org.doxygen.Project
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1282
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1283 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1284 # Help Project output. For more information please see Qt Help Project / Virtual
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1285 # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1286 # folders).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1287 # The default value is: doc.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1288 # This tag requires that the tag GENERATE_QHP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1289
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1290 QHP_VIRTUAL_FOLDER = doc
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1291
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1292 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1293 # filter to add. For more information please see Qt Help Project / Custom
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1294 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1295 # filters).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1296 # This tag requires that the tag GENERATE_QHP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1297
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1298 QHP_CUST_FILTER_NAME =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1299
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1300 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1301 # custom filter to add. For more information please see Qt Help Project / Custom
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1302 # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1303 # filters).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1304 # This tag requires that the tag GENERATE_QHP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1305
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1306 QHP_CUST_FILTER_ATTRS =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1307
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1308 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1309 # project's filter section matches. Qt Help Project / Filter Attributes (see:
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1310 # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1311 # This tag requires that the tag GENERATE_QHP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1312
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1313 QHP_SECT_FILTER_ATTRS =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1314
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1315 # The QHG_LOCATION tag can be used to specify the location of Qt's
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1316 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1317 # generated .qhp file.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1318 # This tag requires that the tag GENERATE_QHP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1319
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1320 QHG_LOCATION =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1321
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1322 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1323 # generated, together with the HTML files, they form an Eclipse help plugin. To
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1324 # install this plugin and make it available under the help contents menu in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1325 # Eclipse, the contents of the directory containing the HTML and XML files needs
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1326 # to be copied into the plugins directory of eclipse. The name of the directory
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1327 # within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1328 # After copying Eclipse needs to be restarted before the help appears.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1329 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1330 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1331
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1332 GENERATE_ECLIPSEHELP = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1333
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1334 # A unique identifier for the Eclipse help plugin. When installing the plugin
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1335 # the directory name containing the HTML and XML files should also have this
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1336 # name. Each documentation set should have its own identifier.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1337 # The default value is: org.doxygen.Project.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1338 # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1339
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1340 ECLIPSE_DOC_ID = org.doxygen.Project
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1341
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1342 # If you want full control over the layout of the generated HTML pages it might
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1343 # be necessary to disable the index and replace it with your own. The
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1344 # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1345 # of each HTML page. A value of NO enables the index and the value YES disables
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1346 # it. Since the tabs in the index contain the same information as the navigation
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1347 # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1348 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1349 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1350
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1351 DISABLE_INDEX = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1352
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1353 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1354 # structure should be generated to display hierarchical information. If the tag
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1355 # value is set to YES, a side panel will be generated containing a tree-like
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1356 # index structure (just like the one that is generated for HTML Help). For this
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1357 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1358 # (i.e. any modern browser). Windows users are probably better off using the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1359 # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1360 # further fine-tune the look of the index. As an example, the default style
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1361 # sheet generated by doxygen has an example that shows how to put an image at
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1362 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1363 # the same information as the tab index, you could consider setting
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1364 # DISABLE_INDEX to YES when enabling this option.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1365 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1366 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1367
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1368 GENERATE_TREEVIEW = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1369
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1370 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1371 # doxygen will group on one line in the generated HTML documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1372 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1373 # Note that a value of 0 will completely suppress the enum values from appearing
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1374 # in the overview section.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1375 # Minimum value: 0, maximum value: 20, default value: 4.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1376 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1377
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	1378 ENUM_VALUES_PER_LINE = 1
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1379
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1380 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1381 # to set the initial width (in pixels) of the frame in which the tree is shown.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1382 # Minimum value: 0, maximum value: 1500, default value: 250.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1383 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1384
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1385 TREEVIEW_WIDTH = 250
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1386
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1387 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1388 # external symbols imported via tag files in a separate window.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1389 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1390 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1391
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1392 EXT_LINKS_IN_WINDOW = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1393
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1394 # Use this tag to change the font size of LaTeX formulas included as images in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1395 # the HTML documentation. When you change the font size after a successful
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1396 # doxygen run you need to manually remove any form_*.png images from the HTML
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1397 # output directory to force them to be regenerated.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1398 # Minimum value: 8, maximum value: 50, default value: 10.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1399 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1400
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1401 FORMULA_FONTSIZE = 10
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1402
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1403 # Use the FORMULA_TRANPARENT tag to determine whether or not the images
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1404 # generated for formulas are transparent PNGs. Transparent PNGs are not
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1405 # supported properly for IE 6.0, but are supported on all modern browsers.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1406 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1407 # Note that when changing this option you need to delete any form_*.png files in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1408 # the HTML output directory before the changes have effect.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1409 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1410 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1411
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1412 FORMULA_TRANSPARENT = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1413
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1414 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1415 # http://www.mathjax.org) which uses client side Javascript for the rendering
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1416 # instead of using prerendered bitmaps. Use this if you do not have LaTeX
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1417 # installed or if you want to formulas look prettier in the HTML output. When
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1418 # enabled you may also need to install MathJax separately and configure the path
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1419 # to it using the MATHJAX_RELPATH option.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1420 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1421 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1422
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1423 USE_MATHJAX = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1424
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1425 # When MathJax is enabled you can set the default output format to be used for
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1426 # the MathJax output. See the MathJax site (see:
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1427 # http://docs.mathjax.org/en/latest/output.html) for more details.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1428 # Possible values are: HTML-CSS (which is slower, but has the best
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1429 # compatibility), NativeMML (i.e. MathML) and SVG.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1430 # The default value is: HTML-CSS.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1431 # This tag requires that the tag USE_MATHJAX is set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1432
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1433 MATHJAX_FORMAT = HTML-CSS
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1434
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1435 # When MathJax is enabled you need to specify the location relative to the HTML
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1436 # output directory using the MATHJAX_RELPATH option. The destination directory
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1437 # should contain the MathJax.js script. For instance, if the mathjax directory
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1438 # is located at the same level as the HTML output directory, then
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1439 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1440 # Content Delivery Network so you can quickly see the result without installing
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1441 # MathJax. However, it is strongly recommended to install a local copy of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1442 # MathJax from http://www.mathjax.org before deployment.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1443 # The default value is: http://cdn.mathjax.org/mathjax/latest.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1444 # This tag requires that the tag USE_MATHJAX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1445
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1446 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1447
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1448 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1449 # extension names that should be enabled during MathJax rendering. For example
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1450 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1451 # This tag requires that the tag USE_MATHJAX is set to YES.
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	1452
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	1453 MATHJAX_EXTENSIONS =
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	1454
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1455 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1456 # of code that will be used on startup of the MathJax code. See the MathJax site
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1457 # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1458 # example see the documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1459 # This tag requires that the tag USE_MATHJAX is set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1460
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1461 MATHJAX_CODEFILE =
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1462
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1463 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1464 # the HTML output. The underlying search engine uses javascript and DHTML and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1465 # should work on any modern browser. Note that when using HTML help
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1466 # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1467 # there is already a search function so this one should typically be disabled.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1468 # For large projects the javascript based search engine can be slow, then
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1469 # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1470 # search using the keyboard; to jump to the search box use <access key> + S
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1471 # (what the <access key> is depends on the OS and browser, but it is typically
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1472 # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1473 # key> to jump into the search results window, the results can be navigated
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1474 # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1475 # the search. The filter options can be selected when the cursor is inside the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1476 # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1477 # to select a filter and <Enter> or <escape> to activate or cancel the filter
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1478 # option.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1479 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1480 # This tag requires that the tag GENERATE_HTML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1481
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1482 SEARCHENGINE = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1483
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1484 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1485 # implemented using a web server instead of a web client using Javascript. There
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1486 # are two flavors of web server based searching depending on the EXTERNAL_SEARCH
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1487 # setting. When disabled, doxygen will generate a PHP script for searching and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1488 # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1489 # and searching needs to be provided by external tools. See the section
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1490 # "External Indexing and Searching" for details.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1491 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1492 # This tag requires that the tag SEARCHENGINE is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1493
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1494 SERVER_BASED_SEARCH = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1495
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1496 # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1497 # script for searching. Instead the search results are written to an XML file
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1498 # which needs to be processed by an external indexer. Doxygen will invoke an
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1499 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1500 # search results.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1501 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1502 # Doxygen ships with an example indexer ( doxyindexer) and search engine
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1503 # (doxysearch.cgi) which are based on the open source search engine library
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1504 # Xapian (see: http://xapian.org/).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1505 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1506 # See the section "External Indexing and Searching" for details.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1507 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1508 # This tag requires that the tag SEARCHENGINE is set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1509
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1510 EXTERNAL_SEARCH = NO
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1511
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1512 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1513 # which will return the search results when EXTERNAL_SEARCH is enabled.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1514 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1515 # Doxygen ships with an example indexer ( doxyindexer) and search engine
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1516 # (doxysearch.cgi) which are based on the open source search engine library
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1517 # Xapian (see: http://xapian.org/). See the section "External Indexing and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1518 # Searching" for details.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1519 # This tag requires that the tag SEARCHENGINE is set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1520
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1521 SEARCHENGINE_URL =
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1522
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1523 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1524 # search data is written to a file for indexing by an external tool. With the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1525 # SEARCHDATA_FILE tag the name of this file can be specified.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1526 # The default file is: searchdata.xml.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1527 # This tag requires that the tag SEARCHENGINE is set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1528
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1529 SEARCHDATA_FILE = searchdata.xml
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1530
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1531 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1532 # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1533 # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1534 # projects and redirect the results back to the right project.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1535 # This tag requires that the tag SEARCHENGINE is set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1536
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1537 EXTERNAL_SEARCH_ID =
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1538
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1539 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1540 # projects other than the one defined by this configuration file, but that are
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1541 # all added to the same external search index. Each project needs to have a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1542 # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1543 # to a relative location where the documentation can be found. The format is:
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1544 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1545 # This tag requires that the tag SEARCHENGINE is set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1546
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1547 EXTRA_SEARCH_MAPPINGS =
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1548
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1549 #---------------------------------------------------------------------------
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1550 # Configuration options related to the LaTeX output
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1551 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1552
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1553 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1554 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1555
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1556 GENERATE_LATEX = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1557
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1558 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1559 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1560 # it.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1561 # The default directory is: latex.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1562 # This tag requires that the tag GENERATE_LATEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1563
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1564 LATEX_OUTPUT = latex
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1565
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1566 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1567 # invoked.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1568 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1569 # Note that when enabling USE_PDFLATEX this option is only used for generating
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1570 # bitmaps for formulas in the HTML output, but not in the Makefile that is
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1571 # written to the output directory.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1572 # The default file is: latex.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1573 # This tag requires that the tag GENERATE_LATEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1574
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1575 LATEX_CMD_NAME = latex
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1576
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1577 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1578 # index for LaTeX.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1579 # The default file is: makeindex.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1580 # This tag requires that the tag GENERATE_LATEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1581
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1582 MAKEINDEX_CMD_NAME = makeindex
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1583
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1584 # If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1585 # documents. This may be useful for small projects and may help to save some
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1586 # trees in general.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1587 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1588 # This tag requires that the tag GENERATE_LATEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1589
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1590 COMPACT_LATEX = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1591
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1592 # The PAPER_TYPE tag can be used to set the paper type that is used by the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1593 # printer.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1594 # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1595 # 14 inches) and executive (7.25 x 10.5 inches).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1596 # The default value is: a4.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1597 # This tag requires that the tag GENERATE_LATEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1598
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1599 PAPER_TYPE = a4
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1600
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1601 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1602 # that should be included in the LaTeX output. To get the times font for
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1603 # instance you can specify
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1604 # EXTRA_PACKAGES=times
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1605 # If left blank no extra packages will be included.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1606 # This tag requires that the tag GENERATE_LATEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1607
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1608 EXTRA_PACKAGES =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1609
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1610 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1611 # generated LaTeX document. The header should contain everything until the first
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1612 # chapter. If it is left blank doxygen will generate a standard header. See
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1613 # section "Doxygen usage" for information on how to let doxygen write the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1614 # default header to a separate file.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1615 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1616 # Note: Only use a user-defined header if you know what you are doing! The
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1617 # following commands have a special meaning inside the header: $title,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1618 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1619 # replace them by respectively the title of the page, the current date and time,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1620 # only the current date, the version number of doxygen, the project name (see
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1621 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1622 # This tag requires that the tag GENERATE_LATEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1623
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1624 LATEX_HEADER =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1625
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1626 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1627 # generated LaTeX document. The footer should contain everything after the last
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1628 # chapter. If it is left blank doxygen will generate a standard footer.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1629 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1630 # Note: Only use a user-defined footer if you know what you are doing!
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1631 # This tag requires that the tag GENERATE_LATEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1632
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1633 LATEX_FOOTER =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1634
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1635 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1636 # other source files which should be copied to the LATEX_OUTPUT output
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1637 # directory. Note that the files will be copied as-is; there are no commands or
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1638 # markers available.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1639 # This tag requires that the tag GENERATE_LATEX is set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1640
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1641 LATEX_EXTRA_FILES =
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1642
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1643 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1644 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1645 # contain links (just like the HTML output) instead of page references. This
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1646 # makes the output suitable for online browsing using a PDF viewer.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1647 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1648 # This tag requires that the tag GENERATE_LATEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1649
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1650 PDF_HYPERLINKS = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1651
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1652 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1653 # the PDF file directly from the LaTeX files. Set this option to YES to get a
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1654 # higher quality PDF documentation.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1655 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1656 # This tag requires that the tag GENERATE_LATEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1657
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1658 USE_PDFLATEX = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1659
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1660 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1661 # command to the generated LaTeX files. This will instruct LaTeX to keep running
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1662 # if errors occur, instead of asking the user for help. This option is also used
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1663 # when generating formulas in HTML.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1664 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1665 # This tag requires that the tag GENERATE_LATEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1666
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1667 LATEX_BATCHMODE = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1668
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1669 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1670 # index chapters (such as File Index, Compound Index, etc.) in the output.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1671 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1672 # This tag requires that the tag GENERATE_LATEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1673
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1674 LATEX_HIDE_INDICES = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1675
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1676 # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1677 # code with syntax highlighting in the LaTeX output.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1678 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1679 # Note that which sources are shown also depends on other settings such as
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1680 # SOURCE_BROWSER.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1681 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1682 # This tag requires that the tag GENERATE_LATEX is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1683
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1684 LATEX_SOURCE_CODE = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1685
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	1686 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1687 # bibliography, e.g. plainnat, or ieeetr. See
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1688 # http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1689 # The default value is: plain.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1690 # This tag requires that the tag GENERATE_LATEX is set to YES.
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	1691
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	1692 LATEX_BIB_STYLE = plain
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	1693
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1694 #---------------------------------------------------------------------------
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1695 # Configuration options related to the RTF output
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1696 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1697
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1698 # If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1699 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1700 # readers/editors.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1701 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1702
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1703 GENERATE_RTF = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1704
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1705 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1706 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1707 # it.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1708 # The default directory is: rtf.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1709 # This tag requires that the tag GENERATE_RTF is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1710
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1711 RTF_OUTPUT = rtf
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1712
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1713 # If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1714 # documents. This may be useful for small projects and may help to save some
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1715 # trees in general.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1716 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1717 # This tag requires that the tag GENERATE_RTF is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1718
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1719 COMPACT_RTF = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1720
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1721 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1722 # contain hyperlink fields. The RTF file will contain links (just like the HTML
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1723 # output) instead of page references. This makes the output suitable for online
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1724 # browsing using Word or some other Word compatible readers that support those
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1725 # fields.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1726 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1727 # Note: WordPad (write) and others do not support links.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1728 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1729 # This tag requires that the tag GENERATE_RTF is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1730
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1731 RTF_HYPERLINKS = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1732
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1733 # Load stylesheet definitions from file. Syntax is similar to doxygen's config
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1734 # file, i.e. a series of assignments. You only have to provide replacements,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1735 # missing definitions are set to their default value.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1736 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1737 # See also section "Doxygen usage" for information on how to generate the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1738 # default style sheet that doxygen normally uses.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1739 # This tag requires that the tag GENERATE_RTF is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1740
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1741 RTF_STYLESHEET_FILE =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1742
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1743 # Set optional variables used in the generation of an RTF document. Syntax is
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1744 # similar to doxygen's config file. A template extensions file can be generated
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1745 # using doxygen -e rtf extensionFile.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1746 # This tag requires that the tag GENERATE_RTF is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1747
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1748 RTF_EXTENSIONS_FILE =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1749
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1750 #---------------------------------------------------------------------------
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1751 # Configuration options related to the man page output
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1752 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1753
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1754 # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1755 # classes and files.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1756 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1757
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1758 GENERATE_MAN = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1759
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1760 # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1761 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1762 # it. A directory man3 will be created inside the directory specified by
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1763 # MAN_OUTPUT.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1764 # The default directory is: man.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1765 # This tag requires that the tag GENERATE_MAN is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1766
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1767 MAN_OUTPUT = man
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1768
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1769 # The MAN_EXTENSION tag determines the extension that is added to the generated
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1770 # man pages. In case the manual section does not start with a number, the number
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1771 # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1772 # optional.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1773 # The default value is: .3.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1774 # This tag requires that the tag GENERATE_MAN is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1775
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1776 MAN_EXTENSION = .3
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1777
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1778 # The MAN_SUBDIR tag determines the name of the directory created within
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1779 # MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1780 # MAN_EXTENSION with the initial . removed.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1781 # This tag requires that the tag GENERATE_MAN is set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1782
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1783 MAN_SUBDIR =
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1784
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1785 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1786 # will generate one additional man file for each entity documented in the real
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1787 # man page(s). These additional files only source the real man page, but without
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1788 # them the man command would be unable to find the correct page.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1789 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1790 # This tag requires that the tag GENERATE_MAN is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1791
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1792 MAN_LINKS = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1793
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1794 #---------------------------------------------------------------------------
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1795 # Configuration options related to the XML output
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1796 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1797
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1798 # If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1799 # captures the structure of the code including all documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1800 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1801
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1802 GENERATE_XML = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1803
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1804 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1805 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1806 # it.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1807 # The default directory is: xml.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1808 # This tag requires that the tag GENERATE_XML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1809
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1810 XML_OUTPUT = xml
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1811
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1812 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1813 # listings (including syntax highlighting and cross-referencing information) to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1814 # the XML output. Note that enabling this will significantly increase the size
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1815 # of the XML output.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1816 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1817 # This tag requires that the tag GENERATE_XML is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1818
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1819 XML_PROGRAMLISTING = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1820
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1821 #---------------------------------------------------------------------------
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1822 # Configuration options related to the DOCBOOK output
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1823 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1824
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1825 # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1826 # that can be used to generate PDF.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1827 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1828
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1829 GENERATE_DOCBOOK = NO
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1830
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1831 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1832 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1833 # front of it.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1834 # The default directory is: docbook.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1835 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1836
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1837 DOCBOOK_OUTPUT = docbook
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1838
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1839 #---------------------------------------------------------------------------
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1840 # Configuration options for the AutoGen Definitions output
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1841 #---------------------------------------------------------------------------
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1842
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1843 # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1844 # Definitions (see http://autogen.sf.net) file that captures the structure of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1845 # the code including all documentation. Note that this feature is still
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1846 # experimental and incomplete at the moment.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1847 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1848
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1849 GENERATE_AUTOGEN_DEF = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1850
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1851 #---------------------------------------------------------------------------
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1852 # Configuration options related to the Perl module output
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1853 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1854
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1855 # If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1856 # file that captures the structure of the code including all documentation.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1857 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1858 # Note that this feature is still experimental and incomplete at the moment.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1859 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1860
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1861 GENERATE_PERLMOD = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1862
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1863 # If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1864 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1865 # output from the Perl module output.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1866 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1867 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1868
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1869 PERLMOD_LATEX = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1870
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1871 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1872 # formatted so it can be parsed by a human reader. This is useful if you want to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1873 # understand what is going on. On the other hand, if this tag is set to NO the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1874 # size of the Perl module output will be much smaller and Perl will parse it
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1875 # just the same.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1876 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1877 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1878
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1879 PERLMOD_PRETTY = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1880
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1881 # The names of the make variables in the generated doxyrules.make file are
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1882 # prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1883 # so different doxyrules.make files included by the same Makefile don't
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1884 # overwrite each other's variables.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1885 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1886
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1887 PERLMOD_MAKEVAR_PREFIX =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1888
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1889 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1890 # Configuration options related to the preprocessor
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1891 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1892
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1893 # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1894 # C-preprocessor directives found in the sources and include files.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1895 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1896
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1897 ENABLE_PREPROCESSING = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1898
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1899 # If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1900 # in the source code. If set to NO only conditional compilation will be
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1901 # performed. Macro expansion can be done in a controlled way by setting
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1902 # EXPAND_ONLY_PREDEF to YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1903 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1904 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1905
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1906 MACRO_EXPANSION = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1907
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1908 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1909 # the macro expansion is limited to the macros specified with the PREDEFINED and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1910 # EXPAND_AS_DEFINED tags.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1911 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1912 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1913
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1914 EXPAND_ONLY_PREDEF = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1915
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1916 # If the SEARCH_INCLUDES tag is set to YES the includes files in the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1917 # INCLUDE_PATH will be searched if a #include is found.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1918 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1919 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1920
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1921 SEARCH_INCLUDES = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1922
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1923 # The INCLUDE_PATH tag can be used to specify one or more directories that
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1924 # contain include files that are not input files but should be processed by the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1925 # preprocessor.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1926 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1927
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1928 INCLUDE_PATH =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1929
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1930 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1931 # patterns (like .h and .hpp) to filter out the header-files in the
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1932 # directories. If left blank, the patterns specified with FILE_PATTERNS will be
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1933 # used.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1934 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1935
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1936 INCLUDE_FILE_PATTERNS =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1937
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1938 # The PREDEFINED tag can be used to specify one or more macro names that are
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1939 # defined before the preprocessor is started (similar to the -D option of e.g.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1940 # gcc). The argument of the tag is a list of macros of the form: name or
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1941 # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1942 # is assumed. To prevent a macro definition from being undefined via #undef or
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1943 # recursively expanded use the := operator instead of the = operator.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1944 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1945
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1946 PREDEFINED =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1947
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1948 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1949 # tag can be used to specify a list of macro names that should be expanded. The
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1950 # macro definition that is found in the sources will be used. Use the PREDEFINED
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1951 # tag if you want to use a different macro definition that overrules the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1952 # definition found in the source code.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1953 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1954
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1955 EXPAND_AS_DEFINED =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1956
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1957 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1958 # remove all references to function-like macros that are alone on a line, have
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1959 # an all uppercase name, and do not end with a semicolon. Such function macros
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1960 # are typically used for boiler-plate code, and will confuse the parser if not
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1961 # removed.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1962 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1963 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1964
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1965 SKIP_FUNCTION_MACROS = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1966
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1967 #---------------------------------------------------------------------------
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1968 # Configuration options related to external references
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1969 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1970
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1971 # The TAGFILES tag can be used to specify one or more tag files. For each tag
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1972 # file the location of the external documentation should be added. The format of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1973 # a tag file without this location is as follows:
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1974 # TAGFILES = file1 file2 ...
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1975 # Adding location for the tag files is done as follows:
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1976 # TAGFILES = file1=loc1 "file2 = loc2" ...
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1977 # where loc1 and loc2 can be relative or absolute paths or URLs. See the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1978 # section "Linking to external documentation" for more information about the use
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1979 # of tag files.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1980 # Note: Each tag file must have a unique name (where the name does NOT include
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1981 # the path). If a tag file is not located in the directory in which doxygen is
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1982 # run, you must also specify the path to the tagfile here.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1983
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1984 TAGFILES =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1985
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1986 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1987 # tag file that is based on the input files it reads. See section "Linking to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1988 # external documentation" for more information about the usage of tag files.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1989
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1990 GENERATE_TAGFILE =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1991
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1992 # If the ALLEXTERNALS tag is set to YES all external class will be listed in the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1993 # class index. If set to NO only the inherited external classes will be listed.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1994 # The default value is: NO.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1995
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1996 ALLEXTERNALS = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1997
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1998 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	1999 # the modules index. If set to NO, only the current project's groups will be
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2000 # listed.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2001 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2002
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2003 EXTERNAL_GROUPS = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2004
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2005 # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2006 # the related pages index. If set to NO, only the current project's pages will
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2007 # be listed.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2008 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2009
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2010 EXTERNAL_PAGES = YES
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2011
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2012 # The PERL_PATH should be the absolute path and name of the perl script
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2013 # interpreter (i.e. the result of 'which perl').
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2014 # The default file (with absolute path) is: /usr/bin/perl.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2015
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2016 PERL_PATH = /usr/bin/perl
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2017
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2018 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2019 # Configuration options related to the dot tool
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2020 #---------------------------------------------------------------------------
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2021
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2022 # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2023 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2024 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2025 # disabled, but it is recommended to install and use dot, since it yields more
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2026 # powerful graphs.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2027 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2028
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2029 CLASS_DIAGRAMS = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2030
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2031 # You can define message sequence charts within doxygen comments using the \msc
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2032 # command. Doxygen will then run the mscgen tool (see:
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2033 # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2034 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2035 # the mscgen tool resides. If left empty the tool is assumed to be found in the
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2036 # default search path.
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2037
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2038 MSCGEN_PATH =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2039
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2040 # You can include diagrams made with dia in doxygen documentation. Doxygen will
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2041 # then run dia to produce the diagram and insert it in the documentation. The
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2042 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2043 # If left empty dia is assumed to be found in the default search path.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2044
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2045 DIA_PATH =
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2046
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2047 # If set to YES, the inheritance and collaboration graphs will hide inheritance
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2048 # and usage relations if the target is undocumented or is not a class.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2049 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2050
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2051 HIDE_UNDOC_RELATIONS = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2052
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2053 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2054 # available from the path. This tool is part of Graphviz (see:
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2055 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2056 # Bell Labs. The other options in this section have no effect if this option is
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2057 # set to NO
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2058 # The default value is: YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2059
1524 4a0c2eedceb6 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1523 diff changeset	2060 HAVE_DOT = NO
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2061
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2062 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2063 # to run in parallel. When set to 0 doxygen will base this on the number of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2064 # processors available in the system. You can set it explicitly to a value
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2065 # larger than 0 to get control over the balance between CPU load and processing
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2066 # speed.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2067 # Minimum value: 0, maximum value: 32, default value: 0.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2068 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2069
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2070 DOT_NUM_THREADS = 0
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2071
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2072 # When you want a differently looking font n the dot files that doxygen
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2073 # generates you can specify the font name using DOT_FONTNAME. You need to make
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2074 # sure dot is able to find the font, which can be done by putting it in a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2075 # standard location or by setting the DOTFONTPATH environment variable or by
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2076 # setting DOT_FONTPATH to the directory containing the font.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2077 # The default value is: Helvetica.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2078 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2079
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2080 DOT_FONTNAME = Helvetica
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2081
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2082 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2083 # dot graphs.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2084 # Minimum value: 4, maximum value: 24, default value: 10.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2085 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2086
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2087 DOT_FONTSIZE = 10
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2088
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2089 # By default doxygen will tell dot to use the default font as specified with
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2090 # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2091 # the path where dot can find it using this tag.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2092 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2093
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2094 DOT_FONTPATH =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2095
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2096 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2097 # each documented class showing the direct and indirect inheritance relations.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2098 # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2099 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2100 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2101
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2102 CLASS_GRAPH = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2103
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2104 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2105 # graph for each documented class showing the direct and indirect implementation
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2106 # dependencies (inheritance, containment, and class references variables) of the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2107 # class with other documented classes.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2108 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2109 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2110
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2111 COLLABORATION_GRAPH = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2112
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2113 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2114 # groups, showing the direct groups dependencies.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2115 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2116 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2117
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2118 GROUP_GRAPHS = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2119
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2120 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2121 # collaboration diagrams in a style similar to the OMG's Unified Modeling
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2122 # Language.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2123 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2124 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2125
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2126 UML_LOOK = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2127
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2128 # If the UML_LOOK tag is enabled, the fields and methods are shown inside the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2129 # class node. If there are many fields or methods and many nodes the graph may
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2130 # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2131 # number of items for each type to make the size more manageable. Set this to 0
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2132 # for no limit. Note that the threshold may be exceeded by 50% before the limit
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2133 # is enforced. So when you set the threshold to 10, up to 15 fields may appear,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2134 # but if the number exceeds 15, the total amount of fields shown is limited to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2135 # 10.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2136 # Minimum value: 0, maximum value: 100, default value: 10.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2137 # This tag requires that the tag HAVE_DOT is set to YES.
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	2138
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	2139 UML_LIMIT_NUM_FIELDS = 10
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	2140
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2141 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2142 # collaboration graphs will show the relations between templates and their
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2143 # instances.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2144 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2145 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2146
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2147 TEMPLATE_RELATIONS = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2148
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2149 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2150 # YES then doxygen will generate a graph for each documented file showing the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2151 # direct and indirect include dependencies of the file with other documented
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2152 # files.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2153 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2154 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2155
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2156 INCLUDE_GRAPH = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2157
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2158 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2159 # set to YES then doxygen will generate a graph for each documented file showing
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2160 # the direct and indirect include dependencies of the file with other documented
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2161 # files.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2162 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2163 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2164
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2165 INCLUDED_BY_GRAPH = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2166
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2167 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2168 # dependency graph for every global function or class method.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2169 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2170 # Note that enabling this option will significantly increase the time of a run.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2171 # So in most cases it will be better to enable call graphs for selected
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2172 # functions only using the \callgraph command.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2173 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2174 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2175
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2176 CALL_GRAPH = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2177
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2178 # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2179 # dependency graph for every global function or class method.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2180 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2181 # Note that enabling this option will significantly increase the time of a run.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2182 # So in most cases it will be better to enable caller graphs for selected
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2183 # functions only using the \callergraph command.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2184 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2185 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2186
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2187 CALLER_GRAPH = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2188
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2189 # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2190 # hierarchy of all classes instead of a textual one.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2191 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2192 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2193
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2194 GRAPHICAL_HIERARCHY = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2195
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2196 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2197 # dependencies a directory has on other directories in a graphical way. The
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2198 # dependency relations are determined by the #include relations between the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2199 # files in the directories.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2200 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2201 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2202
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2203 DIRECTORY_GRAPH = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2204
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2205 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2206 # generated by dot.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2207 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2208 # to make the SVG files visible in IE 9+ (other browsers do not have this
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2209 # requirement).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2210 # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2211 # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2212 # gif:cairo:gd, gif:gd, gif:gd:gd and svg.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2213 # The default value is: png.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2214 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2215
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2216 DOT_IMAGE_FORMAT = png
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2217
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	2218 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	2219 # enable generation of interactive SVG images that allow zooming and panning.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2220 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2221 # Note that this requires a modern browser other than Internet Explorer. Tested
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2222 # and working are Firefox, Chrome, Safari, and Opera.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2223 # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2224 # the SVG files visible. Older versions of IE do not have SVG support.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2225 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2226 # This tag requires that the tag HAVE_DOT is set to YES.
660 f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	2227
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	2228 INTERACTIVE_SVG = NO
f0232774b913 fix warnings Sebastien Jodogne <s.jodogne@gmail.com> parents: 593 diff changeset	2229
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2230 # The DOT_PATH tag can be used to specify the path where the dot tool can be
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2231 # found. If left blank, it is assumed the dot tool can be found in the path.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2232 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2233
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2234 DOT_PATH =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2235
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2236 # The DOTFILE_DIRS tag can be used to specify one or more directories that
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2237 # contain dot files that are included in the documentation (see the \dotfile
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2238 # command).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2239 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2240
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2241 DOTFILE_DIRS =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2242
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2243 # The MSCFILE_DIRS tag can be used to specify one or more directories that
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2244 # contain msc files that are included in the documentation (see the \mscfile
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2245 # command).
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2246
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2247 MSCFILE_DIRS =
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2248
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2249 # The DIAFILE_DIRS tag can be used to specify one or more directories that
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2250 # contain dia files that are included in the documentation (see the \diafile
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2251 # command).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2252
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2253 DIAFILE_DIRS =
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2254
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2255 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2256 # that will be shown in the graph. If the number of nodes in a graph becomes
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2257 # larger than this value, doxygen will truncate the graph, which is visualized
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2258 # by representing a node as a red box. Note that doxygen if the number of direct
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2259 # children of the root node in a graph is already larger than
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2260 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2261 # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2262 # Minimum value: 0, maximum value: 10000, default value: 50.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2263 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2264
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2265 DOT_GRAPH_MAX_NODES = 50
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2266
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2267 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2268 # generated by dot. A depth value of 3 means that only nodes reachable from the
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2269 # root by following a path via at most 3 edges will be shown. Nodes that lay
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2270 # further from the root node will be omitted. Note that setting this option to 1
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2271 # or 2 may greatly reduce the computation time needed for large code bases. Also
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2272 # note that the size of a graph can be further restricted by
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2273 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2274 # Minimum value: 0, maximum value: 1000, default value: 0.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2275 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2276
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2277 MAX_DOT_GRAPH_DEPTH = 0
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2278
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2279 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2280 # background. This is disabled by default, because dot on Windows does not seem
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2281 # to support this out of the box.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2282 #
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2283 # Warning: Depending on the platform used, enabling this option may lead to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2284 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2285 # read).
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2286 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2287 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2288
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2289 DOT_TRANSPARENT = NO
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2290
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2291 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2292 # files in one run (i.e. multiple -o and -T options on the command line). This
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2293 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2294 # this, this feature is disabled by default.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2295 # The default value is: NO.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2296 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2297
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2298 DOT_MULTI_TARGETS = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2299
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2300 # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2301 # explaining the meaning of the various boxes and arrows in the dot generated
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2302 # graphs.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2303 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2304 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2305
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2306 GENERATE_LEGEND = YES
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2307
2224 87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2308 # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2309 # files that are used to generate the various graphs.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2310 # The default value is: YES.
87c71bfb4e8a upgrade doxygen configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1524 diff changeset	2311 # This tag requires that the tag HAVE_DOT is set to YES.
0 3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2312
3959d33612cc initial commit Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2313 DOT_CLEANUP = YES

Mercurial > hg > orthanc

annotate OrthancServer/Resources/Orthanc.doxygen @ 4072:3dda0d73193c framework