~esys-p-dev/esys-particle/trunk

827 by steffen
The next step towards checkpoint restart
1
# Doxyfile 1.5.6
2 by steffen
Initial revision
2
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
3
# This file describes the settings to be used by the documentation system
4
# doxygen (www.doxygen.org) for a project
2 by steffen
Initial revision
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
#---------------------------------------------------------------------------
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
14
# Project related configuration options
2 by steffen
Initial revision
15
#---------------------------------------------------------------------------
16
827 by steffen
The next step towards checkpoint restart
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
2 by steffen
Initial revision
25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
26
# by quotes) that should identify the project.
2 by steffen
Initial revision
27
844 by dion
Release2009: cosmetic changes to remove references to LSMearth
28
PROJECT_NAME           = ESyS-Particle
2 by steffen
Initial revision
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
1123 by Vince Boros
Updates ahead of 2.3 release
34
PROJECT_NUMBER         = 2.3
2 by steffen
Initial revision
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
1053 by Vince Boros
Changes to the doxygen input file, taken mainly from the LSMGenGeo Doxyfile,
41
OUTPUT_DIRECTORY       = Doc
2 by steffen
Initial revision
42
827 by steffen
The next step towards checkpoint restart
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
2 by steffen
Initial revision
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: 
827 by steffen
The next step towards checkpoint restart
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.
2 by steffen
Initial revision
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). 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
68
# Set to NO to disable this.
2 by steffen
Initial revision
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 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
75
# brief descriptions will be completely suppressed.
2 by steffen
Initial revision
76
77
REPEAT_BRIEF           = YES
78
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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 
827 by steffen
The next step towards checkpoint restart
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"
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
88
89
ABBREVIATE_BRIEF       = 
90
2 by steffen
Initial revision
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 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
93
# description.
2 by steffen
Initial revision
94
95
ALWAYS_DETAILED_SEC    = NO
96
827 by steffen
The next step towards checkpoint restart
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.
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
101
102
INLINE_INHERITED_MEMB  = NO
103
2 by steffen
Initial revision
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 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
106
# to NO the shortest path that makes the file name unique will be used.
2 by steffen
Initial revision
107
1053 by Vince Boros
Changes to the doxygen input file, taken mainly from the LSMGenGeo Doxyfile,
108
FULL_PATH_NAMES        = YES
2 by steffen
Initial revision
109
110
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
111
# can be used to strip a user-defined part of the path. Stripping is 
2 by steffen
Initial revision
112
# only done if one of the specified strings matches the left-hand part of 
827 by steffen
The next step towards checkpoint restart
113
# the path. The tag can be used to show relative paths in the file list. 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
114
# If left blank the directory from which doxygen is run is used as the 
115
# path to strip.
2 by steffen
Initial revision
116
117
STRIP_FROM_PATH        = 
118
827 by steffen
The next step towards checkpoint restart
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
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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 
827 by steffen
The next step towards checkpoint restart
137
# comments will behave just like regular Qt-style comments 
138
# (thus requiring an explicit @brief command for a brief description.)
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
139
140
JAVADOC_AUTOBRIEF      = NO
141
827 by steffen
The next step towards checkpoint restart
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
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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
827 by steffen
The next step towards checkpoint restart
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.
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
174
827 by steffen
The next step towards checkpoint restart
175
SEPARATE_MEMBER_PAGES  = NO
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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               = 8
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
827 by steffen
The next step towards checkpoint restart
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. 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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
827 by steffen
The next step towards checkpoint restart
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.
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
202
203
OPTIMIZE_OUTPUT_JAVA   = NO
204
827 by steffen
The next step towards checkpoint restart
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    = NO
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
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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
827 by steffen
The next step towards checkpoint restart
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
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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
1053 by Vince Boros
Changes to the doxygen input file, taken mainly from the LSMGenGeo Doxyfile,
280
EXTRACT_ALL            = YES
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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
1053 by Vince Boros
Changes to the doxygen input file, taken mainly from the LSMGenGeo Doxyfile,
285
EXTRACT_PRIVATE        = YES
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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
1053 by Vince Boros
Changes to the doxygen input file, taken mainly from the LSMGenGeo Doxyfile,
290
EXTRACT_STATIC         = YES
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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
827 by steffen
The next step towards checkpoint restart
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
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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
2 by steffen
Initial revision
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. 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
345
# Set it to YES to include the internal documentation.
2 by steffen
Initial revision
346
347
INTERNAL_DOCS          = NO
348
349
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
350
# file names in lower-case letters. If set to YES upper-case letters are also 
2 by steffen
Initial revision
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 
827 by steffen
The next step towards checkpoint restart
353
# and Mac users are advised to set this option to NO.
2 by steffen
Initial revision
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 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
359
# documentation. If set to YES the scope will be hidden.
2 by steffen
Initial revision
360
361
HIDE_SCOPE_NAMES       = NO
362
363
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
364
# will put a list of the files that are included by a file in the documentation 
365
# of that file.
2 by steffen
Initial revision
366
367
SHOW_INCLUDE_FILES     = YES
368
369
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
370
# is inserted in the documentation for inline members.
2 by steffen
Initial revision
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 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
377
# declaration order.
2 by steffen
Initial revision
378
379
SORT_MEMBER_DOCS       = YES
380
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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
827 by steffen
The next step towards checkpoint restart
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
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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
2 by steffen
Initial revision
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
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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
2 by steffen
Initial revision
448
827 by steffen
The next step towards checkpoint restart
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
1053 by Vince Boros
Changes to the doxygen input file, taken mainly from the LSMGenGeo Doxyfile,
453
SHOW_DIRECTORIES       = YES
827 by steffen
The next step towards checkpoint restart
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
2 by steffen
Initial revision
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 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
482
# by doxygen. Possible values are YES and NO. If left blank NO is used.
2 by steffen
Initial revision
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 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
488
# NO is used.
2 by steffen
Initial revision
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 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
494
# automatically be disabled.
2 by steffen
Initial revision
495
1053 by Vince Boros
Changes to the doxygen input file, taken mainly from the LSMGenGeo Doxyfile,
496
WARN_IF_UNDOCUMENTED   = YES
2 by steffen
Initial revision
497
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
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
827 by steffen
The next step towards checkpoint restart
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
1053 by Vince Boros
Changes to the doxygen input file, taken mainly from the LSMGenGeo Doxyfile,
511
WARN_NO_PARAMDOC       = YES
827 by steffen
The next step towards checkpoint restart
512
2 by steffen
Initial revision
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 
827 by steffen
The next step towards checkpoint restart
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)
2 by steffen
Initial revision
519
520
WARN_FORMAT            = "$file:$line: $text"
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 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
524
# to stderr.
2 by steffen
Initial revision
525
1053 by Vince Boros
Changes to the doxygen input file, taken mainly from the LSMGenGeo Doxyfile,
526
WARN_LOGFILE           = doxy_warnings.txt
2 by steffen
Initial revision
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 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
535
# with spaces.
2 by steffen
Initial revision
536
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
537
INPUT                  = Parallel \
538
                         Model \
