Subversion Repositories gelsvn

Rev

Rev 11 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
11 jab 1
	# Doxyfile 1.2.6
2 bj 2
 
3
# This file describes the settings to be used by doxygen for a project
4
#
5
# All text after a hash (#) is considered a comment and will be ignored
6
# The format is:
7
#       TAG = value [value, ...]
8
# For lists items can also be appended using:
9
#       TAG += value [value, ...]
10
# Values that contain spaces should be placed between quotes (" ")
11
 
91 jab 12
TAGFILES = 
13
 
2 bj 14
#---------------------------------------------------------------------------
15
# General configuration options
16
#---------------------------------------------------------------------------
17
 
18
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
19
# by quotes) that should identify the project. 
20
 
11 jab 21
PROJECT_NAME           = "GEL"
2 bj 22
 
23
# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
24
# This could be handy for archiving the generated documentation or 
25
# if some version control system is used.
26
 
27
PROJECT_NUMBER         = 
28
 
29
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
30
# base path where the generated documentation will be put. 
31
# If a relative path is entered, it will be relative to the location 
32
# where doxygen was started. If left blank the current directory will be used.
33
 
34
OUTPUT_DIRECTORY       =
35
 
36
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
37
# documentation generated by doxygen is written. Doxygen will use this 
38
# information to generate all constant output in the proper language. 
39
# The default language is English, other supported languages are: 
40
# Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese, 
41
# Korean, Hungarian, Norwegian, Spanish, Romanian, Russian, Croatian, 
42
# Polish, Portuguese and Slovene.
43
 
44
OUTPUT_LANGUAGE        = English
45
 
46
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
47
# documentation are documented, even if no documentation was available. 
48
# Private class members and static file members will be hidden unless 
49
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 
50
 
11 jab 51
EXTRACT_ALL            = NO
2 bj 52
 
53
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
54
# will be included in the documentation. 
55
 
11 jab 56
EXTRACT_PRIVATE        = NO
2 bj 57
 
58
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
59
# will be included in the documentation. 
60
 
61
EXTRACT_STATIC         = NO
62
 
63
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
64
# undocumented members of documented classes, files or namespaces. 
65
# If set to NO (the default) these members will be included in the 
66
# various overviews, but no documentation section is generated. 
67
# This option has no effect if EXTRACT_ALL is enabled. 
68
 
91 jab 69
HIDE_UNDOC_MEMBERS     = NO
2 bj 70
 
71
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
72
# undocumented classes that are normally visible in the class hierarchy. 
73
# If set to NO (the default) these class will be included in the various 
74
# overviews. This option has no effect if EXTRACT_ALL is enabled. 
75
 
91 jab 76
HIDE_UNDOC_CLASSES     = NO
2 bj 77
 
78
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
79
# include brief member descriptions after the members that are listed in 
80
# the file and class documentation (similar to JavaDoc). 
81
# Set to NO to disable this. 
82
 
11 jab 83
BRIEF_MEMBER_DESC      = YES
2 bj 84
 
85
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
86
# the brief description of a member or function before the detailed description. 
87
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
88
# brief descriptions will be completely suppressed. 
89
 
91 jab 90
REPEAT_BRIEF           = YES
2 bj 91
 
92
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
93
# Doxygen will generate a detailed section even if there is only a brief 
94
# description. 
95
 
91 jab 96
ALWAYS_DETAILED_SEC    = YES
2 bj 97
 
98
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
99
# path before files name in the file list and in the header files. If set 
100
# to NO the shortest path that makes the file name unique will be used. 
101
 
102
FULL_PATH_NAMES        = NO
103
 
104
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
105
# can be used to strip a user defined part of the path. Stripping is 
106
# only done if one of the specified strings matches the left-hand part of 
107
# the path. It is allowed to use relative paths in the argument list.
108
 
109
STRIP_FROM_PATH        = 
110
 
111
# The INTERNAL_DOCS tag determines if documentation 
112
# that is typed after a \internal command is included. If the tag is set 
113
# to NO (the default) then the documentation will be excluded. 
114
# Set it to YES to include the internal documentation. 
115
 
116
INTERNAL_DOCS          = NO
117
 
118
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
119
# generate a class diagram (in Html and LaTeX) for classes with base or 
120
# super classes. Setting the tag to NO turns the diagrams off. 
121
 
11 jab 122
CLASS_DIAGRAMS         = YES
2 bj 123
 
124
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
125
# be generated. Documented entities will be cross-referenced with these sources. 
126
 
127
SOURCE_BROWSER         = NO
128
 
129
# Setting the INLINE_SOURCES tag to YES will include the body 
130
# of functions and classes directly in the documentation. 
131
 
132
INLINE_SOURCES         = NO
133
 
134
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
135
# doxygen to hide any special comment blocks from generated source code 
136
# fragments. Normal C and C++ comments will always remain visible. 
137
 
138
STRIP_CODE_COMMENTS    = YES
139
 
140
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
141
# file names in lower case letters. If set to YES upper case letters are also 
142
# allowed. This is useful if you have classes or files whose names only differ 
143
# in case and if your file system supports case sensitive file names. Windows 
144
# users are adviced to set this option to NO.
145
 
146
CASE_SENSE_NAMES       = YES
147
 
148
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
149
# will show members with their full class and namespace scopes in the 
150
# documentation. If set to YES the scope will be hidden. 
151
 
152
HIDE_SCOPE_NAMES       = NO
153
 
154
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
155
# will generate a verbatim copy of the header file for each class for 
156
# which an include is specified. Set to NO to disable this. 
157
 
158
VERBATIM_HEADERS       = YES
159
 
160
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
161
# will put list of the files that are included by a file in the documentation 
162
# of that file. 
163
 
164
SHOW_INCLUDE_FILES     = NO
165
 
166
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
167
# will interpret the first line (until the first dot) of a JavaDoc-style 
168
# comment as the brief description. If set to NO, the JavaDoc 
169
# comments  will behave just like the Qt-style comments (thus requiring an 
170
# explict @brief command for a brief description. 
171
 
172
JAVADOC_AUTOBRIEF      = NO
173
 
174
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
175
# member inherits the documentation from any documented member that it 
176
# reimplements. 
177
 
178
INHERIT_DOCS           = YES
179
 
180
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
181
# is inserted in the documentation for inline members. 
182
 
183
INLINE_INFO            = YES
184
 
185
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
186
# will sort the (detailed) documentation of file and class members 
187
# alphabetically by member name. If set to NO the members will appear in 
188
# declaration order. 
189
 
190
SORT_MEMBER_DOCS       = YES
191
 
192
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
193
# tag is set to YES, then doxygen will reuse the documentation of the first 
194
# member in the group (if any) for the other members of the group. By default 
195
# all members of a group must be documented explicitly.
196
 
197
DISTRIBUTE_GROUP_DOC   = NO
198
 
199
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
200
# Doxygen uses this value to replace tabs by spaces in code fragments. 
201
 
202
TAB_SIZE               = 8
203
 
204
# The ENABLE_SECTIONS tag can be used to enable conditional 
205
# documentation sections, marked by \if sectionname ... \endif. 
206
 
207
ENABLED_SECTIONS       = 
208
 
209
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
210
# disable (NO) the todo list. This list is created by putting \todo 
211
# commands in the documentation.
212
 
213
GENERATE_TODOLIST      = YES
214
 
215
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
216
# disable (NO) the test list. This list is created by putting \test 
217
# commands in the documentation.
218
 
219
GENERATE_TESTLIST      = YES
220
 
221
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
222
# disable (NO) the bug list. This list is created by putting \bug 
223
# commands in the documentation.
224
 
225
GENERATE_BUGLIST       = YES
226
 
