MySQL++

Check-in [8bfb213043]

Overview
Comment: Updated Doxygen-related files for Doxygen 1.8.14. Tarball | ZIP archive | SQL archive family | ancestors | descendants | both | files | file ages | folders 8bfb213043e41700e91ce5ccb31f74536fb0e5f8facd57221759e99c17278176 tangent 2018-07-27 03:57:23
Context
 2018-07-27 03:59 Squished a few complaints from Doxygen. NFC. check-in: 57170bf853 user: tangent tags: trunk 03:57 Updated Doxygen-related files for Doxygen 1.8.14. check-in: 8bfb213043 user: tangent tags: trunk 03:49 Whitespace fix check-in: d4b2983283 user: tangent tags: trunk
Changes

     1         -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2         -<html>
1  +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2  +<html xmlns="http://www.w3.org/1999/xhtml">
4      4     <title>MySQL++ Reference Manual</title>
5         -  <meta http-equiv="Content-type" content="text/html;charset=iso-8859-1">
5  +  <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6  +  <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7  +  <meta name="generator" content="Doxygen $doxygenversion"/> 8 + <meta name="viewport" content="width=device-width, initial-scale=1"/> 9 + <!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME--> 10 + <!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
11  +  <link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/> 6 12 <link href="doxygen.css" rel="stylesheet" type="text/css"> 13 + <script type="text/javascript" src="$relpath^jquery.js"></script>
14  +  <script type="text/javascript" src="$relpath^dynsections.js"></script> 15 +$treeview
16  +  $search 17 +$mathjax
18  +  <link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
19  +  $extrastylesheet 7 20 </head> 21 + 8 22 <body> 23 + <div id="top"><!-- do not remove this div, it is closed by doxygen! --> 24 + <!--BEGIN TITLEAREA--> 25 + <div id="titlearea"> 26 + <table cellspacing="0" cellpadding="0"> 27 + <tbody> 28 + <tr style="height: 56px;"> 29 + <!--BEGIN PROJECT_LOGO--> 30 + <td id="projectlogo"><img alt="Logo" src="$relpath^projectlogo"/></td> 31 + <!--END PROJECT_LOGO--> 32 + <!--BEGIN PROJECT_NAME--> 33 + <td id="projectalign" style="padding-left: 0.5em;"> 34 + <div id="projectname">projectname
35  +       <!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER--> 36 + </div> 37 + <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
38  +      </td>
39  +      <!--END PROJECT_NAME-->
40  +      <!--BEGIN !PROJECT_NAME-->
41  +       <!--BEGIN PROJECT_BRIEF-->
43  +        <div id="projectbrief">$projectbrief</div> 44 + </td> 45 + <!--END PROJECT_BRIEF--> 46 + <!--END !PROJECT_NAME--> 47 + <!--BEGIN DISABLE_INDEX--> 48 + <!--BEGIN SEARCHENGINE--> 49 + <td>$searchbox</td>
50  +       <!--END SEARCHENGINE-->
51  +      <!--END DISABLE_INDEX-->
52  +     </tr>
53  +     </tbody>
54  +    </table>
55  +    </div>
56  +    <!--END TITLEAREA-->
57  +    <!-- end header part -->



Changes to lib/Doxyfile.in.

     1         -# Doxyfile 1.8.5
