1 |
jgs |
82 |
# Doxyfile 1.2.8.1 |
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 |
|
|
# General configuration options |
15 |
|
|
#--------------------------------------------------------------------------- |
16 |
|
|
|
17 |
|
|
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
18 |
|
|
# by quotes) that should identify the project. |
19 |
|
|
|
20 |
|
|
PROJECT_NAME = ESYS |
21 |
|
|
|
22 |
|
|
# The PROJECT_NUMBER tag can be used to enter a project or revision number. |
23 |
|
|
# This could be handy for archiving the generated documentation or |
24 |
|
|
# if some version control system is used. |
25 |
|
|
|
26 |
|
|
PROJECT_NUMBER = |
27 |
|
|
|
28 |
|
|
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
29 |
|
|
# base path where the generated documentation will be put. |
30 |
|
|
# If a relative path is entered, it will be relative to the location |
31 |
|
|
# where doxygen was started. If left blank the current directory will be used. |
32 |
|
|
|
33 |
|
|
OUTPUT_DIRECTORY = |
34 |
|
|
|
35 |
|
|
# The OUTPUT_LANGUAGE tag is used to specify the language in which all |
36 |
|
|
# documentation generated by doxygen is written. Doxygen will use this |
37 |
|
|
# information to generate all constant output in the proper language. |
38 |
|
|
# The default language is English, other supported languages are: |
39 |
|
|
# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, |
40 |
|
|
# German, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, |
41 |
|
|
# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish. |
42 |
|
|
|
43 |
|
|
OUTPUT_LANGUAGE = English |
44 |
|
|
|
45 |
|
|
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
46 |
|
|
# documentation are documented, even if no documentation was available. |
47 |
|
|
# Private class members and static file members will be hidden unless |
48 |
|
|
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
49 |
|
|
|
50 |
|
|
EXTRACT_ALL = YES |
51 |
|
|
|
52 |
|
|
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
53 |
|
|
# will be included in the documentation. |
54 |
|
|
|
55 |
|
|
EXTRACT_PRIVATE = YES |
56 |
|
|
|
57 |
|
|
# If the EXTRACT_STATIC tag is set to YES all static members of a file |
58 |
|
|
# will be included in the documentation. |
59 |
|
|
|
60 |
|
|
EXTRACT_STATIC = YES |
61 |
|
|
|
62 |
|
|
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
63 |
|
|
# undocumented members of documented classes, files or namespaces. |
64 |
|
|
# If set to NO (the default) these members will be included in the |
65 |
|
|
# various overviews, but no documentation section is generated. |
66 |
|
|
# This option has no effect if EXTRACT_ALL is enabled. |
67 |
|
|
|
68 |
|
|
HIDE_UNDOC_MEMBERS = NO |
69 |
|
|
|
70 |
|
|
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
71 |
|
|
# undocumented classes that are normally visible in the class hierarchy. |
72 |
|
|
# If set to NO (the default) these class will be included in the various |
73 |
|
|
# overviews. This option has no effect if EXTRACT_ALL is enabled. |
74 |
|
|
|
75 |
|
|
HIDE_UNDOC_CLASSES = NO |
76 |
|
|
|
77 |
|
|
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
78 |
|
|
# include brief member descriptions after the members that are listed in |
79 |
|
|
# the file and class documentation (similar to JavaDoc). |
80 |
|
|
# Set to NO to disable this. |
81 |
|
|
|
82 |
|
|
BRIEF_MEMBER_DESC = YES |
83 |
|
|
|
84 |
|
|
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
85 |
|
|
# the brief description of a member or function before the detailed description. |
86 |
|
|
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
87 |
|
|
# brief descriptions will be completely suppressed. |
88 |
|
|
|
89 |
|
|
REPEAT_BRIEF = YES |
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 = NO |
96 |
|
|
|
97 |
|
|
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
98 |
|
|
# path before files name in the file list and in the header files. If set |
99 |
|
|
# to NO the shortest path that makes the file name unique will be used. |
100 |
|
|
|
101 |
|
|
FULL_PATH_NAMES = NO |
102 |
|
|
|
103 |
|
|
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
104 |
|
|
# can be used to strip a user defined part of the path. Stripping is |
105 |
|
|
# only done if one of the specified strings matches the left-hand part of |
106 |
|
|
# the path. It is allowed to use relative paths in the argument list. |
107 |
|
|
|
108 |
|
|
STRIP_FROM_PATH = |
109 |
|
|
|
110 |
|
|
# The INTERNAL_DOCS tag determines if documentation |
111 |
|
|
# that is typed after a \internal command is included. If the tag is set |
112 |
|
|
# to NO (the default) then the documentation will be excluded. |
113 |
|
|
# Set it to YES to include the internal documentation. |
114 |
|
|
|
115 |
|
|
INTERNAL_DOCS = NO |
116 |
|
|
|
117 |
|
|
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
118 |
|
|
# generate a class diagram (in Html and LaTeX) for classes with base or |
119 |
|
|
# super classes. Setting the tag to NO turns the diagrams off. |
120 |
|
|
|
121 |
|
|
CLASS_DIAGRAMS = YES |
122 |
|
|
|
123 |
|
|
# If the SOURCE_BROWSER tag is set to YES then a list of source files will |
124 |
|
|
# be generated. Documented entities will be cross-referenced with these sources. |
125 |
|
|
|
126 |
|
|
SOURCE_BROWSER = NO |
127 |
|
|
|
128 |
|
|
# Setting the INLINE_SOURCES tag to YES will include the body |
129 |
|
|
# of functions and classes directly in the documentation. |
130 |
|
|
|
131 |
|
|
INLINE_SOURCES = NO |
132 |
|
|
|
133 |
|
|
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
134 |
|
|
# doxygen to hide any special comment blocks from generated source code |
135 |
|
|
# fragments. Normal C and C++ comments will always remain visible. |
136 |
|
|
|
137 |
|
|
STRIP_CODE_COMMENTS = YES |
138 |
|
|
|
139 |
|
|
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
140 |
|
|
# file names in lower case letters. If set to YES upper case letters are also |
141 |
|
|
# allowed. This is useful if you have classes or files whose names only differ |
142 |
|
|
# in case and if your file system supports case sensitive file names. Windows |
143 |
|
|
# users are adviced to set this option to NO. |
144 |
|
|
|
145 |
|
|
CASE_SENSE_NAMES = YES |
146 |
|
|
|
147 |
|
|
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
148 |
|
|
# (but less readable) file names. This can be useful is your file systems |
149 |
|
|
# doesn't support long names like on DOS, Mac, or CD-ROM. |
150 |
|
|
|
151 |
|
|
SHORT_NAMES = NO |
152 |
|
|
|
153 |
|
|
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
154 |
|
|
# will show members with their full class and namespace scopes in the |
155 |
|
|
# documentation. If set to YES the scope will be hidden. |
156 |
|
|
|
157 |
|
|
HIDE_SCOPE_NAMES = NO |
158 |
|
|
|
159 |
|
|
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
160 |
|
|
# will generate a verbatim copy of the header file for each class for |
161 |
|
|
# which an include is specified. Set to NO to disable this. |
162 |
|
|
|
163 |
|
|
VERBATIM_HEADERS = YES |
164 |
|
|
|
165 |
|
|
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
166 |
|
|
# will put list of the files that are included by a file in the documentation |
167 |
|
|
# of that file. |
168 |
|
|
|
169 |
|
|
SHOW_INCLUDE_FILES = YES |
170 |
|
|
|
171 |
|
|
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
172 |
|
|
# will interpret the first line (until the first dot) of a JavaDoc-style |
173 |
|
|
# comment as the brief description. If set to NO, the JavaDoc |
174 |
|
|
# comments will behave just like the Qt-style comments (thus requiring an |
175 |
|
|
# explict @brief command for a brief description. |
176 |
|
|
|
177 |
|
|
JAVADOC_AUTOBRIEF = NO |
178 |
|
|
|
179 |
|
|
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
180 |
|
|
# member inherits the documentation from any documented member that it |
181 |
|
|
# reimplements. |
182 |
|
|
|
183 |
|
|
INHERIT_DOCS = YES |
184 |
|
|
|
185 |
|
|
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
186 |
|
|
# is inserted in the documentation for inline members. |
187 |
|
|
|
188 |
|
|
INLINE_INFO = YES |
189 |
|
|
|
190 |
|
|
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
191 |
|
|
# will sort the (detailed) documentation of file and class members |
192 |
|
|
# alphabetically by member name. If set to NO the members will appear in |
193 |
|
|
# declaration order. |
194 |
|
|
|
195 |
|
|
SORT_MEMBER_DOCS = YES |
196 |
|
|
|
197 |
|
|
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
198 |
|
|
# tag is set to YES, then doxygen will reuse the documentation of the first |
199 |
|
|
# member in the group (if any) for the other members of the group. By default |
200 |
|
|
# all members of a group must be documented explicitly. |
201 |
|
|
|
202 |
|
|
DISTRIBUTE_GROUP_DOC = NO |
203 |
|
|
|
204 |
|
|
# The TAB_SIZE tag can be used to set the number of spaces in a tab. |
205 |
|
|
# Doxygen uses this value to replace tabs by spaces in code fragments. |
206 |
|
|
|
207 |
|
|
TAB_SIZE = 8 |
208 |
|
|
|
209 |
|
|
# The ENABLED_SECTIONS tag can be used to enable conditional |
210 |
|
|
# documentation sections, marked by \if sectionname ... \endif. |
211 |
|
|
|
212 |
|
|
ENABLED_SECTIONS = |
213 |
|
|
|
214 |
|
|
# The GENERATE_TODOLIST tag can be used to enable (YES) or |
215 |
|
|
# disable (NO) the todo list. This list is created by putting \todo |
216 |
|
|
# commands in the documentation. |
217 |
|
|
|
218 |
|
|
GENERATE_TODOLIST = YES |
219 |
|
|
|
220 |
|
|
# The GENERATE_TESTLIST tag can be used to enable (YES) or |
221 |
|
|
# disable (NO) the test list. This list is created by putting \test |
222 |
|
|
# commands in the documentation. |
223 |
|
|
|
224 |
|
|
GENERATE_TESTLIST = YES |
225 |
|
|
|
226 |
|
|
# The GENERATE_BUGLIST tag can be used to enable (YES) or |
227 |
|
|
# disable (NO) the bug list. This list is created by putting \bug |
228 |
|
|
# commands in the documentation. |
229 |
|
|
|
230 |
|
|
GENERATE_BUGLIST = YES |
231 |
|
|
|
232 |
|
|
# This tag can be used to specify a number of aliases that acts |
233 |
|
|
# as commands in the documentation. An alias has the form "name=value". |
234 |
|
|
# For example adding "sideeffect=\par Side Effects:\n" will allow you to |
235 |
|
|
# put the command \sideeffect (or @sideeffect) in the documentation, which |
236 |
|
|
# will result in a user defined paragraph with heading "Side Effects:". |
237 |
|
|
# You can put \n's in the value part of an alias to insert newlines. |
238 |
|
|
|
239 |
|
|
ALIASES = |
240 |
|
|
|
241 |
|
|
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
242 |
|
|
# the initial value of a variable or define consist of for it to appear in |
243 |
|
|
# the documentation. If the initializer consists of more lines than specified |
244 |
|
|
# here it will be hidden. Use a value of 0 to hide initializers completely. |
245 |
|
|
# The appearance of the initializer of individual variables and defines in the |
246 |
|
|
# documentation can be controlled using \showinitializer or \hideinitializer |
247 |
|
|
# command in the documentation regardless of this setting. |
248 |
|
|
|
249 |
|
|
MAX_INITIALIZER_LINES = 30 |
250 |
|
|
|
251 |
|
|
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
252 |
|
|
# only. Doxygen will then generate output that is more tailored for C. |
253 |
|
|
# For instance some of the names that are used will be different. The list |
254 |
|
|
# of all members will be omitted, etc. |
255 |
|
|
|
256 |
|
|
OPTIMIZE_OUTPUT_FOR_C = NO |
257 |
|
|
|
258 |
|
|
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
259 |
|
|
# at the bottom of the documentation of classes and structs. If set to YES the |
260 |
|
|
# list will mention the files that were used to generate the documentation. |
261 |
|
|
|
262 |
|
|
SHOW_USED_FILES = YES |
263 |
|
|
|
264 |
|
|
#--------------------------------------------------------------------------- |
265 |
|
|
# configuration options related to warning and progress messages |
266 |
|
|
#--------------------------------------------------------------------------- |
267 |
|
|
|
268 |
|
|
# The QUIET tag can be used to turn on/off the messages that are generated |
269 |
|
|
# by doxygen. Possible values are YES and NO. If left blank NO is used. |
270 |
|
|
|
271 |
|
|
QUIET = NO |
272 |
|
|
|
273 |
|
|
# The WARNINGS tag can be used to turn on/off the warning messages that are |
274 |
|
|
# generated by doxygen. Possible values are YES and NO. If left blank |
275 |
|
|
# NO is used. |
276 |
|
|
|
277 |
|
|
WARNINGS = YES |
278 |
|
|
|
279 |
|
|
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
280 |
|
|
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
281 |
|
|
# automatically be disabled. |
282 |
|
|
|
283 |
|
|
WARN_IF_UNDOCUMENTED = YES |
284 |
|
|
|
285 |
|
|
# The WARN_FORMAT tag determines the format of the warning messages that |
286 |
|
|
# doxygen can produce. The string should contain the $file, $line, and $text |
287 |
|
|
# tags, which will be replaced by the file and line number from which the |
288 |
|
|
# warning originated and the warning text. |
289 |
|
|
|
290 |
|
|
WARN_FORMAT = |
291 |
|
|
|
292 |
|
|
# The WARN_LOGFILE tag can be used to specify a file to which warning |
293 |
|
|
# and error messages should be written. If left blank the output is written |
294 |
|
|
# to stderr. |
295 |
|
|
|
296 |
|
|
WARN_LOGFILE = |
297 |
|
|
|
298 |
|
|
#--------------------------------------------------------------------------- |
299 |
|
|
# configuration options related to the input files |
300 |
|
|
#--------------------------------------------------------------------------- |
301 |
|
|
|
302 |
|
|
# The INPUT tag can be used to specify the files and/or directories that contain |
303 |
|
|
# documented source files. You may enter file names like "myfile.cpp" or |
304 |
|
|
# directories like "/usr/src/myproject". Separate the files or directories |
305 |
|
|
# with spaces. |
306 |
|
|
|
307 |
|
|
INPUT = /home/johng/esys/escript/src /home/johng/esys/finley/src /home/johng/esys/esysUtils/src |
308 |
|
|
|
309 |
|
|
# If the value of the INPUT tag contains directories, you can use the |
310 |
|
|
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
311 |
|
|
# and *.h) to filter out the source-files in the directories. If left |
312 |
|
|
# blank all files are included. |
313 |
|
|
|
314 |
|
|
FILE_PATTERNS = *.cpp *.h |
315 |
|
|
|
316 |
|
|
# The RECURSIVE tag can be used to turn specify whether or not subdirectories |
317 |
|
|
# should be searched for input files as well. Possible values are YES and NO. |
318 |
|
|
# If left blank NO is used. |
319 |
|
|
|
320 |
|
|
RECURSIVE = YES |
321 |
|
|
|
322 |
|
|
# The EXCLUDE tag can be used to specify files and/or directories that should |
323 |
|
|
# excluded from the INPUT source files. This way you can easily exclude a |
324 |
|
|
# subdirectory from a directory tree whose root is specified with the INPUT tag. |
325 |
|
|
|
326 |
|
|
EXCLUDE = test |
327 |
|
|
|
328 |
|
|
# If the value of the INPUT tag contains directories, you can use the |
329 |
|
|
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
330 |
|
|
# certain files from those directories. |
331 |
|
|
|
332 |
|
|
EXCLUDE_PATTERNS = |
333 |
|
|
|
334 |
|
|
# The EXAMPLE_PATH tag can be used to specify one or more files or |
335 |
|
|
# directories that contain example code fragments that are included (see |
336 |
|
|
# the \include command). |
337 |
|
|
|
338 |
|
|
EXAMPLE_PATH = |
339 |
|
|
|
340 |
|
|
# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
341 |
|
|
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
342 |
|
|
# and *.h) to filter out the source-files in the directories. If left |
343 |
|
|
# blank all files are included. |
344 |
|
|
|
345 |
|
|
EXAMPLE_PATTERNS = |
346 |
|
|
|
347 |
|
|
# The IMAGE_PATH tag can be used to specify one or more files or |
348 |
|
|
# directories that contain image that are included in the documentation (see |
349 |
|
|
# the \image command). |
350 |
|
|
|
351 |
|
|
IMAGE_PATH = |
352 |
|
|
|
353 |
|
|
# The INPUT_FILTER tag can be used to specify a program that doxygen should |
354 |
|
|
# invoke to filter for each input file. Doxygen will invoke the filter program |
355 |
|
|
# by executing (via popen()) the command <filter> <input-file>, where <filter> |
356 |
|
|
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
357 |
|
|
# input file. Doxygen will then use the output that the filter program writes |
358 |
|
|
# to standard output. |
359 |
|
|
|
360 |
|
|
INPUT_FILTER = |
361 |
|
|
|
362 |
|
|
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
363 |
|
|
# INPUT_FILTER) will be used to filter the input files when producing source |
364 |
|
|
# files to browse. |
365 |
|
|
|
366 |
|
|
FILTER_SOURCE_FILES = NO |
367 |
|
|
|
368 |
|
|
#--------------------------------------------------------------------------- |
369 |
|
|
# configuration options related to the alphabetical class index |
370 |
|
|
#--------------------------------------------------------------------------- |
371 |
|
|
|
372 |
|
|
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
373 |
|
|
# of all compounds will be generated. Enable this if the project |
374 |
|
|
# contains a lot of classes, structs, unions or interfaces. |
375 |
|
|
|
376 |
|
|
ALPHABETICAL_INDEX = YES |
377 |
|
|
|
378 |
|
|
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
379 |
|
|
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
380 |
|
|
# in which this list will be split (can be a number in the range [1..20]) |
381 |
|
|
|
382 |
|
|
COLS_IN_ALPHA_INDEX = 5 |
383 |
|
|
|
384 |
|
|
# In case all classes in a project start with a common prefix, all |
385 |
|
|
# classes will be put under the same header in the alphabetical index. |
386 |
|
|
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
387 |
|
|
# should be ignored while generating the index headers. |
388 |
|
|
|
389 |
|
|
IGNORE_PREFIX = |
390 |
|
|
|
391 |
|
|
#--------------------------------------------------------------------------- |
392 |
|
|
# configuration options related to the HTML output |
393 |
|
|
#--------------------------------------------------------------------------- |
394 |
|
|
|
395 |
|
|
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
396 |
|
|
# generate HTML output. |
397 |
|
|
|
398 |
|
|
GENERATE_HTML = YES |
399 |
|
|
|
400 |
|
|
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
401 |
|
|
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
402 |
|
|
# put in front of it. If left blank `html' will be used as the default path. |
403 |
|
|
|
404 |
|
|
HTML_OUTPUT = |
405 |
|
|
|
406 |
|
|
# The HTML_HEADER tag can be used to specify a personal HTML header for |
407 |
|
|
# each generated HTML page. If it is left blank doxygen will generate a |
408 |
|
|
# standard header. |
409 |
|
|
|
410 |
|
|
HTML_HEADER = |
411 |
|
|
|
412 |
|
|
# The HTML_FOOTER tag can be used to specify a personal HTML footer for |
413 |
|
|
# each generated HTML page. If it is left blank doxygen will generate a |
414 |
|
|
# standard footer. |
415 |
|
|
|
416 |
|
|
HTML_FOOTER = |
417 |
|
|
|
418 |
|
|
# The HTML_STYLESHEET tag can be used to specify a user defined cascading |
419 |
|
|
# style sheet that is used by each HTML page. It can be used to |
420 |
|
|
# fine-tune the look of the HTML output. If the tag is left blank doxygen |
421 |
|
|
# will generate a default style sheet |
422 |
|
|
|
423 |
|
|
HTML_STYLESHEET = |
424 |
|
|
|
425 |
|
|
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
426 |
|
|
# files or namespaces will be aligned in HTML using tables. If set to |
427 |
|
|
# NO a bullet list will be used. |
428 |
|
|
|
429 |
|
|
HTML_ALIGN_MEMBERS = YES |
430 |
|
|
|
431 |
|
|
# If the GENERATE_HTMLHELP tag is set to YES, additional index files |
432 |
|
|
# will be generated that can be used as input for tools like the |
433 |
|
|
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) |
434 |
|
|
# of the generated HTML documentation. |
435 |
|
|
|
436 |
|
|
GENERATE_HTMLHELP = NO |
437 |
|
|
|
438 |
|
|
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
439 |
|
|
# controls if a separate .chi index file is generated (YES) or that |
440 |
|
|
# it should be included in the master .chm file (NO). |
441 |
|
|
|
442 |
|
|
GENERATE_CHI = NO |
443 |
|
|
|
444 |
|
|
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
445 |
|
|
# controls whether a binary table of contents is generated (YES) or a |
446 |
|
|
# normal table of contents (NO) in the .chm file. |
447 |
|
|
|
448 |
|
|
BINARY_TOC = NO |
449 |
|
|
|
450 |
|
|
# The TOC_EXPAND flag can be set to YES to add extra items for group members |
451 |
|
|
# to the contents of the Html help documentation and to the tree view. |
452 |
|
|
|
453 |
|
|
TOC_EXPAND = NO |
454 |
|
|
|
455 |
|
|
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
456 |
|
|
# top of each HTML page. The value NO (the default) enables the index and |
457 |
|
|
# the value YES disables it. |
458 |
|
|
|
459 |
|
|
DISABLE_INDEX = NO |
460 |
|
|
|
461 |
|
|
# This tag can be used to set the number of enum values (range [1..20]) |
462 |
|
|
# that doxygen will group on one line in the generated HTML documentation. |
463 |
|
|
|
464 |
|
|
ENUM_VALUES_PER_LINE = 4 |
465 |
|
|
|
466 |
|
|
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be |
467 |
|
|
# generated containing a tree-like index structure (just like the one that |
468 |
|
|
# is generated for HTML Help). For this to work a browser that supports |
469 |
|
|
# JavaScript and frames is required (for instance Netscape 4.0+ |
470 |
|
|
# or Internet explorer 4.0+). |
471 |
|
|
|
472 |
|
|
GENERATE_TREEVIEW = NO |
473 |
|
|
|
474 |
|
|
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
475 |
|
|
# used to set the initial width (in pixels) of the frame in which the tree |
476 |
|
|
# is shown. |
477 |
|
|
|
478 |
|
|
TREEVIEW_WIDTH = 250 |
479 |
|
|
|
480 |
|
|
#--------------------------------------------------------------------------- |
481 |
|
|
# configuration options related to the LaTeX output |
482 |
|
|
#--------------------------------------------------------------------------- |
483 |
|
|
|
484 |
|
|
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
485 |
|
|
# generate Latex output. |
486 |
|
|
|
487 |
|
|
GENERATE_LATEX = NO |
488 |
|
|
|
489 |
|
|
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
490 |
|
|
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
491 |
|
|
# put in front of it. If left blank `latex' will be used as the default path. |
492 |
|
|
|
493 |
|
|
LATEX_OUTPUT = |
494 |
|
|
|
495 |
|
|
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
496 |
|
|
# LaTeX documents. This may be useful for small projects and may help to |
497 |
|
|
# save some trees in general. |
498 |
|
|
|
499 |
|
|
COMPACT_LATEX = NO |
500 |
|
|
|
501 |
|
|
# The PAPER_TYPE tag can be used to set the paper type that is used |
502 |
|
|
# by the printer. Possible values are: a4, a4wide, letter, legal and |
503 |
|
|
# executive. If left blank a4wide will be used. |
504 |
|
|
|
505 |
|
|
PAPER_TYPE = a4wide |
506 |
|
|
|
507 |
|
|
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
508 |
|
|
# packages that should be included in the LaTeX output. |
509 |
|
|
|
510 |
|
|
EXTRA_PACKAGES = |
511 |
|
|
|
512 |
|
|
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
513 |
|
|
# the generated latex document. The header should contain everything until |
514 |
|
|
# the first chapter. If it is left blank doxygen will generate a |
515 |
|
|
# standard header. Notice: only use this tag if you know what you are doing! |
516 |
|
|
|
517 |
|
|
LATEX_HEADER = |
518 |
|
|
|
519 |
|
|
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
520 |
|
|
# is prepared for conversion to pdf (using ps2pdf). The pdf file will |
521 |
|
|
# contain links (just like the HTML output) instead of page references |
522 |
|
|
# This makes the output suitable for online browsing using a pdf viewer. |
523 |
|
|
|
524 |
|
|
PDF_HYPERLINKS = NO |
525 |
|
|
|
526 |
|
|
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
527 |
|
|
# plain latex in the generated Makefile. Set this option to YES to get a |
528 |
|
|
# higher quality PDF documentation. |
529 |
|
|
|
530 |
|
|
USE_PDFLATEX = NO |
531 |
|
|
|
532 |
|
|
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
533 |
|
|
# command to the generated LaTeX files. This will instruct LaTeX to keep |
534 |
|
|
# running if errors occur, instead of asking the user for help. |
535 |
|
|
# This option is also used when generating formulas in HTML. |
536 |
|
|
|
537 |
|
|
LATEX_BATCHMODE = NO |
538 |
|
|
|
539 |
|
|
#--------------------------------------------------------------------------- |
540 |
|
|
# configuration options related to the RTF output |
541 |
|
|
#--------------------------------------------------------------------------- |
542 |
|
|
|
543 |
|
|
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
544 |
|
|
# The RTF output is optimised for Word 97 and may not look very pretty with |
545 |
|
|
# other RTF readers or editors. |
546 |
|
|
|
547 |
|
|
GENERATE_RTF = NO |
548 |
|
|
|
549 |
|
|
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
550 |
|
|
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
551 |
|
|
# put in front of it. If left blank `rtf' will be used as the default path. |
552 |
|
|
|
553 |
|
|
RTF_OUTPUT = |
554 |
|
|
|
555 |
|
|
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
556 |
|
|
# RTF documents. This may be useful for small projects and may help to |
557 |
|
|
# save some trees in general. |
558 |
|
|
|
559 |
|
|
COMPACT_RTF = NO |
560 |
|
|
|
561 |
|
|
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
562 |
|
|
# will contain hyperlink fields. The RTF file will |
563 |
|
|
# contain links (just like the HTML output) instead of page references. |
564 |
|
|
# This makes the output suitable for online browsing using WORD or other |
565 |
|
|
# programs which support those fields. |
566 |
|
|
# Note: wordpad (write) and others do not support links. |
567 |
|
|
|
568 |
|
|
RTF_HYPERLINKS = NO |
569 |
|
|
|
570 |
|
|
# Load stylesheet definitions from file. Syntax is similar to doxygen's |
571 |
|
|
# config file, i.e. a series of assigments. You only have to provide |
572 |
|
|
# replacements, missing definitions are set to their default value. |
573 |
|
|
|
574 |
|
|
RTF_STYLESHEET_FILE = |
575 |
|
|
|
576 |
|
|
# Set optional variables used in the generation of an rtf document. |
577 |
|
|
# Syntax is similar to doxygen's config file. |
578 |
|
|
|
579 |
|
|
RTF_EXTENSIONS_FILE = |
580 |
|
|
|
581 |
|
|
#--------------------------------------------------------------------------- |
582 |
|
|
# configuration options related to the man page output |
583 |
|
|
#--------------------------------------------------------------------------- |
584 |
|
|
|
585 |
|
|
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
586 |
|
|
# generate man pages |
587 |
|
|
|
588 |
|
|
GENERATE_MAN = NO |
589 |
|
|
|
590 |
|
|
# The MAN_OUTPUT tag is used to specify where the man pages will be put. |
591 |
|
|
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
592 |
|
|
# put in front of it. If left blank `man' will be used as the default path. |
593 |
|
|
|
594 |
|
|
MAN_OUTPUT = |
595 |
|
|
|
596 |
|
|
# The MAN_EXTENSION tag determines the extension that is added to |
597 |
|
|
# the generated man pages (default is the subroutine's section .3) |
598 |
|
|
|
599 |
|
|
MAN_EXTENSION = |
600 |
|
|
|
601 |
|
|
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
602 |
|
|
# then it will generate one additional man file for each entity |
603 |
|
|
# documented in the real man page(s). These additional files |
604 |
|
|
# only source the real man page, but without them the man command |
605 |
|
|
# would be unable to find the correct page. The default is NO. |
606 |
|
|
|
607 |
|
|
MAN_LINKS = NO |
608 |
|
|
|
609 |
|
|
#--------------------------------------------------------------------------- |
610 |
|
|
# Configuration options related to the preprocessor |
611 |
|
|
#--------------------------------------------------------------------------- |
612 |
|
|
|
613 |
|
|
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
614 |
|
|
# evaluate all C-preprocessor directives found in the sources and include |
615 |
|
|
# files. |
616 |
|
|
|
617 |
|
|
ENABLE_PREPROCESSING = YES |
618 |
|
|
|
619 |
|
|
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
620 |
|
|
# names in the source code. If set to NO (the default) only conditional |
621 |
|
|
# compilation will be performed. Macro expansion can be done in a controlled |
622 |
|
|
# way by setting EXPAND_ONLY_PREDEF to YES. |
623 |
|
|
|
624 |
|
|
MACRO_EXPANSION = NO |
625 |
|
|
|
626 |
|
|
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
627 |
|
|
# then the macro expansion is limited to the macros specified with the |
628 |
|
|
# PREDEFINED and EXPAND_AS_PREDEFINED tags. |
629 |
|
|
|
630 |
|
|
EXPAND_ONLY_PREDEF = NO |
631 |
|
|
|
632 |
|
|
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
633 |
|
|
# in the INCLUDE_PATH (see below) will be search if a #include is found. |
634 |
|
|
|
635 |
|
|
SEARCH_INCLUDES = YES |
636 |
|
|
|
637 |
|
|
# The INCLUDE_PATH tag can be used to specify one or more directories that |
638 |
|
|
# contain include files that are not input files but should be processed by |
639 |
|
|
# the preprocessor. |
640 |
|
|
|
641 |
|
|
INCLUDE_PATH = |
642 |
|
|
|
643 |
|
|
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
644 |
|
|
# patterns (like *.h and *.hpp) to filter out the header-files in the |
645 |
|
|
# directories. If left blank, the patterns specified with FILE_PATTERNS will |
646 |
|
|
# be used. |
647 |
|
|
|
648 |
|
|
INCLUDE_FILE_PATTERNS = |
649 |
|
|
|
650 |
|
|
# The PREDEFINED tag can be used to specify one or more macro names that |
651 |
|
|
# are defined before the preprocessor is started (similar to the -D option of |
652 |
|
|
# gcc). The argument of the tag is a list of macros of the form: name |
653 |
|
|
# or name=definition (no spaces). If the definition and the = are |
654 |
|
|
# omitted =1 is assumed. |
655 |
|
|
|
656 |
|
|
PREDEFINED = |
657 |
|
|
|
658 |
|
|
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then |
659 |
|
|
# this tag can be used to specify a list of macro names that should be expanded. |
660 |
|
|
# The macro definition that is found in the sources will be used. |
661 |
|
|
# Use the PREDEFINED tag if you want to use a different macro definition. |
662 |
|
|
|
663 |
|
|
EXPAND_AS_DEFINED = |
664 |
|
|
|
665 |
|
|
#--------------------------------------------------------------------------- |
666 |
|
|
# Configuration::addtions related to external references |
667 |
|
|
#--------------------------------------------------------------------------- |
668 |
|
|
|
669 |
|
|
# The TAGFILES tag can be used to specify one or more tagfiles. |
670 |
|
|
|
671 |
|
|
TAGFILES = |
672 |
|
|
|
673 |
|
|
# When a file name is specified after GENERATE_TAGFILE, doxygen will create |
674 |
|
|
# a tag file that is based on the input files it reads. |
675 |
|
|
|
676 |
|
|
GENERATE_TAGFILE = |
677 |
|
|
|
678 |
|
|
# If the ALLEXTERNALS tag is set to YES all external classes will be listed |
679 |
|
|
# in the class index. If set to NO only the inherited external classes |
680 |
|
|
# will be listed. |
681 |
|
|
|
682 |
|
|
ALLEXTERNALS = NO |
683 |
|
|
|
684 |
|
|
# The PERL_PATH should be the absolute path and name of the perl script |
685 |
|
|
# interpreter (i.e. the result of `which perl'). |
686 |
|
|
|
687 |
|
|
PERL_PATH = |
688 |
|
|
|
689 |
|
|
#--------------------------------------------------------------------------- |
690 |
|
|
# Configuration options related to the dot tool |
691 |
|
|
#--------------------------------------------------------------------------- |
692 |
|
|
|
693 |
|
|
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
694 |
|
|
# available from the path. This tool is part of Graphviz, a graph visualization |
695 |
|
|
# toolkit from AT&T and Lucent Bell Labs. The other options in this section |
696 |
|
|
# have no effect if this option is set to NO (the default) |
697 |
|
|
|
698 |
|
|
HAVE_DOT = NO |
699 |
|
|
|
700 |
|
|
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
701 |
|
|
# will generate a graph for each documented class showing the direct and |
702 |
|
|
# indirect inheritance relations. Setting this tag to YES will force the |
703 |
|
|
# the CLASS_DIAGRAMS tag to NO. |
704 |
|
|
|
705 |
|
|
CLASS_GRAPH = YES |
706 |
|
|
|
707 |
|
|
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
708 |
|
|
# will generate a graph for each documented class showing the direct and |
709 |
|
|
# indirect implementation dependencies (inheritance, containment, and |
710 |
|
|
# class references variables) of the class with other documented classes. |
711 |
|
|
|
712 |
|
|
COLLABORATION_GRAPH = YES |
713 |
|
|
|
714 |
|
|
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
715 |
|
|
# tags are set to YES then doxygen will generate a graph for each documented |
716 |
|
|
# file showing the direct and indirect include dependencies of the file with |
717 |
|
|
# other documented files. |
718 |
|
|
|
719 |
|
|
INCLUDE_GRAPH = YES |
720 |
|
|
|
721 |
|
|
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
722 |
|
|
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
723 |
|
|
# documented header file showing the documented files that directly or |
724 |
|
|
# indirectly include this file. |
725 |
|
|
|
726 |
|
|
INCLUDED_BY_GRAPH = YES |
727 |
|
|
|
728 |
|
|
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
729 |
|
|
# will graphical hierarchy of all classes instead of a textual one. |
730 |
|
|
|
731 |
|
|
GRAPHICAL_HIERARCHY = YES |
732 |
|
|
|
733 |
|
|
# The tag DOT_PATH can be used to specify the path where the dot tool can be |
734 |
|
|
# found. If left blank, it is assumed the dot tool can be found on the path. |
735 |
|
|
|
736 |
|
|
DOT_PATH = |
737 |
|
|
|
738 |
|
|
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width |
739 |
|
|
# (in pixels) of the graphs generated by dot. If a graph becomes larger than |
740 |
|
|
# this value, doxygen will try to truncate the graph, so that it fits within |
741 |
|
|
# the specified constraint. Beware that most browsers cannot cope with very |
742 |
|
|
# large images. |
743 |
|
|
|
744 |
|
|
MAX_DOT_GRAPH_WIDTH = 1024 |
745 |
|
|
|
746 |
|
|
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height |
747 |
|
|
# (in pixels) of the graphs generated by dot. If a graph becomes larger than |
748 |
|
|
# this value, doxygen will try to truncate the graph, so that it fits within |
749 |
|
|
# the specified constraint. Beware that most browsers cannot cope with very |
750 |
|
|
# large images. |
751 |
|
|
|
752 |
|
|
MAX_DOT_GRAPH_HEIGHT = 1024 |
753 |
|
|
|
754 |
|
|
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
755 |
|
|
# generate a legend page explaining the meaning of the various boxes and |
756 |
|
|
# arrows in the dot generated graphs. |
757 |
|
|
|
758 |
|
|
GENERATE_LEGEND = YES |
759 |
|
|
|
760 |
|
|
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
761 |
|
|
# remove the intermedate dot files that are used to generate |
762 |
|
|
# the various graphs. |
763 |
|
|
|
764 |
|
|
DOT_CLEANUP = YES |
765 |
|
|
|
766 |
|
|
#--------------------------------------------------------------------------- |
767 |
|
|
# Configuration::addtions related to the search engine |
768 |
|
|
#--------------------------------------------------------------------------- |
769 |
|
|
|
770 |
|
|
# The SEARCHENGINE tag specifies whether or not a search engine should be |
771 |
|
|
# used. If set to NO the values of all tags below this one will be ignored. |
772 |
|
|
|
773 |
|
|
SEARCHENGINE = NO |
774 |
|
|
|
775 |
|
|
# The CGI_NAME tag should be the name of the CGI script that |
776 |
|
|
# starts the search engine (doxysearch) with the correct parameters. |
777 |
|
|
# A script with this name will be generated by doxygen. |
778 |
|
|
|
779 |
|
|
CGI_NAME = |
780 |
|
|
|
781 |
|
|
# The CGI_URL tag should be the absolute URL to the directory where the |
782 |
|
|
# cgi binaries are located. See the documentation of your http daemon for |
783 |
|
|
# details. |
784 |
|
|
|
785 |
|
|
CGI_URL = |
786 |
|
|
|
787 |
|
|
# The DOC_URL tag should be the absolute URL to the directory where the |
788 |
|
|
# documentation is located. If left blank the absolute path to the |
789 |
|
|
# documentation, with file:// prepended to it, will be used. |
790 |
|
|
|
791 |
|
|
DOC_URL = |
792 |
|
|
|
793 |
|
|
# The DOC_ABSPATH tag should be the absolute path to the directory where the |
794 |
|
|
# documentation is located. If left blank the directory on the local machine |
795 |
|
|
# will be used. |
796 |
|
|
|
797 |
|
|
DOC_ABSPATH = |
798 |
|
|
|
799 |
|
|
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary |
800 |
|
|
# is installed. |
801 |
|
|
|
802 |
|
|
BIN_ABSPATH = |
803 |
|
|
|
804 |
|
|
# The EXT_DOC_PATHS tag can be used to specify one or more paths to |
805 |
|
|
# documentation generated for other projects. This allows doxysearch to search |
806 |
|
|
# the documentation for these projects as well. |
807 |
|
|
|
808 |
|
|
EXT_DOC_PATHS = |