« back to all changes in this revision
Viewing changes to COPYING
- browse files at revision 4
- compare with another revision
- download diff
- download tarball
- view history from revision 4
- Committer: Bazaar Package Importer
- Author(s): Pierre Chifflier
- Date: 2011-04-06 21:46:31 UTC
- mfrom: (1.1.1 upstream)
- Revision ID: james.westby@ubuntu.com-20110406214631-j1kl1ey8xef0prvz
Tags: 0.3.0-1
* Imported Upstream version 0.3.0
* Add symbols files (Closes: #613334)
* Add symbols files (Closes: #613334)
- files added:
- debian/libee0.symbols
- files modified:
- COPYING
added
removed
COPYING
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 = libee
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 = 0.0.0
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 = doc
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 = "The $name class" \
90
"The $name widget" \
91
"The $name file" \
92
is \
93
provides \
94
specifies \
95
contains \
96
represents \
97
a \
98
an \
99
the
100
101
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
102
# Doxygen will generate a detailed section even if there is only a brief
103
# description.
104
105
ALWAYS_DETAILED_SEC = NO
106
107
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
108
# inherited members of a class in the documentation of that class as if those
109
# members were ordinary class members. Constructors, destructors and assignment
110
# operators of the base classes will not be shown.
111
112
INLINE_INHERITED_MEMB = NO
113
114
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
115
# path before files name in the file list and in the header files. If set
116
# to NO the shortest path that makes the file name unique will be used.
117
118
FULL_PATH_NAMES = YES
119
120
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
121
# can be used to strip a user-defined part of the path. Stripping is
122
# only done if one of the specified strings matches the left-hand part of
123
# the path. The tag can be used to show relative paths in the file list.
124
# If left blank the directory from which doxygen is run is used as the
125
# path to strip.
126
127
STRIP_FROM_PATH =
128
129
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
130
# the path mentioned in the documentation of a class, which tells
131
# the reader which header file to include in order to use a class.
132
# If left blank only the name of the header file containing the class
133
# definition is used. Otherwise one should specify the include paths that
134
# are normally passed to the compiler using the -I flag.
135
136
STRIP_FROM_INC_PATH =
137
138
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
139
# (but less readable) file names. This can be useful is your file systems
140
# doesn't support long names like on DOS, Mac, or CD-ROM.
141
142
SHORT_NAMES = NO
143
144
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
145
# will interpret the first line (until the first dot) of a JavaDoc-style
146
# comment as the brief description. If set to NO, the JavaDoc
147
# comments will behave just like regular Qt-style comments
148
# (thus requiring an explicit @brief command for a brief description.)
149
150
JAVADOC_AUTOBRIEF = NO
151
152
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
153
# interpret the first line (until the first dot) of a Qt-style
154
# comment as the brief description. If set to NO, the comments
155
# will behave just like regular Qt-style comments (thus requiring
156
# an explicit \brief command for a brief description.)
157
158
QT_AUTOBRIEF = NO
159
160
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
161
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
162
# comments) as a brief description. This used to be the default behaviour.
163
# The new default is to treat a multi-line C++ comment block as a detailed
164
# description. Set this tag to YES if you prefer the old behaviour instead.
165
166
MULTILINE_CPP_IS_BRIEF = NO
167
168
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
169
# member inherits the documentation from any documented member that it
170
# re-implements.
171
172
INHERIT_DOCS = YES
173
174
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
175
# a new page for each member. If set to NO, the documentation of a member will
176
# be part of the file/class/namespace that contains it.
177
178
SEPARATE_MEMBER_PAGES = NO
179
180
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
181
# Doxygen uses this value to replace tabs by spaces in code fragments.
182
183
TAB_SIZE = 8
184
185
# This tag can be used to specify a number of aliases that acts
186
# as commands in the documentation. An alias has the form "name=value".
187
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
188
# put the command \sideeffect (or @sideeffect) in the documentation, which
189
# will result in a user-defined paragraph with heading "Side Effects:".
190
# You can put \n's in the value part of an alias to insert newlines.
191
192
ALIASES =
193
194
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
195
# sources only. Doxygen will then generate output that is more tailored for C.
196
# For instance, some of the names that are used will be different. The list
197
# of all members will be omitted, etc.
198
199
OPTIMIZE_OUTPUT_FOR_C = YES
200
201
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
202
# sources only. Doxygen will then generate output that is more tailored for
203
# Java. For instance, namespaces will be presented as packages, qualified
204
# scopes will look different, etc.
205
206
OPTIMIZE_OUTPUT_JAVA = NO
207
208
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
209
# sources only. Doxygen will then generate output that is more tailored for
210
# Fortran.
211
212
OPTIMIZE_FOR_FORTRAN = NO
213
214
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
215
# sources. Doxygen will then generate output that is tailored for
216
# VHDL.
217
218
OPTIMIZE_OUTPUT_VHDL = NO
219
220
# Doxygen selects the parser to use depending on the extension of the files it
221
# parses. With this tag you can assign which parser to use for a given extension.
222
# Doxygen has a built-in mapping, but you can override or extend it using this
223
# tag. The format is ext=language, where ext is a file extension, and language
224
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
225
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
226
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
227
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
228
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
229
230
EXTENSION_MAPPING =
231
232
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
233
# to include (a tag file for) the STL sources as input, then you should
234
# set this tag to YES in order to let doxygen match functions declarations and
235
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
236
# func(std::string) {}). This also make the inheritance and collaboration
237
# diagrams that involve STL classes more complete and accurate.
238
239
BUILTIN_STL_SUPPORT = NO
240
241
# If you use Microsoft's C++/CLI language, you should set this option to YES to
242
# enable parsing support.
243
244
CPP_CLI_SUPPORT = NO
245
246
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
247
# Doxygen will parse them like normal C++ but will assume all classes use public
248
# instead of private inheritance when no explicit protection keyword is present.
249
250
SIP_SUPPORT = NO
251
252
# For Microsoft's IDL there are propget and propput attributes to indicate getter
253
# and setter methods for a property. Setting this option to YES (the default)
254
# will make doxygen to replace the get and set methods by a property in the
255
# documentation. This will only work if the methods are indeed getting or
256
# setting a simple type. If this is not the case, or you want to show the
257
# methods anyway, you should set this option to NO.
258
259
IDL_PROPERTY_SUPPORT = YES
260
261
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
262
# tag is set to YES, then doxygen will reuse the documentation of the first
263
# member in the group (if any) for the other members of the group. By default
264
# all members of a group must be documented explicitly.
265
266
DISTRIBUTE_GROUP_DOC = NO
267
268
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
269
# the same type (for instance a group of public functions) to be put as a
270
# subgroup of that type (e.g. under the Public Functions section). Set it to
271
# NO to prevent subgrouping. Alternatively, this can be done per class using
272
# the \nosubgrouping command.
273
274
SUBGROUPING = YES
275
276
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
277
# is documented as struct, union, or enum with the name of the typedef. So
278
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
279
# with name TypeT. When disabled the typedef will appear as a member of a file,
280
# namespace, or class. And the struct will be named TypeS. This can typically
281
# be useful for C code in case the coding convention dictates that all compound
282
# types are typedef'ed and only the typedef is referenced, never the tag name.
283
284
TYPEDEF_HIDES_STRUCT = NO
285
286
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
287
# determine which symbols to keep in memory and which to flush to disk.
288
# When the cache is full, less often used symbols will be written to disk.
289
# For small to medium size projects (<1000 input files) the default value is
290
# probably good enough. For larger projects a too small cache size can cause
291
# doxygen to be busy swapping symbols to and from disk most of the time
292
# causing a significant performance penality.
293
# If the system has enough physical memory increasing the cache will improve the
294
# performance by keeping more symbols in memory. Note that the value works on
295
# a logarithmic scale so increasing the size by one will rougly double the
296
# memory usage. The cache size is given by this formula:
297
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
298
# corresponding to a cache size of 2^16 = 65536 symbols
299
300
SYMBOL_CACHE_SIZE = 0
301
302
#---------------------------------------------------------------------------
303
# Build related configuration options
304
#---------------------------------------------------------------------------
305
306
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
307
# documentation are documented, even if no documentation was available.
308
# Private class members and static file members will be hidden unless
309
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
310
311
EXTRACT_ALL = NO
312
313
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
314
# will be included in the documentation.
315
316
EXTRACT_PRIVATE = NO
317
318
# If the EXTRACT_STATIC tag is set to YES all static members of a file
319
# will be included in the documentation.
320
321
EXTRACT_STATIC = NO
322
323
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
324
# defined locally in source files will be included in the documentation.
325
# If set to NO only classes defined in header files are included.
326
327
EXTRACT_LOCAL_CLASSES = YES
328
329
# This flag is only useful for Objective-C code. When set to YES local
330
# methods, which are defined in the implementation section but not in
331
# the interface are included in the documentation.
332
# If set to NO (the default) only methods in the interface are included.
333
334
EXTRACT_LOCAL_METHODS = NO
335
336
# If this flag is set to YES, the members of anonymous namespaces will be
337
# extracted and appear in the documentation as a namespace called
338
# 'anonymous_namespace{file}', where file will be replaced with the base
339
# name of the file that contains the anonymous namespace. By default
340
# anonymous namespace are hidden.
341
342
EXTRACT_ANON_NSPACES = NO
343
344
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
345
# undocumented members of documented classes, files or namespaces.
346
# If set to NO (the default) these members will be included in the
347
# various overviews, but no documentation section is generated.
348
# This option has no effect if EXTRACT_ALL is enabled.
349
350
HIDE_UNDOC_MEMBERS = NO
351
352
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
353
# undocumented classes that are normally visible in the class hierarchy.
354
# If set to NO (the default) these classes will be included in the various
355
# overviews. This option has no effect if EXTRACT_ALL is enabled.
356
357
HIDE_UNDOC_CLASSES = NO
358
359
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
360
# friend (class|struct|union) declarations.
361
# If set to NO (the default) these declarations will be included in the
362
# documentation.
363
364
HIDE_FRIEND_COMPOUNDS = NO
365
366
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
367
# documentation blocks found inside the body of a function.
368
# If set to NO (the default) these blocks will be appended to the
369
# function's detailed documentation block.
370
371
HIDE_IN_BODY_DOCS = NO
372
373
# The INTERNAL_DOCS tag determines if documentation
374
# that is typed after a \internal command is included. If the tag is set
375
# to NO (the default) then the documentation will be excluded.
376
# Set it to YES to include the internal documentation.
377
378
INTERNAL_DOCS = NO
379
380
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
381
# file names in lower-case letters. If set to YES upper-case letters are also
382
# allowed. This is useful if you have classes or files whose names only differ
383
# in case and if your file system supports case sensitive file names. Windows
384
# and Mac users are advised to set this option to NO.
385
386
CASE_SENSE_NAMES = NO
387
388
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
389
# will show members with their full class and namespace scopes in the
390
# documentation. If set to YES the scope will be hidden.
391
392
HIDE_SCOPE_NAMES = YES
393
394
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
395
# will put a list of the files that are included by a file in the documentation
396
# of that file.
397
398
SHOW_INCLUDE_FILES = YES
399
400
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
401
# will list include files with double quotes in the documentation
402
# rather than with sharp brackets.
403
404
FORCE_LOCAL_INCLUDES = NO
405
406
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
407
# is inserted in the documentation for inline members.
408
409
INLINE_INFO = YES
410
411
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
412
# will sort the (detailed) documentation of file and class members
413
# alphabetically by member name. If set to NO the members will appear in
414
# declaration order.
415
416
SORT_MEMBER_DOCS = YES
417
418
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
419
# brief documentation of file, namespace and class members alphabetically
420
# by member name. If set to NO (the default) the members will appear in
421
# declaration order.
422
423
SORT_BRIEF_DOCS = NO
424
425
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
426
# will sort the (brief and detailed) documentation of class members so that
427
# constructors and destructors are listed first. If set to NO (the default)
428
# the constructors will appear in the respective orders defined by
429
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
430
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
431
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
432
433
SORT_MEMBERS_CTORS_1ST = NO
434
435
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
436
# hierarchy of group names into alphabetical order. If set to NO (the default)
437
# the group names will appear in their defined order.
438
439
SORT_GROUP_NAMES = NO
440
441
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
442
# sorted by fully-qualified names, including namespaces. If set to
443
# NO (the default), the class list will be sorted only by class name,
444
# not including the namespace part.
445
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
446
# Note: This option applies only to the class list, not to the
447
# alphabetical list.
448
449
SORT_BY_SCOPE_NAME = NO
450
451
# The GENERATE_TODOLIST tag can be used to enable (YES) or
452
# disable (NO) the todo list. This list is created by putting \todo
453
# commands in the documentation.
454
455
GENERATE_TODOLIST = YES
456
457
# The GENERATE_TESTLIST tag can be used to enable (YES) or
458
# disable (NO) the test list. This list is created by putting \test
459
# commands in the documentation.
460
461
GENERATE_TESTLIST = YES
462
463
# The GENERATE_BUGLIST tag can be used to enable (YES) or
464
# disable (NO) the bug list. This list is created by putting \bug
465
# commands in the documentation.
466
467
GENERATE_BUGLIST = YES
468
469
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
470
# disable (NO) the deprecated list. This list is created by putting
471
# \deprecated commands in the documentation.
472
473
GENERATE_DEPRECATEDLIST= YES
474
475
# The ENABLED_SECTIONS tag can be used to enable conditional
476
# documentation sections, marked by \if sectionname ... \endif.
477
478
ENABLED_SECTIONS =
479
480
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
481
# the initial value of a variable or define consists of for it to appear in
482
# the documentation. If the initializer consists of more lines than specified
483
# here it will be hidden. Use a value of 0 to hide initializers completely.
484
# The appearance of the initializer of individual variables and defines in the
485
# documentation can be controlled using \showinitializer or \hideinitializer
486
# command in the documentation regardless of this setting.
487
488
MAX_INITIALIZER_LINES = 30
489
490
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
491
# at the bottom of the documentation of classes and structs. If set to YES the
492
# list will mention the files that were used to generate the documentation.
493
494
SHOW_USED_FILES = YES
495
496
# If the sources in your project are distributed over multiple directories
497
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
498
# in the documentation. The default is NO.
499
500
SHOW_DIRECTORIES = NO
501
502
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
503
# This will remove the Files entry from the Quick Index and from the
504
# Folder Tree View (if specified). The default is YES.
505
506
SHOW_FILES = YES
507
508
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
509
# Namespaces page. This will remove the Namespaces entry from the Quick Index
510
# and from the Folder Tree View (if specified). The default is YES.
511
512
SHOW_NAMESPACES = YES
513
514
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
515
# doxygen should invoke to get the current version for each file (typically from
516
# the version control system). Doxygen will invoke the program by executing (via
517
# popen()) the command <command> <input-file>, where <command> is the value of
518
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
519
# provided by doxygen. Whatever the program writes to standard output
520
# is used as the file version. See the manual for examples.
521
522
FILE_VERSION_FILTER =
523
524
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
525
# by doxygen. The layout file controls the global structure of the generated
526
# output files in an output format independent way. The create the layout file
527
# that represents doxygen's defaults, run doxygen with the -l option.
528
# You can optionally specify a file name after the option, if omitted
529
# DoxygenLayout.xml will be used as the name of the layout file.
530
531
LAYOUT_FILE =
532
533
#---------------------------------------------------------------------------
534
# configuration options related to warning and progress messages
535
#---------------------------------------------------------------------------
536
537
# The QUIET tag can be used to turn on/off the messages that are generated
538
# by doxygen. Possible values are YES and NO. If left blank NO is used.
539
540
QUIET = NO
541
542
# The WARNINGS tag can be used to turn on/off the warning messages that are
543
# generated by doxygen. Possible values are YES and NO. If left blank
544
# NO is used.
545
546
WARNINGS = YES
547
548
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
549
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
550
# automatically be disabled.
551
552
WARN_IF_UNDOCUMENTED = YES
553
554
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
555
# potential errors in the documentation, such as not documenting some
556
# parameters in a documented function, or documenting parameters that
557
# don't exist or using markup commands wrongly.
558
559
WARN_IF_DOC_ERROR = YES
560
561
# This WARN_NO_PARAMDOC option can be abled to get warnings for
562
# functions that are documented, but have no documentation for their parameters
563
# or return value. If set to NO (the default) doxygen will only warn about
564
# wrong or incomplete parameter documentation, but not about the absence of
565
# documentation.
566
567
WARN_NO_PARAMDOC = NO
568
569
# The WARN_FORMAT tag determines the format of the warning messages that
570
# doxygen can produce. The string should contain the $file, $line, and $text
571
# tags, which will be replaced by the file and line number from which the
572
# warning originated and the warning text. Optionally the format may contain
573
# $version, which will be replaced by the version of the file (if it could
574
# be obtained via FILE_VERSION_FILTER)
575
576
WARN_FORMAT = "$file:$line: $text"
577
578
# The WARN_LOGFILE tag can be used to specify a file to which warning
579
# and error messages should be written. If left blank the output is written
580
# to stderr.
581
582
WARN_LOGFILE =
583
584
#---------------------------------------------------------------------------
585
# configuration options related to the input files
586
#---------------------------------------------------------------------------
587
588
# The INPUT tag can be used to specify the files and/or directories that contain
589
# documented source files. You may enter file names like "myfile.cpp" or
590
# directories like "/usr/src/myproject". Separate the files or directories
591
# with spaces.
592
593
INPUT = src include
594
595
# This tag can be used to specify the character encoding of the source files
596
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
597
# also the default input encoding. Doxygen uses libiconv (or the iconv built
598
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
599
# the list of possible encodings.
600
601
INPUT_ENCODING = UTF-8
602
603
# If the value of the INPUT tag contains directories, you can use the
604
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
605
# and *.h) to filter out the source-files in the directories. If left
606
# blank the following patterns are tested:
607
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
608
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
609
610
FILE_PATTERNS = *.c \
611
*.cc \
612
*.cxx \
613
*.cpp \
614
*.c++ \
615
*.d \
616
*.java \
617
*.ii \
618
*.ixx \
619
*.ipp \
620
*.i++ \
621
*.inl \
622
*.h \
623
*.hh \
624
*.hxx \
625
*.hpp \
626
*.h++ \
627
*.idl \
628
*.odl \
629
*.cs \
630
*.php \
631
*.php3 \
632
*.inc \
633
*.m \
634
*.mm \
635
*.dox \
636
*.py \
637
*.f90 \
638
*.f \
639
*.vhd \
640
*.vhdl
641
642
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
643
# should be searched for input files as well. Possible values are YES and NO.
644
# If left blank NO is used.
645
646
RECURSIVE = YES
647
648
# The EXCLUDE tag can be used to specify files and/or directories that should
649
# excluded from the INPUT source files. This way you can easily exclude a
650
# subdirectory from a directory tree whose root is specified with the INPUT tag.
651
652
EXCLUDE =
653
654
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
655
# directories that are symbolic links (a Unix filesystem feature) are excluded
656
# from the input.
657
658
EXCLUDE_SYMLINKS = NO
659
660
# If the value of the INPUT tag contains directories, you can use the
661
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
662
# certain files from those directories. Note that the wildcards are matched
663
# against the file with absolute path, so to exclude all test directories
664
# for example use the pattern */test/*
665
666
EXCLUDE_PATTERNS =
667
668
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
669
# (namespaces, classes, functions, etc.) that should be excluded from the
670
# output. The symbol name can be a fully qualified name, a word, or if the
671
# wildcard * is used, a substring. Examples: ANamespace, AClass,
672
# AClass::ANamespace, ANamespace::*Test
673
674
EXCLUDE_SYMBOLS =
675
676
# The EXAMPLE_PATH tag can be used to specify one or more files or
677
# directories that contain example code fragments that are included (see
678
# the \include command).
679
680
EXAMPLE_PATH =
681
682
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
683
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
684
# and *.h) to filter out the source-files in the directories. If left
685
# blank all files are included.
686
687
EXAMPLE_PATTERNS = *
688
689
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
690
# searched for input files to be used with the \include or \dontinclude
691
# commands irrespective of the value of the RECURSIVE tag.
692
# Possible values are YES and NO. If left blank NO is used.
693
694
EXAMPLE_RECURSIVE = NO
695
696
# The IMAGE_PATH tag can be used to specify one or more files or
697
# directories that contain image that are included in the documentation (see
698
# the \image command).
699
700
IMAGE_PATH =
701
702
# The INPUT_FILTER tag can be used to specify a program that doxygen should
703
# invoke to filter for each input file. Doxygen will invoke the filter program
704
# by executing (via popen()) the command <filter> <input-file>, where <filter>
705
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
706
# input file. Doxygen will then use the output that the filter program writes
707
# to standard output. If FILTER_PATTERNS is specified, this tag will be
708
# ignored.
709
710
INPUT_FILTER =
711
712
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
713
# basis. Doxygen will compare the file name with each pattern and apply the
714
# filter if there is a match. The filters are a list of the form:
715
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
716
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
717
# is applied to all files.
718
719
FILTER_PATTERNS =
720
721
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
722
# INPUT_FILTER) will be used to filter the input files when producing source
723
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
724
725
FILTER_SOURCE_FILES = NO
726
727
#---------------------------------------------------------------------------
728
# configuration options related to source browsing
729
#---------------------------------------------------------------------------
730
731
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
732
# be generated. Documented entities will be cross-referenced with these sources.
733
# Note: To get rid of all source code in the generated output, make sure also
734
# VERBATIM_HEADERS is set to NO.
735
736
SOURCE_BROWSER = NO
737
738
# Setting the INLINE_SOURCES tag to YES will include the body
739
# of functions and classes directly in the documentation.
740
741
INLINE_SOURCES = NO
742
743
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
744
# doxygen to hide any special comment blocks from generated source code
745
# fragments. Normal C and C++ comments will always remain visible.
746
747
STRIP_CODE_COMMENTS = YES
748
749
# If the REFERENCED_BY_RELATION tag is set to YES
750
# then for each documented function all documented
751
# functions referencing it will be listed.
752
753
REFERENCED_BY_RELATION = NO
754
755
# If the REFERENCES_RELATION tag is set to YES
756
# then for each documented function all documented entities
757
# called/used by that function will be listed.
758
759
REFERENCES_RELATION = NO
760
761
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
762
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
763
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
764
# link to the source code. Otherwise they will link to the documentation.
765
766
REFERENCES_LINK_SOURCE = YES
767
768
# If the USE_HTAGS tag is set to YES then the references to source code
769
# will point to the HTML generated by the htags(1) tool instead of doxygen
770
# built-in source browser. The htags tool is part of GNU's global source
771
# tagging system (see http://www.gnu.org/software/global/global.html). You
772
# will need version 4.8.6 or higher.
773
774
USE_HTAGS = NO
775
776
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
777
# will generate a verbatim copy of the header file for each class for
778
# which an include is specified. Set to NO to disable this.
779
780
VERBATIM_HEADERS = YES
781
782
#---------------------------------------------------------------------------
783
# configuration options related to the alphabetical class index
784
#---------------------------------------------------------------------------
785
786
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
787
# of all compounds will be generated. Enable this if the project
788
# contains a lot of classes, structs, unions or interfaces.
789
790
ALPHABETICAL_INDEX = NO
791
792
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
793
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
794
# in which this list will be split (can be a number in the range [1..20])
795
796
COLS_IN_ALPHA_INDEX = 5
797
798
# In case all classes in a project start with a common prefix, all
799
# classes will be put under the same header in the alphabetical index.
800
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
801
# should be ignored while generating the index headers.
802
803
IGNORE_PREFIX =
804
805
#---------------------------------------------------------------------------
806
# configuration options related to the HTML output
807
#---------------------------------------------------------------------------
808
809
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
810
# generate HTML output.
811
812
GENERATE_HTML = YES
813
814
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
815
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
816
# put in front of it. If left blank `html' will be used as the default path.
817
818
HTML_OUTPUT = html
819
820
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
821
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
822
# doxygen will generate files with .html extension.
823
824
HTML_FILE_EXTENSION = .html
825
826
# The HTML_HEADER tag can be used to specify a personal HTML header for
827
# each generated HTML page. If it is left blank doxygen will generate a
828
# standard header.
829
830
HTML_HEADER =
831
832
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
833
# each generated HTML page. If it is left blank doxygen will generate a
834
# standard footer.
835
836
HTML_FOOTER =
837
838
# If the HTML_TIMESTAMP tag is set to YES then the generated HTML
839
# documentation will contain the timesstamp.
840
841
HTML_TIMESTAMP = YES
842
843
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
844
# style sheet that is used by each HTML page. It can be used to
845
# fine-tune the look of the HTML output. If the tag is left blank doxygen
846
# will generate a default style sheet. Note that doxygen will try to copy
847
# the style sheet file to the HTML output directory, so don't put your own
848
# stylesheet in the HTML output directory as well, or it will be erased!
849
850
HTML_STYLESHEET =
851
852
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
853
# Doxygen will adjust the colors in the stylesheet and background images
854
# according to this color. Hue is specified as an angle on a colorwheel,
855
# see http://en.wikipedia.org/wiki/Hue for more information.
856
# For instance the value 0 represents red, 60 is yellow, 120 is green,
857
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
858
# The allowed range is 0 to 359.
859
860
HTML_COLORSTYLE_HUE = 220
861
862
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
863
# the colors in the HTML output. For a value of 0 the output will use
864
# grayscales only. A value of 255 will produce the most vivid colors.
865
866
HTML_COLORSTYLE_SAT = 100
867
868
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
869
# the luminance component of the colors in the HTML output. Values below
870
# 100 gradually make the output lighter, whereas values above 100 make
871
# the output darker. The value divided by 100 is the actual gamma applied,
872
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
873
# and 100 does not change the gamma.
874
875
HTML_COLORSTYLE_GAMMA = 80
876
877
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
878
# page will contain the date and time when the page was generated. Setting
879
# this to NO can help when comparing the output of multiple runs.
880
881
HTML_TIMESTAMP = YES
882
883
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
884
# files or namespaces will be aligned in HTML using tables. If set to
885
# NO a bullet list will be used.
886
887
HTML_ALIGN_MEMBERS = YES
888
889
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
890
# documentation will contain sections that can be hidden and shown after the
891
# page has loaded. For this to work a browser that supports
892
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
893
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
894
895
HTML_DYNAMIC_SECTIONS = NO
896
897
# If the GENERATE_DOCSET tag is set to YES, additional index files
898
# will be generated that can be used as input for Apple's Xcode 3
899
# integrated development environment, introduced with OSX 10.5 (Leopard).
900
# To create a documentation set, doxygen will generate a Makefile in the
901
# HTML output directory. Running make will produce the docset in that
902
# directory and running "make install" will install the docset in
903
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
904
# it at startup.
905
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
906
# for more information.
907
908
GENERATE_DOCSET = NO
909
910
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
911
# feed. A documentation feed provides an umbrella under which multiple
912
# documentation sets from a single provider (such as a company or product suite)
913
# can be grouped.
914
915
DOCSET_FEEDNAME = "Doxygen generated docs"
916
917
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
918
# should uniquely identify the documentation set bundle. This should be a
919
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
920
# will append .docset to the name.
921
922
DOCSET_BUNDLE_ID = org.doxygen.Project
923
924
# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
925
# the documentation publisher. This should be a reverse domain-name style
926
# string, e.g. com.mycompany.MyDocSet.documentation.
927
928
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
929
930
# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
931
932
DOCSET_PUBLISHER_NAME = Publisher
933
934
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
935
# will be generated that can be used as input for tools like the
936
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
937
# of the generated HTML documentation.
938
939
GENERATE_HTMLHELP = NO
940
941
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
942
# be used to specify the file name of the resulting .chm file. You
943
# can add a path in front of the file if the result should not be
944
# written to the html output directory.
945
946
CHM_FILE =
947
948
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
949
# be used to specify the location (absolute path including file name) of
950
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
951
# the HTML help compiler on the generated index.hhp.
952
953
HHC_LOCATION =
954
955
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
956
# controls if a separate .chi index file is generated (YES) or that
957
# it should be included in the master .chm file (NO).
958
959
GENERATE_CHI = NO
960
961
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
962
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
963
# content.
964
965
CHM_INDEX_ENCODING =
966
967
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
968
# controls whether a binary table of contents is generated (YES) or a
969
# normal table of contents (NO) in the .chm file.
970
971
BINARY_TOC = NO
972
973
# The TOC_EXPAND flag can be set to YES to add extra items for group members
974
# to the contents of the HTML help documentation and to the tree view.
975
976
TOC_EXPAND = NO
977
978
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
979
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
980
# that can be used as input for Qt's qhelpgenerator to generate a
981
# Qt Compressed Help (.qch) of the generated HTML documentation.
982
983
GENERATE_QHP = NO
984
985
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
986
# be used to specify the file name of the resulting .qch file.
987
# The path specified is relative to the HTML output folder.
988
989
QCH_FILE =
990
991
# The QHP_NAMESPACE tag specifies the namespace to use when generating
992
# Qt Help Project output. For more information please see
993
# http://doc.trolltech.com/qthelpproject.html#namespace
994
995
QHP_NAMESPACE = org.doxygen.Project
996
997
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
998
# Qt Help Project output. For more information please see
999
# http://doc.trolltech.com/qthelpproject.html#virtual-folders
1000
1001
QHP_VIRTUAL_FOLDER = doc
1002
1003
# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
1004
# add. For more information please see
1005
# http://doc.trolltech.com/qthelpproject.html#custom-filters
1006
1007
QHP_CUST_FILTER_NAME =
1008
1009
# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
1010
# custom filter to add. For more information please see
1011
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
1012
# Qt Help Project / Custom Filters</a>.
1013
1014
QHP_CUST_FILTER_ATTRS =
1015
1016
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1017
# project's
1018
# filter section matches.
1019
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
1020
# Qt Help Project / Filter Attributes</a>.
1021
1022
QHP_SECT_FILTER_ATTRS =
1023
1024
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
1025
# be used to specify the location of Qt's qhelpgenerator.
1026
# If non-empty doxygen will try to run qhelpgenerator on the generated
1027
# .qhp file.
1028
1029
QHG_LOCATION =
1030
1031
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
1032
# will be generated, which together with the HTML files, form an Eclipse help
1033
# plugin. To install this plugin and make it available under the help contents
1034
# menu in Eclipse, the contents of the directory containing the HTML and XML
1035
# files needs to be copied into the plugins directory of eclipse. The name of
1036
# the directory within the plugins directory should be the same as
1037
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
1038
# the help appears.
1039
1040
GENERATE_ECLIPSEHELP = NO
1041
1042
# A unique identifier for the eclipse help plugin. When installing the plugin
1043
# the directory name containing the HTML and XML files should also have
1044
# this name.
1045
1046
ECLIPSE_DOC_ID = org.doxygen.Project
1047
1048
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
1049
# top of each HTML page. The value NO (the default) enables the index and
1050
# the value YES disables it.
1051
1052
DISABLE_INDEX = NO
1053
1054
# This tag can be used to set the number of enum values (range [1..20])
1055
# that doxygen will group on one line in the generated HTML documentation.
1056
1057
ENUM_VALUES_PER_LINE = 4
1058
1059
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1060
# structure should be generated to display hierarchical information.
1061
# If the tag value is set to YES, a side panel will be generated
1062
# containing a tree-like index structure (just like the one that
1063
# is generated for HTML Help). For this to work a browser that supports
1064
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1065
# Windows users are probably better off using the HTML help feature.
1066
1067
GENERATE_TREEVIEW = NO
1068
1069
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1070
# and Class Hierarchy pages using a tree view instead of an ordered list.
1071
1072
USE_INLINE_TREES = NO
1073
1074
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
1075
# used to set the initial width (in pixels) of the frame in which the tree
1076
# is shown.
1077
1078
TREEVIEW_WIDTH = 250
1079
1080
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
1081
# links to external symbols imported via tag files in a separate window.
1082
1083
EXT_LINKS_IN_WINDOW = NO
1084
1085
# Use this tag to change the font size of Latex formulas included
1086
# as images in the HTML documentation. The default is 10. Note that
1087
# when you change the font size after a successful doxygen run you need
1088
# to manually remove any form_*.png images from the HTML output directory
1089
# to force them to be regenerated.
1090
1091
FORMULA_FONTSIZE = 10
1092
1093
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1094
# generated for formulas are transparent PNGs. Transparent PNGs are
1095
# not supported properly for IE 6.0, but are supported on all modern browsers.
1096
# Note that when changing this option you need to delete any form_*.png files
1097
# in the HTML output before the changes have effect.
1098
1099
FORMULA_TRANSPARENT = YES
1100
1101
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1102
# for the HTML output. The underlying search engine uses javascript
1103
# and DHTML and should work on any modern browser. Note that when using
1104
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1105
# (GENERATE_DOCSET) there is already a search function so this one should
1106
# typically be disabled. For large projects the javascript based search engine
1107
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1108
1109
SEARCHENGINE = NO
1110
1111
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1112
# implemented using a PHP enabled web server instead of at the web client
1113
# using Javascript. Doxygen will generate the search PHP script and index
1114
# file to put on the web server. The advantage of the server
1115
# based approach is that it scales better to large projects and allows
1116
# full text search. The disadvances is that it is more difficult to setup
1117
# and does not have live searching capabilities.
1118
1119
SERVER_BASED_SEARCH = NO
1120
1121
#---------------------------------------------------------------------------
1122
# configuration options related to the LaTeX output
1123
#---------------------------------------------------------------------------
1124
1125
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1126
# generate Latex output.
1127
1128
GENERATE_LATEX = NO
1129
1130
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1131
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1132
# put in front of it. If left blank `latex' will be used as the default path.
1133
1134
LATEX_OUTPUT = latex
1135
1136
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1137
# invoked. If left blank `latex' will be used as the default command name.
1138
# Note that when enabling USE_PDFLATEX this option is only used for
1139
# generating bitmaps for formulas in the HTML output, but not in the
1140
# Makefile that is written to the output directory.
1141
1142
LATEX_CMD_NAME = latex
1143
1144
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1145
# generate index for LaTeX. If left blank `makeindex' will be used as the
1146
# default command name.
1147
1148
MAKEINDEX_CMD_NAME = makeindex
1149
1150
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1151
# LaTeX documents. This may be useful for small projects and may help to
1152
# save some trees in general.
1153
1154
COMPACT_LATEX = NO
1155
1156
# The PAPER_TYPE tag can be used to set the paper type that is used
1157
# by the printer. Possible values are: a4, a4wide, letter, legal and
1158
# executive. If left blank a4wide will be used.
1159
1160
PAPER_TYPE = a4wide
1161
1162
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1163
# packages that should be included in the LaTeX output.
1164
1165
EXTRA_PACKAGES =
1166
1167
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1168
# the generated latex document. The header should contain everything until
1169
# the first chapter. If it is left blank doxygen will generate a
1170
# standard header. Notice: only use this tag if you know what you are doing!
1171
1172
LATEX_HEADER =
1173
1174
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1175
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1176
# contain links (just like the HTML output) instead of page references
1177
# This makes the output suitable for online browsing using a pdf viewer.
1178
1179
PDF_HYPERLINKS = YES
1180
1181
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1182
# plain latex in the generated Makefile. Set this option to YES to get a
1183
# higher quality PDF documentation.
1184
1185
USE_PDFLATEX = YES
1186
1187
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1188
# command to the generated LaTeX files. This will instruct LaTeX to keep
1189
# running if errors occur, instead of asking the user for help.
1190
# This option is also used when generating formulas in HTML.
1191
1192
LATEX_BATCHMODE = NO
1193
1194
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1195
# include the index chapters (such as File Index, Compound Index, etc.)
1196
# in the output.
1197
1198
LATEX_HIDE_INDICES = NO
1199
1200
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
1201
# source code with syntax highlighting in the LaTeX output.
1202
# Note that which sources are shown also depends on other settings
1203
# such as SOURCE_BROWSER.
1204
1205
LATEX_SOURCE_CODE = NO
1206
1207
#---------------------------------------------------------------------------
1208
# configuration options related to the RTF output
1209
#---------------------------------------------------------------------------
1210
1211
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1212
# The RTF output is optimized for Word 97 and may not look very pretty with
1213
# other RTF readers or editors.
1214
1215
GENERATE_RTF = NO
1216
1217
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1218
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1219
# put in front of it. If left blank `rtf' will be used as the default path.
1220
1221
RTF_OUTPUT = rtf
1222
1223
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1224
# RTF documents. This may be useful for small projects and may help to
1225
# save some trees in general.
1226
1227
COMPACT_RTF = NO
1228
1229
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1230
# will contain hyperlink fields. The RTF file will
1231
# contain links (just like the HTML output) instead of page references.
1232
# This makes the output suitable for online browsing using WORD or other
1233
# programs which support those fields.
1234
# Note: wordpad (write) and others do not support links.
1235
1236
RTF_HYPERLINKS = NO
1237
1238
# Load stylesheet definitions from file. Syntax is similar to doxygen's
1239
# config file, i.e. a series of assignments. You only have to provide
1240
# replacements, missing definitions are set to their default value.
1241
1242
RTF_STYLESHEET_FILE =
1243
1244
# Set optional variables used in the generation of an rtf document.
1245
# Syntax is similar to doxygen's config file.
1246
1247
RTF_EXTENSIONS_FILE =
1248
1249
#---------------------------------------------------------------------------
1250
# configuration options related to the man page output
1251
#---------------------------------------------------------------------------
1252
1253
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1254
# generate man pages
1255
1256
GENERATE_MAN = NO
1257
1258
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1259
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1260
# put in front of it. If left blank `man' will be used as the default path.
1261
1262
MAN_OUTPUT = man
1263
1264
# The MAN_EXTENSION tag determines the extension that is added to
1265
# the generated man pages (default is the subroutine's section .3)
1266
1267
MAN_EXTENSION = .3
1268
1269
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1270
# then it will generate one additional man file for each entity
1271
# documented in the real man page(s). These additional files
1272
# only source the real man page, but without them the man command
1273
# would be unable to find the correct page. The default is NO.
1274
1275
MAN_LINKS = NO
1276
1277
#---------------------------------------------------------------------------
1278
# configuration options related to the XML output
1279
#---------------------------------------------------------------------------
1280
1281
# If the GENERATE_XML tag is set to YES Doxygen will
1282
# generate an XML file that captures the structure of
1283
# the code including all documentation.
1284
1285
GENERATE_XML = NO
1286
1287
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1288
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1289
# put in front of it. If left blank `xml' will be used as the default path.
1290
1291
XML_OUTPUT = xml
1292
1293
# The XML_SCHEMA tag can be used to specify an XML schema,
1294
# which can be used by a validating XML parser to check the
1295
# syntax of the XML files.
1296
1297
XML_SCHEMA =
1298
1299
# The XML_DTD tag can be used to specify an XML DTD,
1300
# which can be used by a validating XML parser to check the
1301
# syntax of the XML files.
1302
1303
XML_DTD =
1304
1305
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1306
# dump the program listings (including syntax highlighting
1307
# and cross-referencing information) to the XML output. Note that
1308
# enabling this will significantly increase the size of the XML output.
1309
1310
XML_PROGRAMLISTING = YES
1311
1312
#---------------------------------------------------------------------------
1313
# configuration options for the AutoGen Definitions output
1314
#---------------------------------------------------------------------------
1315
1316
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1317
# generate an AutoGen Definitions (see autogen.sf.net) file
1318
# that captures the structure of the code including all
1319
# documentation. Note that this feature is still experimental
1320
# and incomplete at the moment.
1321
1322
GENERATE_AUTOGEN_DEF = NO
1323
1324
#---------------------------------------------------------------------------
1325
# configuration options related to the Perl module output
1326
#---------------------------------------------------------------------------
1327
1328
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1329
# generate a Perl module file that captures the structure of
1330
# the code including all documentation. Note that this
1331
# feature is still experimental and incomplete at the
1332
# moment.
1333
1334
GENERATE_PERLMOD = NO
1335
1336
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1337
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1338
# to generate PDF and DVI output from the Perl module output.
1339
1340
PERLMOD_LATEX = NO
1341
1342
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1343
# nicely formatted so it can be parsed by a human reader. This is useful
1344
# if you want to understand what is going on. On the other hand, if this
1345
# tag is set to NO the size of the Perl module output will be much smaller
1346
# and Perl will parse it just the same.
1347
1348
PERLMOD_PRETTY = YES
1349
1350
# The names of the make variables in the generated doxyrules.make file
1351
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1352
# This is useful so different doxyrules.make files included by the same
1353
# Makefile don't overwrite each other's variables.
1354
1355
PERLMOD_MAKEVAR_PREFIX =
1356
1357
#---------------------------------------------------------------------------
1358
# Configuration options related to the preprocessor
1359
#---------------------------------------------------------------------------
1360
1361
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1362
# evaluate all C-preprocessor directives found in the sources and include
1363
# files.
1364
1365
ENABLE_PREPROCESSING = YES
1366
1367
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1368
# names in the source code. If set to NO (the default) only conditional
1369
# compilation will be performed. Macro expansion can be done in a controlled
1370
# way by setting EXPAND_ONLY_PREDEF to YES.
1371
1372
MACRO_EXPANSION = NO
1373
1374
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1375
# then the macro expansion is limited to the macros specified with the
1376
# PREDEFINED and EXPAND_AS_DEFINED tags.
1377
1378
EXPAND_ONLY_PREDEF = NO
1379
1380
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1381
# in the INCLUDE_PATH (see below) will be search if a #include is found.
1382
1383
SEARCH_INCLUDES = YES
1384
1385
# The INCLUDE_PATH tag can be used to specify one or more directories that
1386
# contain include files that are not input files but should be processed by
1387
# the preprocessor.
1388
1389
INCLUDE_PATH =
1390
1391
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1392
# patterns (like *.h and *.hpp) to filter out the header-files in the
1393
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1394
# be used.
1395
1396
INCLUDE_FILE_PATTERNS =
1397
1398
# The PREDEFINED tag can be used to specify one or more macro names that
1399
# are defined before the preprocessor is started (similar to the -D option of
1400
# gcc). The argument of the tag is a list of macros of the form: name
1401
# or name=definition (no spaces). If the definition and the = are
1402
# omitted =1 is assumed. To prevent a macro definition from being
1403
# undefined via #undef or recursively expanded use the := operator
1404
# instead of the = operator.
1405
1406
PREDEFINED =
1407
1408
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1409
# this tag can be used to specify a list of macro names that should be expanded.
1410
# The macro definition that is found in the sources will be used.
1411
# Use the PREDEFINED tag if you want to use a different macro definition.
1412
1413
EXPAND_AS_DEFINED =
1414
1415
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1416
# doxygen's preprocessor will remove all function-like macros that are alone
1417
# on a line, have an all uppercase name, and do not end with a semicolon. Such
1418
# function macros are typically used for boiler-plate code, and will confuse
1419
# the parser if not removed.
1420
1421
SKIP_FUNCTION_MACROS = YES
1422
1423
#---------------------------------------------------------------------------
1424
# Configuration::additions related to external references
1425
#---------------------------------------------------------------------------
1426
1427
# The TAGFILES option can be used to specify one or more tagfiles.
1428
# Optionally an initial location of the external documentation
1429
# can be added for each tagfile. The format of a tag file without
1430
# this location is as follows:
1431
# TAGFILES = file1 file2 ...
1432
# Adding location for the tag files is done as follows:
1433
# TAGFILES = file1=loc1 "file2 = loc2" ...
1434
# where "loc1" and "loc2" can be relative or absolute paths or
1435
# URLs. If a location is present for each tag, the installdox tool
1436
# does not have to be run to correct the links.
1437
# Note that each tag file must have a unique name
1438
# (where the name does NOT include the path)
1439
# If a tag file is not located in the directory in which doxygen
1440
# is run, you must also specify the path to the tagfile here.
1441
1442
TAGFILES =
1443
1444
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1445
# a tag file that is based on the input files it reads.
1446
1447
GENERATE_TAGFILE =
1448
1449
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1450
# in the class index. If set to NO only the inherited external classes
1451
# will be listed.
1452
1453
ALLEXTERNALS = NO
1454
1455
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1456
# in the modules index. If set to NO, only the current project's groups will
1457
# be listed.
1458
1459
EXTERNAL_GROUPS = YES
1460
1461
# The PERL_PATH should be the absolute path and name of the perl script
1462
# interpreter (i.e. the result of `which perl').
1463
1464
PERL_PATH = /usr/bin/perl
1465
1466
#---------------------------------------------------------------------------
1467
# Configuration options related to the dot tool
1468
#---------------------------------------------------------------------------
1469
1470
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1471
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1472
# or super classes. Setting the tag to NO turns the diagrams off. Note that
1473
# this option is superseded by the HAVE_DOT option below. This is only a
1474
# fallback. It is recommended to install and use dot, since it yields more
1475
# powerful graphs.
1476
1477
CLASS_DIAGRAMS = YES
1478
1479
# You can define message sequence charts within doxygen comments using the \msc
1480
# command. Doxygen will then run the mscgen tool (see
1481
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1482
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1483
# the mscgen tool resides. If left empty the tool is assumed to be found in the
1484
# default search path.
1485
1486
MSCGEN_PATH =
1487
1488
# If set to YES, the inheritance and collaboration graphs will hide
1489
# inheritance and usage relations if the target is undocumented
1490
# or is not a class.
1491
1492
HIDE_UNDOC_RELATIONS = YES
1493
1494
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1495
# available from the path. This tool is part of Graphviz, a graph visualization
1496
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1497
# have no effect if this option is set to NO (the default)
1498
1499
HAVE_DOT = YES
1500
1501
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
1502
# allowed to run in parallel. When set to 0 (the default) doxygen will
1503
# base this on the number of processors available in the system. You can set it
1504
# explicitly to a value larger than 0 to get control over the balance
1505
# between CPU load and processing speed.
1506
1507
DOT_NUM_THREADS = 0
1508
1509
# By default doxygen will write a font called FreeSans.ttf to the output
1510
# directory and reference it in all dot files that doxygen generates. This
1511
# font does not include all possible unicode characters however, so when you need
1512
# these (or just want a differently looking font) you can specify the font name
1513
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1514
# which can be done by putting it in a standard location or by setting the
1515
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1516
# containing the font.
1517
1518
DOT_FONTNAME = FreeSans.ttf
1519
1520
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1521
# The default size is 10pt.
1522
1523
DOT_FONTSIZE = 10
1524
1525
# By default doxygen will tell dot to use the output directory to look for the
1526
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1527
# different font using DOT_FONTNAME you can set the path where dot
1528
# can find it using this tag.
1529
1530
DOT_FONTPATH =
1531
1532
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1533
# will generate a graph for each documented class showing the direct and
1534
# indirect inheritance relations. Setting this tag to YES will force the
1535
# the CLASS_DIAGRAMS tag to NO.
1536
1537
CLASS_GRAPH = YES
1538
1539
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1540
# will generate a graph for each documented class showing the direct and
1541
# indirect implementation dependencies (inheritance, containment, and
1542
# class references variables) of the class with other documented classes.
1543
1544
COLLABORATION_GRAPH = YES
1545
1546
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1547
# will generate a graph for groups, showing the direct groups dependencies
1548
1549
GROUP_GRAPHS = YES
1550
1551
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1552
# collaboration diagrams in a style similar to the OMG's Unified Modeling
1553
# Language.
1554
1555
UML_LOOK = NO
1556
1557
# If set to YES, the inheritance and collaboration graphs will show the
1558
# relations between templates and their instances.
1559
1560
TEMPLATE_RELATIONS = NO
1561
1562
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1563
# tags are set to YES then doxygen will generate a graph for each documented
1564
# file showing the direct and indirect include dependencies of the file with
1565
# other documented files.
1566
1567
INCLUDE_GRAPH = YES
1568
1569
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1570
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1571
# documented header file showing the documented files that directly or
1572
# indirectly include this file.
1573
1574
INCLUDED_BY_GRAPH = YES
1575
1576
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1577
# doxygen will generate a call dependency graph for every global function
1578
# or class method. Note that enabling this option will significantly increase
1579
# the time of a run. So in most cases it will be better to enable call graphs
1580
# for selected functions only using the \callgraph command.
1581
1582
CALL_GRAPH = NO
1583
1584
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1585
# doxygen will generate a caller dependency graph for every global function
1586
# or class method. Note that enabling this option will significantly increase
1587
# the time of a run. So in most cases it will be better to enable caller
1588
# graphs for selected functions only using the \callergraph command.
1589
1590
CALLER_GRAPH = NO
1591
1592
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1593
# will graphical hierarchy of all classes instead of a textual one.
1594
1595
GRAPHICAL_HIERARCHY = YES
1596
1597
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1598
# then doxygen will show the dependencies a directory has on other directories
1599
# in a graphical way. The dependency relations are determined by the #include
1600
# relations between the files in the directories.
1601
1602
DIRECTORY_GRAPH = YES
1603
1604
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1605
# generated by dot. Possible values are png, jpg, or gif
1606
# If left blank png will be used.
1607
1608
DOT_IMAGE_FORMAT = png
1609
1610
# The tag DOT_PATH can be used to specify the path where the dot tool can be
1611
# found. If left blank, it is assumed the dot tool can be found in the path.
1612
1613
DOT_PATH =
1614
1615
# The DOTFILE_DIRS tag can be used to specify one or more directories that
1616
# contain dot files that are included in the documentation (see the
1617
# \dotfile command).
1618
1619
DOTFILE_DIRS =
1620
1621
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1622
# nodes that will be shown in the graph. If the number of nodes in a graph
1623
# becomes larger than this value, doxygen will truncate the graph, which is
1624
# visualized by representing a node as a red box. Note that doxygen if the
1625
# number of direct children of the root node in a graph is already larger than
1626
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1627
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1628
1629
DOT_GRAPH_MAX_NODES = 50
1630
1631
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1632
# graphs generated by dot. A depth value of 3 means that only nodes reachable
1633
# from the root by following a path via at most 3 edges will be shown. Nodes
1634
# that lay further from the root node will be omitted. Note that setting this
1635
# option to 1 or 2 may greatly reduce the computation time needed for large
1636
# code bases. Also note that the size of a graph can be further restricted by
1637
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1638
1639
MAX_DOT_GRAPH_DEPTH = 0
1640
1641
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1642
# background. This is disabled by default, because dot on Windows does not
1643
# seem to support this out of the box. Warning: Depending on the platform used,
1644
# enabling this option may lead to badly anti-aliased labels on the edges of
1645
# a graph (i.e. they become hard to read).
1646
1647
DOT_TRANSPARENT = NO
1648
1649
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1650
# files in one run (i.e. multiple -o and -T options on the command line). This
1651
# makes dot run faster, but since only newer versions of dot (>1.8.10)
1652
# support this, this feature is disabled by default.
1653
1654
DOT_MULTI_TARGETS = NO
1655
1656
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1657
# generate a legend page explaining the meaning of the various boxes and
1658
# arrows in the dot generated graphs.
1659
1660
GENERATE_LEGEND = YES
1661
1662
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1663
# remove the intermediate dot files that are used to generate
1664
# the various graphs.
1665
1666
DOT_CLEANUP = YES
1
libee is available under the terms of the GNU GPL v2.1 or above (full
2
text below).
3
-----------------------------------------------------------------------
4
GNU LESSER GENERAL PUBLIC LICENSE
5
Version 2.1, February 1999
6
7
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
8
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
9
Everyone is permitted to copy and distribute verbatim copies
10
of this license document, but changing it is not allowed.
11
12
[This is the first released version of the Lesser GPL. It also counts
13
as the successor of the GNU Library Public License, version 2, hence
14
the version number 2.1.]
15
16
Preamble
17
18
The licenses for most software are designed to take away your
19
freedom to share and change it. By contrast, the GNU General Public
20
Licenses are intended to guarantee your freedom to share and change
21
free software--to make sure the software is free for all its users.
22
23
This license, the Lesser General Public License, applies to some
24
specially designated software packages--typically libraries--of the
25
Free Software Foundation and other authors who decide to use it. You
26
can use it too, but we suggest you first think carefully about whether
27
this license or the ordinary General Public License is the better
28
strategy to use in any particular case, based on the explanations below.
29
30
When we speak of free software, we are referring to freedom of use,
31
not price. Our General Public Licenses are designed to make sure that
32
you have the freedom to distribute copies of free software (and charge
33
for this service if you wish); that you receive source code or can get
34
it if you want it; that you can change the software and use pieces of
35
it in new free programs; and that you are informed that you can do
36
these things.
37
38
To protect your rights, we need to make restrictions that forbid
39
distributors to deny you these rights or to ask you to surrender these
40
rights. These restrictions translate to certain responsibilities for
41
you if you distribute copies of the library or if you modify it.
42
43
For example, if you distribute copies of the library, whether gratis
44
or for a fee, you must give the recipients all the rights that we gave
45
you. You must make sure that they, too, receive or can get the source
46
code. If you link other code with the library, you must provide
47
complete object files to the recipients, so that they can relink them
48
with the library after making changes to the library and recompiling
49
it. And you must show them these terms so they know their rights.
50
51
We protect your rights with a two-step method: (1) we copyright the
52
library, and (2) we offer you this license, which gives you legal
53
permission to copy, distribute and/or modify the library.
54
55
To protect each distributor, we want to make it very clear that
56
there is no warranty for the free library. Also, if the library is
57
modified by someone else and passed on, the recipients should know
58
that what they have is not the original version, so that the original
59
author's reputation will not be affected by problems that might be
60
introduced by others.
61
62
Finally, software patents pose a constant threat to the existence of
63
any free program. We wish to make sure that a company cannot
64
effectively restrict the users of a free program by obtaining a
65
restrictive license from a patent holder. Therefore, we insist that
66
any patent license obtained for a version of the library must be
67
consistent with the full freedom of use specified in this license.
68
69
Most GNU software, including some libraries, is covered by the
70
ordinary GNU General Public License. This license, the GNU Lesser
71
General Public License, applies to certain designated libraries, and
72
is quite different from the ordinary General Public License. We use
73
this license for certain libraries in order to permit linking those
74
libraries into non-free programs.
75
76
When a program is linked with a library, whether statically or using
77
a shared library, the combination of the two is legally speaking a
78
combined work, a derivative of the original library. The ordinary
79
General Public License therefore permits such linking only if the
80
entire combination fits its criteria of freedom. The Lesser General
81
Public License permits more lax criteria for linking other code with
82
the library.
83
84
We call this license the "Lesser" General Public License because it
85
does Less to protect the user's freedom than the ordinary General
86
Public License. It also provides other free software developers Less
87
of an advantage over competing non-free programs. These disadvantages
88
are the reason we use the ordinary General Public License for many
89
libraries. However, the Lesser license provides advantages in certain
90
special circumstances.
91
92
For example, on rare occasions, there may be a special need to
93
encourage the widest possible use of a certain library, so that it becomes
94
a de-facto standard. To achieve this, non-free programs must be
95
allowed to use the library. A more frequent case is that a free
96
library does the same job as widely used non-free libraries. In this
97
case, there is little to gain by limiting the free library to free
98
software only, so we use the Lesser General Public License.
99
100
In other cases, permission to use a particular library in non-free
101
programs enables a greater number of people to use a large body of
102
free software. For example, permission to use the GNU C Library in
103
non-free programs enables many more people to use the whole GNU
104
operating system, as well as its variant, the GNU/Linux operating
105
system.
106
107
Although the Lesser General Public License is Less protective of the
108
users' freedom, it does ensure that the user of a program that is
109
linked with the Library has the freedom and the wherewithal to run
110
that program using a modified version of the Library.
111
112
The precise terms and conditions for copying, distribution and
113
modification follow. Pay close attention to the difference between a
114
"work based on the library" and a "work that uses the library". The
115
former contains code derived from the library, whereas the latter must
116
be combined with the library in order to run.
117
118
GNU LESSER GENERAL PUBLIC LICENSE
119
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
120
121
0. This License Agreement applies to any software library or other
122
program which contains a notice placed by the copyright holder or
123
other authorized party saying it may be distributed under the terms of
124
this Lesser General Public License (also called "this License").
125
Each licensee is addressed as "you".
126
127
A "library" means a collection of software functions and/or data
128
prepared so as to be conveniently linked with application programs
129
(which use some of those functions and data) to form executables.
130
131
The "Library", below, refers to any such software library or work
132
which has been distributed under these terms. A "work based on the
133
Library" means either the Library or any derivative work under
134
copyright law: that is to say, a work containing the Library or a
135
portion of it, either verbatim or with modifications and/or translated
136
straightforwardly into another language. (Hereinafter, translation is
137
included without limitation in the term "modification".)
138
139
"Source code" for a work means the preferred form of the work for
140
making modifications to it. For a library, complete source code means
141
all the source code for all modules it contains, plus any associated
142
interface definition files, plus the scripts used to control compilation
143
and installation of the library.
144
145
Activities other than copying, distribution and modification are not
146
covered by this License; they are outside its scope. The act of
147
running a program using the Library is not restricted, and output from
148
such a program is covered only if its contents constitute a work based
149
on the Library (independent of the use of the Library in a tool for
150
writing it). Whether that is true depends on what the Library does
151
and what the program that uses the Library does.
152
153
1. You may copy and distribute verbatim copies of the Library's
154
complete source code as you receive it, in any medium, provided that
155
you conspicuously and appropriately publish on each copy an
156
appropriate copyright notice and disclaimer of warranty; keep intact
157
all the notices that refer to this License and to the absence of any
158
warranty; and distribute a copy of this License along with the
159
Library.
160
161
You may charge a fee for the physical act of transferring a copy,
162
and you may at your option offer warranty protection in exchange for a
163
fee.
164
165
2. You may modify your copy or copies of the Library or any portion
166
of it, thus forming a work based on the Library, and copy and
167
distribute such modifications or work under the terms of Section 1
168
above, provided that you also meet all of these conditions:
169
170
a) The modified work must itself be a software library.
171
172
b) You must cause the files modified to carry prominent notices
173
stating that you changed the files and the date of any change.
174
175
c) You must cause the whole of the work to be licensed at no
176
charge to all third parties under the terms of this License.
177
178
d) If a facility in the modified Library refers to a function or a
179
table of data to be supplied by an application program that uses
180
the facility, other than as an argument passed when the facility
181
is invoked, then you must make a good faith effort to ensure that,
182
in the event an application does not supply such function or
183
table, the facility still operates, and performs whatever part of
184
its purpose remains meaningful.
185
186
(For example, a function in a library to compute square roots has
187
a purpose that is entirely well-defined independent of the
188
application. Therefore, Subsection 2d requires that any
189
application-supplied function or table used by this function must
190
be optional: if the application does not supply it, the square
191
root function must still compute square roots.)
192
193
These requirements apply to the modified work as a whole. If
194
identifiable sections of that work are not derived from the Library,
195
and can be reasonably considered independent and separate works in
196
themselves, then this License, and its terms, do not apply to those
197
sections when you distribute them as separate works. But when you
198
distribute the same sections as part of a whole which is a work based
199
on the Library, the distribution of the whole must be on the terms of
200
this License, whose permissions for other licensees extend to the
201
entire whole, and thus to each and every part regardless of who wrote
202
it.
203
204
Thus, it is not the intent of this section to claim rights or contest
205
your rights to work written entirely by you; rather, the intent is to
206
exercise the right to control the distribution of derivative or
207
collective works based on the Library.
208
209
In addition, mere aggregation of another work not based on the Library
210
with the Library (or with a work based on the Library) on a volume of
211
a storage or distribution medium does not bring the other work under
212
the scope of this License.
213
214
3. You may opt to apply the terms of the ordinary GNU General Public
215
License instead of this License to a given copy of the Library. To do
216
this, you must alter all the notices that refer to this License, so
217
that they refer to the ordinary GNU General Public License, version 2,
218
instead of to this License. (If a newer version than version 2 of the
219
ordinary GNU General Public License has appeared, then you can specify
220
that version instead if you wish.) Do not make any other change in
221
these notices.
222
223
Once this change is made in a given copy, it is irreversible for
224
that copy, so the ordinary GNU General Public License applies to all
225
subsequent copies and derivative works made from that copy.
226
227
This option is useful when you wish to copy part of the code of
228
the Library into a program that is not a library.
229
230
4. You may copy and distribute the Library (or a portion or
231
derivative of it, under Section 2) in object code or executable form
232
under the terms of Sections 1 and 2 above provided that you accompany
233
it with the complete corresponding machine-readable source code, which
234
must be distributed under the terms of Sections 1 and 2 above on a
235
medium customarily used for software interchange.
236
237
If distribution of object code is made by offering access to copy
238
from a designated place, then offering equivalent access to copy the
239
source code from the same place satisfies the requirement to
240
distribute the source code, even though third parties are not
241
compelled to copy the source along with the object code.
242
243
5. A program that contains no derivative of any portion of the
244
Library, but is designed to work with the Library by being compiled or
245
linked with it, is called a "work that uses the Library". Such a
246
work, in isolation, is not a derivative work of the Library, and
247
therefore falls outside the scope of this License.
248
249
However, linking a "work that uses the Library" with the Library
250
creates an executable that is a derivative of the Library (because it
251
contains portions of the Library), rather than a "work that uses the
252
library". The executable is therefore covered by this License.
253
Section 6 states terms for distribution of such executables.
254
255
When a "work that uses the Library" uses material from a header file
256
that is part of the Library, the object code for the work may be a
257
derivative work of the Library even though the source code is not.
258
Whether this is true is especially significant if the work can be
259
linked without the Library, or if the work is itself a library. The
260
threshold for this to be true is not precisely defined by law.
261
262
If such an object file uses only numerical parameters, data
263
structure layouts and accessors, and small macros and small inline
264
functions (ten lines or less in length), then the use of the object
265
file is unrestricted, regardless of whether it is legally a derivative
266
work. (Executables containing this object code plus portions of the
267
Library will still fall under Section 6.)
268
269
Otherwise, if the work is a derivative of the Library, you may
270
distribute the object code for the work under the terms of Section 6.
271
Any executables containing that work also fall under Section 6,
272
whether or not they are linked directly with the Library itself.
273
274
6. As an exception to the Sections above, you may also combine or
275
link a "work that uses the Library" with the Library to produce a
276
work containing portions of the Library, and distribute that work
277
under terms of your choice, provided that the terms permit
278
modification of the work for the customer's own use and reverse
279
engineering for debugging such modifications.
280
281
You must give prominent notice with each copy of the work that the
282
Library is used in it and that the Library and its use are covered by
283
this License. You must supply a copy of this License. If the work
284
during execution displays copyright notices, you must include the
285
copyright notice for the Library among them, as well as a reference
286
directing the user to the copy of this License. Also, you must do one
287
of these things:
288
289
a) Accompany the work with the complete corresponding
290
machine-readable source code for the Library including whatever
291
changes were used in the work (which must be distributed under
292
Sections 1 and 2 above); and, if the work is an executable linked
293
with the Library, with the complete machine-readable "work that
294
uses the Library", as object code and/or source code, so that the
295
user can modify the Library and then relink to produce a modified
296
executable containing the modified Library. (It is understood
297
that the user who changes the contents of definitions files in the
298
Library will not necessarily be able to recompile the application
299
to use the modified definitions.)
300
301
b) Use a suitable shared library mechanism for linking with the
302
Library. A suitable mechanism is one that (1) uses at run time a
303
copy of the library already present on the user's computer system,
304
rather than copying library functions into the executable, and (2)
305
will operate properly with a modified version of the library, if
306
the user installs one, as long as the modified version is
307
interface-compatible with the version that the work was made with.
308
309
c) Accompany the work with a written offer, valid for at
310
least three years, to give the same user the materials
311
specified in Subsection 6a, above, for a charge no more
312
than the cost of performing this distribution.
313
314
d) If distribution of the work is made by offering access to copy
315
from a designated place, offer equivalent access to copy the above
316
specified materials from the same place.
317
318
e) Verify that the user has already received a copy of these
319
materials or that you have already sent this user a copy.
320
321
For an executable, the required form of the "work that uses the
322
Library" must include any data and utility programs needed for
323
reproducing the executable from it. However, as a special exception,
324
the materials to be distributed need not include anything that is
325
normally distributed (in either source or binary form) with the major
326
components (compiler, kernel, and so on) of the operating system on
327
which the executable runs, unless that component itself accompanies
328
the executable.
329
330
It may happen that this requirement contradicts the license
331
restrictions of other proprietary libraries that do not normally
332
accompany the operating system. Such a contradiction means you cannot
333
use both them and the Library together in an executable that you
334
distribute.
335
336
7. You may place library facilities that are a work based on the
337
Library side-by-side in a single library together with other library
338
facilities not covered by this License, and distribute such a combined
339
library, provided that the separate distribution of the work based on
340
the Library and of the other library facilities is otherwise
341
permitted, and provided that you do these two things:
342
343
a) Accompany the combined library with a copy of the same work
344
based on the Library, uncombined with any other library
345
facilities. This must be distributed under the terms of the
346
Sections above.
347
348
b) Give prominent notice with the combined library of the fact
349
that part of it is a work based on the Library, and explaining
350
where to find the accompanying uncombined form of the same work.
351
352
8. You may not copy, modify, sublicense, link with, or distribute
353
the Library except as expressly provided under this License. Any
354
attempt otherwise to copy, modify, sublicense, link with, or
355
distribute the Library is void, and will automatically terminate your
356
rights under this License. However, parties who have received copies,
357
or rights, from you under this License will not have their licenses
358
terminated so long as such parties remain in full compliance.
359
360
9. You are not required to accept this License, since you have not
361
signed it. However, nothing else grants you permission to modify or
362
distribute the Library or its derivative works. These actions are
363
prohibited by law if you do not accept this License. Therefore, by
364
modifying or distributing the Library (or any work based on the
365
Library), you indicate your acceptance of this License to do so, and
366
all its terms and conditions for copying, distributing or modifying
367
the Library or works based on it.
368
369
10. Each time you redistribute the Library (or any work based on the
370
Library), the recipient automatically receives a license from the
371
original licensor to copy, distribute, link with or modify the Library
372
subject to these terms and conditions. You may not impose any further
373
restrictions on the recipients' exercise of the rights granted herein.
374
You are not responsible for enforcing compliance by third parties with
375
this License.
376
377
11. If, as a consequence of a court judgment or allegation of patent
378
infringement or for any other reason (not limited to patent issues),
379
conditions are imposed on you (whether by court order, agreement or
380
otherwise) that contradict the conditions of this License, they do not
381
excuse you from the conditions of this License. If you cannot
382
distribute so as to satisfy simultaneously your obligations under this
383
License and any other pertinent obligations, then as a consequence you
384
may not distribute the Library at all. For example, if a patent
385
license would not permit royalty-free redistribution of the Library by
386
all those who receive copies directly or indirectly through you, then
387
the only way you could satisfy both it and this License would be to
388
refrain entirely from distribution of the Library.
389
390
If any portion of this section is held invalid or unenforceable under any
391
particular circumstance, the balance of the section is intended to apply,
392
and the section as a whole is intended to apply in other circumstances.
393
394
It is not the purpose of this section to induce you to infringe any
395
patents or other property right claims or to contest validity of any
396
such claims; this section has the sole purpose of protecting the
397
integrity of the free software distribution system which is
398
implemented by public license practices. Many people have made
399
generous contributions to the wide range of software distributed
400
through that system in reliance on consistent application of that
401
system; it is up to the author/donor to decide if he or she is willing
402
to distribute software through any other system and a licensee cannot
403
impose that choice.
404
405
This section is intended to make thoroughly clear what is believed to
406
be a consequence of the rest of this License.
407
408
12. If the distribution and/or use of the Library is restricted in
409
certain countries either by patents or by copyrighted interfaces, the
410
original copyright holder who places the Library under this License may add
411
an explicit geographical distribution limitation excluding those countries,
412
so that distribution is permitted only in or among countries not thus
413
excluded. In such case, this License incorporates the limitation as if
414
written in the body of this License.
415
416
13. The Free Software Foundation may publish revised and/or new
417
versions of the Lesser General Public License from time to time.
418
Such new versions will be similar in spirit to the present version,
419
but may differ in detail to address new problems or concerns.
420
421
Each version is given a distinguishing version number. If the Library
422
specifies a version number of this License which applies to it and
423
"any later version", you have the option of following the terms and
424
conditions either of that version or of any later version published by
425
the Free Software Foundation. If the Library does not specify a
426
license version number, you may choose any version ever published by
427
the Free Software Foundation.
428
429
14. If you wish to incorporate parts of the Library into other free
430
programs whose distribution conditions are incompatible with these,
431
write to the author to ask for permission. For software which is
432
copyrighted by the Free Software Foundation, write to the Free
433
Software Foundation; we sometimes make exceptions for this. Our
434
decision will be guided by the two goals of preserving the free status
435
of all derivatives of our free software and of promoting the sharing
436
and reuse of software generally.
437
438
NO WARRANTY
439
440
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
441
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
442
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
443
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
444
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
445
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
446
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
447
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
448
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
449
450
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
451
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
452
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
453
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
454
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
455
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
456
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
457
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
458
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
459
DAMAGES.
460
461
END OF TERMS AND CONDITIONS
462
463
How to Apply These Terms to Your New Libraries
464
465
If you develop a new library, and you want it to be of the greatest
466
possible use to the public, we recommend making it free software that
467
everyone can redistribute and change. You can do so by permitting
468
redistribution under these terms (or, alternatively, under the terms of the
469
ordinary General Public License).
470
471
To apply these terms, attach the following notices to the library. It is
472
safest to attach them to the start of each source file to most effectively
473
convey the exclusion of warranty; and each file should have at least the
474
"copyright" line and a pointer to where the full notice is found.
475
476
liblognorm, a fast samples-based log normalization library
477
Copyright (C) 2010 Rainer Gerhards
478
479
This library is free software; you can redistribute it and/or
480
modify it under the terms of the GNU Lesser General Public
481
License as published by the Free Software Foundation; either
482
version 2.1 of the License, or (at your option) any later version.
483
484
This library is distributed in the hope that it will be useful,
485
but WITHOUT ANY WARRANTY; without even the implied warranty of
486
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
487
Lesser General Public License for more details.
488
489
You should have received a copy of the GNU Lesser General Public
490
License along with this library; if not, write to the Free Software
491
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
492
Loggerhead is a web-based interface for Breezy
Version: 2.0.1