539
                         Foundation \
827 by steffen
The next step towards checkpoint restart
540
                         Fields \
541
                         Geometry \
1053 by Vince Boros
Changes to the doxygen input file, taken mainly from the LSMGenGeo Doxyfile,
542
                         Python \
543
                         Tools \
544
                         ntable \
827 by steffen
The next step towards checkpoint restart
545
                         pis \
546
                         ppa \
547
                         tml
548
549
# This tag can be used to specify the character encoding of the source files 
550
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
551
# also the default input encoding. Doxygen uses libiconv (or the iconv built 
552
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
553
# the list of possible encodings.
554
555
INPUT_ENCODING         = UTF-8
2 by steffen
Initial revision
556
557
# If the value of the INPUT tag contains directories, you can use the 
558
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
559
# and *.h) to filter out the source-files in the directories. If left 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
560
# blank the following patterns are tested: 
827 by steffen
The next step towards checkpoint restart
561
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
562
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
2 by steffen
Initial revision
563
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
564
FILE_PATTERNS          = *.h \
565
                         *.hpp \
566
                         *.cpp \
567
                         *.c
2 by steffen
Initial revision
568
569
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
570
# should be searched for input files as well. Possible values are YES and NO. 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
571
# If left blank NO is used.
2 by steffen
Initial revision
572
573
RECURSIVE              = YES
574
575
# The EXCLUDE tag can be used to specify files and/or directories that should 
576
# excluded from the INPUT source files. This way you can easily exclude a 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
577
# subdirectory from a directory tree whose root is specified with the INPUT tag.
578
579
EXCLUDE                = shake_*
580
827 by steffen
The next step towards checkpoint restart
581
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
582
# directories that are symbolic links (a Unix filesystem feature) are excluded 
583
# from the input.
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
584
585
EXCLUDE_SYMLINKS       = NO
2 by steffen
Initial revision
586
587
# If the value of the INPUT tag contains directories, you can use the 
588
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
827 by steffen
The next step towards checkpoint restart
589
# certain files from those directories. Note that the wildcards are matched 
590
# against the file with absolute path, so to exclude all test directories 
591
# for example use the pattern */test/*
2 by steffen
Initial revision
592
593
EXCLUDE_PATTERNS       = 
594
827 by steffen
The next step towards checkpoint restart
595
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
596
# (namespaces, classes, functions, etc.) that should be excluded from the 
597
# output. The symbol name can be a fully qualified name, a word, or if the 
598
# wildcard * is used, a substring. Examples: ANamespace, AClass, 
599
# AClass::ANamespace, ANamespace::*Test
600
601
EXCLUDE_SYMBOLS        = 
602
2 by steffen
Initial revision
603
# The EXAMPLE_PATH tag can be used to specify one or more files or 
604
# directories that contain example code fragments that are included (see 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
605
# the \include command).
2 by steffen
Initial revision
606
607
EXAMPLE_PATH           = 
608
609
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
610
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
611
# and *.h) to filter out the source-files in the directories. If left 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
612
# blank all files are included.
2 by steffen
Initial revision
613
614
EXAMPLE_PATTERNS       = 
615
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
616
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
617
# searched for input files to be used with the \include or \dontinclude 
618
# commands irrespective of the value of the RECURSIVE tag. 
619
# Possible values are YES and NO. If left blank NO is used.
620
621
EXAMPLE_RECURSIVE      = NO
622
2 by steffen
Initial revision
623
# The IMAGE_PATH tag can be used to specify one or more files or 
624
# directories that contain image that are included in the documentation (see 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
625
# the \image command).
2 by steffen
Initial revision
626
627
IMAGE_PATH             = 
628
629
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
630
# invoke to filter for each input file. Doxygen will invoke the filter program 
631
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
632
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
633
# input file. Doxygen will then use the output that the filter program writes 
827 by steffen
The next step towards checkpoint restart
634
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
635
# ignored.
2 by steffen
Initial revision
636
637
INPUT_FILTER           = 
638
827 by steffen
The next step towards checkpoint restart
639
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
640
# basis.  Doxygen will compare the file name with each pattern and apply the 
641
# filter if there is a match.  The filters are a list of the form: 
642
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
643
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
644
# is applied to all files.
645
646
FILTER_PATTERNS        = 
647
2 by steffen
Initial revision
648
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
649
# INPUT_FILTER) will be used to filter the input files when producing source 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
650
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
2 by steffen
Initial revision
651
652
FILTER_SOURCE_FILES    = NO
653
654
#---------------------------------------------------------------------------
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
655
# configuration options related to source browsing
656
#---------------------------------------------------------------------------
657
658
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
659
# be generated. Documented entities will be cross-referenced with these sources. 
660
# Note: To get rid of all source code in the generated output, make sure also 
661
# VERBATIM_HEADERS is set to NO.
662
663
SOURCE_BROWSER         = NO
664
665
# Setting the INLINE_SOURCES tag to YES will include the body 
666
# of functions and classes directly in the documentation.
667
668
INLINE_SOURCES         = NO
669
670
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
671
# doxygen to hide any special comment blocks from generated source code 
672
# fragments. Normal C and C++ comments will always remain visible.
673
674
STRIP_CODE_COMMENTS    = YES
675
827 by steffen
The next step towards checkpoint restart
676
# If the REFERENCED_BY_RELATION tag is set to YES 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
677
# then for each documented function all documented 
678
# functions referencing it will be listed.
679
680
REFERENCED_BY_RELATION = YES
681
827 by steffen
The next step towards checkpoint restart
682
# If the REFERENCES_RELATION tag is set to YES 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
683
# then for each documented function all documented entities 
684
# called/used by that function will be listed.
685
686
REFERENCES_RELATION    = YES
687
827 by steffen
The next step towards checkpoint restart
688
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
689
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
690
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
691
# link to the source code.  Otherwise they will link to the documentstion.
692
693
REFERENCES_LINK_SOURCE = YES
694
695
# If the USE_HTAGS tag is set to YES then the references to source code 
696
# will point to the HTML generated by the htags(1) tool instead of doxygen 
697
# built-in source browser. The htags tool is part of GNU's global source 
698
# tagging system (see http://www.gnu.org/software/global/global.html). You 
699
# will need version 4.8.6 or higher.
700
701
USE_HTAGS              = NO
702
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
703
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
704
# will generate a verbatim copy of the header file for each class for 
705
# which an include is specified. Set to NO to disable this.
706
707
VERBATIM_HEADERS       = YES
708
709
#---------------------------------------------------------------------------
2 by steffen
Initial revision
710
# configuration options related to the alphabetical class index
711
#---------------------------------------------------------------------------
712
713
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
714
# of all compounds will be generated. Enable this if the project 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
715
# contains a lot of classes, structs, unions or interfaces.
2 by steffen
Initial revision
716
1053 by Vince Boros
Changes to the doxygen input file, taken mainly from the LSMGenGeo Doxyfile,
717
ALPHABETICAL_INDEX     = YES
2 by steffen
Initial revision
718
719
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
720
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
721
# in which this list will be split (can be a number in the range [1..20])
2 by steffen
Initial revision
722
723
COLS_IN_ALPHA_INDEX    = 5
724
725
# In case all classes in a project start with a common prefix, all 
726
# classes will be put under the same header in the alphabetical index. 
727
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
728
# should be ignored while generating the index headers.
2 by steffen
Initial revision
729
730
IGNORE_PREFIX          = 
731
732
#---------------------------------------------------------------------------
733
# configuration options related to the HTML output
734
#---------------------------------------------------------------------------
735
736
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
737
# generate HTML output.
2 by steffen
Initial revision
738
739
GENERATE_HTML          = YES
740
741
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
742
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
743
# put in front of it. If left blank `html' will be used as the default path.
2 by steffen
Initial revision
744
745
HTML_OUTPUT            = html
746
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
747
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
748
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
749
# doxygen will generate files with .html extension.
750
751
HTML_FILE_EXTENSION    = .html
752
2 by steffen
Initial revision
753
# The HTML_HEADER tag can be used to specify a personal HTML header for 
754
# each generated HTML page. If it is left blank doxygen will generate a 
755
# standard header.
756
757
HTML_HEADER            = 
758
759
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
760
# each generated HTML page. If it is left blank doxygen will generate a 
761
# standard footer.
762
763
HTML_FOOTER            = 
764
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
765
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
2 by steffen
Initial revision
766
# style sheet that is used by each HTML page. It can be used to 
767
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
768
# will generate a default style sheet. Note that doxygen will try to copy 
769
# the style sheet file to the HTML output directory, so don't put your own 
770
# stylesheet in the HTML output directory as well, or it will be erased!
2 by steffen
Initial revision
771
772
HTML_STYLESHEET        = 
773
774
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
775
# files or namespaces will be aligned in HTML using tables. If set to 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
776
# NO a bullet list will be used.
2 by steffen
Initial revision
777
778
HTML_ALIGN_MEMBERS     = YES
779
780
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
781
# will be generated that can be used as input for tools like the 
827 by steffen
The next step towards checkpoint restart
782
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
783
# of the generated HTML documentation.
2 by steffen
Initial revision
784
785
GENERATE_HTMLHELP      = NO
786
827 by steffen
The next step towards checkpoint restart
787
# If the GENERATE_DOCSET tag is set to YES, additional index files 
788
# will be generated that can be used as input for Apple's Xcode 3 
789
# integrated development environment, introduced with OSX 10.5 (Leopard). 
790
# To create a documentation set, doxygen will generate a Makefile in the 
791
# HTML output directory. Running make will produce the docset in that 
792
# directory and running "make install" will install the docset in 
793
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
794
# it at startup.
795
796
GENERATE_DOCSET        = NO
797
798
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
799
# feed. A documentation feed provides an umbrella under which multiple 
800
# documentation sets from a single provider (such as a company or product suite) 
801
# can be grouped.
802
803
DOCSET_FEEDNAME        = "Doxygen generated docs"
804
805
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
806
# should uniquely identify the documentation set bundle. This should be a 
807
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
808
# will append .docset to the name.
809
810
DOCSET_BUNDLE_ID       = org.doxygen.Project
811
812
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
813
# documentation will contain sections that can be hidden and shown after the 
814
# page has loaded. For this to work a browser that supports 
815
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
816
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
817
818
HTML_DYNAMIC_SECTIONS  = NO
819
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
820
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
821
# be used to specify the file name of the resulting .chm file. You 
822
# can add a path in front of the file if the result should not be 
823
# written to the html output directory.
824
825
CHM_FILE               = 
826
827
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
828
# be used to specify the location (absolute path including file name) of 
829
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
830
# the HTML help compiler on the generated index.hhp.
831
832
HHC_LOCATION           = 
833
834
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
835
# controls if a separate .chi index file is generated (YES) or that 
836
# it should be included in the master .chm file (NO).
837
838
GENERATE_CHI           = NO
839
827 by steffen
The next step towards checkpoint restart
840
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
841
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
842
# content.
843
844
CHM_INDEX_ENCODING     = 
845
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
846
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
847
# controls whether a binary table of contents is generated (YES) or a 
848
# normal table of contents (NO) in the .chm file.
849
850
BINARY_TOC             = NO
851
852
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
853
# to the contents of the HTML help documentation and to the tree view.
854
855
TOC_EXPAND             = NO
856
2 by steffen
Initial revision
857
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
858
# top of each HTML page. The value NO (the default) enables the index and 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
859
# the value YES disables it.
2 by steffen
Initial revision
860
861
DISABLE_INDEX          = NO
862
863
# This tag can be used to set the number of enum values (range [1..20]) 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
864
# that doxygen will group on one line in the generated HTML documentation.
2 by steffen
Initial revision
865
866
ENUM_VALUES_PER_LINE   = 4
867
827 by steffen
The next step towards checkpoint restart
868
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
869
# structure should be generated to display hierarchical information.
870
# If the tag value is set to FRAME, a side panel will be generated
871
# containing a tree-like index structure (just like the one that 
2 by steffen
Initial revision
872
# is generated for HTML Help). For this to work a browser that supports 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
873
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
874
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
827 by steffen
The next step towards checkpoint restart
875
# probably better off using the HTML help feature. Other possible values 
876
# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
877
# and Class Hiererachy pages using a tree view instead of an ordered list;
878
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
879
# disables this behavior completely. For backwards compatibility with previous
880
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
881
# respectively.
2 by steffen
Initial revision
882
1053 by Vince Boros
Changes to the doxygen input file, taken mainly from the LSMGenGeo Doxyfile,
883
GENERATE_TREEVIEW      = YES
2 by steffen
Initial revision
884
885
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
886
# used to set the initial width (in pixels) of the frame in which the tree 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
887
# is shown.
2 by steffen
Initial revision
888
889
TREEVIEW_WIDTH         = 250
890
827 by steffen
The next step towards checkpoint restart
891
# Use this tag to change the font size of Latex formulas included 
892
# as images in the HTML documentation. The default is 10. Note that 
893
# when you change the font size after a successful doxygen run you need 
894
# to manually remove any form_*.png images from the HTML output directory 
895
# to force them to be regenerated.
896
897
FORMULA_FONTSIZE       = 10
898
2 by steffen
Initial revision
899
#---------------------------------------------------------------------------
900
# configuration options related to the LaTeX output
901
#---------------------------------------------------------------------------
902
903
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
904
# generate Latex output.
2 by steffen
Initial revision
905
827 by steffen
The next step towards checkpoint restart
906
GENERATE_LATEX         = NO
2 by steffen
Initial revision
907
908
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
909
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
910
# put in front of it. If left blank `latex' will be used as the default path.
2 by steffen
Initial revision
911
912
LATEX_OUTPUT           = latex
913
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
914
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
915
# invoked. If left blank `latex' will be used as the default command name.
916
917
LATEX_CMD_NAME         = latex
918
919
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
920
# generate index for LaTeX. If left blank `makeindex' will be used as the 
921
# default command name.
922
923
MAKEINDEX_CMD_NAME     = makeindex
924
2 by steffen
Initial revision
925
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
926
# LaTeX documents. This may be useful for small projects and may help to 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
927
# save some trees in general.
2 by steffen
Initial revision
928
929
COMPACT_LATEX          = NO
930
931
# The PAPER_TYPE tag can be used to set the paper type that is used 
932
# by the printer. Possible values are: a4, a4wide, letter, legal and 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
933
# executive. If left blank a4wide will be used.
2 by steffen
Initial revision
934
935
PAPER_TYPE             = a4wide
936
937
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
938
# packages that should be included in the LaTeX output.
2 by steffen
Initial revision
939
940
EXTRA_PACKAGES         = 
941
942
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
943
# the generated latex document. The header should contain everything until 
944
# the first chapter. If it is left blank doxygen will generate a 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
945
# standard header. Notice: only use this tag if you know what you are doing!
2 by steffen
Initial revision
946
947
LATEX_HEADER           = 
948
949
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
950
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
951
# contain links (just like the HTML output) instead of page references 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
952
# This makes the output suitable for online browsing using a pdf viewer.
2 by steffen
Initial revision
953
954
PDF_HYPERLINKS         = NO
955
956
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
957
# plain latex in the generated Makefile. Set this option to YES to get a 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
958
# higher quality PDF documentation.
2 by steffen
Initial revision
959
960
USE_PDFLATEX           = NO
961
962
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
963
# command to the generated LaTeX files. This will instruct LaTeX to keep 
964
# running if errors occur, instead of asking the user for help. 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
965
# This option is also used when generating formulas in HTML.
2 by steffen
Initial revision
966
967
LATEX_BATCHMODE        = NO
968
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
969
# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
970
# include the index chapters (such as File Index, Compound Index, etc.) 
971
# in the output.
972
973
LATEX_HIDE_INDICES     = NO
974
2 by steffen
Initial revision
975
#---------------------------------------------------------------------------
976
# configuration options related to the RTF output
977
#---------------------------------------------------------------------------
978
979
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
980
# The RTF output is optimized for Word 97 and may not look very pretty with 
2 by steffen
Initial revision
981
# other RTF readers or editors.
982
983
GENERATE_RTF           = NO
984
985
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
986
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
987
# put in front of it. If left blank `rtf' will be used as the default path.
2 by steffen
Initial revision
988
989
RTF_OUTPUT             = rtf
990
991
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
992
# RTF documents. This may be useful for small projects and may help to 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
993
# save some trees in general.
2 by steffen
Initial revision
994
995
COMPACT_RTF            = NO
996
997
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
998
# will contain hyperlink fields. The RTF file will 
999
# contain links (just like the HTML output) instead of page references. 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1000
# This makes the output suitable for online browsing using WORD or other 
2 by steffen
Initial revision
1001
# programs which support those fields. 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1002
# Note: wordpad (write) and others do not support links.
2 by steffen
Initial revision
1003
1004
RTF_HYPERLINKS         = NO
1005
1006
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1007
# config file, i.e. a series of assignments. You only have to provide 
1008
# replacements, missing definitions are set to their default value.
2 by steffen
Initial revision
1009
1010
RTF_STYLESHEET_FILE    = 
1011
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1012
# Set optional variables used in the generation of an rtf document. 
1013
# Syntax is similar to doxygen's config file.
1014
1015
RTF_EXTENSIONS_FILE    = 
1016
2 by steffen
Initial revision
1017
#---------------------------------------------------------------------------
1018
# configuration options related to the man page output
1019
#---------------------------------------------------------------------------
1020
1021
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1022
# generate man pages
2 by steffen
Initial revision
1023
1024
GENERATE_MAN           = NO
1025
1026
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
1027
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1028
# put in front of it. If left blank `man' will be used as the default path.
2 by steffen
Initial revision
1029
1030
MAN_OUTPUT             = man
1031
1032
# The MAN_EXTENSION tag determines the extension that is added to 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1033
# the generated man pages (default is the subroutine's section .3)
2 by steffen
Initial revision
1034
1035
MAN_EXTENSION          = .3
1036
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1037
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
1038
# then it will generate one additional man file for each entity 
1039
# documented in the real man page(s). These additional files 
1040
# only source the real man page, but without them the man command 
1041
# would be unable to find the correct page. The default is NO.
1042
1043
MAN_LINKS              = NO
1044
2 by steffen
Initial revision
1045
#---------------------------------------------------------------------------
1046
# configuration options related to the XML output
1047
#---------------------------------------------------------------------------
1048
1049
# If the GENERATE_XML tag is set to YES Doxygen will 
1050
# generate an XML file that captures the structure of 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1051
# the code including all documentation.
2 by steffen
Initial revision
1052
1053
GENERATE_XML           = NO
1054
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1055
# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
1056
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1057
# put in front of it. If left blank `xml' will be used as the default path.
1058
1059
XML_OUTPUT             = xml
1060
1061
# The XML_SCHEMA tag can be used to specify an XML schema, 
1062
# which can be used by a validating XML parser to check the 
1063
# syntax of the XML files.
1064
1065
XML_SCHEMA             = 
1066
1067
# The XML_DTD tag can be used to specify an XML DTD, 
1068
# which can be used by a validating XML parser to check the 
1069
# syntax of the XML files.
1070
1071
XML_DTD                = 
1072
1073
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
1074
# dump the program listings (including syntax highlighting 
1075
# and cross-referencing information) to the XML output. Note that 
1076
# enabling this will significantly increase the size of the XML output.
1077
1078
XML_PROGRAMLISTING     = YES
1079
1080
#---------------------------------------------------------------------------
1081
# configuration options for the AutoGen Definitions output
1082
#---------------------------------------------------------------------------
1083
1084
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
1085
# generate an AutoGen Definitions (see autogen.sf.net) file 
1086
# that captures the structure of the code including all 
1087
# documentation. Note that this feature is still experimental 
1088
# and incomplete at the moment.
1089
1090
GENERATE_AUTOGEN_DEF   = NO
1091
1092
#---------------------------------------------------------------------------
1093
# configuration options related to the Perl module output
1094
#---------------------------------------------------------------------------
1095
1096
# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
1097
# generate a Perl module file that captures the structure of 
1098
# the code including all documentation. Note that this 
1099
# feature is still experimental and incomplete at the 
1100
# moment.
1101
1102
GENERATE_PERLMOD       = NO
1103
1104
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
1105
# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
1106
# to generate PDF and DVI output from the Perl module output.
1107
1108
PERLMOD_LATEX          = NO
1109
1110
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
1111
# nicely formatted so it can be parsed by a human reader.  This is useful 
1112
# if you want to understand what is going on.  On the other hand, if this 
1113
# tag is set to NO the size of the Perl module output will be much smaller 
1114
# and Perl will parse it just the same.
1115
1116
PERLMOD_PRETTY         = YES
1117
1118
# The names of the make variables in the generated doxyrules.make file 
1119
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
1120
# This is useful so different doxyrules.make files included by the same 
1121
# Makefile don't overwrite each other's variables.
1122
1123
PERLMOD_MAKEVAR_PREFIX = 
1124
2 by steffen
Initial revision
1125
#---------------------------------------------------------------------------
1126
# Configuration options related to the preprocessor   
1127
#---------------------------------------------------------------------------
1128
1129
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
1130
# evaluate all C-preprocessor directives found in the sources and include 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1131
# files.
2 by steffen
Initial revision
1132
1133
ENABLE_PREPROCESSING   = YES
1134
1135
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
1136
# names in the source code. If set to NO (the default) only conditional 
1137
# compilation will be performed. Macro expansion can be done in a controlled 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1138
# way by setting EXPAND_ONLY_PREDEF to YES.
2 by steffen
Initial revision
1139
1140
MACRO_EXPANSION        = NO
1141
1142
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
1143
# then the macro expansion is limited to the macros specified with the 
827 by steffen
The next step towards checkpoint restart
1144
# PREDEFINED and EXPAND_AS_DEFINED tags.
2 by steffen
Initial revision
1145
1146
EXPAND_ONLY_PREDEF     = NO
1147
1148
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1149
# in the INCLUDE_PATH (see below) will be search if a #include is found.
2 by steffen
Initial revision
1150
1151
SEARCH_INCLUDES        = YES
1152
1153
# The INCLUDE_PATH tag can be used to specify one or more directories that 
1154
# contain include files that are not input files but should be processed by 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1155
# the preprocessor.
2 by steffen
Initial revision
1156
1157
INCLUDE_PATH           = 
1158
1159
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1160
# patterns (like *.h and *.hpp) to filter out the header-files in the 
1161
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1162
# be used.
2 by steffen
Initial revision
1163
1164
INCLUDE_FILE_PATTERNS  = 
1165
1166
# The PREDEFINED tag can be used to specify one or more macro names that 
1167
# are defined before the preprocessor is started (similar to the -D option of 
1168
# gcc). The argument of the tag is a list of macros of the form: name 
1169
# or name=definition (no spaces). If the definition and the = are 
827 by steffen
The next step towards checkpoint restart
1170
# omitted =1 is assumed. To prevent a macro definition from being 
1171
# undefined via #undef or recursively expanded use the := operator 
1172
# instead of the = operator.
2 by steffen
Initial revision
1173
1174
PREDEFINED             = 
1175
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1176
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
2 by steffen
Initial revision
1177
# this tag can be used to specify a list of macro names that should be expanded. 
1178
# The macro definition that is found in the sources will be used. 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1179
# Use the PREDEFINED tag if you want to use a different macro definition.
2 by steffen
Initial revision
1180
1181
EXPAND_AS_DEFINED      = 
1182
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1183
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
1184
# doxygen's preprocessor will remove all function-like macros that are alone 
1185
# on a line, have an all uppercase name, and do not end with a semicolon. Such 
827 by steffen
The next step towards checkpoint restart
1186
# function macros are typically used for boiler-plate code, and will confuse 
1187
# the parser if not removed.
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1188
1189
SKIP_FUNCTION_MACROS   = YES
1190
1191
#---------------------------------------------------------------------------
1192
# Configuration::additions related to external references   
1193
#---------------------------------------------------------------------------
1194
1195
# The TAGFILES option can be used to specify one or more tagfiles. 
1196
# Optionally an initial location of the external documentation 
1197
# can be added for each tagfile. The format of a tag file without 
1198
# this location is as follows: 
1199
#   TAGFILES = file1 file2 ... 
1200
# Adding location for the tag files is done as follows: 
1201
#   TAGFILES = file1=loc1 "file2 = loc2" ... 
1202
# where "loc1" and "loc2" can be relative or absolute paths or 
1203
# URLs. If a location is present for each tag, the installdox tool 
1204
# does not have to be run to correct the links.
1205
# Note that each tag file must have a unique name
1206
# (where the name does NOT include the path)
1207
# If a tag file is not located in the directory in which doxygen 
1208
# is run, you must also specify the path to the tagfile here.
2 by steffen
Initial revision
1209
1210
TAGFILES               = 
1211
1212
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1213
# a tag file that is based on the input files it reads.
2 by steffen
Initial revision
1214
1215
GENERATE_TAGFILE       = 
1216
1217
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1218
# in the class index. If set to NO only the inherited external classes 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1219
# will be listed.
2 by steffen
Initial revision
1220
1221
ALLEXTERNALS           = NO
1222
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1223
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1224
# in the modules index. If set to NO, only the current project's groups will 
1225
# be listed.
1226
1227
EXTERNAL_GROUPS        = YES
1228
2 by steffen
Initial revision
1229
# The PERL_PATH should be the absolute path and name of the perl script 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1230
# interpreter (i.e. the result of `which perl').
2 by steffen
Initial revision
1231
1232
PERL_PATH              = /usr/bin/perl
1233
1234
#---------------------------------------------------------------------------
1235
# Configuration options related to the dot tool   
1236
#---------------------------------------------------------------------------
1237
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1238
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
827 by steffen
The next step towards checkpoint restart
1239
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
1240
# or super classes. Setting the tag to NO turns the diagrams off. Note that 
1241
# this option is superseded by the HAVE_DOT option below. This is only a 
1242
# fallback. It is recommended to install and use dot, since it yields more 
1243
# powerful graphs.
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1244
1245
CLASS_DIAGRAMS         = YES
1246
827 by steffen
The next step towards checkpoint restart
1247
# You can define message sequence charts within doxygen comments using the \msc 
1248
# command. Doxygen will then run the mscgen tool (see 
1249
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
1250
# documentation. The MSCGEN_PATH tag allows you to specify the directory where 
1251
# the mscgen tool resides. If left empty the tool is assumed to be found in the 
1252
# default search path.
1253
1254
MSCGEN_PATH            = 
1255
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1256
# If set to YES, the inheritance and collaboration graphs will hide 
1257
# inheritance and usage relations if the target is undocumented 
1258
# or is not a class.
1259
1260
HIDE_UNDOC_RELATIONS   = YES
1261
2 by steffen
Initial revision
1262
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1263
# available from the path. This tool is part of Graphviz, a graph visualization 
1264
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1265
# have no effect if this option is set to NO (the default)
2 by steffen
Initial revision
1266
1267
HAVE_DOT               = YES
1268
827 by steffen
The next step towards checkpoint restart
1269
# By default doxygen will write a font called FreeSans.ttf to the output 
1270
# directory and reference it in all dot files that doxygen generates. This 
1271
# font does not include all possible unicode characters however, so when you need 
1272
# these (or just want a differently looking font) you can specify the font name 
1273
# using DOT_FONTNAME. You need need to make sure dot is able to find the font, 
1274
# which can be done by putting it in a standard location or by setting the 
1275
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
1276
# containing the font.
1277
1278
DOT_FONTNAME           = FreeSans
1279
1280
# By default doxygen will tell dot to use the output directory to look for the 
1281
# FreeSans.ttf font (which doxygen will put there itself). If you specify a 
1282
# different font using DOT_FONTNAME you can set the path where dot 
1283
# can find it using this tag.
1284
1285
DOT_FONTPATH           = 
1286
2 by steffen
Initial revision
1287
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1288
# will generate a graph for each documented class showing the direct and 
1289
# indirect inheritance relations. Setting this tag to YES will force the 
1290
# the CLASS_DIAGRAMS tag to NO.
1291
1292
CLASS_GRAPH            = YES
1293
1294
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1295
# will generate a graph for each documented class showing the direct and 
1296
# indirect implementation dependencies (inheritance, containment, and 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1297
# class references variables) of the class with other documented classes.
2 by steffen
Initial revision
1298
1299
COLLABORATION_GRAPH    = YES
1300
827 by steffen
The next step towards checkpoint restart
1301
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1302
# will generate a graph for groups, showing the direct groups dependencies
1303
1304
GROUP_GRAPHS           = YES
1305
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1306
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1307
# collaboration diagrams in a style similar to the OMG's Unified Modeling 
1308
# Language.
1309
1310
UML_LOOK               = NO
1311
1312
# If set to YES, the inheritance and collaboration graphs will show the 
1313
# relations between templates and their instances.
1314
1053 by Vince Boros
Changes to the doxygen input file, taken mainly from the LSMGenGeo Doxyfile,
1315
TEMPLATE_RELATIONS     = YES
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1316
1317
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1318
# tags are set to YES then doxygen will generate a graph for each documented 
1319
# file showing the direct and indirect include dependencies of the file with 
1320
# other documented files.
2 by steffen
Initial revision
1321
1322
INCLUDE_GRAPH          = YES
1323
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1324
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1325
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1326
# documented header file showing the documented files that directly or 
1327
# indirectly include this file.
2 by steffen
Initial revision
1328
1329
INCLUDED_BY_GRAPH      = YES
1330
827 by steffen
The next step towards checkpoint restart
1331
# If the CALL_GRAPH and HAVE_DOT options are set to YES then 
1332
# doxygen will generate a call dependency graph for every global function 
1333
# or class method. Note that enabling this option will significantly increase 
1334
# the time of a run. So in most cases it will be better to enable call graphs 
1335
# for selected functions only using the \callgraph command.
1336
1337
CALL_GRAPH             = YES
1338
1339
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
1340
# doxygen will generate a caller dependency graph for every global function 
1341
# or class method. Note that enabling this option will significantly increase 
1342
# the time of a run. So in most cases it will be better to enable caller 
1343
# graphs for selected functions only using the \callergraph command.
1344
984 by steffen
Added checkpointing function for bonded trimesh interactions
1345
CALLER_GRAPH           = YES
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1346
2 by steffen
Initial revision
1347
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1348
# will graphical hierarchy of all classes instead of a textual one.
2 by steffen
Initial revision
1349
1350
GRAPHICAL_HIERARCHY    = YES
1351
827 by steffen
The next step towards checkpoint restart
1352
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1353
# then doxygen will show the dependencies a directory has on other directories 
1354
# in a graphical way. The dependency relations are determined by the #include
1355
# relations between the files in the directories.
1356
1357
DIRECTORY_GRAPH        = YES
1358
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1359
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1360
# generated by dot. Possible values are png, jpg, or gif
1361
# If left blank png will be used.
1362
1363
DOT_IMAGE_FORMAT       = png
1364
2 by steffen
Initial revision
1365
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
827 by steffen
The next step towards checkpoint restart
1366
# found. If left blank, it is assumed the dot tool can be found in the path.
2 by steffen
Initial revision
1367
1368
DOT_PATH               = 
1369
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1370
# The DOTFILE_DIRS tag can be used to specify one or more directories that 
1371
# contain dot files that are included in the documentation (see the 
1372
# \dotfile command).
1373
1374
DOTFILE_DIRS           = 
1375
827 by steffen
The next step towards checkpoint restart
1376
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
1377
# nodes that will be shown in the graph. If the number of nodes in a graph 
1378
# becomes larger than this value, doxygen will truncate the graph, which is 
1379
# visualized by representing a node as a red box. Note that doxygen if the 
1380
# number of direct children of the root node in a graph is already larger than 
1381
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
1382
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1383
1384
DOT_GRAPH_MAX_NODES    = 50
2 by steffen
Initial revision
1385
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1386
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1387
# graphs generated by dot. A depth value of 3 means that only nodes reachable 
827 by steffen
The next step towards checkpoint restart
1388
# from the root by following a path via at most 3 edges will be shown. Nodes 
1389
# that lay further from the root node will be omitted. Note that setting this 
1390
# option to 1 or 2 may greatly reduce the computation time needed for large 
1391
# code bases. Also note that the size of a graph can be further restricted by 
1392
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1393
1394
MAX_DOT_GRAPH_DEPTH    = 0
1395
827 by steffen
The next step towards checkpoint restart
1396
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1397
# background. This is enabled by default, which results in a transparent 
1398
# background. Warning: Depending on the platform used, enabling this option 
1399
# may lead to badly anti-aliased labels on the edges of a graph (i.e. they 
1400
# become hard to read).
1401
1402
DOT_TRANSPARENT        = YES
1403
1404
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1405
# files in one run (i.e. multiple -o and -T options on the command line). This 
1406
# makes dot run faster, but since only newer versions of dot (>1.8.10) 
1407
# support this, this feature is disabled by default.
1408
1409
DOT_MULTI_TARGETS      = NO
1410
2 by steffen
Initial revision
1411
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1412
# generate a legend page explaining the meaning of the various boxes and 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1413
# arrows in the dot generated graphs.
2 by steffen
Initial revision
1414
1415
GENERATE_LEGEND        = YES
1416
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1417
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1418
# remove the intermediate dot files that are used to generate 
1419
# the various graphs.
1420
1421
DOT_CLEANUP            = YES
1422
2 by steffen
Initial revision
1423
#---------------------------------------------------------------------------
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1424
# Configuration::additions related to the search engine   
2 by steffen
Initial revision
1425
#---------------------------------------------------------------------------
1426
1427
# The SEARCHENGINE tag specifies whether or not a search engine should be 
511 by slatham
Moved OpValue dependencies in CLatticeMaster to ParserLmInitialiser.cpp classes.
1428
# used. If set to NO the values of all tags below this one will be ignored.
2 by steffen
Initial revision
1429
1430
SEARCHENGINE           = NO