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