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