Revision 838b8f69 Doxyfile.grapes

View differences:

Doxyfile.grapes
1
# Doxyfile 1.5.5
1
# Doxyfile 1.7.1
2 2

  
3 3
# This file describes the settings to be used by the documentation system
4 4
# doxygen (www.doxygen.org) for a project
......
14 14
# Project related configuration options
15 15
#---------------------------------------------------------------------------
16 16

  
17
# This tag specifies the encoding used for all characters in the config file 
18
# that follow. The default is UTF-8 which is also the encoding used for all 
19
# text before the first occurrence of this tag. Doxygen uses libiconv (or the 
20
# iconv built into libc) for the transcoding. See 
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 21
# http://www.gnu.org/software/libiconv for the list of possible encodings.
22 22

  
23 23
DOXYFILE_ENCODING      = UTF-8
24 24

  
25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26 26
# by quotes) that should identify the project.
27 27

  
28 28
PROJECT_NAME           = GRAPES
29 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 
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 32
# if some version control system is used.
33 33

  
34
PROJECT_NUMBER         = 
34
PROJECT_NUMBER         =
35 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 
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 39
# where doxygen was started. If left blank the current directory will be used.
40 40

  
41 41
OUTPUT_DIRECTORY       = doc/doxy
42 42

  
43
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
44
# 4096 sub-directories (in 2 levels) under the output directory of each output 
45
# format and will distribute the generated files over these directories. 
46
# Enabling this option can be useful when feeding doxygen a huge amount of 
47
# source files, where putting all generated files in the same directory would 
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 48
# otherwise cause performance problems for the file system.
49 49

  
50 50
CREATE_SUBDIRS         = NO
51 51

  
52
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
53
# documentation generated by doxygen is written. Doxygen will use this 
54
# information to generate all constant output in the proper language. 
55
# The default language is English, other supported languages are: 
56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
57
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, 
58
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), 
59
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, 
60
# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, 
61
# and Ukrainian.
52
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
53
# documentation generated by doxygen is written. Doxygen will use this
54
# information to generate all constant output in the proper language.
55
# The default language is English, other supported languages are:
56
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
57
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
58
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
59
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
60
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
62 62

  
63 63
OUTPUT_LANGUAGE        = English
64 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). 
65
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
66
# include brief member descriptions after the members that are listed in
67
# the file and class documentation (similar to JavaDoc).
68 68
# Set to NO to disable this.
69 69

  
70 70
BRIEF_MEMBER_DESC      = YES
71 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 
72
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
73
# the brief description of a member or function before the detailed description.
74
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75 75
# brief descriptions will be completely suppressed.
76 76

  
77 77
REPEAT_BRIEF           = YES
78 78

  
79
# This tag implements a quasi-intelligent brief description abbreviator 
80
# that is used to form the text in various listings. Each string 
81
# in this list, if found as the leading text of the brief description, will be 
82
# stripped from the text and the result after processing the whole list, is 
83
# used as the annotated text. Otherwise, the brief description is used as-is. 
84
# If left blank, the following values are used ("$name" is automatically 
85
# replaced with the name of the entity): "The $name class" "The $name widget" 
86
# "The $name file" "is" "provides" "specifies" "contains" 
79
# This tag implements a quasi-intelligent brief description abbreviator
80
# that is used to form the text in various listings. Each string
81
# in this list, if found as the leading text of the brief description, will be
82
# stripped from the text and the result after processing the whole list, is
83
# used as the annotated text. Otherwise, the brief description is used as-is.
84
# If left blank, the following values are used ("$name" is automatically
85
# replaced with the name of the entity): "The $name class" "The $name widget"
86
# "The $name file" "is" "provides" "specifies" "contains"
87 87
# "represents" "a" "an" "the"
88 88

  
89
ABBREVIATE_BRIEF       = 
89
ABBREVIATE_BRIEF       =
90 90

  
91
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
92
# Doxygen will generate a detailed section even if there is only a brief 
91
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92
# Doxygen will generate a detailed section even if there is only a brief
93 93
# description.
94 94

  
95 95
ALWAYS_DETAILED_SEC    = NO
96 96

  
97
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
98
# inherited members of a class in the documentation of that class as if those 
99
# members were ordinary class members. Constructors, destructors and assignment 
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 100
# operators of the base classes will not be shown.
101 101

  
102 102
INLINE_INHERITED_MEMB  = NO
103 103

  
104
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
105
# path before files name in the file list and in the header files. If set 
104
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
105
# path before files name in the file list and in the header files. If set
106 106
# to NO the shortest path that makes the file name unique will be used.
107 107

  
108 108
FULL_PATH_NAMES        = NO
109 109

  
110
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
111
# can be used to strip a user-defined part of the path. Stripping is 
112
# only done if one of the specified strings matches the left-hand part of 
113
# the path. The tag can be used to show relative paths in the file list. 
114
# If left blank the directory from which doxygen is run is used as the 
110
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
111
# can be used to strip a user-defined part of the path. Stripping is
112
# only done if one of the specified strings matches the left-hand part of
113
# the path. The tag can be used to show relative paths in the file list.
114
# If left blank the directory from which doxygen is run is used as the
115 115
# path to strip.
116 116

  
117
STRIP_FROM_PATH        = 
117
STRIP_FROM_PATH        =
118 118

  
119
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
120
# the path mentioned in the documentation of a class, which tells 
121
# the reader which header file to include in order to use a class. 
122
# If left blank only the name of the header file containing the class 
123
# definition is used. Otherwise one should specify the include paths that 
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 124
# are normally passed to the compiler using the -I flag.
125 125

  
126
STRIP_FROM_INC_PATH    = 
126
STRIP_FROM_INC_PATH    =
127 127

  
128
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
129
# (but less readable) file names. This can be useful is your file systems 
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 130
# doesn't support long names like on DOS, Mac, or CD-ROM.
131 131

  
132 132
SHORT_NAMES            = NO
133 133

  
134
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
135
# will interpret the first line (until the first dot) of a JavaDoc-style 
136
# comment as the brief description. If set to NO, the JavaDoc 
137
# comments will behave just like regular Qt-style comments 
134
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
135
# will interpret the first line (until the first dot) of a JavaDoc-style
136
# comment as the brief description. If set to NO, the JavaDoc
137
# comments will behave just like regular Qt-style comments
138 138
# (thus requiring an explicit @brief command for a brief description.)
139 139

  
140 140
JAVADOC_AUTOBRIEF      = NO
141 141

  
142
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
143
# interpret the first line (until the first dot) of a Qt-style 
144
# comment as the brief description. If set to NO, the comments 
145
# will behave just like regular Qt-style comments (thus requiring 
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 146
# an explicit \brief command for a brief description.)
147 147

  
148 148
QT_AUTOBRIEF           = NO
149 149

  
150
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
151
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
152
# comments) as a brief description. This used to be the default behaviour. 
153
# The new default is to treat a multi-line C++ comment block as a detailed 
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 154
# description. Set this tag to YES if you prefer the old behaviour instead.
155 155

  
156 156
MULTILINE_CPP_IS_BRIEF = NO
157 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 
158
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159
# member inherits the documentation from any documented member that it
167 160
# re-implements.
168 161

  
169 162
INHERIT_DOCS           = YES
170 163

  
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 
164
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
165
# a new page for each member. If set to NO, the documentation of a member will
173 166
# be part of the file/class/namespace that contains it.
174 167

  
175 168
SEPARATE_MEMBER_PAGES  = NO
176 169

  
177
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
170
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
178 171
# Doxygen uses this value to replace tabs by spaces in code fragments.
179 172

  
180 173
TAB_SIZE               = 8
181 174

  
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:". 
175
# This tag can be used to specify a number of aliases that acts
176
# as commands in the documentation. An alias has the form "name=value".
177
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
178
# put the command \sideeffect (or @sideeffect) in the documentation, which
179
# will result in a user-defined paragraph with heading "Side Effects:".
187 180
# You can put \n's in the value part of an alias to insert newlines.
188 181

  
189
ALIASES                = 
182
ALIASES                =
190 183

  
191
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
192
# sources only. Doxygen will then generate output that is more tailored for C. 
193
# For instance, some of the names that are used will be different. The list 
184
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
185
# sources only. Doxygen will then generate output that is more tailored for C.
186
# For instance, some of the names that are used will be different. The list
194 187
# of all members will be omitted, etc.
195 188

  
196 189
OPTIMIZE_OUTPUT_FOR_C  = YES
197 190

  
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 
191
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
192
# sources only. Doxygen will then generate output that is more tailored for
193
# Java. For instance, namespaces will be presented as packages, qualified
201 194
# scopes will look different, etc.
202 195

  
203 196
OPTIMIZE_OUTPUT_JAVA   = NO
204 197

  
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 
198
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
199
# sources only. Doxygen will then generate output that is more tailored for
207 200
# Fortran.
208 201

  
209 202
OPTIMIZE_FOR_FORTRAN   = NO
210 203

  
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 
204
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
205
# sources. Doxygen will then generate output that is tailored for
213 206
# VHDL.
214 207

  
215 208
OPTIMIZE_OUTPUT_VHDL   = NO
216 209

  
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 
210
# Doxygen selects the parser to use depending on the extension of the files it
211
# parses. With this tag you can assign which parser to use for a given extension.
212
# Doxygen has a built-in mapping, but you can override or extend it using this
213
# tag. The format is ext=language, where ext is a file extension, and language
214
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
215
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
216
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
217
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
218
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
219

  
220
EXTENSION_MAPPING      =
221

  
222
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
223
# to include (a tag file for) the STL sources as input, then you should
224
# set this tag to YES in order to let doxygen match functions declarations and
225
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
226
# func(std::string) {}). This also make the inheritance and collaboration
222 227
# diagrams that involve STL classes more complete and accurate.
223 228

  
224 229
BUILTIN_STL_SUPPORT    = NO
......
228 233

  
229 234
CPP_CLI_SUPPORT        = NO
230 235

  
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 
236
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
237
# Doxygen will parse them like normal C++ but will assume all classes use public
233 238
# instead of private inheritance when no explicit protection keyword is present.
234 239

  
235 240
SIP_SUPPORT            = NO
236 241

  
237
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
238
# tag is set to YES, then doxygen will reuse the documentation of the first 
239
# member in the group (if any) for the other members of the group. By default 
242
# For Microsoft's IDL there are propget and propput attributes to indicate getter
243
# and setter methods for a property. Setting this option to YES (the default)
244
# will make doxygen to replace the get and set methods by a property in the
245
# documentation. This will only work if the methods are indeed getting or
246
# setting a simple type. If this is not the case, or you want to show the
247
# methods anyway, you should set this option to NO.
248

  
249
IDL_PROPERTY_SUPPORT   = YES
250

  
251
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
252
# tag is set to YES, then doxygen will reuse the documentation of the first
253
# member in the group (if any) for the other members of the group. By default
240 254
# all members of a group must be documented explicitly.
241 255

  
242 256
DISTRIBUTE_GROUP_DOC   = NO
243 257

  
244
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
245
# the same type (for instance a group of public functions) to be put as a 
246
# subgroup of that type (e.g. under the Public Functions section). Set it to 
247
# NO to prevent subgrouping. Alternatively, this can be done per class using 
258
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
259
# the same type (for instance a group of public functions) to be put as a
260
# subgroup of that type (e.g. under the Public Functions section). Set it to
261
# NO to prevent subgrouping. Alternatively, this can be done per class using
248 262
# the \nosubgrouping command.
249 263

  
250 264
SUBGROUPING            = YES
251 265

  
252
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
253
# is documented as struct, union, or enum with the name of the typedef. So 
254
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
255
# with name TypeT. When disabled the typedef will appear as a member of a file, 
256
# namespace, or class. And the struct will be named TypeS. This can typically 
257
# be useful for C code in case the coding convention dictates that all compound 
266
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
267
# is documented as struct, union, or enum with the name of the typedef. So
268
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
269
# with name TypeT. When disabled the typedef will appear as a member of a file,
270
# namespace, or class. And the struct will be named TypeS. This can typically
271
# be useful for C code in case the coding convention dictates that all compound
258 272
# types are typedef'ed and only the typedef is referenced, never the tag name.
259 273

  
260 274
TYPEDEF_HIDES_STRUCT   = NO
261 275

  
276
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
277
# determine which symbols to keep in memory and which to flush to disk.
278
# When the cache is full, less often used symbols will be written to disk.
279
# For small to medium size projects (<1000 input files) the default value is
280
# probably good enough. For larger projects a too small cache size can cause
281
# doxygen to be busy swapping symbols to and from disk most of the time
282
# causing a significant performance penality.
283
# If the system has enough physical memory increasing the cache will improve the
284
# performance by keeping more symbols in memory. Note that the value works on
285
# a logarithmic scale so increasing the size by one will rougly double the
286
# memory usage. The cache size is given by this formula:
287
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
288
# corresponding to a cache size of 2^16 = 65536 symbols
289

  
290
SYMBOL_CACHE_SIZE      = 0
291

  
262 292
#---------------------------------------------------------------------------
263 293
# Build related configuration options
264 294
#---------------------------------------------------------------------------
265 295

  
266
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
267
# documentation are documented, even if no documentation was available. 
268
# Private class members and static file members will be hidden unless 
296
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
297
# documentation are documented, even if no documentation was available.
298
# Private class members and static file members will be hidden unless
269 299
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
270 300

  
271 301
EXTRACT_ALL            = NO
272 302

  
273
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
303
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
274 304
# will be included in the documentation.
275 305

  
276 306
EXTRACT_PRIVATE        = NO
277 307

  
278
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
308
# If the EXTRACT_STATIC tag is set to YES all static members of a file
279 309
# will be included in the documentation.
280 310

  
281 311
EXTRACT_STATIC         = NO
282 312

  
283
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
284
# defined locally in source files will be included in the documentation. 
313
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
314
# defined locally in source files will be included in the documentation.
285 315
# If set to NO only classes defined in header files are included.
286 316

  
287 317
EXTRACT_LOCAL_CLASSES  = YES
288 318

  
289
# This flag is only useful for Objective-C code. When set to YES local 
290
# methods, which are defined in the implementation section but not in 
291
# the interface are included in the documentation. 
319
# This flag is only useful for Objective-C code. When set to YES local
320
# methods, which are defined in the implementation section but not in
321
# the interface are included in the documentation.
292 322
# If set to NO (the default) only methods in the interface are included.
293 323

  
294 324
EXTRACT_LOCAL_METHODS  = NO
295 325

  
296
# If this flag is set to YES, the members of anonymous namespaces will be 
297
# extracted and appear in the documentation as a namespace called 
298
# 'anonymous_namespace{file}', where file will be replaced with the base 
299
# name of the file that contains the anonymous namespace. By default 
326
# If this flag is set to YES, the members of anonymous namespaces will be
327
# extracted and appear in the documentation as a namespace called
328
# 'anonymous_namespace{file}', where file will be replaced with the base
329
# name of the file that contains the anonymous namespace. By default
300 330
# anonymous namespace are hidden.
301 331

  
302 332
EXTRACT_ANON_NSPACES   = NO
303 333

  
304
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
305
# undocumented members of documented classes, files or namespaces. 
306
# If set to NO (the default) these members will be included in the 
307
# various overviews, but no documentation section is generated. 
334
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
335
# undocumented members of documented classes, files or namespaces.
336
# If set to NO (the default) these members will be included in the
337
# various overviews, but no documentation section is generated.
308 338
# This option has no effect if EXTRACT_ALL is enabled.
309 339

  
310 340
HIDE_UNDOC_MEMBERS     = NO
311 341

  
312
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
313
# undocumented classes that are normally visible in the class hierarchy. 
314
# If set to NO (the default) these classes will be included in the various 
342
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
343
# undocumented classes that are normally visible in the class hierarchy.
344
# If set to NO (the default) these classes will be included in the various
315 345
# overviews. This option has no effect if EXTRACT_ALL is enabled.
316 346

  
317 347
HIDE_UNDOC_CLASSES     = NO
318 348

  
319
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
320
# friend (class|struct|union) declarations. 
321
# If set to NO (the default) these declarations will be included in the 
349
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
350
# friend (class|struct|union) declarations.
351
# If set to NO (the default) these declarations will be included in the
322 352
# documentation.
323 353

  
324 354
HIDE_FRIEND_COMPOUNDS  = NO
325 355

  
326
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
327
# documentation blocks found inside the body of a function. 
328
# If set to NO (the default) these blocks will be appended to the 
356
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
357
# documentation blocks found inside the body of a function.
358
# If set to NO (the default) these blocks will be appended to the
329 359
# function's detailed documentation block.
330 360

  
331 361
HIDE_IN_BODY_DOCS      = NO
332 362

  
333
# The INTERNAL_DOCS tag determines if documentation 
334
# that is typed after a \internal command is included. If the tag is set 
335
# to NO (the default) then the documentation will be excluded. 
363
# The INTERNAL_DOCS tag determines if documentation
364
# that is typed after a \internal command is included. If the tag is set
365
# to NO (the default) then the documentation will be excluded.
336 366
# Set it to YES to include the internal documentation.
337 367

  
338 368
INTERNAL_DOCS          = NO
339 369

  
340
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
341
# file names in lower-case letters. If set to YES upper-case letters are also 
342
# allowed. This is useful if you have classes or files whose names only differ 
343
# in case and if your file system supports case sensitive file names. Windows 
370
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
371
# file names in lower-case letters. If set to YES upper-case letters are also
372
# allowed. This is useful if you have classes or files whose names only differ
373
# in case and if your file system supports case sensitive file names. Windows
344 374
# and Mac users are advised to set this option to NO.
345 375

  
346 376
CASE_SENSE_NAMES       = YES
347 377

  
348
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
349
# will show members with their full class and namespace scopes in the 
378
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
379
# will show members with their full class and namespace scopes in the
350 380
# documentation. If set to YES the scope will be hidden.
351 381

  
352 382
HIDE_SCOPE_NAMES       = NO
353 383

  
354
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
355
# will put a list of the files that are included by a file in the documentation 
384
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
385
# will put a list of the files that are included by a file in the documentation
356 386
# of that file.
357 387

  
358 388
SHOW_INCLUDE_FILES     = YES
359 389

  
360
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
390
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
391
# will list include files with double quotes in the documentation
392
# rather than with sharp brackets.
393

  
394
FORCE_LOCAL_INCLUDES   = NO
395

  
396
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
361 397
# is inserted in the documentation for inline members.
362 398

  
363 399
INLINE_INFO            = YES
364 400

  
365
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
366
# will sort the (detailed) documentation of file and class members 
367
# alphabetically by member name. If set to NO the members will appear in 
401
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
402
# will sort the (detailed) documentation of file and class members
403
# alphabetically by member name. If set to NO the members will appear in
368 404
# declaration order.
369 405

  
370 406
SORT_MEMBER_DOCS       = YES
371 407

  
372
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
373
# brief documentation of file, namespace and class members alphabetically 
374
# by member name. If set to NO (the default) the members will appear in 
408
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
409
# brief documentation of file, namespace and class members alphabetically
410
# by member name. If set to NO (the default) the members will appear in
375 411
# declaration order.
376 412

  
377 413
SORT_BRIEF_DOCS        = NO
378 414

  
379
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
380
# hierarchy of group names into alphabetical order. If set to NO (the default) 
415
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
416
# will sort the (brief and detailed) documentation of class members so that
417
# constructors and destructors are listed first. If set to NO (the default)
418
# the constructors will appear in the respective orders defined by
419
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
420
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
421
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
422

  
423
SORT_MEMBERS_CTORS_1ST = NO
424

  
425
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
426
# hierarchy of group names into alphabetical order. If set to NO (the default)
381 427
# the group names will appear in their defined order.
382 428

  
383 429
SORT_GROUP_NAMES       = NO
384 430

  
385
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
386
# sorted by fully-qualified names, including namespaces. If set to 
387
# NO (the default), the class list will be sorted only by class name, 
388
# not including the namespace part. 
431
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
432
# sorted by fully-qualified names, including namespaces. If set to
433
# NO (the default), the class list will be sorted only by class name,
434
# not including the namespace part.
389 435
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
390
# Note: This option applies only to the class list, not to the 
436
# Note: This option applies only to the class list, not to the
391 437
# alphabetical list.
392 438

  
393 439
SORT_BY_SCOPE_NAME     = NO
394 440

  
395
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
396
# disable (NO) the todo list. This list is created by putting \todo 
441
# The GENERATE_TODOLIST tag can be used to enable (YES) or
442
# disable (NO) the todo list. This list is created by putting \todo
397 443
# commands in the documentation.
398 444

  
399 445
GENERATE_TODOLIST      = YES
400 446

  
401
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
402
# disable (NO) the test list. This list is created by putting \test 
447
# The GENERATE_TESTLIST tag can be used to enable (YES) or
448
# disable (NO) the test list. This list is created by putting \test
403 449
# commands in the documentation.
404 450

  
405 451
GENERATE_TESTLIST      = YES
406 452

  
407
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
408
# disable (NO) the bug list. This list is created by putting \bug 
453
# The GENERATE_BUGLIST tag can be used to enable (YES) or
454
# disable (NO) the bug list. This list is created by putting \bug
409 455
# commands in the documentation.
410 456

  
411 457
GENERATE_BUGLIST       = YES
412 458

  
413
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
414
# disable (NO) the deprecated list. This list is created by putting 
459
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
460
# disable (NO) the deprecated list. This list is created by putting
415 461
# \deprecated commands in the documentation.
416 462

  
417 463
GENERATE_DEPRECATEDLIST= YES
418 464

  
419
# The ENABLED_SECTIONS tag can be used to enable conditional 
465
# The ENABLED_SECTIONS tag can be used to enable conditional
420 466
# documentation sections, marked by \if sectionname ... \endif.
421 467

  
422
ENABLED_SECTIONS       = 
468
ENABLED_SECTIONS       =
423 469

  
424
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
425
# the initial value of a variable or define consists of for it to appear in 
426
# the documentation. If the initializer consists of more lines than specified 
427
# here it will be hidden. Use a value of 0 to hide initializers completely. 
428
# The appearance of the initializer of individual variables and defines in the 
429
# documentation can be controlled using \showinitializer or \hideinitializer 
470
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
471
# the initial value of a variable or define consists of for it to appear in
472
# the documentation. If the initializer consists of more lines than specified
473
# here it will be hidden. Use a value of 0 to hide initializers completely.
474
# The appearance of the initializer of individual variables and defines in the
475
# documentation can be controlled using \showinitializer or \hideinitializer
430 476
# command in the documentation regardless of this setting.
431 477

  
432 478
MAX_INITIALIZER_LINES  = 30
433 479

  
434
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
435
# at the bottom of the documentation of classes and structs. If set to YES the 
480
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
481
# at the bottom of the documentation of classes and structs. If set to YES the
436 482
# list will mention the files that were used to generate the documentation.
437 483

  
438 484
SHOW_USED_FILES        = YES
439 485

  
440
# If the sources in your project are distributed over multiple directories 
441
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
486
# If the sources in your project are distributed over multiple directories
487
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
442 488
# in the documentation. The default is NO.
443 489

  
444 490
SHOW_DIRECTORIES       = NO
445 491

  
446
# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
447
# doxygen should invoke to get the current version for each file (typically from 
448
# the version control system). Doxygen will invoke the program by executing (via 
449
# popen()) the command <command> <input-file>, where <command> is the value of 
450
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
451
# provided by doxygen. Whatever the program writes to standard output 
492
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
493
# This will remove the Files entry from the Quick Index and from the
494
# Folder Tree View (if specified). The default is YES.
495

  
496
SHOW_FILES             = YES
497

  
498
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
499
# Namespaces page.
500
# This will remove the Namespaces entry from the Quick Index
501
# and from the Folder Tree View (if specified). The default is YES.
502

  
503
SHOW_NAMESPACES        = YES
504

  
505
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
506
# doxygen should invoke to get the current version for each file (typically from
507
# the version control system). Doxygen will invoke the program by executing (via
508
# popen()) the command <command> <input-file>, where <command> is the value of
509
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
510
# provided by doxygen. Whatever the program writes to standard output
452 511
# is used as the file version. See the manual for examples.
453 512

  
454
FILE_VERSION_FILTER    = 
513
FILE_VERSION_FILTER    =
514

  
515
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
516
# by doxygen. The layout file controls the global structure of the generated
517
# output files in an output format independent way. The create the layout file
518
# that represents doxygen's defaults, run doxygen with the -l option.
519
# You can optionally specify a file name after the option, if omitted
520
# DoxygenLayout.xml will be used as the name of the layout file.
521

  
522
LAYOUT_FILE            =
455 523

  
456 524
#---------------------------------------------------------------------------
457 525
# configuration options related to warning and progress messages
458 526
#---------------------------------------------------------------------------
459 527

  
460
# The QUIET tag can be used to turn on/off the messages that are generated 
528
# The QUIET tag can be used to turn on/off the messages that are generated
461 529
# by doxygen. Possible values are YES and NO. If left blank NO is used.
462 530

  
463 531
QUIET                  = NO
464 532

  
465
# The WARNINGS tag can be used to turn on/off the warning messages that are 
466
# generated by doxygen. Possible values are YES and NO. If left blank 
533
# The WARNINGS tag can be used to turn on/off the warning messages that are
534
# generated by doxygen. Possible values are YES and NO. If left blank
467 535
# NO is used.
468 536

  
469 537
WARNINGS               = YES
470 538

  
471
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
472
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
539
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
540
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
473 541
# automatically be disabled.
474 542

  
475 543
WARN_IF_UNDOCUMENTED   = YES
476 544

  
477
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
478
# potential errors in the documentation, such as not documenting some 
479
# parameters in a documented function, or documenting parameters that 
545
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
546
# potential errors in the documentation, such as not documenting some
547
# parameters in a documented function, or documenting parameters that
480 548
# don't exist or using markup commands wrongly.
481 549

  
482 550
WARN_IF_DOC_ERROR      = YES
483 551

  
484
# This WARN_NO_PARAMDOC option can be abled to get warnings for 
485
# functions that are documented, but have no documentation for their parameters 
486
# or return value. If set to NO (the default) doxygen will only warn about 
487
# wrong or incomplete parameter documentation, but not about the absence of 
552
# This WARN_NO_PARAMDOC option can be abled to get warnings for
553
# functions that are documented, but have no documentation for their parameters
554
# or return value. If set to NO (the default) doxygen will only warn about
555
# wrong or incomplete parameter documentation, but not about the absence of
488 556
# documentation.
489 557

  
490 558
WARN_NO_PARAMDOC       = NO
491 559

  
492
# The WARN_FORMAT tag determines the format of the warning messages that 
493
# doxygen can produce. The string should contain the $file, $line, and $text 
494
# tags, which will be replaced by the file and line number from which the 
495
# warning originated and the warning text. Optionally the format may contain 
496
# $version, which will be replaced by the version of the file (if it could 
560
# The WARN_FORMAT tag determines the format of the warning messages that
561
# doxygen can produce. The string should contain the $file, $line, and $text
562
# tags, which will be replaced by the file and line number from which the
563
# warning originated and the warning text. Optionally the format may contain
564
# $version, which will be replaced by the version of the file (if it could
497 565
# be obtained via FILE_VERSION_FILTER)
498 566

  
499 567
WARN_FORMAT            = "$file:$line: $text"
500 568

  
501
# The WARN_LOGFILE tag can be used to specify a file to which warning 
502
# and error messages should be written. If left blank the output is written 
569
# The WARN_LOGFILE tag can be used to specify a file to which warning
570
# and error messages should be written. If left blank the output is written
503 571
# to stderr.
504 572

  
505
WARN_LOGFILE           = 
573
WARN_LOGFILE           =
506 574

  
507 575
#---------------------------------------------------------------------------
508 576
# configuration options related to the input files
509 577
#---------------------------------------------------------------------------
510 578

  
511
# The INPUT tag can be used to specify the files and/or directories that contain 
512
# documented source files. You may enter file names like "myfile.cpp" or 
513
# directories like "/usr/src/myproject". Separate the files or directories 
579
# The INPUT tag can be used to specify the files and/or directories that contain
580
# documented source files. You may enter file names like "myfile.cpp" or
581
# directories like "/usr/src/myproject". Separate the files or directories
514 582
# with spaces.
515 583

  
516
INPUT                  = doc/grapes.doxy include/peersampler.h include/chunk.h include/chunkbuffer.h include/peerset.h include/scheduler_la.h include/trade_msg_ha.h include/net_helper.h include/tman.h include/trade_msg_la.h include/chunkidset.h include/scheduler_ha.h include/trade_sig_la.h include/trade_sig_ha.h include/chunkiser.h
517

  
518
#INPUT                  = include/topmanager.h
519

  
520
# This tag can be used to specify the character encoding of the source files 
521
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
522
# also the default input encoding. Doxygen uses libiconv (or the iconv built 
523
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
584
INPUT                  = doc/grapes.doxy \
585
                         include/peersampler.h \
