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 284 by francois, Thu Sep 15 20:50:01 2011 UTC vs.
Revision 1020 by francois, Wed Jun 5 14:33:14 2019 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines