joachim99@14
|
1 # Doxyfile 1.2.15
|
joachim99@14
|
2
|
joachim99@14
|
3 # This file describes the settings to be used by the documentation system
|
joachim99@14
|
4 # doxygen (www.doxygen.org) for a project
|
joachim99@14
|
5 #
|
joachim99@14
|
6 # All text after a hash (#) is considered a comment and will be ignored
|
joachim99@14
|
7 # The format is:
|
joachim99@14
|
8 # TAG = value [value, ...]
|
joachim99@14
|
9 # For lists items can also be appended using:
|
joachim99@14
|
10 # TAG += value [value, ...]
|
joachim99@14
|
11 # Values that contain spaces should be placed between quotes (" ")
|
joachim99@14
|
12
|
joachim99@14
|
13 #---------------------------------------------------------------------------
|
joachim99@14
|
14 # General configuration options
|
joachim99@14
|
15 #---------------------------------------------------------------------------
|
joachim99@14
|
16
|
joachim99@14
|
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
|
joachim99@14
|
18 # by quotes) that should identify the project.
|
joachim99@14
|
19
|
joachim99@14
|
20 PROJECT_NAME =
|
joachim99@14
|
21
|
joachim99@14
|
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
joachim99@14
|
23 # This could be handy for archiving the generated documentation or
|
joachim99@14
|
24 # if some version control system is used.
|
joachim99@14
|
25
|
joachim99@14
|
26 PROJECT_NUMBER =
|
joachim99@14
|
27
|
joachim99@14
|
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
joachim99@14
|
29 # base path where the generated documentation will be put.
|
joachim99@14
|
30 # If a relative path is entered, it will be relative to the location
|
joachim99@14
|
31 # where doxygen was started. If left blank the current directory will be used.
|
joachim99@14
|
32
|
joachim99@14
|
33 OUTPUT_DIRECTORY = ../apidocs/
|
joachim99@14
|
34
|
joachim99@14
|
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
joachim99@14
|
36 # documentation generated by doxygen is written. Doxygen will use this
|
joachim99@14
|
37 # information to generate all constant output in the proper language.
|
joachim99@14
|
38 # The default language is English, other supported languages are:
|
joachim99@14
|
39 # Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
|
joachim99@14
|
40 # German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
|
joachim99@14
|
41 # Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
|
joachim99@14
|
42
|
joachim99@14
|
43 OUTPUT_LANGUAGE = English
|
joachim99@14
|
44
|
joachim99@14
|
45 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
|
joachim99@14
|
46 # documentation are documented, even if no documentation was available.
|
joachim99@14
|
47 # Private class members and static file members will be hidden unless
|
joachim99@14
|
48 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
|
joachim99@14
|
49
|
joachim99@14
|
50 EXTRACT_ALL = NO
|
joachim99@14
|
51
|
joachim99@14
|
52 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
|
joachim99@14
|
53 # will be included in the documentation.
|
joachim99@14
|
54
|
joachim99@14
|
55 EXTRACT_PRIVATE = NO
|
joachim99@14
|
56
|
joachim99@14
|
57 # If the EXTRACT_STATIC tag is set to YES all static members of a file
|
joachim99@14
|
58 # will be included in the documentation.
|
joachim99@14
|
59
|
joachim99@14
|
60 EXTRACT_STATIC = YES
|
joachim99@14
|
61
|
joachim99@14
|
62 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
|
joachim99@14
|
63 # defined locally in source files will be included in the documentation.
|
joachim99@14
|
64 # If set to NO only classes defined in header files are included.
|
joachim99@14
|
65
|
joachim99@14
|
66 EXTRACT_LOCAL_CLASSES = NO
|
joachim99@14
|
67
|
joachim99@14
|
68 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
|
joachim99@14
|
69 # undocumented members of documented classes, files or namespaces.
|
joachim99@14
|
70 # If set to NO (the default) these members will be included in the
|
joachim99@14
|
71 # various overviews, but no documentation section is generated.
|
joachim99@14
|
72 # This option has no effect if EXTRACT_ALL is enabled.
|
joachim99@14
|
73
|
joachim99@14
|
74 HIDE_UNDOC_MEMBERS = NO
|
joachim99@14
|
75
|
joachim99@14
|
76 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
|
joachim99@14
|
77 # undocumented classes that are normally visible in the class hierarchy.
|
joachim99@14
|
78 # If set to NO (the default) these class will be included in the various
|
joachim99@14
|
79 # overviews. This option has no effect if EXTRACT_ALL is enabled.
|
joachim99@14
|
80
|
joachim99@14
|
81 HIDE_UNDOC_CLASSES = YES
|
joachim99@14
|
82
|
joachim99@14
|
83 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
|
joachim99@14
|
84 # include brief member descriptions after the members that are listed in
|
joachim99@14
|
85 # the file and class documentation (similar to JavaDoc).
|
joachim99@14
|
86 # Set to NO to disable this.
|
joachim99@14
|
87
|
joachim99@14
|
88 BRIEF_MEMBER_DESC = NO
|
joachim99@14
|
89
|
joachim99@14
|
90 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
|
joachim99@14
|
91 # the brief description of a member or function before the detailed description.
|
joachim99@14
|
92 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
joachim99@14
|
93 # brief descriptions will be completely suppressed.
|
joachim99@14
|
94
|
joachim99@14
|
95 REPEAT_BRIEF = YES
|
joachim99@14
|
96
|
joachim99@14
|
97 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
|
joachim99@14
|
98 # Doxygen will generate a detailed section even if there is only a brief
|
joachim99@14
|
99 # description.
|
joachim99@14
|
100
|
joachim99@14
|
101 ALWAYS_DETAILED_SEC = YES
|
joachim99@14
|
102
|
joachim99@14
|
103 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
|
joachim99@14
|
104 # members of a class in the documentation of that class as if those members were
|
joachim99@14
|
105 # ordinary class members. Constructors, destructors and assignment operators of
|
joachim99@14
|
106 # the base classes will not be shown.
|
joachim99@14
|
107
|
joachim99@14
|
108 INLINE_INHERITED_MEMB = NO
|
joachim99@14
|
109
|
joachim99@14
|
110 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
|
joachim99@14
|
111 # path before files name in the file list and in the header files. If set
|
joachim99@14
|
112 # to NO the shortest path that makes the file name unique will be used.
|
joachim99@14
|
113
|
joachim99@14
|
114 FULL_PATH_NAMES = NO
|
joachim99@14
|
115
|
joachim99@14
|
116 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
|
joachim99@14
|
117 # can be used to strip a user defined part of the path. Stripping is
|
joachim99@14
|
118 # only done if one of the specified strings matches the left-hand part of
|
joachim99@14
|
119 # the path. It is allowed to use relative paths in the argument list.
|
joachim99@14
|
120
|
joachim99@14
|
121 STRIP_FROM_PATH =
|
joachim99@14
|
122
|
joachim99@14
|
123 # The INTERNAL_DOCS tag determines if documentation
|
joachim99@14
|
124 # that is typed after a \internal command is included. If the tag is set
|
joachim99@14
|
125 # to NO (the default) then the documentation will be excluded.
|
joachim99@14
|
126 # Set it to YES to include the internal documentation.
|
joachim99@14
|
127
|
joachim99@14
|
128 INTERNAL_DOCS = NO
|
joachim99@14
|
129
|
joachim99@14
|
130 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
|
joachim99@14
|
131 # doxygen to hide any special comment blocks from generated source code
|
joachim99@14
|
132 # fragments. Normal C and C++ comments will always remain visible.
|
joachim99@14
|
133
|
joachim99@14
|
134 STRIP_CODE_COMMENTS = YES
|
joachim99@14
|
135
|
joachim99@14
|
136 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
|
joachim99@14
|
137 # file names in lower case letters. If set to YES upper case letters are also
|
joachim99@14
|
138 # allowed. This is useful if you have classes or files whose names only differ
|
joachim99@14
|
139 # in case and if your file system supports case sensitive file names. Windows
|
joachim99@14
|
140 # users are adviced to set this option to NO.
|
joachim99@14
|
141
|
joachim99@14
|
142 CASE_SENSE_NAMES = YES
|
joachim99@14
|
143
|
joachim99@14
|
144 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
|
joachim99@14
|
145 # (but less readable) file names. This can be useful is your file systems
|
joachim99@14
|
146 # doesn't support long names like on DOS, Mac, or CD-ROM.
|
joachim99@14
|
147
|
joachim99@14
|
148 SHORT_NAMES = NO
|
joachim99@14
|
149
|
joachim99@14
|
150 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
|
joachim99@14
|
151 # will show members with their full class and namespace scopes in the
|
joachim99@14
|
152 # documentation. If set to YES the scope will be hidden.
|
joachim99@14
|
153
|
joachim99@14
|
154 HIDE_SCOPE_NAMES = NO
|
joachim99@14
|
155
|
joachim99@14
|
156 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
|
joachim99@14
|
157 # will generate a verbatim copy of the header file for each class for
|
joachim99@14
|
158 # which an include is specified. Set to NO to disable this.
|
joachim99@14
|
159
|
joachim99@14
|
160 VERBATIM_HEADERS = YES
|
joachim99@14
|
161
|
joachim99@14
|
162 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
|
joachim99@14
|
163 # will put list of the files that are included by a file in the documentation
|
joachim99@14
|
164 # of that file.
|
joachim99@14
|
165
|
joachim99@14
|
166 SHOW_INCLUDE_FILES = YES
|
joachim99@14
|
167
|
joachim99@14
|
168 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
|
joachim99@14
|
169 # will interpret the first line (until the first dot) of a JavaDoc-style
|
joachim99@14
|
170 # comment as the brief description. If set to NO, the JavaDoc
|
joachim99@14
|
171 # comments will behave just like the Qt-style comments (thus requiring an
|
joachim99@14
|
172 # explict @brief command for a brief description.
|
joachim99@14
|
173
|
joachim99@14
|
174 JAVADOC_AUTOBRIEF = YES
|
joachim99@14
|
175
|
joachim99@14
|
176 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
|
joachim99@14
|
177 # member inherits the documentation from any documented member that it
|
joachim99@14
|
178 # reimplements.
|
joachim99@14
|
179
|
joachim99@14
|
180 INHERIT_DOCS = YES
|
joachim99@14
|
181
|
joachim99@14
|
182 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
|
joachim99@14
|
183 # is inserted in the documentation for inline members.
|
joachim99@14
|
184
|
joachim99@14
|
185 INLINE_INFO = YES
|
joachim99@14
|
186
|
joachim99@14
|
187 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
|
joachim99@14
|
188 # will sort the (detailed) documentation of file and class members
|
joachim99@14
|
189 # alphabetically by member name. If set to NO the members will appear in
|
joachim99@14
|
190 # declaration order.
|
joachim99@14
|
191
|
joachim99@14
|
192 SORT_MEMBER_DOCS = NO
|
joachim99@14
|
193
|
joachim99@14
|
194 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
joachim99@14
|
195 # tag is set to YES, then doxygen will reuse the documentation of the first
|
joachim99@14
|
196 # member in the group (if any) for the other members of the group. By default
|
joachim99@14
|
197 # all members of a group must be documented explicitly.
|
joachim99@14
|
198
|
joachim99@14
|
199 DISTRIBUTE_GROUP_DOC = NO
|
joachim99@14
|
200
|
joachim99@14
|
201 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
|
joachim99@14
|
202 # Doxygen uses this value to replace tabs by spaces in code fragments.
|
joachim99@14
|
203
|
joachim99@14
|
204 TAB_SIZE = 4
|
joachim99@14
|
205
|
joachim99@14
|
206 # The GENERATE_TODOLIST tag can be used to enable (YES) or
|
joachim99@14
|
207 # disable (NO) the todo list. This list is created by putting \todo
|
joachim99@14
|
208 # commands in the documentation.
|
joachim99@14
|
209
|
joachim99@14
|
210 GENERATE_TODOLIST = NO
|
joachim99@14
|
211
|
joachim99@14
|
212 # The GENERATE_TESTLIST tag can be used to enable (YES) or
|
joachim99@14
|
213 # disable (NO) the test list. This list is created by putting \test
|
joachim99@14
|
214 # commands in the documentation.
|
joachim99@14
|
215
|
joachim99@14
|
216 GENERATE_TESTLIST = NO
|
joachim99@14
|
217
|
joachim99@14
|
218 # The GENERATE_BUGLIST tag can be used to enable (YES) or
|
joachim99@14
|
219 # disable (NO) the bug list. This list is created by putting \bug
|
joachim99@14
|
220 # commands in the documentation.
|
joachim99@14
|
221
|
joachim99@14
|
222 GENERATE_BUGLIST = YES
|
joachim99@14
|
223
|
joachim99@14
|
224 # This tag can be used to specify a number of aliases that acts
|
joachim99@14
|
225 # as commands in the documentation. An alias has the form "name=value".
|
joachim99@14
|
226 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
|
joachim99@14
|
227 # put the command \sideeffect (or @sideeffect) in the documentation, which
|
joachim99@14
|
228 # will result in a user defined paragraph with heading "Side Effects:".
|
joachim99@14
|
229 # You can put \n's in the value part of an alias to insert newlines.
|
joachim99@14
|
230
|
joachim99@14
|
231 # @ref in KDE docu are for kdoc, doxygen doesn't need them, so we alias them
|
joachim99@14
|
232 # to nothing here
|
joachim99@14
|
233
|
joachim99@14
|
234 ALIASES = libdoc=@mainpage \
|
joachim99@14
|
235 sect=<p><b> \
|
joachim99@14
|
236 reimplemented= \
|
joachim99@14
|
237 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \
|
joachim99@14
|
238 obsolete=@deprecated \
|
joachim99@14
|
239 ref=
|
joachim99@14
|
240
|
joachim99@14
|
241 # The ENABLED_SECTIONS tag can be used to enable conditional
|
joachim99@14
|
242 # documentation sections, marked by \if sectionname ... \endif.
|
joachim99@14
|
243
|
joachim99@14
|
244 ENABLED_SECTIONS =
|
joachim99@14
|
245
|
joachim99@14
|
246 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
|
joachim99@14
|
247 # the initial value of a variable or define consist of for it to appear in
|
joachim99@14
|
248 # the documentation. If the initializer consists of more lines than specified
|
joachim99@14
|
249 # here it will be hidden. Use a value of 0 to hide initializers completely.
|
joachim99@14
|
250 # The appearance of the initializer of individual variables and defines in the
|
joachim99@14
|
251 # documentation can be controlled using \showinitializer or \hideinitializer
|
joachim99@14
|
252 # command in the documentation regardless of this setting.
|
joachim99@14
|
253
|
joachim99@14
|
254 MAX_INITIALIZER_LINES = 30
|
joachim99@14
|
255
|
joachim99@14
|
256 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
|
joachim99@14
|
257 # only. Doxygen will then generate output that is more tailored for C.
|
joachim99@14
|
258 # For instance some of the names that are used will be different. The list
|
joachim99@14
|
259 # of all members will be omitted, etc.
|
joachim99@14
|
260
|
joachim99@14
|
261 OPTIMIZE_OUTPUT_FOR_C = NO
|
joachim99@14
|
262
|
joachim99@14
|
263 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
|
joachim99@14
|
264 # only. Doxygen will then generate output that is more tailored for Java.
|
joachim99@14
|
265 # For instance namespaces will be presented as packages, qualified scopes
|
joachim99@14
|
266 # will look different, etc.
|
joachim99@14
|
267
|
joachim99@14
|
268 OPTIMIZE_OUTPUT_JAVA = NO
|
joachim99@14
|
269
|
joachim99@14
|
270 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
|
joachim99@14
|
271 # at the bottom of the documentation of classes and structs. If set to YES the
|
joachim99@14
|
272 # list will mention the files that were used to generate the documentation.
|
joachim99@14
|
273
|
joachim99@14
|
274 SHOW_USED_FILES = YES
|
joachim99@14
|
275
|
joachim99@14
|
276 #---------------------------------------------------------------------------
|
joachim99@14
|
277 # configuration options related to warning and progress messages
|
joachim99@14
|
278 #---------------------------------------------------------------------------
|
joachim99@14
|
279
|
joachim99@14
|
280 # The QUIET tag can be used to turn on/off the messages that are generated
|
joachim99@14
|
281 # by doxygen. Possible values are YES and NO. If left blank NO is used.
|
joachim99@14
|
282
|
joachim99@14
|
283 QUIET = YES
|
joachim99@14
|
284
|
joachim99@14
|
285 # The WARNINGS tag can be used to turn on/off the warning messages that are
|
joachim99@14
|
286 # generated by doxygen. Possible values are YES and NO. If left blank
|
joachim99@14
|
287 # NO is used.
|
joachim99@14
|
288
|
joachim99@14
|
289 WARNINGS = YES
|
joachim99@14
|
290
|
joachim99@14
|
291 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
|
joachim99@14
|
292 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
|
joachim99@14
|
293 # automatically be disabled.
|
joachim99@14
|
294
|
joachim99@14
|
295 WARN_IF_UNDOCUMENTED = NO
|
joachim99@14
|
296
|
joachim99@14
|
297 # The WARN_FORMAT tag determines the format of the warning messages that
|
joachim99@14
|
298 # doxygen can produce. The string should contain the $file, $line, and $text
|
joachim99@14
|
299 # tags, which will be replaced by the file and line number from which the
|
joachim99@14
|
300 # warning originated and the warning text.
|
joachim99@14
|
301
|
joachim99@14
|
302 WARN_FORMAT =
|
joachim99@14
|
303
|
joachim99@14
|
304 # The WARN_LOGFILE tag can be used to specify a file to which warning
|
joachim99@14
|
305 # and error messages should be written. If left blank the output is written
|
joachim99@14
|
306 # to stderr.
|
joachim99@14
|
307
|
joachim99@14
|
308 WARN_LOGFILE =
|
joachim99@14
|
309
|
joachim99@14
|
310 #---------------------------------------------------------------------------
|
joachim99@14
|
311 # configuration options related to the input files
|
joachim99@14
|
312 #---------------------------------------------------------------------------
|
joachim99@14
|
313
|
joachim99@14
|
314 # The INPUT tag can be used to specify the files and/or directories that contain
|
joachim99@14
|
315 # documented source files. You may enter file names like "myfile.cpp" or
|
joachim99@14
|
316 # directories like "/usr/src/myproject". Separate the files or directories
|
joachim99@14
|
317 # with spaces.
|
joachim99@14
|
318
|
joachim99@14
|
319 INPUT =
|
joachim99@14
|
320
|
joachim99@14
|
321 # If the value of the INPUT tag contains directories, you can use the
|
joachim99@14
|
322 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
joachim99@14
|
323 # and *.h) to filter out the source-files in the directories. If left
|
joachim99@14
|
324 # blank the following patterns are tested:
|
joachim99@14
|
325 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
|
joachim99@14
|
326 # *.h++ *.idl *.odl
|
joachim99@14
|
327
|
joachim99@14
|
328 FILE_PATTERNS = *.h \
|
joachim99@14
|
329 *.cpp \
|
joachim99@14
|
330 *.cc \
|
joachim99@14
|
331 *.hpp
|
joachim99@14
|
332
|
joachim99@14
|
333 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
|
joachim99@14
|
334 # should be searched for input files as well. Possible values are YES and NO.
|
joachim99@14
|
335 # If left blank NO is used.
|
joachim99@14
|
336
|
joachim99@14
|
337 RECURSIVE = YES
|
joachim99@14
|
338
|
joachim99@14
|
339 # The EXCLUDE tag can be used to specify files and/or directories that should
|
joachim99@14
|
340 # excluded from the INPUT source files. This way you can easily exclude a
|
joachim99@14
|
341 # subdirectory from a directory tree whose root is specified with the INPUT tag.
|
joachim99@14
|
342
|
joachim99@14
|
343 EXCLUDE =
|
joachim99@14
|
344
|
joachim99@14
|
345 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
|
joachim99@14
|
346 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
|
joachim99@14
|
347
|
joachim99@14
|
348 EXCLUDE_SYMLINKS = NO
|
joachim99@14
|
349
|
joachim99@14
|
350 # If the value of the INPUT tag contains directories, you can use the
|
joachim99@14
|
351 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
joachim99@14
|
352 # certain files from those directories.
|
joachim99@14
|
353
|
joachim99@14
|
354 EXCLUDE_PATTERNS = *.moc.* \
|
joachim99@14
|
355 moc* \
|
joachim99@14
|
356 *.all_cpp.* \
|
joachim99@14
|
357 *unload.* \
|
joachim99@14
|
358 */test/* \
|
joachim99@14
|
359 */tests/*
|
joachim99@14
|
360
|
joachim99@14
|
361 # The EXAMPLE_PATH tag can be used to specify one or more files or
|
joachim99@14
|
362 # directories that contain example code fragments that are included (see
|
joachim99@14
|
363 # the \include command).
|
joachim99@14
|
364
|
joachim99@14
|
365 EXAMPLE_PATH =
|
joachim99@14
|
366
|
joachim99@14
|
367 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
joachim99@14
|
368 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
joachim99@14
|
369 # and *.h) to filter out the source-files in the directories. If left
|
joachim99@14
|
370 # blank all files are included.
|
joachim99@14
|
371
|
joachim99@14
|
372 EXAMPLE_PATTERNS =
|
joachim99@14
|
373
|
joachim99@14
|
374 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
|
joachim99@14
|
375 # searched for input files to be used with the \include or \dontinclude
|
joachim99@14
|
376 # commands irrespective of the value of the RECURSIVE tag.
|
joachim99@14
|
377 # Possible values are YES and NO. If left blank NO is used.
|
joachim99@14
|
378
|
joachim99@14
|
379 EXAMPLE_RECURSIVE = NO
|
joachim99@14
|
380
|
joachim99@14
|
381 # The IMAGE_PATH tag can be used to specify one or more files or
|
joachim99@14
|
382 # directories that contain image that are included in the documentation (see
|
joachim99@14
|
383 # the \image command).
|
joachim99@14
|
384
|
joachim99@14
|
385 IMAGE_PATH =
|
joachim99@14
|
386
|
joachim99@14
|
387 # The INPUT_FILTER tag can be used to specify a program that doxygen should
|
joachim99@14
|
388 # invoke to filter for each input file. Doxygen will invoke the filter program
|
joachim99@14
|
389 # by executing (via popen()) the command <filter> <input-file>, where <filter>
|
joachim99@14
|
390 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
|
joachim99@14
|
391 # input file. Doxygen will then use the output that the filter program writes
|
joachim99@14
|
392 # to standard output.
|
joachim99@14
|
393
|
joachim99@14
|
394 INPUT_FILTER =
|
joachim99@14
|
395
|
joachim99@14
|
396 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
|
joachim99@14
|
397 # INPUT_FILTER) will be used to filter the input files when producing source
|
joachim99@14
|
398 # files to browse.
|
joachim99@14
|
399
|
joachim99@14
|
400 FILTER_SOURCE_FILES = NO
|
joachim99@14
|
401
|
joachim99@14
|
402 #---------------------------------------------------------------------------
|
joachim99@14
|
403 # configuration options related to source browsing
|
joachim99@14
|
404 #---------------------------------------------------------------------------
|
joachim99@14
|
405
|
joachim99@14
|
406 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
|
joachim99@14
|
407 # be generated. Documented entities will be cross-referenced with these sources.
|
joachim99@14
|
408
|
joachim99@14
|
409 SOURCE_BROWSER = YES
|
joachim99@14
|
410
|
joachim99@14
|
411 # Setting the INLINE_SOURCES tag to YES will include the body
|
joachim99@14
|
412 # of functions and classes directly in the documentation.
|
joachim99@14
|
413
|
joachim99@14
|
414 INLINE_SOURCES = NO
|
joachim99@14
|
415
|
joachim99@14
|
416 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
|
joachim99@14
|
417 # then for each documented function all documented
|
joachim99@14
|
418 # functions referencing it will be listed.
|
joachim99@14
|
419
|
joachim99@14
|
420 REFERENCED_BY_RELATION = YES
|
joachim99@14
|
421
|
joachim99@14
|
422 # If the REFERENCES_RELATION tag is set to YES (the default)
|
joachim99@14
|
423 # then for each documented function all documented entities
|
joachim99@14
|
424 # called/used by that function will be listed.
|
joachim99@14
|
425
|
joachim99@14
|
426 REFERENCES_RELATION = YES
|
joachim99@14
|
427
|
joachim99@14
|
428 #---------------------------------------------------------------------------
|
joachim99@14
|
429 # configuration options related to the alphabetical class index
|
joachim99@14
|
430 #---------------------------------------------------------------------------
|
joachim99@14
|
431
|
joachim99@14
|
432 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
|
joachim99@14
|
433 # of all compounds will be generated. Enable this if the project
|
joachim99@14
|
434 # contains a lot of classes, structs, unions or interfaces.
|
joachim99@14
|
435
|
joachim99@14
|
436 ALPHABETICAL_INDEX = YES
|
joachim99@14
|
437
|
joachim99@14
|
438 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
|
joachim99@14
|
439 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
|
joachim99@14
|
440 # in which this list will be split (can be a number in the range [1..20])
|
joachim99@14
|
441
|
joachim99@14
|
442 COLS_IN_ALPHA_INDEX = 3
|
joachim99@14
|
443
|
joachim99@14
|
444 # In case all classes in a project start with a common prefix, all
|
joachim99@14
|
445 # classes will be put under the same header in the alphabetical index.
|
joachim99@14
|
446 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
|
joachim99@14
|
447 # should be ignored while generating the index headers.
|
joachim99@14
|
448
|
joachim99@14
|
449 IGNORE_PREFIX = K
|
joachim99@14
|
450
|
joachim99@14
|
451 #---------------------------------------------------------------------------
|
joachim99@14
|
452 # configuration options related to the HTML output
|
joachim99@14
|
453 #---------------------------------------------------------------------------
|
joachim99@14
|
454
|
joachim99@14
|
455 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
|
joachim99@14
|
456 # generate HTML output.
|
joachim99@14
|
457
|
joachim99@14
|
458 GENERATE_HTML = NO
|
joachim99@14
|
459
|
joachim99@14
|
460 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
|
joachim99@14
|
461 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
joachim99@14
|
462 # put in front of it. If left blank `html' will be used as the default path.
|
joachim99@14
|
463
|
joachim99@14
|
464 HTML_OUTPUT =
|
joachim99@14
|
465
|
joachim99@14
|
466 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
|
joachim99@14
|
467 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
|
joachim99@14
|
468 # doxygen will generate files with .html extension.
|
joachim99@14
|
469
|
joachim99@14
|
470 HTML_FILE_EXTENSION = .html
|
joachim99@14
|
471
|
joachim99@14
|
472 # The HTML_HEADER tag can be used to specify a personal HTML header for
|
joachim99@14
|
473 # each generated HTML page. If it is left blank doxygen will generate a
|
joachim99@14
|
474 # standard header.
|
joachim99@14
|
475
|
joachim99@14
|
476 HTML_HEADER = ../apidocs/common/header.html
|
joachim99@14
|
477
|
joachim99@14
|
478 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
|
joachim99@14
|
479 # each generated HTML page. If it is left blank doxygen will generate a
|
joachim99@14
|
480 # standard footer.
|
joachim99@14
|
481
|
joachim99@14
|
482 HTML_FOOTER = ../apidocs/common/footer.html
|
joachim99@14
|
483
|
joachim99@14
|
484 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
|
joachim99@14
|
485 # style sheet that is used by each HTML page. It can be used to
|
joachim99@14
|
486 # fine-tune the look of the HTML output. If the tag is left blank doxygen
|
joachim99@14
|
487 # will generate a default style sheet
|
joachim99@14
|
488
|
joachim99@14
|
489 HTML_STYLESHEET = ../apidocs/common/doxygen.css
|
joachim99@14
|
490
|
joachim99@14
|
491 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
|
joachim99@14
|
492 # files or namespaces will be aligned in HTML using tables. If set to
|
joachim99@14
|
493 # NO a bullet list will be used.
|
joachim99@14
|
494
|
joachim99@14
|
495 HTML_ALIGN_MEMBERS = YES
|
joachim99@14
|
496
|
joachim99@14
|
497 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
|
joachim99@14
|
498 # will be generated that can be used as input for tools like the
|
joachim99@14
|
499 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
|
joachim99@14
|
500 # of the generated HTML documentation.
|
joachim99@14
|
501
|
joachim99@14
|
502 GENERATE_HTMLHELP = NO
|
joachim99@14
|
503
|
joachim99@14
|
504 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
|
joachim99@14
|
505 # controls if a separate .chi index file is generated (YES) or that
|
joachim99@14
|
506 # it should be included in the master .chm file (NO).
|
joachim99@14
|
507
|
joachim99@14
|
508 GENERATE_CHI = NO
|
joachim99@14
|
509
|
joachim99@14
|
510 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
|
joachim99@14
|
511 # controls whether a binary table of contents is generated (YES) or a
|
joachim99@14
|
512 # normal table of contents (NO) in the .chm file.
|
joachim99@14
|
513
|
joachim99@14
|
514 BINARY_TOC = NO
|
joachim99@14
|
515
|
joachim99@14
|
516 # The TOC_EXPAND flag can be set to YES to add extra items for group members
|
joachim99@14
|
517 # to the contents of the Html help documentation and to the tree view.
|
joachim99@14
|
518
|
joachim99@14
|
519 TOC_EXPAND = NO
|
joachim99@14
|
520
|
joachim99@14
|
521 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
|
joachim99@14
|
522 # top of each HTML page. The value NO (the default) enables the index and
|
joachim99@14
|
523 # the value YES disables it.
|
joachim99@14
|
524
|
joachim99@14
|
525 DISABLE_INDEX = YES
|
joachim99@14
|
526
|
joachim99@14
|
527 # This tag can be used to set the number of enum values (range [1..20])
|
joachim99@14
|
528 # that doxygen will group on one line in the generated HTML documentation.
|
joachim99@14
|
529
|
joachim99@14
|
530 ENUM_VALUES_PER_LINE = 4
|
joachim99@14
|
531
|
joachim99@14
|
532 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
|
joachim99@14
|
533 # generated containing a tree-like index structure (just like the one that
|
joachim99@14
|
534 # is generated for HTML Help). For this to work a browser that supports
|
joachim99@14
|
535 # JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
|
joachim99@14
|
536 # or Internet explorer 4.0+). Note that for large projects the tree generation
|
joachim99@14
|
537 # can take a very long time. In such cases it is better to disable this feature.
|
joachim99@14
|
538 # Windows users are probably better off using the HTML help feature.
|
joachim99@14
|
539
|
joachim99@14
|
540 GENERATE_TREEVIEW = NO
|
joachim99@14
|
541
|
joachim99@14
|
542 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
|
joachim99@14
|
543 # used to set the initial width (in pixels) of the frame in which the tree
|
joachim99@14
|
544 # is shown.
|
joachim99@14
|
545
|
joachim99@14
|
546 TREEVIEW_WIDTH = 250
|
joachim99@14
|
547
|
joachim99@14
|
548 #---------------------------------------------------------------------------
|
joachim99@14
|
549 # configuration options related to the LaTeX output
|
joachim99@14
|
550 #---------------------------------------------------------------------------
|
joachim99@14
|
551
|
joachim99@14
|
552 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
|
joachim99@14
|
553 # generate Latex output.
|
joachim99@14
|
554
|
joachim99@14
|
555 GENERATE_LATEX = NO
|
joachim99@14
|
556
|
joachim99@14
|
557 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
|
joachim99@14
|
558 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
joachim99@14
|
559 # put in front of it. If left blank `latex' will be used as the default path.
|
joachim99@14
|
560
|
joachim99@14
|
561 LATEX_OUTPUT =
|
joachim99@14
|
562
|
joachim99@14
|
563 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
|
joachim99@14
|
564
|
joachim99@14
|
565 LATEX_CMD_NAME = latex
|
joachim99@14
|
566
|
joachim99@14
|
567 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
|
joachim99@14
|
568 # generate index for LaTeX. If left blank `makeindex' will be used as the
|
joachim99@14
|
569 # default command name.
|
joachim99@14
|
570
|
joachim99@14
|
571 MAKEINDEX_CMD_NAME = makeindex
|
joachim99@14
|
572
|
joachim99@14
|
573 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
|
joachim99@14
|
574 # LaTeX documents. This may be useful for small projects and may help to
|
joachim99@14
|
575 # save some trees in general.
|
joachim99@14
|
576
|
joachim99@14
|
577 COMPACT_LATEX = NO
|
joachim99@14
|
578
|
joachim99@14
|
579 # The PAPER_TYPE tag can be used to set the paper type that is used
|
joachim99@14
|
580 # by the printer. Possible values are: a4, a4wide, letter, legal and
|
joachim99@14
|
581 # executive. If left blank a4wide will be used.
|
joachim99@14
|
582
|
joachim99@14
|
583 PAPER_TYPE = a4wide
|
joachim99@14
|
584
|
joachim99@14
|
585 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
|
joachim99@14
|
586 # packages that should be included in the LaTeX output.
|
joachim99@14
|
587
|
joachim99@14
|
588 EXTRA_PACKAGES =
|
joachim99@14
|
589
|
joachim99@14
|
590 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
|
joachim99@14
|
591 # the generated latex document. The header should contain everything until
|
joachim99@14
|
592 # the first chapter. If it is left blank doxygen will generate a
|
joachim99@14
|
593 # standard header. Notice: only use this tag if you know what you are doing!
|
joachim99@14
|
594
|
joachim99@14
|
595 LATEX_HEADER =
|
joachim99@14
|
596
|
joachim99@14
|
597 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
|
joachim99@14
|
598 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
|
joachim99@14
|
599 # contain links (just like the HTML output) instead of page references
|
joachim99@14
|
600 # This makes the output suitable for online browsing using a pdf viewer.
|
joachim99@14
|
601
|
joachim99@14
|
602 PDF_HYPERLINKS = NO
|
joachim99@14
|
603
|
joachim99@14
|
604 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
|
joachim99@14
|
605 # plain latex in the generated Makefile. Set this option to YES to get a
|
joachim99@14
|
606 # higher quality PDF documentation.
|
joachim99@14
|
607
|
joachim99@14
|
608 USE_PDFLATEX = NO
|
joachim99@14
|
609
|
joachim99@14
|
610 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
|
joachim99@14
|
611 # command to the generated LaTeX files. This will instruct LaTeX to keep
|
joachim99@14
|
612 # running if errors occur, instead of asking the user for help.
|
joachim99@14
|
613 # This option is also used when generating formulas in HTML.
|
joachim99@14
|
614
|
joachim99@14
|
615 LATEX_BATCHMODE = NO
|
joachim99@14
|
616
|
joachim99@14
|
617 #---------------------------------------------------------------------------
|
joachim99@14
|
618 # configuration options related to the RTF output
|
joachim99@14
|
619 #---------------------------------------------------------------------------
|
joachim99@14
|
620
|
joachim99@14
|
621 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
|
joachim99@14
|
622 # The RTF output is optimised for Word 97 and may not look very pretty with
|
joachim99@14
|
623 # other RTF readers or editors.
|
joachim99@14
|
624
|
joachim99@14
|
625 GENERATE_RTF = NO
|
joachim99@14
|
626
|
joachim99@14
|
627 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
|
joachim99@14
|
628 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
joachim99@14
|
629 # put in front of it. If left blank `rtf' will be used as the default path.
|
joachim99@14
|
630
|
joachim99@14
|
631 RTF_OUTPUT =
|
joachim99@14
|
632
|
joachim99@14
|
633 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
|
joachim99@14
|
634 # RTF documents. This may be useful for small projects and may help to
|
joachim99@14
|
635 # save some trees in general.
|
joachim99@14
|
636
|
joachim99@14
|
637 COMPACT_RTF = NO
|
joachim99@14
|
638
|
joachim99@14
|
639 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
|
joachim99@14
|
640 # will contain hyperlink fields. The RTF file will
|
joachim99@14
|
641 # contain links (just like the HTML output) instead of page references.
|
joachim99@14
|
642 # This makes the output suitable for online browsing using WORD or other
|
joachim99@14
|
643 # programs which support those fields.
|
joachim99@14
|
644 # Note: wordpad (write) and others do not support links.
|
joachim99@14
|
645
|
joachim99@14
|
646 RTF_HYPERLINKS = NO
|
joachim99@14
|
647
|
joachim99@14
|
648 # Load stylesheet definitions from file. Syntax is similar to doxygen's
|
joachim99@14
|
649 # config file, i.e. a series of assigments. You only have to provide
|
joachim99@14
|
650 # replacements, missing definitions are set to their default value.
|
joachim99@14
|
651
|
joachim99@14
|
652 RTF_STYLESHEET_FILE =
|
joachim99@14
|
653
|
joachim99@14
|
654 # Set optional variables used in the generation of an rtf document.
|
joachim99@14
|
655 # Syntax is similar to doxygen's config file.
|
joachim99@14
|
656
|
joachim99@14
|
657 RTF_EXTENSIONS_FILE =
|
joachim99@14
|
658
|
joachim99@14
|
659 #---------------------------------------------------------------------------
|
joachim99@14
|
660 # configuration options related to the man page output
|
joachim99@14
|
661 #---------------------------------------------------------------------------
|
joachim99@14
|
662
|
joachim99@14
|
663 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
|
joachim99@14
|
664 # generate man pages
|
joachim99@14
|
665
|
joachim99@14
|
666 GENERATE_MAN = NO
|
joachim99@14
|
667
|
joachim99@14
|
668 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
|
joachim99@14
|
669 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
joachim99@14
|
670 # put in front of it. If left blank `man' will be used as the default path.
|
joachim99@14
|
671
|
joachim99@14
|
672 MAN_OUTPUT =
|
joachim99@14
|
673
|
joachim99@14
|
674 # The MAN_EXTENSION tag determines the extension that is added to
|
joachim99@14
|
675 # the generated man pages (default is the subroutine's section .3)
|
joachim99@14
|
676
|
joachim99@14
|
677 MAN_EXTENSION = .kde3
|
joachim99@14
|
678
|
joachim99@14
|
679 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
|
joachim99@14
|
680 # then it will generate one additional man file for each entity
|
joachim99@14
|
681 # documented in the real man page(s). These additional files
|
joachim99@14
|
682 # only source the real man page, but without them the man command
|
joachim99@14
|
683 # would be unable to find the correct page. The default is NO.
|
joachim99@14
|
684
|
joachim99@14
|
685 MAN_LINKS = YES
|
joachim99@14
|
686
|
joachim99@14
|
687 #---------------------------------------------------------------------------
|
joachim99@14
|
688 # configuration options related to the XML output
|
joachim99@14
|
689 #---------------------------------------------------------------------------
|
joachim99@14
|
690
|
joachim99@14
|
691 # If the GENERATE_XML tag is set to YES Doxygen will
|
joachim99@14
|
692 # generate an XML file that captures the structure of
|
joachim99@14
|
693 # the code including all documentation. Note that this
|
joachim99@14
|
694 # feature is still experimental and incomplete at the
|
joachim99@14
|
695 # moment.
|
joachim99@14
|
696
|
joachim99@14
|
697 GENERATE_XML = NO
|
joachim99@14
|
698
|
joachim99@14
|
699 #---------------------------------------------------------------------------
|
joachim99@14
|
700 # configuration options for the AutoGen Definitions output
|
joachim99@14
|
701 #---------------------------------------------------------------------------
|
joachim99@14
|
702
|
joachim99@14
|
703 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
|
joachim99@14
|
704 # generate an AutoGen Definitions (see autogen.sf.net) file
|
joachim99@14
|
705 # that captures the structure of the code including all
|
joachim99@14
|
706 # documentation. Note that this feature is still experimental
|
joachim99@14
|
707 # and incomplete at the moment.
|
joachim99@14
|
708
|
joachim99@14
|
709 GENERATE_AUTOGEN_DEF = NO
|
joachim99@14
|
710
|
joachim99@14
|
711 #---------------------------------------------------------------------------
|
joachim99@14
|
712 # Configuration options related to the preprocessor
|
joachim99@14
|
713 #---------------------------------------------------------------------------
|
joachim99@14
|
714
|
joachim99@14
|
715 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
|
joachim99@14
|
716 # evaluate all C-preprocessor directives found in the sources and include
|
joachim99@14
|
717 # files.
|
joachim99@14
|
718
|
joachim99@14
|
719 ENABLE_PREPROCESSING = YES
|
joachim99@14
|
720
|
joachim99@14
|
721 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
|
joachim99@14
|
722 # names in the source code. If set to NO (the default) only conditional
|
joachim99@14
|
723 # compilation will be performed. Macro expansion can be done in a controlled
|
joachim99@14
|
724 # way by setting EXPAND_ONLY_PREDEF to YES.
|
joachim99@14
|
725
|
joachim99@14
|
726 MACRO_EXPANSION = NO
|
joachim99@14
|
727
|
joachim99@14
|
728 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
|
joachim99@14
|
729 # then the macro expansion is limited to the macros specified with the
|
joachim99@14
|
730 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
|
joachim99@14
|
731
|
joachim99@14
|
732 EXPAND_ONLY_PREDEF = NO
|
joachim99@14
|
733
|
joachim99@14
|
734 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
|
joachim99@14
|
735 # in the INCLUDE_PATH (see below) will be search if a #include is found.
|
joachim99@14
|
736
|
joachim99@14
|
737 SEARCH_INCLUDES = YES
|
joachim99@14
|
738
|
joachim99@14
|
739 # The INCLUDE_PATH tag can be used to specify one or more directories that
|
joachim99@14
|
740 # contain include files that are not input files but should be processed by
|
joachim99@14
|
741 # the preprocessor.
|
joachim99@14
|
742
|
joachim99@14
|
743 INCLUDE_PATH =
|
joachim99@14
|
744
|
joachim99@14
|
745 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
|
joachim99@14
|
746 # patterns (like *.h and *.hpp) to filter out the header-files in the
|
joachim99@14
|
747 # directories. If left blank, the patterns specified with FILE_PATTERNS will
|
joachim99@14
|
748 # be used.
|
joachim99@14
|
749
|
joachim99@14
|
750 INCLUDE_FILE_PATTERNS =
|
joachim99@14
|
751
|
joachim99@14
|
752 # The PREDEFINED tag can be used to specify one or more macro names that
|
joachim99@14
|
753 # are defined before the preprocessor is started (similar to the -D option of
|
joachim99@14
|
754 # gcc). The argument of the tag is a list of macros of the form: name
|
joachim99@14
|
755 # or name=definition (no spaces). If the definition and the = are
|
joachim99@14
|
756 # omitted =1 is assumed.
|
joachim99@14
|
757
|
joachim99@14
|
758 PREDEFINED = QT_VERSION=305
|
joachim99@14
|
759
|
joachim99@14
|
760 # If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
|
joachim99@14
|
761 # this tag can be used to specify a list of macro names that should be expanded.
|
joachim99@14
|
762 # The macro definition that is found in the sources will be used.
|
joachim99@14
|
763 # Use the PREDEFINED tag if you want to use a different macro definition.
|
joachim99@14
|
764
|
joachim99@14
|
765 EXPAND_AS_DEFINED =
|
joachim99@14
|
766
|
joachim99@14
|
767 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
|
joachim99@14
|
768 # doxygen's preprocessor will remove all function-like macros that are alone
|
joachim99@14
|
769 # on a line and do not end with a semicolon. Such function macros are typically
|
joachim99@14
|
770 # used for boiler-plate code, and will confuse the parser if not removed.
|
joachim99@14
|
771
|
joachim99@14
|
772 SKIP_FUNCTION_MACROS = YES
|
joachim99@14
|
773
|
joachim99@14
|
774 #---------------------------------------------------------------------------
|
joachim99@14
|
775 # Configuration::addtions related to external references
|
joachim99@14
|
776 #---------------------------------------------------------------------------
|
joachim99@14
|
777
|
joachim99@14
|
778 # The TAGFILES tag can be used to specify one or more tagfiles.
|
joachim99@14
|
779
|
joachim99@14
|
780 TAGFILES =
|
joachim99@14
|
781
|
joachim99@14
|
782 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
|
joachim99@14
|
783 # a tag file that is based on the input files it reads.
|
joachim99@14
|
784
|
joachim99@14
|
785 GENERATE_TAGFILE =
|
joachim99@14
|
786
|
joachim99@14
|
787 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
|
joachim99@14
|
788 # in the class index. If set to NO only the inherited external classes
|
joachim99@14
|
789 # will be listed.
|
joachim99@14
|
790
|
joachim99@14
|
791 ALLEXTERNALS = NO
|
joachim99@14
|
792
|
joachim99@14
|
793 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
|
joachim99@14
|
794 # in the modules index. If set to NO, only the current project's groups will
|
joachim99@14
|
795 # be listed.
|
joachim99@14
|
796
|
joachim99@14
|
797 EXTERNAL_GROUPS = NO
|
joachim99@14
|
798
|
joachim99@14
|
799 # The PERL_PATH should be the absolute path and name of the perl script
|
joachim99@14
|
800 # interpreter (i.e. the result of `which perl').
|
joachim99@14
|
801
|
joachim99@14
|
802 PERL_PATH =
|
joachim99@14
|
803
|
joachim99@14
|
804 #---------------------------------------------------------------------------
|
joachim99@14
|
805 # Configuration options related to the dot tool
|
joachim99@14
|
806 #---------------------------------------------------------------------------
|
joachim99@14
|
807
|
joachim99@14
|
808 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
|
joachim99@14
|
809 # generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
|
joachim99@14
|
810 # super classes. Setting the tag to NO turns the diagrams off. Note that this
|
joachim99@14
|
811 # option is superceded by the HAVE_DOT option below. This is only a fallback. It is
|
joachim99@14
|
812 # recommended to install and use dot, since it yield more powerful graphs.
|
joachim99@14
|
813
|
joachim99@14
|
814 CLASS_DIAGRAMS = YES
|
joachim99@14
|
815
|
joachim99@14
|
816 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
|
joachim99@14
|
817 # available from the path. This tool is part of Graphviz, a graph visualization
|
joachim99@14
|
818 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
|
joachim99@14
|
819 # have no effect if this option is set to NO (the default)
|
joachim99@14
|
820
|
joachim99@14
|
821 HAVE_DOT = NO
|
joachim99@14
|
822
|
joachim99@14
|
823 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
joachim99@14
|
824 # will generate a graph for each documented class showing the direct and
|
joachim99@14
|
825 # indirect inheritance relations. Setting this tag to YES will force the
|
joachim99@14
|
826 # the CLASS_DIAGRAMS tag to NO.
|
joachim99@14
|
827
|
joachim99@14
|
828 CLASS_GRAPH = YES
|
joachim99@14
|
829
|
joachim99@14
|
830 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
joachim99@14
|
831 # will generate a graph for each documented class showing the direct and
|
joachim99@14
|
832 # indirect implementation dependencies (inheritance, containment, and
|
joachim99@14
|
833 # class references variables) of the class with other documented classes.
|
joachim99@14
|
834
|
joachim99@14
|
835 COLLABORATION_GRAPH = YES
|
joachim99@14
|
836
|
joachim99@14
|
837 # If set to YES, the inheritance and collaboration graphs will show the
|
joachim99@14
|
838 # relations between templates and their instances.
|
joachim99@14
|
839
|
joachim99@14
|
840 TEMPLATE_RELATIONS = YES
|
joachim99@14
|
841
|
joachim99@14
|
842 # If set to YES, the inheritance and collaboration graphs will hide
|
joachim99@14
|
843 # inheritance and usage relations if the target is undocumented
|
joachim99@14
|
844 # or is not a class.
|
joachim99@14
|
845
|
joachim99@14
|
846 HIDE_UNDOC_RELATIONS = NO
|
joachim99@14
|
847
|
joachim99@14
|
848 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
|
joachim99@14
|
849 # tags are set to YES then doxygen will generate a graph for each documented
|
joachim99@14
|
850 # file showing the direct and indirect include dependencies of the file with
|
joachim99@14
|
851 # other documented files.
|
joachim99@14
|
852
|
joachim99@14
|
853 INCLUDE_GRAPH = YES
|
joachim99@14
|
854
|
joachim99@14
|
855 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
|
joachim99@14
|
856 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
|
joachim99@14
|
857 # documented header file showing the documented files that directly or
|
joachim99@14
|
858 # indirectly include this file.
|
joachim99@14
|
859
|
joachim99@14
|
860 INCLUDED_BY_GRAPH = YES
|
joachim99@14
|
861
|
joachim99@14
|
862 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
joachim99@14
|
863 # will graphical hierarchy of all classes instead of a textual one.
|
joachim99@14
|
864
|
joachim99@14
|
865 GRAPHICAL_HIERARCHY = NO
|
joachim99@14
|
866
|
joachim99@14
|
867 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
joachim99@14
|
868 # generated by dot. Possible values are png, jpg, or gif
|
joachim99@14
|
869 # If left blank png will be used.
|
joachim99@14
|
870
|
joachim99@14
|
871 DOT_IMAGE_FORMAT = png
|
joachim99@14
|
872
|
joachim99@14
|
873 # The tag DOT_PATH can be used to specify the path where the dot tool can be
|
joachim99@14
|
874 # found. If left blank, it is assumed the dot tool can be found on the path.
|
joachim99@14
|
875
|
joachim99@14
|
876 DOT_PATH =
|
joachim99@14
|
877
|
joachim99@14
|
878 # The DOTFILE_DIRS tag can be used to specify one or more directories that
|
joachim99@14
|
879 # contain dot files that are included in the documentation (see the
|
joachim99@14
|
880 # \dotfile command).
|
joachim99@14
|
881
|
joachim99@14
|
882 DOTFILE_DIRS =
|
joachim99@14
|
883
|
joachim99@14
|
884 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
|
joachim99@14
|
885 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
|
joachim99@14
|
886 # this value, doxygen will try to truncate the graph, so that it fits within
|
joachim99@14
|
887 # the specified constraint. Beware that most browsers cannot cope with very
|
joachim99@14
|
888 # large images.
|
joachim99@14
|
889
|
joachim99@14
|
890 MAX_DOT_GRAPH_WIDTH = 800
|
joachim99@14
|
891
|
joachim99@14
|
892 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
|
joachim99@14
|
893 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
|
joachim99@14
|
894 # this value, doxygen will try to truncate the graph, so that it fits within
|
joachim99@14
|
895 # the specified constraint. Beware that most browsers cannot cope with very
|
joachim99@14
|
896 # large images.
|
joachim99@14
|
897
|
joachim99@14
|
898 MAX_DOT_GRAPH_HEIGHT = 1024
|
joachim99@14
|
899
|
joachim99@14
|
900 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
|
joachim99@14
|
901 # generate a legend page explaining the meaning of the various boxes and
|
joachim99@14
|
902 # arrows in the dot generated graphs.
|
joachim99@14
|
903
|
joachim99@14
|
904 GENERATE_LEGEND = YES
|
joachim99@14
|
905
|
joachim99@14
|
906 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
|
joachim99@14
|
907 # remove the intermedate dot files that are used to generate
|
joachim99@14
|
908 # the various graphs.
|
joachim99@14
|
909
|
joachim99@14
|
910 DOT_CLEANUP = YES
|
joachim99@14
|
911
|
joachim99@14
|
912 #---------------------------------------------------------------------------
|
joachim99@14
|
913 # Configuration::addtions related to the search engine
|
joachim99@14
|
914 #---------------------------------------------------------------------------
|
joachim99@14
|
915
|
joachim99@14
|
916 # The SEARCHENGINE tag specifies whether or not a search engine should be
|
joachim99@14
|
917 # used. If set to NO the values of all tags below this one will be ignored.
|
joachim99@14
|
918
|
joachim99@14
|
919 SEARCHENGINE = NO
|
joachim99@14
|
920
|
joachim99@14
|
921 # The CGI_NAME tag should be the name of the CGI script that
|
joachim99@14
|
922 # starts the search engine (doxysearch) with the correct parameters.
|
joachim99@14
|
923 # A script with this name will be generated by doxygen.
|
joachim99@14
|
924
|
joachim99@14
|
925 CGI_NAME =
|
joachim99@14
|
926
|
joachim99@14
|
927 # The CGI_URL tag should be the absolute URL to the directory where the
|
joachim99@14
|
928 # cgi binaries are located. See the documentation of your http daemon for
|
joachim99@14
|
929 # details.
|
joachim99@14
|
930
|
joachim99@14
|
931 CGI_URL =
|
joachim99@14
|
932
|
joachim99@14
|
933 # The DOC_URL tag should be the absolute URL to the directory where the
|
joachim99@14
|
934 # documentation is located. If left blank the absolute path to the
|
joachim99@14
|
935 # documentation, with file:// prepended to it, will be used.
|
joachim99@14
|
936
|
joachim99@14
|
937 DOC_URL =
|
joachim99@14
|
938
|
joachim99@14
|
939 # The DOC_ABSPATH tag should be the absolute path to the directory where the
|
joachim99@14
|
940 # documentation is located. If left blank the directory on the local machine
|
joachim99@14
|
941 # will be used.
|
joachim99@14
|
942
|
joachim99@14
|
943 DOC_ABSPATH =
|
joachim99@14
|
944
|
joachim99@14
|
945 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
|
joachim99@14
|
946 # is installed.
|
joachim99@14
|
947
|
joachim99@14
|
948 BIN_ABSPATH =
|
joachim99@14
|
949
|
joachim99@14
|
950 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
|
joachim99@14
|
951 # documentation generated for other projects. This allows doxysearch to search
|
joachim99@14
|
952 # the documentation for these projects as well.
|
joachim99@14
|
953
|
joachim99@14
|
954 EXT_DOC_PATHS =
|