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