/[svn]/liblscp/trunk/doc/liblscp.doxygen.in
ViewVC logotype

Contents of /liblscp/trunk/doc/liblscp.doxygen.in

Parent Directory Parent Directory | Revision Log Revision Log


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

  ViewVC Help
Powered by ViewVC