586
                         include/chunk.h \
587
                         include/chunkbuffer.h \
588
                         include/peerset.h \
589
                         include/scheduler_la.h \
590
                         include/trade_msg_ha.h \
591
                         include/net_helper.h \
592
                         include/tman.h \
593
                         include/trade_msg_la.h \
594
                         include/chunkidset.h \
595
                         include/scheduler_ha.h \
596
                         include/trade_sig_la.h \
597
                         include/trade_sig_ha.h \
598
                         include/chunkiser.h
599

  
600
# This tag can be used to specify the character encoding of the source files
601
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
602
# also the default input encoding. Doxygen uses libiconv (or the iconv built
603
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
524 604
# the list of possible encodings.
525 605

  
526 606
INPUT_ENCODING         = UTF-8
527 607

  
528
# If the value of the INPUT tag contains directories, you can use the 
529
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
530
# and *.h) to filter out the source-files in the directories. If left 
531
# blank the following patterns are tested: 
532
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
608
# If the value of the INPUT tag contains directories, you can use the
609
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
610
# and *.h) to filter out the source-files in the directories. If left
611
# blank the following patterns are tested:
612
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
533 613
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
534 614

  
535
FILE_PATTERNS          = *.h *.doxy
615
FILE_PATTERNS          = *.h \
616
                         *.doxy