1  +# Doxyfile 1.8.14
2      2
3      3   # This file describes the settings to be used by the documentation system
4      4   # doxygen (www.doxygen.org) for a project.
5      5   #
6      6   # All text after a double hash (##) is considered a comment and is placed in
7      7   # front of the TAG it is preceding.
8      8   #
................................................................................
16     16   #---------------------------------------------------------------------------
17     17   # Project related configuration options
18     18   #---------------------------------------------------------------------------
19     19
20     20   # This tag specifies the encoding used for all characters in the config file
21     21   # that follow. The default is UTF-8 which is also the encoding used for all text
22     22   # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23         -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24         -# for the list of possible encodings.
23  +# built into libc) for the transcoding. See
24  +# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
25     25   # The default value is: UTF-8.
26     26
27     27   DOXYFILE_ENCODING      = UTF-8
28     28
29     29   # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30     30   # double-quotes, unless you are using Doxywizard) that should identify the
31     31   # project for which the documentation is generated. This name is used in the
................................................................................
42     42
43     43   # Using the PROJECT_BRIEF tag one can provide an optional one line description
44     44   # for a project that appears at the top of each page and should give viewer a
45     45   # quick idea about the purpose of the project. Keep the description short.
46     46
47     47   PROJECT_BRIEF          =
48     48
49         -# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50         -# the documentation. The maximum height of the logo should not exceed 55 pixels
51         -# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52         -# to the output directory.
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     53
54     54   PROJECT_LOGO           =
55     55
56     56   # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57     57   # into which the generated documentation will be written. If a relative path is
58     58   # entered, it will be relative to the location where doxygen was started. If
59     59   # left blank the current directory will be used.
60     60
61     61   OUTPUT_DIRECTORY       = ../doc
62     62
63         -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
63  +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64     64   # directories (in 2 levels) under the output directory of each output format and
65     65   # will distribute the generated files over these directories. Enabling this
66     66   # option can be useful when feeding doxygen a huge amount of source files, where
67     67   # putting all generated files in the same directory would otherwise causes
68     68   # performance problems for the file system.
69     69   # The default value is: NO.
70     70
71     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
72     80
73     81   # The OUTPUT_LANGUAGE tag is used to specify the language in which all
74     82   # documentation generated by doxygen is written. Doxygen will use this
75     83   # information to generate all constant output in the proper language.
76         -# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
77         -# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
78         -# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
79         -# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
80         -# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
81         -# Turkish, Ukrainian and Vietnamese.
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.
82     92   # The default value is: English.
83     93
84     94   OUTPUT_LANGUAGE        = English
85     95
86         -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
96  +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
87     97   # descriptions after the members that are listed in the file and class
88     98   # documentation (similar to Javadoc). Set to NO to disable this.
89     99   # The default value is: YES.
90    100
91    101   BRIEF_MEMBER_DESC      = YES
92    102
93         -# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
103  +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
94    104   # description of a member or function before the detailed description
95    105   #
96    106   # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
97    107   # brief descriptions will be completely suppressed.
98    108   # The default value is: YES.
99    109
100    110   REPEAT_BRIEF           = YES
................................................................................
121    131   # inherited members of a class in the documentation of that class as if those
122    132   # members were ordinary class members. Constructors, destructors and assignment
123    133   # operators of the base classes will not be shown.
124    134   # The default value is: NO.
125    135
126    136   INLINE_INHERITED_MEMB  = NO
127    137
128         -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
138  +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
129    139   # before files name in the file list and in the header files. If set to NO the
130    140   # shortest path that makes the file name unique will be used
131    141   # The default value is: YES.
132    142
133    143   FULL_PATH_NAMES        = NO
134    144
135    145   # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
................................................................................
191    201
192    202   # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
193    203   # documentation from any documented member that it re-implements.
194    204   # The default value is: YES.
195    205
196    206   INHERIT_DOCS           = YES
197    207
198         -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
199         -# new page for each member. If set to NO, the documentation of a member will be
200         -# part of the file/class/namespace that contains it.
208  +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
209  +# page for each member. If set to NO, the documentation of a member will be part
210  +# of the file/class/namespace that contains it.
201    211   # The default value is: NO.
202    212
203    213   SEPARATE_MEMBER_PAGES  = NO
204    214
205    215   # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
206    216   # uses this value to replace tabs by spaces in code fragments.
207    217   # Minimum value: 1, maximum value: 16, default value: 4.
................................................................................
212    222   # the documentation. An alias has the form:
213    223   # name=value
214    224   # For example adding
215    225   # "sideeffect=@par Side Effects:\n"
216    226   # will allow you to put the command \sideeffect (or @sideeffect) in the
217    227   # documentation, which will result in a user-defined paragraph with heading
218    228   # "Side Effects:". You can put \n's in the value part of an alias to insert
219         -# newlines.
229  +# newlines (in the resulting output). You can put ^^ in the value part of an
230  +# alias to insert a newline as if a physical newline was in the original file.
220    231
221    232   ALIASES                =
222    233
223    234   # This tag can be used to specify a number of word-keyword mappings (TCL only).
224    235   # A mapping has the form "name=value". For example adding "class=itcl::class"
225    236   # will allow you to use the command class in the itcl::class meaning.
226    237
................................................................................
255    266   OPTIMIZE_OUTPUT_VHDL   = NO
256    267
257    268   # Doxygen selects the parser to use depending on the extension of the files it
258    269   # parses. With this tag you can assign which parser to use for a given
259    270   # extension. Doxygen has a built-in mapping, but you can override or extend it
260    271   # using this tag. The format is ext=language, where ext is a file extension, and
261    272   # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
262         -# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
263         -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
264         -# (default is Fortran), use: inc=Fortran f=C.
273  +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
274  +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
275  +# Fortran. In the later case the parser tries to guess whether the code is fixed
276  +# or free formatted code, this is the default for Fortran type files), VHDL. For
277  +# instance to make doxygen treat .inc files as Fortran files (default is PHP),
278  +# and .f files as C (default is Fortran), use: inc=Fortran f=C.
265    279   #
266         -# Note For files without extension you can use no_extension as a placeholder.
280  +# Note: For files without extension you can use no_extension as a placeholder.
267    281   #
268    282   # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
269    283   # the files are not read by doxygen.
270    284
271    285   EXTENSION_MAPPING      =
272    286
273    287   # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
................................................................................
275    289   # documentation. See http://daringfireball.net/projects/markdown/ for details.
276    290   # The output of markdown processing is further processed by doxygen, so you can
277    291   # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
278    292   # case of backward compatibilities issues.
279    293   # The default value is: YES.
280    294
281    295   MARKDOWN_SUPPORT       = YES
296  +
297  +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
299  +# they do not have an id attribute.
300  +# Note: This feature currently applies only to Markdown headings.
301  +# Minimum value: 0, maximum value: 99, default value: 0.
302  +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
303  +
282    305
283    306   # When enabled doxygen tries to link words that correspond to documented
284    307   # classes, or namespaces to their corresponding documentation. Such a link can
285         -# be prevented in individual cases by by putting a % sign in front of the word
286         -# or globally by setting AUTOLINK_SUPPORT to NO.
308  +# be prevented in individual cases by putting a % sign in front of the word or
309  +# globally by setting AUTOLINK_SUPPORT to NO.
287    310   # The default value is: YES.
288    311
290    313
291    314   # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
292    315   # to include (a tag file for) the STL sources as input, then you should set this
293    316   # tag to YES in order to let doxygen match functions declarations and
................................................................................
301    324   # If you use Microsoft's C++/CLI language, you should set this option to YES to
302    325   # enable parsing support.
303    326   # The default value is: NO.
304    327
305    328   CPP_CLI_SUPPORT        = NO
306    329
307    330   # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
308         -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
331  +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
309    332   # will parse them like normal C++ but will assume all classes use public instead
310    333   # of private inheritance when no explicit protection keyword is present.
311    334   # The default value is: NO.
312    335
313    336   SIP_SUPPORT            = NO
314    337
315    338   # For Microsoft's IDL there are propget and propput attributes to indicate
................................................................................
319    342   # type. If this is not the case, or you want to show the methods anyway, you
320    343   # should set this option to NO.
321    344   # The default value is: YES.
322    345
323    346   IDL_PROPERTY_SUPPORT   = YES
324    347
325    348   # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
326         -# tag is set to YES, then doxygen will reuse the documentation of the first
349  +# tag is set to YES then doxygen will reuse the documentation of the first
327    350   # member in the group (if any) for the other members of the group. By default
328    351   # all members of a group must be documented explicitly.
329    352   # The default value is: NO.
330    353
331    354   DISTRIBUTE_GROUP_DOC   = NO
355  +
356  +# If one adds a struct or class to a group and this option is enabled, then also
357  +# any nested class or struct is added to the same group. By default this option
358  +# is disabled and one has to add nested compounds explicitly via \ingroup.
359  +# The default value is: NO.
360  +
361  +GROUP_NESTED_COMPOUNDS = NO
332    362
333    363   # Set the SUBGROUPING tag to YES to allow class member groups of the same type
334    364   # (for instance a group of public functions) to be put as a subgroup of that
335    365   # type (e.g. under the Public Functions section). Set it to NO to prevent
336    366   # subgrouping. Alternatively, this can be done per class using the
337    367   # \nosubgrouping command.
338    368   # The default value is: YES.
................................................................................
384    414
385    415   LOOKUP_CACHE_SIZE      = 0
386    416
387    417   #---------------------------------------------------------------------------
388    418   # Build related configuration options
389    419   #---------------------------------------------------------------------------
390    420
391         -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
421  +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
392    422   # documentation are documented, even if no documentation was available. Private
393    423   # class members and static file members will be hidden unless the
394    424   # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
395    425   # Note: This will also disable the warnings about undocumented members that are
396    426   # normally produced when WARNINGS is set to YES.
397    427   # The default value is: NO.
398    428
399    429   EXTRACT_ALL            = NO
400    430
401         -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
431  +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
402    432   # be included in the documentation.
403    433   # The default value is: NO.
404    434
405    435   EXTRACT_PRIVATE        = NO
406    436
407         -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
437  +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
408    438   # scope will be included in the documentation.
409    439   # The default value is: NO.
410    440
411    441   EXTRACT_PACKAGE        = NO
412    442
413         -# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
443  +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
414    444   # included in the documentation.
415    445   # The default value is: NO.
416    446
417    447   EXTRACT_STATIC         = NO
418    448
419         -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
420         -# locally in source files will be included in the documentation. If set to NO
449  +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
450  +# locally in source files will be included in the documentation. If set to NO,
421    451   # only classes defined in header files are included. Does not have any effect
422    452   # for Java sources.
423    453   # The default value is: YES.
424    454
425    455   EXTRACT_LOCAL_CLASSES  = YES
426    456
427         -# This flag is only useful for Objective-C code. When set to YES local methods,
457  +# This flag is only useful for Objective-C code. If set to YES, local methods,
428    458   # which are defined in the implementation section but not in the interface are
429         -# included in the documentation. If set to NO only methods in the interface are
459  +# included in the documentation. If set to NO, only methods in the interface are
430    460   # included.
431    461   # The default value is: NO.
432    462
433    463   EXTRACT_LOCAL_METHODS  = NO
434    464
435    465   # If this flag is set to YES, the members of anonymous namespaces will be
436    466   # extracted and appear in the documentation as a namespace called
................................................................................
447    477   # section is generated. This option has no effect if EXTRACT_ALL is enabled.
448    478   # The default value is: NO.
449    479
450    480   HIDE_UNDOC_MEMBERS     = NO
451    481
452    482   # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
453    483   # undocumented classes that are normally visible in the class hierarchy. If set
454         -# to NO these classes will be included in the various overviews. This option has
455         -# no effect if EXTRACT_ALL is enabled.
484  +# to NO, these classes will be included in the various overviews. This option
485  +# has no effect if EXTRACT_ALL is enabled.
456    486   # The default value is: NO.
457    487
458    488   HIDE_UNDOC_CLASSES     = NO
459    489
460    490   # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
461         -# (class|struct|union) declarations. If set to NO these declarations will be
491  +# (class|struct|union) declarations. If set to NO, these declarations will be
462    492   # included in the documentation.
463    493   # The default value is: NO.
464    494
465    495   HIDE_FRIEND_COMPOUNDS  = NO
466    496
467    497   # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
468         -# documentation blocks found inside the body of a function. If set to NO these
498  +# documentation blocks found inside the body of a function. If set to NO, these
469    499   # blocks will be appended to the function's detailed documentation block.
470    500   # The default value is: NO.
471    501
472    502   HIDE_IN_BODY_DOCS      = NO
473    503
474    504   # The INTERNAL_DOCS tag determines if documentation that is typed after a
475    505   # \internal command is included. If the tag is set to NO then the documentation
476    506   # will be excluded. Set it to YES to include the internal documentation.
477    507   # The default value is: NO.
478    508
479    509   INTERNAL_DOCS          = NO
480    510
481    511   # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
482         -# names in lower-case letters. If set to YES upper-case letters are also
512  +# names in lower-case letters. If set to YES, upper-case letters are also
483    513   # allowed. This is useful if you have classes or files whose names only differ
484    514   # in case and if your file system supports case sensitive file names. Windows
485    515   # and Mac users are advised to set this option to NO.
486    516   # The default value is: system dependent.
487    517
488    518   CASE_SENSE_NAMES       = YES
489    519
490    520   # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
491         -# their full class and namespace scopes in the documentation. If set to YES the
521  +# their full class and namespace scopes in the documentation. If set to YES, the
492    522   # scope will be hidden.
493    523   # The default value is: NO.
494    524
495    525   HIDE_SCOPE_NAMES       = NO
526  +
527  +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
528  +# append additional text to a page's title, such as Class Reference. If set to
529  +# YES the compound reference will be hidden.
530  +# The default value is: NO.
531  +
532  +HIDE_COMPOUND_REFERENCE= NO
496    533
497    534   # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
498    535   # the files that are included by a file in the documentation of that file.
499    536   # The default value is: YES.
500    537
501    538   SHOW_INCLUDE_FILES     = YES
539  +
540  +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
541  +# grouped member an include statement to the documentation, telling the reader
542  +# which file to include in order to use the member.
543  +# The default value is: NO.
544  +
545  +SHOW_GROUPED_MEMB_INC  = NO
502    546
503    547   # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
504    548   # files with double quotes in the documentation rather than with sharp brackets.
505    549   # The default value is: NO.
506    550
507    551   FORCE_LOCAL_INCLUDES   = NO
508    552
................................................................................
510    554   # documentation for inline members.
511    555   # The default value is: YES.
512    556
513    557   INLINE_INFO            = YES
514    558
515    559   # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
516    560   # (detailed) documentation of file and class members alphabetically by member
517         -# name. If set to NO the members will appear in declaration order.
561  +# name. If set to NO, the members will appear in declaration order.
518    562   # The default value is: YES.
519    563
520    564   SORT_MEMBER_DOCS       = YES
521    565
522    566   # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
523    567   # descriptions of file, namespace and class members alphabetically by member
524         -# name. If set to NO the members will appear in declaration order.
568  +# name. If set to NO, the members will appear in declaration order. Note that
569  +# this will also influence the order of the classes in the class list.
525    570   # The default value is: NO.
526    571
527    572   SORT_BRIEF_DOCS        = NO
528    573
529    574   # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
530    575   # (brief and detailed) documentation of class members so that constructors and
531    576   # destructors are listed first. If set to NO the constructors will appear in the
................................................................................
561    606   # only one candidate or it is obvious which candidate to choose by doing a
562    607   # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
563    608   # accept a match between prototype and implementation in such cases.
564    609   # The default value is: NO.
565    610
566    611   STRICT_PROTO_MATCHING  = NO
567    612
568         -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
569         -# todo list. This list is created by putting \todo commands in the
570         -# documentation.
613  +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
614  +# list. This list is created by putting \todo commands in the documentation.
571    615   # The default value is: YES.
572    616
573    617   GENERATE_TODOLIST      = YES
574    618
575         -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
576         -# test list. This list is created by putting \test commands in the
577         -# documentation.
619  +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
620  +# list. This list is created by putting \test commands in the documentation.
578    621   # The default value is: YES.
579    622
580    623   GENERATE_TESTLIST      = YES
581    624
582         -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
625  +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
583    626   # list. This list is created by putting \bug commands in the documentation.
584    627   # The default value is: YES.
585    628
586    629   GENERATE_BUGLIST       = YES
587    630
588         -# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
631  +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
589    632   # the deprecated list. This list is created by putting \deprecated commands in
590    633   # the documentation.
591    634   # The default value is: YES.
592    635
593    636   GENERATE_DEPRECATEDLIST= YES
594    637
595    638   # The ENABLED_SECTIONS tag can be used to enable conditional documentation
................................................................................
606    649   # controlled using \showinitializer or \hideinitializer command in the
607    650   # documentation regardless of this setting.
608    651   # Minimum value: 0, maximum value: 10000, default value: 30.
609    652
610    653   MAX_INITIALIZER_LINES  = 30
611    654
612    655   # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
613         -# the bottom of the documentation of classes and structs. If set to YES the list
614         -# will mention the files that were used to generate the documentation.
656  +# the bottom of the documentation of classes and structs. If set to YES, the
657  +# list will mention the files that were used to generate the documentation.
615    658   # The default value is: YES.
616    659
617    660   SHOW_USED_FILES        = YES
618    661
619    662   # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
620    663   # will remove the Files entry from the Quick Index and from the Folder Tree View
621    664   # (if specified).
................................................................................
652    695   # tag is left empty.
653    696
654    697   LAYOUT_FILE            =
655    698
656    699   # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
657    700   # the reference definitions. This must be a list of .bib files. The .bib
658    701   # extension is automatically appended if omitted. This requires the bibtex tool
660    703   # For LaTeX the style of the bibliography can be controlled using
661    704   # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
662         -# search path. Do not use file names with spaces, bibtex cannot handle them. See
663         -# also \cite for info how to create references.
705  +# search path. See also \cite for info how to create references.
664    706
665    707   CITE_BIB_FILES         =
666    708
667    709   #---------------------------------------------------------------------------
668    710   # Configuration options related to warning and progress messages
669    711   #---------------------------------------------------------------------------
670    712
................................................................................
672    714   # standard output by doxygen. If QUIET is set to YES this implies that the
673    715   # messages are off.
674    716   # The default value is: NO.
675    717
676    718   QUIET                  = NO
677    719
678    720   # The WARNINGS tag can be used to turn on/off the warning messages that are
679         -# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
721  +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
680    722   # this implies that the warnings are on.
681    723   #
682    724   # Tip: Turn warnings on while writing the documentation.
683    725   # The default value is: YES.
684    726
685    727   WARNINGS               = YES
686    728
687         -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
729  +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
688    730   # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
689    731   # will automatically be disabled.
690    732   # The default value is: YES.
691    733
692    734   WARN_IF_UNDOCUMENTED   = YES
693    735
694    736   # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
................................................................................
697    739   # markup commands wrongly.
698    740   # The default value is: YES.
699    741
700    742   WARN_IF_DOC_ERROR      = YES
701    743
702    744   # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
703    745   # are documented, but have no documentation for their parameters or return
704         -# value. If set to NO doxygen will only warn about wrong or incomplete parameter
705         -# documentation, but not about the absence of documentation.
746  +# value. If set to NO, doxygen will only warn about wrong or incomplete
747  +# parameter documentation, but not about the absence of documentation.
706    748   # The default value is: NO.
707    749
708    750   WARN_NO_PARAMDOC       = NO
751  +
752  +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
753  +# a warning is encountered.
754  +# The default value is: NO.
755  +
756  +WARN_AS_ERROR          = NO
709    757
710    758   # The WARN_FORMAT tag determines the format of the warning messages that doxygen
711    759   # can produce. The string should contain the $file,$line, and $text tags, which 712 760 # will be replaced by the file and line number from which the warning originated 713 761 # and the warning text. Optionally the format may contain$version, which will
714    762   # be replaced by the version of the file (if it could be obtained via
715    763   # FILE_VERSION_FILTER)
................................................................................
726    774   #---------------------------------------------------------------------------
727    775   # Configuration options related to the input files
728    776   #---------------------------------------------------------------------------
729    777
730    778   # The INPUT tag is used to specify the files and/or directories that contain
731    779   # documented source files. You may enter file names like myfile.cpp or
732    780   # directories like /usr/src/myproject. Separate the files or directories with
733         -# spaces.
734    782   # Note: If this tag is empty the current directory is searched.
735    783
736    784   INPUT                  =
737    785
738    786   # This tag can be used to specify the character encoding of the source files
739    787   # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
740    788   # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
741         -# documentation (see: http://www.gnu.org/software/libiconv) for the list of
789  +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
742    790   # possible encodings.
743    791   # The default value is: UTF-8.
744    792
745    793   INPUT_ENCODING         = UTF-8
746    794
747    795   # If the value of the INPUT tag contains directories, you can use the
748    796   # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
749         -# *.h) to filter out the source-files in the directories. If left blank the
750         -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
751         -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
752         -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
753         -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
754         -# *.qsf, *.as and *.js.
797  +# *.h) to filter out the source-files in the directories.
798  +#
799  +# Note that for custom extensions or not directly supported extensions you also
800  +# need to set EXTENSION_MAPPING for the extension otherwise the files are not
802  +#
803  +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
804  +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
805  +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
806  +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
807  +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
755    808
756    809   FILE_PATTERNS          =
757    810
758    811   # The RECURSIVE tag can be used to specify whether or not subdirectories should
759    812   # be searched for input files as well.
760    813   # The default value is: NO.
761    814
................................................................................
836    889   # name of an input file. Doxygen will then use the output that the filter
837    890   # program writes to standard output. If FILTER_PATTERNS is specified, this tag
838    891   # will be ignored.
839    892   #
840    893   # Note that the filter must not add or remove lines; it is applied before the
841    894   # code is scanned, but not when the output code is generated. If lines are added
842    895   # or removed, the anchors will not be placed correctly.
896  +#
897  +# Note that for custom extensions or not directly supported extensions you also
898  +# need to set EXTENSION_MAPPING for the extension otherwise the files are not
899  +# properly processed by doxygen.
843    900
844    901   INPUT_FILTER           =
845    902
846    903   # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
847    904   # basis. Doxygen will compare the file name with each pattern and apply the
848    905   # filter if there is a match. The filters are a list of the form: pattern=filter
849    906   # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
850    907   # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
851    908   # patterns match the file name, INPUT_FILTER is applied.
909  +#
910  +# Note that for custom extensions or not directly supported extensions you also
911  +# need to set EXTENSION_MAPPING for the extension otherwise the files are not
912  +# properly processed by doxygen.
852    913
853    914   FILTER_PATTERNS        =
854    915
855    916   # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
856         -# INPUT_FILTER ) will also be used to filter the input files that are used for
917  +# INPUT_FILTER) will also be used to filter the input files that are used for
857    918   # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
858    919   # The default value is: NO.
859    920
860    921   FILTER_SOURCE_FILES    = NO
861    922
862    923   # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
863    924   # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
................................................................................
909    970   # If the REFERENCES_RELATION tag is set to YES then for each documented function
910    971   # all documented entities called/used by that function will be listed.
911    972   # The default value is: NO.
912    973
913    974   REFERENCES_RELATION    = YES
914    975
915    976   # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
916         -# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
977  +# to YES then the hyperlinks from functions in REFERENCES_RELATION and
917    978   # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
918    979   # link to the documentation.
919    980   # The default value is: YES.
920    981
922    983
923    984   # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
................................................................................
929    990   # This tag requires that the tag SOURCE_BROWSER is set to YES.
930    991
931    992   SOURCE_TOOLTIPS        = YES
932    993
933    994   # If the USE_HTAGS tag is set to YES then the references to source code will
934    995   # point to the HTML generated by the htags(1) tool instead of doxygen built-in
935    996   # source browser. The htags tool is part of GNU's global source tagging system
936         -# (see http://www.gnu.org/software/global/global.html). You will need version
997  +# (see https://www.gnu.org/software/global/global.html). You will need version
937    998   # 4.8.6 or higher.
938    999   #
939   1000   # To use it do the following:
941   1002   # - Enable SOURCE_BROWSER and USE_HTAGS in the config file
942   1003   # - Make sure the INPUT points to the root of the source tree
943   1004   # - Run doxygen as normal
................................................................................
986   1047
987   1048   IGNORE_PREFIX          =
988   1049
989   1050   #---------------------------------------------------------------------------
990   1051   # Configuration options related to the HTML output
991   1052   #---------------------------------------------------------------------------
992   1053
993         -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1054  +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
994   1055   # The default value is: YES.
995   1056
996   1057   GENERATE_HTML          = YES
997   1058
998   1059   # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
999   1060   # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1000   1061   # it.
................................................................................
1048   1109   # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1049   1110   # it is more robust and this tag (HTML_STYLESHEET) will in the future become
1050   1111   # obsolete.
1051   1112   # This tag requires that the tag GENERATE_HTML is set to YES.
1052   1113
1053   1114   HTML_STYLESHEET        =
1054   1115
1055         -# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1056         -# defined cascading style sheet that is included after the standard style sheets
1116  +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1117  +# cascading style sheets that are included after the standard style sheets
1057   1118   # created by doxygen. Using this option one can overrule certain style aspects.
1058   1119   # This is preferred over using HTML_STYLESHEET since it does not replace the
1059         -# standard style sheet and is therefor more robust against future updates.
1060         -# Doxygen will copy the style sheet file to the output directory. For an example
1061         -# see the documentation.
1120  +# standard style sheet and is therefore more robust against future updates.
1121  +# Doxygen will copy the style sheet files to the output directory.
1122  +# Note: The order of the extra style sheet files is of importance (e.g. the last
1123  +# style sheet in the list overrules the setting of the previous ones in the
1124  +# list). For an example see the documentation.
1062   1125   # This tag requires that the tag GENERATE_HTML is set to YES.
1063   1126
1064   1127   HTML_EXTRA_STYLESHEET  =
1065   1128
1066   1129   # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1067   1130   # other source files which should be copied to the HTML output directory. Note
1068   1131   # that these files will be copied to the base HTML output directory. Use the
................................................................................
1070   1133   # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1071   1134   # files will be copied as-is; there are no commands or markers available.
1072   1135   # This tag requires that the tag GENERATE_HTML is set to YES.
1073   1136
1074   1137   HTML_EXTRA_FILES       =
1075   1138
1076   1139   # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1077         -# will adjust the colors in the stylesheet and background images according to
1140  +# will adjust the colors in the style sheet and background images according to
1078   1141   # this color. Hue is specified as an angle on a colorwheel, see
1080   1143   # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1081   1144   # purple, and 360 is red again.
1082   1145   # Minimum value: 0, maximum value: 359, default value: 220.
1083   1146   # This tag requires that the tag GENERATE_HTML is set to YES.
1084   1147
1085   1148   HTML_COLORSTYLE_HUE    = 220
1086   1149
................................................................................
1101   1164   # Minimum value: 40, maximum value: 240, default value: 80.
1102   1165   # This tag requires that the tag GENERATE_HTML is set to YES.
1103   1166
1104   1167   HTML_COLORSTYLE_GAMMA  = 80
1105   1168
1106   1169   # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1107   1170   # page will contain the date and time when the page was generated. Setting this
1108         -# to NO can help when comparing the output of multiple runs.
1109         -# The default value is: YES.
1171  +# to YES can help to show when doxygen was last run and thus if the
1172  +# documentation is up to date.
1173  +# The default value is: NO.
1110   1174   # This tag requires that the tag GENERATE_HTML is set to YES.
1111   1175
1112   1176   HTML_TIMESTAMP         = YES
1177  +
1178  +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1179  +# documentation will contain a main index with vertical navigation menus that
1180  +# are dynamically created via Javascript. If disabled, the navigation index will
1181  +# consists of multiple levels of tabs that are statically embedded in every HTML
1182  +# page. Disable this option to support browsers that do not have Javascript,
1183  +# like the Qt help browser.
1184  +# The default value is: YES.
1185  +# This tag requires that the tag GENERATE_HTML is set to YES.
1186  +
1113   1188
1114   1189   # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1115   1190   # documentation will contain sections that can be hidden and shown after the
1116   1191   # page has loaded.
1117   1192   # The default value is: NO.
1118   1193   # This tag requires that the tag GENERATE_HTML is set to YES.
1119   1194
................................................................................
1130   1205   # Minimum value: 0, maximum value: 9999, default value: 100.
1131   1206   # This tag requires that the tag GENERATE_HTML is set to YES.
1132   1207
1133   1208   HTML_INDEX_NUM_ENTRIES = 100
1134   1209
1135   1210   # If the GENERATE_DOCSET tag is set to YES, additional index files will be
1136   1211   # generated that can be used as input for Apple's Xcode 3 integrated development
1137         -# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1212  +# environment (see: https://developer.apple.com/tools/xcode/), introduced with
1138   1213   # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1139   1214   # Makefile in the HTML output directory. Running make will produce the docset in
1140   1215   # that directory and running make install will install the docset in
1141   1216   # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1142         -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1217  +# startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1144   1219   # The default value is: NO.
1145   1220   # This tag requires that the tag GENERATE_HTML is set to YES.
1146   1221
1147   1222   GENERATE_DOCSET        = NO
1148   1223
1149   1224   # This tag determines the name of the docset feed. A documentation feed provides
................................................................................
1198   1273   # file. You can add a path in front of the file if the result should not be
1199   1274   # written to the html output directory.
1200   1275   # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1201   1276
1202   1277   CHM_FILE               =
1203   1278
1204   1279   # The HHC_LOCATION tag can be used to specify the location (absolute path
1205         -# including file name) of the HTML help compiler ( hhc.exe). If non-empty
1280  +# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1206   1281   # doxygen will try to run the HTML help compiler on the generated index.hhp.
1207   1282   # The file has to be specified with full path.
1208   1283   # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1209   1284
1210   1285   HHC_LOCATION           =
1211   1286
1212         -# The GENERATE_CHI flag controls if a separate .chi index file is generated (
1213         -# YES) or that it should be included in the master .chm file ( NO).
1287  +# The GENERATE_CHI flag controls if a separate .chi index file is generated
1288  +# (YES) or that it should be included in the master .chm file (NO).
1214   1289   # The default value is: NO.
1215   1290   # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1216   1291
1217   1292   GENERATE_CHI           = NO
1218   1293
1219         -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1294  +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1220   1295   # and project file content.
1221   1296   # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1222   1297
1223   1298   CHM_INDEX_ENCODING     =
1224   1299
1302  +# enables the Previous and Next buttons.
1227   1303   # The default value is: NO.
1228   1304   # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1229   1305
1230   1306   BINARY_TOC             = NO
1231   1307
1232   1308   # The TOC_EXPAND flag can be set to YES to add extra items for group members to
1233   1309   # the table of contents of the HTML help documentation and to the tree view.
................................................................................
1250   1326   # the HTML output folder.
1251   1327   # This tag requires that the tag GENERATE_QHP is set to YES.
1252   1328
1253   1329   QCH_FILE               =
1254   1330
1255   1331   # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1257         -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1333  +# (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace).
1258   1334   # The default value is: org.doxygen.Project.
1259   1335   # This tag requires that the tag GENERATE_QHP is set to YES.
1260   1336
1261   1337   QHP_NAMESPACE          = org.doxygen.Project
1262   1338
1263   1339   # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1265         -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1266         -# folders).
1341  +# Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders).
1267   1342   # The default value is: doc.
1268   1343   # This tag requires that the tag GENERATE_QHP is set to YES.
1269   1344
1270   1345   QHP_VIRTUAL_FOLDER     = doc
1271   1346
1272   1347   # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1274         -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1275         -# filters).
1349  +# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters).
1276   1350   # This tag requires that the tag GENERATE_QHP is set to YES.
1277   1351
1278   1352   QHP_CUST_FILTER_NAME   =
1279   1353
1280   1354   # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1282         -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1283         -# filters).
1356  +# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters).
1284   1357   # This tag requires that the tag GENERATE_QHP is set to YES.
1285   1358
1286   1359   QHP_CUST_FILTER_ATTRS  =
1287   1360
1288   1361   # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1289   1362   # project's filter section matches. Qt Help Project / Filter Attributes (see:
1290         -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1363  +# http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes).
1291   1364   # This tag requires that the tag GENERATE_QHP is set to YES.
1292   1365
1293   1366   QHP_SECT_FILTER_ATTRS  =
1294   1367
1295   1368   # The QHG_LOCATION tag can be used to specify the location of Qt's
1296   1369   # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1297   1370   # generated .qhp file.
................................................................................
1332   1405
1333   1406   # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1334   1407   # structure should be generated to display hierarchical information. If the tag
1335   1408   # value is set to YES, a side panel will be generated containing a tree-like
1336   1409   # index structure (just like the one that is generated for HTML Help). For this
1337   1410   # to work a browser that supports JavaScript, DHTML, CSS and frames is required
1338   1411   # (i.e. any modern browser). Windows users are probably better off using the
1339         -# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1412  +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1340   1413   # further fine-tune the look of the index. As an example, the default style
1341   1414   # sheet generated by doxygen has an example that shows how to put an image at
1342   1415   # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1343   1416   # the same information as the tab index, you could consider setting
1344   1417   # DISABLE_INDEX to YES when enabling this option.
1345   1418   # The default value is: NO.
1346   1419   # This tag requires that the tag GENERATE_HTML is set to YES.
................................................................................
1360   1433   # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1361   1434   # to set the initial width (in pixels) of the frame in which the tree is shown.
1362   1435   # Minimum value: 0, maximum value: 1500, default value: 250.
1363   1436   # This tag requires that the tag GENERATE_HTML is set to YES.
1364   1437
1365   1438   TREEVIEW_WIDTH         = 250
1366   1439
1367         -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1440  +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1368   1441   # external symbols imported via tag files in a separate window.
1369   1442   # The default value is: NO.
1370   1443   # This tag requires that the tag GENERATE_HTML is set to YES.
1371   1444
1373   1446
1374   1447   # Use this tag to change the font size of LaTeX formulas included as images in
................................................................................
1376   1449   # doxygen run you need to manually remove any form_*.png images from the HTML
1377   1450   # output directory to force them to be regenerated.
1378   1451   # Minimum value: 8, maximum value: 50, default value: 10.
1379   1452   # This tag requires that the tag GENERATE_HTML is set to YES.
1380   1453
1381   1454   FORMULA_FONTSIZE       = 10
1382   1455
1383         -# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1456  +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1384   1457   # generated for formulas are transparent PNGs. Transparent PNGs are not
1385   1458   # supported properly for IE 6.0, but are supported on all modern browsers.
1386   1459   #
1387   1460   # Note that when changing this option you need to delete any form_*.png files in
1388   1461   # the HTML output directory before the changes have effect.
1389   1462   # The default value is: YES.
1390   1463   # This tag requires that the tag GENERATE_HTML is set to YES.
1391   1464
1392   1465   FORMULA_TRANSPARENT    = YES
1393   1466
1394   1467   # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1395         -# http://www.mathjax.org) which uses client side Javascript for the rendering
1396         -# instead of using prerendered bitmaps. Use this if you do not have LaTeX
1468  +# https://www.mathjax.org) which uses client side Javascript for the rendering
1469  +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1397   1470   # installed or if you want to formulas look prettier in the HTML output. When
1398   1471   # enabled you may also need to install MathJax separately and configure the path
1399   1472   # to it using the MATHJAX_RELPATH option.
1400   1473   # The default value is: NO.
1401   1474   # This tag requires that the tag GENERATE_HTML is set to YES.
1402   1475
1403   1476   USE_MATHJAX            = NO
................................................................................
1415   1488   # When MathJax is enabled you need to specify the location relative to the HTML
1416   1489   # output directory using the MATHJAX_RELPATH option. The destination directory
1417   1490   # should contain the MathJax.js script. For instance, if the mathjax directory
1418   1491   # is located at the same level as the HTML output directory, then
1419   1492   # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1420   1493   # Content Delivery Network so you can quickly see the result without installing
1421   1494   # MathJax. However, it is strongly recommended to install a local copy of
1422         -# MathJax from http://www.mathjax.org before deployment.
1423         -# The default value is: http://cdn.mathjax.org/mathjax/latest.
1495  +# MathJax from https://www.mathjax.org before deployment.
1496  +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/.
1424   1497   # This tag requires that the tag USE_MATHJAX is set to YES.
1425   1498
1426   1499   MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1427   1500
1428   1501   # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1429   1502   # extension names that should be enabled during MathJax rendering. For example
1430   1503   # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
................................................................................
1455   1528   # the search. The filter options can be selected when the cursor is inside the
1456   1529   # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1457   1530   # to select a filter and <Enter> or <escape> to activate or cancel the filter
1458   1531   # option.
1459   1532   # The default value is: YES.
1460   1533   # This tag requires that the tag GENERATE_HTML is set to YES.
1461   1534
1462         -SEARCHENGINE           = NO
1535  +SEARCHENGINE           = YES
1463   1536
1464   1537   # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1465   1538   # implemented using a web server instead of a web client using Javascript. There
1466         -# are two flavours of web server based searching depending on the
1467         -# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
1468         -# searching and an index file used by the script. When EXTERNAL_SEARCH is
1469         -# enabled the indexing and searching needs to be provided by external tools. See
1470         -# the section "External Indexing and Searching" for details.
1539  +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1540  +# setting. When disabled, doxygen will generate a PHP script for searching and
1541  +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1542  +# and searching needs to be provided by external tools. See the section
1543  +# "External Indexing and Searching" for details.
1471   1544   # The default value is: NO.
1472   1545   # This tag requires that the tag SEARCHENGINE is set to YES.
1473   1546
1474   1547   SERVER_BASED_SEARCH    = NO
1475   1548
1476   1549   # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1477   1550   # script for searching. Instead the search results are written to an XML file
1478   1551   # which needs to be processed by an external indexer. Doxygen will invoke an
1479   1552   # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1480   1553   # search results.
1481   1554   #
1482         -# Doxygen ships with an example indexer ( doxyindexer) and search engine
1555  +# Doxygen ships with an example indexer (doxyindexer) and search engine
1483   1556   # (doxysearch.cgi) which are based on the open source search engine library
1484         -# Xapian (see: http://xapian.org/).
1557  +# Xapian (see: https://xapian.org/).
1485   1558   #
1486   1559   # See the section "External Indexing and Searching" for details.
1487   1560   # The default value is: NO.
1488   1561   # This tag requires that the tag SEARCHENGINE is set to YES.
1489   1562
1490   1563   EXTERNAL_SEARCH        = NO
1491   1564
1492   1565   # The SEARCHENGINE_URL should point to a search engine hosted by a web server
1493   1566   # which will return the search results when EXTERNAL_SEARCH is enabled.
1494   1567   #
1495         -# Doxygen ships with an example indexer ( doxyindexer) and search engine
1568  +# Doxygen ships with an example indexer (doxyindexer) and search engine
1496   1569   # (doxysearch.cgi) which are based on the open source search engine library
1497         -# Xapian (see: http://xapian.org/). See the section "External Indexing and
1570  +# Xapian (see: https://xapian.org/). See the section "External Indexing and
1498   1571   # Searching" for details.
1499   1572   # This tag requires that the tag SEARCHENGINE is set to YES.
1500   1573
1501   1574   SEARCHENGINE_URL       =
1502   1575
1503   1576   # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1504   1577   # search data is written to a file for indexing by an external tool. With the
................................................................................
1526   1599
1527   1600   EXTRA_SEARCH_MAPPINGS  =
1528   1601
1529   1602   #---------------------------------------------------------------------------
1530   1603   # Configuration options related to the LaTeX output
1531   1604   #---------------------------------------------------------------------------
1532   1605
1533         -# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1606  +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1534   1607   # The default value is: YES.
1535   1608
1536   1609   GENERATE_LATEX         = NO
1537   1610
1538   1611   # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1539   1612   # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1540   1613   # it.
................................................................................
1557   1630   # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1558   1631   # index for LaTeX.
1559   1632   # The default file is: makeindex.
1560   1633   # This tag requires that the tag GENERATE_LATEX is set to YES.
1561   1634
1562   1635   MAKEINDEX_CMD_NAME     = makeindex
1563   1636
1564         -# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1637  +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1565   1638   # documents. This may be useful for small projects and may help to save some
1566   1639   # trees in general.
1567   1640   # The default value is: NO.
1568   1641   # This tag requires that the tag GENERATE_LATEX is set to YES.
1569   1642
1570   1643   COMPACT_LATEX          = NO
1571   1644
................................................................................
1575   1648   # 14 inches) and executive (7.25 x 10.5 inches).
1576   1649   # The default value is: a4.
1577   1650   # This tag requires that the tag GENERATE_LATEX is set to YES.
1578   1651
1579   1652   PAPER_TYPE             = letter
1580   1653
1581   1654   # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1582         -# that should be included in the LaTeX output. To get the times font for
1583         -# instance you can specify
1584         -# EXTRA_PACKAGES=times
1655  +# that should be included in the LaTeX output. The package can be specified just
1656  +# by its name or with the correct syntax as to be used with the LaTeX
1657  +# \usepackage command. To get the times font for instance you can specify :
1658  +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1659  +# To use the option intlimits with the amsmath package you can specify:
1660  +# EXTRA_PACKAGES=[intlimits]{amsmath}
1585   1661   # If left blank no extra packages will be included.
1586   1662   # This tag requires that the tag GENERATE_LATEX is set to YES.
1587   1663
1588   1664   EXTRA_PACKAGES         =
1589   1665
1590   1666   # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1591   1667   # generated LaTeX document. The header should contain everything until the first
1592   1668   # chapter. If it is left blank doxygen will generate a standard header. See
1593   1669   # section "Doxygen usage" for information on how to let doxygen write the
1594   1670   # default header to a separate file.
1595   1671   #
1596   1672   # Note: Only use a user-defined header if you know what you are doing! The
1597   1673   # following commands have a special meaning inside the header: $title, 1598 -#$datetime, $date,$doxygenversion, $projectname,$projectnumber. Doxygen will
1599         -# replace them by respectively the title of the page, the current date and time,
1600         -# only the current date, the version number of doxygen, the project name (see
1601         -# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1674  +# $datetime,$date, $doxygenversion,$projectname, $projectnumber, 1675 +#$projectbrief, $projectlogo. Doxygen will replace$title with the empty
1676  +# string, for the replacement values of the other commands the user is referred
1602   1678   # This tag requires that the tag GENERATE_LATEX is set to YES.
1603   1679
1605   1681
1606   1682   # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1607   1683   # generated LaTeX document. The footer should contain everything after the last
1608         -# chapter. If it is left blank doxygen will generate a standard footer.
1684  +# chapter. If it is left blank doxygen will generate a standard footer. See
1686  +# special commands can be used inside the footer.
1609   1687   #
1610   1688   # Note: Only use a user-defined footer if you know what you are doing!
1611   1689   # This tag requires that the tag GENERATE_LATEX is set to YES.
1612   1690
1613   1691   LATEX_FOOTER           =
1692  +
1693  +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1694  +# LaTeX style sheets that are included after the standard style sheets created
1695  +# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1696  +# will copy the style sheet files to the output directory.
1697  +# Note: The order of the extra style sheet files is of importance (e.g. the last
1698  +# style sheet in the list overrules the setting of the previous ones in the
1699  +# list).
1700  +# This tag requires that the tag GENERATE_LATEX is set to YES.
1701  +
1702  +LATEX_EXTRA_STYLESHEET =
1614   1703
1615   1704   # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1616   1705   # other source files which should be copied to the LATEX_OUTPUT output
1617   1706   # directory. Note that the files will be copied as-is; there are no commands or
1618   1707   # markers available.
1619   1708   # This tag requires that the tag GENERATE_LATEX is set to YES.
1620   1709
................................................................................
1625   1714   # contain links (just like the HTML output) instead of page references. This
1626   1715   # makes the output suitable for online browsing using a PDF viewer.
1627   1716   # The default value is: YES.
1628   1717   # This tag requires that the tag GENERATE_LATEX is set to YES.
1629   1718
1631   1720
1632         -# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1633         -# the PDF file directly from the LaTeX files. Set this option to YES to get a
1721  +# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1722  +# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1634   1723   # higher quality PDF documentation.
1635   1724   # The default value is: YES.
1636   1725   # This tag requires that the tag GENERATE_LATEX is set to YES.
1637   1726
1638   1727   USE_PDFLATEX           = YES
1639   1728
1640   1729   # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
................................................................................
1661   1750   # The default value is: NO.
1662   1751   # This tag requires that the tag GENERATE_LATEX is set to YES.
1663   1752
1664   1753   LATEX_SOURCE_CODE      = NO
1665   1754
1666   1755   # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1667   1756   # bibliography, e.g. plainnat, or ieeetr. See
1669   1758   # The default value is: plain.
1670   1759   # This tag requires that the tag GENERATE_LATEX is set to YES.
1671   1760
1672   1761   LATEX_BIB_STYLE        = plain
1762  +
1763  +# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1764  +# page will contain the date and time when the page was generated. Setting this
1765  +# to NO can help when comparing the output of multiple runs.
1766  +# The default value is: NO.
1767  +# This tag requires that the tag GENERATE_LATEX is set to YES.
1768  +
1769  +LATEX_TIMESTAMP        = NO
1673   1770
1674   1771   #---------------------------------------------------------------------------
1675   1772   # Configuration options related to the RTF output
1676   1773   #---------------------------------------------------------------------------
1677   1774
1678         -# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1775  +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1679   1776   # RTF output is optimized for Word 97 and may not look too pretty with other RTF
1681   1778   # The default value is: NO.
1682   1779
1683   1780   GENERATE_RTF           = NO
1684   1781
1685   1782   # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
................................................................................
1686   1783   # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1687   1784   # it.
1688   1785   # The default directory is: rtf.
1689   1786   # This tag requires that the tag GENERATE_RTF is set to YES.
1690   1787
1691   1788   RTF_OUTPUT             = rtf
1692   1789
1693         -# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1790  +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1694   1791   # documents. This may be useful for small projects and may help to save some
1695   1792   # trees in general.
1696   1793   # The default value is: NO.
1697   1794   # This tag requires that the tag GENERATE_RTF is set to YES.
1698   1795
1699   1796   COMPACT_RTF            = NO
1700   1797
................................................................................
1722   1819
1723   1820   # Set optional variables used in the generation of an RTF document. Syntax is
1724   1821   # similar to doxygen's config file. A template extensions file can be generated
1725   1822   # using doxygen -e rtf extensionFile.
1726   1823   # This tag requires that the tag GENERATE_RTF is set to YES.
1727   1824
1728   1825   RTF_EXTENSIONS_FILE    =
1826  +
1827  +# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1828  +# with syntax highlighting in the RTF output.
1829  +#
1830  +# Note that which sources are shown also depends on other settings such as
1831  +# SOURCE_BROWSER.
1832  +# The default value is: NO.
1833  +# This tag requires that the tag GENERATE_RTF is set to YES.
1834  +
1835  +RTF_SOURCE_CODE        = NO
1729   1836
1730   1837   #---------------------------------------------------------------------------
1731   1838   # Configuration options related to the man page output
1732   1839   #---------------------------------------------------------------------------
1733   1840
1734         -# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1841  +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1735   1842   # classes and files.
1736   1843   # The default value is: NO.
1737   1844
1738   1845   GENERATE_MAN           = NO
1739   1846
1740   1847   # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1741   1848   # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
................................................................................
1750   1857   # man pages. In case the manual section does not start with a number, the number
1751   1858   # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1752   1859   # optional.
1753   1860   # The default value is: .3.
1754   1861   # This tag requires that the tag GENERATE_MAN is set to YES.
1755   1862
1756   1863   MAN_EXTENSION          = .3
1864  +
1865  +# The MAN_SUBDIR tag determines the name of the directory created within
1866  +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1867  +# MAN_EXTENSION with the initial . removed.
1868  +# This tag requires that the tag GENERATE_MAN is set to YES.
1869  +
1870  +MAN_SUBDIR             =
1757   1871
1758   1872   # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1759   1873   # will generate one additional man file for each entity documented in the real
1760   1874   # man page(s). These additional files only source the real man page, but without
1761   1875   # them the man command would be unable to find the correct page.
1762   1876   # The default value is: NO.
1763   1877   # This tag requires that the tag GENERATE_MAN is set to YES.
................................................................................
1764   1878
1766   1880
1767   1881   #---------------------------------------------------------------------------
1768   1882   # Configuration options related to the XML output
1769   1883   #---------------------------------------------------------------------------
1770   1884
1771         -# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1885  +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1772   1886   # captures the structure of the code including all documentation.
1773   1887   # The default value is: NO.
1774   1888
1775   1889   GENERATE_XML           = NO
1776   1890
1777   1891   # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1778   1892   # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1779   1893   # it.
1780   1894   # The default directory is: xml.
1781   1895   # This tag requires that the tag GENERATE_XML is set to YES.
1782   1896
1783   1897   XML_OUTPUT             = xml
1784   1898
1785         -# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1899  +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1786   1900   # listings (including syntax highlighting and cross-referencing information) to
1787   1901   # the XML output. Note that enabling this will significantly increase the size
1788   1902   # of the XML output.
1789   1903   # The default value is: YES.
1790   1904   # This tag requires that the tag GENERATE_XML is set to YES.
1791   1905
1792   1906   XML_PROGRAMLISTING     = YES
1793   1907
1794   1908   #---------------------------------------------------------------------------
1795   1909   # Configuration options related to the DOCBOOK output
1796   1910   #---------------------------------------------------------------------------
1797   1911
1798         -# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1912  +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1799   1913   # that can be used to generate PDF.
1800   1914   # The default value is: NO.
1801   1915
1802   1916   GENERATE_DOCBOOK       = NO
1803   1917
1804   1918   # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1805   1919   # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1806   1920   # front of it.
1807   1921   # The default directory is: docbook.
1808   1922   # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1809   1923
1810   1924   DOCBOOK_OUTPUT         = docbook
1925  +
1926  +# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1927  +# program listings (including syntax highlighting and cross-referencing
1928  +# information) to the DOCBOOK output. Note that enabling this will significantly
1929  +# increase the size of the DOCBOOK output.
1930  +# The default value is: NO.
1931  +# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1932  +
1933  +DOCBOOK_PROGRAMLISTING = NO
1811   1934
1812   1935   #---------------------------------------------------------------------------
1813   1936   # Configuration options for the AutoGen Definitions output
1814   1937   #---------------------------------------------------------------------------
1815   1938
1816         -# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1817         -# Definitions (see http://autogen.sf.net) file that captures the structure of
1818         -# the code including all documentation. Note that this feature is still
1819         -# experimental and incomplete at the moment.
1939  +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1940  +# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
1941  +# the structure of the code including all documentation. Note that this feature
1942  +# is still experimental and incomplete at the moment.
1820   1943   # The default value is: NO.
1821   1944
1822   1945   GENERATE_AUTOGEN_DEF   = NO
1823   1946
1824   1947   #---------------------------------------------------------------------------
1825   1948   # Configuration options related to the Perl module output
1826   1949   #---------------------------------------------------------------------------
1827   1950
1828         -# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
1951  +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1829   1952   # file that captures the structure of the code including all documentation.
1830   1953   #
1831   1954   # Note that this feature is still experimental and incomplete at the moment.
1832   1955   # The default value is: NO.
1833   1956
1834   1957   GENERATE_PERLMOD       = NO
1835   1958
1836         -# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
1959  +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
1837   1960   # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
1838   1961   # output from the Perl module output.
1839   1962   # The default value is: NO.
1840   1963   # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1841   1964
1842   1965   PERLMOD_LATEX          = NO
1843   1966
1844         -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
1967  +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
1845   1968   # formatted so it can be parsed by a human reader. This is useful if you want to
1846         -# understand what is going on. On the other hand, if this tag is set to NO the
1969  +# understand what is going on. On the other hand, if this tag is set to NO, the
1847   1970   # size of the Perl module output will be much smaller and Perl will parse it
1848   1971   # just the same.
1849   1972   # The default value is: YES.
1850   1973   # This tag requires that the tag GENERATE_PERLMOD is set to YES.
1851   1974
1852   1975   PERLMOD_PRETTY         = YES
1853   1976
................................................................................
1859   1982
1860   1983   PERLMOD_MAKEVAR_PREFIX =
1861   1984
1862   1985   #---------------------------------------------------------------------------
1863   1986   # Configuration options related to the preprocessor
1864   1987   #---------------------------------------------------------------------------
1865   1988
1866         -# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
1989  +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
1867   1990   # C-preprocessor directives found in the sources and include files.
1868   1991   # The default value is: YES.
1869   1992
1870   1993   ENABLE_PREPROCESSING   = YES
1871   1994
1872         -# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1873         -# in the source code. If set to NO only conditional compilation will be
1995  +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
1996  +# in the source code. If set to NO, only conditional compilation will be
1874   1997   # performed. Macro expansion can be done in a controlled way by setting
1875   1998   # EXPAND_ONLY_PREDEF to YES.
1876   1999   # The default value is: NO.
1877   2000   # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1878   2001
1879   2002   MACRO_EXPANSION        = NO
1880   2003
................................................................................
1882   2005   # the macro expansion is limited to the macros specified with the PREDEFINED and
1883   2006   # EXPAND_AS_DEFINED tags.
1884   2007   # The default value is: NO.
1885   2008   # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1886   2009
1887   2010   EXPAND_ONLY_PREDEF     = NO
1888   2011
1889         -# If the SEARCH_INCLUDES tag is set to YES the includes files in the
2012  +# If the SEARCH_INCLUDES tag is set to YES, the include files in the
1890   2013   # INCLUDE_PATH will be searched if a #include is found.
1891   2014   # The default value is: YES.
1892   2015   # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1893   2016
1894   2017   SEARCH_INCLUDES        = YES
1895   2018
1896   2019   # The INCLUDE_PATH tag can be used to specify one or more directories that
................................................................................
1924   2047   # tag if you want to use a different macro definition that overrules the
1925   2048   # definition found in the source code.
1926   2049   # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1927   2050
1928   2051   EXPAND_AS_DEFINED      =
1929   2052
1930   2053   # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
1931         -# remove all refrences to function-like macros that are alone on a line, have an
1932         -# all uppercase name, and do not end with a semicolon. Such function macros are
1933         -# typically used for boiler-plate code, and will confuse the parser if not
2054  +# remove all references to function-like macros that are alone on a line, have
2055  +# an all uppercase name, and do not end with a semicolon. Such function macros
2056  +# are typically used for boiler-plate code, and will confuse the parser if not
1934   2057   # removed.
1935   2058   # The default value is: YES.
1936   2059   # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
1937   2060
1938   2061   SKIP_FUNCTION_MACROS   = YES
1939   2062
1940   2063   #---------------------------------------------------------------------------
................................................................................
1946   2069   # a tag file without this location is as follows:
1947   2070   # TAGFILES = file1 file2 ...
1948   2071   # Adding location for the tag files is done as follows:
1949   2072   # TAGFILES = file1=loc1 "file2 = loc2" ...
1950   2073   # where loc1 and loc2 can be relative or absolute paths or URLs. See the
1952   2075   # of tag files.
1953         -# Note: Each tag file must have an unique name (where the name does NOT include
2076  +# Note: Each tag file must have a unique name (where the name does NOT include
1954   2077   # the path). If a tag file is not located in the directory in which doxygen is
1955   2078   # run, you must also specify the path to the tagfile here.
1956   2079
1957   2080   TAGFILES               =
1958   2081
1959   2082   # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
1960   2083   # tag file that is based on the input files it reads. See section "Linking to
1962   2085
1963   2086   GENERATE_TAGFILE       =
1964   2087
1965         -# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
1966         -# class index. If set to NO only the inherited external classes will be listed.
2088  +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2089  +# the class index. If set to NO, only the inherited external classes will be
2090  +# listed.
1967   2091   # The default value is: NO.
1968   2092
1969   2093   ALLEXTERNALS           = NO
1970   2094
1971         -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
1972         -# the modules index. If set to NO, only the current project's groups will be
2095  +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2096  +# in the modules index. If set to NO, only the current project's groups will be
1973   2097   # listed.
1974   2098   # The default value is: YES.
1975   2099
1976   2100   EXTERNAL_GROUPS        = YES
1977   2101
1978         -# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2102  +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
1979   2103   # the related pages index. If set to NO, only the current project's pages will
1980   2104   # be listed.
1981   2105   # The default value is: YES.
1982   2106
1983   2107   EXTERNAL_PAGES         = YES
1984   2108
1985   2109   # The PERL_PATH should be the absolute path and name of the perl script
................................................................................
1988   2112
1989   2113   PERL_PATH              = /usr/bin/perl
1990   2114
1991   2115   #---------------------------------------------------------------------------
1992   2116   # Configuration options related to the dot tool
1993   2117   #---------------------------------------------------------------------------
1994   2118
1995         -# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2119  +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
1996   2120   # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
1997   2121   # NO turns the diagrams off. Note that this option also works with HAVE_DOT
1998   2122   # disabled, but it is recommended to install and use dot, since it yields more
1999   2123   # powerful graphs.
2000   2124   # The default value is: YES.
2001   2125
2002   2126   CLASS_DIAGRAMS         = YES
................................................................................
2006   2130   # http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2007   2131   # documentation. The MSCGEN_PATH tag allows you to specify the directory where
2008   2132   # the mscgen tool resides. If left empty the tool is assumed to be found in the
2009   2133   # default search path.
2010   2134
2011   2135   MSCGEN_PATH            =
2012   2136
2013         -# If set to YES, the inheritance and collaboration graphs will hide inheritance
2137  +# You can include diagrams made with dia in doxygen documentation. Doxygen will
2138  +# then run dia to produce the diagram and insert it in the documentation. The
2139  +# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2140  +# If left empty dia is assumed to be found in the default search path.
2141  +
2142  +DIA_PATH               =
2143  +
2144  +# If set to YES the inheritance and collaboration graphs will hide inheritance
2014   2145   # and usage relations if the target is undocumented or is not a class.
2015   2146   # The default value is: YES.
2016   2147
2017   2148   HIDE_UNDOC_RELATIONS   = YES
2018   2149
2019   2150   # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2020   2151   # available from the path. This tool is part of Graphviz (see:
................................................................................
2031   2162   # larger than 0 to get control over the balance between CPU load and processing
2032   2163   # speed.
2033   2164   # Minimum value: 0, maximum value: 32, default value: 0.
2034   2165   # This tag requires that the tag HAVE_DOT is set to YES.
2035   2166
2037   2168
2038         -# When you want a differently looking font n the dot files that doxygen
2169  +# When you want a differently looking font in the dot files that doxygen
2039   2170   # generates you can specify the font name using DOT_FONTNAME. You need to make
2040   2171   # sure dot is able to find the font, which can be done by putting it in a
2041   2172   # standard location or by setting the DOTFONTPATH environment variable or by
2042   2173   # setting DOT_FONTPATH to the directory containing the font.
2043   2174   # The default value is: Helvetica.
2044   2175   # This tag requires that the tag HAVE_DOT is set to YES.
2045   2176
................................................................................
2079   2210   # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2080   2211   # groups, showing the direct groups dependencies.
2081   2212   # The default value is: YES.
2082   2213   # This tag requires that the tag HAVE_DOT is set to YES.
2083   2214
2084   2215   GROUP_GRAPHS           = YES
2085   2216
2086         -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2217  +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2087   2218   # collaboration diagrams in a style similar to the OMG's Unified Modeling
2088   2219   # Language.
2089   2220   # The default value is: NO.
2090   2221   # This tag requires that the tag HAVE_DOT is set to YES.
2091   2222
2092   2223   UML_LOOK               = NO
2093   2224
................................................................................
2131   2262   INCLUDED_BY_GRAPH      = NO
2132   2263
2133   2264   # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2134   2265   # dependency graph for every global function or class method.
2135   2266   #
2136   2267   # Note that enabling this option will significantly increase the time of a run.
2137   2268   # So in most cases it will be better to enable call graphs for selected
2138         -# functions only using the \callgraph command.
2269  +# functions only using the \callgraph command. Disabling a call graph can be
2270  +# accomplished by means of the command \hidecallgraph.
2139   2271   # The default value is: NO.
2140   2272   # This tag requires that the tag HAVE_DOT is set to YES.
2141   2273
2142   2274   CALL_GRAPH             = NO
2143   2275
2144   2276   # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2145   2277   # dependency graph for every global function or class method.
2146   2278   #
2147   2279   # Note that enabling this option will significantly increase the time of a run.
2148   2280   # So in most cases it will be better to enable caller graphs for selected
2149         -# functions only using the \callergraph command.
2281  +# functions only using the \callergraph command. Disabling a caller graph can be
2282  +# accomplished by means of the command \hidecallergraph.
2150   2283   # The default value is: NO.
2151   2284   # This tag requires that the tag HAVE_DOT is set to YES.
2152   2285
2153   2286   CALLER_GRAPH           = NO
2154   2287
2155   2288   # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2156   2289   # hierarchy of all classes instead of a textual one.
................................................................................
2165   2298   # files in the directories.
2166   2299   # The default value is: YES.
2167   2300   # This tag requires that the tag HAVE_DOT is set to YES.
2168   2301
2169   2302   DIRECTORY_GRAPH        = YES
2170   2303
2171   2304   # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2172         -# generated by dot.
2305  +# generated by dot. For an explanation of the image formats see the section
2306  +# output formats in the documentation of the dot tool (Graphviz (see:
2307  +# http://www.graphviz.org/)).
2173   2308   # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2174   2309   # to make the SVG files visible in IE 9+ (other browsers do not have this
2175   2310   # requirement).
2176         -# Possible values are: png, jpg, gif and svg.
2311  +# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2312  +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2313  +# png:gdiplus:gdiplus.
2177   2314   # The default value is: png.
2178   2315   # This tag requires that the tag HAVE_DOT is set to YES.
2179   2316
2180   2317   DOT_IMAGE_FORMAT       = png
2181   2318
2182   2319   # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2183   2320   # enable generation of interactive SVG images that allow zooming and panning.
................................................................................
2205   2342   DOTFILE_DIRS           =
2206   2343
2207   2344   # The MSCFILE_DIRS tag can be used to specify one or more directories that
2208   2345   # contain msc files that are included in the documentation (see the \mscfile
2209   2346   # command).
2210   2347
2211   2348   MSCFILE_DIRS           =
2349  +
2350  +# The DIAFILE_DIRS tag can be used to specify one or more directories that
2351  +# contain dia files that are included in the documentation (see the \diafile
2352  +# command).
2353  +
2354  +DIAFILE_DIRS           =
2355  +
2356  +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2357  +# path where java can find the plantuml.jar file. If left blank, it is assumed
2358  +# PlantUML is not used or called during a preprocessing step. Doxygen will
2359  +# generate a warning when it encounters a \startuml command in this case and
2360  +# will not generate output for the diagram.
2361  +
2362  +PLANTUML_JAR_PATH      =
2363  +
2364  +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2365  +# configuration file for plantuml.
2366  +
2367  +PLANTUML_CFG_FILE      =
2368  +
2369  +# When using plantuml, the specified paths are searched for files specified by
2370  +# the !include statement in a plantuml block.
2371  +
2372  +PLANTUML_INCLUDE_PATH  =
2212   2373
2213   2374   # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2214   2375   # that will be shown in the graph. If the number of nodes in a graph becomes
2215   2376   # larger than this value, doxygen will truncate the graph, which is visualized
2216   2377   # by representing a node as a red box. Note that doxygen if the number of direct
2217   2378   # children of the root node in a graph is already larger than
2218   2379   # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
................................................................................
2242   2403   # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2244   2405   # The default value is: NO.
2245   2406   # This tag requires that the tag HAVE_DOT is set to YES.
2246   2407
2247   2408   DOT_TRANSPARENT        = NO
2248   2409
2249         -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2410  +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2250   2411   # files in one run (i.e. multiple -o and -T options on the command line). This
2251   2412   # makes dot run faster, but since only newer versions of dot (>1.8.10) support
2252   2413   # this, this feature is disabled by default.
2253   2414   # The default value is: NO.
2254   2415   # This tag requires that the tag HAVE_DOT is set to YES.
2255   2416
2256   2417   DOT_MULTI_TARGETS      = NO
................................................................................
2259   2420   # explaining the meaning of the various boxes and arrows in the dot generated
2260   2421   # graphs.
2261   2422   # The default value is: YES.
2262   2423   # This tag requires that the tag HAVE_DOT is set to YES.
2263   2424
2264   2425   GENERATE_LEGEND        = YES
2265   2426
2266         -# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2427  +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2267   2428   # files that are used to generate the various graphs.
2268   2429   # The default value is: YES.
2269   2430   # This tag requires that the tag HAVE_DOT is set to YES.
2270   2431
2271   2432   DOT_CLEANUP            = YES