Subversion Repositories gelsvn

Rev

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