227
# This tag can be used to specify a number of aliases that acts 
228
# as commands in the documentation. An alias has the form "name=value". 
229
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
230
# put the command \sideeffect (or @sideeffect) in the documentation, which 
231
# will result in a user defined paragraph with heading "Side Effects:". 
232
# You can put \n's in the value part of an alias to insert newlines. 
233
 
234
ALIASES                = 
235
 
236
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
237
# the initial value of a variable or define consist of for it to appear in 
238
# the documentation. If the initializer consists of more lines than specified 
239
# here it will be hidden. Use a value of 0 to hide initializers completely. 
240
# The appearance of the initializer of individual variables and defines in the 
241
# documentation can be controlled using \showinitializer or \hideinitializer 
242
# command in the documentation regardless of this setting. 
243
 
244
MAX_INITIALIZER_LINES  = 30
245
 
246
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
247
# only. Doxygen will then generate output that is more tailored for C. 
248
# For instance some of the names that are used will be different. The list 
249
# of all members will be omitted, etc. 
250
 
251
OPTIMIZE_OUTPUT_FOR_C  = NO
252
 
253
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
254
# at the bottom of the documentation of classes and structs. If set to YES the 
255
# list will mention the files that were used to generate the documentation. 
256
 
257
SHOW_USED_FILES        = YES
258
 
259
#---------------------------------------------------------------------------
260
# configuration options related to warning and progress messages
261
#---------------------------------------------------------------------------
262
 
263
# The QUIET tag can be used to turn on/off the messages that are generated 
264
# by doxygen. Possible values are YES and NO. If left blank NO is used. 
265
 
266
QUIET                  = NO
267
 
268
# The WARNINGS tag can be used to turn on/off the warning messages that are 
269
# generated by doxygen. Possible values are YES and NO. If left blank 
270
# NO is used. 
271
 
272
WARNINGS               = YES
273
 
274
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
275
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
276
# automatically be disabled. 
277
 
278
WARN_IF_UNDOCUMENTED   = YES
279
 
280
# The WARN_FORMAT tag determines the format of the warning messages that 
281
# doxygen can produce. The string should contain the $file, $line, and $text 
282
# tags, which will be replaced by the file and line number from which the 
283
# warning originated and the warning text. 
284
 
285
WARN_FORMAT            = "$file:$line: $text"
286
 
287
# The WARN_LOGFILE tag can be used to specify a file to which warning 
288
# and error messages should be written. If left blank the output is written 
289
# to stderr. 
290
 
291
WARN_LOGFILE           = 
292
 
293
#---------------------------------------------------------------------------
294
# configuration options related to the input files
295
#---------------------------------------------------------------------------
296
 
297
# The INPUT tag can be used to specify the files and/or directories that contain 
298
# documented source files. You may enter file names like "myfile.cpp" or 
299
# directories like "/usr/src/myproject". Separate the files or directories 
300
# with spaces. 
301
 
11 jab 302
INPUT                  = ../src
2 bj 303
 
304
# If the value of the INPUT tag contains directories, you can use the 
305
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
306
# and *.h) to filter out the source-files in the directories. If left 
307
# blank all files are included. 
308
 
91 jab 309
FILE_PATTERNS          = *.h *.doxygen
2 bj 310
 
311
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
312
# should be searched for input files as well. Possible values are YES and NO. 
313
# If left blank NO is used. 
314
 
315
RECURSIVE              = YES
316
 
317
# The EXCLUDE tag can be used to specify files and/or directories that should 
318
# excluded from the INPUT source files. This way you can easily exclude a 
319
# subdirectory from a directory tree whose root is specified with the INPUT tag. 
320
# If the value of the INPUT tag contains directories, you can use the 
321
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
322
# certain files from those directories. 
323
 
324
EXCLUDE_PATTERNS       = 
325
 
326
# The EXAMPLE_PATH tag can be used to specify one or more files or 
327
# directories that contain example code fragments that are included (see 
328
# the \include command). 
329
 
330
EXAMPLE_PATH           = 
331
 
332
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
333
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
334
# and *.h) to filter out the source-files in the directories. If left 
335
# blank all files are included. 
336
 
337
EXAMPLE_PATTERNS       = 
338
 
339
# The IMAGE_PATH tag can be used to specify one or more files or 
340
# directories that contain image that are included in the documentation (see 
341
# the \image command). 
342
 
343
IMAGE_PATH             = 
344
 
345
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
346
# invoke to filter for each input file. Doxygen will invoke the filter program 
347
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
348
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
349
# input file. Doxygen will then use the output that the filter program writes 
350
# to standard output. 
351
 
352
INPUT_FILTER           = 
353
 
354
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
355
# INPUT_FILTER) will be used to filter the input files when producing source 
356
# files to browse. 
357
 
358
FILTER_SOURCE_FILES    = NO
359
 
360
#---------------------------------------------------------------------------
361
# configuration options related to the alphabetical class index
362
#---------------------------------------------------------------------------
363
 
364
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
365
# of all compounds will be generated. Enable this if the project 
366
# contains a lot of classes, structs, unions or interfaces. 
367
 
11 jab 368
ALPHABETICAL_INDEX     = YES
2 bj 369
 
370
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
371
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
372
# in which this list will be split (can be a number in the range [1..20]) 
373
 
374
COLS_IN_ALPHA_INDEX    = 5
375
 
376
# In case all classes in a project start with a common prefix, all 
377
# classes will be put under the same header in the alphabetical index. 
378
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
379
# should be ignored while generating the index headers. 
380
 
381
IGNORE_PREFIX          = 
382
 
383
 
384
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
385
# generate Latex output. 
386
 
91 jab 387
GENERATE_LATEX         = no
2 bj 388
 
389
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
390
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
391
# put in front of it. If left blank `latex' will be used as the default path. 
392
 
393
LATEX_OUTPUT           = latex
394
 
395
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
396
# LaTeX documents. This may be useful for small projects and may help to 
397
# save some trees in general. 
398
 
11 jab 399
COMPACT_LATEX          = yes
2 bj 400
 
401
# The PAPER_TYPE tag can be used to set the paper type that is used 
402
# by the printer. Possible values are: a4, a4wide, letter, legal and 
403
# executive. If left blank a4wide will be used. 
404
 
11 jab 405
PAPER_TYPE             = a4
2 bj 406
 
407
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
408
# packages that should be included in the LaTeX output. 
409
 
410
EXTRA_PACKAGES         = 
411
 
412
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
413
# the generated latex document. The header should contain everything until 
414
# the first chapter. If it is left blank doxygen will generate a 
415
# standard header. Notice: only use this tag if you know what you are doing! 
416
 
417
LATEX_HEADER           = 
91 jab 418
LATEX_FOOTER 						= 
2 bj 419
 
420
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
421
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
422
# contain links (just like the HTML output) instead of page references 
423
# This makes the output suitable for online browsing using a pdf viewer. 
424
 
11 jab 425
PDF_HYPERLINKS         = YES
2 bj 426
 
427
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
428
# plain latex in the generated Makefile. Set this option to YES to get a 
429
# higher quality PDF documentation. 
430
 
11 jab 431
USE_PDFLATEX           = YES
2 bj 432
 
433
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
434
# command to the generated LaTeX files. This will instruct LaTeX to keep 
435
# running if errors occur, instead of asking the user for help. 
436
# This option is also used when generating formulas in HTML. 
437
 
438
LATEX_BATCHMODE        = NO
439
 
440
#---------------------------------------------------------------------------
441
# configuration options related to the RTF output
442
#---------------------------------------------------------------------------
443
 
91 jab 444
GENERATE_HTML          = YES
2 bj 445
GENERATE_RTF           = NO
446
GENERATE_MAN           = NO
447
HAVE_DOT               = NO
448
SEARCHENGINE           = NO