ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/REPOS_ERICCA/magic/documentation/docmagic
(Generate patch)

Comparing magic/documentation/docmagic (file contents):
Revision 357 by francois, Wed Aug 15 19:33:45 2012 UTC vs.
Revision 1081 by francois, Mon Nov 1 21:29:51 2021 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines