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 652 by francois, Thu Feb 19 19:35:16 2015 UTC vs.
Revision 1069 by francois, Mon Jun 14 20:12:11 2021 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines