1 |
# Doxyfile 1.5.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 hash (#) is considered a comment and will be ignored |
7 |
# The format is: |
8 |
# TAG = value [value, ...] |
9 |
# For lists items can also be appended using: |
10 |
# TAG += value [value, ...] |
11 |
# Values that contain spaces should be placed between quotes (" ") |
12 |
|
13 |
#--------------------------------------------------------------------------- |
14 |
# Project related configuration options |
15 |
#--------------------------------------------------------------------------- |
16 |
|
17 |
# This tag specifies the encoding used for all characters in the config file |
18 |
# that follow. The default is UTF-8 which is also the encoding used for all |
19 |
# text before the first occurrence of this tag. Doxygen uses libiconv (or the |
20 |
# iconv built into libc) for the transcoding. See |
21 |
# http://www.gnu.org/software/libiconv for the list of possible encodings. |
22 |
|
23 |
DOXYFILE_ENCODING = UTF-8 |
24 |
|
25 |
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
26 |
# by quotes) that should identify the project. |
27 |
|
28 |
PROJECT_NAME = ESYS13 |
29 |
|
30 |
# The PROJECT_NUMBER tag can be used to enter a project or revision number. |
31 |
# This could be handy for archiving the generated documentation or |
32 |
# if some version control system is used. |
33 |
|
34 |
PROJECT_NUMBER = Revision$Revision:1215$ |
35 |
|
36 |
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
37 |
# base path where the generated documentation will be put. |
38 |
# If a relative path is entered, it will be relative to the location |
39 |
# where doxygen was started. If left blank the current directory will be used. |
40 |
|
41 |
OUTPUT_DIRECTORY = release/doc/doxygen |
42 |
|
43 |
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create |
44 |
# 4096 sub-directories (in 2 levels) under the output directory of each output |
45 |
# format and will distribute the generated files over these directories. |
46 |
# Enabling this option can be useful when feeding doxygen a huge amount of |
47 |
# source files, where putting all generated files in the same directory would |
48 |
# otherwise cause performance problems for the file system. |
49 |
|
50 |
CREATE_SUBDIRS = NO |
51 |
|
52 |
# The OUTPUT_LANGUAGE tag is used to specify the language in which all |
53 |
# documentation generated by doxygen is written. Doxygen will use this |
54 |
# information to generate all constant output in the proper language. |
55 |
# The default language is English, other supported languages are: |
56 |
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, |
57 |
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, |
58 |
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), |
59 |
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, |
60 |
# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, |
61 |
# and Ukrainian. |
62 |
|
63 |
OUTPUT_LANGUAGE = English |
64 |
|
65 |
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
66 |
# include brief member descriptions after the members that are listed in |
67 |
# the file and class documentation (similar to JavaDoc). |
68 |
# Set to NO to disable this. |
69 |
|
70 |
BRIEF_MEMBER_DESC = YES |
71 |
|
72 |
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
73 |
# the brief description of a member or function before the detailed description. |
74 |
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
75 |
# brief descriptions will be completely suppressed. |
76 |
|
77 |
REPEAT_BRIEF = YES |
78 |
|
79 |
# This tag implements a quasi-intelligent brief description abbreviator |
80 |
# that is used to form the text in various listings. Each string |
81 |
# in this list, if found as the leading text of the brief description, will be |
82 |
# stripped from the text and the result after processing the whole list, is |
83 |
# used as the annotated text. Otherwise, the brief description is used as-is. |
84 |
# If left blank, the following values are used ("$name" is automatically |
85 |
# replaced with the name of the entity): "The $name class" "The $name widget" |
86 |
# "The $name file" "is" "provides" "specifies" "contains" |
87 |
# "represents" "a" "an" "the" |
88 |
|
89 |
ABBREVIATE_BRIEF = |
90 |
|
91 |
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
92 |
# Doxygen will generate a detailed section even if there is only a brief |
93 |
# description. |
94 |
|
95 |
ALWAYS_DETAILED_SEC = YES |
96 |
|
97 |
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all |
98 |
# inherited members of a class in the documentation of that class as if those |
99 |
# members were ordinary class members. Constructors, destructors and assignment |
100 |
# operators of the base classes will not be shown. |
101 |
|
102 |
INLINE_INHERITED_MEMB = NO |
103 |
|
104 |
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
105 |
# path before files name in the file list and in the header files. If set |
106 |
# to NO the shortest path that makes the file name unique will be used. |
107 |
|
108 |
FULL_PATH_NAMES = NO |
109 |
|
110 |
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
111 |
# can be used to strip a user-defined part of the path. Stripping is |
112 |
# only done if one of the specified strings matches the left-hand part of |
113 |
# the path. The tag can be used to show relative paths in the file list. |
114 |
# If left blank the directory from which doxygen is run is used as the |
115 |
# path to strip. |
116 |
|
117 |
STRIP_FROM_PATH = |
118 |
|
119 |
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of |
120 |
# the path mentioned in the documentation of a class, which tells |
121 |
# the reader which header file to include in order to use a class. |
122 |
# If left blank only the name of the header file containing the class |
123 |
# definition is used. Otherwise one should specify the include paths that |
124 |
# are normally passed to the compiler using the -I flag. |
125 |
|
126 |
STRIP_FROM_INC_PATH = |
127 |
|
128 |
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
129 |
# (but less readable) file names. This can be useful is your file systems |
130 |
# doesn't support long names like on DOS, Mac, or CD-ROM. |
131 |
|
132 |
SHORT_NAMES = NO |
133 |
|
134 |
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
135 |
# will interpret the first line (until the first dot) of a JavaDoc-style |
136 |
# comment as the brief description. If set to NO, the JavaDoc |
137 |
# comments will behave just like regular Qt-style comments |
138 |
# (thus requiring an explicit @brief command for a brief description.) |
139 |
|
140 |
JAVADOC_AUTOBRIEF = NO |
141 |
|
142 |
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will |
143 |
# interpret the first line (until the first dot) of a Qt-style |
144 |
# comment as the brief description. If set to NO, the comments |
145 |
# will behave just like regular Qt-style comments (thus requiring |
146 |
# an explicit \brief command for a brief description.) |
147 |
|
148 |
QT_AUTOBRIEF = NO |
149 |
|
150 |
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
151 |
# treat a multi-line C++ special comment block (i.e. a block of //! or /// |
152 |
# comments) as a brief description. This used to be the default behaviour. |
153 |
# The new default is to treat a multi-line C++ comment block as a detailed |
154 |
# description. Set this tag to YES if you prefer the old behaviour instead. |
155 |
|
156 |
MULTILINE_CPP_IS_BRIEF = NO |
157 |
|
158 |
# If the DETAILS_AT_TOP tag is set to YES then Doxygen |
159 |
# will output the detailed description near the top, like JavaDoc. |
160 |
# If set to NO, the detailed description appears after the member |
161 |
# documentation. |
162 |
|
163 |
DETAILS_AT_TOP = NO |
164 |
|
165 |
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
166 |
# member inherits the documentation from any documented member that it |
167 |
# re-implements. |
168 |
|
169 |
INHERIT_DOCS = YES |
170 |
|
171 |
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce |
172 |
# a new page for each member. If set to NO, the documentation of a member will |
173 |
# be part of the file/class/namespace that contains it. |
174 |
|
175 |
SEPARATE_MEMBER_PAGES = NO |
176 |
|
177 |
# The TAB_SIZE tag can be used to set the number of spaces in a tab. |
178 |
# Doxygen uses this value to replace tabs by spaces in code fragments. |
179 |
|
180 |
TAB_SIZE = 4 |
181 |
|
182 |
# This tag can be used to specify a number of aliases that acts |
183 |
# as commands in the documentation. An alias has the form "name=value". |
184 |
# For example adding "sideeffect=\par Side Effects:\n" will allow you to |
185 |
# put the command \sideeffect (or @sideeffect) in the documentation, which |
186 |
# will result in a user-defined paragraph with heading "Side Effects:". |
187 |
# You can put \n's in the value part of an alias to insert newlines. |
188 |
|
189 |
ALIASES = |
190 |
|
191 |
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C |
192 |
# sources only. Doxygen will then generate output that is more tailored for C. |
193 |
# For instance, some of the names that are used will be different. The list |
194 |
# of all members will be omitted, etc. |
195 |
|
196 |
OPTIMIZE_OUTPUT_FOR_C = NO |
197 |
|
198 |
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java |
199 |
# sources only. Doxygen will then generate output that is more tailored for |
200 |
# Java. For instance, namespaces will be presented as packages, qualified |
201 |
# scopes will look different, etc. |
202 |
|
203 |
OPTIMIZE_OUTPUT_JAVA = NO |
204 |
|
205 |
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran |
206 |
# sources only. Doxygen will then generate output that is more tailored for |
207 |
# Fortran. |
208 |
|
209 |
OPTIMIZE_FOR_FORTRAN = NO |
210 |
|
211 |
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL |
212 |
# sources. Doxygen will then generate output that is tailored for |
213 |
# VHDL. |
214 |
|
215 |
OPTIMIZE_OUTPUT_VHDL = NO |
216 |
|
217 |
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want |
218 |
# to include (a tag file for) the STL sources as input, then you should |
219 |
# set this tag to YES in order to let doxygen match functions declarations and |
220 |
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. |
221 |
# func(std::string) {}). This also make the inheritance and collaboration |
222 |
# diagrams that involve STL classes more complete and accurate. |
223 |
|
224 |
BUILTIN_STL_SUPPORT = YES |
225 |
|
226 |
# If you use Microsoft's C++/CLI language, you should set this option to YES to |
227 |
# enable parsing support. |
228 |
|
229 |
CPP_CLI_SUPPORT = NO |
230 |
|
231 |
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. |
232 |
# Doxygen will parse them like normal C++ but will assume all classes use public |
233 |
# instead of private inheritance when no explicit protection keyword is present. |
234 |
|
235 |
SIP_SUPPORT = NO |
236 |
|
237 |
# For Microsoft's IDL there are propget and propput attributes to indicate getter |
238 |
# and setter methods for a property. Setting this option to YES (the default) |
239 |
# will make doxygen to replace the get and set methods by a property in the |
240 |
# documentation. This will only work if the methods are indeed getting or |
241 |
# setting a simple type. If this is not the case, or you want to show the |
242 |
# methods anyway, you should set this option to NO. |
243 |
|
244 |
IDL_PROPERTY_SUPPORT = YES |
245 |
|
246 |
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
247 |
# tag is set to YES, then doxygen will reuse the documentation of the first |
248 |
# member in the group (if any) for the other members of the group. By default |
249 |
# all members of a group must be documented explicitly. |
250 |
|
251 |
DISTRIBUTE_GROUP_DOC = NO |
252 |
|
253 |
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
254 |
# the same type (for instance a group of public functions) to be put as a |
255 |
# subgroup of that type (e.g. under the Public Functions section). Set it to |
256 |
# NO to prevent subgrouping. Alternatively, this can be done per class using |
257 |
# the \nosubgrouping command. |
258 |
|
259 |
SUBGROUPING = YES |
260 |
|
261 |
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum |
262 |
# is documented as struct, union, or enum with the name of the typedef. So |
263 |
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct |
264 |
# with name TypeT. When disabled the typedef will appear as a member of a file, |
265 |
# namespace, or class. And the struct will be named TypeS. This can typically |
266 |
# be useful for C code in case the coding convention dictates that all compound |
267 |
# types are typedef'ed and only the typedef is referenced, never the tag name. |
268 |
|
269 |
TYPEDEF_HIDES_STRUCT = NO |
270 |
|
271 |
#--------------------------------------------------------------------------- |
272 |
# Build related configuration options |
273 |
#--------------------------------------------------------------------------- |
274 |
|
275 |
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
276 |
# documentation are documented, even if no documentation was available. |
277 |
# Private class members and static file members will be hidden unless |
278 |
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
279 |
|
280 |
EXTRACT_ALL = YES |
281 |
|
282 |
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
283 |
# will be included in the documentation. |
284 |
|
285 |
EXTRACT_PRIVATE = YES |
286 |
|
287 |
# If the EXTRACT_STATIC tag is set to YES all static members of a file |
288 |
# will be included in the documentation. |
289 |
|
290 |
EXTRACT_STATIC = YES |
291 |
|
292 |
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
293 |
# defined locally in source files will be included in the documentation. |
294 |
# If set to NO only classes defined in header files are included. |
295 |
|
296 |
EXTRACT_LOCAL_CLASSES = YES |
297 |
|
298 |
# This flag is only useful for Objective-C code. When set to YES local |
299 |
# methods, which are defined in the implementation section but not in |
300 |
# the interface are included in the documentation. |
301 |
# If set to NO (the default) only methods in the interface are included. |
302 |
|
303 |
EXTRACT_LOCAL_METHODS = NO |
304 |
|
305 |
# If this flag is set to YES, the members of anonymous namespaces will be |
306 |
# extracted and appear in the documentation as a namespace called |
307 |
# 'anonymous_namespace{file}', where file will be replaced with the base |
308 |
# name of the file that contains the anonymous namespace. By default |
309 |
# anonymous namespace are hidden. |
310 |
|
311 |
EXTRACT_ANON_NSPACES = NO |
312 |
|
313 |
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
314 |
# undocumented members of documented classes, files or namespaces. |
315 |
# If set to NO (the default) these members will be included in the |
316 |
# various overviews, but no documentation section is generated. |
317 |
# This option has no effect if EXTRACT_ALL is enabled. |
318 |
|
319 |
HIDE_UNDOC_MEMBERS = NO |
320 |
|
321 |
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
322 |
# undocumented classes that are normally visible in the class hierarchy. |
323 |
# If set to NO (the default) these classes will be included in the various |
324 |
# overviews. This option has no effect if EXTRACT_ALL is enabled. |
325 |
|
326 |
HIDE_UNDOC_CLASSES = NO |
327 |
|
328 |
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
329 |
# friend (class|struct|union) declarations. |
330 |
# If set to NO (the default) these declarations will be included in the |
331 |
# documentation. |
332 |
|
333 |
HIDE_FRIEND_COMPOUNDS = NO |
334 |
|
335 |
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
336 |
# documentation blocks found inside the body of a function. |
337 |
# If set to NO (the default) these blocks will be appended to the |
338 |
# function's detailed documentation block. |
339 |
|
340 |
HIDE_IN_BODY_DOCS = NO |
341 |
|
342 |
# The INTERNAL_DOCS tag determines if documentation |
343 |
# that is typed after a \internal command is included. If the tag is set |
344 |
# to NO (the default) then the documentation will be excluded. |
345 |
# Set it to YES to include the internal documentation. |
346 |
|
347 |
INTERNAL_DOCS = NO |
348 |
|
349 |
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
350 |
# file names in lower-case letters. If set to YES upper-case letters are also |
351 |
# allowed. This is useful if you have classes or files whose names only differ |
352 |
# in case and if your file system supports case sensitive file names. Windows |
353 |
# and Mac users are advised to set this option to NO. |
354 |
|
355 |
CASE_SENSE_NAMES = YES |
356 |
|
357 |
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
358 |
# will show members with their full class and namespace scopes in the |
359 |
# documentation. If set to YES the scope will be hidden. |
360 |
|
361 |
HIDE_SCOPE_NAMES = NO |
362 |
|
363 |
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
364 |
# will put a list of the files that are included by a file in the documentation |
365 |
# of that file. |
366 |
|
367 |
SHOW_INCLUDE_FILES = YES |
368 |
|
369 |
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
370 |
# is inserted in the documentation for inline members. |
371 |
|
372 |
INLINE_INFO = YES |
373 |
|
374 |
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
375 |
# will sort the (detailed) documentation of file and class members |
376 |
# alphabetically by member name. If set to NO the members will appear in |
377 |
# declaration order. |
378 |
|
379 |
SORT_MEMBER_DOCS = YES |
380 |
|
381 |
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the |
382 |
# brief documentation of file, namespace and class members alphabetically |
383 |
# by member name. If set to NO (the default) the members will appear in |
384 |
# declaration order. |
385 |
|
386 |
SORT_BRIEF_DOCS = NO |
387 |
|
388 |
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the |
389 |
# hierarchy of group names into alphabetical order. If set to NO (the default) |
390 |
# the group names will appear in their defined order. |
391 |
|
392 |
SORT_GROUP_NAMES = NO |
393 |
|
394 |
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
395 |
# sorted by fully-qualified names, including namespaces. If set to |
396 |
# NO (the default), the class list will be sorted only by class name, |
397 |
# not including the namespace part. |
398 |
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
399 |
# Note: This option applies only to the class list, not to the |
400 |
# alphabetical list. |
401 |
|
402 |
SORT_BY_SCOPE_NAME = NO |
403 |
|
404 |
# The GENERATE_TODOLIST tag can be used to enable (YES) or |
405 |
# disable (NO) the todo list. This list is created by putting \todo |
406 |
# commands in the documentation. |
407 |
|
408 |
GENERATE_TODOLIST = YES |
409 |
|
410 |
# The GENERATE_TESTLIST tag can be used to enable (YES) or |
411 |
# disable (NO) the test list. This list is created by putting \test |
412 |
# commands in the documentation. |
413 |
|
414 |
GENERATE_TESTLIST = YES |
415 |
|
416 |
# The GENERATE_BUGLIST tag can be used to enable (YES) or |
417 |
# disable (NO) the bug list. This list is created by putting \bug |
418 |
# commands in the documentation. |
419 |
|
420 |
GENERATE_BUGLIST = YES |
421 |
|
422 |
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
423 |
# disable (NO) the deprecated list. This list is created by putting |
424 |
# \deprecated commands in the documentation. |
425 |
|
426 |
GENERATE_DEPRECATEDLIST= YES |
427 |
|
428 |
# The ENABLED_SECTIONS tag can be used to enable conditional |
429 |
# documentation sections, marked by \if sectionname ... \endif. |
430 |
|
431 |
ENABLED_SECTIONS = |
432 |
|
433 |
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
434 |
# the initial value of a variable or define consists of for it to appear in |
435 |
# the documentation. If the initializer consists of more lines than specified |
436 |
# here it will be hidden. Use a value of 0 to hide initializers completely. |
437 |
# The appearance of the initializer of individual variables and defines in the |
438 |
# documentation can be controlled using \showinitializer or \hideinitializer |
439 |
# command in the documentation regardless of this setting. |
440 |
|
441 |
MAX_INITIALIZER_LINES = 30 |
442 |
|
443 |
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
444 |
# at the bottom of the documentation of classes and structs. If set to YES the |
445 |
# list will mention the files that were used to generate the documentation. |
446 |
|
447 |
SHOW_USED_FILES = YES |
448 |
|
449 |
# If the sources in your project are distributed over multiple directories |
450 |
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy |
451 |
# in the documentation. The default is NO. |
452 |
|
453 |
SHOW_DIRECTORIES = NO |
454 |
|
455 |
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. |
456 |
# This will remove the Files entry from the Quick Index and from the |
457 |
# Folder Tree View (if specified). The default is YES. |
458 |
|
459 |
SHOW_FILES = YES |
460 |
|
461 |
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the |
462 |
# Namespaces page. This will remove the Namespaces entry from the Quick Index |
463 |
# and from the Folder Tree View (if specified). The default is YES. |
464 |
|
465 |
SHOW_NAMESPACES = YES |
466 |
|
467 |
# The FILE_VERSION_FILTER tag can be used to specify a program or script that |
468 |
# doxygen should invoke to get the current version for each file (typically from |
469 |
# the version control system). Doxygen will invoke the program by executing (via |
470 |
# popen()) the command <command> <input-file>, where <command> is the value of |
471 |
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file |
472 |
# provided by doxygen. Whatever the program writes to standard output |
473 |
# is used as the file version. See the manual for examples. |
474 |
|
475 |
FILE_VERSION_FILTER = |
476 |
|
477 |
#--------------------------------------------------------------------------- |
478 |
# configuration options related to warning and progress messages |
479 |
#--------------------------------------------------------------------------- |
480 |
|
481 |
# The QUIET tag can be used to turn on/off the messages that are generated |
482 |
# by doxygen. Possible values are YES and NO. If left blank NO is used. |
483 |
|
484 |
QUIET = NO |
485 |
|
486 |
# The WARNINGS tag can be used to turn on/off the warning messages that are |
487 |
# generated by doxygen. Possible values are YES and NO. If left blank |
488 |
# NO is used. |
489 |
|
490 |
WARNINGS = YES |
491 |
|
492 |
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
493 |
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
494 |
# automatically be disabled. |
495 |
|
496 |
WARN_IF_UNDOCUMENTED = YES |
497 |
|
498 |
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
499 |
# potential errors in the documentation, such as not documenting some |
500 |
# parameters in a documented function, or documenting parameters that |
501 |
# don't exist or using markup commands wrongly. |
502 |
|
503 |
WARN_IF_DOC_ERROR = YES |
504 |
|
505 |
# This WARN_NO_PARAMDOC option can be abled to get warnings for |
506 |
# functions that are documented, but have no documentation for their parameters |
507 |
# or return value. If set to NO (the default) doxygen will only warn about |
508 |
# wrong or incomplete parameter documentation, but not about the absence of |
509 |
# documentation. |
510 |
|
511 |
WARN_NO_PARAMDOC = NO |
512 |
|
513 |
# The WARN_FORMAT tag determines the format of the warning messages that |
514 |
# doxygen can produce. The string should contain the $file, $line, and $text |
515 |
# tags, which will be replaced by the file and line number from which the |
516 |
# warning originated and the warning text. Optionally the format may contain |
517 |
# $version, which will be replaced by the version of the file (if it could |
518 |
# be obtained via FILE_VERSION_FILTER) |
519 |
|
520 |
WARN_FORMAT = |
521 |
|
522 |
# The WARN_LOGFILE tag can be used to specify a file to which warning |
523 |
# and error messages should be written. If left blank the output is written |
524 |
# to stderr. |
525 |
|
526 |
WARN_LOGFILE = |
527 |
|
528 |
#--------------------------------------------------------------------------- |
529 |
# configuration options related to the input files |
530 |
#--------------------------------------------------------------------------- |
531 |
|
532 |
# The INPUT tag can be used to specify the files and/or directories that contain |
533 |
# documented source files. You may enter file names like "myfile.cpp" or |
534 |
# directories like "/usr/src/myproject". Separate the files or directories |
535 |
# with spaces. |
536 |
|
537 |
INPUT = escript/src \ |
538 |
esysUtils/src \ |
539 |
finley/src \ |
540 |
paso/src \ |
541 |
pythonMPI/src |
542 |
|
543 |
# This tag can be used to specify the character encoding of the source files |
544 |
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is |
545 |
# also the default input encoding. Doxygen uses libiconv (or the iconv built |
546 |
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for |
547 |
# the list of possible encodings. |
548 |
|
549 |
INPUT_ENCODING = UTF-8 |
550 |
|
551 |
# If the value of the INPUT tag contains directories, you can use the |
552 |
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
553 |
# and *.h) to filter out the source-files in the directories. If left |
554 |
# blank the following patterns are tested: |
555 |
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx |
556 |
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 |
557 |
|
558 |
FILE_PATTERNS = *.c \ |
559 |
*.cpp \ |
560 |
*.h |
561 |
|
562 |
# The RECURSIVE tag can be used to turn specify whether or not subdirectories |
563 |
# should be searched for input files as well. Possible values are YES and NO. |
564 |
# If left blank NO is used. |
565 |
|
566 |
RECURSIVE = YES |
567 |
|
568 |
# The EXCLUDE tag can be used to specify files and/or directories that should |
569 |
# excluded from the INPUT source files. This way you can easily exclude a |
570 |
# subdirectory from a directory tree whose root is specified with the INPUT tag. |
571 |
|
572 |
EXCLUDE = test |
573 |
|
574 |
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or |
575 |
# directories that are symbolic links (a Unix filesystem feature) are excluded |
576 |
# from the input. |
577 |
|
578 |
EXCLUDE_SYMLINKS = NO |
579 |
|
580 |
# If the value of the INPUT tag contains directories, you can use the |
581 |
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
582 |
# certain files from those directories. Note that the wildcards are matched |
583 |
# against the file with absolute path, so to exclude all test directories |
584 |
# for example use the pattern */test/* |
585 |
|
586 |
EXCLUDE_PATTERNS = */.svn/* */.svn */deprecated/* |
587 |
|
588 |
#found this pattern on the net - hopefully will not check svn dirs |
589 |
|
590 |
|
591 |
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
592 |
# (namespaces, classes, functions, etc.) that should be excluded from the |
593 |
# output. The symbol name can be a fully qualified name, a word, or if the |
594 |
# wildcard * is used, a substring. Examples: ANamespace, AClass, |
595 |
# AClass::ANamespace, ANamespace::*Test |
596 |
|
597 |
EXCLUDE_SYMBOLS = |
598 |
|
599 |
# The EXAMPLE_PATH tag can be used to specify one or more files or |
600 |
# directories that contain example code fragments that are included (see |
601 |
# the \include command). |
602 |
|
603 |
EXAMPLE_PATH = |
604 |
|
605 |
# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
606 |
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
607 |
# and *.h) to filter out the source-files in the directories. If left |
608 |
# blank all files are included. |
609 |
|
610 |
EXAMPLE_PATTERNS = |
611 |
|
612 |
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
613 |
# searched for input files to be used with the \include or \dontinclude |
614 |
# commands irrespective of the value of the RECURSIVE tag. |
615 |
# Possible values are YES and NO. If left blank NO is used. |
616 |
|
617 |
EXAMPLE_RECURSIVE = NO |
618 |
|
619 |
# The IMAGE_PATH tag can be used to specify one or more files or |
620 |
# directories that contain image that are included in the documentation (see |
621 |
# the \image command). |
622 |
|
623 |
IMAGE_PATH = |
624 |
|
625 |
# The INPUT_FILTER tag can be used to specify a program that doxygen should |
626 |
# invoke to filter for each input file. Doxygen will invoke the filter program |
627 |
# by executing (via popen()) the command <filter> <input-file>, where <filter> |
628 |
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
629 |
# input file. Doxygen will then use the output that the filter program writes |
630 |
# to standard output. If FILTER_PATTERNS is specified, this tag will be |
631 |
# ignored. |
632 |
|
633 |
INPUT_FILTER = |
634 |
|
635 |
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
636 |
# basis. Doxygen will compare the file name with each pattern and apply the |
637 |
# filter if there is a match. The filters are a list of the form: |
638 |
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further |
639 |
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER |
640 |
# is applied to all files. |
641 |
|
642 |
FILTER_PATTERNS = |
643 |
|
644 |
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
645 |
# INPUT_FILTER) will be used to filter the input files when producing source |
646 |
# files to browse (i.e. when SOURCE_BROWSER is set to YES). |
647 |
|
648 |
FILTER_SOURCE_FILES = NO |
649 |
|
650 |
#--------------------------------------------------------------------------- |
651 |
# configuration options related to source browsing |
652 |
#--------------------------------------------------------------------------- |
653 |
|
654 |
# If the SOURCE_BROWSER tag is set to YES then a list of source files will |
655 |
# be generated. Documented entities will be cross-referenced with these sources. |
656 |
# Note: To get rid of all source code in the generated output, make sure also |
657 |
# VERBATIM_HEADERS is set to NO. |
658 |
|
659 |
SOURCE_BROWSER = NO |
660 |
|
661 |
# Setting the INLINE_SOURCES tag to YES will include the body |
662 |
# of functions and classes directly in the documentation. |
663 |
|
664 |
INLINE_SOURCES = NO |
665 |
|
666 |
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
667 |
# doxygen to hide any special comment blocks from generated source code |
668 |
# fragments. Normal C and C++ comments will always remain visible. |
669 |
|
670 |
STRIP_CODE_COMMENTS = YES |
671 |
|
672 |
# If the REFERENCED_BY_RELATION tag is set to YES |
673 |
# then for each documented function all documented |
674 |
# functions referencing it will be listed. |
675 |
|
676 |
REFERENCED_BY_RELATION = YES |
677 |
|
678 |
# If the REFERENCES_RELATION tag is set to YES |
679 |
# then for each documented function all documented entities |
680 |
# called/used by that function will be listed. |
681 |
|
682 |
REFERENCES_RELATION = YES |
683 |
|
684 |
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) |
685 |
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from |
686 |
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will |
687 |
# link to the source code. Otherwise they will link to the documentstion. |
688 |
|
689 |
REFERENCES_LINK_SOURCE = YES |
690 |
|
691 |
# If the USE_HTAGS tag is set to YES then the references to source code |
692 |
# will point to the HTML generated by the htags(1) tool instead of doxygen |
693 |
# built-in source browser. The htags tool is part of GNU's global source |
694 |
# tagging system (see http://www.gnu.org/software/global/global.html). You |
695 |
# will need version 4.8.6 or higher. |
696 |
|
697 |
USE_HTAGS = NO |
698 |
|
699 |
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
700 |
# will generate a verbatim copy of the header file for each class for |
701 |
# which an include is specified. Set to NO to disable this. |
702 |
|
703 |
VERBATIM_HEADERS = YES |
704 |
|
705 |
#--------------------------------------------------------------------------- |
706 |
# configuration options related to the alphabetical class index |
707 |
#--------------------------------------------------------------------------- |
708 |
|
709 |
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
710 |
# of all compounds will be generated. Enable this if the project |
711 |
# contains a lot of classes, structs, unions or interfaces. |
712 |
|
713 |
ALPHABETICAL_INDEX = YES |
714 |
|
715 |
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
716 |
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
717 |
# in which this list will be split (can be a number in the range [1..20]) |
718 |
|
719 |
COLS_IN_ALPHA_INDEX = 5 |
720 |
|
721 |
# In case all classes in a project start with a common prefix, all |
722 |
# classes will be put under the same header in the alphabetical index. |
723 |
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
724 |
# should be ignored while generating the index headers. |
725 |
|
726 |
IGNORE_PREFIX = |
727 |
|
728 |
#--------------------------------------------------------------------------- |
729 |
# configuration options related to the HTML output |
730 |
#--------------------------------------------------------------------------- |
731 |
|
732 |
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
733 |
# generate HTML output. |
734 |
|
735 |
GENERATE_HTML = YES |
736 |
|
737 |
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
738 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
739 |
# put in front of it. If left blank `html' will be used as the default path. |
740 |
|
741 |
HTML_OUTPUT = |
742 |
|
743 |
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
744 |
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
745 |
# doxygen will generate files with .html extension. |
746 |
|
747 |
HTML_FILE_EXTENSION = .html |
748 |
|
749 |
# The HTML_HEADER tag can be used to specify a personal HTML header for |
750 |
# each generated HTML page. If it is left blank doxygen will generate a |
751 |
# standard header. |
752 |
|
753 |
HTML_HEADER = |
754 |
|
755 |
# The HTML_FOOTER tag can be used to specify a personal HTML footer for |
756 |
# each generated HTML page. If it is left blank doxygen will generate a |
757 |
# standard footer. |
758 |
|
759 |
HTML_FOOTER = |
760 |
|
761 |
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
762 |
# style sheet that is used by each HTML page. It can be used to |
763 |
# fine-tune the look of the HTML output. If the tag is left blank doxygen |
764 |
# will generate a default style sheet. Note that doxygen will try to copy |
765 |
# the style sheet file to the HTML output directory, so don't put your own |
766 |
# stylesheet in the HTML output directory as well, or it will be erased! |
767 |
|
768 |
HTML_STYLESHEET = |
769 |
|
770 |
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
771 |
# files or namespaces will be aligned in HTML using tables. If set to |
772 |
# NO a bullet list will be used. |
773 |
|
774 |
HTML_ALIGN_MEMBERS = YES |
775 |
|
776 |
# If the GENERATE_HTMLHELP tag is set to YES, additional index files |
777 |
# will be generated that can be used as input for tools like the |
778 |
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) |
779 |
# of the generated HTML documentation. |
780 |
|
781 |
GENERATE_HTMLHELP = NO |
782 |
|
783 |
# If the GENERATE_DOCSET tag is set to YES, additional index files |
784 |
# will be generated that can be used as input for Apple's Xcode 3 |
785 |
# integrated development environment, introduced with OSX 10.5 (Leopard). |
786 |
# To create a documentation set, doxygen will generate a Makefile in the |
787 |
# HTML output directory. Running make will produce the docset in that |
788 |
# directory and running "make install" will install the docset in |
789 |
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find |
790 |
# it at startup. |
791 |
|
792 |
GENERATE_DOCSET = NO |
793 |
|
794 |
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the |
795 |
# feed. A documentation feed provides an umbrella under which multiple |
796 |
# documentation sets from a single provider (such as a company or product suite) |
797 |
# can be grouped. |
798 |
|
799 |
DOCSET_FEEDNAME = "Doxygen generated docs" |
800 |
|
801 |
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that |
802 |
# should uniquely identify the documentation set bundle. This should be a |
803 |
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen |
804 |
# will append .docset to the name. |
805 |
|
806 |
DOCSET_BUNDLE_ID = org.doxygen.Project |
807 |
|
808 |
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
809 |
# documentation will contain sections that can be hidden and shown after the |
810 |
# page has loaded. For this to work a browser that supports |
811 |
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox |
812 |
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). |
813 |
|
814 |
HTML_DYNAMIC_SECTIONS = NO |
815 |
|
816 |
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
817 |
# be used to specify the file name of the resulting .chm file. You |
818 |
# can add a path in front of the file if the result should not be |
819 |
# written to the html output directory. |
820 |
|
821 |
CHM_FILE = |
822 |
|
823 |
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
824 |
# be used to specify the location (absolute path including file name) of |
825 |
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
826 |
# the HTML help compiler on the generated index.hhp. |
827 |
|
828 |
HHC_LOCATION = |
829 |
|
830 |
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
831 |
# controls if a separate .chi index file is generated (YES) or that |
832 |
# it should be included in the master .chm file (NO). |
833 |
|
834 |
GENERATE_CHI = NO |
835 |
|
836 |
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING |
837 |
# is used to encode HtmlHelp index (hhk), content (hhc) and project file |
838 |
# content. |
839 |
|
840 |
CHM_INDEX_ENCODING = |
841 |
|
842 |
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
843 |
# controls whether a binary table of contents is generated (YES) or a |
844 |
# normal table of contents (NO) in the .chm file. |
845 |
|
846 |
BINARY_TOC = NO |
847 |
|
848 |
# The TOC_EXPAND flag can be set to YES to add extra items for group members |
849 |
# to the contents of the HTML help documentation and to the tree view. |
850 |
|
851 |
TOC_EXPAND = NO |
852 |
|
853 |
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
854 |
# top of each HTML page. The value NO (the default) enables the index and |
855 |
# the value YES disables it. |
856 |
|
857 |
DISABLE_INDEX = NO |
858 |
|
859 |
# This tag can be used to set the number of enum values (range [1..20]) |
860 |
# that doxygen will group on one line in the generated HTML documentation. |
861 |
|
862 |
ENUM_VALUES_PER_LINE = 4 |
863 |
|
864 |
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index |
865 |
# structure should be generated to display hierarchical information. |
866 |
# If the tag value is set to FRAME, a side panel will be generated |
867 |
# containing a tree-like index structure (just like the one that |
868 |
# is generated for HTML Help). For this to work a browser that supports |
869 |
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
870 |
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
871 |
# probably better off using the HTML help feature. Other possible values |
872 |
# for this tag are: HIERARCHIES, which will generate the Groups, Directories, |
873 |
# and Class Hiererachy pages using a tree view instead of an ordered list; |
874 |
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which |
875 |
# disables this behavior completely. For backwards compatibility with previous |
876 |
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE |
877 |
# respectively. |
878 |
|
879 |
GENERATE_TREEVIEW = NO |
880 |
|
881 |
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
882 |
# used to set the initial width (in pixels) of the frame in which the tree |
883 |
# is shown. |
884 |
|
885 |
TREEVIEW_WIDTH = 250 |
886 |
|
887 |
# Use this tag to change the font size of Latex formulas included |
888 |
# as images in the HTML documentation. The default is 10. Note that |
889 |
# when you change the font size after a successful doxygen run you need |
890 |
# to manually remove any form_*.png images from the HTML output directory |
891 |
# to force them to be regenerated. |
892 |
|
893 |
FORMULA_FONTSIZE = 10 |
894 |
|
895 |
#--------------------------------------------------------------------------- |
896 |
# configuration options related to the LaTeX output |
897 |
#--------------------------------------------------------------------------- |
898 |
|
899 |
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
900 |
# generate Latex output. |
901 |
|
902 |
GENERATE_LATEX = NO |
903 |
|
904 |
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
905 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
906 |
# put in front of it. If left blank `latex' will be used as the default path. |
907 |
|
908 |
LATEX_OUTPUT = |
909 |
|
910 |
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
911 |
# invoked. If left blank `latex' will be used as the default command name. |
912 |
|
913 |
LATEX_CMD_NAME = latex |
914 |
|
915 |
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
916 |
# generate index for LaTeX. If left blank `makeindex' will be used as the |
917 |
# default command name. |
918 |
|
919 |
MAKEINDEX_CMD_NAME = makeindex |
920 |
|
921 |
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
922 |
# LaTeX documents. This may be useful for small projects and may help to |
923 |
# save some trees in general. |
924 |
|
925 |
COMPACT_LATEX = NO |
926 |
|
927 |
# The PAPER_TYPE tag can be used to set the paper type that is used |
928 |
# by the printer. Possible values are: a4, a4wide, letter, legal and |
929 |
# executive. If left blank a4wide will be used. |
930 |
|
931 |
PAPER_TYPE = a4wide |
932 |
|
933 |
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
934 |
# packages that should be included in the LaTeX output. |
935 |
|
936 |
EXTRA_PACKAGES = |
937 |
|
938 |
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
939 |
# the generated latex document. The header should contain everything until |
940 |
# the first chapter. If it is left blank doxygen will generate a |
941 |
# standard header. Notice: only use this tag if you know what you are doing! |
942 |
|
943 |
LATEX_HEADER = |
944 |
|
945 |
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
946 |
# is prepared for conversion to pdf (using ps2pdf). The pdf file will |
947 |
# contain links (just like the HTML output) instead of page references |
948 |
# This makes the output suitable for online browsing using a pdf viewer. |
949 |
|
950 |
PDF_HYPERLINKS = NO |
951 |
|
952 |
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
953 |
# plain latex in the generated Makefile. Set this option to YES to get a |
954 |
# higher quality PDF documentation. |
955 |
|
956 |
USE_PDFLATEX = NO |
957 |
|
958 |
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
959 |
# command to the generated LaTeX files. This will instruct LaTeX to keep |
960 |
# running if errors occur, instead of asking the user for help. |
961 |
# This option is also used when generating formulas in HTML. |
962 |
|
963 |
LATEX_BATCHMODE = NO |
964 |
|
965 |
# If LATEX_HIDE_INDICES is set to YES then doxygen will not |
966 |
# include the index chapters (such as File Index, Compound Index, etc.) |
967 |
# in the output. |
968 |
|
969 |
LATEX_HIDE_INDICES = NO |
970 |
|
971 |
#--------------------------------------------------------------------------- |
972 |
# configuration options related to the RTF output |
973 |
#--------------------------------------------------------------------------- |
974 |
|
975 |
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
976 |
# The RTF output is optimized for Word 97 and may not look very pretty with |
977 |
# other RTF readers or editors. |
978 |
|
979 |
GENERATE_RTF = NO |
980 |
|
981 |
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
982 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
983 |
# put in front of it. If left blank `rtf' will be used as the default path. |
984 |
|
985 |
RTF_OUTPUT = |
986 |
|
987 |
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
988 |
# RTF documents. This may be useful for small projects and may help to |
989 |
# save some trees in general. |
990 |
|
991 |
COMPACT_RTF = NO |
992 |
|
993 |
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
994 |
# will contain hyperlink fields. The RTF file will |
995 |
# contain links (just like the HTML output) instead of page references. |
996 |
# This makes the output suitable for online browsing using WORD or other |
997 |
# programs which support those fields. |
998 |
# Note: wordpad (write) and others do not support links. |
999 |
|
1000 |
RTF_HYPERLINKS = NO |
1001 |
|
1002 |
# Load stylesheet definitions from file. Syntax is similar to doxygen's |
1003 |
# config file, i.e. a series of assignments. You only have to provide |
1004 |
# replacements, missing definitions are set to their default value. |
1005 |
|
1006 |
RTF_STYLESHEET_FILE = |
1007 |
|
1008 |
# Set optional variables used in the generation of an rtf document. |
1009 |
# Syntax is similar to doxygen's config file. |
1010 |
|
1011 |
RTF_EXTENSIONS_FILE = |
1012 |
|
1013 |
#--------------------------------------------------------------------------- |
1014 |
# configuration options related to the man page output |
1015 |
#--------------------------------------------------------------------------- |
1016 |
|
1017 |
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
1018 |
# generate man pages |
1019 |
|
1020 |
GENERATE_MAN = NO |
1021 |
|
1022 |
# The MAN_OUTPUT tag is used to specify where the man pages will be put. |
1023 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1024 |
# put in front of it. If left blank `man' will be used as the default path. |
1025 |
|
1026 |
MAN_OUTPUT = |
1027 |
|
1028 |
# The MAN_EXTENSION tag determines the extension that is added to |
1029 |
# the generated man pages (default is the subroutine's section .3) |
1030 |
|
1031 |
MAN_EXTENSION = |
1032 |
|
1033 |
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
1034 |
# then it will generate one additional man file for each entity |
1035 |
# documented in the real man page(s). These additional files |
1036 |
# only source the real man page, but without them the man command |
1037 |
# would be unable to find the correct page. The default is NO. |
1038 |
|
1039 |
MAN_LINKS = NO |
1040 |
|
1041 |
#--------------------------------------------------------------------------- |
1042 |
# configuration options related to the XML output |
1043 |
#--------------------------------------------------------------------------- |
1044 |
|
1045 |
# If the GENERATE_XML tag is set to YES Doxygen will |
1046 |
# generate an XML file that captures the structure of |
1047 |
# the code including all documentation. |
1048 |
|
1049 |
GENERATE_XML = NO |
1050 |
|
1051 |
# The XML_OUTPUT tag is used to specify where the XML pages will be put. |
1052 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
1053 |
# put in front of it. If left blank `xml' will be used as the default path. |
1054 |
|
1055 |
XML_OUTPUT = xml |
1056 |
|
1057 |
# The XML_SCHEMA tag can be used to specify an XML schema, |
1058 |
# which can be used by a validating XML parser to check the |
1059 |
# syntax of the XML files. |
1060 |
|
1061 |
XML_SCHEMA = |
1062 |
|
1063 |
# The XML_DTD tag can be used to specify an XML DTD, |
1064 |
# which can be used by a validating XML parser to check the |
1065 |
# syntax of the XML files. |
1066 |
|
1067 |
XML_DTD = |
1068 |
|
1069 |
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will |
1070 |
# dump the program listings (including syntax highlighting |
1071 |
# and cross-referencing information) to the XML output. Note that |
1072 |
# enabling this will significantly increase the size of the XML output. |
1073 |
|
1074 |
XML_PROGRAMLISTING = YES |
1075 |
|
1076 |
#--------------------------------------------------------------------------- |
1077 |
# configuration options for the AutoGen Definitions output |
1078 |
#--------------------------------------------------------------------------- |
1079 |
|
1080 |
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
1081 |
# generate an AutoGen Definitions (see autogen.sf.net) file |
1082 |
# that captures the structure of the code including all |
1083 |
# documentation. Note that this feature is still experimental |
1084 |
# and incomplete at the moment. |
1085 |
|
1086 |
GENERATE_AUTOGEN_DEF = NO |
1087 |
|
1088 |
#--------------------------------------------------------------------------- |
1089 |
# configuration options related to the Perl module output |
1090 |
#--------------------------------------------------------------------------- |
1091 |
|
1092 |
# If the GENERATE_PERLMOD tag is set to YES Doxygen will |
1093 |
# generate a Perl module file that captures the structure of |
1094 |
# the code including all documentation. Note that this |
1095 |
# feature is still experimental and incomplete at the |
1096 |
# moment. |
1097 |
|
1098 |
GENERATE_PERLMOD = NO |
1099 |
|
1100 |
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
1101 |
# the necessary Makefile rules, Perl scripts and LaTeX code to be able |
1102 |
# to generate PDF and DVI output from the Perl module output. |
1103 |
|
1104 |
PERLMOD_LATEX = NO |
1105 |
|
1106 |
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
1107 |
# nicely formatted so it can be parsed by a human reader. This is useful |
1108 |
# if you want to understand what is going on. On the other hand, if this |
1109 |
# tag is set to NO the size of the Perl module output will be much smaller |
1110 |
# and Perl will parse it just the same. |
1111 |
|
1112 |
PERLMOD_PRETTY = YES |
1113 |
|
1114 |
# The names of the make variables in the generated doxyrules.make file |
1115 |
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
1116 |
# This is useful so different doxyrules.make files included by the same |
1117 |
# Makefile don't overwrite each other's variables. |
1118 |
|
1119 |
PERLMOD_MAKEVAR_PREFIX = |
1120 |
|
1121 |
#--------------------------------------------------------------------------- |
1122 |
# Configuration options related to the preprocessor |
1123 |
#--------------------------------------------------------------------------- |
1124 |
|
1125 |
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
1126 |
# evaluate all C-preprocessor directives found in the sources and include |
1127 |
# files. |
1128 |
|
1129 |
ENABLE_PREPROCESSING = YES |
1130 |
|
1131 |
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
1132 |
# names in the source code. If set to NO (the default) only conditional |
1133 |
# compilation will be performed. Macro expansion can be done in a controlled |
1134 |
# way by setting EXPAND_ONLY_PREDEF to YES. |
1135 |
|
1136 |
MACRO_EXPANSION = NO |
1137 |
|
1138 |
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
1139 |
# then the macro expansion is limited to the macros specified with the |
1140 |
# PREDEFINED and EXPAND_AS_DEFINED tags. |
1141 |
|
1142 |
EXPAND_ONLY_PREDEF = NO |
1143 |
|
1144 |
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
1145 |
# in the INCLUDE_PATH (see below) will be search if a #include is found. |
1146 |
|
1147 |
SEARCH_INCLUDES = YES |
1148 |
|
1149 |
# The INCLUDE_PATH tag can be used to specify one or more directories that |
1150 |
# contain include files that are not input files but should be processed by |
1151 |
# the preprocessor. |
1152 |
|
1153 |
INCLUDE_PATH = |
1154 |
|
1155 |
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
1156 |
# patterns (like *.h and *.hpp) to filter out the header-files in the |
1157 |
# directories. If left blank, the patterns specified with FILE_PATTERNS will |
1158 |
# be used. |
1159 |
|
1160 |
INCLUDE_FILE_PATTERNS = |
1161 |
|
1162 |
# The PREDEFINED tag can be used to specify one or more macro names that |
1163 |
# are defined before the preprocessor is started (similar to the -D option of |
1164 |
# gcc). The argument of the tag is a list of macros of the form: name |
1165 |
# or name=definition (no spaces). If the definition and the = are |
1166 |
# omitted =1 is assumed. To prevent a macro definition from being |
1167 |
# undefined via #undef or recursively expanded use the := operator |
1168 |
# instead of the = operator. |
1169 |
|
1170 |
PREDEFINED = |
1171 |
|
1172 |
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
1173 |
# this tag can be used to specify a list of macro names that should be expanded. |
1174 |
# The macro definition that is found in the sources will be used. |
1175 |
# Use the PREDEFINED tag if you want to use a different macro definition. |
1176 |
|
1177 |
EXPAND_AS_DEFINED = |
1178 |
|
1179 |
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
1180 |
# doxygen's preprocessor will remove all function-like macros that are alone |
1181 |
# on a line, have an all uppercase name, and do not end with a semicolon. Such |
1182 |
# function macros are typically used for boiler-plate code, and will confuse |
1183 |
# the parser if not removed. |
1184 |
|
1185 |
SKIP_FUNCTION_MACROS = YES |
1186 |
|
1187 |
#--------------------------------------------------------------------------- |
1188 |
# Configuration::additions related to external references |
1189 |
#--------------------------------------------------------------------------- |
1190 |
|
1191 |
# The TAGFILES option can be used to specify one or more tagfiles. |
1192 |
# Optionally an initial location of the external documentation |
1193 |
# can be added for each tagfile. The format of a tag file without |
1194 |
# this location is as follows: |
1195 |
# TAGFILES = file1 file2 ... |
1196 |
# Adding location for the tag files is done as follows: |
1197 |
# TAGFILES = file1=loc1 "file2 = loc2" ... |
1198 |
# where "loc1" and "loc2" can be relative or absolute paths or |
1199 |
# URLs. If a location is present for each tag, the installdox tool |
1200 |
# does not have to be run to correct the links. |
1201 |
# Note that each tag file must have a unique name |
1202 |
# (where the name does NOT include the path) |
1203 |
# If a tag file is not located in the directory in which doxygen |
1204 |
# is run, you must also specify the path to the tagfile here. |
1205 |
|
1206 |
TAGFILES = |
1207 |
|
1208 |
# When a file name is specified after GENERATE_TAGFILE, doxygen will create |
1209 |
# a tag file that is based on the input files it reads. |
1210 |
|
1211 |
GENERATE_TAGFILE = |
1212 |
|
1213 |
# If the ALLEXTERNALS tag is set to YES all external classes will be listed |
1214 |
# in the class index. If set to NO only the inherited external classes |
1215 |
# will be listed. |
1216 |
|
1217 |
ALLEXTERNALS = NO |
1218 |
|
1219 |
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed |
1220 |
# in the modules index. If set to NO, only the current project's groups will |
1221 |
# be listed. |
1222 |
|
1223 |
EXTERNAL_GROUPS = YES |
1224 |
|
1225 |
# The PERL_PATH should be the absolute path and name of the perl script |
1226 |
# interpreter (i.e. the result of `which perl'). |
1227 |
|
1228 |
PERL_PATH = |
1229 |
|
1230 |
#--------------------------------------------------------------------------- |
1231 |
# Configuration options related to the dot tool |
1232 |
#--------------------------------------------------------------------------- |
1233 |
|
1234 |
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
1235 |
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base |
1236 |
# or super classes. Setting the tag to NO turns the diagrams off. Note that |
1237 |
# this option is superseded by the HAVE_DOT option below. This is only a |
1238 |
# fallback. It is recommended to install and use dot, since it yields more |
1239 |
# powerful graphs. |
1240 |
|
1241 |
CLASS_DIAGRAMS = YES |
1242 |
|
1243 |
# You can define message sequence charts within doxygen comments using the \msc |
1244 |
# command. Doxygen will then run the mscgen tool (see |
1245 |
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the |
1246 |
# documentation. The MSCGEN_PATH tag allows you to specify the directory where |
1247 |
# the mscgen tool resides. If left empty the tool is assumed to be found in the |
1248 |
# default search path. |
1249 |
|
1250 |
MSCGEN_PATH = |
1251 |
|
1252 |
# If set to YES, the inheritance and collaboration graphs will hide |
1253 |
# inheritance and usage relations if the target is undocumented |
1254 |
# or is not a class. |
1255 |
|
1256 |
HIDE_UNDOC_RELATIONS = YES |
1257 |
|
1258 |
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
1259 |
# available from the path. This tool is part of Graphviz, a graph visualization |
1260 |
# toolkit from AT&T and Lucent Bell Labs. The other options in this section |
1261 |
# have no effect if this option is set to NO (the default) |
1262 |
|
1263 |
HAVE_DOT = NO |
1264 |
|
1265 |
# By default doxygen will write a font called FreeSans.ttf to the output |
1266 |
# directory and reference it in all dot files that doxygen generates. This |
1267 |
# font does not include all possible unicode characters however, so when you need |
1268 |
# these (or just want a differently looking font) you can specify the font name |
1269 |
# using DOT_FONTNAME. You need need to make sure dot is able to find the font, |
1270 |
# which can be done by putting it in a standard location or by setting the |
1271 |
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory |
1272 |
# containing the font. |
1273 |
|
1274 |
DOT_FONTNAME = FreeSans |
1275 |
|
1276 |
# By default doxygen will tell dot to use the output directory to look for the |
1277 |
# FreeSans.ttf font (which doxygen will put there itself). If you specify a |
1278 |
# different font using DOT_FONTNAME you can set the path where dot |
1279 |
# can find it using this tag. |
1280 |
|
1281 |
DOT_FONTPATH = |
1282 |
|
1283 |
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
1284 |
# will generate a graph for each documented class showing the direct and |
1285 |
# indirect inheritance relations. Setting this tag to YES will force the |
1286 |
# the CLASS_DIAGRAMS tag to NO. |
1287 |
|
1288 |
CLASS_GRAPH = YES |
1289 |
|
1290 |
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
1291 |
# will generate a graph for each documented class showing the direct and |
1292 |
# indirect implementation dependencies (inheritance, containment, and |
1293 |
# class references variables) of the class with other documented classes. |
1294 |
|
1295 |
COLLABORATION_GRAPH = YES |
1296 |
|
1297 |
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen |
1298 |
# will generate a graph for groups, showing the direct groups dependencies |
1299 |
|
1300 |
GROUP_GRAPHS = YES |
1301 |
|
1302 |
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
1303 |
# collaboration diagrams in a style similar to the OMG's Unified Modeling |
1304 |
# Language. |
1305 |
|
1306 |
UML_LOOK = NO |
1307 |
|
1308 |
# If set to YES, the inheritance and collaboration graphs will show the |
1309 |
# relations between templates and their instances. |
1310 |
|
1311 |
TEMPLATE_RELATIONS = NO |
1312 |
|
1313 |
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
1314 |
# tags are set to YES then doxygen will generate a graph for each documented |
1315 |
# file showing the direct and indirect include dependencies of the file with |
1316 |
# other documented files. |
1317 |
|
1318 |
INCLUDE_GRAPH = YES |
1319 |
|
1320 |
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
1321 |
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
1322 |
# documented header file showing the documented files that directly or |
1323 |
# indirectly include this file. |
1324 |
|
1325 |
INCLUDED_BY_GRAPH = YES |
1326 |
|
1327 |
# If the CALL_GRAPH and HAVE_DOT options are set to YES then |
1328 |
# doxygen will generate a call dependency graph for every global function |
1329 |
# or class method. Note that enabling this option will significantly increase |
1330 |
# the time of a run. So in most cases it will be better to enable call graphs |
1331 |
# for selected functions only using the \callgraph command. |
1332 |
|
1333 |
CALL_GRAPH = NO |
1334 |
|
1335 |
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then |
1336 |
# doxygen will generate a caller dependency graph for every global function |
1337 |
# or class method. Note that enabling this option will significantly increase |
1338 |
# the time of a run. So in most cases it will be better to enable caller |
1339 |
# graphs for selected functions only using the \callergraph command. |
1340 |
|
1341 |
CALLER_GRAPH = NO |
1342 |
|
1343 |
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
1344 |
# will graphical hierarchy of all classes instead of a textual one. |
1345 |
|
1346 |
GRAPHICAL_HIERARCHY = YES |
1347 |
|
1348 |
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES |
1349 |
# then doxygen will show the dependencies a directory has on other directories |
1350 |
# in a graphical way. The dependency relations are determined by the #include |
1351 |
# relations between the files in the directories. |
1352 |
|
1353 |
DIRECTORY_GRAPH = YES |
1354 |
|
1355 |
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
1356 |
# generated by dot. Possible values are png, jpg, or gif |
1357 |
# If left blank png will be used. |
1358 |
|
1359 |
DOT_IMAGE_FORMAT = png |
1360 |
|
1361 |
# The tag DOT_PATH can be used to specify the path where the dot tool can be |
1362 |
# found. If left blank, it is assumed the dot tool can be found in the path. |
1363 |
|
1364 |
DOT_PATH = |
1365 |
|
1366 |
# The DOTFILE_DIRS tag can be used to specify one or more directories that |
1367 |
# contain dot files that are included in the documentation (see the |
1368 |
# \dotfile command). |
1369 |
|
1370 |
DOTFILE_DIRS = |
1371 |
|
1372 |
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of |
1373 |
# nodes that will be shown in the graph. If the number of nodes in a graph |
1374 |
# becomes larger than this value, doxygen will truncate the graph, which is |
1375 |
# visualized by representing a node as a red box. Note that doxygen if the |
1376 |
# number of direct children of the root node in a graph is already larger than |
1377 |
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note |
1378 |
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. |
1379 |
|
1380 |
DOT_GRAPH_MAX_NODES = 50 |
1381 |
|
1382 |
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
1383 |
# graphs generated by dot. A depth value of 3 means that only nodes reachable |
1384 |
# from the root by following a path via at most 3 edges will be shown. Nodes |
1385 |
# that lay further from the root node will be omitted. Note that setting this |
1386 |
# option to 1 or 2 may greatly reduce the computation time needed for large |
1387 |
# code bases. Also note that the size of a graph can be further restricted by |
1388 |
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. |
1389 |
|
1390 |
MAX_DOT_GRAPH_DEPTH = 0 |
1391 |
|
1392 |
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent |
1393 |
# background. This is enabled by default, which results in a transparent |
1394 |
# background. Warning: Depending on the platform used, enabling this option |
1395 |
# may lead to badly anti-aliased labels on the edges of a graph (i.e. they |
1396 |
# become hard to read). |
1397 |
|
1398 |
DOT_TRANSPARENT = YES |
1399 |
|
1400 |
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
1401 |
# files in one run (i.e. multiple -o and -T options on the command line). This |
1402 |
# makes dot run faster, but since only newer versions of dot (>1.8.10) |
1403 |
# support this, this feature is disabled by default. |
1404 |
|
1405 |
DOT_MULTI_TARGETS = NO |
1406 |
|
1407 |
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
1408 |
# generate a legend page explaining the meaning of the various boxes and |
1409 |
# arrows in the dot generated graphs. |
1410 |
|
1411 |
GENERATE_LEGEND = YES |
1412 |
|
1413 |
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
1414 |
# remove the intermediate dot files that are used to generate |
1415 |
# the various graphs. |
1416 |
|
1417 |
DOT_CLEANUP = YES |
1418 |
|
1419 |
#--------------------------------------------------------------------------- |
1420 |
# Configuration::additions related to the search engine |
1421 |
#--------------------------------------------------------------------------- |
1422 |
|
1423 |
# The SEARCHENGINE tag specifies whether or not a search engine should be |
1424 |
# used. If set to NO the values of all tags below this one will be ignored. |
1425 |
|
1426 |
SEARCHENGINE = NO |