summaryrefslogtreecommitdiff
path: root/doc
authorzecke <zecke>2003-04-15 18:54:29 (UTC)
committer zecke <zecke>2003-04-15 18:54:29 (UTC)
commitdfa2d294b3af09bf3757a3c2294a925093e72fc6 (patch) (unidiff)
tree4912b4d7c74bf78e6903ec0304625a69580b6ffe /doc
parentf145f985e6635dbee2df3c04a9f2220e36f5512f (diff)
downloadopie-dfa2d294b3af09bf3757a3c2294a925093e72fc6.zip
opie-dfa2d294b3af09bf3757a3c2294a925093e72fc6.tar.gz
opie-dfa2d294b3af09bf3757a3c2294a925093e72fc6.tar.bz2
Add common web files for our API docu
Add the Doxyfiles for library, libopie, libopie/pim, qt Add a script to generate our API docs You need to set OPIEDIR and QTDIR ./generate_apidox and you'll find your APIDOCS inside $OPIEDIR/apidocs have fun
Diffstat (limited to 'doc') (more/less context) (show whitespace changes)
-rw-r--r--doc/Doxyfile_libopie972
-rw-r--r--doc/Doxyfile_libqpe971
-rw-r--r--doc/Doxyfile_main975
-rw-r--r--doc/Doxyfile_pim973
-rw-r--r--doc/README1
-rw-r--r--doc/common/1.pngbin0 -> 329 bytes
-rw-r--r--doc/common/10.pngbin0 -> 361 bytes
-rw-r--r--doc/common/2.pngbin0 -> 353 bytes
-rw-r--r--doc/common/3.pngbin0 -> 350 bytes
-rw-r--r--doc/common/4.pngbin0 -> 345 bytes
-rw-r--r--doc/common/5.pngbin0 -> 348 bytes
-rw-r--r--doc/common/6.pngbin0 -> 355 bytes
-rw-r--r--doc/common/7.pngbin0 -> 344 bytes
-rw-r--r--doc/common/8.pngbin0 -> 357 bytes
-rw-r--r--doc/common/9.pngbin0 -> 357 bytes
-rwxr-xr-xdoc/common/artistic-license.html165
-rw-r--r--doc/common/bottom1.pngbin0 -> 168 bytes
-rw-r--r--doc/common/bottom2.pngbin0 -> 6979 bytes
-rwxr-xr-xdoc/common/bsd-license.html45
-rw-r--r--doc/common/docheadergears.pngbin0 -> 10894 bytes
-rw-r--r--doc/common/doctop1.pngbin0 -> 12235 bytes
-rwxr-xr-xdoc/common/doctop1a-online.pngbin0 -> 444 bytes
-rwxr-xr-xdoc/common/doctop1a.pngbin0 -> 850 bytes
-rw-r--r--doc/common/doctop1b.pngbin0 -> 2313 bytes
-rw-r--r--doc/common/doctop2-online.pngbin0 -> 257 bytes
-rw-r--r--doc/common/doctop2.pngbin0 -> 260 bytes
-rwxr-xr-xdoc/common/doxygen.css152
-rw-r--r--doc/common/fdl-license.html353
-rwxr-xr-xdoc/common/footer.html14
-rw-r--r--doc/common/gpl-license.html381
-rw-r--r--doc/common/grad.pngbin0 -> 248 bytes
-rwxr-xr-xdoc/common/header.html34
-rw-r--r--doc/common/headerbg.pngbin0 -> 493 bytes
-rw-r--r--doc/common/kde-common.css32
-rw-r--r--doc/common/kde-default.css228
-rw-r--r--doc/common/kde-web.css178
-rw-r--r--doc/common/kde_logo.pngbin0 -> 29911 bytes
-rw-r--r--doc/common/kde_logo_bg.pngbin0 -> 199 bytes
-rwxr-xr-xdoc/common/kmenu.pngbin0 -> 845 bytes
-rw-r--r--doc/common/lgpl-license.html502
-rwxr-xr-xdoc/common/mainfooter.html14
-rwxr-xr-xdoc/common/mainheader.html29
-rwxr-xr-xdoc/common/qpl-license.html164
-rw-r--r--doc/common/shadow.pngbin0 -> 213 bytes
-rw-r--r--doc/common/web-docbottom.pngbin0 -> 6762 bytes
-rw-r--r--doc/common/web-doctop.pngbin0 -> 14939 bytes
-rwxr-xr-xdoc/common/x11-license.html45
-rw-r--r--doc/common/xml.dcl179
-rwxr-xr-xdoc/generate_apidox54
49 files changed, 6461 insertions, 0 deletions
diff --git a/doc/Doxyfile_libopie b/doc/Doxyfile_libopie
new file mode 100644
index 0000000..4a2872d
--- a/dev/null
+++ b/doc/Doxyfile_libopie
@@ -0,0 +1,972 @@
1# Doxyfile 1.2.15
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# General configuration options
15#---------------------------------------------------------------------------
16
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18# by quotes) that should identify the project.
19
20PROJECT_NAME =
21
22# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or
24# if some version control system is used.
25
26PROJECT_NUMBER =
27
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29# base path where the generated documentation will be put.
30# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.
32
33OUTPUT_DIRECTORY = ../apidocs/
34
35# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36# documentation generated by doxygen is written. Doxygen will use this
37# information to generate all constant output in the proper language.
38# The default language is English, other supported languages are:
39# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
40# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
41# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
42
43OUTPUT_LANGUAGE = English
44
45# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
46# documentation are documented, even if no documentation was available.
47# Private class members and static file members will be hidden unless
48# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
49
50EXTRACT_ALL = NO
51
52# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
53# will be included in the documentation.
54
55EXTRACT_PRIVATE = NO
56
57# If the EXTRACT_STATIC tag is set to YES all static members of a file
58# will be included in the documentation.
59
60EXTRACT_STATIC = YES
61
62# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
63# defined locally in source files will be included in the documentation.
64# If set to NO only classes defined in header files are included.
65
66EXTRACT_LOCAL_CLASSES = NO
67
68# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
69# undocumented members of documented classes, files or namespaces.
70# If set to NO (the default) these members will be included in the
71# various overviews, but no documentation section is generated.
72# This option has no effect if EXTRACT_ALL is enabled.
73
74HIDE_UNDOC_MEMBERS = NO
75
76# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
77# undocumented classes that are normally visible in the class hierarchy.
78# If set to NO (the default) these class will be included in the various
79# overviews. This option has no effect if EXTRACT_ALL is enabled.
80
81HIDE_UNDOC_CLASSES = YES
82
83# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
84# include brief member descriptions after the members that are listed in
85# the file and class documentation (similar to JavaDoc).
86# Set to NO to disable this.
87
88BRIEF_MEMBER_DESC = YES
89
90# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
91# the brief description of a member or function before the detailed description.
92# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
93# brief descriptions will be completely suppressed.
94
95REPEAT_BRIEF = YES
96
97# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
98# Doxygen will generate a detailed section even if there is only a brief
99# description.
100
101ALWAYS_DETAILED_SEC = YES
102
103# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
104# members of a class in the documentation of that class as if those members were
105# ordinary class members. Constructors, destructors and assignment operators of
106# the base classes will not be shown.
107
108INLINE_INHERITED_MEMB = NO
109
110# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
111# path before files name in the file list and in the header files. If set
112# to NO the shortest path that makes the file name unique will be used.
113
114FULL_PATH_NAMES = NO
115
116# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
117# can be used to strip a user defined part of the path. Stripping is
118# only done if one of the specified strings matches the left-hand part of
119# the path. It is allowed to use relative paths in the argument list.
120
121STRIP_FROM_PATH =
122
123# The INTERNAL_DOCS tag determines if documentation
124# that is typed after a \internal command is included. If the tag is set
125# to NO (the default) then the documentation will be excluded.
126# Set it to YES to include the internal documentation.
127
128INTERNAL_DOCS = NO
129
130# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
131# doxygen to hide any special comment blocks from generated source code
132# fragments. Normal C and C++ comments will always remain visible.
133
134STRIP_CODE_COMMENTS = YES
135
136# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
137# file names in lower case letters. If set to YES upper case letters are also
138# allowed. This is useful if you have classes or files whose names only differ
139# in case and if your file system supports case sensitive file names. Windows
140# users are adviced to set this option to NO.
141
142CASE_SENSE_NAMES = YES
143
144# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
145# (but less readable) file names. This can be useful is your file systems
146# doesn't support long names like on DOS, Mac, or CD-ROM.
147
148SHORT_NAMES = NO
149
150# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
151# will show members with their full class and namespace scopes in the
152# documentation. If set to YES the scope will be hidden.
153
154HIDE_SCOPE_NAMES = NO
155
156# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
157# will generate a verbatim copy of the header file for each class for
158# which an include is specified. Set to NO to disable this.
159
160VERBATIM_HEADERS = YES
161
162# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
163# will put list of the files that are included by a file in the documentation
164# of that file.
165
166SHOW_INCLUDE_FILES = YES
167
168# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
169# will interpret the first line (until the first dot) of a JavaDoc-style
170# comment as the brief description. If set to NO, the JavaDoc
171# comments will behave just like the Qt-style comments (thus requiring an
172# explict @brief command for a brief description.
173
174JAVADOC_AUTOBRIEF = YES
175
176# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
177# member inherits the documentation from any documented member that it
178# reimplements.
179
180INHERIT_DOCS = YES
181
182# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
183# is inserted in the documentation for inline members.
184
185INLINE_INFO = YES
186
187# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
188# will sort the (detailed) documentation of file and class members
189# alphabetically by member name. If set to NO the members will appear in
190# declaration order.
191
192SORT_MEMBER_DOCS = NO
193
194# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
195# tag is set to YES, then doxygen will reuse the documentation of the first
196# member in the group (if any) for the other members of the group. By default
197# all members of a group must be documented explicitly.
198
199DISTRIBUTE_GROUP_DOC = NO
200
201# The TAB_SIZE tag can be used to set the number of spaces in a tab.
202# Doxygen uses this value to replace tabs by spaces in code fragments.
203
204TAB_SIZE = 4
205
206# The GENERATE_TODOLIST tag can be used to enable (YES) or
207# disable (NO) the todo list. This list is created by putting \todo
208# commands in the documentation.
209
210GENERATE_TODOLIST = NO
211
212# The GENERATE_TESTLIST tag can be used to enable (YES) or
213# disable (NO) the test list. This list is created by putting \test
214# commands in the documentation.
215
216GENERATE_TESTLIST = NO
217
218# The GENERATE_BUGLIST tag can be used to enable (YES) or
219# disable (NO) the bug list. This list is created by putting \bug
220# commands in the documentation.
221
222GENERATE_BUGLIST = YES
223
224# This tag can be used to specify a number of aliases that acts
225# as commands in the documentation. An alias has the form "name=value".
226# For example adding "sideeffect=\par Side Effects:\n" will allow you to
227# put the command \sideeffect (or @sideeffect) in the documentation, which
228# will result in a user defined paragraph with heading "Side Effects:".
229# You can put \n's in the value part of an alias to insert newlines.
230
231# @ref in KDE docu are for kdoc, doxygen doesn't need them, so we alias them
232# to nothing here
233
234ALIASES = libdoc=@mainpage \
235 sect=<p><b> \
236 reimplemented= \
237 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \
238 obsolete=@deprecated \
239 ref=
240
241# The ENABLED_SECTIONS tag can be used to enable conditional
242# documentation sections, marked by \if sectionname ... \endif.
243
244ENABLED_SECTIONS =
245
246# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
247# the initial value of a variable or define consist of for it to appear in
248# the documentation. If the initializer consists of more lines than specified
249# here it will be hidden. Use a value of 0 to hide initializers completely.
250# The appearance of the initializer of individual variables and defines in the
251# documentation can be controlled using \showinitializer or \hideinitializer
252# command in the documentation regardless of this setting.
253
254MAX_INITIALIZER_LINES = 30
255
256# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
257# only. Doxygen will then generate output that is more tailored for C.
258# For instance some of the names that are used will be different. The list
259# of all members will be omitted, etc.
260
261OPTIMIZE_OUTPUT_FOR_C = NO
262
263# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
264# only. Doxygen will then generate output that is more tailored for Java.
265# For instance namespaces will be presented as packages, qualified scopes
266# will look different, etc.
267
268OPTIMIZE_OUTPUT_JAVA = NO
269
270# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
271# at the bottom of the documentation of classes and structs. If set to YES the
272# list will mention the files that were used to generate the documentation.
273
274SHOW_USED_FILES = YES
275
276#---------------------------------------------------------------------------
277# configuration options related to warning and progress messages
278#---------------------------------------------------------------------------
279
280# The QUIET tag can be used to turn on/off the messages that are generated
281# by doxygen. Possible values are YES and NO. If left blank NO is used.
282
283QUIET = YES
284
285# The WARNINGS tag can be used to turn on/off the warning messages that are
286# generated by doxygen. Possible values are YES and NO. If left blank
287# NO is used.
288
289WARNINGS = YES
290
291# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
292# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
293# automatically be disabled.
294
295WARN_IF_UNDOCUMENTED = YES
296
297# The WARN_FORMAT tag determines the format of the warning messages that
298# doxygen can produce. The string should contain the $file, $line, and $text
299# tags, which will be replaced by the file and line number from which the
300# warning originated and the warning text.
301
302WARN_FORMAT = "$file:$line: $text"
303
304# The WARN_LOGFILE tag can be used to specify a file to which warning
305# and error messages should be written. If left blank the output is written
306# to stderr.
307
308WARN_LOGFILE = Dox-Warning
309
310#---------------------------------------------------------------------------
311# configuration options related to the input files
312#---------------------------------------------------------------------------
313
314# The INPUT tag can be used to specify the files and/or directories that contain
315# documented source files. You may enter file names like "myfile.cpp" or
316# directories like "/usr/src/myproject". Separate the files or directories
317# with spaces.
318
319INPUT =
320
321# If the value of the INPUT tag contains directories, you can use the
322# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
323# and *.h) to filter out the source-files in the directories. If left
324# blank the following patterns are tested:
325# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
326# *.h++ *.idl *.odl
327
328FILE_PATTERNS = *.h \
329 *.cpp \
330 *.cc \
331 *.hpp
332
333# The RECURSIVE tag can be used to turn specify whether or not subdirectories
334# should be searched for input files as well. Possible values are YES and NO.
335# If left blank NO is used.
336
337RECURSIVE = NO
338
339# The EXCLUDE tag can be used to specify files and/or directories that should
340# excluded from the INPUT source files. This way you can easily exclude a
341# subdirectory from a directory tree whose root is specified with the INPUT tag.
342
343EXCLUDE =
344
345# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
346# that are symbolic links (a Unix filesystem feature) are excluded from the input.
347
348EXCLUDE_SYMLINKS = NO
349
350# If the value of the INPUT tag contains directories, you can use the
351# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
352# certain files from those directories.
353
354EXCLUDE_PATTERNS = *.moc.* \
355 moc* \
356 *.all_cpp.* \
357 *unload.* \
358 */test/* \
359 */tests/*
360
361# The EXAMPLE_PATH tag can be used to specify one or more files or
362# directories that contain example code fragments that are included (see
363# the \include command).
364
365EXAMPLE_PATH =
366
367# If the value of the EXAMPLE_PATH tag contains directories, you can use the
368# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
369# and *.h) to filter out the source-files in the directories. If left
370# blank all files are included.
371
372EXAMPLE_PATTERNS =
373
374# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
375# searched for input files to be used with the \include or \dontinclude
376# commands irrespective of the value of the RECURSIVE tag.
377# Possible values are YES and NO. If left blank NO is used.
378
379EXAMPLE_RECURSIVE = NO
380
381# The IMAGE_PATH tag can be used to specify one or more files or
382# directories that contain image that are included in the documentation (see
383# the \image command).
384
385IMAGE_PATH =
386
387# The INPUT_FILTER tag can be used to specify a program that doxygen should
388# invoke to filter for each input file. Doxygen will invoke the filter program
389# by executing (via popen()) the command <filter> <input-file>, where <filter>
390# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
391# input file. Doxygen will then use the output that the filter program writes
392# to standard output.
393
394INPUT_FILTER =
395
396# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
397# INPUT_FILTER) will be used to filter the input files when producing source
398# files to browse.
399
400FILTER_SOURCE_FILES = NO
401
402#---------------------------------------------------------------------------
403# configuration options related to source browsing
404#---------------------------------------------------------------------------
405
406# If the SOURCE_BROWSER tag is set to YES then a list of source files will
407# be generated. Documented entities will be cross-referenced with these sources.
408
409SOURCE_BROWSER = YES
410
411# Setting the INLINE_SOURCES tag to YES will include the body
412# of functions and classes directly in the documentation.
413
414INLINE_SOURCES = NO
415
416# If the REFERENCED_BY_RELATION tag is set to YES (the default)
417# then for each documented function all documented
418# functions referencing it will be listed.
419
420REFERENCED_BY_RELATION = YES
421
422# If the REFERENCES_RELATION tag is set to YES (the default)
423# then for each documented function all documented entities
424# called/used by that function will be listed.
425
426REFERENCES_RELATION = YES
427
428#---------------------------------------------------------------------------
429# configuration options related to the alphabetical class index
430#---------------------------------------------------------------------------
431
432# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
433# of all compounds will be generated. Enable this if the project
434# contains a lot of classes, structs, unions or interfaces.
435
436ALPHABETICAL_INDEX = YES
437
438# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
439# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
440# in which this list will be split (can be a number in the range [1..20])
441
442COLS_IN_ALPHA_INDEX = 3
443
444# In case all classes in a project start with a common prefix, all
445# classes will be put under the same header in the alphabetical index.
446# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
447# should be ignored while generating the index headers.
448
449IGNORE_PREFIX = K
450
451#---------------------------------------------------------------------------
452# configuration options related to the HTML output
453#---------------------------------------------------------------------------
454
455# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
456# generate HTML output.
457
458GENERATE_HTML = NO
459
460# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
461# If a relative path is entered the value of OUTPUT_DIRECTORY will be
462# put in front of it. If left blank `html' will be used as the default path.
463
464HTML_OUTPUT =
465
466# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
467# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
468# doxygen will generate files with .html extension.
469
470HTML_FILE_EXTENSION = .html
471
472# The HTML_HEADER tag can be used to specify a personal HTML header for
473# each generated HTML page. If it is left blank doxygen will generate a
474# standard header.
475
476HTML_HEADER = ../apidocs/common/header.html
477
478# The HTML_FOOTER tag can be used to specify a personal HTML footer for
479# each generated HTML page. If it is left blank doxygen will generate a
480# standard footer.
481
482HTML_FOOTER = ../apidocs/common/footer.html
483
484# The HTML_STYLESHEET tag can be used to specify a user defined cascading
485# style sheet that is used by each HTML page. It can be used to
486# fine-tune the look of the HTML output. If the tag is left blank doxygen
487# will generate a default style sheet
488
489HTML_STYLESHEET = ../apidocs/common/doxygen.css
490
491# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
492# files or namespaces will be aligned in HTML using tables. If set to
493# NO a bullet list will be used.
494
495HTML_ALIGN_MEMBERS = YES
496
497# If the GENERATE_HTMLHELP tag is set to YES, additional index files
498# will be generated that can be used as input for tools like the
499# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
500# of the generated HTML documentation.
501
502GENERATE_HTMLHELP = NO
503
504# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
505# controls if a separate .chi index file is generated (YES) or that
506# it should be included in the master .chm file (NO).
507
508GENERATE_CHI = NO
509
510# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
511# controls whether a binary table of contents is generated (YES) or a
512# normal table of contents (NO) in the .chm file.
513
514BINARY_TOC = NO
515
516# The TOC_EXPAND flag can be set to YES to add extra items for group members
517# to the contents of the Html help documentation and to the tree view.
518
519TOC_EXPAND = NO
520
521# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
522# top of each HTML page. The value NO (the default) enables the index and
523# the value YES disables it.
524
525DISABLE_INDEX = YES
526
527# This tag can be used to set the number of enum values (range [1..20])
528# that doxygen will group on one line in the generated HTML documentation.
529
530ENUM_VALUES_PER_LINE = 4
531
532# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
533# generated containing a tree-like index structure (just like the one that
534# is generated for HTML Help). For this to work a browser that supports
535# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
536# or Internet explorer 4.0+). Note that for large projects the tree generation
537# can take a very long time. In such cases it is better to disable this feature.
538# Windows users are probably better off using the HTML help feature.
539
540GENERATE_TREEVIEW = NO
541
542# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
543# used to set the initial width (in pixels) of the frame in which the tree
544# is shown.
545
546TREEVIEW_WIDTH = 250
547
548#---------------------------------------------------------------------------
549# configuration options related to the LaTeX output
550#---------------------------------------------------------------------------
551
552# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
553# generate Latex output.
554
555GENERATE_LATEX = NO
556
557# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
558# If a relative path is entered the value of OUTPUT_DIRECTORY will be
559# put in front of it. If left blank `latex' will be used as the default path.
560
561LATEX_OUTPUT =
562
563# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
564
565LATEX_CMD_NAME = latex
566
567# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
568# generate index for LaTeX. If left blank `makeindex' will be used as the
569# default command name.
570
571MAKEINDEX_CMD_NAME = makeindex
572
573# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
574# LaTeX documents. This may be useful for small projects and may help to
575# save some trees in general.
576
577COMPACT_LATEX = NO
578
579# The PAPER_TYPE tag can be used to set the paper type that is used
580# by the printer. Possible values are: a4, a4wide, letter, legal and
581# executive. If left blank a4wide will be used.
582
583PAPER_TYPE = a4wide
584
585# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
586# packages that should be included in the LaTeX output.
587
588EXTRA_PACKAGES =
589
590# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
591# the generated latex document. The header should contain everything until
592# the first chapter. If it is left blank doxygen will generate a
593# standard header. Notice: only use this tag if you know what you are doing!
594
595LATEX_HEADER =
596
597# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
598# is prepared for conversion to pdf (using ps2pdf). The pdf file will
599# contain links (just like the HTML output) instead of page references
600# This makes the output suitable for online browsing using a pdf viewer.
601
602PDF_HYPERLINKS = NO
603
604# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
605# plain latex in the generated Makefile. Set this option to YES to get a
606# higher quality PDF documentation.
607
608USE_PDFLATEX = NO
609
610# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
611# command to the generated LaTeX files. This will instruct LaTeX to keep
612# running if errors occur, instead of asking the user for help.
613# This option is also used when generating formulas in HTML.
614
615LATEX_BATCHMODE = NO
616
617#---------------------------------------------------------------------------
618# configuration options related to the RTF output
619#---------------------------------------------------------------------------
620
621# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
622# The RTF output is optimised for Word 97 and may not look very pretty with
623# other RTF readers or editors.
624
625GENERATE_RTF = NO
626
627# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
628# If a relative path is entered the value of OUTPUT_DIRECTORY will be
629# put in front of it. If left blank `rtf' will be used as the default path.
630
631RTF_OUTPUT =
632
633# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
634# RTF documents. This may be useful for small projects and may help to
635# save some trees in general.
636
637COMPACT_RTF = NO
638
639# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
640# will contain hyperlink fields. The RTF file will
641# contain links (just like the HTML output) instead of page references.
642# This makes the output suitable for online browsing using WORD or other
643# programs which support those fields.
644# Note: wordpad (write) and others do not support links.
645
646RTF_HYPERLINKS = NO
647
648# Load stylesheet definitions from file. Syntax is similar to doxygen's
649# config file, i.e. a series of assigments. You only have to provide
650# replacements, missing definitions are set to their default value.
651
652RTF_STYLESHEET_FILE =
653
654# Set optional variables used in the generation of an rtf document.
655# Syntax is similar to doxygen's config file.
656
657RTF_EXTENSIONS_FILE =
658
659#---------------------------------------------------------------------------
660# configuration options related to the man page output
661#---------------------------------------------------------------------------
662
663# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
664# generate man pages
665
666GENERATE_MAN = NO
667
668# The MAN_OUTPUT tag is used to specify where the man pages will be put.
669# If a relative path is entered the value of OUTPUT_DIRECTORY will be
670# put in front of it. If left blank `man' will be used as the default path.
671
672MAN_OUTPUT =
673
674# The MAN_EXTENSION tag determines the extension that is added to
675# the generated man pages (default is the subroutine's section .3)
676
677MAN_EXTENSION = .kde3
678
679# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
680# then it will generate one additional man file for each entity
681# documented in the real man page(s). These additional files
682# only source the real man page, but without them the man command
683# would be unable to find the correct page. The default is NO.
684
685MAN_LINKS = YES
686
687#---------------------------------------------------------------------------
688# configuration options related to the XML output
689#---------------------------------------------------------------------------
690
691# If the GENERATE_XML tag is set to YES Doxygen will
692# generate an XML file that captures the structure of
693# the code including all documentation. Note that this
694# feature is still experimental and incomplete at the
695# moment.
696
697GENERATE_XML = NO
698
699#---------------------------------------------------------------------------
700# configuration options for the AutoGen Definitions output
701#---------------------------------------------------------------------------
702
703# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
704# generate an AutoGen Definitions (see autogen.sf.net) file
705# that captures the structure of the code including all
706# documentation. Note that this feature is still experimental
707# and incomplete at the moment.
708
709GENERATE_AUTOGEN_DEF = NO
710
711#---------------------------------------------------------------------------
712# Configuration options related to the preprocessor
713#---------------------------------------------------------------------------
714
715# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
716# evaluate all C-preprocessor directives found in the sources and include
717# files.
718
719ENABLE_PREPROCESSING = YES
720
721# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
722# names in the source code. If set to NO (the default) only conditional
723# compilation will be performed. Macro expansion can be done in a controlled
724# way by setting EXPAND_ONLY_PREDEF to YES.
725
726MACRO_EXPANSION = NO
727
728# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
729# then the macro expansion is limited to the macros specified with the
730# PREDEFINED and EXPAND_AS_PREDEFINED tags.
731
732EXPAND_ONLY_PREDEF = NO
733
734# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
735# in the INCLUDE_PATH (see below) will be search if a #include is found.
736
737SEARCH_INCLUDES = YES
738
739# The INCLUDE_PATH tag can be used to specify one or more directories that
740# contain include files that are not input files but should be processed by
741# the preprocessor.
742
743INCLUDE_PATH =
744
745# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
746# patterns (like *.h and *.hpp) to filter out the header-files in the
747# directories. If left blank, the patterns specified with FILE_PATTERNS will
748# be used.
749
750INCLUDE_FILE_PATTERNS =
751
752# The PREDEFINED tag can be used to specify one or more macro names that
753# are defined before the preprocessor is started (similar to the -D option of
754# gcc). The argument of the tag is a list of macros of the form: name
755# or name=definition (no spaces). If the definition and the = are
756# omitted =1 is assumed.
757
758PREDEFINED = QT_VERSION=305
759
760# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
761# this tag can be used to specify a list of macro names that should be expanded.
762# The macro definition that is found in the sources will be used.
763# Use the PREDEFINED tag if you want to use a different macro definition.
764
765EXPAND_AS_DEFINED =
766
767# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
768# doxygen's preprocessor will remove all function-like macros that are alone
769# on a line and do not end with a semicolon. Such function macros are typically
770# used for boiler-plate code, and will confuse the parser if not removed.
771
772SKIP_FUNCTION_MACROS = YES
773
774#---------------------------------------------------------------------------
775# Configuration::addtions related to external references
776#---------------------------------------------------------------------------
777
778# The TAGFILES tag can be used to specify one or more tagfiles.
779
780TAGFILES =
781
782# When a file name is specified after GENERATE_TAGFILE, doxygen will create
783# a tag file that is based on the input files it reads.
784
785GENERATE_TAGFILE =
786
787# If the ALLEXTERNALS tag is set to YES all external classes will be listed
788# in the class index. If set to NO only the inherited external classes
789# will be listed.
790
791ALLEXTERNALS = NO
792
793# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
794# in the modules index. If set to NO, only the current project's groups will
795# be listed.
796
797EXTERNAL_GROUPS = NO
798
799# The PERL_PATH should be the absolute path and name of the perl script
800# interpreter (i.e. the result of `which perl').
801
802PERL_PATH =
803
804#---------------------------------------------------------------------------
805# Configuration options related to the dot tool
806#---------------------------------------------------------------------------
807
808# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
809# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
810# super classes. Setting the tag to NO turns the diagrams off. Note that this
811# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
812# recommended to install and use dot, since it yield more powerful graphs.
813
814CLASS_DIAGRAMS = YES
815
816# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
817# available from the path. This tool is part of Graphviz, a graph visualization
818# toolkit from AT&T and Lucent Bell Labs. The other options in this section
819# have no effect if this option is set to NO (the default)
820
821HAVE_DOT = NO
822
823# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
824# will generate a graph for each documented class showing the direct and
825# indirect inheritance relations. Setting this tag to YES will force the
826# the CLASS_DIAGRAMS tag to NO.
827
828CLASS_GRAPH = YES
829
830# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
831# will generate a graph for each documented class showing the direct and
832# indirect implementation dependencies (inheritance, containment, and
833# class references variables) of the class with other documented classes.
834
835COLLABORATION_GRAPH = YES
836
837# If set to YES, the inheritance and collaboration graphs will show the
838# relations between templates and their instances.
839
840TEMPLATE_RELATIONS = YES
841
842# If set to YES, the inheritance and collaboration graphs will hide
843# inheritance and usage relations if the target is undocumented
844# or is not a class.
845
846HIDE_UNDOC_RELATIONS = NO
847
848# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
849# tags are set to YES then doxygen will generate a graph for each documented
850# file showing the direct and indirect include dependencies of the file with
851# other documented files.
852
853INCLUDE_GRAPH = YES
854
855# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
856# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
857# documented header file showing the documented files that directly or
858# indirectly include this file.
859
860INCLUDED_BY_GRAPH = YES
861
862# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
863# will graphical hierarchy of all classes instead of a textual one.
864
865GRAPHICAL_HIERARCHY = NO
866
867# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
868# generated by dot. Possible values are png, jpg, or gif
869# If left blank png will be used.
870
871DOT_IMAGE_FORMAT = png
872
873# The tag DOT_PATH can be used to specify the path where the dot tool can be
874# found. If left blank, it is assumed the dot tool can be found on the path.
875
876DOT_PATH =
877
878# The DOTFILE_DIRS tag can be used to specify one or more directories that
879# contain dot files that are included in the documentation (see the
880# \dotfile command).
881
882DOTFILE_DIRS =
883
884# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
885# (in pixels) of the graphs generated by dot. If a graph becomes larger than
886# this value, doxygen will try to truncate the graph, so that it fits within
887# the specified constraint. Beware that most browsers cannot cope with very
888# large images.
889
890MAX_DOT_GRAPH_WIDTH = 800
891
892# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
893# (in pixels) of the graphs generated by dot. If a graph becomes larger than
894# this value, doxygen will try to truncate the graph, so that it fits within
895# the specified constraint. Beware that most browsers cannot cope with very
896# large images.
897
898MAX_DOT_GRAPH_HEIGHT = 1024
899
900# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
901# generate a legend page explaining the meaning of the various boxes and
902# arrows in the dot generated graphs.
903
904GENERATE_LEGEND = YES
905
906# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
907# remove the intermedate dot files that are used to generate
908# the various graphs.
909
910DOT_CLEANUP = YES
911
912#---------------------------------------------------------------------------
913# Configuration::addtions related to the search engine
914#---------------------------------------------------------------------------
915
916# The SEARCHENGINE tag specifies whether or not a search engine should be
917# used. If set to NO the values of all tags below this one will be ignored.
918
919SEARCHENGINE = NO
920
921# The CGI_NAME tag should be the name of the CGI script that
922# starts the search engine (doxysearch) with the correct parameters.
923# A script with this name will be generated by doxygen.
924
925CGI_NAME =
926
927# The CGI_URL tag should be the absolute URL to the directory where the
928# cgi binaries are located. See the documentation of your http daemon for
929# details.
930
931CGI_URL =
932
933# The DOC_URL tag should be the absolute URL to the directory where the
934# documentation is located. If left blank the absolute path to the
935# documentation, with file:// prepended to it, will be used.
936
937DOC_URL =
938
939# The DOC_ABSPATH tag should be the absolute path to the directory where the
940# documentation is located. If left blank the directory on the local machine
941# will be used.
942
943DOC_ABSPATH =
944
945# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
946# is installed.
947
948BIN_ABSPATH =
949
950# The EXT_DOC_PATHS tag can be used to specify one or more paths to
951# documentation generated for other projects. This allows doxysearch to search
952# the documentation for these projects as well.
953
954EXT_DOC_PATHS =
955PROJECT_NAME = "libopie"
956PROJECT_NUMBER = "Version 0.9.3"
957INPUT = .
958IMAGE_PATH = ../apidocs/api
959OUTPUT_DIRECTORY = ../apidocs
960HTML_OUTPUT = libopie/html
961LATEX_OUTPUT = libopie/latex
962RTF_OUTPUT = libopie/rtf
963MAN_OUTPUT = libopie/man
964GENERATE_HTML = yes
965GENERATE_MAN = yes
966GENERATE_LATEX = yes
967TAGFILES = \
968../apidocs/qt/qt.tag=../../qt \
969../apidocs/libqpe/libqpe.tag=../../libqpe/html
970GENERATE_TAGFILE = ../apidocs/libopie/libopie.tag
971IGNORE_PREFIX = O
972HAVE_DOT = YES
diff --git a/doc/Doxyfile_libqpe b/doc/Doxyfile_libqpe
new file mode 100644
index 0000000..a26a8b0
--- a/dev/null
+++ b/doc/Doxyfile_libqpe
@@ -0,0 +1,971 @@
1# Doxyfile 1.2.15
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# General configuration options
15#---------------------------------------------------------------------------
16
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18# by quotes) that should identify the project.
19
20PROJECT_NAME = Qtopia Libs
21
22# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or
24# if some version control system is used.
25
26PROJECT_NUMBER =
27
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29# base path where the generated documentation will be put.
30# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.
32
33OUTPUT_DIRECTORY = ../apidocs/
34
35# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36# documentation generated by doxygen is written. Doxygen will use this
37# information to generate all constant output in the proper language.
38# The default language is English, other supported languages are:
39# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
40# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
41# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
42
43OUTPUT_LANGUAGE = English
44
45# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
46# documentation are documented, even if no documentation was available.
47# Private class members and static file members will be hidden unless
48# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
49
50EXTRACT_ALL = NO
51
52# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
53# will be included in the documentation.
54
55EXTRACT_PRIVATE = NO
56
57# If the EXTRACT_STATIC tag is set to YES all static members of a file
58# will be included in the documentation.
59
60EXTRACT_STATIC = YES
61
62# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
63# defined locally in source files will be included in the documentation.
64# If set to NO only classes defined in header files are included.
65
66EXTRACT_LOCAL_CLASSES = NO
67
68# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
69# undocumented members of documented classes, files or namespaces.
70# If set to NO (the default) these members will be included in the
71# various overviews, but no documentation section is generated.
72# This option has no effect if EXTRACT_ALL is enabled.
73
74HIDE_UNDOC_MEMBERS = NO
75
76# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
77# undocumented classes that are normally visible in the class hierarchy.
78# If set to NO (the default) these class will be included in the various
79# overviews. This option has no effect if EXTRACT_ALL is enabled.
80
81HIDE_UNDOC_CLASSES = YES
82
83# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
84# include brief member descriptions after the members that are listed in
85# the file and class documentation (similar to JavaDoc).
86# Set to NO to disable this.
87
88BRIEF_MEMBER_DESC = YES
89
90# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
91# the brief description of a member or function before the detailed description.
92# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
93# brief descriptions will be completely suppressed.
94
95REPEAT_BRIEF = YES
96
97# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
98# Doxygen will generate a detailed section even if there is only a brief
99# description.
100
101ALWAYS_DETAILED_SEC = YES
102
103# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
104# members of a class in the documentation of that class as if those members were
105# ordinary class members. Constructors, destructors and assignment operators of
106# the base classes will not be shown.
107
108INLINE_INHERITED_MEMB = NO
109
110# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
111# path before files name in the file list and in the header files. If set
112# to NO the shortest path that makes the file name unique will be used.
113
114FULL_PATH_NAMES = NO
115
116# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
117# can be used to strip a user defined part of the path. Stripping is
118# only done if one of the specified strings matches the left-hand part of
119# the path. It is allowed to use relative paths in the argument list.
120
121STRIP_FROM_PATH =
122
123# The INTERNAL_DOCS tag determines if documentation
124# that is typed after a \internal command is included. If the tag is set
125# to NO (the default) then the documentation will be excluded.
126# Set it to YES to include the internal documentation.
127
128INTERNAL_DOCS = NO
129
130# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
131# doxygen to hide any special comment blocks from generated source code
132# fragments. Normal C and C++ comments will always remain visible.
133
134STRIP_CODE_COMMENTS = YES
135
136# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
137# file names in lower case letters. If set to YES upper case letters are also
138# allowed. This is useful if you have classes or files whose names only differ
139# in case and if your file system supports case sensitive file names. Windows
140# users are adviced to set this option to NO.
141
142CASE_SENSE_NAMES = YES
143
144# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
145# (but less readable) file names. This can be useful is your file systems
146# doesn't support long names like on DOS, Mac, or CD-ROM.
147
148SHORT_NAMES = NO
149
150# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
151# will show members with their full class and namespace scopes in the
152# documentation. If set to YES the scope will be hidden.
153
154HIDE_SCOPE_NAMES = NO
155
156# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
157# will generate a verbatim copy of the header file for each class for
158# which an include is specified. Set to NO to disable this.
159
160VERBATIM_HEADERS = YES
161
162# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
163# will put list of the files that are included by a file in the documentation
164# of that file.
165
166SHOW_INCLUDE_FILES = YES
167
168# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
169# will interpret the first line (until the first dot) of a JavaDoc-style
170# comment as the brief description. If set to NO, the JavaDoc
171# comments will behave just like the Qt-style comments (thus requiring an
172# explict @brief command for a brief description.
173
174JAVADOC_AUTOBRIEF = YES
175
176# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
177# member inherits the documentation from any documented member that it
178# reimplements.
179
180INHERIT_DOCS = YES
181
182# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
183# is inserted in the documentation for inline members.
184
185INLINE_INFO = YES
186
187# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
188# will sort the (detailed) documentation of file and class members
189# alphabetically by member name. If set to NO the members will appear in
190# declaration order.
191
192SORT_MEMBER_DOCS = NO
193
194# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
195# tag is set to YES, then doxygen will reuse the documentation of the first
196# member in the group (if any) for the other members of the group. By default
197# all members of a group must be documented explicitly.
198
199DISTRIBUTE_GROUP_DOC = NO
200
201# The TAB_SIZE tag can be used to set the number of spaces in a tab.
202# Doxygen uses this value to replace tabs by spaces in code fragments.
203
204TAB_SIZE = 4
205
206# The GENERATE_TODOLIST tag can be used to enable (YES) or
207# disable (NO) the todo list. This list is created by putting \todo
208# commands in the documentation.
209
210GENERATE_TODOLIST = YES
211
212# The GENERATE_TESTLIST tag can be used to enable (YES) or
213# disable (NO) the test list. This list is created by putting \test
214# commands in the documentation.
215
216GENERATE_TESTLIST = YES
217
218# The GENERATE_BUGLIST tag can be used to enable (YES) or
219# disable (NO) the bug list. This list is created by putting \bug
220# commands in the documentation.
221
222GENERATE_BUGLIST = YES
223
224# This tag can be used to specify a number of aliases that acts
225# as commands in the documentation. An alias has the form "name=value".
226# For example adding "sideeffect=\par Side Effects:\n" will allow you to
227# put the command \sideeffect (or @sideeffect) in the documentation, which
228# will result in a user defined paragraph with heading "Side Effects:".
229# You can put \n's in the value part of an alias to insert newlines.
230
231# @ref in KDE docu are for kdoc, doxygen doesn't need them, so we alias them
232# to nothing here
233
234ALIASES = libdoc=@mainpage \
235 sect=<p><b> \
236 reimplemented= \
237 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \
238 obsolete=@deprecated \
239 ref=
240
241# The ENABLED_SECTIONS tag can be used to enable conditional
242# documentation sections, marked by \if sectionname ... \endif.
243
244ENABLED_SECTIONS =
245
246# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
247# the initial value of a variable or define consist of for it to appear in
248# the documentation. If the initializer consists of more lines than specified
249# here it will be hidden. Use a value of 0 to hide initializers completely.
250# The appearance of the initializer of individual variables and defines in the
251# documentation can be controlled using \showinitializer or \hideinitializer
252# command in the documentation regardless of this setting.
253
254MAX_INITIALIZER_LINES = 30
255
256# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
257# only. Doxygen will then generate output that is more tailored for C.
258# For instance some of the names that are used will be different. The list
259# of all members will be omitted, etc.
260
261OPTIMIZE_OUTPUT_FOR_C = NO
262
263# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
264# only. Doxygen will then generate output that is more tailored for Java.
265# For instance namespaces will be presented as packages, qualified scopes
266# will look different, etc.
267
268OPTIMIZE_OUTPUT_JAVA = NO
269
270# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
271# at the bottom of the documentation of classes and structs. If set to YES the
272# list will mention the files that were used to generate the documentation.
273
274SHOW_USED_FILES = YES
275
276#---------------------------------------------------------------------------
277# configuration options related to warning and progress messages
278#---------------------------------------------------------------------------
279
280# The QUIET tag can be used to turn on/off the messages that are generated
281# by doxygen. Possible values are YES and NO. If left blank NO is used.
282
283QUIET = YES
284
285# The WARNINGS tag can be used to turn on/off the warning messages that are
286# generated by doxygen. Possible values are YES and NO. If left blank
287# NO is used.
288
289WARNINGS = YES
290
291# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
292# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
293# automatically be disabled.
294
295WARN_IF_UNDOCUMENTED = YES
296
297# The WARN_FORMAT tag determines the format of the warning messages that
298# doxygen can produce. The string should contain the $file, $line, and $text
299# tags, which will be replaced by the file and line number from which the
300# warning originated and the warning text.
301
302WARN_FORMAT = "$file:$line: $text"
303
304# The WARN_LOGFILE tag can be used to specify a file to which warning
305# and error messages should be written. If left blank the output is written
306# to stderr.
307
308WARN_LOGFILE = Dox-Warnings
309
310#---------------------------------------------------------------------------
311# configuration options related to the input files
312#---------------------------------------------------------------------------
313
314# The INPUT tag can be used to specify the files and/or directories that contain
315# documented source files. You may enter file names like "myfile.cpp" or
316# directories like "/usr/src/myproject". Separate the files or directories
317# with spaces.
318
319INPUT =
320
321# If the value of the INPUT tag contains directories, you can use the
322# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
323# and *.h) to filter out the source-files in the directories. If left
324# blank the following patterns are tested:
325# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
326# *.h++ *.idl *.odl
327
328FILE_PATTERNS = *.h \
329 *.cpp \
330 *.cc \
331 *.hpp
332
333# The RECURSIVE tag can be used to turn specify whether or not subdirectories
334# should be searched for input files as well. Possible values are YES and NO.
335# If left blank NO is used.
336
337RECURSIVE = YES
338
339# The EXCLUDE tag can be used to specify files and/or directories that should
340# excluded from the INPUT source files. This way you can easily exclude a
341# subdirectory from a directory tree whose root is specified with the INPUT tag.
342
343EXCLUDE =
344
345# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
346# that are symbolic links (a Unix filesystem feature) are excluded from the input.
347
348EXCLUDE_SYMLINKS = NO
349
350# If the value of the INPUT tag contains directories, you can use the
351# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
352# certain files from those directories.
353
354EXCLUDE_PATTERNS = *.moc.* \
355 moc* \
356 *.all_cpp.* \
357 *unload.* \
358 */test/* \
359 */tests/*
360
361# The EXAMPLE_PATH tag can be used to specify one or more files or
362# directories that contain example code fragments that are included (see
363# the \include command).
364
365EXAMPLE_PATH =
366
367# If the value of the EXAMPLE_PATH tag contains directories, you can use the
368# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
369# and *.h) to filter out the source-files in the directories. If left
370# blank all files are included.
371
372EXAMPLE_PATTERNS =
373
374# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
375# searched for input files to be used with the \include or \dontinclude
376# commands irrespective of the value of the RECURSIVE tag.
377# Possible values are YES and NO. If left blank NO is used.
378
379EXAMPLE_RECURSIVE = NO
380
381# The IMAGE_PATH tag can be used to specify one or more files or
382# directories that contain image that are included in the documentation (see
383# the \image command).
384
385IMAGE_PATH =
386
387# The INPUT_FILTER tag can be used to specify a program that doxygen should
388# invoke to filter for each input file. Doxygen will invoke the filter program
389# by executing (via popen()) the command <filter> <input-file>, where <filter>
390# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
391# input file. Doxygen will then use the output that the filter program writes
392# to standard output.
393
394INPUT_FILTER =
395
396# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
397# INPUT_FILTER) will be used to filter the input files when producing source
398# files to browse.
399
400FILTER_SOURCE_FILES = NO
401
402#---------------------------------------------------------------------------
403# configuration options related to source browsing
404#---------------------------------------------------------------------------
405
406# If the SOURCE_BROWSER tag is set to YES then a list of source files will
407# be generated. Documented entities will be cross-referenced with these sources.
408
409SOURCE_BROWSER = YES
410
411# Setting the INLINE_SOURCES tag to YES will include the body
412# of functions and classes directly in the documentation.
413
414INLINE_SOURCES = NO
415
416# If the REFERENCED_BY_RELATION tag is set to YES (the default)
417# then for each documented function all documented
418# functions referencing it will be listed.
419
420REFERENCED_BY_RELATION = YES
421
422# If the REFERENCES_RELATION tag is set to YES (the default)
423# then for each documented function all documented entities
424# called/used by that function will be listed.
425
426REFERENCES_RELATION = YES
427
428#---------------------------------------------------------------------------
429# configuration options related to the alphabetical class index
430#---------------------------------------------------------------------------
431
432# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
433# of all compounds will be generated. Enable this if the project
434# contains a lot of classes, structs, unions or interfaces.
435
436ALPHABETICAL_INDEX = YES
437
438# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
439# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
440# in which this list will be split (can be a number in the range [1..20])
441
442COLS_IN_ALPHA_INDEX = 3
443
444# In case all classes in a project start with a common prefix, all
445# classes will be put under the same header in the alphabetical index.
446# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
447# should be ignored while generating the index headers.
448
449IGNORE_PREFIX = O
450
451#---------------------------------------------------------------------------
452# configuration options related to the HTML output
453#---------------------------------------------------------------------------
454
455# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
456# generate HTML output.
457
458GENERATE_HTML = NO
459
460# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
461# If a relative path is entered the value of OUTPUT_DIRECTORY will be
462# put in front of it. If left blank `html' will be used as the default path.
463
464HTML_OUTPUT =
465
466# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
467# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
468# doxygen will generate files with .html extension.
469
470HTML_FILE_EXTENSION = .html
471
472# The HTML_HEADER tag can be used to specify a personal HTML header for
473# each generated HTML page. If it is left blank doxygen will generate a
474# standard header.
475
476HTML_HEADER = ../apidocs/common/header.html
477
478# The HTML_FOOTER tag can be used to specify a personal HTML footer for
479# each generated HTML page. If it is left blank doxygen will generate a
480# standard footer.
481
482HTML_FOOTER = ../apidocs/common/footer.html
483
484# The HTML_STYLESHEET tag can be used to specify a user defined cascading
485# style sheet that is used by each HTML page. It can be used to
486# fine-tune the look of the HTML output. If the tag is left blank doxygen
487# will generate a default style sheet
488
489HTML_STYLESHEET = ../apidocs/common/doxygen.css
490
491# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
492# files or namespaces will be aligned in HTML using tables. If set to
493# NO a bullet list will be used.
494
495HTML_ALIGN_MEMBERS = YES
496
497# If the GENERATE_HTMLHELP tag is set to YES, additional index files
498# will be generated that can be used as input for tools like the
499# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
500# of the generated HTML documentation.
501
502GENERATE_HTMLHELP = NO
503
504# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
505# controls if a separate .chi index file is generated (YES) or that
506# it should be included in the master .chm file (NO).
507
508GENERATE_CHI = NO
509
510# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
511# controls whether a binary table of contents is generated (YES) or a
512# normal table of contents (NO) in the .chm file.
513
514BINARY_TOC = NO
515
516# The TOC_EXPAND flag can be set to YES to add extra items for group members
517# to the contents of the Html help documentation and to the tree view.
518
519TOC_EXPAND = NO
520
521# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
522# top of each HTML page. The value NO (the default) enables the index and
523# the value YES disables it.
524
525DISABLE_INDEX = YES
526
527# This tag can be used to set the number of enum values (range [1..20])
528# that doxygen will group on one line in the generated HTML documentation.
529
530ENUM_VALUES_PER_LINE = 4
531
532# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
533# generated containing a tree-like index structure (just like the one that
534# is generated for HTML Help). For this to work a browser that supports
535# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
536# or Internet explorer 4.0+). Note that for large projects the tree generation
537# can take a very long time. In such cases it is better to disable this feature.
538# Windows users are probably better off using the HTML help feature.
539
540GENERATE_TREEVIEW = NO
541
542# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
543# used to set the initial width (in pixels) of the frame in which the tree
544# is shown.
545
546TREEVIEW_WIDTH = 250
547
548#---------------------------------------------------------------------------
549# configuration options related to the LaTeX output
550#---------------------------------------------------------------------------
551
552# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
553# generate Latex output.
554
555GENERATE_LATEX = NO
556
557# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
558# If a relative path is entered the value of OUTPUT_DIRECTORY will be
559# put in front of it. If left blank `latex' will be used as the default path.
560
561LATEX_OUTPUT =
562
563# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
564
565LATEX_CMD_NAME = latex
566
567# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
568# generate index for LaTeX. If left blank `makeindex' will be used as the
569# default command name.
570
571MAKEINDEX_CMD_NAME = makeindex
572
573# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
574# LaTeX documents. This may be useful for small projects and may help to
575# save some trees in general.
576
577COMPACT_LATEX = NO
578
579# The PAPER_TYPE tag can be used to set the paper type that is used
580# by the printer. Possible values are: a4, a4wide, letter, legal and
581# executive. If left blank a4wide will be used.
582
583PAPER_TYPE = a4wide
584
585# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
586# packages that should be included in the LaTeX output.
587
588EXTRA_PACKAGES =
589
590# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
591# the generated latex document. The header should contain everything until
592# the first chapter. If it is left blank doxygen will generate a
593# standard header. Notice: only use this tag if you know what you are doing!
594
595LATEX_HEADER =
596
597# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
598# is prepared for conversion to pdf (using ps2pdf). The pdf file will
599# contain links (just like the HTML output) instead of page references
600# This makes the output suitable for online browsing using a pdf viewer.
601
602PDF_HYPERLINKS = NO
603
604# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
605# plain latex in the generated Makefile. Set this option to YES to get a
606# higher quality PDF documentation.
607
608USE_PDFLATEX = NO
609
610# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
611# command to the generated LaTeX files. This will instruct LaTeX to keep
612# running if errors occur, instead of asking the user for help.
613# This option is also used when generating formulas in HTML.
614
615LATEX_BATCHMODE = NO
616
617#---------------------------------------------------------------------------
618# configuration options related to the RTF output
619#---------------------------------------------------------------------------
620
621# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
622# The RTF output is optimised for Word 97 and may not look very pretty with
623# other RTF readers or editors.
624
625GENERATE_RTF = NO
626
627# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
628# If a relative path is entered the value of OUTPUT_DIRECTORY will be
629# put in front of it. If left blank `rtf' will be used as the default path.
630
631RTF_OUTPUT =
632
633# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
634# RTF documents. This may be useful for small projects and may help to
635# save some trees in general.
636
637COMPACT_RTF = NO
638
639# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
640# will contain hyperlink fields. The RTF file will
641# contain links (just like the HTML output) instead of page references.
642# This makes the output suitable for online browsing using WORD or other
643# programs which support those fields.
644# Note: wordpad (write) and others do not support links.
645
646RTF_HYPERLINKS = NO
647
648# Load stylesheet definitions from file. Syntax is similar to doxygen's
649# config file, i.e. a series of assigments. You only have to provide
650# replacements, missing definitions are set to their default value.
651
652RTF_STYLESHEET_FILE =
653
654# Set optional variables used in the generation of an rtf document.
655# Syntax is similar to doxygen's config file.
656
657RTF_EXTENSIONS_FILE =
658
659#---------------------------------------------------------------------------
660# configuration options related to the man page output
661#---------------------------------------------------------------------------
662
663# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
664# generate man pages
665
666GENERATE_MAN = NO
667
668# The MAN_OUTPUT tag is used to specify where the man pages will be put.
669# If a relative path is entered the value of OUTPUT_DIRECTORY will be
670# put in front of it. If left blank `man' will be used as the default path.
671
672MAN_OUTPUT =
673
674# The MAN_EXTENSION tag determines the extension that is added to
675# the generated man pages (default is the subroutine's section .3)
676
677MAN_EXTENSION = .opie3
678
679# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
680# then it will generate one additional man file for each entity
681# documented in the real man page(s). These additional files
682# only source the real man page, but without them the man command
683# would be unable to find the correct page. The default is NO.
684
685MAN_LINKS = YES
686
687#---------------------------------------------------------------------------
688# configuration options related to the XML output
689#---------------------------------------------------------------------------
690
691# If the GENERATE_XML tag is set to YES Doxygen will
692# generate an XML file that captures the structure of
693# the code including all documentation. Note that this
694# feature is still experimental and incomplete at the
695# moment.
696
697GENERATE_XML = NO
698
699#---------------------------------------------------------------------------
700# configuration options for the AutoGen Definitions output
701#---------------------------------------------------------------------------
702
703# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
704# generate an AutoGen Definitions (see autogen.sf.net) file
705# that captures the structure of the code including all
706# documentation. Note that this feature is still experimental
707# and incomplete at the moment.
708
709GENERATE_AUTOGEN_DEF = NO
710
711#---------------------------------------------------------------------------
712# Configuration options related to the preprocessor
713#---------------------------------------------------------------------------
714
715# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
716# evaluate all C-preprocessor directives found in the sources and include
717# files.
718
719ENABLE_PREPROCESSING = YES
720
721# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
722# names in the source code. If set to NO (the default) only conditional
723# compilation will be performed. Macro expansion can be done in a controlled
724# way by setting EXPAND_ONLY_PREDEF to YES.
725
726MACRO_EXPANSION = NO
727
728# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
729# then the macro expansion is limited to the macros specified with the
730# PREDEFINED and EXPAND_AS_PREDEFINED tags.
731
732EXPAND_ONLY_PREDEF = NO
733
734# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
735# in the INCLUDE_PATH (see below) will be search if a #include is found.
736
737SEARCH_INCLUDES = YES
738
739# The INCLUDE_PATH tag can be used to specify one or more directories that
740# contain include files that are not input files but should be processed by
741# the preprocessor.
742
743INCLUDE_PATH =
744
745# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
746# patterns (like *.h and *.hpp) to filter out the header-files in the
747# directories. If left blank, the patterns specified with FILE_PATTERNS will
748# be used.
749
750INCLUDE_FILE_PATTERNS =
751
752# The PREDEFINED tag can be used to specify one or more macro names that
753# are defined before the preprocessor is started (similar to the -D option of
754# gcc). The argument of the tag is a list of macros of the form: name
755# or name=definition (no spaces). If the definition and the = are
756# omitted =1 is assumed.
757
758PREDEFINED = QT_VERSION=305
759
760# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
761# this tag can be used to specify a list of macro names that should be expanded.
762# The macro definition that is found in the sources will be used.
763# Use the PREDEFINED tag if you want to use a different macro definition.
764
765EXPAND_AS_DEFINED =
766
767# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
768# doxygen's preprocessor will remove all function-like macros that are alone
769# on a line and do not end with a semicolon. Such function macros are typically
770# used for boiler-plate code, and will confuse the parser if not removed.
771
772SKIP_FUNCTION_MACROS = YES
773
774#---------------------------------------------------------------------------
775# Configuration::addtions related to external references
776#---------------------------------------------------------------------------
777
778# The TAGFILES tag can be used to specify one or more tagfiles.
779
780TAGFILES =
781
782# When a file name is specified after GENERATE_TAGFILE, doxygen will create
783# a tag file that is based on the input files it reads.
784
785GENERATE_TAGFILE =
786
787# If the ALLEXTERNALS tag is set to YES all external classes will be listed
788# in the class index. If set to NO only the inherited external classes
789# will be listed.
790
791ALLEXTERNALS = NO
792
793# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
794# in the modules index. If set to NO, only the current project's groups will
795# be listed.
796
797EXTERNAL_GROUPS = NO
798
799# The PERL_PATH should be the absolute path and name of the perl script
800# interpreter (i.e. the result of `which perl').
801
802PERL_PATH =
803
804#---------------------------------------------------------------------------
805# Configuration options related to the dot tool
806#---------------------------------------------------------------------------
807
808# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
809# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
810# super classes. Setting the tag to NO turns the diagrams off. Note that this
811# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
812# recommended to install and use dot, since it yield more powerful graphs.
813
814CLASS_DIAGRAMS = YES
815
816# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
817# available from the path. This tool is part of Graphviz, a graph visualization
818# toolkit from AT&T and Lucent Bell Labs. The other options in this section
819# have no effect if this option is set to NO (the default)
820
821HAVE_DOT = YES
822
823# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
824# will generate a graph for each documented class showing the direct and
825# indirect inheritance relations. Setting this tag to YES will force the
826# the CLASS_DIAGRAMS tag to NO.
827
828CLASS_GRAPH = YES
829
830# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
831# will generate a graph for each documented class showing the direct and
832# indirect implementation dependencies (inheritance, containment, and
833# class references variables) of the class with other documented classes.
834
835COLLABORATION_GRAPH = YES
836
837# If set to YES, the inheritance and collaboration graphs will show the
838# relations between templates and their instances.
839
840TEMPLATE_RELATIONS = YES
841
842# If set to YES, the inheritance and collaboration graphs will hide
843# inheritance and usage relations if the target is undocumented
844# or is not a class.
845
846HIDE_UNDOC_RELATIONS = NO
847
848# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
849# tags are set to YES then doxygen will generate a graph for each documented
850# file showing the direct and indirect include dependencies of the file with
851# other documented files.
852
853INCLUDE_GRAPH = YES
854
855# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
856# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
857# documented header file showing the documented files that directly or
858# indirectly include this file.
859
860INCLUDED_BY_GRAPH = YES
861
862# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
863# will graphical hierarchy of all classes instead of a textual one.
864
865GRAPHICAL_HIERARCHY = NO
866
867# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
868# generated by dot. Possible values are png, jpg, or gif
869# If left blank png will be used.
870
871DOT_IMAGE_FORMAT = png
872
873# The tag DOT_PATH can be used to specify the path where the dot tool can be
874# found. If left blank, it is assumed the dot tool can be found on the path.
875
876DOT_PATH =
877
878# The DOTFILE_DIRS tag can be used to specify one or more directories that
879# contain dot files that are included in the documentation (see the
880# \dotfile command).
881
882DOTFILE_DIRS =
883
884# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
885# (in pixels) of the graphs generated by dot. If a graph becomes larger than
886# this value, doxygen will try to truncate the graph, so that it fits within
887# the specified constraint. Beware that most browsers cannot cope with very
888# large images.
889
890MAX_DOT_GRAPH_WIDTH = 800
891
892# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
893# (in pixels) of the graphs generated by dot. If a graph becomes larger than
894# this value, doxygen will try to truncate the graph, so that it fits within
895# the specified constraint. Beware that most browsers cannot cope with very
896# large images.
897
898MAX_DOT_GRAPH_HEIGHT = 1024
899
900# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
901# generate a legend page explaining the meaning of the various boxes and
902# arrows in the dot generated graphs.
903
904GENERATE_LEGEND = YES
905
906# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
907# remove the intermedate dot files that are used to generate
908# the various graphs.
909
910DOT_CLEANUP = YES
911
912#---------------------------------------------------------------------------
913# Configuration::addtions related to the search engine
914#---------------------------------------------------------------------------
915
916# The SEARCHENGINE tag specifies whether or not a search engine should be
917# used. If set to NO the values of all tags below this one will be ignored.
918
919SEARCHENGINE = NO
920
921# The CGI_NAME tag should be the name of the CGI script that
922# starts the search engine (doxysearch) with the correct parameters.
923# A script with this name will be generated by doxygen.
924
925CGI_NAME =
926
927# The CGI_URL tag should be the absolute URL to the directory where the
928# cgi binaries are located. See the documentation of your http daemon for
929# details.
930
931CGI_URL =
932
933# The DOC_URL tag should be the absolute URL to the directory where the
934# documentation is located. If left blank the absolute path to the
935# documentation, with file:// prepended to it, will be used.
936
937DOC_URL =
938
939# The DOC_ABSPATH tag should be the absolute path to the directory where the
940# documentation is located. If left blank the directory on the local machine
941# will be used.
942
943DOC_ABSPATH =
944
945# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
946# is installed.
947
948BIN_ABSPATH =
949
950# The EXT_DOC_PATHS tag can be used to specify one or more paths to
951# documentation generated for other projects. This allows doxysearch to search
952# the documentation for these projects as well.
953
954EXT_DOC_PATHS =
955PROJECT_NAME = "Qtopia library"
956PROJECT_NUMBER = "Version 1.5.5"
957INPUT = .
958IMAGE_PATH = ../apidocs/api
959OUTPUT_DIRECTORY = ../apidocs
960HTML_OUTPUT = libqpe/html
961LATEX_OUTPUT = libqpe/latex
962RTF_OUTPUT = libqpe/rtf
963MAN_OUTPUT = libqpe/man
964GENERATE_HTML = yes
965GENERATE_MAN = no
966GENERATE_LATEX = no
967TAGFILES = \
968../apidocs/qt/qt.tag=../../qt/
969GENERATE_TAGFILE = ../apidocs/libqpe/libqpe.tag
970IGNORE_PREFIX = Q
971HAVE_DOT = YES
diff --git a/doc/Doxyfile_main b/doc/Doxyfile_main
new file mode 100644
index 0000000..180fc1f
--- a/dev/null
+++ b/doc/Doxyfile_main
@@ -0,0 +1,975 @@
1# Doxyfile 1.2.15
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# General configuration options
15#---------------------------------------------------------------------------
16
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18# by quotes) that should identify the project.
19
20PROJECT_NAME =
21
22# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or
24# if some version control system is used.
25
26PROJECT_NUMBER =
27
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29# base path where the generated documentation will be put.
30# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.
32
33OUTPUT_DIRECTORY = apidocs/
34
35# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36# documentation generated by doxygen is written. Doxygen will use this
37# information to generate all constant output in the proper language.
38# The default language is English, other supported languages are:
39# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
40# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
41# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
42
43OUTPUT_LANGUAGE = English
44
45# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
46# documentation are documented, even if no documentation was available.
47# Private class members and static file members will be hidden unless
48# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
49
50EXTRACT_ALL = YES
51
52# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
53# will be included in the documentation.
54
55EXTRACT_PRIVATE = NO
56
57# If the EXTRACT_STATIC tag is set to YES all static members of a file
58# will be included in the documentation.
59
60EXTRACT_STATIC = YES
61
62# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
63# defined locally in source files will be included in the documentation.
64# If set to NO only classes defined in header files are included.
65
66EXTRACT_LOCAL_CLASSES = NO
67
68# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
69# undocumented members of documented classes, files or namespaces.
70# If set to NO (the default) these members will be included in the
71# various overviews, but no documentation section is generated.
72# This option has no effect if EXTRACT_ALL is enabled.
73
74HIDE_UNDOC_MEMBERS = NO
75
76# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
77# undocumented classes that are normally visible in the class hierarchy.
78# If set to NO (the default) these class will be included in the various
79# overviews. This option has no effect if EXTRACT_ALL is enabled.
80
81HIDE_UNDOC_CLASSES = YES
82
83# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
84# include brief member descriptions after the members that are listed in
85# the file and class documentation (similar to JavaDoc).
86# Set to NO to disable this.
87
88BRIEF_MEMBER_DESC = YES
89
90# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
91# the brief description of a member or function before the detailed description.
92# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
93# brief descriptions will be completely suppressed.
94
95REPEAT_BRIEF = YES
96
97# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
98# Doxygen will generate a detailed section even if there is only a brief
99# description.
100
101ALWAYS_DETAILED_SEC = YES
102
103# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
104# members of a class in the documentation of that class as if those members were
105# ordinary class members. Constructors, destructors and assignment operators of
106# the base classes will not be shown.
107
108INLINE_INHERITED_MEMB = NO
109
110# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
111# path before files name in the file list and in the header files. If set
112# to NO the shortest path that makes the file name unique will be used.
113
114FULL_PATH_NAMES = NO
115
116# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
117# can be used to strip a user defined part of the path. Stripping is
118# only done if one of the specified strings matches the left-hand part of
119# the path. It is allowed to use relative paths in the argument list.
120
121STRIP_FROM_PATH =
122
123# The INTERNAL_DOCS tag determines if documentation
124# that is typed after a \internal command is included. If the tag is set
125# to NO (the default) then the documentation will be excluded.
126# Set it to YES to include the internal documentation.
127
128INTERNAL_DOCS = NO
129
130# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
131# doxygen to hide any special comment blocks from generated source code
132# fragments. Normal C and C++ comments will always remain visible.
133
134STRIP_CODE_COMMENTS = YES
135
136# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
137# file names in lower case letters. If set to YES upper case letters are also
138# allowed. This is useful if you have classes or files whose names only differ
139# in case and if your file system supports case sensitive file names. Windows
140# users are adviced to set this option to NO.
141
142CASE_SENSE_NAMES = YES
143
144# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
145# (but less readable) file names. This can be useful is your file systems
146# doesn't support long names like on DOS, Mac, or CD-ROM.
147
148SHORT_NAMES = NO
149
150# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
151# will show members with their full class and namespace scopes in the
152# documentation. If set to YES the scope will be hidden.
153
154HIDE_SCOPE_NAMES = NO
155
156# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
157# will generate a verbatim copy of the header file for each class for
158# which an include is specified. Set to NO to disable this.
159
160VERBATIM_HEADERS = YES
161
162# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
163# will put list of the files that are included by a file in the documentation
164# of that file.
165
166SHOW_INCLUDE_FILES = YES
167
168# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
169# will interpret the first line (until the first dot) of a JavaDoc-style
170# comment as the brief description. If set to NO, the JavaDoc
171# comments will behave just like the Qt-style comments (thus requiring an
172# explict @brief command for a brief description.
173
174JAVADOC_AUTOBRIEF = YES
175
176# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
177# member inherits the documentation from any documented member that it
178# reimplements.
179
180INHERIT_DOCS = YES
181
182# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
183# is inserted in the documentation for inline members.
184
185INLINE_INFO = YES
186
187# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
188# will sort the (detailed) documentation of file and class members
189# alphabetically by member name. If set to NO the members will appear in
190# declaration order.
191
192SORT_MEMBER_DOCS = NO
193
194# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
195# tag is set to YES, then doxygen will reuse the documentation of the first
196# member in the group (if any) for the other members of the group. By default
197# all members of a group must be documented explicitly.
198
199DISTRIBUTE_GROUP_DOC = NO
200
201# The TAB_SIZE tag can be used to set the number of spaces in a tab.
202# Doxygen uses this value to replace tabs by spaces in code fragments.
203
204TAB_SIZE = 4
205
206# The GENERATE_TODOLIST tag can be used to enable (YES) or
207# disable (NO) the todo list. This list is created by putting \todo
208# commands in the documentation.
209
210GENERATE_TODOLIST = NO
211
212# The GENERATE_TESTLIST tag can be used to enable (YES) or
213# disable (NO) the test list. This list is created by putting \test
214# commands in the documentation.
215
216GENERATE_TESTLIST = NO
217
218# The GENERATE_BUGLIST tag can be used to enable (YES) or
219# disable (NO) the bug list. This list is created by putting \bug
220# commands in the documentation.
221
222GENERATE_BUGLIST = YES
223
224# This tag can be used to specify a number of aliases that acts
225# as commands in the documentation. An alias has the form "name=value".
226# For example adding "sideeffect=\par Side Effects:\n" will allow you to
227# put the command \sideeffect (or @sideeffect) in the documentation, which
228# will result in a user defined paragraph with heading "Side Effects:".
229# You can put \n's in the value part of an alias to insert newlines.
230
231# @ref in KDE docu are for kdoc, doxygen doesn't need them, so we alias them
232# to nothing here
233
234ALIASES = libdoc=@mainpage \
235 sect=<p><b> \
236 reimplemented= \
237 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \
238 obsolete=@deprecated \
239 ref=
240
241# The ENABLED_SECTIONS tag can be used to enable conditional
242# documentation sections, marked by \if sectionname ... \endif.
243
244ENABLED_SECTIONS =
245
246# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
247# the initial value of a variable or define consist of for it to appear in
248# the documentation. If the initializer consists of more lines than specified
249# here it will be hidden. Use a value of 0 to hide initializers completely.
250# The appearance of the initializer of individual variables and defines in the
251# documentation can be controlled using \showinitializer or \hideinitializer
252# command in the documentation regardless of this setting.
253
254MAX_INITIALIZER_LINES = 30
255
256# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
257# only. Doxygen will then generate output that is more tailored for C.
258# For instance some of the names that are used will be different. The list
259# of all members will be omitted, etc.
260
261OPTIMIZE_OUTPUT_FOR_C = NO
262
263# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
264# only. Doxygen will then generate output that is more tailored for Java.
265# For instance namespaces will be presented as packages, qualified scopes
266# will look different, etc.
267
268OPTIMIZE_OUTPUT_JAVA = NO
269
270# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
271# at the bottom of the documentation of classes and structs. If set to YES the
272# list will mention the files that were used to generate the documentation.
273
274SHOW_USED_FILES = YES
275
276#---------------------------------------------------------------------------
277# configuration options related to warning and progress messages
278#---------------------------------------------------------------------------
279
280# The QUIET tag can be used to turn on/off the messages that are generated
281# by doxygen. Possible values are YES and NO. If left blank NO is used.
282
283QUIET = YES
284
285# The WARNINGS tag can be used to turn on/off the warning messages that are
286# generated by doxygen. Possible values are YES and NO. If left blank
287# NO is used.
288
289WARNINGS = YES
290
291# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
292# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
293# automatically be disabled.
294
295WARN_IF_UNDOCUMENTED = NO
296
297# The WARN_FORMAT tag determines the format of the warning messages that
298# doxygen can produce. The string should contain the $file, $line, and $text
299# tags, which will be replaced by the file and line number from which the
300# warning originated and the warning text.
301
302WARN_FORMAT =
303
304# The WARN_LOGFILE tag can be used to specify a file to which warning
305# and error messages should be written. If left blank the output is written
306# to stderr.
307
308WARN_LOGFILE =
309
310#---------------------------------------------------------------------------
311# configuration options related to the input files
312#---------------------------------------------------------------------------
313
314# The INPUT tag can be used to specify the files and/or directories that contain
315# documented source files. You may enter file names like "myfile.cpp" or
316# directories like "/usr/src/myproject". Separate the files or directories
317# with spaces.
318
319INPUT = library libopie libopie/pim
320
321# If the value of the INPUT tag contains directories, you can use the
322# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
323# and *.h) to filter out the source-files in the directories. If left
324# blank the following patterns are tested:
325# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
326# *.h++ *.idl *.odl
327
328FILE_PATTERNS = *.h \
329 *.cpp \
330 *.cc \
331 *.hpp
332
333# The RECURSIVE tag can be used to turn specify whether or not subdirectories
334# should be searched for input files as well. Possible values are YES and NO.
335# If left blank NO is used.
336
337RECURSIVE = NO
338
339# The EXCLUDE tag can be used to specify files and/or directories that should
340# excluded from the INPUT source files. This way you can easily exclude a
341# subdirectory from a directory tree whose root is specified with the INPUT tag.
342
343EXCLUDE =
344
345# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
346# that are symbolic links (a Unix filesystem feature) are excluded from the input.
347
348EXCLUDE_SYMLINKS = NO
349
350# If the value of the INPUT tag contains directories, you can use the
351# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
352# certain files from those directories.
353
354EXCLUDE_PATTERNS = *.moc.* \
355 moc* \
356 *.all_cpp.* \
357 *unload.* \
358 */test/* \
359 */tests/*
360
361# The EXAMPLE_PATH tag can be used to specify one or more files or
362# directories that contain example code fragments that are included (see
363# the \include command).
364
365EXAMPLE_PATH =
366
367# If the value of the EXAMPLE_PATH tag contains directories, you can use the
368# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
369# and *.h) to filter out the source-files in the directories. If left
370# blank all files are included.
371
372EXAMPLE_PATTERNS =
373
374# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
375# searched for input files to be used with the \include or \dontinclude
376# commands irrespective of the value of the RECURSIVE tag.
377# Possible values are YES and NO. If left blank NO is used.
378
379EXAMPLE_RECURSIVE = NO
380
381# The IMAGE_PATH tag can be used to specify one or more files or
382# directories that contain image that are included in the documentation (see
383# the \image command).
384
385IMAGE_PATH =
386
387# The INPUT_FILTER tag can be used to specify a program that doxygen should
388# invoke to filter for each input file. Doxygen will invoke the filter program
389# by executing (via popen()) the command <filter> <input-file>, where <filter>
390# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
391# input file. Doxygen will then use the output that the filter program writes
392# to standard output.
393
394INPUT_FILTER =
395
396# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
397# INPUT_FILTER) will be used to filter the input files when producing source
398# files to browse.
399
400FILTER_SOURCE_FILES = NO
401
402#---------------------------------------------------------------------------
403# configuration options related to source browsing
404#---------------------------------------------------------------------------
405
406# If the SOURCE_BROWSER tag is set to YES then a list of source files will
407# be generated. Documented entities will be cross-referenced with these sources.
408
409SOURCE_BROWSER = YES
410
411# Setting the INLINE_SOURCES tag to YES will include the body
412# of functions and classes directly in the documentation.
413
414INLINE_SOURCES = NO
415
416# If the REFERENCED_BY_RELATION tag is set to YES (the default)
417# then for each documented function all documented
418# functions referencing it will be listed.
419
420REFERENCED_BY_RELATION = YES
421
422# If the REFERENCES_RELATION tag is set to YES (the default)
423# then for each documented function all documented entities
424# called/used by that function will be listed.
425
426REFERENCES_RELATION = YES
427
428#---------------------------------------------------------------------------
429# configuration options related to the alphabetical class index
430#---------------------------------------------------------------------------
431
432# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
433# of all compounds will be generated. Enable this if the project
434# contains a lot of classes, structs, unions or interfaces.
435
436ALPHABETICAL_INDEX = YES
437
438# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
439# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
440# in which this list will be split (can be a number in the range [1..20])
441
442COLS_IN_ALPHA_INDEX = 3
443
444# In case all classes in a project start with a common prefix, all
445# classes will be put under the same header in the alphabetical index.
446# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
447# should be ignored while generating the index headers.
448
449IGNORE_PREFIX = O
450
451#---------------------------------------------------------------------------
452# configuration options related to the HTML output
453#---------------------------------------------------------------------------
454
455# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
456# generate HTML output.
457
458GENERATE_HTML = NO
459
460# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
461# If a relative path is entered the value of OUTPUT_DIRECTORY will be
462# put in front of it. If left blank `html' will be used as the default path.
463
464HTML_OUTPUT =
465
466# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
467# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
468# doxygen will generate files with .html extension.
469
470HTML_FILE_EXTENSION = .html
471
472# The HTML_HEADER tag can be used to specify a personal HTML header for
473# each generated HTML page. If it is left blank doxygen will generate a
474# standard header.
475
476HTML_HEADER = apidocs/common/header.html
477
478# The HTML_FOOTER tag can be used to specify a personal HTML footer for
479# each generated HTML page. If it is left blank doxygen will generate a
480# standard footer.
481
482HTML_FOOTER = apidocs/common/footer.html
483
484# The HTML_STYLESHEET tag can be used to specify a user defined cascading
485# style sheet that is used by each HTML page. It can be used to
486# fine-tune the look of the HTML output. If the tag is left blank doxygen
487# will generate a default style sheet
488
489HTML_STYLESHEET = apidocs/common/doxygen.css
490
491# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
492# files or namespaces will be aligned in HTML using tables. If set to
493# NO a bullet list will be used.
494
495HTML_ALIGN_MEMBERS = YES
496
497# If the GENERATE_HTMLHELP tag is set to YES, additional index files
498# will be generated that can be used as input for tools like the
499# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
500# of the generated HTML documentation.
501
502GENERATE_HTMLHELP = NO
503
504# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
505# controls if a separate .chi index file is generated (YES) or that
506# it should be included in the master .chm file (NO).
507
508GENERATE_CHI = NO
509
510# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
511# controls whether a binary table of contents is generated (YES) or a
512# normal table of contents (NO) in the .chm file.
513
514BINARY_TOC = NO
515
516# The TOC_EXPAND flag can be set to YES to add extra items for group members
517# to the contents of the Html help documentation and to the tree view.
518
519TOC_EXPAND = NO
520
521# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
522# top of each HTML page. The value NO (the default) enables the index and
523# the value YES disables it.
524
525DISABLE_INDEX = YES
526
527# This tag can be used to set the number of enum values (range [1..20])
528# that doxygen will group on one line in the generated HTML documentation.
529
530ENUM_VALUES_PER_LINE = 4
531
532# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
533# generated containing a tree-like index structure (just like the one that
534# is generated for HTML Help). For this to work a browser that supports
535# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
536# or Internet explorer 4.0+). Note that for large projects the tree generation
537# can take a very long time. In such cases it is better to disable this feature.
538# Windows users are probably better off using the HTML help feature.
539
540GENERATE_TREEVIEW = NO
541
542# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
543# used to set the initial width (in pixels) of the frame in which the tree
544# is shown.
545
546TREEVIEW_WIDTH = 250
547
548#---------------------------------------------------------------------------
549# configuration options related to the LaTeX output
550#---------------------------------------------------------------------------
551
552# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
553# generate Latex output.
554
555GENERATE_LATEX = NO
556
557# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
558# If a relative path is entered the value of OUTPUT_DIRECTORY will be
559# put in front of it. If left blank `latex' will be used as the default path.
560
561LATEX_OUTPUT =
562
563# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
564
565LATEX_CMD_NAME = latex
566
567# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
568# generate index for LaTeX. If left blank `makeindex' will be used as the
569# default command name.
570
571MAKEINDEX_CMD_NAME = makeindex
572
573# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
574# LaTeX documents. This may be useful for small projects and may help to
575# save some trees in general.
576
577COMPACT_LATEX = NO
578
579# The PAPER_TYPE tag can be used to set the paper type that is used
580# by the printer. Possible values are: a4, a4wide, letter, legal and
581# executive. If left blank a4wide will be used.
582
583PAPER_TYPE = a4wide
584
585# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
586# packages that should be included in the LaTeX output.
587
588EXTRA_PACKAGES =
589
590# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
591# the generated latex document. The header should contain everything until
592# the first chapter. If it is left blank doxygen will generate a
593# standard header. Notice: only use this tag if you know what you are doing!
594
595LATEX_HEADER =
596
597# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
598# is prepared for conversion to pdf (using ps2pdf). The pdf file will
599# contain links (just like the HTML output) instead of page references
600# This makes the output suitable for online browsing using a pdf viewer.
601
602PDF_HYPERLINKS = NO
603
604# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
605# plain latex in the generated Makefile. Set this option to YES to get a
606# higher quality PDF documentation.
607
608USE_PDFLATEX = NO
609
610# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
611# command to the generated LaTeX files. This will instruct LaTeX to keep
612# running if errors occur, instead of asking the user for help.
613# This option is also used when generating formulas in HTML.
614
615LATEX_BATCHMODE = NO
616
617#---------------------------------------------------------------------------
618# configuration options related to the RTF output
619#---------------------------------------------------------------------------
620
621# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
622# The RTF output is optimised for Word 97 and may not look very pretty with
623# other RTF readers or editors.
624
625GENERATE_RTF = NO
626
627# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
628# If a relative path is entered the value of OUTPUT_DIRECTORY will be
629# put in front of it. If left blank `rtf' will be used as the default path.
630
631RTF_OUTPUT =
632
633# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
634# RTF documents. This may be useful for small projects and may help to
635# save some trees in general.
636
637COMPACT_RTF = NO
638
639# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
640# will contain hyperlink fields. The RTF file will
641# contain links (just like the HTML output) instead of page references.
642# This makes the output suitable for online browsing using WORD or other
643# programs which support those fields.
644# Note: wordpad (write) and others do not support links.
645
646RTF_HYPERLINKS = NO
647
648# Load stylesheet definitions from file. Syntax is similar to doxygen's
649# config file, i.e. a series of assigments. You only have to provide
650# replacements, missing definitions are set to their default value.
651
652RTF_STYLESHEET_FILE =
653
654# Set optional variables used in the generation of an rtf document.
655# Syntax is similar to doxygen's config file.
656
657RTF_EXTENSIONS_FILE =
658
659#---------------------------------------------------------------------------
660# configuration options related to the man page output
661#---------------------------------------------------------------------------
662
663# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
664# generate man pages
665
666GENERATE_MAN = NO
667
668# The MAN_OUTPUT tag is used to specify where the man pages will be put.
669# If a relative path is entered the value of OUTPUT_DIRECTORY will be
670# put in front of it. If left blank `man' will be used as the default path.
671
672MAN_OUTPUT =
673
674# The MAN_EXTENSION tag determines the extension that is added to
675# the generated man pages (default is the subroutine's section .3)
676
677MAN_EXTENSION = .kde3
678
679# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
680# then it will generate one additional man file for each entity
681# documented in the real man page(s). These additional files
682# only source the real man page, but without them the man command
683# would be unable to find the correct page. The default is NO.
684
685MAN_LINKS = YES
686
687#---------------------------------------------------------------------------
688# configuration options related to the XML output
689#---------------------------------------------------------------------------
690
691# If the GENERATE_XML tag is set to YES Doxygen will
692# generate an XML file that captures the structure of
693# the code including all documentation. Note that this
694# feature is still experimental and incomplete at the
695# moment.
696
697GENERATE_XML = NO
698
699#---------------------------------------------------------------------------
700# configuration options for the AutoGen Definitions output
701#---------------------------------------------------------------------------
702
703# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
704# generate an AutoGen Definitions (see autogen.sf.net) file
705# that captures the structure of the code including all
706# documentation. Note that this feature is still experimental
707# and incomplete at the moment.
708
709GENERATE_AUTOGEN_DEF = NO
710
711#---------------------------------------------------------------------------
712# Configuration options related to the preprocessor
713#---------------------------------------------------------------------------
714
715# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
716# evaluate all C-preprocessor directives found in the sources and include
717# files.
718
719ENABLE_PREPROCESSING = YES
720
721# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
722# names in the source code. If set to NO (the default) only conditional
723# compilation will be performed. Macro expansion can be done in a controlled
724# way by setting EXPAND_ONLY_PREDEF to YES.
725
726MACRO_EXPANSION = NO
727
728# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
729# then the macro expansion is limited to the macros specified with the
730# PREDEFINED and EXPAND_AS_PREDEFINED tags.
731
732EXPAND_ONLY_PREDEF = NO
733
734# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
735# in the INCLUDE_PATH (see below) will be search if a #include is found.
736
737SEARCH_INCLUDES = YES
738
739# The INCLUDE_PATH tag can be used to specify one or more directories that
740# contain include files that are not input files but should be processed by
741# the preprocessor.
742
743INCLUDE_PATH =
744
745# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
746# patterns (like *.h and *.hpp) to filter out the header-files in the
747# directories. If left blank, the patterns specified with FILE_PATTERNS will
748# be used.
749
750INCLUDE_FILE_PATTERNS =
751
752# The PREDEFINED tag can be used to specify one or more macro names that
753# are defined before the preprocessor is started (similar to the -D option of
754# gcc). The argument of the tag is a list of macros of the form: name
755# or name=definition (no spaces). If the definition and the = are
756# omitted =1 is assumed.
757
758PREDEFINED = QT_VERSION=305
759
760# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
761# this tag can be used to specify a list of macro names that should be expanded.
762# The macro definition that is found in the sources will be used.
763# Use the PREDEFINED tag if you want to use a different macro definition.
764
765EXPAND_AS_DEFINED =
766
767# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
768# doxygen's preprocessor will remove all function-like macros that are alone
769# on a line and do not end with a semicolon. Such function macros are typically
770# used for boiler-plate code, and will confuse the parser if not removed.
771
772SKIP_FUNCTION_MACROS = YES
773
774#---------------------------------------------------------------------------
775# Configuration::addtions related to external references
776#---------------------------------------------------------------------------
777
778# The TAGFILES tag can be used to specify one or more tagfiles.
779
780TAGFILES =
781
782# When a file name is specified after GENERATE_TAGFILE, doxygen will create
783# a tag file that is based on the input files it reads.
784
785GENERATE_TAGFILE =
786
787# If the ALLEXTERNALS tag is set to YES all external classes will be listed
788# in the class index. If set to NO only the inherited external classes
789# will be listed.
790
791ALLEXTERNALS = NO
792
793# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
794# in the modules index. If set to NO, only the current project's groups will
795# be listed.
796
797EXTERNAL_GROUPS = NO
798
799# The PERL_PATH should be the absolute path and name of the perl script
800# interpreter (i.e. the result of `which perl').
801
802PERL_PATH =
803
804#---------------------------------------------------------------------------
805# Configuration options related to the dot tool
806#---------------------------------------------------------------------------
807
808# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
809# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
810# super classes. Setting the tag to NO turns the diagrams off. Note that this
811# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
812# recommended to install and use dot, since it yield more powerful graphs.
813
814CLASS_DIAGRAMS = YES
815
816# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
817# available from the path. This tool is part of Graphviz, a graph visualization
818# toolkit from AT&T and Lucent Bell Labs. The other options in this section
819# have no effect if this option is set to NO (the default)
820
821HAVE_DOT = YES
822
823# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
824# will generate a graph for each documented class showing the direct and
825# indirect inheritance relations. Setting this tag to YES will force the
826# the CLASS_DIAGRAMS tag to NO.
827
828CLASS_GRAPH = YES
829
830# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
831# will generate a graph for each documented class showing the direct and
832# indirect implementation dependencies (inheritance, containment, and
833# class references variables) of the class with other documented classes.
834
835COLLABORATION_GRAPH = YES
836
837# If set to YES, the inheritance and collaboration graphs will show the
838# relations between templates and their instances.
839
840TEMPLATE_RELATIONS = YES
841
842# If set to YES, the inheritance and collaboration graphs will hide
843# inheritance and usage relations if the target is undocumented
844# or is not a class.
845
846HIDE_UNDOC_RELATIONS = NO
847
848# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
849# tags are set to YES then doxygen will generate a graph for each documented
850# file showing the direct and indirect include dependencies of the file with
851# other documented files.
852
853INCLUDE_GRAPH = YES
854
855# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
856# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
857# documented header file showing the documented files that directly or
858# indirectly include this file.
859
860INCLUDED_BY_GRAPH = YES
861
862# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
863# will graphical hierarchy of all classes instead of a textual one.
864
865GRAPHICAL_HIERARCHY = YES
866
867# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
868# generated by dot. Possible values are png, jpg, or gif
869# If left blank png will be used.
870
871DOT_IMAGE_FORMAT = png
872
873# The tag DOT_PATH can be used to specify the path where the dot tool can be
874# found. If left blank, it is assumed the dot tool can be found on the path.
875
876DOT_PATH =
877
878# The DOTFILE_DIRS tag can be used to specify one or more directories that
879# contain dot files that are included in the documentation (see the
880# \dotfile command).
881
882DOTFILE_DIRS =
883
884# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
885# (in pixels) of the graphs generated by dot. If a graph becomes larger than
886# this value, doxygen will try to truncate the graph, so that it fits within
887# the specified constraint. Beware that most browsers cannot cope with very
888# large images.
889
890MAX_DOT_GRAPH_WIDTH = 480
891
892# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
893# (in pixels) of the graphs generated by dot. If a graph becomes larger than
894# this value, doxygen will try to truncate the graph, so that it fits within
895# the specified constraint. Beware that most browsers cannot cope with very
896# large images.
897
898MAX_DOT_GRAPH_HEIGHT = 640
899
900# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
901# generate a legend page explaining the meaning of the various boxes and
902# arrows in the dot generated graphs.
903
904GENERATE_LEGEND = YES
905
906# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
907# remove the intermedate dot files that are used to generate
908# the various graphs.
909
910DOT_CLEANUP = YES
911
912#---------------------------------------------------------------------------
913# Configuration::addtions related to the search engine
914#---------------------------------------------------------------------------
915
916# The SEARCHENGINE tag specifies whether or not a search engine should be
917# used. If set to NO the values of all tags below this one will be ignored.
918
919SEARCHENGINE = NO
920
921# The CGI_NAME tag should be the name of the CGI script that
922# starts the search engine (doxysearch) with the correct parameters.
923# A script with this name will be generated by doxygen.
924
925CGI_NAME =
926
927# The CGI_URL tag should be the absolute URL to the directory where the
928# cgi binaries are located. See the documentation of your http daemon for
929# details.
930
931CGI_URL =
932
933# The DOC_URL tag should be the absolute URL to the directory where the
934# documentation is located. If left blank the absolute path to the
935# documentation, with file:// prepended to it, will be used.
936
937DOC_URL =
938
939# The DOC_ABSPATH tag should be the absolute path to the directory where the
940# documentation is located. If left blank the directory on the local machine
941# will be used.
942
943DOC_ABSPATH =
944
945# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
946# is installed.
947
948BIN_ABSPATH =
949
950# The EXT_DOC_PATHS tag can be used to specify one or more paths to
951# documentation generated for other projects. This allows doxysearch to search
952# the documentation for these projects as well.
953
954EXT_DOC_PATHS =
955PROJECT_NAME = The OPIE API Reference
956PROJECT_NUMBER = Version 0.9.3
957INPUT = .
958OUTPUT_DIRECTORY = ./apidocs
959FILE_PATTERNS = *.dox
960RECURSIVE = NO
961SOURCE_BROWSER = NO
962ALPHABETICAL_INDEX = NO
963HTML_OUTPUT = .
964HTML_HEADER = apidocs/common/mainheader.html
965HTML_FOOTER = apidocs/common/mainfooter.html
966HTML_STYLESHEET = apidocs/common/doxygen.css
967GENERATE_LATEX = NO
968GENERATE_RTF = NO
969GENERATE_MAN = NO
970GENERATE_XML = NO
971GENERATE_AUTOGEN_DEF = NO
972ENABLE_PREPROCESSING = NO
973CLASS_DIAGRAMS = NO
974HAVE_DOT = YES
975GENERATE_HTML = YES
diff --git a/doc/Doxyfile_pim b/doc/Doxyfile_pim
new file mode 100644
index 0000000..60ef90b
--- a/dev/null
+++ b/doc/Doxyfile_pim
@@ -0,0 +1,973 @@
1# Doxyfile 1.2.15
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# General configuration options
15#---------------------------------------------------------------------------
16
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18# by quotes) that should identify the project.
19
20PROJECT_NAME =
21
22# The PROJECT_NUMBER tag can be used to enter a project or revision number.
23# This could be handy for archiving the generated documentation or
24# if some version control system is used.
25
26PROJECT_NUMBER =
27
28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29# base path where the generated documentation will be put.
30# If a relative path is entered, it will be relative to the location
31# where doxygen was started. If left blank the current directory will be used.
32
33OUTPUT_DIRECTORY = ../../apidocs/
34
35# The OUTPUT_LANGUAGE tag is used to specify the language in which all
36# documentation generated by doxygen is written. Doxygen will use this
37# information to generate all constant output in the proper language.
38# The default language is English, other supported languages are:
39# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
40# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
41# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.
42
43OUTPUT_LANGUAGE = English
44
45# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
46# documentation are documented, even if no documentation was available.
47# Private class members and static file members will be hidden unless
48# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
49
50EXTRACT_ALL = NO
51
52# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
53# will be included in the documentation.
54
55EXTRACT_PRIVATE = NO
56
57# If the EXTRACT_STATIC tag is set to YES all static members of a file
58# will be included in the documentation.
59
60EXTRACT_STATIC = YES
61
62# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
63# defined locally in source files will be included in the documentation.
64# If set to NO only classes defined in header files are included.
65
66EXTRACT_LOCAL_CLASSES = NO
67
68# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
69# undocumented members of documented classes, files or namespaces.
70# If set to NO (the default) these members will be included in the
71# various overviews, but no documentation section is generated.
72# This option has no effect if EXTRACT_ALL is enabled.
73
74HIDE_UNDOC_MEMBERS = NO
75
76# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
77# undocumented classes that are normally visible in the class hierarchy.
78# If set to NO (the default) these class will be included in the various
79# overviews. This option has no effect if EXTRACT_ALL is enabled.
80
81HIDE_UNDOC_CLASSES = YES
82
83# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
84# include brief member descriptions after the members that are listed in
85# the file and class documentation (similar to JavaDoc).
86# Set to NO to disable this.
87
88BRIEF_MEMBER_DESC = YES
89
90# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
91# the brief description of a member or function before the detailed description.
92# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
93# brief descriptions will be completely suppressed.
94
95REPEAT_BRIEF = YES
96
97# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
98# Doxygen will generate a detailed section even if there is only a brief
99# description.
100
101ALWAYS_DETAILED_SEC = YES
102
103# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
104# members of a class in the documentation of that class as if those members were
105# ordinary class members. Constructors, destructors and assignment operators of
106# the base classes will not be shown.
107
108INLINE_INHERITED_MEMB = NO
109
110# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
111# path before files name in the file list and in the header files. If set
112# to NO the shortest path that makes the file name unique will be used.
113
114FULL_PATH_NAMES = NO
115
116# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
117# can be used to strip a user defined part of the path. Stripping is
118# only done if one of the specified strings matches the left-hand part of
119# the path. It is allowed to use relative paths in the argument list.
120
121STRIP_FROM_PATH =
122
123# The INTERNAL_DOCS tag determines if documentation
124# that is typed after a \internal command is included. If the tag is set
125# to NO (the default) then the documentation will be excluded.
126# Set it to YES to include the internal documentation.
127
128INTERNAL_DOCS = NO
129
130# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
131# doxygen to hide any special comment blocks from generated source code
132# fragments. Normal C and C++ comments will always remain visible.
133
134STRIP_CODE_COMMENTS = YES
135
136# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
137# file names in lower case letters. If set to YES upper case letters are also
138# allowed. This is useful if you have classes or files whose names only differ
139# in case and if your file system supports case sensitive file names. Windows
140# users are adviced to set this option to NO.
141
142CASE_SENSE_NAMES = YES
143
144# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
145# (but less readable) file names. This can be useful is your file systems
146# doesn't support long names like on DOS, Mac, or CD-ROM.
147
148SHORT_NAMES = NO
149
150# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
151# will show members with their full class and namespace scopes in the
152# documentation. If set to YES the scope will be hidden.
153
154HIDE_SCOPE_NAMES = NO
155
156# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
157# will generate a verbatim copy of the header file for each class for
158# which an include is specified. Set to NO to disable this.
159
160VERBATIM_HEADERS = YES
161
162# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
163# will put list of the files that are included by a file in the documentation
164# of that file.
165
166SHOW_INCLUDE_FILES = YES
167
168# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
169# will interpret the first line (until the first dot) of a JavaDoc-style
170# comment as the brief description. If set to NO, the JavaDoc
171# comments will behave just like the Qt-style comments (thus requiring an
172# explict @brief command for a brief description.
173
174JAVADOC_AUTOBRIEF = YES
175
176# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
177# member inherits the documentation from any documented member that it
178# reimplements.
179
180INHERIT_DOCS = YES
181
182# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
183# is inserted in the documentation for inline members.
184
185INLINE_INFO = YES
186
187# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
188# will sort the (detailed) documentation of file and class members
189# alphabetically by member name. If set to NO the members will appear in
190# declaration order.
191
192SORT_MEMBER_DOCS = NO
193
194# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
195# tag is set to YES, then doxygen will reuse the documentation of the first
196# member in the group (if any) for the other members of the group. By default
197# all members of a group must be documented explicitly.
198
199DISTRIBUTE_GROUP_DOC = NO
200
201# The TAB_SIZE tag can be used to set the number of spaces in a tab.
202# Doxygen uses this value to replace tabs by spaces in code fragments.
203
204TAB_SIZE = 4
205
206# The GENERATE_TODOLIST tag can be used to enable (YES) or
207# disable (NO) the todo list. This list is created by putting \todo
208# commands in the documentation.
209
210GENERATE_TODOLIST = NO
211
212# The GENERATE_TESTLIST tag can be used to enable (YES) or
213# disable (NO) the test list. This list is created by putting \test
214# commands in the documentation.
215
216GENERATE_TESTLIST = NO
217
218# The GENERATE_BUGLIST tag can be used to enable (YES) or
219# disable (NO) the bug list. This list is created by putting \bug
220# commands in the documentation.
221
222GENERATE_BUGLIST = YES
223
224# This tag can be used to specify a number of aliases that acts
225# as commands in the documentation. An alias has the form "name=value".
226# For example adding "sideeffect=\par Side Effects:\n" will allow you to
227# put the command \sideeffect (or @sideeffect) in the documentation, which
228# will result in a user defined paragraph with heading "Side Effects:".
229# You can put \n's in the value part of an alias to insert newlines.
230
231# @ref in KDE docu are for kdoc, doxygen doesn't need them, so we alias them
232# to nothing here
233
234ALIASES = libdoc=@mainpage \
235 sect=<p><b> \
236 reimplemented= \
237 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \
238 obsolete=@deprecated \
239 ref=
240
241# The ENABLED_SECTIONS tag can be used to enable conditional
242# documentation sections, marked by \if sectionname ... \endif.
243
244ENABLED_SECTIONS =
245
246# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
247# the initial value of a variable or define consist of for it to appear in
248# the documentation. If the initializer consists of more lines than specified
249# here it will be hidden. Use a value of 0 to hide initializers completely.
250# The appearance of the initializer of individual variables and defines in the
251# documentation can be controlled using \showinitializer or \hideinitializer
252# command in the documentation regardless of this setting.
253
254MAX_INITIALIZER_LINES = 30
255
256# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
257# only. Doxygen will then generate output that is more tailored for C.
258# For instance some of the names that are used will be different. The list
259# of all members will be omitted, etc.
260
261OPTIMIZE_OUTPUT_FOR_C = NO
262
263# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
264# only. Doxygen will then generate output that is more tailored for Java.
265# For instance namespaces will be presented as packages, qualified scopes
266# will look different, etc.
267
268OPTIMIZE_OUTPUT_JAVA = NO
269
270# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
271# at the bottom of the documentation of classes and structs. If set to YES the
272# list will mention the files that were used to generate the documentation.
273
274SHOW_USED_FILES = YES
275
276#---------------------------------------------------------------------------
277# configuration options related to warning and progress messages
278#---------------------------------------------------------------------------
279
280# The QUIET tag can be used to turn on/off the messages that are generated
281# by doxygen. Possible values are YES and NO. If left blank NO is used.
282
283QUIET = YES
284
285# The WARNINGS tag can be used to turn on/off the warning messages that are
286# generated by doxygen. Possible values are YES and NO. If left blank
287# NO is used.
288
289WARNINGS = YES
290
291# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
292# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
293# automatically be disabled.
294
295WARN_IF_UNDOCUMENTED = NO
296
297# The WARN_FORMAT tag determines the format of the warning messages that
298# doxygen can produce. The string should contain the $file, $line, and $text
299# tags, which will be replaced by the file and line number from which the
300# warning originated and the warning text.
301
302WARN_FORMAT = "$file:$line: $text"
303
304# The WARN_LOGFILE tag can be used to specify a file to which warning
305# and error messages should be written. If left blank the output is written
306# to stderr.
307
308WARN_LOGFILE = Dox-Warning
309
310#---------------------------------------------------------------------------
311# configuration options related to the input files
312#---------------------------------------------------------------------------
313
314# The INPUT tag can be used to specify the files and/or directories that contain
315# documented source files. You may enter file names like "myfile.cpp" or
316# directories like "/usr/src/myproject". Separate the files or directories
317# with spaces.
318
319INPUT =
320
321# If the value of the INPUT tag contains directories, you can use the
322# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
323# and *.h) to filter out the source-files in the directories. If left
324# blank the following patterns are tested:
325# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
326# *.h++ *.idl *.odl
327
328FILE_PATTERNS = *.h \
329 *.cpp \
330 *.cc \
331 *.hpp
332
333# The RECURSIVE tag can be used to turn specify whether or not subdirectories
334# should be searched for input files as well. Possible values are YES and NO.
335# If left blank NO is used.
336
337RECURSIVE = NO
338
339# The EXCLUDE tag can be used to specify files and/or directories that should
340# excluded from the INPUT source files. This way you can easily exclude a
341# subdirectory from a directory tree whose root is specified with the INPUT tag.
342
343EXCLUDE =
344
345# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
346# that are symbolic links (a Unix filesystem feature) are excluded from the input.
347
348EXCLUDE_SYMLINKS = NO
349
350# If the value of the INPUT tag contains directories, you can use the
351# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
352# certain files from those directories.
353
354EXCLUDE_PATTERNS = *.moc.* \
355 moc* \
356 *.all_cpp.* \
357 *unload.* \
358 */test/* \
359 */tests/*
360
361# The EXAMPLE_PATH tag can be used to specify one or more files or
362# directories that contain example code fragments that are included (see
363# the \include command).
364
365EXAMPLE_PATH =
366
367# If the value of the EXAMPLE_PATH tag contains directories, you can use the
368# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
369# and *.h) to filter out the source-files in the directories. If left
370# blank all files are included.
371
372EXAMPLE_PATTERNS =
373
374# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
375# searched for input files to be used with the \include or \dontinclude
376# commands irrespective of the value of the RECURSIVE tag.
377# Possible values are YES and NO. If left blank NO is used.
378
379EXAMPLE_RECURSIVE = NO
380
381# The IMAGE_PATH tag can be used to specify one or more files or
382# directories that contain image that are included in the documentation (see
383# the \image command).
384
385IMAGE_PATH =
386
387# The INPUT_FILTER tag can be used to specify a program that doxygen should
388# invoke to filter for each input file. Doxygen will invoke the filter program
389# by executing (via popen()) the command <filter> <input-file>, where <filter>
390# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
391# input file. Doxygen will then use the output that the filter program writes
392# to standard output.
393
394INPUT_FILTER =
395
396# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
397# INPUT_FILTER) will be used to filter the input files when producing source
398# files to browse.
399
400FILTER_SOURCE_FILES = NO
401
402#---------------------------------------------------------------------------
403# configuration options related to source browsing
404#---------------------------------------------------------------------------
405
406# If the SOURCE_BROWSER tag is set to YES then a list of source files will
407# be generated. Documented entities will be cross-referenced with these sources.
408
409SOURCE_BROWSER = YES
410
411# Setting the INLINE_SOURCES tag to YES will include the body
412# of functions and classes directly in the documentation.
413
414INLINE_SOURCES = NO
415
416# If the REFERENCED_BY_RELATION tag is set to YES (the default)
417# then for each documented function all documented
418# functions referencing it will be listed.
419
420REFERENCED_BY_RELATION = YES
421
422# If the REFERENCES_RELATION tag is set to YES (the default)
423# then for each documented function all documented entities
424# called/used by that function will be listed.
425
426REFERENCES_RELATION = YES
427
428#---------------------------------------------------------------------------
429# configuration options related to the alphabetical class index
430#---------------------------------------------------------------------------
431
432# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
433# of all compounds will be generated. Enable this if the project
434# contains a lot of classes, structs, unions or interfaces.
435
436ALPHABETICAL_INDEX = YES
437
438# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
439# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
440# in which this list will be split (can be a number in the range [1..20])
441
442COLS_IN_ALPHA_INDEX = 3
443
444# In case all classes in a project start with a common prefix, all
445# classes will be put under the same header in the alphabetical index.
446# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
447# should be ignored while generating the index headers.
448
449IGNORE_PREFIX = K
450
451#---------------------------------------------------------------------------
452# configuration options related to the HTML output
453#---------------------------------------------------------------------------
454
455# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
456# generate HTML output.
457
458GENERATE_HTML = NO
459
460# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
461# If a relative path is entered the value of OUTPUT_DIRECTORY will be
462# put in front of it. If left blank `html' will be used as the default path.
463
464HTML_OUTPUT =
465
466# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
467# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
468# doxygen will generate files with .html extension.
469
470HTML_FILE_EXTENSION = .html
471
472# The HTML_HEADER tag can be used to specify a personal HTML header for
473# each generated HTML page. If it is left blank doxygen will generate a
474# standard header.
475
476HTML_HEADER = ../../apidocs/common/header.html
477
478# The HTML_FOOTER tag can be used to specify a personal HTML footer for
479# each generated HTML page. If it is left blank doxygen will generate a
480# standard footer.
481
482HTML_FOOTER = ../../apidocs/common/footer.html
483
484# The HTML_STYLESHEET tag can be used to specify a user defined cascading
485# style sheet that is used by each HTML page. It can be used to
486# fine-tune the look of the HTML output. If the tag is left blank doxygen
487# will generate a default style sheet
488
489HTML_STYLESHEET = ../../apidocs/common/doxygen.css
490
491# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
492# files or namespaces will be aligned in HTML using tables. If set to
493# NO a bullet list will be used.
494
495HTML_ALIGN_MEMBERS = YES
496
497# If the GENERATE_HTMLHELP tag is set to YES, additional index files
498# will be generated that can be used as input for tools like the
499# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
500# of the generated HTML documentation.
501
502GENERATE_HTMLHELP = NO
503
504# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
505# controls if a separate .chi index file is generated (YES) or that
506# it should be included in the master .chm file (NO).
507
508GENERATE_CHI = NO
509
510# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
511# controls whether a binary table of contents is generated (YES) or a
512# normal table of contents (NO) in the .chm file.
513
514BINARY_TOC = NO
515
516# The TOC_EXPAND flag can be set to YES to add extra items for group members
517# to the contents of the Html help documentation and to the tree view.
518
519TOC_EXPAND = NO
520
521# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
522# top of each HTML page. The value NO (the default) enables the index and
523# the value YES disables it.
524
525DISABLE_INDEX = YES
526
527# This tag can be used to set the number of enum values (range [1..20])
528# that doxygen will group on one line in the generated HTML documentation.
529
530ENUM_VALUES_PER_LINE = 4
531
532# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
533# generated containing a tree-like index structure (just like the one that
534# is generated for HTML Help). For this to work a browser that supports
535# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
536# or Internet explorer 4.0+). Note that for large projects the tree generation
537# can take a very long time. In such cases it is better to disable this feature.
538# Windows users are probably better off using the HTML help feature.
539
540GENERATE_TREEVIEW = NO
541
542# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
543# used to set the initial width (in pixels) of the frame in which the tree
544# is shown.
545
546TREEVIEW_WIDTH = 250
547
548#---------------------------------------------------------------------------
549# configuration options related to the LaTeX output
550#---------------------------------------------------------------------------
551
552# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
553# generate Latex output.
554
555GENERATE_LATEX = NO
556
557# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
558# If a relative path is entered the value of OUTPUT_DIRECTORY will be
559# put in front of it. If left blank `latex' will be used as the default path.
560
561LATEX_OUTPUT =
562
563# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
564
565LATEX_CMD_NAME = latex
566
567# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
568# generate index for LaTeX. If left blank `makeindex' will be used as the
569# default command name.
570
571MAKEINDEX_CMD_NAME = makeindex
572
573# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
574# LaTeX documents. This may be useful for small projects and may help to
575# save some trees in general.
576
577COMPACT_LATEX = NO
578
579# The PAPER_TYPE tag can be used to set the paper type that is used
580# by the printer. Possible values are: a4, a4wide, letter, legal and
581# executive. If left blank a4wide will be used.
582
583PAPER_TYPE = a4wide
584
585# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
586# packages that should be included in the LaTeX output.
587
588EXTRA_PACKAGES =
589
590# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
591# the generated latex document. The header should contain everything until
592# the first chapter. If it is left blank doxygen will generate a
593# standard header. Notice: only use this tag if you know what you are doing!
594
595LATEX_HEADER =
596
597# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
598# is prepared for conversion to pdf (using ps2pdf). The pdf file will
599# contain links (just like the HTML output) instead of page references
600# This makes the output suitable for online browsing using a pdf viewer.
601
602PDF_HYPERLINKS = NO
603
604# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
605# plain latex in the generated Makefile. Set this option to YES to get a
606# higher quality PDF documentation.
607
608USE_PDFLATEX = NO
609
610# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
611# command to the generated LaTeX files. This will instruct LaTeX to keep
612# running if errors occur, instead of asking the user for help.
613# This option is also used when generating formulas in HTML.
614
615LATEX_BATCHMODE = NO
616
617#---------------------------------------------------------------------------
618# configuration options related to the RTF output
619#---------------------------------------------------------------------------
620
621# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
622# The RTF output is optimised for Word 97 and may not look very pretty with
623# other RTF readers or editors.
624
625GENERATE_RTF = NO
626
627# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
628# If a relative path is entered the value of OUTPUT_DIRECTORY will be
629# put in front of it. If left blank `rtf' will be used as the default path.
630
631RTF_OUTPUT =
632
633# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
634# RTF documents. This may be useful for small projects and may help to
635# save some trees in general.
636
637COMPACT_RTF = NO
638
639# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
640# will contain hyperlink fields. The RTF file will
641# contain links (just like the HTML output) instead of page references.
642# This makes the output suitable for online browsing using WORD or other
643# programs which support those fields.
644# Note: wordpad (write) and others do not support links.
645
646RTF_HYPERLINKS = NO
647
648# Load stylesheet definitions from file. Syntax is similar to doxygen's
649# config file, i.e. a series of assigments. You only have to provide
650# replacements, missing definitions are set to their default value.
651
652RTF_STYLESHEET_FILE =
653
654# Set optional variables used in the generation of an rtf document.
655# Syntax is similar to doxygen's config file.
656
657RTF_EXTENSIONS_FILE =
658
659#---------------------------------------------------------------------------
660# configuration options related to the man page output
661#---------------------------------------------------------------------------
662
663# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
664# generate man pages
665
666GENERATE_MAN = NO
667
668# The MAN_OUTPUT tag is used to specify where the man pages will be put.
669# If a relative path is entered the value of OUTPUT_DIRECTORY will be
670# put in front of it. If left blank `man' will be used as the default path.
671
672MAN_OUTPUT =
673
674# The MAN_EXTENSION tag determines the extension that is added to
675# the generated man pages (default is the subroutine's section .3)
676
677MAN_EXTENSION = .kde3
678
679# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
680# then it will generate one additional man file for each entity
681# documented in the real man page(s). These additional files
682# only source the real man page, but without them the man command
683# would be unable to find the correct page. The default is NO.
684
685MAN_LINKS = YES
686
687#---------------------------------------------------------------------------
688# configuration options related to the XML output
689#---------------------------------------------------------------------------
690
691# If the GENERATE_XML tag is set to YES Doxygen will
692# generate an XML file that captures the structure of
693# the code including all documentation. Note that this
694# feature is still experimental and incomplete at the
695# moment.
696
697GENERATE_XML = NO
698
699#---------------------------------------------------------------------------
700# configuration options for the AutoGen Definitions output
701#---------------------------------------------------------------------------
702
703# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
704# generate an AutoGen Definitions (see autogen.sf.net) file
705# that captures the structure of the code including all
706# documentation. Note that this feature is still experimental
707# and incomplete at the moment.
708
709GENERATE_AUTOGEN_DEF = NO
710
711#---------------------------------------------------------------------------
712# Configuration options related to the preprocessor
713#---------------------------------------------------------------------------
714
715# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
716# evaluate all C-preprocessor directives found in the sources and include
717# files.
718
719ENABLE_PREPROCESSING = YES
720
721# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
722# names in the source code. If set to NO (the default) only conditional
723# compilation will be performed. Macro expansion can be done in a controlled
724# way by setting EXPAND_ONLY_PREDEF to YES.
725
726MACRO_EXPANSION = NO
727
728# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
729# then the macro expansion is limited to the macros specified with the
730# PREDEFINED and EXPAND_AS_PREDEFINED tags.
731
732EXPAND_ONLY_PREDEF = NO
733
734# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
735# in the INCLUDE_PATH (see below) will be search if a #include is found.
736
737SEARCH_INCLUDES = YES
738
739# The INCLUDE_PATH tag can be used to specify one or more directories that
740# contain include files that are not input files but should be processed by
741# the preprocessor.
742
743INCLUDE_PATH =
744
745# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
746# patterns (like *.h and *.hpp) to filter out the header-files in the
747# directories. If left blank, the patterns specified with FILE_PATTERNS will
748# be used.
749
750INCLUDE_FILE_PATTERNS =
751
752# The PREDEFINED tag can be used to specify one or more macro names that
753# are defined before the preprocessor is started (similar to the -D option of
754# gcc). The argument of the tag is a list of macros of the form: name
755# or name=definition (no spaces). If the definition and the = are
756# omitted =1 is assumed.
757
758PREDEFINED = QT_VERSION=305
759
760# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
761# this tag can be used to specify a list of macro names that should be expanded.
762# The macro definition that is found in the sources will be used.
763# Use the PREDEFINED tag if you want to use a different macro definition.
764
765EXPAND_AS_DEFINED =
766
767# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
768# doxygen's preprocessor will remove all function-like macros that are alone
769# on a line and do not end with a semicolon. Such function macros are typically
770# used for boiler-plate code, and will confuse the parser if not removed.
771
772SKIP_FUNCTION_MACROS = YES
773
774#---------------------------------------------------------------------------
775# Configuration::addtions related to external references
776#---------------------------------------------------------------------------
777
778# The TAGFILES tag can be used to specify one or more tagfiles.
779
780TAGFILES =
781
782# When a file name is specified after GENERATE_TAGFILE, doxygen will create
783# a tag file that is based on the input files it reads.
784
785GENERATE_TAGFILE =
786
787# If the ALLEXTERNALS tag is set to YES all external classes will be listed
788# in the class index. If set to NO only the inherited external classes
789# will be listed.
790
791ALLEXTERNALS = NO
792
793# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
794# in the modules index. If set to NO, only the current project's groups will
795# be listed.
796
797EXTERNAL_GROUPS = NO
798
799# The PERL_PATH should be the absolute path and name of the perl script
800# interpreter (i.e. the result of `which perl').
801
802PERL_PATH =
803
804#---------------------------------------------------------------------------
805# Configuration options related to the dot tool
806#---------------------------------------------------------------------------
807
808# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
809# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
810# super classes. Setting the tag to NO turns the diagrams off. Note that this
811# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
812# recommended to install and use dot, since it yield more powerful graphs.
813
814CLASS_DIAGRAMS = YES
815
816# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
817# available from the path. This tool is part of Graphviz, a graph visualization
818# toolkit from AT&T and Lucent Bell Labs. The other options in this section
819# have no effect if this option is set to NO (the default)
820
821HAVE_DOT = NO
822
823# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
824# will generate a graph for each documented class showing the direct and
825# indirect inheritance relations. Setting this tag to YES will force the
826# the CLASS_DIAGRAMS tag to NO.
827
828CLASS_GRAPH = YES
829
830# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
831# will generate a graph for each documented class showing the direct and
832# indirect implementation dependencies (inheritance, containment, and
833# class references variables) of the class with other documented classes.
834
835COLLABORATION_GRAPH = YES
836
837# If set to YES, the inheritance and collaboration graphs will show the
838# relations between templates and their instances.
839
840TEMPLATE_RELATIONS = YES
841
842# If set to YES, the inheritance and collaboration graphs will hide
843# inheritance and usage relations if the target is undocumented
844# or is not a class.
845
846HIDE_UNDOC_RELATIONS = NO
847
848# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
849# tags are set to YES then doxygen will generate a graph for each documented
850# file showing the direct and indirect include dependencies of the file with
851# other documented files.
852
853INCLUDE_GRAPH = YES
854
855# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
856# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
857# documented header file showing the documented files that directly or
858# indirectly include this file.
859
860INCLUDED_BY_GRAPH = YES
861
862# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
863# will graphical hierarchy of all classes instead of a textual one.
864
865GRAPHICAL_HIERARCHY = NO
866
867# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
868# generated by dot. Possible values are png, jpg, or gif
869# If left blank png will be used.
870
871DOT_IMAGE_FORMAT = png
872
873# The tag DOT_PATH can be used to specify the path where the dot tool can be
874# found. If left blank, it is assumed the dot tool can be found on the path.
875
876DOT_PATH =
877
878# The DOTFILE_DIRS tag can be used to specify one or more directories that
879# contain dot files that are included in the documentation (see the
880# \dotfile command).
881
882DOTFILE_DIRS =
883
884# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
885# (in pixels) of the graphs generated by dot. If a graph becomes larger than
886# this value, doxygen will try to truncate the graph, so that it fits within
887# the specified constraint. Beware that most browsers cannot cope with very
888# large images.
889
890MAX_DOT_GRAPH_WIDTH = 800
891
892# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
893# (in pixels) of the graphs generated by dot. If a graph becomes larger than
894# this value, doxygen will try to truncate the graph, so that it fits within
895# the specified constraint. Beware that most browsers cannot cope with very
896# large images.
897
898MAX_DOT_GRAPH_HEIGHT = 1024
899
900# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
901# generate a legend page explaining the meaning of the various boxes and
902# arrows in the dot generated graphs.
903
904GENERATE_LEGEND = YES
905
906# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
907# remove the intermedate dot files that are used to generate
908# the various graphs.
909
910DOT_CLEANUP = YES
911
912#---------------------------------------------------------------------------
913# Configuration::addtions related to the search engine
914#---------------------------------------------------------------------------
915
916# The SEARCHENGINE tag specifies whether or not a search engine should be
917# used. If set to NO the values of all tags below this one will be ignored.
918
919SEARCHENGINE = NO
920
921# The CGI_NAME tag should be the name of the CGI script that
922# starts the search engine (doxysearch) with the correct parameters.
923# A script with this name will be generated by doxygen.
924
925CGI_NAME =
926
927# The CGI_URL tag should be the absolute URL to the directory where the
928# cgi binaries are located. See the documentation of your http daemon for
929# details.
930
931CGI_URL =
932
933# The DOC_URL tag should be the absolute URL to the directory where the
934# documentation is located. If left blank the absolute path to the
935# documentation, with file:// prepended to it, will be used.
936
937DOC_URL =
938
939# The DOC_ABSPATH tag should be the absolute path to the directory where the
940# documentation is located. If left blank the directory on the local machine
941# will be used.
942
943DOC_ABSPATH =
944
945# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
946# is installed.
947
948BIN_ABSPATH =
949
950# The EXT_DOC_PATHS tag can be used to specify one or more paths to
951# documentation generated for other projects. This allows doxysearch to search
952# the documentation for these projects as well.
953
954EXT_DOC_PATHS =
955PROJECT_NAME = "libopie PIM"
956PROJECT_NUMBER = "Version 0.9.3"
957INPUT = .
958IMAGE_PATH = ../../apidocs/api
959OUTPUT_DIRECTORY = ../../apidocs
960HTML_OUTPUT = pim/html
961LATEX_OUTPUT = pim/latex
962RTF_OUTPUT = pim/rtf
963MAN_OUTPUT = pim/man
964GENERATE_HTML = yes
965GENERATE_MAN = no
966GENERATE_LATEX = no
967TAGFILES = \
968../../apidocs/qt/qt.tag=../../qt/ \
969../../apidocs/libqpe/libqpe.tag=../../libqpe/html \
970../../apidocs/libopie/libopie.tag=../../libopie/html
971GENERATE_TAGFILE = ../../apidocs/pim/pim.tag
972IGNORE_PREFIX = O
973HAVE_DOT = YES
diff --git a/doc/README b/doc/README
new file mode 100644
index 0000000..4d06dd6
--- a/dev/null
+++ b/doc/README
@@ -0,0 +1 @@
This is the src of our apidocs \ No newline at end of file
diff --git a/doc/common/1.png b/doc/common/1.png
new file mode 100644
index 0000000..7d47343
--- a/dev/null
+++ b/doc/common/1.png
Binary files differ
diff --git a/doc/common/10.png b/doc/common/10.png
new file mode 100644
index 0000000..997bbc8
--- a/dev/null
+++ b/doc/common/10.png
Binary files differ
diff --git a/doc/common/2.png b/doc/common/2.png
new file mode 100644
index 0000000..5d09341
--- a/dev/null
+++ b/doc/common/2.png
Binary files differ
diff --git a/doc/common/3.png b/doc/common/3.png
new file mode 100644
index 0000000..ef7b700
--- a/dev/null
+++ b/doc/common/3.png
Binary files differ
diff --git a/doc/common/4.png b/doc/common/4.png
new file mode 100644
index 0000000..adb8364
--- a/dev/null
+++ b/doc/common/4.png
Binary files differ
diff --git a/doc/common/5.png b/doc/common/5.png
new file mode 100644
index 0000000..4d7eb46
--- a/dev/null
+++ b/doc/common/5.png
Binary files differ
diff --git a/doc/common/6.png b/doc/common/6.png
new file mode 100644
index 0000000..0ba694a
--- a/dev/null
+++ b/doc/common/6.png
Binary files differ
diff --git a/doc/common/7.png b/doc/common/7.png
new file mode 100644
index 0000000..472e96f
--- a/dev/null
+++ b/doc/common/7.png
Binary files differ
diff --git a/doc/common/8.png b/doc/common/8.png
new file mode 100644
index 0000000..5e60973
--- a/dev/null
+++ b/doc/common/8.png
Binary files differ
diff --git a/doc/common/9.png b/doc/common/9.png
new file mode 100644
index 0000000..a0676d2
--- a/dev/null
+++ b/doc/common/9.png
Binary files differ
diff --git a/doc/common/artistic-license.html b/doc/common/artistic-license.html
new file mode 100755
index 0000000..2069b4e
--- a/dev/null
+++ b/doc/common/artistic-license.html
@@ -0,0 +1,165 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html40/strict.dtd">
3<HTML LANG="en-US">
4 <HEAD>
5 <TITLE>The "Artistic License"</TITLE>
6 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=us-ascii">
7 <META HTTP-EQUIV="Content-Language" CONTENT="en-US">
8 <META NAME="description" CONTENT="Artistic License">
9 <META NAME="keywords" CONTENT="Artistic, artistic, Artistic License, Artistic license, Artisticlicense, artistic license, artisticlicense, Artistic Licence, Artistic licence, Artisticlicence, artistic licence, artisticlicence, license, licence, software, softwarelicense">
10 <META NAME="robots" CONTENT="none">
11 <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
12 <LINK REL="stylesheet" HREF="kde-default.css" TYPE="text/css">
13 </HEAD>
14 <BODY CLASS="license">
15 <H1>The "Artistic License"</H1>
16
17 <H2>Preamble</H2>
18
19 <P>The intent of this document is to state the conditions under
20 which a Package may be copied, such that the Copyright Holder
21 maintains some semblance of artistic control over the
22 development of the package, while giving the users of the
23 package the right to use and distribute the Package in a
24 more-or-less customary fashion, plus the right to make
25 reasonable modifications.</P>
26
27 <H2>Definitions</H2>
28
29
30 <P>"Package" refers to the collection of files distributed by the
31 Copyright Holder, and derivatives of that collection of files
32 created through textual modification.</P>
33
34 <P>"Standard Version" refers to such a Package if it has not been
35 modified, or has been modified in accordance with the wishes of
36 the Copyright Holder as specified below.</P>
37
38 <P>"Copyright Holder" is whoever is named in the copyright or
39 copyrights for the package.</P>
40
41 <P>"You" is you, if you're thinking about copying or distributing
42 this Package.</P>
43
44 <P>"Reasonable copying fee" is whatever you can justify on the
45 basis of media cost, duplication charges, time of people
46 involved, and so on. (You will not be required to justify it to
47 the Copyright Holder, but only to the computing community at
48 large as a market that must bear the fee.)</P>
49
50 <P>"Freely Available" means that no fee is charged for the item
51 itself, though there may be fees involved in handling the
52 item. It also means that recipients of the item may redistribute
53 it under the same conditions they received it.</P>
54
55
56 <OL STYLE="list-style-type: decimal;">
57 <LI><DIV CLASS="li">You may make and give away verbatim copies of the source
58 form of the Standard Version of this Package without
59 restriction, provided that you duplicate all of the original
60 copyright notices and associated disclaimers.</DIV></LI>
61
62 <LI>You may apply bug fixes, portability fixes and other
63 modifications derived from the Public Domain or from the
64 Copyright Holder. A Package modified in such a way shall still
65 be considered the Standard Version.</LI>
66
67 <LI>You may otherwise modify your copy of this Package in any
68 way, provided that you insert a prominent notice in each
69 changed file stating how and when you changed that file, and
70 provided that you do at least ONE of the following:
71 <OL STYLE="list-style-type: lower-alpha;">
72 <LI>place your modifications in the Public Domain or
73 otherwise make them Freely Available, such as by posting
74 said modifications to Usenet or an equivalent medium, or
75 placing the modifications on a major archive site such as
76 uunet.uu.net, or by allowing the Copyright Holder to
77 include your modifications in the Standard Version of the
78 Package.</LI>
79
80 <LI>use the modified Package only within your corporation or
81 organization.</LI>
82
83 <LI>rename any non-standard executables so the names do not
84 conflict with standard executables, which must also be
85 provided, and provide a separate manual page for each
86 non-standard executable that clearly documents how it
87 differs from the Standard Version. d. make other
88 distribution arrangements with the Copyright Holder.</LI>
89 </OL>
90 </LI>
91 </OL>
92
93 <P>You may distribute the programs of this Package in object code
94 or executable form, provided that you do at least ONE of the
95 following:</P>
96
97 <OL STYLE="list-style-type: lower-alpha;">
98 <LI>distribute a Standard Version of the executables and library
99 files, together with instructions (in the manual page or
100 equivalent) on where to get the Standard Version.</LI>
101
102 <LI>accompany the distribution with the machine-readable source
103 of the Package with your modifications.</LI>
104
105 <LI>give non-standard executables non-standard names, and
106 clearly document the differences in manual pages (or
107 equivalent), together with instructions on where to get the
108 Standard Version.</LI>
109
110 <LI>make other distribution arrangements with the Copyright
111 Holder.</LI>
112 </OL>
113
114 <P>You may charge a reasonable copying fee for any distribution of
115 this Package. You may charge any fee you choose for support of
116 this Package. You may not charge a fee for this Package
117 itself. However, you may distribute this Package in aggregate
118 with other (possibly commercial) programs as part of a larger
119 (possibly commercial) software distribution provided that you do
120 not advertise this Package as a product of your own. You may
121 embed this Package's interpreter within an executable of yours
122 (by linking); this shall be construed as a mere form of
123 aggregation, provided that the complete Standard Version of the
124 interpreter is so embedded.</P>
125
126 <P>The scripts and library files supplied as input to or produced
127 as output from the programs of this Package do not automatically
128 fall under the copyright of this Package, but belong to whomever
129 generated them, and may be sold commercially, and may be
130 aggregated with this Package. If such scripts or library files
131 are aggregated with this Package via the so-called "undump" or
132 "unexec" methods of producing a binary executable image, then
133 distribution of such an image shall neither be construed as a
134 distribution of this Package nor shall it fall under the
135 restrictions of Paragraphs 3 and 4, provided that you do not
136 represent such an executable image as a Standard Version of this
137 Package.</P>
138
139 <P>C subroutines (or comparably compiled subroutines in other
140 languages) supplied by you and linked into this Package in order
141 to emulate subroutines and variables of the language defined by
142 this Package shall not be considered part of this Package, but
143 are the equivalent of input as in Paragraph 6, provided these
144 subroutines do not change the language in any way that would
145 cause it to fail the regression tests for the language.</P>
146
147 <P>Aggregation of this Package with a commercial distribution is
148 always permitted provided that the use of this Package is
149 embedded; that is, when no overt attempt is made to make this
150 Package's interfaces visible to the end user of the commercial
151 distribution. Such use shall not be construed as a distribution
152 of this Package.</P>
153
154 <P>The name of the Copyright Holder may not be used to endorse or
155 promote products derived from this software without specific
156 prior written permission.</P>
157
158 <P>THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
159 IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
160 WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
161 PURPOSE.</P>
162
163 <DIV STYLE="text-align: center;">The End</DIV>
164 </BODY>
165</HTML>
diff --git a/doc/common/bottom1.png b/doc/common/bottom1.png
new file mode 100644
index 0000000..cf26bf4
--- a/dev/null
+++ b/doc/common/bottom1.png
Binary files differ
diff --git a/doc/common/bottom2.png b/doc/common/bottom2.png
new file mode 100644
index 0000000..0515155
--- a/dev/null
+++ b/doc/common/bottom2.png
Binary files differ
diff --git a/doc/common/bsd-license.html b/doc/common/bsd-license.html
new file mode 100755
index 0000000..422bb33
--- a/dev/null
+++ b/doc/common/bsd-license.html
@@ -0,0 +1,45 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html40/strict.dtd">
3<HTML LANG="en-US">
4 <HEAD>
5 <TITLE>BSD License</TITLE>
6 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=us-ascii">
7 <META HTTP-EQUIV="Content-Language" CONTENT="en-US">
8 <META NAME="description" CONTENT="BSD License">
9 <META NAME="keywords" CONTENT="BSD, bsd, Bsd, license, licence, software, free software, softwarelicense, BSD Software license">
10 <META NAME="robots" CONTENT="none">
11 <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
12 <LINK REL="stylesheet" HREF="kde-default.css" TYPE="text/css">
13 </HEAD>
14 <BODY CLASS="license">
15 <H1>BSD License</H1>
16
17 <P>Redistribution and use in source and binary forms, with or
18 without modification, are permitted provided that the following
19 conditions are met:</P>
20
21 <OL>
22 <LI>Redistributions of source code must retain the above
23 copyright notice, this list of conditions and the following
24 disclaimer.</LI>
25
26 <LI>Redistributions in binary form must reproduce the above
27 copyright notice, this list of conditions and the following
28 disclaimer in the documentation and/or other materials
29 provided with the distribution.</LI>
30 </OL>
31
32 <P>THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY
33 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
34 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
35 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR
36 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
37 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
38 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
39 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
40 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
41 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
42 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
43 THE POSSIBILITY OF SUCH DAMAGE.</P>
44 </BODY>
45</HTML>
diff --git a/doc/common/docheadergears.png b/doc/common/docheadergears.png
new file mode 100644
index 0000000..8bd254c
--- a/dev/null
+++ b/doc/common/docheadergears.png
Binary files differ
diff --git a/doc/common/doctop1.png b/doc/common/doctop1.png
new file mode 100644
index 0000000..9ddb33d
--- a/dev/null
+++ b/doc/common/doctop1.png
Binary files differ
diff --git a/doc/common/doctop1a-online.png b/doc/common/doctop1a-online.png
new file mode 100755
index 0000000..0e7512a
--- a/dev/null
+++ b/doc/common/doctop1a-online.png
Binary files differ
diff --git a/doc/common/doctop1a.png b/doc/common/doctop1a.png
new file mode 100755
index 0000000..123284c
--- a/dev/null
+++ b/doc/common/doctop1a.png
Binary files differ
diff --git a/doc/common/doctop1b.png b/doc/common/doctop1b.png
new file mode 100644
index 0000000..428a6e8
--- a/dev/null
+++ b/doc/common/doctop1b.png
Binary files differ
diff --git a/doc/common/doctop2-online.png b/doc/common/doctop2-online.png
new file mode 100644
index 0000000..9f9e744
--- a/dev/null
+++ b/doc/common/doctop2-online.png
Binary files differ
diff --git a/doc/common/doctop2.png b/doc/common/doctop2.png
new file mode 100644
index 0000000..400ed5f
--- a/dev/null
+++ b/doc/common/doctop2.png
Binary files differ
diff --git a/doc/common/doxygen.css b/doc/common/doxygen.css
new file mode 100755
index 0000000..b20213b
--- a/dev/null
+++ b/doc/common/doxygen.css
@@ -0,0 +1,152 @@
1/*******************************************************************************
2
3 Style sheet for kdelibs doxygen documentation.
4 Copyright (c) Anders Lund <anders@alweb.dk> 2002
5
6 This script is made available under the terms of the General Public Licence.
7 You should have received a copy of the GNU General Public License
8 along with this software; see the file COPYING. If not, write to
9 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
10 Boston, MA 02111-1307, USA.
11
12********************************************************************************/
13
14body {
15 margin: 0px;
16 color: black;
17 background-color: white;
18}
19
20a {
21 color: #0000C0;
22}
23
24/* decorative header */
25div.header {
26 background-color: #0855C5;
27 background-image: url("headerbg.png");
28}
29div.header table {
30 padding: 0px;
31 margin: 0px
32}
33div.header table tr td h1 {
34 color: white;
35 font: bold 20pt courier;
36 padding-top: 0.5em;
37}
38
39/* global lind buttons at bottom of decorative header */
40table.links {
41 float: right;
42 border:0;
43 padding-left:1px
44}
45table.links td a {
46 color: white
47}
48table.links td:hover {
49 background-color:#0C4293;
50}
51table.links td a:hover {
52 color: white;
53 background-color:#0C4293
54}
55table.links td {
56 border-left: 1px solid #4A81D5;
57 padding: 0px 12px 0px 12px;
58 background-color:#0E4EAF;
59 font-size:9pt;
60 /*font-weight: bold;*/
61}
62
63/* little gradient below decorative/navigation header */
64div#hgrad {
65 height: 12px;
66 background-image: url("grad.png");
67}
68
69/* contents part of page */
70div.text {
71 margin: 12px
72}
73
74/* contents, mostly equivalent to the default doxugen style sheet */
75H1 { text-align: center; }
76CAPTION { font-weight: bold }
77A.qindex {}
78A.qindexRef {}
79A.el { text-decoration: none; font-weight: bold }
80A.elRef { font-weight: bold }
81A.code { text-decoration: none; font-weight: normal; color: #4444ee }
82A.codeRef { font-weight: normal; color: #4444ee }
83A:hover { text-decoration: none; background-color: #ececec }
84DL.el { margin-left: -1cm }
85DIV.fragment { width: 100%; border: none; background-color: #ffffee; padding: 12px }
86DIV.ah { background-color: navy; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px }
87TD.md { background-color: #ececec; font-weight: bold; }
88TD.mdname1 { background-color: #ececec; font-weight: bold; color: #602020; }
89TD.mdname { background-color: #ececec; font-weight: bold; color: #602020; width: 600px; }
90DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold }
91DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller }
92BODY { background: white }
93TD.indexkey {
94 background-color: #e0eef8;
95 font-weight: bold;
96 padding-right : 10px;
97 padding-top : 2px;
98 padding-left : 10px;
99 padding-bottom : 2px;
100 margin-left : 0px;
101 margin-right : 0px;
102 margin-top : 2px;
103 margin-bottom : 2px
104}
105TD.indexvalue {
106 background-color: #e0eef8;
107 font-style: normal;
108 padding-right : 10px;
109 padding-top : 2px;
110 padding-left : 10px;
111 padding-bottom : 2px;
112 margin-left : 0px;
113 margin-right : 0px;
114 margin-top : 2px;
115 margin-bottom : 2px
116}
117FONT.keyword { color: #008000 }
118FONT.keywordtype { color: #604020 }
119FONT.keywordflow { color: #e08000 }
120FONT.comment { color: #800000 }
121FONT.preprocessor { color: #806020 }
122FONT.stringliteral { color: #002080 }
123FONT.charliteral { color: #008080 }
124
125
126
127/* kde decoration at bottom */
128div#bottom-nav {
129 position : relative;
130 background-color: transparent;
131 /*width : 100%;*/
132 /*top: 0px;
133 left: 0px;
134 right: 0px;
135 margin-left: 0px;
136 margin-right:0px;*/
137 margin-top: 12px;
138 height: 50px;
139 background-image : url('bottom1.png');
140 background-repeat : repeat-x;
141}
142
143/* copyright etc at bottom */
144div.bottom {
145 margin: 12px;
146 font-size: 9pt;
147 text-align: right;
148}
149div.bottom a {
150 color: #aaaaaa
151}
152
diff --git a/doc/common/fdl-license.html b/doc/common/fdl-license.html
new file mode 100644
index 0000000..6b78a5a
--- a/dev/null
+++ b/doc/common/fdl-license.html
@@ -0,0 +1,353 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html40/strict.dtd">
3<HTML LANG="en-US">
4 <HEAD>
5 <TITLE>GNU Free Documentation License - version 1.1</TITLE>
6 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=us-ascii">
7 <META HTTP-EQUIV="Content-Language" CONTENT="en-US">
8 <META NAME="description" CONTENT="GNU free documentation license (for inclusion in documentation files)">
9 <META NAME="keywords" CONTENT="gnu, Gnu, GNU, license, licence, software, free software, software license, software licence, GNU general public license, GNU General Public License, documentation licence, documentation license, documentation, GNU free documentation license, GNU Free Documentation License">
10 <META NAME="robots" CONTENT="none">
11 <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
12 <LINK REL="stylesheet" HREF="kde-default.css" TYPE="text/css">
13 </HEAD>
14 <BODY CLASS="license">
15<H1>GNU Free Documentation License</H1>
16 Version 1.1, March 2000
17
18<P>Copyright (C) 2000 Free Software Foundation, Inc.
19 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA<BR>
20Everyone is permitted to copy and distribute verbatim copies
21of this license document, but changing it is not allowed.</P>
22
23<H2>0. Preamble</H2>
24
25<P>The purpose of this License is to make a manual, textbook, or other
26written document "free" in the sense of freedom: to assure everyone
27the effective freedom to copy and redistribute it, with or without
28modifying it, either commercially or noncommercially. Secondarily,
29this License preserves for the author and publisher a way to get
30credit for their work, while not being considered responsible for
31modifications made by others.</P>
32
33<P>This License is a kind of "copyleft", which means that derivative
34works of the document must themselves be free in the same sense. It
35complements the GNU General Public License, which is a copyleft
36license designed for free software.</P>
37
38<P>We have designed this License in order to use it for manuals for free
39software, because free software needs free documentation: a free
40program should come with manuals providing the same freedoms that the
41software does. But this License is not limited to software manuals;
42it can be used for any textual work, regardless of subject matter or
43whether it is published as a printed book. We recommend this License
44principally for works whose purpose is instruction or reference.</P>
45
46<H2>1. Applicability And Definitions</H2>
47
48<P>This License applies to any manual or other work that contains a
49notice placed by the copyright holder saying it can be distributed
50under the terms of this License. The "Document", below, refers to any
51such manual or work. Any member of the public is a licensee, and is
52addressed as "you".</P>
53
54<P>A "Modified Version" of the Document means any work containing the
55Document or a portion of it, either copied verbatim, or with
56modifications and/or translated into another language.</P>
57
58<P>A "Secondary Section" is a named appendix or a front-matter section of
59the Document that deals exclusively with the relationship of the
60publishers or authors of the Document to the Document's overall subject
61(or to related matters) and contains nothing that could fall directly
62within that overall subject. (For example, if the Document is in part a
63textbook of mathematics, a Secondary Section may not explain any
64mathematics.) The relationship could be a matter of historical
65connection with the subject or with related matters, or of legal,
66commercial, philosophical, ethical or political position regarding
67them.</P>
68
69<P>The "Invariant Sections" are certain Secondary Sections whose titles
70are designated, as being those of Invariant Sections, in the notice
71that says that the Document is released under this License.</P>
72
73<P>The "Cover Texts" are certain short passages of text that are listed,
74as Front-Cover Texts or Back-Cover Texts, in the notice that says that
75the Document is released under this License.</P>
76
77<P>A "Transparent" copy of the Document means a machine-readable copy,
78represented in a format whose specification is available to the
79general public, whose contents can be viewed and edited directly and
80straightforwardly with generic text editors or (for images composed of
81pixels) generic paint programs or (for drawings) some widely available
82drawing editor, and that is suitable for input to text formatters or
83for automatic translation to a variety of formats suitable for input
84to text formatters. A copy made in an otherwise Transparent file
85format whose markup has been designed to thwart or discourage
86subsequent modification by readers is not Transparent. A copy that is
87not "Transparent" is called "Opaque".</P>
88
89<P>Examples of suitable formats for Transparent copies include plain
90ASCII without markup, Texinfo input format, LaTeX input format, SGML
91or XML using a publicly available DTD, and standard-conforming simple
92HTML designed for human modification. Opaque formats include
93PostScript, PDF, proprietary formats that can be read and edited only
94by proprietary word processors, SGML or XML for which the DTD and/or
95processing tools are not generally available, and the
96machine-generated HTML produced by some word processors for output
97purposes only.</P>
98
99<P>The "Title Page" means, for a printed book, the title page itself,
100plus such following pages as are needed to hold, legibly, the material
101this License requires to appear in the title page. For works in
102formats which do not have any title page as such, "Title Page" means
103the text near the most prominent appearance of the work's title,
104preceding the beginning of the body of the text.</P>
105
106<H2>2. Verbatim Copying</H2>
107
108<P>You may copy and distribute the Document in any medium, either
109commercially or noncommercially, provided that this License, the
110copyright notices, and the license notice saying this License applies
111to the Document are reproduced in all copies, and that you add no other
112conditions whatsoever to those of this License. You may not use
113technical measures to obstruct or control the reading or further
114copying of the copies you make or distribute. However, you may accept
115compensation in exchange for copies. If you distribute a large enough
116number of copies you must also follow the conditions in section 3.</P>
117
118<P>You may also lend copies, under the same conditions stated above, and
119you may publicly display copies.</P>
120
121<H2>3. Copying In Quantity</H2>
122
123<P>If you publish printed copies of the Document numbering more than 100,
124and the Document's license notice requires Cover Texts, you must enclose
125the copies in covers that carry, clearly and legibly, all these Cover
126Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
127the back cover. Both covers must also clearly and legibly identify
128you as the publisher of these copies. The front cover must present
129the full title with all words of the title equally prominent and
130visible. You may add other material on the covers in addition.
131Copying with changes limited to the covers, as long as they preserve
132the title of the Document and satisfy these conditions, can be treated
133as verbatim copying in other respects.</P>
134
135<P>If the required texts for either cover are too voluminous to fit
136legibly, you should put the first ones listed (as many as fit
137reasonably) on the actual cover, and continue the rest onto adjacent
138pages.</P>
139
140<P>If you publish or distribute Opaque copies of the Document numbering
141more than 100, you must either include a machine-readable Transparent
142copy along with each Opaque copy, or state in or with each Opaque copy
143a publicly-accessible computer-network location containing a complete
144Transparent copy of the Document, free of added material, which the
145general network-using public has access to download anonymously at no
146charge using public-standard network protocols. If you use the latter
147option, you must take reasonably prudent steps, when you begin
148distribution of Opaque copies in quantity, to ensure that this
149Transparent copy will remain thus accessible at the stated location
150until at least one year after the last time you distribute an Opaque
151copy (directly or through your agents or retailers) of that edition to
152the public.</P>
153
154<P>It is requested, but not required, that you contact the authors of the
155Document well before redistributing any large number of copies, to give
156them a chance to provide you with an updated version of the Document.</P>
157
158<H2>4. Modifications</H2>
159
160<P>You may copy and distribute a Modified Version of the Document under
161the conditions of sections 2 and 3 above, provided that you release
162the Modified Version under precisely this License, with the Modified
163Version filling the role of the Document, thus licensing distribution
164and modification of the Modified Version to whoever possesses a copy
165of it. In addition, you must do these things in the Modified Version:</P>
166
167<OL STYLE="list-style-type: upper-alpha;">
168<LI>Use in the Title Page (and on the covers, if any) a title distinct
169 from that of the Document, and from those of previous versions
170 (which should, if there were any, be listed in the History section
171 of the Document). You may use the same title as a previous
172 version if the original publisher of that version gives
173 permission.</LI>
174
175<LI>List on the Title Page, as authors, one or more persons or
176 entities responsible for authorship of the modifications in the
177 Modified Version, together with at least five of the principal
178 authors of the Document (all of its principal authors, if it has
179 less than five).</LI>
180
181<LI>State on the Title page the name of the publisher of the Modified
182 Version, as the publisher.</LI>
183
184<LI>Preserve all the copyright notices of the Document.</LI>
185
186<LI>Add an appropriate copyright notice for your modifications
187 adjacent to the other copyright notices.</LI>
188
189<LI>Include, immediately after the copyright notices, a license notice
190 giving the public permission to use the Modified Version under the
191 terms of this License, in the form shown in the Addendum
192 below.</LI>
193
194<LI>Preserve in that license notice the full lists of Invariant
195 Sections and required Cover Texts given in the Document's license
196 notice.</LI>
197
198<LI>Include an unaltered copy of this License.</LI>
199
200<LI>Preserve the section entitled "History", and its title, and add to
201 it an item stating at least the title, year, new authors, and
202 publisher of the Modified Version as given on the Title Page. If
203 there is no section entitled "History" in the Document, create one
204 stating the title, year, authors, and publisher of the Document as
205 given on its Title Page, then add an item describing the Modified
206 Version as stated in the previous sentence.</LI>
207
208<LI>Preserve the network location, if any, given in the Document for
209 public access to a Transparent copy of the Document, and likewise
210 the network locations given in the Document for previous versions
211 it was based on. These may be placed in the "History" section.
212 You may omit a network location for a work that was published at
213 least four years before the Document itself, or if the original
214 publisher of the version it refers to gives permission.</LI>
215
216<LI>In any section entitled "Acknowledgements" or "Dedications",
217 preserve the section's title, and preserve in the section all the
218 substance and tone of each of the contributor acknowledgements
219 and/or dedications given therein.</LI>
220
221<LI>Preserve all the Invariant Sections of the Document, unaltered in
222 their text and in their titles. Section numbers or the equivalent
223 are not considered part of the section titles.</LI>
224
225<LI>Delete any section entitled "Endorsements". Such a section may
226 not be included in the Modified Version.</LI>
227
228<LI>Do not retitle any existing section as "Endorsements" or to
229 conflict in title with any Invariant Section.</LI>
230</OL>
231
232<P>If the Modified Version includes new front-matter sections or
233appendices that qualify as Secondary Sections and contain no material
234copied from the Document, you may at your option designate some or all
235of these sections as invariant. To do this, add their titles to the
236list of Invariant Sections in the Modified Version's license notice.
237These titles must be distinct from any other section titles.</P>
238
239<P>You may add a section entitled "Endorsements", provided it contains
240nothing but endorsements of your Modified Version by various
241parties--for example, statements of peer review or that the text has
242been approved by an organization as the authoritative definition of a
243standard.</P>
244
245<P>You may add a passage of up to five words as a Front-Cover Text, and a
246passage of up to 25 words as a Back-Cover Text, to the end of the list
247of Cover Texts in the Modified Version. Only one passage of
248Front-Cover Text and one of Back-Cover Text may be added by (or
249through arrangements made by) any one entity. If the Document already
250includes a cover text for the same cover, previously added by you or
251by arrangement made by the same entity you are acting on behalf of,
252you may not add another; but you may replace the old one, on explicit
253permission from the previous publisher that added the old one.</P>
254
255<P>The author(s) and publisher(s) of the Document do not by this License
256give permission to use their names for publicity for or to assert or
257imply endorsement of any Modified Version.</P>
258
259<H2>5. Combining Documents</H2>
260
261<P>You may combine the Document with other documents released under this
262License, under the terms defined in section 4 above for modified
263versions, provided that you include in the combination all of the
264Invariant Sections of all of the original documents, unmodified, and
265list them all as Invariant Sections of your combined work in its
266license notice.</P>
267
268<P>The combined work need only contain one copy of this License, and
269multiple identical Invariant Sections may be replaced with a single
270copy. If there are multiple Invariant Sections with the same name but
271different contents, make the title of each such section unique by
272adding at the end of it, in parentheses, the name of the original
273author or publisher of that section if known, or else a unique number.
274Make the same adjustment to the section titles in the list of
275Invariant Sections in the license notice of the combined work.</P>
276
277<P>In the combination, you must combine any sections entitled "History"
278in the various original documents, forming one section entitled
279"History"; likewise combine any sections entitled "Acknowledgements",
280and any sections entitled "Dedications". You must delete all sections
281entitled "Endorsements."</P>
282
283<H2>6. Collections Of Documents</H2>
284
285<P>You may make a collection consisting of the Document and other documents
286released under this License, and replace the individual copies of this
287License in the various documents with a single copy that is included in
288the collection, provided that you follow the rules of this License for
289verbatim copying of each of the documents in all other respects.</P>
290
291<P>You may extract a single document from such a collection, and distribute
292it individually under this License, provided you insert a copy of this
293License into the extracted document, and follow this License in all
294other respects regarding verbatim copying of that document.</P>
295
296<H2>7. Aggregation With Independent Works</H2>
297
298<P>A compilation of the Document or its derivatives with other separate
299and independent documents or works, in or on a volume of a storage or
300distribution medium, does not as a whole count as a Modified Version
301of the Document, provided no compilation copyright is claimed for the
302compilation. Such a compilation is called an "aggregate", and this
303License does not apply to the other self-contained works thus compiled
304with the Document, on account of their being thus compiled, if they
305are not themselves derivative works of the Document.</P>
306
307<P>If the Cover Text requirement of section 3 is applicable to these
308copies of the Document, then if the Document is less than one quarter
309of the entire aggregate, the Document's Cover Texts may be placed on
310covers that surround only the Document within the aggregate.
311Otherwise they must appear on covers around the whole aggregate.</P>
312
313<H2>8. Translation</H2>
314
315<P>Translation is considered a kind of modification, so you may
316distribute translations of the Document under the terms of section 4.
317Replacing Invariant Sections with translations requires special
318permission from their copyright holders, but you may include
319translations of some or all Invariant Sections in addition to the
320original versions of these Invariant Sections. You may include a
321translation of this License provided that you also include the
322original English version of this License. In case of a disagreement
323between the translation and the original English version of this
324License, the original English version will prevail.</P>
325
326<H2>9. Termination</H2>
327
328<P>You may not copy, modify, sublicense, or distribute the Document except
329as expressly provided for under this License. Any other attempt to
330copy, modify, sublicense or distribute the Document is void, and will
331automatically terminate your rights under this License. However,
332parties who have received copies, or rights, from you under this
333License will not have their licenses terminated so long as such
334parties remain in full compliance.</P>
335
336<H2>10. Future Revisions Of This License</H2>
337
338<P>The Free Software Foundation may publish new, revised versions
339of the GNU Free Documentation License from time to time. Such new
340versions will be similar in spirit to the present version, but may
341differ in detail to address new problems or concerns. See
342<A HREF="http:///www.gnu.org/copyleft/">http:///www.gnu.org/copyleft/</A>.</P>
343
344<P>Each version of the License is given a distinguishing version number.
345If the Document specifies that a particular numbered version of this
346License "or any later version" applies to it, you have the option of
347following the terms and conditions either of that specified version or
348of any later version that has been published (not as a draft) by the
349Free Software Foundation. If the Document does not specify a version
350number of this License, you may choose any version ever published (not
351as a draft) by the Free Software Foundation.</P>
352 </BODY>
353</HTML>
diff --git a/doc/common/footer.html b/doc/common/footer.html
new file mode 100755
index 0000000..2da58d0
--- a/dev/null
+++ b/doc/common/footer.html
@@ -0,0 +1,14 @@
1</div>
2<div id="bottom-nav">
3<img src="../../common/bottom2.png" align="right" height="59" width="227" alt="KDE Logo">
4</div>
5<div class="bottom">
6This file is part of the documentation for OPIE $projectnumber.
7</div>
8<div class="bottom" style="color:#cccccc">
9Documentation copyright &copy; 1997-2003 the KDE developers. 2003 OPIE developers<br>
10Generated on $datetime by
11<a href="http://www.doxygen.org/index.html">doxygen</a> $doxygenversion written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, &copy;&nbsp;1997-2001
12</div>
13</body>
14</html>
diff --git a/doc/common/gpl-license.html b/doc/common/gpl-license.html
new file mode 100644
index 0000000..ddb5166
--- a/dev/null
+++ b/doc/common/gpl-license.html
@@ -0,0 +1,381 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html40/strict.dtd">
3<HTML LANG="en-US">
4 <HEAD>
5 <TITLE>GNU General Public License</TITLE>
6 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=us-ascii">
7 <META HTTP-EQUIV="Content-Language" CONTENT="en-US">
8 <META NAME="description" CONTENT="GNU general public license (for inclusion in distributions)">
9 <META NAME="keywords" CONTENT="gnu, Gnu, GNU, license, licence, software, free software, software license, software licence, GNU general public license, GNU General Public License">
10 <META NAME="robots" CONTENT="none">
11 <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
12 <LINK REL="stylesheet" HREF="kde-default.css" TYPE="text/css">
13 </HEAD>
14 <BODY CLASS="license">
15<H1>GNU General Public License</H1>
16<P>Version 2, June 1991</P>
17
18<P>Copyright (C) 1989, 1991 Free Software Foundation, Inc.
1959 Temple Place, Suite 330, Boston, MA 02111-1307 USA<BR>
20Everyone is permitted to copy and distribute verbatim copies
21of this license document, but changing it is not allowed.</P>
22
23<H2>Preamble</H2>
24
25<P>The licenses for most software are designed to take away your
26freedom to share and change it. By contrast, the GNU General Public
27License is intended to guarantee your freedom to share and change free
28software--to make sure the software is free for all its users. This
29General Public License applies to most of the Free Software
30Foundation's software and to any other program whose authors commit to
31using it. (Some other Free Software Foundation software is covered by
32the GNU Library General Public License instead.) You can apply it to
33your programs, too.</P>
34
35<P>When we speak of free software, we are referring to freedom, not
36price. Our General Public Licenses are designed to make sure that you
37have the freedom to distribute copies of free software (and charge for
38this service if you wish), that you receive source code or can get it
39if you want it, that you can change the software or use pieces of it
40in new free programs; and that you know you can do these things.</P>
41
42<P>To protect your rights, we need to make restrictions that forbid
43anyone to deny you these rights or to ask you to surrender the rights.
44These restrictions translate to certain responsibilities for you if you
45distribute copies of the software, or if you modify it.</P>
46
47<P>For example, if you distribute copies of such a program, whether
48gratis or for a fee, you must give the recipients all the rights that
49you have. You must make sure that they, too, receive or can get the
50source code. And you must show them these terms so they know their
51rights.</P>
52
53<P>We protect your rights with two steps: (1) copyright the software, and
54(2) offer you this license which gives you legal permission to copy,
55distribute and/or modify the software.</P>
56
57<P>Also, for each author's protection and ours, we want to make certain
58that everyone understands that there is no warranty for this free
59software. If the software is modified by someone else and passed on, we
60want its recipients to know that what they have is not the original, so
61that any problems introduced by others will not reflect on the original
62authors' reputations.</P>
63
64<P>Finally, any free program is threatened constantly by software
65patents. We wish to avoid the danger that redistributors of a free
66program will individually obtain patent licenses, in effect making the
67program proprietary. To prevent this, we have made it clear that any
68patent must be licensed for everyone's free use or not licensed at all.</P>
69
70<P>The precise terms and conditions for copying, distribution and
71modification follow.</P>
72
73<H2><A NAME="show-c">GNU General Public License<BR>
74Terms And Conditions For Copying, Distribution And Modification</A></H2>
75
76<P>0. This License applies to any program or other work which contains
77a notice placed by the copyright holder saying it may be distributed
78under the terms of this General Public License. The "Program", below,
79refers to any such program or work, and a "work based on the Program"
80means either the Program or any derivative work under copyright law:
81that is to say, a work containing the Program or a portion of it,
82either verbatim or with modifications and/or translated into another
83language. (Hereinafter, translation is included without limitation in
84the term "modification".) Each licensee is addressed as "you".</P>
85
86<P>Activities other than copying, distribution and modification are not
87covered by this License; they are outside its scope. The act of
88running the Program is not restricted, and the output from the Program
89is covered only if its contents constitute a work based on the
90Program (independent of having been made by running the Program).
91Whether that is true depends on what the Program does.</P>
92
93<P>1. You may copy and distribute verbatim copies of the Program's
94source code as you receive it, in any medium, provided that you
95conspicuously and appropriately publish on each copy an appropriate
96copyright notice and disclaimer of warranty; keep intact all the
97notices that refer to this License and to the absence of any warranty;
98and give any other recipients of the Program a copy of this License
99along with the Program.</P>
100
101<P>You may charge a fee for the physical act of transferring a copy, and
102you may at your option offer warranty protection in exchange for a fee.</P>
103
104<P>2. You may modify your copy or copies of the Program or any portion
105of it, thus forming a work based on the Program, and copy and
106distribute such modifications or work under the terms of Section 1
107above, provided that you also meet all of these conditions:</P>
108
109<OL STYLE="list-style-type: lower-alpha;">
110<LI>
111<P>You must cause the modified files to carry prominent notices
112stating that you changed the files and the date of any change.</P>
113</LI>
114
115<LI>
116<P>You must cause any work that you distribute or publish, that in
117whole or in part contains or is derived from the Program or any
118part thereof, to be licensed as a whole at no charge to all third
119parties under the terms of this License.</P>
120</LI>
121
122<LI>
123<P>If the modified program normally reads commands interactively
124when run, you must cause it, when started running for such
125interactive use in the most ordinary way, to print or display an
126announcement including an appropriate copyright notice and a
127notice that there is no warranty (or else, saying that you provide
128a warranty) and that users may redistribute the program under
129these conditions, and telling the user how to view a copy of this
130License. (Exception: if the Program itself is interactive but
131does not normally print such an announcement, your work based on
132the Program is not required to print an announcement.)</P>
133</LI>
134</OL>
135
136<P>These requirements apply to the modified work as a whole. If
137identifiable sections of that work are not derived from the Program,
138and can be reasonably considered independent and separate works in
139themselves, then this License, and its terms, do not apply to those
140sections when you distribute them as separate works. But when you
141distribute the same sections as part of a whole which is a work based
142on the Program, the distribution of the whole must be on the terms of
143this License, whose permissions for other licensees extend to the
144entire whole, and thus to each and every part regardless of who wrote it.</P>
145
146<P>Thus, it is not the intent of this section to claim rights or contest
147your rights to work written entirely by you; rather, the intent is to
148exercise the right to control the distribution of derivative or
149collective works based on the Program.</P>
150
151<P>In addition, mere aggregation of another work not based on the Program
152with the Program (or with a work based on the Program) on a volume of
153a storage or distribution medium does not bring the other work under
154the scope of this License.</P>
155
156<P>3. You may copy and distribute the Program (or a work based on it,
157under Section 2) in object code or executable form under the terms of
158Sections 1 and 2 above provided that you also do one of the following:</P>
159
160<OL STYLE="list-style-type: lower-alpha;">
161<LI>
162<P>Accompany it with the complete corresponding machine-readable
163source code, which must be distributed under the terms of Sections
1641 and 2 above on a medium customarily used for software interchange; or,</P>
165</LI>
166
167<LI>
168<P>Accompany it with a written offer, valid for at least three
169years, to give any third party, for a charge no more than your
170cost of physically performing source distribution, a complete
171machine-readable copy of the corresponding source code, to be
172distributed under the terms of Sections 1 and 2 above on a medium
173customarily used for software interchange; or,</P>
174</LI>
175
176<LI>
177<P>Accompany it with the information you received as to the offer
178to distribute corresponding source code. (This alternative is
179allowed only for noncommercial distribution and only if you
180received the program in object code or executable form with such
181an offer, in accord with Subsection b above.)</P>
182</LI>
183</OL>
184
185<P>The source code for a work means the preferred form of the work for
186making modifications to it. For an executable work, complete source
187code means all the source code for all modules it contains, plus any
188associated interface definition files, plus the scripts used to
189control compilation and installation of the executable. However, as a
190special exception, the source code distributed need not include
191anything that is normally distributed (in either source or binary
192form) with the major components (compiler, kernel, and so on) of the
193operating system on which the executable runs, unless that component
194itself accompanies the executable.</P>
195
196<P>If distribution of executable or object code is made by offering
197access to copy from a designated place, then offering equivalent
198access to copy the source code from the same place counts as
199distribution of the source code, even though third parties are not
200compelled to copy the source along with the object code.</P>
201
202<P>4. You may not copy, modify, sublicense, or distribute the Program
203except as expressly provided under this License. Any attempt
204otherwise to copy, modify, sublicense or distribute the Program is
205void, and will automatically terminate your rights under this License.
206However, parties who have received copies, or rights, from you under
207this License will not have their licenses terminated so long as such
208parties remain in full compliance.</P>
209
210<P>5. You are not required to accept this License, since you have not
211signed it. However, nothing else grants you permission to modify or
212distribute the Program or its derivative works. These actions are
213prohibited by law if you do not accept this License. Therefore, by
214modifying or distributing the Program (or any work based on the
215Program), you indicate your acceptance of this License to do so, and
216all its terms and conditions for copying, distributing or modifying
217the Program or works based on it.</P>
218
219<P>6. Each time you redistribute the Program (or any work based on the
220Program), the recipient automatically receives a license from the
221original licensor to copy, distribute or modify the Program subject to
222these terms and conditions. You may not impose any further
223restrictions on the recipients' exercise of the rights granted herein.
224You are not responsible for enforcing compliance by third parties to
225this License.</P>
226
227<P>7. If, as a consequence of a court judgment or allegation of patent
228infringement or for any other reason (not limited to patent issues),
229conditions are imposed on you (whether by court order, agreement or
230otherwise) that contradict the conditions of this License, they do not
231excuse you from the conditions of this License. If you cannot
232distribute so as to satisfy simultaneously your obligations under this
233License and any other pertinent obligations, then as a consequence you
234may not distribute the Program at all. For example, if a patent
235license would not permit royalty-free redistribution of the Program by
236all those who receive copies directly or indirectly through you, then
237the only way you could satisfy both it and this License would be to
238refrain entirely from distribution of the Program.</P>
239
240<P>If any portion of this section is held invalid or unenforceable under
241any particular circumstance, the balance of the section is intended to
242apply and the section as a whole is intended to apply in other
243circumstances.</P>
244
245<P>It is not the purpose of this section to induce you to infringe any
246patents or other property right claims or to contest validity of any
247such claims; this section has the sole purpose of protecting the
248integrity of the free software distribution system, which is
249implemented by public license practices. Many people have made
250generous contributions to the wide range of software distributed
251through that system in reliance on consistent application of that
252system; it is up to the author/donor to decide if he or she is willing
253to distribute software through any other system and a licensee cannot
254impose that choice.</P>
255
256<P>This section is intended to make thoroughly clear what is believed to
257be a consequence of the rest of this License.</P>
258
259<P>8. If the distribution and/or use of the Program is restricted in
260certain countries either by patents or by copyrighted interfaces, the
261original copyright holder who places the Program under this License
262may add an explicit geographical distribution limitation excluding
263those countries, so that distribution is permitted only in or among
264countries not thus excluded. In such case, this License incorporates
265the limitation as if written in the body of this License.</P>
266
267<P>9. The Free Software Foundation may publish revised and/or new versions
268of the General Public License from time to time. Such new versions will
269be similar in spirit to the present version, but may differ in detail to
270address new problems or concerns.</P>
271
272<P>Each version is given a distinguishing version number. If the Program
273specifies a version number of this License which applies to it and "any
274later version", you have the option of following the terms and conditions
275either of that version or of any later version published by the Free
276Software Foundation. If the Program does not specify a version number of
277this License, you may choose any version ever published by the Free Software
278Foundation.</P>
279
280<P>10. If you wish to incorporate parts of the Program into other free
281programs whose distribution conditions are different, write to the author
282to ask for permission. For software which is copyrighted by the Free
283Software Foundation, write to the Free Software Foundation; we sometimes
284make exceptions for this. Our decision will be guided by the two goals
285of preserving the free status of all derivatives of our free software and
286of promoting the sharing and reuse of software generally.</P>
287
288<H2><A NAME="show-w">No Warranty</A></H2>
289
290<P>11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
291FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
292OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
293PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
294OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
295MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
296TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
297PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
298REPAIR OR CORRECTION.</P>
299
300<P>12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
301WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
302REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
303INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
304OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
305TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
306YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
307PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
308POSSIBILITY OF SUCH DAMAGES.</P>
309
310<DIV STYLE="text-align: center;">END OF TERMS AND CONDITIONS</DIV>
311
312<hr>
313
314<h2>How to Apply These Terms to Your New Programs</h2>
315
316<p>If you develop a new program, and you want it to be of the greatest
317possible use to the public, the best way to achieve this is to make it
318free software which everyone can redistribute and change under these
319terms.</p>
320
321
322<p>To do so, attach the following notices to the program. It is
323safest to attach them to the start of each source file to most
324effectively convey the exclusion of warranty; and each file should
325have at least the "copyright" line and a pointer to where the full
326notice is found.</p>
327
328
329<pre> &lt;one line to give the program's name and a brief idea of what it does.&gt;
330 Copyright (C) 19yy &lt;name of author&gt;
331
332 This program is free software; you can redistribute it and/or modify
333 it under the terms of the GNU General Public License as published by
334 the Free Software Foundation; either version 2 of the License, or
335 (at your option) any later version.
336
337 This program is distributed in the hope that it will be useful,
338 but WITHOUT ANY WARRANTY; without even the implied warranty of
339 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
340 GNU General Public License for more details.
341
342 You should have received a copy of the GNU General Public License
343 along with this program; if not, write to the Free Software
344 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</pre>
345
346<p>Also add information on how to contact you by electronic and paper
347mail.</p>
348
349<p>If the program is interactive, make it output a short notice like this
350when it starts in an interactive mode:</p>
351
352<pre> Gnomovision version 69, Copyright (C) 19yy name of author
353 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
354 This is free software, and you are welcome to redistribute it
355 under certain conditions; type `show c' for details.</pre>
356
357<p>The hypothetical commands &quot;show w&quot; and &quot;show c&quot; should show the appropriate
358parts of the General Public License. Of course, the commands you use may
359be called something other than &quot;show w&quot; and &quot;show c&quot;; they could even be
360mouse-clicks or menu items--whatever suits your program.</p>
361
362<p>You should also get your employer (if you work as a programmer) or your
363school, if any, to sign a &quot;copyright disclaimer&quot; for the program, if
364necessary. Here is a sample; alter the names:</p>
365
366<pre> Yoyodyne, Inc., hereby disclaims all copyright interest in the program
367 `Gnomovision' (which makes passes at compilers) written by James Hacker.
368
369 &lt;signature of Ty Coon&gt;, 1 April 1989
370 Ty Coon, President of Vice</pre>
371
372<p>This General Public License does not permit incorporating your program into
373proprietary programs. If your program is a subroutine library, you may
374consider it more useful to permit linking proprietary applications with the
375library. If this is what you want to do, use the GNU Library General
376Public License instead of this License.</p>
377
378
379
380 </BODY>
381</HTML>
diff --git a/doc/common/grad.png b/doc/common/grad.png
new file mode 100644
index 0000000..b0c7f40
--- a/dev/null
+++ b/doc/common/grad.png
Binary files differ
diff --git a/doc/common/header.html b/doc/common/header.html
new file mode 100755
index 0000000..621e0e8
--- a/dev/null
+++ b/doc/common/header.html
@@ -0,0 +1,34 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4 <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
5 <title>$title ($projectname)</title>
6 <link href="../../common/doxygen.css" rel="stylesheet" type="text/css">
7</head>
8<div class="header">
9<table border="0" cellspacing="0" cellpadding="0">
10<tr>
11<td rowspan="2" width="92">
12<a href="../../index.html" title="The API documentation main page"><img src="../../common/docheadergears.png" style="border:0px;" alt=""></a>
13</td>
14<td width="95%">
15<h1>$projectname API Documentation</h1>
16</td>
17</tr>
18<tr>
19<td valign="bottom">
20<table class="links" border=0 cellspacing=0>
21<tr>
22<td><a href="index.html">Overview</a></td>
23<td><a href="hierarchy.html" title="Inheritance list, sorted roughly alphabetically">Class&nbsp;Hierarchy</a></td>
24<td><a href="classes.html" title="Alphabetical list of classes">Classes</a></td>
25<td><a href="annotated.html" title="Classes, structs, unions and interfaces with brief descriptions">Classes&nbsp;(annotated)</a></td>
26<td><a href="functions.html" title="Documented class members with links to the classes they belong to">Members</a></td>
27<!-- td><a href="namespaces.html" title="All documented namespaces with brief descriptions">Namespaces</a></td-->
28<td><a href="files.html" title="A list of all documented files with brief descriptions">Source&nbsp;Files</a></td>
29</tr>
30</table>
31</td></tr></table>
32</div>
33<div id="hgrad"></div>
34<div class="text">
diff --git a/doc/common/headerbg.png b/doc/common/headerbg.png
new file mode 100644
index 0000000..cb7481f
--- a/dev/null
+++ b/doc/common/headerbg.png
Binary files differ
diff --git a/doc/common/kde-common.css b/doc/common/kde-common.css
new file mode 100644
index 0000000..dcd35ef
--- a/dev/null
+++ b/doc/common/kde-common.css
@@ -0,0 +1,32 @@
1/*
2 KDE-wide persistent CSS for HTML documentation (all media types).
3 Copyright (C) 2000 Frederik Fouvry
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
19 Send comments, suggestions, etc. to Frederik Fouvry
20 <fouvry@sfs.nphil.uni-tuebingen.de>.
21*/
22
23/*
24 Important note: these setting cannot be overridden, except by switching
25 off style sheets alltogether.
26
27 Any updates should be validated, e.g. http://jigsaw.w3.org/css-validator/
28
29 Check out http://www.richinstyle.com/ where many of the declarations and
30 setup in the KDE CSS are obtained from. In fact, do not change
31 anything without checking on those pages whether it is wise to do so.
32*/
diff --git a/doc/common/kde-default.css b/doc/common/kde-default.css
new file mode 100644
index 0000000..918840c
--- a/dev/null
+++ b/doc/common/kde-default.css
@@ -0,0 +1,228 @@
1/*
2 KDE-wide default CSS for HTML documentation (all media types).
3 Copyright (C) 2000 Frederik Fouvry
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
19 Send comments, suggestions, etc. to Frederik Fouvry
20 <fouvry@sfs.nphil.uni-tuebingen.de>. */
21
22/*
23 Important note: these setting may be overridden by localised CSS. Do not
24 add here any localisation-sensitive style declarations.
25
26 Any updates should be validated, e.g. http://jigsaw.w3.org/css-validator/ */
27
28/* Note: "should be inherit" means that in a proper browser inherit should work.
29 Somehow Netscape manages to interpret "inherit" as bright green.
30 Yuck. */
31
32body {
33background-color: white;
34font-family: sans-serif;
35padding: 0;
36margin: 0;
37}
38
39.sect1, .chapter {
40padding: 2em;
41}
42
43.chapter .sect1 {
44padding: 0em;
45}
46
47/* Links in Navigation */
48
49.navLeft a:link, .navCenter :link, .navRight :link, .header a:link, .header a:visited, .bottom-nav a:link, .bottom-nav a:visited {
50color: white;
51background-color: #3E91EB;
52font-weight: bold;
53}
54
55
56/* Nice link colors for the main text
57 Setting text-decoration seems to fix a nasty redraw problem in KHC */
58
59:link { color: rgb(170,0,0);
60 background-color: white; /* should be inherit */ }
61:visited { color: rgb(170,0,85);
62 background-color: white; /* should be inherit */ }
63:active { color: rgb(170,0,0);
64 background-color: white; /* should be inherit */ }
65
66.navLeft {
67text-align: left;
68font-weight: bold;
69padding-left: 0.5em;
70background-color: #3E91EB;
71}
72
73.navRight {
74text-align: right;
75font-weight: bold;
76padding-right: 0.5em;
77}
78
79.navCenter {
80text-align: center;
81font-weight: bold;
82padding-left: 0.5em;
83padding-right: 0.5em;
84background-color: transparent;
85}
86
87.header {
88font-size: small;
89line-height: 1em;
90padding-left: 1em;
91vertical-align: middle;
92background-color: #3E91EB;
93color: white;
94margin: 0;
95padding: 0;
96border-top: 1px solid white;
97border-bottom: 1px solid #206dcd;
98height: 1.7em;
99}
100
101.bottom-nav {
102font-size: small;
103line-height: 1em;
104padding-left: 1em;
105vertical-align: middle;
106background-color: #3E91EB;
107color: white;
108margin: 0;
109padding: 0;
110border-top: 1px solid white;
111padding-top: 10px;
112border-bottom: 1px solid #206dcd;
113height: 1.7em;
114}
115
116#logo {
117background: url('help:/common/kde_logo_bg.png') transparent repeat;
118}
119
120
121/* A little bit of padding makes the tables for keybindings etc much easier to read */
122
123TABLE { padding: 5px; }
124DT { margin-top: 1em; }
125DIV.toc DT { margin-top: 0px; }
126DIV.SCREENSHOT { margin-bottom: 1em;
127 margin-top: 1em; }
128DIV.INFORMALEXAMPLE { border-style: dotted;
129 padding: 10px; }
130
131/* But no padding for navigation elements */
132
133.toplogo, .navbackground, { padding: 0px; }
134
135TABLE.programlisting
136TABLE.screen { border-style: none;
137 background-color: rgb(224,224,224);
138 table-layout: auto; /* 100%? */
139 color: rgb(0,0,0); /* should be inherit */
140 }
141
142/* Same as previous block, but more general (previous is HTML only)
143 Not all browsers understand this yet.
144TABLE[class~=programlisting]
145TABLE[class~=screen] { border-style: none;
146 background-color: rgb(224,224,224);
147 table-layout: auto;
148 color: inherit;
149 }
150*/
151
152P { text-align: justify; }
153
154/* More specific settings */
155
156/* Temporary patch: browsers break on bad HTML */
157/* P, H1, H2, H3, H4, H5, TD, TH { font-family: Helvetica, Arial, sans-serif;
158 } */
159
160P, H1, H2, H3, H4, H5, TD, TH { font-family: sans-serif;
161 }
162
163/* Visual cues for GUI elements etc in the text */
164
165.guimenu, .guimenuitem, .guisubmenu { background-color: rgb(240,240,240);
166 color: rgb(0,0,0); /* should be inherit */
167 }
168
169.guilabel, .interface, .guibutton { background-color: rgb(240,240,240);
170 color: rgb(0,0,0); /* should be inherit */
171 }
172
173.shortcut { background-color: rgb(240,240,240);
174 color: rgb(0,0,0); /* should be inherit */
175 }
176
177.shortcut .keycap { background-color: rgb(240,240,240);
178 color: rgb(0,0,0); /* should be inherit */
179 }
180
181.question { font-weight: bolder; }
182
183.accel { background-color: rgb(240,240,240);
184 color: rgb(0,0,0);
185 text-decoration: underline;
186 }
187
188.option, .command { background-color: rgb(255,255,255);
189 color: rgb(0,96,160);
190 font-weight: bold;
191 }
192
193h1, h2, h3, h4, h5, h6 { color: rgb(82,80,82);
194 }
195.arg, .parameter, .replaceable{ background-color: rgb(255,255,255);
196 color: rgb(0,128,64);
197 font-style: italic;
198 }
199
200DIV.mediaobject { /* float: right; */
201 /* might make it much nicer. although someone has to
202 understand the rules ;-) You also don't want it to be
203 surrounded by text it doesn't refer to ... But that
204 may be among others a question of writing style. */
205 text-align: center; /* a bit of a hack: it should
206 position _images_ */
207 }
208
209.caption { margin: 0em 2em 3em 2em; }
210
211.inlinemediaobject { vertical-align: baseline;
212 padding-right: 1em;
213 padding-left: 1em; }
214
215/* An idea that could be nice: a search engine looking for specific
216classes could display them in some conspicuous colour. All that is
217needed is an on the fly generated style element/style sheet. */
218
219/* Only used in the hand-made HTML license texts */
220BODY.license { background-color: rgb(255,255,255);
221 text-align: justify;
222 color: rgb(0,0,0);
223 }
224PRE.license { background-color: rgb(255,255,255);
225 font-family: monospace;
226 color: rgb(0,0,0);
227 }
228
diff --git a/doc/common/kde-web.css b/doc/common/kde-web.css
new file mode 100644
index 0000000..c143105
--- a/dev/null
+++ b/doc/common/kde-web.css
@@ -0,0 +1,178 @@
1/*
2 KDE-wide default CSS for HTML documentation (all media types).
3 Copyright (C) 2000 Frederik Fouvry
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
19 Send comments, suggestions, etc. to Frederik Fouvry
20 <fouvry@sfs.nphil.uni-tuebingen.de>. */
21
22/*
23 Important note: these setting may be overridden by localised CSS. Do not
24 add here any localisation-sensitive style declarations.
25
26 Any updates should be validated, e.g. http://jigsaw.w3.org/css-validator/ */
27
28/* Note: "should be inherit" means that in a proper browser inherit should work.
29 Somehow Netscape manages to interpret "inherit" as bright green.
30 Yuck. */
31
32/* Make the main contents of the page not slide up under the top banner */
33
34/* #body_text { position: relative;
35 top: 100px; } */
36
37/* This is a horrible awful hack.. to once again fix the sliding
38navigation problem. */
39
40body { background-color: white;
41 width: 596px;
42 color: black;
43 align: center;}
44
45/* Nice link colors for the main text, and bottom navigation */
46
47:link { color: rgb(170,0,0);
48 background-color: white; /* should be inherit */ }
49:visited { color: rgb(170,0,85);
50 background-color: white; /* should be inherit */ }
51:active { color: rgb(170,0,0);
52 background-color: white; /* should be inherit */ }
53
54/* Link colors for the top navigation */
55
56.left :link, .center :link, .right :link { color: rgb(255,255,255);
57 background-color: rgb(82,80,82); }
58
59.left :visited, .center :visited, .right :visited { color: rgb(186,182,186);
60 background-color: rgb(82,80,82); }
61
62/* Giving this a background color breaks things, and it's not necessary for
63 either navigation or orientation.. so transparent */
64
65.center {color: rgb(255,255,255);
66 background-color: transparent; }
67
68
69:active {color: rgb(186,182,186);
70 background-color: transparent; }
71
72/* A little bit of padding makes the tables for keybindings etc much easier to read */
73
74TABLE { padding: 5px; }
75DT { margin-top: 1em; }
76DIV.SCREENSHOT { margin-bottom: 1em;
77 margin-top: 1em; }
78DIV.INFORMALEXAMPLE { border-style: dotted;
79 padding: 10px; }
80
81/* But no padding for navigation elements */
82
83.shadow, .headline, .bulb, .end { padding: 0px; }
84
85TABLE.programlisting
86TABLE.screen { border-style: none;
87 background-color: rgb(224,224,224);
88 table-layout: auto; /* 100%? */
89 color: rgb(0,0,0); /* should be inherit */
90 }
91
92/* Same as previous block, but more general (previous is HTML only)
93 Not all browsers understand this yet.
94TABLE[class~=programlisting]
95TABLE[class~=screen] { border-style: none;
96 background-color: rgb(224,224,224);
97 table-layout: auto;
98 color: inherit;
99 }
100*/
101
102P { text-align: justify; }
103
104/* More specific settings */
105
106DIV.navbar P { text-align: right; }
107
108/* Temporary patch: browsers break on bad HTML */
109/* P, H1, H2, H3, H4, H5, TD, TH { font-family: Helvetica, Arial, sans-serif;
110 } */
111
112P, H1, H2, H3, H4, H5, TD, TH { font-family: sans-serif;
113 }
114
115
116
117/* Visual cues for GUI elements etc in the text */
118
119.guimenu, .guimenuitem, .guisubmenu { background-color: rgb(240,240,240);
120 color: rgb(0,0,0); /* should be inherit */
121 }
122
123.guilabel, .interface, .guibutton { background-color: rgb(240,240,240);
124 color: rgb(0,0,0); /* should be inherit */
125 }
126
127.shortcut { background-color: rgb(240,240,240);
128 color: rgb(0,0,0); /* should be inherit */
129 }
130
131.shortcut .keycap { background-color: rgb(240,240,240);
132 color: rgb(0,0,0); /* should be inherit */
133 }
134
135.question { font-weight: bolder; }
136
137.accel { background-color: rgb(240,240,240);
138 color: rgb(0,0,0);
139 text-decoration: underline;
140 }
141
142.option, .command { background-color: rgb(255,255,255);
143 color: rgb(0,96,160);
144 font-weight: bold;
145 }
146
147h1, h2, h3, h4, h5, h6 { color: rgb(82,80,82);
148 }
149.arg, .parameter, .replaceable{ background-color: rgb(255,255,255);
150 color: rgb(0,128,64);
151 font-style: italic;
152 }
153
154DIV.mediaobject { /* float: right; */
155 /* might make it much nicer. although someone has to
156 understand the rules ;-) You also don't want it to be
157 surrounded by text it doesn't refer to ... But that
158 may be among others a question of writing style. */
159 text-align: center; /* a bit of a hack: it should
160 position _images_ */
161 }
162
163/* An idea that could be nice: a search engine looking for specific
164classes could display them in some conspicuous colour. All that is
165needed is an on the fly generated style element/style sheet. */
166
167/* Only used in the hand-made HTML license texts */
168BODY.license { background-color: rgb(255,255,255);
169 text-align: justify;
170 color: rgb(0,0,0);
171 }
172PRE.license { background-color: rgb(255,255,255);
173 font-family: monospace;
174 color: rgb(0,0,0);
175 }
176
177.topbanner { background-repeat: no-repeat;
178 } \ No newline at end of file
diff --git a/doc/common/kde_logo.png b/doc/common/kde_logo.png
new file mode 100644
index 0000000..dfa20b4
--- a/dev/null
+++ b/doc/common/kde_logo.png
Binary files differ
diff --git a/doc/common/kde_logo_bg.png b/doc/common/kde_logo_bg.png
new file mode 100644
index 0000000..6b2bb2f
--- a/dev/null
+++ b/doc/common/kde_logo_bg.png
Binary files differ
diff --git a/doc/common/kmenu.png b/doc/common/kmenu.png
new file mode 100755
index 0000000..a680d44
--- a/dev/null
+++ b/doc/common/kmenu.png
Binary files differ
diff --git a/doc/common/lgpl-license.html b/doc/common/lgpl-license.html
new file mode 100644
index 0000000..a3fba31
--- a/dev/null
+++ b/doc/common/lgpl-license.html
@@ -0,0 +1,502 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html40/strict.dtd">
3<HTML LANG="en-US">
4 <HEAD>
5 <TITLE>GNU Lesser General Public License</TITLE>
6 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=us-ascii">
7 <META HTTP-EQUIV="Content-Language" CONTENT="en-US">
8 <META NAME="description" CONTENT="GNU lesser general public license (for inclusion in library distributions)">
9 <META NAME="keywords" CONTENT="gnu, Gnu, GNU, license, licence, software, free software, software license, software licence, GNU general public license, GNU General Public License, library licence, library license, software library, software libraries, GNU lesser general public license, GNU Lesser General Public License">
10 <META NAME="robots" CONTENT="none">
11 <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
12 <LINK REL="stylesheet" HREF="kde-default.css" TYPE="text/css">
13 </HEAD>
14 <BODY CLASS="license">
15<H1>GNU LESSER GENERAL PUBLIC LICENSE</H1>
16<P>Version 2.1, February 1999</P>
17
18<P>Copyright (C) 1991, 1999 Free Software Foundation, Inc.
1959 Temple Place, Suite 330, Boston, MA 02111-1307 USA<BR>
20Everyone is permitted to copy and distribute verbatim copies
21of this license document, but changing it is not allowed.</P>
22
23<P>[This is the first released version of the Lesser GPL. It also counts
24as the successor of the GNU Library Public License, version 2, hence
25the version number 2.1.]</P>
26
27<H2>Preamble</H2>
28
29<P>The licenses for most software are designed to take away your
30freedom to share and change it. By contrast, the GNU General Public
31Licenses are intended to guarantee your freedom to share and change
32free software--to make sure the software is free for all its users.</P>
33
34<P>This license, the Lesser General Public License, applies to some
35specially designated software packages--typically libraries--of the
36Free Software Foundation and other authors who decide to use it. You
37can use it too, but we suggest you first think carefully about whether
38this license or the ordinary General Public License is the better
39strategy to use in any particular case, based on the explanations below.</P>
40
41<P>When we speak of free software, we are referring to freedom of use,
42not price. Our General Public Licenses are designed to make sure that
43you have the freedom to distribute copies of free software (and charge
44for this service if you wish); that you receive source code or can get
45it if you want it; that you can change the software and use pieces of
46it in new free programs; and that you are informed that you can do
47these things.</P>
48
49<P>To protect your rights, we need to make restrictions that forbid
50distributors to deny you these rights or to ask you to surrender these
51rights. These restrictions translate to certain responsibilities for
52you if you distribute copies of the library or if you modify it.</P>
53
54<P>For example, if you distribute copies of the library, whether gratis
55or for a fee, you must give the recipients all the rights that we gave
56you. You must make sure that they, too, receive or can get the source
57code. If you link other code with the library, you must provide
58complete object files to the recipients, so that they can relink them
59with the library after making changes to the library and recompiling
60it. And you must show them these terms so they know their rights.</P>
61
62<P>We protect your rights with a two-step method: (1) we copyright the
63library, and (2) we offer you this license, which gives you legal
64permission to copy, distribute and/or modify the library.</P>
65
66<P>To protect each distributor, we want to make it very clear that
67there is no warranty for the free library. Also, if the library is
68modified by someone else and passed on, the recipients should know
69that what they have is not the original version, so that the original
70author's reputation will not be affected by problems that might be
71introduced by others.</P>
72
73<P>Finally, software patents pose a constant threat to the existence of
74any free program. We wish to make sure that a company cannot
75effectively restrict the users of a free program by obtaining a
76restrictive license from a patent holder. Therefore, we insist that
77any patent license obtained for a version of the library must be
78consistent with the full freedom of use specified in this license.</P>
79
80<P>Most GNU software, including some libraries, is covered by the
81ordinary GNU General Public License. This license, the GNU Lesser
82General Public License, applies to certain designated libraries, and
83is quite different from the ordinary General Public License. We use
84this license for certain libraries in order to permit linking those
85libraries into non-free programs.</P>
86
87<P>When a program is linked with a library, whether statically or using
88a shared library, the combination of the two is legally speaking a
89combined work, a derivative of the original library. The ordinary
90General Public License therefore permits such linking only if the
91entire combination fits its criteria of freedom. The Lesser General
92Public License permits more lax criteria for linking other code with
93the library.</P>
94
95<P>We call this license the "Lesser" General Public License because it
96does Less to protect the user's freedom than the ordinary General
97Public License. It also provides other free software developers Less
98of an advantage over competing non-free programs. These disadvantages
99are the reason we use the ordinary General Public License for many
100libraries. However, the Lesser license provides advantages in certain
101special circumstances.</P>
102
103<P>For example, on rare occasions, there may be a special need to
104encourage the widest possible use of a certain library, so that it becomes
105a de-facto standard. To achieve this, non-free programs must be
106allowed to use the library. A more frequent case is that a free
107library does the same job as widely used non-free libraries. In this
108case, there is little to gain by limiting the free library to free
109software only, so we use the Lesser General Public License.</P>
110
111<P>In other cases, permission to use a particular library in non-free
112programs enables a greater number of people to use a large body of
113free software. For example, permission to use the GNU C Library in
114non-free programs enables many more people to use the whole GNU
115operating system, as well as its variant, the GNU/Linux operating
116system.</P>
117
118<P>Although the Lesser General Public License is Less protective of the
119users' freedom, it does ensure that the user of a program that is
120linked with the Library has the freedom and the wherewithal to run
121that program using a modified version of the Library.</P>
122
123<P>The precise terms and conditions for copying, distribution and
124modification follow. Pay close attention to the difference between a
125"work based on the library" and a "work that uses the library". The
126former contains code derived from the library, whereas the latter must
127be combined with the library in order to run.</P>
128
129<H2>GNU Lesser General Public License<BR>
130Terms And Conditions For Copying, Distribution And Modification</H2>
131
132<P>0. This License Agreement applies to any software library or other
133program which contains a notice placed by the copyright holder or
134other authorized party saying it may be distributed under the terms of
135this Lesser General Public License (also called "this License").
136Each licensee is addressed as "you".</P>
137
138<P>A "library" means a collection of software functions and/or data
139prepared so as to be conveniently linked with application programs
140(which use some of those functions and data) to form executables.</P>
141
142<P>The "Library", below, refers to any such software library or work
143which has been distributed under these terms. A "work based on the
144Library" means either the Library or any derivative work under
145copyright law: that is to say, a work containing the Library or a
146portion of it, either verbatim or with modifications and/or translated
147straightforwardly into another language. (Hereinafter, translation is
148included without limitation in the term "modification".)</P>
149
150<P>"Source code" for a work means the preferred form of the work for
151making modifications to it. For a library, complete source code means
152all the source code for all modules it contains, plus any associated
153interface definition files, plus the scripts used to control compilation
154and installation of the library.</P>
155
156<P>Activities other than copying, distribution and modification are not
157covered by this License; they are outside its scope. The act of
158running a program using the Library is not restricted, and output from
159such a program is covered only if its contents constitute a work based
160on the Library (independent of the use of the Library in a tool for
161writing it). Whether that is true depends on what the Library does
162and what the program that uses the Library does.</P>
163
164<P>1. You may copy and distribute verbatim copies of the Library's
165complete source code as you receive it, in any medium, provided that
166you conspicuously and appropriately publish on each copy an
167appropriate copyright notice and disclaimer of warranty; keep intact
168all the notices that refer to this License and to the absence of any
169warranty; and distribute a copy of this License along with the
170Library.</P>
171
172<P>You may charge a fee for the physical act of transferring a copy,
173and you may at your option offer warranty protection in exchange for a
174fee.</P>
175
176<P>2. You may modify your copy or copies of the Library or any portion
177of it, thus forming a work based on the Library, and copy and
178distribute such modifications or work under the terms of Section 1
179above, provided that you also meet all of these conditions:</P>
180
181<OL STYLE="list-style-type: lower-alpha;">
182<LI>
183<P>The modified work must itself be a software library.</P>
184</LI>
185
186<LI>
187<P>You must cause the files modified to carry prominent notices
188stating that you changed the files and the date of any change.</P>
189</LI>
190
191<LI>
192<P>You must cause the whole of the work to be licensed at no
193charge to all third parties under the terms of this License.</P>
194</LI>
195
196<LI>
197<P>If a facility in the modified Library refers to a function or a
198table of data to be supplied by an application program that uses
199the facility, other than as an argument passed when the facility
200is invoked, then you must make a good faith effort to ensure that,
201in the event an application does not supply such function or
202table, the facility still operates, and performs whatever part of
203its purpose remains meaningful.</P>
204
205<P>(For example, a function in a library to compute square roots has
206a purpose that is entirely well-defined independent of the
207application. Therefore, Subsection 2d requires that any
208application-supplied function or table used by this function must
209be optional: if the application does not supply it, the square
210root function must still compute square roots.)</P>
211</LI>
212</OL>
213
214<P>These requirements apply to the modified work as a whole. If
215identifiable sections of that work are not derived from the Library,
216and can be reasonably considered independent and separate works in
217themselves, then this License, and its terms, do not apply to those
218sections when you distribute them as separate works. But when you
219distribute the same sections as part of a whole which is a work based
220on the Library, the distribution of the whole must be on the terms of
221this License, whose permissions for other licensees extend to the
222entire whole, and thus to each and every part regardless of who wrote
223it.</P>
224
225<P>Thus, it is not the intent of this section to claim rights or contest
226your rights to work written entirely by you; rather, the intent is to
227exercise the right to control the distribution of derivative or
228collective works based on the Library.</P>
229
230<P>In addition, mere aggregation of another work not based on the Library
231with the Library (or with a work based on the Library) on a volume of
232a storage or distribution medium does not bring the other work under
233the scope of this License.</P>
234
235<P>3. You may opt to apply the terms of the ordinary GNU General Public
236License instead of this License to a given copy of the Library. To do
237this, you must alter all the notices that refer to this License, so
238that they refer to the ordinary GNU General Public License, version 2,
239instead of to this License. (If a newer version than version 2 of the
240ordinary GNU General Public License has appeared, then you can specify
241that version instead if you wish.) Do not make any other change in
242these notices.</P>
243
244<P>Once this change is made in a given copy, it is irreversible for
245that copy, so the ordinary GNU General Public License applies to all
246subsequent copies and derivative works made from that copy.</P>
247
248<P>This option is useful when you wish to copy part of the code of
249the Library into a program that is not a library.</P>
250
251<P>4. You may copy and distribute the Library (or a portion or
252derivative of it, under Section 2) in object code or executable form
253under the terms of Sections 1 and 2 above provided that you accompany
254it with the complete corresponding machine-readable source code, which
255must be distributed under the terms of Sections 1 and 2 above on a
256medium customarily used for software interchange.</P>
257
258<P>If distribution of object code is made by offering access to copy
259from a designated place, then offering equivalent access to copy the
260source code from the same place satisfies the requirement to
261distribute the source code, even though third parties are not
262compelled to copy the source along with the object code.</P>
263
264<P>5. A program that contains no derivative of any portion of the
265Library, but is designed to work with the Library by being compiled or
266linked with it, is called a "work that uses the Library". Such a
267work, in isolation, is not a derivative work of the Library, and
268therefore falls outside the scope of this License.</P>
269
270<P>However, linking a "work that uses the Library" with the Library
271creates an executable that is a derivative of the Library (because it
272contains portions of the Library), rather than a "work that uses the
273library". The executable is therefore covered by this License.
274Section 6 states terms for distribution of such executables.</P>
275
276<P>When a "work that uses the Library" uses material from a header file
277that is part of the Library, the object code for the work may be a
278derivative work of the Library even though the source code is not.
279Whether this is true is especially significant if the work can be
280linked without the Library, or if the work is itself a library. The
281threshold for this to be true is not precisely defined by law.</P>
282
283<P>If such an object file uses only numerical parameters, data
284structure layouts and accessors, and small macros and small inline
285functions (ten lines or less in length), then the use of the object
286file is unrestricted, regardless of whether it is legally a derivative
287work. (Executables containing this object code plus portions of the
288Library will still fall under Section 6.)</P>
289
290<P>Otherwise, if the work is a derivative of the Library, you may
291distribute the object code for the work under the terms of Section 6.
292Any executables containing that work also fall under Section 6,
293whether or not they are linked directly with the Library itself.</P>
294
295<P>6. As an exception to the Sections above, you may also combine or
296link a "work that uses the Library" with the Library to produce a
297work containing portions of the Library, and distribute that work
298under terms of your choice, provided that the terms permit
299modification of the work for the customer's own use and reverse
300engineering for debugging such modifications.</P>
301
302<P>You must give prominent notice with each copy of the work that the
303Library is used in it and that the Library and its use are covered by
304this License. You must supply a copy of this License. If the work
305during execution displays copyright notices, you must include the
306copyright notice for the Library among them, as well as a reference
307directing the user to the copy of this License. Also, you must do one
308of these things:</P>
309
310<OL STYLE="list-style-type: lower-alpha;">
311<LI>
312<P>Accompany the work with the complete corresponding
313machine-readable source code for the Library including whatever
314changes were used in the work (which must be distributed under
315Sections 1 and 2 above); and, if the work is an executable linked
316with the Library, with the complete machine-readable "work that
317uses the Library", as object code and/or source code, so that the
318user can modify the Library and then relink to produce a modified
319executable containing the modified Library. (It is understood
320that the user who changes the contents of definitions files in the
321Library will not necessarily be able to recompile the application
322to use the modified definitions.)</P>
323</LI>
324
325<LI>
326<P>Use a suitable shared library mechanism for linking with the
327Library. A suitable mechanism is one that (1) uses at run time a
328copy of the library already present on the user's computer system,
329rather than copying library functions into the executable, and (2)
330will operate properly with a modified version of the library, if
331the user installs one, as long as the modified version is
332interface-compatible with the version that the work was made with.</P>
333</LI>
334
335<LI>
336<P>Accompany the work with a written offer, valid for at
337least three years, to give the same user the materials
338specified in Subsection 6a, above, for a charge no more
339than the cost of performing this distribution.</P>
340</LI>
341
342<LI>
343<P>If distribution of the work is made by offering access to copy
344from a designated place, offer equivalent access to copy the above
345specified materials from the same place.</P>
346</LI>
347
348<LI>
349<P>Verify that the user has already received a copy of these
350materials or that you have already sent this user a copy.</P>
351</LI>
352</OL>
353
354<P>For an executable, the required form of the "work that uses the
355Library" must include any data and utility programs needed for
356reproducing the executable from it. However, as a special exception,
357the materials to be distributed need not include anything that is
358normally distributed (in either source or binary form) with the major
359components (compiler, kernel, and so on) of the operating system on
360which the executable runs, unless that component itself accompanies
361the executable.</P>
362
363<P>It may happen that this requirement contradicts the license
364restrictions of other proprietary libraries that do not normally
365accompany the operating system. Such a contradiction means you cannot
366use both them and the Library together in an executable that you
367distribute.</P>
368
369<P>7. You may place library facilities that are a work based on the
370Library side-by-side in a single library together with other library
371facilities not covered by this License, and distribute such a combined
372library, provided that the separate distribution of the work based on
373the Library and of the other library facilities is otherwise
374permitted, and provided that you do these two things:</P>
375
376<OL STYLE="list-style-type: lower-alpha;">
377<LI>
378<P>Accompany the combined library with a copy of the same work
379based on the Library, uncombined with any other library
380facilities. This must be distributed under the terms of the
381Sections above.</P>
382</LI>
383
384<LI>
385<P>Give prominent notice with the combined library of the fact
386that part of it is a work based on the Library, and explaining
387where to find the accompanying uncombined form of the same work.</P>
388</LI>
389</OL>
390
391<P>8. You may not copy, modify, sublicense, link with, or distribute
392the Library except as expressly provided under this License. Any
393attempt otherwise to copy, modify, sublicense, link with, or
394distribute the Library is void, and will automatically terminate your
395rights under this License. However, parties who have received copies,
396or rights, from you under this License will not have their licenses
397terminated so long as such parties remain in full compliance.</P>
398
399<P>9. You are not required to accept this License, since you have not
400signed it. However, nothing else grants you permission to modify or
401distribute the Library or its derivative works. These actions are
402prohibited by law if you do not accept this License. Therefore, by
403modifying or distributing the Library (or any work based on the
404Library), you indicate your acceptance of this License to do so, and
405all its terms and conditions for copying, distributing or modifying
406the Library or works based on it.</P>
407
408<P>10. Each time you redistribute the Library (or any work based on the
409Library), the recipient automatically receives a license from the
410original licensor to copy, distribute, link with or modify the Library
411subject to these terms and conditions. You may not impose any further
412restrictions on the recipients' exercise of the rights granted herein.
413You are not responsible for enforcing compliance by third parties with
414this License.</P>
415
416<P>11. If, as a consequence of a court judgment or allegation of patent
417infringement or for any other reason (not limited to patent issues),
418conditions are imposed on you (whether by court order, agreement or
419otherwise) that contradict the conditions of this License, they do not
420excuse you from the conditions of this License. If you cannot
421distribute so as to satisfy simultaneously your obligations under this
422License and any other pertinent obligations, then as a consequence you
423may not distribute the Library at all. For example, if a patent
424license would not permit royalty-free redistribution of the Library by
425all those who receive copies directly or indirectly through you, then
426the only way you could satisfy both it and this License would be to
427refrain entirely from distribution of the Library.</P>
428
429<P>If any portion of this section is held invalid or unenforceable under any
430particular circumstance, the balance of the section is intended to apply,
431and the section as a whole is intended to apply in other circumstances.</P>
432
433<P>It is not the purpose of this section to induce you to infringe any
434patents or other property right claims or to contest validity of any
435such claims; this section has the sole purpose of protecting the
436integrity of the free software distribution system which is
437implemented by public license practices. Many people have made
438generous contributions to the wide range of software distributed
439through that system in reliance on consistent application of that
440system; it is up to the author/donor to decide if he or she is willing
441to distribute software through any other system and a licensee cannot
442impose that choice.</P>
443
444<P>This section is intended to make thoroughly clear what is believed to
445be a consequence of the rest of this License.</P>
446
447<P>12. If the distribution and/or use of the Library is restricted in
448certain countries either by patents or by copyrighted interfaces, the
449original copyright holder who places the Library under this License may add
450an explicit geographical distribution limitation excluding those countries,
451so that distribution is permitted only in or among countries not thus
452excluded. In such case, this License incorporates the limitation as if
453written in the body of this License.</P>
454
455<P>13. The Free Software Foundation may publish revised and/or new
456versions of the Lesser General Public License from time to time.
457Such new versions will be similar in spirit to the present version,
458but may differ in detail to address new problems or concerns.</P>
459
460<P>Each version is given a distinguishing version number. If the Library
461specifies a version number of this License which applies to it and
462"any later version", you have the option of following the terms and
463conditions either of that version or of any later version published by
464the Free Software Foundation. If the Library does not specify a
465license version number, you may choose any version ever published by
466the Free Software Foundation.</P>
467
468<P>14. If you wish to incorporate parts of the Library into other free
469programs whose distribution conditions are incompatible with these,
470write to the author to ask for permission. For software which is
471copyrighted by the Free Software Foundation, write to the Free
472Software Foundation; we sometimes make exceptions for this. Our
473decision will be guided by the two goals of preserving the free status
474of all derivatives of our free software and of promoting the sharing
475and reuse of software generally.</P>
476
477<H2>No Warranty</H2>
478
479<P>15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
480WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
481EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
482OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
483KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
484IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
485PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
486LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
487THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</P>
488
489<P>16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
490WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
491AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
492FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
493CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
494LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
495RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
496FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
497SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
498DAMAGES.</P>
499
500<DIV STYLE="text-align: center;">END OF TERMS AND CONDITIONS</DIV>
501 </BODY>
502</HTML>
diff --git a/doc/common/mainfooter.html b/doc/common/mainfooter.html
new file mode 100755
index 0000000..4963c31
--- a/dev/null
+++ b/doc/common/mainfooter.html
@@ -0,0 +1,14 @@
1</div>
2<div id="bottom-nav">
3<img src="common/bottom2.png" align="right" height="59" width="227" alt="KDE Logo">
4</div>
5<div class="bottom">
6This file is part of the documentation for OPIE $projectnumber.
7</div>
8<div class="bottom" style="color:#cccccc">
9Documentation copyright &copy; 1996-2002 the KDE developers. 2003 OPIE developers<br>
10Generated on $datetime by
11<a href="http://www.doxygen.org/index.html">doxygen</a> $doxygenversion written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, &copy;&nbsp;1997-2001
12</div>
13</body>
14</html>
diff --git a/doc/common/mainheader.html b/doc/common/mainheader.html
new file mode 100755
index 0000000..1d9d926
--- a/dev/null
+++ b/doc/common/mainheader.html
@@ -0,0 +1,29 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4 <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
5 <title>$title ($projectname)</title>
6 <link href="common/doxygen.css" rel="stylesheet" type="text/css">
7</head>
8<div class="header">
9<table border="0" cellspacing="0" cellpadding="0">
10<tr>
11<td rowspan="2" width="92">
12<a href="index.html" title="The API documentation main page"><img src="common/docheadergears.png" style="border:0px;" alt=""></a>
13</td>
14<td width="95%">
15<h1>$projectname</h1>
16</td>
17</tr>
18<tr>
19<td valign="bottom">
20<table class="links" border=0 cellspacing=0>
21<tr>
22<td><a href="index.html">Home</a></td>
23<td><a href="search.html" title="Search page">Search</a></td>
24</tr>
25</table>
26</td></tr></table>
27</div>
28<div id="hgrad"></div>
29<div class="text">
diff --git a/doc/common/qpl-license.html b/doc/common/qpl-license.html
new file mode 100755
index 0000000..19a863b
--- a/dev/null
+++ b/doc/common/qpl-license.html
@@ -0,0 +1,164 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html40/strict.dtd">
3<HTML LANG="en-US">
4 <HEAD>
5 <TITLE>The Q Public License - version 1.0</TITLE>
6 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=us-ascii">
7 <META HTTP-EQUIV="Content-Language" CONTENT="en-US">
8 <META NAME="description" CONTENT="Q Public License">
9 <META NAME="keywords" CONTENT="Q, q, Q Public License, Q public license, q public license, public license, Q Public Licence, Q public licence, q public licence, public licence, license, licence, software, softwarelicense, Troll, troll, Troll License, troll license, Troll Licence, troll licence">
10 <META NAME="robots" CONTENT="none">
11 <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
12 <LINK REL="stylesheet" HREF="kde-default.css" TYPE="text/css">
13 </HEAD>
14 <BODY CLASS="license">
15 <H1>The Q Public License</H1>
16 <P>version 1.0</P>
17
18 <P>Copyright (C) 1999-2000 Troll Tech AS, Norway.<BR>
19 Everyone is permitted to copy and distribute this license
20 document.
21 </P>
22
23 <P>The intent of this license is to establish freedom to share and
24 change the software regulated by this license under the open
25 source model.</P>
26
27 <P>This license applies to any software containing a notice placed
28 by the copyright holder saying that it may be distributed under
29 the terms of the Q Public License version 1.0. Such software is
30 herein referred to as the Software. This license covers
31 modification and distribution of the Software, use of
32 third-party application programs based on the Software, and
33 development of free software which uses the Software.</P>
34
35 <H2>Granted Rights</H2>
36
37 <OL STYLE="list-style-type: decimal;">
38 <LI>
39 <P>You are granted the non-exclusive rights set forth in this
40 license provided you agree to and comply with any and all
41 conditions in this license. Whole or partial distribution
42 of the Software, or software items that link with the
43 Software, in any form signifies acceptance of this
44 license.</P>
45 </LI>
46
47 <LI>
48 <P>You may copy and distribute the Software in unmodified form
49 provided that the entire package, including - but not
50 restricted to - copyright, trademark notices and
51 disclaimers, as released by the initial developer of the
52 Software, is distributed.</P></LI>
53
54 <LI>
55 <P>You may make modifications to the Software and distribute
56 your modifications, in a form that is separate from the
57 Software, such as patches. The following restrictions apply
58 to modifications:</P>
59
60 <OL STYLE="list-style-type: lower-alpha;">
61 <LI>
62 <P>Modifications must not alter or remove any copyright
63 notices in the Software.</P></LI>
64 <LI>
65 <P>When modifications to the Software are released under
66 this license, a non-exclusive royalty-free right is
67 granted to the initial developer of the Software to
68 distribute your modification in future versions of the
69 Software provided such versions remain available under
70 these terms in addition to any other license(s) of the
71 initial developer.</P>
72 </LI>
73 </OL>
74
75 <LI>
76 <P>You may distribute machine-executable forms of the Software
77 or machine-executable forms of modified versions of the
78 Software, provided that you meet these restrictions:</P>
79
80 <OL STYLE="list-style-type: lower-alpha;">
81 <LI>
82 <P>You must include this license document in the
83 distribution.</P>
84 </LI>
85
86 <LI>
87 <P>You must ensure that all recipients of the
88 machine-executable forms are also able to receive the
89 complete machine-readable source code to the distributed
90 Software, including all modifications, without any
91 charge beyond the costs of data transfer, and place
92 prominent notices in the distribution explaining
93 this.</P>
94 </LI>
95
96 <LI>
97 <P>You must ensure that all modifications included in the
98 machine-executable forms are available under the terms
99 of this license.</P>
100 </LI>
101 </OL>
102 </LI>
103
104 <LI>
105 <P>You may use the original or modified versions of the
106 Software to compile, link and run application programs
107 legally developed by you or by others.</P>
108 </LI>
109
110 <LI>
111 <P>You may develop application programs, reusable components
112 and other software items that link with the original or
113 modified versions of the Software. These items, when
114 distributed, are subject to the following requirements:</P>
115
116 <OL STYLE="list-style-type: lower-alpha;">
117 <LI>
118 <P>You must ensure that all recipients of
119 machine-executable forms of these items are also able to
120 receive and use the complete machine-readable source
121 code to the items without any charge beyond the costs of
122 data transfer.</P>
123 </LI>
124
125 <LI>
126 <P>You must explicitly license all recipients of your
127 items to use and re-distribute original and modified
128 versions of the items in both machine-executable and
129 source code forms. The recipients must be able to do so
130 without any charges whatsoever, and they must be able to
131 re-distribute to anyone they choose.</P>
132 </LI>
133
134 <LI>
135 <P>If the items are not available to the general public,
136 and the initial developer of the Software requests a
137 copy of the items, then you must supply one.</P>
138 </LI>
139 </OL>
140 </LI>
141 </OL>
142
143 <H2>Limitations of Liability</H2>
144
145 <P>In no event shall the initial developers or copyright holders
146 be liable for any damages whatsoever, including - but not
147 restricted to - lost revenue or profits or other direct,
148 indirect, special, incidental or consequential damages, even if
149 they have been advised of the possibility of such damages,
150 except to the extent invariable law, if any, provides
151 otherwise.</P>
152
153 <H2>No Warranty</H2>
154
155 <P>The Software and this license document are provided AS IS with
156 NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN,
157 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.</P>
158
159 <H2>Choice of Law</H2>
160
161 <P>This license is governed by the Laws of Norway. Disputes shall
162 be settled by Oslo City Court.</P>
163 </BODY>
164</HTML>
diff --git a/doc/common/shadow.png b/doc/common/shadow.png
new file mode 100644
index 0000000..37c4469
--- a/dev/null
+++ b/doc/common/shadow.png
Binary files differ
diff --git a/doc/common/web-docbottom.png b/doc/common/web-docbottom.png
new file mode 100644
index 0000000..d334479
--- a/dev/null
+++ b/doc/common/web-docbottom.png
Binary files differ
diff --git a/doc/common/web-doctop.png b/doc/common/web-doctop.png
new file mode 100644
index 0000000..0160109
--- a/dev/null
+++ b/doc/common/web-doctop.png
Binary files differ
diff --git a/doc/common/x11-license.html b/doc/common/x11-license.html
new file mode 100755
index 0000000..444a27b
--- a/dev/null
+++ b/doc/common/x11-license.html
@@ -0,0 +1,45 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html40/strict.dtd">
3<HTML LANG="en-US">
4 <HEAD>
5 <TITLE>X Window System License - X11R6.4</TITLE>
6 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=us-ascii">
7 <META HTTP-EQUIV="Content-Language" CONTENT="en-US">
8 <META NAME="description" CONTENT="X Window System License - X11R6.4">
9 <META NAME="keywords" CONTENT="X, x, X Window, x window, X Windows, x windows, X Window System License, x window system license, X Window System Licence, x window system licence, X11R6.4, x11r6.4, x11r64, license, licence, software, softwarelicense">
10 <META NAME="robots" CONTENT="none">
11 <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
12 <LINK REL="stylesheet" HREF="kde-default.css" TYPE="text/css">
13 </HEAD>
14 <BODY CLASS="license">
15 <H1>X Window System License - X11R6.4</H1>
16
17 <P>Copyright (c) 1998 The Open Group</P>
18
19 <P>Permission is hereby granted, free of charge, to any person
20obtaining a copy of this software and associated documentation files
21(the "Software"), to deal in the Software without restriction,
22including without limitation the rights to use, copy, modify, merge,
23publish, distribute, sublicense, and/or sell copies of the Software,
24and to permit persons to whom the Software is furnished to do so,
25subject to the following conditions:</P>
26
27 <P>The above copyright notice and this permission notice shall be
28included in all copies or substantial portions of the Software.</P>
29
30 <P>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
31EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
32MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
33IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
34OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
35ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
36OTHER DEALINGS IN THE SOFTWARE.</P>
37
38 <P>Except as contained in this notice, the name of The Open Group
39shall not be used in advertising or otherwise to promote the sale, use
40or other dealings in this Software without prior written authorization
41from The Open Group.</P>
42
43 <P>X Window System is a trademark of The Open Group</P>
44 </BODY>
45</HTML>
diff --git a/doc/common/xml.dcl b/doc/common/xml.dcl
new file mode 100644
index 0000000..fed2103
--- a/dev/null
+++ b/doc/common/xml.dcl
@@ -0,0 +1,179 @@
1<!SGML -- SGML Declaration for valid XML documents --
2 "ISO 8879:1986 (WWW)"
3
4 CHARSET
5 BASESET
6 "ISO Registration Number 176//CHARSET
7 ISO/IEC 10646-1:1993 UCS-4 with implementation
8 level 3//ESC 2/5 2/15 4/6"
9 DESCSET
10 0 9 UNUSED
11 9 2 9
12 11 2 UNUSED
13 13 1 13
14 14 18 UNUSED
15 32 95 32
16 127 1 UNUSED
17 128 32 UNUSED
18 -- use this instead of the official declaration because SP only
19 supports 16-bit characters --
20 160 65374 160
21 65534 2 UNUSED
22 -- 55296 2048 UNUSED
23 57344 8190 57344
24 65534 2 UNUSED
25 65536 1048576 65536 --
26 CAPACITY NONE
27
28 SCOPE DOCUMENT
29
30 SYNTAX
31 SHUNCHAR NONE
32 BASESET "ISO Registration Number 176//CHARSET
33 ISO/IEC 10646-1:1993 UCS-4 with implementation
34 level 3//ESC 2/5 2/15 4/6"
35 DESCSET
36 0 1114112 0
37 FUNCTION
38 RE 13
39 RS 10
40 SPACE 32
41 TAB SEPCHAR 9
42
43 NAMING
44 LCNMSTRT ""
45 UCNMSTRT ""
46 NAMESTRT
47 58 95 192-214 216-246 248-305 308-318 321-328
48 330-382 384-451 461-496 500-501 506-535 592-680
49 699-705 902 904-906 908 910-929 931-974 976-982
50 986 988 990 992 994-1011 1025-1036 1038-1103
51 1105-1116 1118-1153 1168-1220 1223-1224
52 1227-1228 1232-1259 1262-1269 1272-1273
53 1329-1366 1369 1377-1414 1488-1514 1520-1522
54 1569-1594 1601-1610 1649-1719 1722-1726
55 1728-1742 1744-1747 1749 1765-1766 2309-2361
56 2365 2392-2401 2437-2444 2447-2448 2451-2472
57 2474-2480 2482 2486-2489 2524-2525 2527-2529
58 2544-2545 2565-2570 2575-2576 2579-2600
59 2602-2608 2610-2611 2613-2614 2616-2617
60 2649-2652 2654 2674-2676 2693-2699 2701
61 2703-2705 2707-2728 2730-2736 2738-2739
62 2741-2745 2749 2784 2821-2828 2831-2832
63 2835-2856 2858-2864 2866-2867 2870-2873 2877
64 2908-2909 2911-2913 2949-2954 2958-2960
65 2962-2965 2969-2970 2972 2974-2975 2979-2980
66 2984-2986 2990-2997 2999-3001 3077-3084
67 3086-3088 3090-3112 3114-3123 3125-3129
68 3168-3169 3205-3212 3214-3216 3218-3240
69 3242-3251 3253-3257 3294 3296-3297 3333-3340
70 3342-3344 3346-3368 3370-3385 3424-3425
71 3585-3630 3632 3634-3635 3648-3653 3713-3714
72 3716 3719-3720 3722 3725 3732-3735 3737-3743
73 3745-3747 3749 3751 3754-3755 3757-3758 3760
74 3762-3763 3773 3776-3780 3904-3911 3913-3945
75 4256-4293 4304-4342 4352 4354-4355 4357-4359
76 4361 4363-4364 4366-4370 4412 4414 4416 4428
77 4430 4432 4436-4437 4441 4447-4449 4451 4453
78 4455 4457 4461-4462 4466-4467 4469 4510 4520
79 4523 4526-4527 4535-4536 4538 4540-4546 4587
80 4592 4601 7680-7835 7840-7929 7936-7957
81 7960-7965 7968-8005 8008-8013 8016-8023 8025
82 8027 8029 8031-8061 8064-8116 8118-8124 8126
83 8130-8132 8134-8140 8144-8147 8150-8155
84 8160-8172 8178-8180 8182-8188 8486 8490-8491
85 8494 8576-8578 12295 12321-12329 12353-12436
86 12449-12538 12549-12588 19968-40869 44032-55203
87
88 LCNMCHAR ""
89 UCNMCHAR ""
90 NAMECHAR
91 45-46 183 720-721 768-837 864-865 903 1155-1158
92 1425-1441 1443-1465 1467-1469 1471 1473-1474
93 1476 1600 1611-1618 1632-1641 1648 1750-1764
94 1767-1768 1770-1773 1776-1785 2305-2307 2364
95 2366-2381 2385-2388 2402-2403 2406-2415
96 2433-2435 2492 2494-2500 2503-2504 2507-2509
97 2519 2530-2531 2534-2543 2562 2620 2622-2626
98 2631-2632 2635-2637 2662-2673 2689-2691 2748
99 2750-2757 2759-2761 2763-2765 2790-2799
100 2817-2819 2876 2878-2883 2887-2888 2891-2893
101 2902-2903 2918-2927 2946-2947 3006-3010
102 3014-3016 3018-3021 3031 3047-3055 3073-3075
103 3134-3140 3142-3144 3146-3149 3157-3158
104 3174-3183 3202-3203 3262-3268 3270-3272
105 3274-3277 3285-3286 3302-3311 3330-3331
106 3390-3395 3398-3400 3402-3405 3415 3430-3439
107 3633 3636-3642 3654-3662 3664-3673 3761
108 3764-3769 3771-3772 3782 3784-3789 3792-3801
109 3864-3865 3872-3881 3893 3895 3897 3902-3903
110 3953-3972 3974-3979 3984-3989 3991 3993-4013
111 4017-4023 4025 8400-8412 8417 12293 12330-12335
112 12337-12341 12441-12442 12445-12446 12540-12542
113
114 NAMECASE
115 GENERAL NO
116 ENTITY NO
117
118 DELIM
119 GENERAL SGMLREF
120 HCRO "&#38;#x" -- 38 is the number for ampersand --
121 NESTC "/"
122 NET ">"
123 PIC "?>"
124 SHORTREF NONE
125
126 NAMES
127 SGMLREF
128
129 QUANTITY NONE
130
131 ENTITIES
132 "amp" 38
133 "lt" 60
134 "gt" 62
135 "quot" 34
136 "apos" 39
137
138 FEATURES
139 MINIMIZE
140 DATATAG NO
141 OMITTAG NO
142 RANK NO
143 SHORTTAG
144 STARTTAG
145 EMPTY NO
146 UNCLOSED NO
147 NETENABL IMMEDNET
148 ENDTAG
149 EMPTY NO
150 UNCLOSED NO
151 ATTRIB
152 DEFAULT YES
153 OMITNAME NO
154 VALUE NO
155 EMPTYNRM YES
156 IMPLYDEF
157 ATTLIST NO
158 DOCTYPE NO
159 ELEMENT NO
160 ENTITY NO
161 NOTATION NO
162 LINK
163 SIMPLE NO
164 IMPLICIT NO
165 EXPLICIT NO
166 OTHER
167 CONCUR NO
168 SUBDOC NO
169 FORMAL NO
170 URN NO
171 KEEPRSRE YES
172 VALIDITY TYPE
173 ENTITIES
174 REF ANY
175 INTEGRAL YES
176 APPINFO NONE
177 SEEALSO "ISO 8879:1986//NOTATION
178 Extensible Markup Language (XML) 1.0//EN"
179>
diff --git a/doc/generate_apidox b/doc/generate_apidox
new file mode 100755
index 0000000..db77e20
--- a/dev/null
+++ b/doc/generate_apidox
@@ -0,0 +1,54 @@
1#!/bin/sh
2
3# small shell script to generate our API docs
4# it'll copy over qt
5
6#
7# create directory structure
8echo "Creating directory structure"
9rm -rf $OPIEDIR/apidocs
10mkdir $OPIEDIR/apidocs
11mkdir $OPIEDIR/apidocs/api
12mkdir $OPIEDIR/apidocs/common
13mkdir $OPIEDIR/apidocs/qt
14mkdir $OPIEDIR/apidocs/libqpe
15mkdir $OPIEDIR/apidocs/libopie
16mkdir $OPIEDIR/apidocs/pim
17
18# now copy qt doc
19echo "Scanning and copying QT docu"
20cp -R $QTDIR/doc/html/* $OPIEDIR/apidocs/qt
21doxytag -t $OPIEDIR/apidocs/qt/qt.tag $OPIEDIR/apidocs/qt
22
23cp -r $OPIEDIR/doc/common/* $OPIEDIR/apidocs/common
24# now start with libqpe
25echo "Creating docu for qpe"
26cp $OPIEDIR/doc/Doxyfile_libqpe $OPIEDIR/library/Doxyfile
27cd $OPIEDIR/library
28doxygen Doxyfile
29rm -f Doxyfile
30
31# now do libopie
32echo "Creating docu for libopie"
33cp $OPIEDIR/doc/Doxyfile_libopie $OPIEDIR/libopie/Doxyfile
34cd $OPIEDIR/libopie
35doxygen Doxyfile
36rm -f Doxyfile
37
38echo "Creating docu for PIM"
39# now it's time for libopie/pim
40cp $OPIEDIR/doc/Doxyfile_pim $OPIEDIR/libopie/pim/Doxyfile
41cd $OPIEDIR/libopie/pim
42doxygen Doxyfile
43rm -f Doxyfile
44
45echo "Making mainpage"
46# now generate the mainpage
47cp $OPIEDIR/doc/Doxyfile_main $OPIEDIR/Doxyfile
48cp $OPIEDIR/doc/Mainpage.dox $OPIEDIR/
49cd $OPIEDIR
50doxygen Doxyfile
51rm -f Doxyfile
52rm -f Mainpage.dox
53
54echo "Done with generation!!! hopefully grin"