annotate doc/apidoc/Doxyfile.in @ 1310:60e481aa75ca

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

http://wald.intevation.org/projects/trustbridge/