lmdb 0.6 → 0.6.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/ext/lmdb_ext/extconf.rb +7 -3
  3. data/ext/lmdb_ext/lmdb_ext.c +120 -110
  4. data/lib/lmdb/version.rb +1 -1
  5. data/lmdb.gemspec +4 -4
  6. data/{ext/lmdb_ext → vendor/libraries}/liblmdb/.gitignore +8 -0
  7. data/{ext/lmdb_ext → vendor/libraries}/liblmdb/COPYRIGHT +1 -1
  8. data/vendor/libraries/liblmdb/Doxyfile +1631 -0
  9. data/{ext/lmdb_ext → vendor/libraries}/liblmdb/LICENSE +0 -0
  10. data/vendor/libraries/liblmdb/Makefile +118 -0
  11. data/vendor/libraries/liblmdb/intro.doc +192 -0
  12. data/{ext/lmdb_ext → vendor/libraries}/liblmdb/lmdb.h +161 -61
  13. data/{ext/lmdb_ext → vendor/libraries}/liblmdb/mdb.c +3244 -1302
  14. data/vendor/libraries/liblmdb/mdb_copy.1 +61 -0
  15. data/vendor/libraries/liblmdb/mdb_copy.c +84 -0
  16. data/vendor/libraries/liblmdb/mdb_drop.1 +40 -0
  17. data/vendor/libraries/liblmdb/mdb_drop.c +135 -0
  18. data/vendor/libraries/liblmdb/mdb_dump.1 +81 -0
  19. data/vendor/libraries/liblmdb/mdb_dump.c +319 -0
  20. data/vendor/libraries/liblmdb/mdb_load.1 +84 -0
  21. data/vendor/libraries/liblmdb/mdb_load.c +492 -0
  22. data/vendor/libraries/liblmdb/mdb_stat.1 +70 -0
  23. data/vendor/libraries/liblmdb/mdb_stat.c +264 -0
  24. data/{ext/lmdb_ext → vendor/libraries}/liblmdb/midl.c +66 -5
  25. data/{ext/lmdb_ext → vendor/libraries}/liblmdb/midl.h +19 -5
  26. data/vendor/libraries/liblmdb/mtest.c +177 -0
  27. data/vendor/libraries/liblmdb/mtest2.c +124 -0
  28. data/vendor/libraries/liblmdb/mtest3.c +133 -0
  29. data/vendor/libraries/liblmdb/mtest4.c +168 -0
  30. data/vendor/libraries/liblmdb/mtest5.c +135 -0
  31. data/vendor/libraries/liblmdb/mtest6.c +141 -0
  32. data/vendor/libraries/liblmdb/sample-bdb.txt +73 -0
  33. data/vendor/libraries/liblmdb/sample-mdb.txt +62 -0
  34. data/vendor/libraries/liblmdb/tooltag +27 -0
  35. metadata +34 -14
  36. data/.gitignore +0 -15
  37. data/.travis.yml +0 -14
  38. data/ext/lmdb_ext/liblmdb/CHANGES +0 -112