536 617

  
537
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
538
# should be searched for input files as well. Possible values are YES and NO. 
618
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
619
# should be searched for input files as well. Possible values are YES and NO.
539 620
# If left blank NO is used.
540 621

  
541 622
RECURSIVE              = NO
542 623

  
543
# The EXCLUDE tag can be used to specify files and/or directories that should 
544
# excluded from the INPUT source files. This way you can easily exclude a 
624
# The EXCLUDE tag can be used to specify files and/or directories that should
625
# excluded from the INPUT source files. This way you can easily exclude a
545 626
# subdirectory from a directory tree whose root is specified with the INPUT tag.
546 627

  
547
EXCLUDE                = 
628
EXCLUDE                =
548 629

  
549
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
550
# directories that are symbolic links (a Unix filesystem feature) are excluded 
630
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
631
# directories that are symbolic links (a Unix filesystem feature) are excluded
551 632
# from the input.
552 633

  
553 634
EXCLUDE_SYMLINKS       = NO
554 635

  
555
# If the value of the INPUT tag contains directories, you can use the 
556
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
557
# certain files from those directories. Note that the wildcards are matched 
558
# against the file with absolute path, so to exclude all test directories 
636
# If the value of the INPUT tag contains directories, you can use the
637
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
638
# certain files from those directories. Note that the wildcards are matched
639
# against the file with absolute path, so to exclude all test directories
559 640
# for example use the pattern */test/*
560 641

  
561
EXCLUDE_PATTERNS       = 
642
EXCLUDE_PATTERNS       =
562 643

  
563
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
564
# (namespaces, classes, functions, etc.) that should be excluded from the 
565
# output. The symbol name can be a fully qualified name, a word, or if the 
566
# wildcard * is used, a substring. Examples: ANamespace, AClass, 
644
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
645
# (namespaces, classes, functions, etc.) that should be excluded from the
646
# output. The symbol name can be a fully qualified name, a word, or if the
647
# wildcard * is used, a substring. Examples: ANamespace, AClass,
567 648
# AClass::ANamespace, ANamespace::*Test
568 649

  
569
EXCLUDE_SYMBOLS        = 
650
EXCLUDE_SYMBOLS        =
570 651

  
571
# The EXAMPLE_PATH tag can be used to specify one or more files or 
572
# directories that contain example code fragments that are included (see 
652
# The EXAMPLE_PATH tag can be used to specify one or more files or
653
# directories that contain example code fragments that are included (see
573 654
# the \include command).
574 655

  
575 656
EXAMPLE_PATH           = src/Tests
576 657

  
577
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
578
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
579
# and *.h) to filter out the source-files in the directories. If left 
658
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
659
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
660
# and *.h) to filter out the source-files in the directories. If left
580 661
# blank all files are included.
581 662

  
582
EXAMPLE_PATTERNS       = 
663
EXAMPLE_PATTERNS       =
583 664

  
584
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
585
# searched for input files to be used with the \include or \dontinclude 
586
# commands irrespective of the value of the RECURSIVE tag. 
665
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
666
# searched for input files to be used with the \include or \dontinclude
667
# commands irrespective of the value of the RECURSIVE tag.
587 668
# Possible values are YES and NO. If left blank NO is used.
588 669

  
589 670
EXAMPLE_RECURSIVE      = NO
590 671

  
591
# The IMAGE_PATH tag can be used to specify one or more files or 
592
# directories that contain image that are included in the documentation (see 
672
# The IMAGE_PATH tag can be used to specify one or more files or
673
# directories that contain image that are included in the documentation (see
593 674
# the \image command).
594 675

  
595
IMAGE_PATH             = 
676
IMAGE_PATH             =
596 677

  
597
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
598
# invoke to filter for each input file. Doxygen will invoke the filter program 
599
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
600
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
601
# input file. Doxygen will then use the output that the filter program writes 
602
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
678
# The INPUT_FILTER tag can be used to specify a program that doxygen should
679
# invoke to filter for each input file. Doxygen will invoke the filter program
680
# by executing (via popen()) the command <filter> <input-file>, where <filter>
681
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
682
# input file. Doxygen will then use the output that the filter program writes
683
# to standard output.
684
# If FILTER_PATTERNS is specified, this tag will be
603 685
# ignored.
604 686

  
605
INPUT_FILTER           = 
687
INPUT_FILTER           =
606 688

  
607
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
608
# basis.  Doxygen will compare the file name with each pattern and apply the 
609
# filter if there is a match.  The filters are a list of the form: 
610
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
611
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
689
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
690
# basis.
691
# Doxygen will compare the file name with each pattern and apply the
692
# filter if there is a match.
693
# The filters are a list of the form:
694
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
695
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
612 696
# is applied to all files.
613 697

  
614
FILTER_PATTERNS        = 
698
FILTER_PATTERNS        =
615 699

  
616
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
617
# INPUT_FILTER) will be used to filter the input files when producing source 
700
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
701
# INPUT_FILTER) will be used to filter the input files when producing source
618 702
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
619 703

  
620 704
FILTER_SOURCE_FILES    = NO
......
623 707
# configuration options related to source browsing
624 708
#---------------------------------------------------------------------------
625 709

  
626
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
627
# be generated. Documented entities will be cross-referenced with these sources. 
628
# Note: To get rid of all source code in the generated output, make sure also 
710
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
711
# be generated. Documented entities will be cross-referenced with these sources.
712
# Note: To get rid of all source code in the generated output, make sure also
629 713
# VERBATIM_HEADERS is set to NO.
630 714

  
631 715
SOURCE_BROWSER         = NO
632 716

  
633
# Setting the INLINE_SOURCES tag to YES will include the body 
717
# Setting the INLINE_SOURCES tag to YES will include the body
634 718
# of functions and classes directly in the documentation.
635 719

  
636 720
INLINE_SOURCES         = NO
637 721

  
638
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
639
# doxygen to hide any special comment blocks from generated source code 
722
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
723
# doxygen to hide any special comment blocks from generated source code
640 724
# fragments. Normal C and C++ comments will always remain visible.
641 725

  
642 726
STRIP_CODE_COMMENTS    = YES
643 727

  
644
# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
645
# then for each documented function all documented 
728
# If the REFERENCED_BY_RELATION tag is set to YES
729
# then for each documented function all documented
646 730
# functions referencing it will be listed.
647 731

  
648 732
REFERENCED_BY_RELATION = NO
649 733

  
650
# If the REFERENCES_RELATION tag is set to YES (the default) 
651
# then for each documented function all documented entities 
734
# If the REFERENCES_RELATION tag is set to YES
735
# then for each documented function all documented entities
652 736
# called/used by that function will be listed.
653 737

  
654 738
REFERENCES_RELATION    = NO
......
656 740
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
657 741
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
658 742
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
659
# link to the source code.  Otherwise they will link to the documentstion.
743
# link to the source code.
744
# Otherwise they will link to the documentation.
660 745

  
661 746
REFERENCES_LINK_SOURCE = YES
662 747

  
663
# If the USE_HTAGS tag is set to YES then the references to source code 
664
# will point to the HTML generated by the htags(1) tool instead of doxygen 
665
# built-in source browser. The htags tool is part of GNU's global source 
666
# tagging system (see http://www.gnu.org/software/global/global.html). You 
748
# If the USE_HTAGS tag is set to YES then the references to source code
749
# will point to the HTML generated by the htags(1) tool instead of doxygen
750
# built-in source browser. The htags tool is part of GNU's global source
751
# tagging system (see http://www.gnu.org/software/global/global.html). You
667 752
# will need version 4.8.6 or higher.
668 753

  
669 754
USE_HTAGS              = NO
670 755

  
671
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
672
# will generate a verbatim copy of the header file for each class for 
756
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
757
# will generate a verbatim copy of the header file for each class for
673 758
# which an include is specified. Set to NO to disable this.
674 759

  
675 760
VERBATIM_HEADERS       = YES
......
678 763
# configuration options related to the alphabetical class index
679 764
#---------------------------------------------------------------------------
680 765

  
681
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
682
# of all compounds will be generated. Enable this if the project 
766
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
767
# of all compounds will be generated. Enable this if the project
683 768
# contains a lot of classes, structs, unions or interfaces.
684 769

  
685 770
ALPHABETICAL_INDEX     = NO
686 771

  
687
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
688
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
772
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
773
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
689 774
# in which this list will be split (can be a number in the range [1..20])
690 775

  
691 776
COLS_IN_ALPHA_INDEX    = 5
692 777

  
693
# In case all classes in a project start with a common prefix, all 
694
# classes will be put under the same header in the alphabetical index. 
695
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
778
# In case all classes in a project start with a common prefix, all
779
# classes will be put under the same header in the alphabetical index.
780
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
696 781
# should be ignored while generating the index headers.
697 782

  
698
IGNORE_PREFIX          = 
783
IGNORE_PREFIX          =
699 784

  
700 785
#---------------------------------------------------------------------------
701 786
# configuration options related to the HTML output
702 787
#---------------------------------------------------------------------------
703 788

  
704
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
789
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
705 790
# generate HTML output.
706 791

  
707 792
GENERATE_HTML          = YES
708 793

  
709
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
710
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
794
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
795
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
711 796
# put in front of it. If left blank `html' will be used as the default path.
712 797

  
713 798
HTML_OUTPUT            = html
714 799

  
715
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
716
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
800
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
801
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
717 802
# doxygen will generate files with .html extension.
718 803

  
719 804
HTML_FILE_EXTENSION    = .html
720 805

  
721
# The HTML_HEADER tag can be used to specify a personal HTML header for 
722
# each generated HTML page. If it is left blank doxygen will generate a 
806
# The HTML_HEADER tag can be used to specify a personal HTML header for
807
# each generated HTML page. If it is left blank doxygen will generate a
723 808
# standard header.
724 809

  
725
HTML_HEADER            = 
810
HTML_HEADER            =
726 811

  
727
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
728
# each generated HTML page. If it is left blank doxygen will generate a 
812
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
813
# each generated HTML page. If it is left blank doxygen will generate a
729 814
# standard footer.
730 815

  
731
HTML_FOOTER            = 
816
HTML_FOOTER            =
732 817

  
733
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
734
# style sheet that is used by each HTML page. It can be used to 
735
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
736
# will generate a default style sheet. Note that doxygen will try to copy 
737
# the style sheet file to the HTML output directory, so don't put your own 
818
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
819
# style sheet that is used by each HTML page. It can be used to
820
# fine-tune the look of the HTML output. If the tag is left blank doxygen
821
# will generate a default style sheet. Note that doxygen will try to copy
822
# the style sheet file to the HTML output directory, so don't put your own
738 823
# stylesheet in the HTML output directory as well, or it will be erased!
739 824

  
740
HTML_STYLESHEET        = 
825
HTML_STYLESHEET        =
826

  
827
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
828
# Doxygen will adjust the colors in the stylesheet and background images
829
# according to this color. Hue is specified as an angle on a colorwheel,
830
# see http://en.wikipedia.org/wiki/Hue for more information.
831
# For instance the value 0 represents red, 60 is yellow, 120 is green,
832
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
833
# The allowed range is 0 to 359.
834

  
835
HTML_COLORSTYLE_HUE    = 220
836

  
837
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
838
# the colors in the HTML output. For a value of 0 the output will use
839
# grayscales only. A value of 255 will produce the most vivid colors.
840

  
841
HTML_COLORSTYLE_SAT    = 100
842

  
843
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
844
# the luminance component of the colors in the HTML output. Values below
845
# 100 gradually make the output lighter, whereas values above 100 make
846
# the output darker. The value divided by 100 is the actual gamma applied,
847
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
848
# and 100 does not change the gamma.
741 849

  
742
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
743
# files or namespaces will be aligned in HTML using tables. If set to 
850
HTML_COLORSTYLE_GAMMA  = 80
851

  
852
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
853
# page will contain the date and time when the page was generated. Setting
854
# this to NO can help when comparing the output of multiple runs.
855

  
856
HTML_TIMESTAMP         = YES
857

  
858
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
859
# files or namespaces will be aligned in HTML using tables. If set to
744 860
# NO a bullet list will be used.
745 861

  
746 862
HTML_ALIGN_MEMBERS     = YES
747 863

  
748
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
749
# will be generated that can be used as input for tools like the 
750
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
751
# of the generated HTML documentation.
864
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
865
# documentation will contain sections that can be hidden and shown after the
866
# page has loaded. For this to work a browser that supports
867
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
868
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
752 869

  
753
GENERATE_HTMLHELP      = NO
870
HTML_DYNAMIC_SECTIONS  = NO
754 871

  
755
# If the GENERATE_DOCSET tag is set to YES, additional index files 
756
# will be generated that can be used as input for Apple's Xcode 3 
757
# integrated development environment, introduced with OSX 10.5 (Leopard). 
758
# To create a documentation set, doxygen will generate a Makefile in the 
759
# HTML output directory. Running make will produce the docset in that 
760
# directory and running "make install" will install the docset in 
761
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
872
# If the GENERATE_DOCSET tag is set to YES, additional index files
873
# will be generated that can be used as input for Apple's Xcode 3
874
# integrated development environment, introduced with OSX 10.5 (Leopard).
875
# To create a documentation set, doxygen will generate a Makefile in the
876
# HTML output directory. Running make will produce the docset in that
877
# directory and running "make install" will install the docset in
878
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
762 879
# it at startup.
880
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
881
# for more information.
763 882

  
764 883
GENERATE_DOCSET        = NO
765 884

  
766
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
767
# feed. A documentation feed provides an umbrella under which multiple 
768
# documentation sets from a single provider (such as a company or product suite) 
885
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
886
# feed. A documentation feed provides an umbrella under which multiple
887
# documentation sets from a single provider (such as a company or product suite)
769 888
# can be grouped.
770 889

  
771 890
DOCSET_FEEDNAME        = "Doxygen generated docs"
772 891

  
773
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
774
# should uniquely identify the documentation set bundle. This should be a 
775
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
892
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
893
# should uniquely identify the documentation set bundle. This should be a
894
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
776 895
# will append .docset to the name.
777 896

  
778 897
DOCSET_BUNDLE_ID       = org.doxygen.Project
779 898

  
780
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
781
# documentation will contain sections that can be hidden and shown after the 
782
# page has loaded. For this to work a browser that supports 
783
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
784
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
899
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
900
# the documentation publisher. This should be a reverse domain-name style
901
# string, e.g. com.mycompany.MyDocSet.documentation.
785 902

  
786
HTML_DYNAMIC_SECTIONS  = NO
903
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
787 904

  
788
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
789
# be used to specify the file name of the resulting .chm file. You 
790
# can add a path in front of the file if the result should not be 
905
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
906

  
907
DOCSET_PUBLISHER_NAME  = Publisher
908

  
909
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
910
# will be generated that can be used as input for tools like the
911
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
912
# of the generated HTML documentation.
913

  
914
GENERATE_HTMLHELP      = NO
915

  
916
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
917
# be used to specify the file name of the resulting .chm file. You
918
# can add a path in front of the file if the result should not be
791 919
# written to the html output directory.
792 920

  
793
CHM_FILE               = 
921
CHM_FILE               =
794 922

  
795
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
796
# be used to specify the location (absolute path including file name) of 
797
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
923
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
924
# be used to specify the location (absolute path including file name) of
925
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
798 926
# the HTML help compiler on the generated index.hhp.
799 927

  
800
HHC_LOCATION           = 
928
HHC_LOCATION           =
801 929

  
802
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
803
# controls if a separate .chi index file is generated (YES) or that 
930
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
931
# controls if a separate .chi index file is generated (YES) or that
804 932
# it should be included in the master .chm file (NO).
805 933

  
806 934
GENERATE_CHI           = NO
807 935

  
808
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
809
# controls whether a binary table of contents is generated (YES) or a 
936
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
937
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
938
# content.
939

  
940
CHM_INDEX_ENCODING     =
941

  
942
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
943
# controls whether a binary table of contents is generated (YES) or a
810 944
# normal table of contents (NO) in the .chm file.
811 945

  
812 946
BINARY_TOC             = NO
813 947

  
814
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
948
# The TOC_EXPAND flag can be set to YES to add extra items for group members
815 949
# to the contents of the HTML help documentation and to the tree view.
816 950

  
817 951
TOC_EXPAND             = NO
818 952

  
819
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
820
# top of each HTML page. The value NO (the default) enables the index and 
953
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
954
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
955
# that can be used as input for Qt's qhelpgenerator to generate a
956
# Qt Compressed Help (.qch) of the generated HTML documentation.
957

  
958
GENERATE_QHP           = NO
959

  
960
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
961
# be used to specify the file name of the resulting .qch file.
962
# The path specified is relative to the HTML output folder.
963

  
964
QCH_FILE               =
965

  
966
# The QHP_NAMESPACE tag specifies the namespace to use when generating
967
# Qt Help Project output. For more information please see
968
# http://doc.trolltech.com/qthelpproject.html#namespace
969

  
970
QHP_NAMESPACE          = org.doxygen.Project
971

  
972
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
973
# Qt Help Project output. For more information please see
974
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
975

  
976
QHP_VIRTUAL_FOLDER     = doc
977

  
978
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
979
# add. For more information please see
980
# http://doc.trolltech.com/qthelpproject.html#custom-filters
981

  
982
QHP_CUST_FILTER_NAME   =
983

  
984
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
985
# custom filter to add. For more information please see
986
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
987
# Qt Help Project / Custom Filters</a>.
988

  
989
QHP_CUST_FILTER_ATTRS  =
990

  
991
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
992
# project's
993
# filter section matches.
994
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
995
# Qt Help Project / Filter Attributes</a>.
996

  
997
QHP_SECT_FILTER_ATTRS  =
998

  
999
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1000
# be used to specify the location of Qt's qhelpgenerator.
1001
# If non-empty doxygen will try to run qhelpgenerator on the generated
1002
# .qhp file.
1003

  
1004
QHG_LOCATION           =
1005

  
1006
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1007
#  will be generated, which together with the HTML files, form an Eclipse help
1008
# plugin. To install this plugin and make it available under the help contents
1009
# menu in Eclipse, the contents of the directory containing the HTML and XML
1010
# files needs to be copied into the plugins directory of eclipse. The name of
1011
# the directory within the plugins directory should be the same as
1012
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1013
# the help appears.
1014

  
1015
GENERATE_ECLIPSEHELP   = NO
1016

  
1017
# A unique identifier for the eclipse help plugin. When installing the plugin
1018
# the directory name containing the HTML and XML files should also have
1019
# this name.
1020

  
1021
ECLIPSE_DOC_ID         = org.doxygen.Project
1022

  
1023
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1024
# top of each HTML page. The value NO (the default) enables the index and
821 1025
# the value YES disables it.
822 1026

  
823 1027
DISABLE_INDEX          = NO
824 1028

  
825
# This tag can be used to set the number of enum values (range [1..20]) 
1029
# This tag can be used to set the number of enum values (range [1..20])
826 1030
# that doxygen will group on one line in the generated HTML documentation.
827 1031

  
828 1032
ENUM_VALUES_PER_LINE   = 4
829 1033

  
830
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
831
# generated containing a tree-like index structure (just like the one that 
832
# is generated for HTML Help). For this to work a browser that supports 
833
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
834
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
835
# probably better off using the HTML help feature.
1034
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1035
# structure should be generated to display hierarchical information.
1036
# If the tag value is set to YES, a side panel will be generated
1037
# containing a tree-like index structure (just like the one that
1038
# is generated for HTML Help). For this to work a browser that supports
1039
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1040
# Windows users are probably better off using the HTML help feature.
836 1041

  
837 1042
GENERATE_TREEVIEW      = NO
838 1043

  
839
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
840
# used to set the initial width (in pixels) of the frame in which the tree 
1044
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1045
# and Class Hierarchy pages using a tree view instead of an ordered list.
1046

  
1047
USE_INLINE_TREES       = NO
1048

  
1049
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1050
# used to set the initial width (in pixels) of the frame in which the tree
841 1051
# is shown.
842 1052

  
843 1053
TREEVIEW_WIDTH         = 250
844 1054

  
1055
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1056
# links to external symbols imported via tag files in a separate window.
1057

  
1058
EXT_LINKS_IN_WINDOW    = NO
1059

  
1060
# Use this tag to change the font size of Latex formulas included
1061
# as images in the HTML documentation. The default is 10. Note that
1062
# when you change the font size after a successful doxygen run you need
1063
# to manually remove any form_*.png images from the HTML output directory
1064
# to force them to be regenerated.
1065

  
1066
FORMULA_FONTSIZE       = 10
1067

  
1068
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1069
# generated for formulas are transparent PNGs. Transparent PNGs are
1070
# not supported properly for IE 6.0, but are supported on all modern browsers.
1071
# Note that when changing this option you need to delete any form_*.png files
1072
# in the HTML output before the changes have effect.
1073

  
1074
FORMULA_TRANSPARENT    = YES
1075

  
1076
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1077
# for the HTML output. The underlying search engine uses javascript
1078
# and DHTML and should work on any modern browser. Note that when using
1079
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1080
# (GENERATE_DOCSET) there is already a search function so this one should
1081
# typically be disabled. For large projects the javascript based search engine
1082
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1083

  
1084
SEARCHENGINE           = NO
1085

  
1086
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1087
# implemented using a PHP enabled web server instead of at the web client
1088
# using Javascript. Doxygen will generate the search PHP script and index
1089
# file to put on the web server. The advantage of the server
1090
# based approach is that it scales better to large projects and allows
1091
# full text search. The disadvances is that it is more difficult to setup
1092
# and does not have live searching capabilities.
1093

  
1094
SERVER_BASED_SEARCH    = NO
1095

  
845 1096
#---------------------------------------------------------------------------
846 1097
# configuration options related to the LaTeX output
847 1098
#---------------------------------------------------------------------------
848 1099

  
849
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
1100
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
850 1101
# generate Latex output.
851 1102

  
852 1103
GENERATE_LATEX         = YES
853 1104

  
854
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
855
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1105
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1106
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
856 1107
# put in front of it. If left blank `latex' will be used as the default path.
857 1108

  
858 1109
LATEX_OUTPUT           = latex
859 1110

  
860
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
1111
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
861 1112
# invoked. If left blank `latex' will be used as the default command name.
1113
# Note that when enabling USE_PDFLATEX this option is only used for
1114
# generating bitmaps for formulas in the HTML output, but not in the
1115
# Makefile that is written to the output directory.
862 1116

  
863 1117
LATEX_CMD_NAME         = latex
864 1118

  
865
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
866
# generate index for LaTeX. If left blank `makeindex' will be used as the 
1119
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1120
# generate index for LaTeX. If left blank `makeindex' will be used as the
867 1121
# default command name.
... This diff was truncated because it exceeds the maximum size that can be displayed.

Also available in: Unified diff