@@ -0,0 +1,1631 @@
1
+ # Doxyfile 1.7.1
2
+
3
+ # This file describes the settings to be used by the documentation system
4
+ # doxygen (www.doxygen.org) for a project
5
+ #
6
+ # All text after a hash (#) is considered a comment and will be ignored
7
+ # The format is:
8
+ # TAG = value [value, ...]
9
+ # For lists items can also be appended using:
10
+ # TAG += value [value, ...]
11
+ # Values that contain spaces should be placed between quotes (" ")
12
+
13
+ #---------------------------------------------------------------------------
14
+ # Project related configuration options
15
+ #---------------------------------------------------------------------------
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
21
+ # http://www.gnu.org/software/libiconv for the list of possible encodings.
22
+
23
+ DOXYFILE_ENCODING = UTF-8
24
+
25
+ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26
+ # by quotes) that should identify the project.
27
+
28
+ PROJECT_NAME = LMDB
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
+
34
+ PROJECT_NUMBER =
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
+
41
+ OUTPUT_DIRECTORY =
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
48
+ # otherwise cause performance problems for the file system.
49
+
50
+ CREATE_SUBDIRS = NO
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, 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
+
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).
68
+ # Set to NO to disable this.
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
75
+ # brief descriptions will be completely suppressed.
76
+
77
+ REPEAT_BRIEF = YES
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"
87
+ # "represents" "a" "an" "the"
88
+
89
+ ABBREVIATE_BRIEF =
90
+
91
+ # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
92
+ # Doxygen will generate a detailed section even if there is only a brief
93
+ # description.
94
+
95
+ ALWAYS_DETAILED_SEC = NO
96
+
97
+ # If the 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.
101
+
102
+ INLINE_INHERITED_MEMB = NO
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
106
+ # to NO the shortest path that makes the file name unique will be used.
107
+
108
+ FULL_PATH_NAMES = YES
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
115
+ # path to strip.
116
+
117
+ STRIP_FROM_PATH =
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
124
+ # are normally passed to the compiler using the -I flag.
125
+
126
+ STRIP_FROM_INC_PATH =
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
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
137
+ # comments will behave just like regular Qt-style comments
138
+ # (thus requiring an explicit @brief command for a brief description.)
139
+
140
+ JAVADOC_AUTOBRIEF = NO
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
146
+ # an explicit \brief command for a brief description.)
147
+
148
+ QT_AUTOBRIEF = NO
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
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 INHERIT_DOCS tag is set to YES (the default) then an undocumented
159
+ # member inherits the documentation from any documented member that it
160
+ # re-implements.
161
+
162
+ INHERIT_DOCS = YES
163
+
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
166
+ # be part of the file/class/namespace that contains it.
167
+
168
+ SEPARATE_MEMBER_PAGES = NO
169
+
170
+ # The TAB_SIZE tag can be used to set the number of spaces in a tab.
171
+ # Doxygen uses this value to replace tabs by spaces in code fragments.
172
+
173
+ TAB_SIZE = 4
174
+
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:".
180
+ # You can put \n's in the value part of an alias to insert newlines.
181
+
182
+ ALIASES =
183
+
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
187
+ # of all members will be omitted, etc.
188
+
189
+ OPTIMIZE_OUTPUT_FOR_C = YES
190
+
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
194
+ # scopes will look different, etc.
195
+
196
+ OPTIMIZE_OUTPUT_JAVA = NO
197
+
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
200
+ # Fortran.
201
+
202
+ OPTIMIZE_FOR_FORTRAN = NO
203
+
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
206
+ # VHDL.
207
+
208
+ OPTIMIZE_OUTPUT_VHDL = NO
209
+
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
227
+ # diagrams that involve STL classes more complete and accurate.
228
+
229
+ BUILTIN_STL_SUPPORT = NO
230
+
231
+ # If you use Microsoft's C++/CLI language, you should set this option to YES to
232
+ # enable parsing support.
233
+
234
+ CPP_CLI_SUPPORT = NO
235
+
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
238
+ # instead of private inheritance when no explicit protection keyword is present.
239
+
240
+ SIP_SUPPORT = NO
241
+
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
254
+ # all members of a group must be documented explicitly.
255
+
256
+ DISTRIBUTE_GROUP_DOC = YES
257
+
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
262
+ # the \nosubgrouping command.
263
+
264
+ SUBGROUPING = YES
265
+
266
+ INLINE_GROUPED_CLASSES = YES
267
+ # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
268
+ # is documented as struct, union, or enum with the name of the typedef. So
269
+ # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
270
+ # with name TypeT. When disabled the typedef will appear as a member of a file,
271
+ # namespace, or class. And the struct will be named TypeS. This can typically
272
+ # be useful for C code in case the coding convention dictates that all compound
273
+ # types are typedef'ed and only the typedef is referenced, never the tag name.
274
+
275
+ TYPEDEF_HIDES_STRUCT = YES
276
+
277
+ # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
278
+ # determine which symbols to keep in memory and which to flush to disk.
279
+ # When the cache is full, less often used symbols will be written to disk.
280
+ # For small to medium size projects (<1000 input files) the default value is
281
+ # probably good enough. For larger projects a too small cache size can cause
282
+ # doxygen to be busy swapping symbols to and from disk most of the time
283
+ # causing a significant performance penality.
284
+ # If the system has enough physical memory increasing the cache will improve the
285
+ # performance by keeping more symbols in memory. Note that the value works on
286
+ # a logarithmic scale so increasing the size by one will rougly double the
287
+ # memory usage. The cache size is given by this formula:
288
+ # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
289
+ # corresponding to a cache size of 2^16 = 65536 symbols
290
+
291
+ SYMBOL_CACHE_SIZE = 0
292
+
293
+ #---------------------------------------------------------------------------
294
+ # Build related configuration options
295
+ #---------------------------------------------------------------------------
296
+
297
+ # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
298
+ # documentation are documented, even if no documentation was available.
299
+ # Private class members and static file members will be hidden unless
300
+ # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
301
+
302
+ EXTRACT_ALL = NO
303
+
304
+ # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
305
+ # will be included in the documentation.
306
+
307
+ EXTRACT_PRIVATE = NO
308
+
309
+ # If the EXTRACT_STATIC tag is set to YES all static members of a file
310
+ # will be included in the documentation.
311
+
312
+ EXTRACT_STATIC = YES
313
+
314
+ # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
315
+ # defined locally in source files will be included in the documentation.
316
+ # If set to NO only classes defined in header files are included.
317
+
318
+ EXTRACT_LOCAL_CLASSES = YES
319
+
320
+ # This flag is only useful for Objective-C code. When set to YES local
321
+ # methods, which are defined in the implementation section but not in
322
+ # the interface are included in the documentation.
323
+ # If set to NO (the default) only methods in the interface are included.
324
+
325
+ EXTRACT_LOCAL_METHODS = NO
326
+
327
+ # If this flag is set to YES, the members of anonymous namespaces will be
328
+ # extracted and appear in the documentation as a namespace called
329
+ # 'anonymous_namespace{file}', where file will be replaced with the base
330
+ # name of the file that contains the anonymous namespace. By default
331
+ # anonymous namespace are hidden.
332
+
333
+ EXTRACT_ANON_NSPACES = NO
334
+
335
+ # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
336
+ # undocumented members of documented classes, files or namespaces.
337
+ # If set to NO (the default) these members will be included in the
338
+ # various overviews, but no documentation section is generated.
339
+ # This option has no effect if EXTRACT_ALL is enabled.
340
+
341
+ HIDE_UNDOC_MEMBERS = NO
342
+
343
+ # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
344
+ # undocumented classes that are normally visible in the class hierarchy.
345
+ # If set to NO (the default) these classes will be included in the various
346
+ # overviews. This option has no effect if EXTRACT_ALL is enabled.
347
+
348
+ HIDE_UNDOC_CLASSES = NO
349
+
350
+ # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
351
+ # friend (class|struct|union) declarations.
352
+ # If set to NO (the default) these declarations will be included in the
353
+ # documentation.
354
+
355
+ HIDE_FRIEND_COMPOUNDS = NO
356
+
357
+ # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
358
+ # documentation blocks found inside the body of a function.
359
+ # If set to NO (the default) these blocks will be appended to the
360
+ # function's detailed documentation block.
361
+
362
+ HIDE_IN_BODY_DOCS = NO
363
+
364
+ # The INTERNAL_DOCS tag determines if documentation
365
+ # that is typed after a \internal command is included. If the tag is set
366
+ # to NO (the default) then the documentation will be excluded.
367
+ # Set it to YES to include the internal documentation.
368
+
369
+ INTERNAL_DOCS = NO
370
+
371
+ # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
372
+ # file names in lower-case letters. If set to YES upper-case letters are also
373
+ # allowed. This is useful if you have classes or files whose names only differ
374
+ # in case and if your file system supports case sensitive file names. Windows
375
+ # and Mac users are advised to set this option to NO.
376
+
377
+ CASE_SENSE_NAMES = YES
378
+
379
+ # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
380
+ # will show members with their full class and namespace scopes in the
381
+ # documentation. If set to YES the scope will be hidden.
382
+
383
+ HIDE_SCOPE_NAMES = NO
384
+
385
+ # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
386
+ # will put a list of the files that are included by a file in the documentation
387
+ # of that file.
388
+
389
+ SHOW_INCLUDE_FILES = YES
390
+
391
+ # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
392
+ # will list include files with double quotes in the documentation
393
+ # rather than with sharp brackets.
394
+
395
+ FORCE_LOCAL_INCLUDES = NO
396
+
397
+ # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
398
+ # is inserted in the documentation for inline members.
399
+
400
+ INLINE_INFO = YES
401
+
402
+ # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
403
+ # will sort the (detailed) documentation of file and class members
404
+ # alphabetically by member name. If set to NO the members will appear in
405
+ # declaration order.
406
+
407
+ SORT_MEMBER_DOCS = NO
408
+
409
+ # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
410
+ # brief documentation of file, namespace and class members alphabetically
411
+ # by member name. If set to NO (the default) the members will appear in
412
+ # declaration order.
413
+
414
+ SORT_BRIEF_DOCS = NO
415
+
416
+ # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
417
+ # will sort the (brief and detailed) documentation of class members so that
418
+ # constructors and destructors are listed first. If set to NO (the default)
419
+ # the constructors will appear in the respective orders defined by
420
+ # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
421
+ # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
422
+ # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
423
+
424
+ SORT_MEMBERS_CTORS_1ST = NO
425
+
426
+ # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
427
+ # hierarchy of group names into alphabetical order. If set to NO (the default)
428
+ # the group names will appear in their defined order.
429
+
430
+ SORT_GROUP_NAMES = NO
431
+
432
+ # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
433
+ # sorted by fully-qualified names, including namespaces. If set to
434
+ # NO (the default), the class list will be sorted only by class name,
435
+ # not including the namespace part.
436
+ # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
437
+ # Note: This option applies only to the class list, not to the
438
+ # alphabetical list.
439
+
440
+ SORT_BY_SCOPE_NAME = NO
441
+
442
+ # The GENERATE_TODOLIST tag can be used to enable (YES) or
443
+ # disable (NO) the todo list. This list is created by putting \todo
444
+ # commands in the documentation.
445
+
446
+ GENERATE_TODOLIST = YES
447
+
448
+ # The GENERATE_TESTLIST tag can be used to enable (YES) or
449
+ # disable (NO) the test list. This list is created by putting \test
450
+ # commands in the documentation.
451
+
452
+ GENERATE_TESTLIST = YES
453
+
454
+ # The GENERATE_BUGLIST tag can be used to enable (YES) or
455
+ # disable (NO) the bug list. This list is created by putting \bug
456
+ # commands in the documentation.
457
+
458
+ GENERATE_BUGLIST = YES
459
+
460
+ # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
461
+ # disable (NO) the deprecated list. This list is created by putting
462
+ # \deprecated commands in the documentation.
463
+
464
+ GENERATE_DEPRECATEDLIST= YES
465
+
466
+ # The ENABLED_SECTIONS tag can be used to enable conditional
467
+ # documentation sections, marked by \if sectionname ... \endif.
468
+
469
+ ENABLED_SECTIONS =
470
+
471
+ # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
472
+ # the initial value of a variable or define consists of for it to appear in
473
+ # the documentation. If the initializer consists of more lines than specified
474
+ # here it will be hidden. Use a value of 0 to hide initializers completely.
475
+ # The appearance of the initializer of individual variables and defines in the
476
+ # documentation can be controlled using \showinitializer or \hideinitializer
477
+ # command in the documentation regardless of this setting.
478
+
479
+ MAX_INITIALIZER_LINES = 30
480
+
481
+ # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
482
+ # at the bottom of the documentation of classes and structs. If set to YES the
483
+ # list will mention the files that were used to generate the documentation.
484
+
485
+ SHOW_USED_FILES = YES
486
+
487
+ # If the sources in your project are distributed over multiple directories
488
+ # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
489
+ # in the documentation. The default is NO.
490
+
491
+ SHOW_DIRECTORIES = NO
492
+
493
+ # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
494
+ # This will remove the Files entry from the Quick Index and from the
495
+ # Folder Tree View (if specified). The default is YES.
496
+
497
+ SHOW_FILES = YES
498
+
499
+ # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
500
+ # Namespaces page.
501
+ # This will remove the Namespaces entry from the Quick Index
502
+ # and from the Folder Tree View (if specified). The default is YES.
503
+
504
+ SHOW_NAMESPACES = YES
505
+
506
+ # The FILE_VERSION_FILTER tag can be used to specify a program or script that
507
+ # doxygen should invoke to get the current version for each file (typically from
508
+ # the version control system). Doxygen will invoke the program by executing (via
509
+ # popen()) the command <command> <input-file>, where <command> is the value of
510
+ # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
511
+ # provided by doxygen. Whatever the program writes to standard output
512
+ # is used as the file version. See the manual for examples.
513
+
514
+ FILE_VERSION_FILTER =
515
+
516
+ # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
517
+ # by doxygen. The layout file controls the global structure of the generated
518
+ # output files in an output format independent way. The create the layout file
519
+ # that represents doxygen's defaults, run doxygen with the -l option.
520
+ # You can optionally specify a file name after the option, if omitted
521
+ # DoxygenLayout.xml will be used as the name of the layout file.
522
+
523
+ LAYOUT_FILE =
524
+
525
+ #---------------------------------------------------------------------------
526
+ # configuration options related to warning and progress messages
527
+ #---------------------------------------------------------------------------
528
+
529
+ # The QUIET tag can be used to turn on/off the messages that are generated
530
+ # by doxygen. Possible values are YES and NO. If left blank NO is used.
531
+
532
+ QUIET = NO
533
+
534
+ # The WARNINGS tag can be used to turn on/off the warning messages that are
535
+ # generated by doxygen. Possible values are YES and NO. If left blank
536
+ # NO is used.
537
+
538
+ WARNINGS = YES
539
+
540
+ # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
541
+ # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
542
+ # automatically be disabled.
543
+
544
+ WARN_IF_UNDOCUMENTED = YES
545
+
546
+ # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
547
+ # potential errors in the documentation, such as not documenting some
548
+ # parameters in a documented function, or documenting parameters that
549
+ # don't exist or using markup commands wrongly.
550
+
551
+ WARN_IF_DOC_ERROR = YES
552
+
553
+ # This WARN_NO_PARAMDOC option can be abled to get warnings for
554
+ # functions that are documented, but have no documentation for their parameters
555
+ # or return value. If set to NO (the default) doxygen will only warn about
556
+ # wrong or incomplete parameter documentation, but not about the absence of
557
+ # documentation.
558
+
559
+ WARN_NO_PARAMDOC = NO
560
+
561
+ # The WARN_FORMAT tag determines the format of the warning messages that
562
+ # doxygen can produce. The string should contain the $file, $line, and $text
563
+ # tags, which will be replaced by the file and line number from which the
564
+ # warning originated and the warning text. Optionally the format may contain
565
+ # $version, which will be replaced by the version of the file (if it could
566
+ # be obtained via FILE_VERSION_FILTER)
567
+
568
+ WARN_FORMAT = "$file:$line: $text"
569
+
570
+ # The WARN_LOGFILE tag can be used to specify a file to which warning
571
+ # and error messages should be written. If left blank the output is written
572
+ # to stderr.
573
+
574
+ WARN_LOGFILE =
575
+
576
+ #---------------------------------------------------------------------------
577
+ # configuration options related to the input files
578
+ #---------------------------------------------------------------------------
579
+
580
+ # The INPUT tag can be used to specify the files and/or directories that contain
581
+ # documented source files. You may enter file names like "myfile.cpp" or
582
+ # directories like "/usr/src/myproject". Separate the files or directories
583
+ # with spaces.
584
+
585
+ INPUT = lmdb.h midl.h mdb.c midl.c intro.doc
586
+
587
+ # This tag can be used to specify the character encoding of the source files
588
+ # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
589
+ # also the default input encoding. Doxygen uses libiconv (or the iconv built
590
+ # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
591
+ # the list of possible encodings.
592
+
593
+ INPUT_ENCODING = UTF-8
594
+
595
+ # If the value of the INPUT tag contains directories, you can use the
596
+ # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
597
+ # and *.h) to filter out the source-files in the directories. If left
598
+ # blank the following patterns are tested:
599
+ # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
600
+ # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
601
+
602
+ FILE_PATTERNS =
603
+
604
+ # The RECURSIVE tag can be used to turn specify whether or not subdirectories
605
+ # should be searched for input files as well. Possible values are YES and NO.
606
+ # If left blank NO is used.
607
+
608
+ RECURSIVE = NO
609
+
610
+ # The EXCLUDE tag can be used to specify files and/or directories that should
611
+ # excluded from the INPUT source files. This way you can easily exclude a
612
+ # subdirectory from a directory tree whose root is specified with the INPUT tag.
613
+
614
+ EXCLUDE =
615
+
616
+ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
617
+ # directories that are symbolic links (a Unix filesystem feature) are excluded
618
+ # from the input.
619
+
620
+ EXCLUDE_SYMLINKS = NO
621
+
622
+ # If the value of the INPUT tag contains directories, you can use the
623
+ # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
624
+ # certain files from those directories. Note that the wildcards are matched
625
+ # against the file with absolute path, so to exclude all test directories
626
+ # for example use the pattern */test/*
627
+
628
+ EXCLUDE_PATTERNS =
629
+
630
+ # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
631
+ # (namespaces, classes, functions, etc.) that should be excluded from the
632
+ # output. The symbol name can be a fully qualified name, a word, or if the
633
+ # wildcard * is used, a substring. Examples: ANamespace, AClass,
634
+ # AClass::ANamespace, ANamespace::*Test
635
+
636
+ EXCLUDE_SYMBOLS =
637
+
638
+ # The EXAMPLE_PATH tag can be used to specify one or more files or
639
+ # directories that contain example code fragments that are included (see
640
+ # the \include command).
641
+
642
+ EXAMPLE_PATH =
643
+
644
+ # If the value of the EXAMPLE_PATH tag contains directories, you can use the
645
+ # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
646
+ # and *.h) to filter out the source-files in the directories. If left
647
+ # blank all files are included.
648
+
649
+ EXAMPLE_PATTERNS =
650
+
651
+ # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
652
+ # searched for input files to be used with the \include or \dontinclude
653
+ # commands irrespective of the value of the RECURSIVE tag.
654
+ # Possible values are YES and NO. If left blank NO is used.
655
+
656
+ EXAMPLE_RECURSIVE = NO
657
+
658
+ # The IMAGE_PATH tag can be used to specify one or more files or
659
+ # directories that contain image that are included in the documentation (see
660
+ # the \image command).
661
+
662
+ IMAGE_PATH =
663
+
664
+ # The INPUT_FILTER tag can be used to specify a program that doxygen should
665
+ # invoke to filter for each input file. Doxygen will invoke the filter program
666
+ # by executing (via popen()) the command <filter> <input-file>, where <filter>
667
+ # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
668
+ # input file. Doxygen will then use the output that the filter program writes
669
+ # to standard output.
670
+ # If FILTER_PATTERNS is specified, this tag will be
671
+ # ignored.
672
+
673
+ INPUT_FILTER =
674
+
675
+ # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
676
+ # basis.
677
+ # Doxygen will compare the file name with each pattern and apply the
678
+ # filter if there is a match.
679
+ # The filters are a list of the form:
680
+ # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
681
+ # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
682
+ # is applied to all files.
683
+
684
+ FILTER_PATTERNS =
685
+
686
+ # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
687
+ # INPUT_FILTER) will be used to filter the input files when producing source
688
+ # files to browse (i.e. when SOURCE_BROWSER is set to YES).
689
+
690
+ FILTER_SOURCE_FILES = NO
691
+
692
+ #---------------------------------------------------------------------------
693
+ # configuration options related to source browsing
694
+ #---------------------------------------------------------------------------
695
+
696
+ # If the SOURCE_BROWSER tag is set to YES then a list of source files will
697
+ # be generated. Documented entities will be cross-referenced with these sources.
698
+ # Note: To get rid of all source code in the generated output, make sure also
699
+ # VERBATIM_HEADERS is set to NO.
700
+
701
+ SOURCE_BROWSER = NO
702
+
703
+ # Setting the INLINE_SOURCES tag to YES will include the body
704
+ # of functions and classes directly in the documentation.
705
+
706
+ INLINE_SOURCES = NO
707
+
708
+ # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
709
+ # doxygen to hide any special comment blocks from generated source code
710
+ # fragments. Normal C and C++ comments will always remain visible.
711
+
712
+ STRIP_CODE_COMMENTS = YES
713
+
714
+ # If the REFERENCED_BY_RELATION tag is set to YES
715
+ # then for each documented function all documented
716
+ # functions referencing it will be listed.
717
+
718
+ REFERENCED_BY_RELATION = NO
719
+
720
+ # If the REFERENCES_RELATION tag is set to YES
721
+ # then for each documented function all documented entities
722
+ # called/used by that function will be listed.
723
+
724
+ REFERENCES_RELATION = NO
725
+
726
+ # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
727
+ # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
728
+ # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
729
+ # link to the source code.
730
+ # Otherwise they will link to the documentation.
731
+
732
+ REFERENCES_LINK_SOURCE = YES
733
+
734
+ # If the USE_HTAGS tag is set to YES then the references to source code
735
+ # will point to the HTML generated by the htags(1) tool instead of doxygen
736
+ # built-in source browser. The htags tool is part of GNU's global source
737
+ # tagging system (see http://www.gnu.org/software/global/global.html). You
738
+ # will need version 4.8.6 or higher.
739
+
740
+ USE_HTAGS = NO
741
+
742
+ # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
743
+ # will generate a verbatim copy of the header file for each class for
744
+ # which an include is specified. Set to NO to disable this.
745
+
746
+ VERBATIM_HEADERS = YES
747
+
748
+ #---------------------------------------------------------------------------
749
+ # configuration options related to the alphabetical class index
750
+ #---------------------------------------------------------------------------
751
+
752
+ # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
753
+ # of all compounds will be generated. Enable this if the project
754
+ # contains a lot of classes, structs, unions or interfaces.
755
+
756
+ ALPHABETICAL_INDEX = YES
757
+
758
+ # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
759
+ # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
760
+ # in which this list will be split (can be a number in the range [1..20])
761
+
762
+ COLS_IN_ALPHA_INDEX = 5
763
+
764
+ # In case all classes in a project start with a common prefix, all
765
+ # classes will be put under the same header in the alphabetical index.
766
+ # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
767
+ # should be ignored while generating the index headers.
768
+
769
+ IGNORE_PREFIX =
770
+
771
+ #---------------------------------------------------------------------------
772
+ # configuration options related to the HTML output
773
+ #---------------------------------------------------------------------------
774
+
775
+ # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
776
+ # generate HTML output.
777
+
778
+ GENERATE_HTML = YES
779
+
780
+ # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
781
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
782
+ # put in front of it. If left blank `html' will be used as the default path.
783
+
784
+ HTML_OUTPUT = html
785
+
786
+ # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
787
+ # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
788
+ # doxygen will generate files with .html extension.
789
+
790
+ HTML_FILE_EXTENSION = .html
791
+
792
+ # The HTML_HEADER tag can be used to specify a personal HTML header for
793
+ # each generated HTML page. If it is left blank doxygen will generate a
794
+ # standard header.
795
+
796
+ HTML_HEADER =
797
+
798
+ # The HTML_FOOTER tag can be used to specify a personal HTML footer for
799
+ # each generated HTML page. If it is left blank doxygen will generate a
800
+ # standard footer.
801
+
802
+ HTML_FOOTER =
803
+
804
+ # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
805
+ # style sheet that is used by each HTML page. It can be used to
806
+ # fine-tune the look of the HTML output. If the tag is left blank doxygen
807
+ # will generate a default style sheet. Note that doxygen will try to copy
808
+ # the style sheet file to the HTML output directory, so don't put your own
809
+ # stylesheet in the HTML output directory as well, or it will be erased!
810
+
811
+ HTML_STYLESHEET =
812
+
813
+ # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
814
+ # Doxygen will adjust the colors in the stylesheet and background images
815
+ # according to this color. Hue is specified as an angle on a colorwheel,
816
+ # see http://en.wikipedia.org/wiki/Hue for more information.
817
+ # For instance the value 0 represents red, 60 is yellow, 120 is green,
818
+ # 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
819
+ # The allowed range is 0 to 359.
820
+
821
+ HTML_COLORSTYLE_HUE = 220
822
+
823
+ # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
824
+ # the colors in the HTML output. For a value of 0 the output will use
825
+ # grayscales only. A value of 255 will produce the most vivid colors.
826
+
827
+ HTML_COLORSTYLE_SAT = 100
828
+
829
+ # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
830
+ # the luminance component of the colors in the HTML output. Values below
831
+ # 100 gradually make the output lighter, whereas values above 100 make
832
+ # the output darker. The value divided by 100 is the actual gamma applied,
833
+ # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
834
+ # and 100 does not change the gamma.
835
+
836
+ HTML_COLORSTYLE_GAMMA = 80
837
+
838
+ # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
839
+ # page will contain the date and time when the page was generated. Setting
840
+ # this to NO can help when comparing the output of multiple runs.
841
+
842
+ HTML_TIMESTAMP = YES
843
+
844
+ # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
845
+ # files or namespaces will be aligned in HTML using tables. If set to
846
+ # NO a bullet list will be used.
847
+
848
+ HTML_ALIGN_MEMBERS = YES
849
+
850
+ # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
851
+ # documentation will contain sections that can be hidden and shown after the
852
+ # page has loaded. For this to work a browser that supports
853
+ # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
854
+ # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
855
+
856
+ HTML_DYNAMIC_SECTIONS = NO
857
+
858
+ # If the GENERATE_DOCSET tag is set to YES, additional index files
859
+ # will be generated that can be used as input for Apple's Xcode 3
860
+ # integrated development environment, introduced with OSX 10.5 (Leopard).
861
+ # To create a documentation set, doxygen will generate a Makefile in the
862
+ # HTML output directory. Running make will produce the docset in that
863
+ # directory and running "make install" will install the docset in
864
+ # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
865
+ # it at startup.
866
+ # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
867
+ # for more information.
868
+
869
+ GENERATE_DOCSET = NO
870
+
871
+ # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
872
+ # feed. A documentation feed provides an umbrella under which multiple
873
+ # documentation sets from a single provider (such as a company or product suite)
874
+ # can be grouped.
875
+
876
+ DOCSET_FEEDNAME = "Doxygen generated docs"
877
+
878
+ # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
879
+ # should uniquely identify the documentation set bundle. This should be a
880
+ # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
881
+ # will append .docset to the name.
882
+
883
+ DOCSET_BUNDLE_ID = org.doxygen.Project
884
+
885
+ # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
886
+ # the documentation publisher. This should be a reverse domain-name style
887
+ # string, e.g. com.mycompany.MyDocSet.documentation.
888
+
889
+ DOCSET_PUBLISHER_ID = org.doxygen.Publisher
890
+
891
+ # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
892
+
893
+ DOCSET_PUBLISHER_NAME = Publisher
894
+
895
+ # If the GENERATE_HTMLHELP tag is set to YES, additional index files
896
+ # will be generated that can be used as input for tools like the
897
+ # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
898
+ # of the generated HTML documentation.
899
+
900
+ GENERATE_HTMLHELP = NO
901
+
902
+ # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
903
+ # be used to specify the file name of the resulting .chm file. You
904
+ # can add a path in front of the file if the result should not be
905
+ # written to the html output directory.
906
+
907
+ CHM_FILE =
908
+
909
+ # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
910
+ # be used to specify the location (absolute path including file name) of
911
+ # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
912
+ # the HTML help compiler on the generated index.hhp.
913
+
914
+ HHC_LOCATION =
915
+
916
+ # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
917
+ # controls if a separate .chi index file is generated (YES) or that
918
+ # it should be included in the master .chm file (NO).
919
+
920
+ GENERATE_CHI = NO
921
+
922
+ # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
923
+ # is used to encode HtmlHelp index (hhk), content (hhc) and project file
924
+ # content.
925
+
926
+ CHM_INDEX_ENCODING =
927
+
928
+ # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
929
+ # controls whether a binary table of contents is generated (YES) or a
930
+ # normal table of contents (NO) in the .chm file.
931
+
932
+ BINARY_TOC = NO
933
+
934
+ # The TOC_EXPAND flag can be set to YES to add extra items for group members
935
+ # to the contents of the HTML help documentation and to the tree view.
936
+
937
+ TOC_EXPAND = NO
938
+
939
+ # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
940
+ # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
941
+ # that can be used as input for Qt's qhelpgenerator to generate a
942
+ # Qt Compressed Help (.qch) of the generated HTML documentation.
943
+
944
+ GENERATE_QHP = NO
945
+
946
+ # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
947
+ # be used to specify the file name of the resulting .qch file.
948
+ # The path specified is relative to the HTML output folder.
949
+
950
+ QCH_FILE =
951
+
952
+ # The QHP_NAMESPACE tag specifies the namespace to use when generating
953
+ # Qt Help Project output. For more information please see
954
+ # http://doc.trolltech.com/qthelpproject.html#namespace
955
+
956
+ QHP_NAMESPACE = org.doxygen.Project
957
+
958
+ # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
959
+ # Qt Help Project output. For more information please see
960
+ # http://doc.trolltech.com/qthelpproject.html#virtual-folders
961
+
962
+ QHP_VIRTUAL_FOLDER = doc
963
+
964
+ # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
965
+ # add. For more information please see
966
+ # http://doc.trolltech.com/qthelpproject.html#custom-filters
967
+
968
+ QHP_CUST_FILTER_NAME =
969
+
970
+ # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
971
+ # custom filter to add. For more information please see
972
+ # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
973
+ # Qt Help Project / Custom Filters</a>.
974
+
975
+ QHP_CUST_FILTER_ATTRS =
976
+
977
+ # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
978
+ # project's
979
+ # filter section matches.
980
+ # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
981
+ # Qt Help Project / Filter Attributes</a>.
982
+
983
+ QHP_SECT_FILTER_ATTRS =
984
+
985
+ # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
986
+ # be used to specify the location of Qt's qhelpgenerator.
987
+ # If non-empty doxygen will try to run qhelpgenerator on the generated
988
+ # .qhp file.
989
+
990
+ QHG_LOCATION =
991
+
992
+ # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
993
+ # will be generated, which together with the HTML files, form an Eclipse help
994
+ # plugin. To install this plugin and make it available under the help contents
995
+ # menu in Eclipse, the contents of the directory containing the HTML and XML
996
+ # files needs to be copied into the plugins directory of eclipse. The name of
997
+ # the directory within the plugins directory should be the same as
998
+ # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
999
+ # the help appears.
1000
+
1001
+ GENERATE_ECLIPSEHELP = NO
1002
+
1003
+ # A unique identifier for the eclipse help plugin. When installing the plugin
1004
+ # the directory name containing the HTML and XML files should also have
1005
+ # this name.
1006
+
1007
+ ECLIPSE_DOC_ID = org.doxygen.Project
1008
+
1009
+ # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1010
+ # top of each HTML page. The value NO (the default) enables the index and
1011
+ # the value YES disables it.
1012
+
1013
+ DISABLE_INDEX = NO
1014
+
1015
+ # This tag can be used to set the number of enum values (range [1..20])
1016
+ # that doxygen will group on one line in the generated HTML documentation.
1017
+
1018
+ ENUM_VALUES_PER_LINE = 4
1019
+
1020
+ # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1021
+ # structure should be generated to display hierarchical information.
1022
+ # If the tag value is set to YES, a side panel will be generated
1023
+ # containing a tree-like index structure (just like the one that
1024
+ # is generated for HTML Help). For this to work a browser that supports
1025
+ # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1026
+ # Windows users are probably better off using the HTML help feature.
1027
+
1028
+ GENERATE_TREEVIEW = NO
1029
+
1030
+ # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1031
+ # and Class Hierarchy pages using a tree view instead of an ordered list.
1032
+
1033
+ USE_INLINE_TREES = NO
1034
+
1035
+ # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1036
+ # used to set the initial width (in pixels) of the frame in which the tree
1037
+ # is shown.
1038
+
1039
+ TREEVIEW_WIDTH = 250
1040
+
1041
+ # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1042
+ # links to external symbols imported via tag files in a separate window.
1043
+
1044
+ EXT_LINKS_IN_WINDOW = NO
1045
+
1046
+ # Use this tag to change the font size of Latex formulas included
1047
+ # as images in the HTML documentation. The default is 10. Note that
1048
+ # when you change the font size after a successful doxygen run you need
1049
+ # to manually remove any form_*.png images from the HTML output directory
1050
+ # to force them to be regenerated.
1051
+
1052
+ FORMULA_FONTSIZE = 10
1053
+
1054
+ # Use the FORMULA_TRANPARENT tag to determine whether or not the images
1055
+ # generated for formulas are transparent PNGs. Transparent PNGs are
1056
+ # not supported properly for IE 6.0, but are supported on all modern browsers.
1057
+ # Note that when changing this option you need to delete any form_*.png files
1058
+ # in the HTML output before the changes have effect.
1059
+
1060
+ FORMULA_TRANSPARENT = YES
1061
+
1062
+ # When the SEARCHENGINE tag is enabled doxygen will generate a search box
1063
+ # for the HTML output. The underlying search engine uses javascript
1064
+ # and DHTML and should work on any modern browser. Note that when using
1065
+ # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1066
+ # (GENERATE_DOCSET) there is already a search function so this one should
1067
+ # typically be disabled. For large projects the javascript based search engine
1068
+ # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1069
+
1070
+ SEARCHENGINE = YES
1071
+
1072
+ # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1073
+ # implemented using a PHP enabled web server instead of at the web client
1074
+ # using Javascript. Doxygen will generate the search PHP script and index
1075
+ # file to put on the web server. The advantage of the server
1076
+ # based approach is that it scales better to large projects and allows
1077
+ # full text search. The disadvances is that it is more difficult to setup
1078
+ # and does not have live searching capabilities.
1079
+
1080
+ SERVER_BASED_SEARCH = NO
1081
+
1082
+ #---------------------------------------------------------------------------
1083
+ # configuration options related to the LaTeX output
1084
+ #---------------------------------------------------------------------------
1085
+
1086
+ # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1087
+ # generate Latex output.
1088
+
1089
+ GENERATE_LATEX = NO
1090
+
1091
+ # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1092
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1093
+ # put in front of it. If left blank `latex' will be used as the default path.
1094
+
1095
+ LATEX_OUTPUT = latex
1096
+
1097
+ # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1098
+ # invoked. If left blank `latex' will be used as the default command name.
1099
+ # Note that when enabling USE_PDFLATEX this option is only used for
1100
+ # generating bitmaps for formulas in the HTML output, but not in the
1101
+ # Makefile that is written to the output directory.
1102
+
1103
+ LATEX_CMD_NAME = latex
1104
+
1105
+ # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1106
+ # generate index for LaTeX. If left blank `makeindex' will be used as the
1107
+ # default command name.
1108
+
1109
+ MAKEINDEX_CMD_NAME = makeindex
1110
+
1111
+ # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1112
+ # LaTeX documents. This may be useful for small projects and may help to
1113
+ # save some trees in general.
1114
+
1115
+ COMPACT_LATEX = NO
1116
+
1117
+ # The PAPER_TYPE tag can be used to set the paper type that is used
1118
+ # by the printer. Possible values are: a4, a4wide, letter, legal and
1119
+ # executive. If left blank a4wide will be used.
1120
+
1121
+ PAPER_TYPE = a4wide
1122
+
1123
+ # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1124
+ # packages that should be included in the LaTeX output.
1125
+
1126
+ EXTRA_PACKAGES =
1127
+
1128
+ # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1129
+ # the generated latex document. The header should contain everything until
1130
+ # the first chapter. If it is left blank doxygen will generate a
1131
+ # standard header. Notice: only use this tag if you know what you are doing!
1132
+
1133
+ LATEX_HEADER =
1134
+
1135
+ # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1136
+ # is prepared for conversion to pdf (using ps2pdf). The pdf file will
1137
+ # contain links (just like the HTML output) instead of page references
1138
+ # This makes the output suitable for online browsing using a pdf viewer.
1139
+
1140
+ PDF_HYPERLINKS = YES
1141
+
1142
+ # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1143
+ # plain latex in the generated Makefile. Set this option to YES to get a
1144
+ # higher quality PDF documentation.
1145
+
1146
+ USE_PDFLATEX = YES
1147
+
1148
+ # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1149
+ # command to the generated LaTeX files. This will instruct LaTeX to keep
1150
+ # running if errors occur, instead of asking the user for help.
1151
+ # This option is also used when generating formulas in HTML.
1152
+
1153
+ LATEX_BATCHMODE = NO
1154
+
1155
+ # If LATEX_HIDE_INDICES is set to YES then doxygen will not
1156
+ # include the index chapters (such as File Index, Compound Index, etc.)
1157
+ # in the output.
1158
+
1159
+ LATEX_HIDE_INDICES = NO
1160
+
1161
+ # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1162
+ # source code with syntax highlighting in the LaTeX output.
1163
+ # Note that which sources are shown also depends on other settings
1164
+ # such as SOURCE_BROWSER.
1165
+
1166
+ LATEX_SOURCE_CODE = NO
1167
+
1168
+ #---------------------------------------------------------------------------
1169
+ # configuration options related to the RTF output
1170
+ #---------------------------------------------------------------------------
1171
+
1172
+ # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1173
+ # The RTF output is optimized for Word 97 and may not look very pretty with
1174
+ # other RTF readers or editors.
1175
+
1176
+ GENERATE_RTF = NO
1177
+
1178
+ # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1179
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1180
+ # put in front of it. If left blank `rtf' will be used as the default path.
1181
+
1182
+ RTF_OUTPUT = rtf
1183
+
1184
+ # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1185
+ # RTF documents. This may be useful for small projects and may help to
1186
+ # save some trees in general.
1187
+
1188
+ COMPACT_RTF = NO
1189
+
1190
+ # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1191
+ # will contain hyperlink fields. The RTF file will
1192
+ # contain links (just like the HTML output) instead of page references.
1193
+ # This makes the output suitable for online browsing using WORD or other
1194
+ # programs which support those fields.
1195
+ # Note: wordpad (write) and others do not support links.
1196
+
1197
+ RTF_HYPERLINKS = NO
1198
+
1199
+ # Load stylesheet definitions from file. Syntax is similar to doxygen's
1200
+ # config file, i.e. a series of assignments. You only have to provide
1201
+ # replacements, missing definitions are set to their default value.
1202
+
1203
+ RTF_STYLESHEET_FILE =
1204
+
1205
+ # Set optional variables used in the generation of an rtf document.
1206
+ # Syntax is similar to doxygen's config file.
1207
+
1208
+ RTF_EXTENSIONS_FILE =
1209
+
1210
+ #---------------------------------------------------------------------------
1211
+ # configuration options related to the man page output
1212
+ #---------------------------------------------------------------------------
1213
+
1214
+ # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1215
+ # generate man pages
1216
+
1217
+ GENERATE_MAN = YES
1218
+
1219
+ # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1220
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1221
+ # put in front of it. If left blank `man' will be used as the default path.
1222
+
1223
+ MAN_OUTPUT = man
1224
+
1225
+ # The MAN_EXTENSION tag determines the extension that is added to
1226
+ # the generated man pages (default is the subroutine's section .3)
1227
+
1228
+ MAN_EXTENSION = .3
1229
+
1230
+ # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1231
+ # then it will generate one additional man file for each entity
1232
+ # documented in the real man page(s). These additional files
1233
+ # only source the real man page, but without them the man command
1234
+ # would be unable to find the correct page. The default is NO.
1235
+
1236
+ MAN_LINKS = NO
1237
+
1238
+ #---------------------------------------------------------------------------
1239
+ # configuration options related to the XML output
1240
+ #---------------------------------------------------------------------------
1241
+
1242
+ # If the GENERATE_XML tag is set to YES Doxygen will
1243
+ # generate an XML file that captures the structure of
1244
+ # the code including all documentation.
1245
+
1246
+ GENERATE_XML = NO
1247
+
1248
+ # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1249
+ # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1250
+ # put in front of it. If left blank `xml' will be used as the default path.
1251
+
1252
+ XML_OUTPUT = xml
1253
+
1254
+ # The XML_SCHEMA tag can be used to specify an XML schema,
1255
+ # which can be used by a validating XML parser to check the
1256
+ # syntax of the XML files.
1257
+
1258
+ XML_SCHEMA =
1259
+
1260
+ # The XML_DTD tag can be used to specify an XML DTD,
1261
+ # which can be used by a validating XML parser to check the
1262
+ # syntax of the XML files.
1263
+
1264
+ XML_DTD =
1265
+
1266
+ # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1267
+ # dump the program listings (including syntax highlighting
1268
+ # and cross-referencing information) to the XML output. Note that
1269
+ # enabling this will significantly increase the size of the XML output.
1270
+
1271
+ XML_PROGRAMLISTING = YES
1272
+
1273
+ #---------------------------------------------------------------------------
1274
+ # configuration options for the AutoGen Definitions output
1275
+ #---------------------------------------------------------------------------
1276
+
1277
+ # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1278
+ # generate an AutoGen Definitions (see autogen.sf.net) file
1279
+ # that captures the structure of the code including all
1280
+ # documentation. Note that this feature is still experimental
1281
+ # and incomplete at the moment.
1282
+
1283
+ GENERATE_AUTOGEN_DEF = NO
1284
+
1285
+ #---------------------------------------------------------------------------
1286
+ # configuration options related to the Perl module output
1287
+ #---------------------------------------------------------------------------
1288
+
1289
+ # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1290
+ # generate a Perl module file that captures the structure of
1291
+ # the code including all documentation. Note that this
1292
+ # feature is still experimental and incomplete at the
1293
+ # moment.
1294
+
1295
+ GENERATE_PERLMOD = NO
1296
+
1297
+ # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1298
+ # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1299
+ # to generate PDF and DVI output from the Perl module output.
1300
+
1301
+ PERLMOD_LATEX = NO
1302
+
1303
+ # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1304
+ # nicely formatted so it can be parsed by a human reader.
1305
+ # This is useful
1306
+ # if you want to understand what is going on.
1307
+ # On the other hand, if this
1308
+ # tag is set to NO the size of the Perl module output will be much smaller
1309
+ # and Perl will parse it just the same.
1310
+
1311
+ PERLMOD_PRETTY = YES
1312
+
1313
+ # The names of the make variables in the generated doxyrules.make file
1314
+ # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1315
+ # This is useful so different doxyrules.make files included by the same
1316
+ # Makefile don't overwrite each other's variables.
1317
+
1318
+ PERLMOD_MAKEVAR_PREFIX =
1319
+
1320
+ #---------------------------------------------------------------------------
1321
+ # Configuration options related to the preprocessor
1322
+ #---------------------------------------------------------------------------
1323
+
1324
+ # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1325
+ # evaluate all C-preprocessor directives found in the sources and include
1326
+ # files.
1327
+
1328
+ ENABLE_PREPROCESSING = YES
1329
+
1330
+ # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1331
+ # names in the source code. If set to NO (the default) only conditional
1332
+ # compilation will be performed. Macro expansion can be done in a controlled
1333
+ # way by setting EXPAND_ONLY_PREDEF to YES.
1334
+
1335
+ MACRO_EXPANSION = NO
1336
+
1337
+ # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1338
+ # then the macro expansion is limited to the macros specified with the
1339
+ # PREDEFINED and EXPAND_AS_DEFINED tags.
1340
+
1341
+ EXPAND_ONLY_PREDEF = NO
1342
+
1343
+ # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1344
+ # in the INCLUDE_PATH (see below) will be search if a #include is found.
1345
+
1346
+ SEARCH_INCLUDES = YES
1347
+
1348
+ # The INCLUDE_PATH tag can be used to specify one or more directories that
1349
+ # contain include files that are not input files but should be processed by
1350
+ # the preprocessor.
1351
+
1352
+ INCLUDE_PATH =
1353
+
1354
+ # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1355
+ # patterns (like *.h and *.hpp) to filter out the header-files in the
1356
+ # directories. If left blank, the patterns specified with FILE_PATTERNS will
1357
+ # be used.
1358
+
1359
+ INCLUDE_FILE_PATTERNS =
1360
+
1361
+ # The PREDEFINED tag can be used to specify one or more macro names that
1362
+ # are defined before the preprocessor is started (similar to the -D option of
1363
+ # gcc). The argument of the tag is a list of macros of the form: name
1364
+ # or name=definition (no spaces). If the definition and the = are
1365
+ # omitted =1 is assumed. To prevent a macro definition from being
1366
+ # undefined via #undef or recursively expanded use the := operator
1367
+ # instead of the = operator.
1368
+
1369
+ PREDEFINED = DEBUG=2 __GNUC__=1
1370
+
1371
+ # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1372
+ # this tag can be used to specify a list of macro names that should be expanded.
1373
+ # The macro definition that is found in the sources will be used.
1374
+ # Use the PREDEFINED tag if you want to use a different macro definition.
1375
+
1376
+ EXPAND_AS_DEFINED =
1377
+
1378
+ # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1379
+ # doxygen's preprocessor will remove all function-like macros that are alone
1380
+ # on a line, have an all uppercase name, and do not end with a semicolon. Such
1381
+ # function macros are typically used for boiler-plate code, and will confuse
1382
+ # the parser if not removed.
1383
+
1384
+ SKIP_FUNCTION_MACROS = YES
1385
+
1386
+ #---------------------------------------------------------------------------
1387
+ # Configuration::additions related to external references
1388
+ #---------------------------------------------------------------------------
1389
+
1390
+ # The TAGFILES option can be used to specify one or more tagfiles.
1391
+ # Optionally an initial location of the external documentation
1392
+ # can be added for each tagfile. The format of a tag file without
1393
+ # this location is as follows:
1394
+ #
1395
+ # TAGFILES = file1 file2 ...
1396
+ # Adding location for the tag files is done as follows:
1397
+ #
1398
+ # TAGFILES = file1=loc1 "file2 = loc2" ...
1399
+ # where "loc1" and "loc2" can be relative or absolute paths or
1400
+ # URLs. If a location is present for each tag, the installdox tool
1401
+ # does not have to be run to correct the links.
1402
+ # Note that each tag file must have a unique name
1403
+ # (where the name does NOT include the path)
1404
+ # If a tag file is not located in the directory in which doxygen
1405
+ # is run, you must also specify the path to the tagfile here.
1406
+
1407
+ TAGFILES = tooltag=./man1
1408
+
1409
+ # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1410
+ # a tag file that is based on the input files it reads.
1411
+
1412
+ GENERATE_TAGFILE =
1413
+
1414
+ # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1415
+ # in the class index. If set to NO only the inherited external classes
1416
+ # will be listed.
1417
+
1418
+ ALLEXTERNALS = NO
1419
+
1420
+ # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1421
+ # in the modules index. If set to NO, only the current project's groups will
1422
+ # be listed.
1423
+
1424
+ EXTERNAL_GROUPS = YES
1425
+
1426
+ # The PERL_PATH should be the absolute path and name of the perl script
1427
+ # interpreter (i.e. the result of `which perl').
1428
+
1429
+ PERL_PATH = /usr/bin/perl
1430
+
1431
+ #---------------------------------------------------------------------------
1432
+ # Configuration options related to the dot tool
1433
+ #---------------------------------------------------------------------------
1434
+
1435
+ # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1436
+ # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1437
+ # or super classes. Setting the tag to NO turns the diagrams off. Note that
1438
+ # this option is superseded by the HAVE_DOT option below. This is only a
1439
+ # fallback. It is recommended to install and use dot, since it yields more
1440
+ # powerful graphs.
1441
+
1442
+ CLASS_DIAGRAMS = YES
1443
+
1444
+ # You can define message sequence charts within doxygen comments using the \msc
1445
+ # command. Doxygen will then run the mscgen tool (see
1446
+ # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1447
+ # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1448
+ # the mscgen tool resides. If left empty the tool is assumed to be found in the
1449
+ # default search path.
1450
+
1451
+ MSCGEN_PATH =
1452
+
1453
+ # If set to YES, the inheritance and collaboration graphs will hide
1454
+ # inheritance and usage relations if the target is undocumented
1455
+ # or is not a class.
1456
+
1457
+ HIDE_UNDOC_RELATIONS = YES
1458
+
1459
+ # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1460
+ # available from the path. This tool is part of Graphviz, a graph visualization
1461
+ # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1462
+ # have no effect if this option is set to NO (the default)
1463
+
1464
+ HAVE_DOT = NO
1465
+
1466
+ # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1467
+ # allowed to run in parallel. When set to 0 (the default) doxygen will
1468
+ # base this on the number of processors available in the system. You can set it
1469
+ # explicitly to a value larger than 0 to get control over the balance
1470
+ # between CPU load and processing speed.
1471
+
1472
+ DOT_NUM_THREADS = 0
1473
+
1474
+ # By default doxygen will write a font called FreeSans.ttf to the output
1475
+ # directory and reference it in all dot files that doxygen generates. This
1476
+ # font does not include all possible unicode characters however, so when you need
1477
+ # these (or just want a differently looking font) you can specify the font name
1478
+ # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1479
+ # which can be done by putting it in a standard location or by setting the
1480
+ # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1481
+ # containing the font.
1482
+
1483
+ DOT_FONTNAME = FreeSans.ttf
1484
+
1485
+ # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1486
+ # The default size is 10pt.
1487
+
1488
+ DOT_FONTSIZE = 10
1489
+
1490
+ # By default doxygen will tell dot to use the output directory to look for the
1491
+ # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1492
+ # different font using DOT_FONTNAME you can set the path where dot
1493
+ # can find it using this tag.
1494
+
1495
+ DOT_FONTPATH =
1496
+
1497
+ # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1498
+ # will generate a graph for each documented class showing the direct and
1499
+ # indirect inheritance relations. Setting this tag to YES will force the
1500
+ # the CLASS_DIAGRAMS tag to NO.
1501
+
1502
+ CLASS_GRAPH = YES
1503
+
1504
+ # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1505
+ # will generate a graph for each documented class showing the direct and
1506
+ # indirect implementation dependencies (inheritance, containment, and
1507
+ # class references variables) of the class with other documented classes.
1508
+
1509
+ COLLABORATION_GRAPH = YES
1510
+
1511
+ # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1512
+ # will generate a graph for groups, showing the direct groups dependencies
1513
+
1514
+ GROUP_GRAPHS = YES
1515
+
1516
+ # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1517
+ # collaboration diagrams in a style similar to the OMG's Unified Modeling
1518
+ # Language.
1519
+
1520
+ UML_LOOK = NO
1521
+
1522
+ # If set to YES, the inheritance and collaboration graphs will show the
1523
+ # relations between templates and their instances.
1524
+
1525
+ TEMPLATE_RELATIONS = NO
1526
+
1527
+ # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1528
+ # tags are set to YES then doxygen will generate a graph for each documented
1529
+ # file showing the direct and indirect include dependencies of the file with
1530
+ # other documented files.
1531
+
1532
+ INCLUDE_GRAPH = YES
1533
+
1534
+ # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1535
+ # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1536
+ # documented header file showing the documented files that directly or
1537
+ # indirectly include this file.
1538
+
1539
+ INCLUDED_BY_GRAPH = YES
1540
+
1541
+ # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1542
+ # doxygen will generate a call dependency graph for every global function
1543
+ # or class method. Note that enabling this option will significantly increase
1544
+ # the time of a run. So in most cases it will be better to enable call graphs
1545
+ # for selected functions only using the \callgraph command.
1546
+
1547
+ CALL_GRAPH = NO
1548
+
1549
+ # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1550
+ # doxygen will generate a caller dependency graph for every global function
1551
+ # or class method. Note that enabling this option will significantly increase
1552
+ # the time of a run. So in most cases it will be better to enable caller
1553
+ # graphs for selected functions only using the \callergraph command.
1554
+
1555
+ CALLER_GRAPH = NO
1556
+
1557
+ # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1558
+ # will graphical hierarchy of all classes instead of a textual one.
1559
+
1560
+ GRAPHICAL_HIERARCHY = YES
1561
+
1562
+ # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1563
+ # then doxygen will show the dependencies a directory has on other directories
1564
+ # in a graphical way. The dependency relations are determined by the #include
1565
+ # relations between the files in the directories.
1566
+
1567
+ DIRECTORY_GRAPH = YES
1568
+
1569
+ # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1570
+ # generated by dot. Possible values are png, jpg, or gif
1571
+ # If left blank png will be used.
1572
+
1573
+ DOT_IMAGE_FORMAT = png
1574
+
1575
+ # The tag DOT_PATH can be used to specify the path where the dot tool can be
1576
+ # found. If left blank, it is assumed the dot tool can be found in the path.
1577
+
1578
+ DOT_PATH =
1579
+
1580
+ # The DOTFILE_DIRS tag can be used to specify one or more directories that
1581
+ # contain dot files that are included in the documentation (see the
1582
+ # \dotfile command).
1583
+
1584
+ DOTFILE_DIRS =
1585
+
1586
+ # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1587
+ # nodes that will be shown in the graph. If the number of nodes in a graph
1588
+ # becomes larger than this value, doxygen will truncate the graph, which is
1589
+ # visualized by representing a node as a red box. Note that doxygen if the
1590
+ # number of direct children of the root node in a graph is already larger than
1591
+ # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1592
+ # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1593
+
1594
+ DOT_GRAPH_MAX_NODES = 50
1595
+
1596
+ # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1597
+ # graphs generated by dot. A depth value of 3 means that only nodes reachable
1598
+ # from the root by following a path via at most 3 edges will be shown. Nodes
1599
+ # that lay further from the root node will be omitted. Note that setting this
1600
+ # option to 1 or 2 may greatly reduce the computation time needed for large
1601
+ # code bases. Also note that the size of a graph can be further restricted by
1602
+ # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1603
+
1604
+ MAX_DOT_GRAPH_DEPTH = 0
1605
+
1606
+ # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1607
+ # background. This is disabled by default, because dot on Windows does not
1608
+ # seem to support this out of the box. Warning: Depending on the platform used,
1609
+ # enabling this option may lead to badly anti-aliased labels on the edges of
1610
+ # a graph (i.e. they become hard to read).
1611
+
1612
+ DOT_TRANSPARENT = NO
1613
+
1614
+ # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1615
+ # files in one run (i.e. multiple -o and -T options on the command line). This
1616
+ # makes dot run faster, but since only newer versions of dot (>1.8.10)
1617
+ # support this, this feature is disabled by default.
1618
+
1619
+ DOT_MULTI_TARGETS = YES
1620
+
1621
+ # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1622
+ # generate a legend page explaining the meaning of the various boxes and
1623
+ # arrows in the dot generated graphs.
1624
+
1625
+ GENERATE_LEGEND = YES
1626
+
1627
+ # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1628
+ # remove the intermediate dot files that are used to generate
1629
+ # the various graphs.
1630
+
1631
+ DOT_CLEANUP = YES