summaryrefslogtreecommitdiff
path: root/doc
Unidiff
Diffstat (limited to 'doc') (more/less context) (ignore whitespace changes)
-rw-r--r--doc/Doxyfile_libopie887
-rw-r--r--doc/Doxyfile_libqpe879
-rw-r--r--doc/Doxyfile_main886
-rw-r--r--doc/Doxyfile_pim885
-rwxr-xr-xdoc/Mainpage.dox30
5 files changed, 289 insertions, 3278 deletions
diff --git a/doc/Doxyfile_libopie b/doc/Doxyfile_libopie
index 4a2872d..13eb92b 100644
--- a/doc/Doxyfile_libopie
+++ b/doc/Doxyfile_libopie
@@ -1,972 +1,219 @@
1# Doxyfile 1.2.15 1# Doxyfile 1.3.4
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 2
13#--------------------------------------------------------------------------- 3#---------------------------------------------------------------------------
14# General configuration options 4# Project related configuration options
15#--------------------------------------------------------------------------- 5#---------------------------------------------------------------------------
16 6PROJECT_NAME = libopie
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 7PROJECT_NUMBER = "Version 1.1"
18# by quotes) that should identify the project. 8OUTPUT_DIRECTORY = ../apidocs
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 9OUTPUT_LANGUAGE = English
44 10USE_WINDOWS_ENCODING = NO
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 11BRIEF_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 12REPEAT_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 13ALWAYS_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 14INLINE_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 15FULL_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 = 16STRIP_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 17SHORT_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 18JAVADOC_AUTOBRIEF = YES
175 19MULTILINE_CPP_IS_BRIEF = NO
176# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 20DETAILS_AT_TOP = NO
177# member inherits the documentation from any documented member that it
178# reimplements.
179
180INHERIT_DOCS = YES 21INHERIT_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 22DISTRIBUTE_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 23TAB_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 \ 24ALIASES = libdoc=@mainpage \
235 sect=<p><b> \ 25 sect=<p><b> \
236 reimplemented= \ 26 reimplemented= \
237 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \ 27 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \
238 obsolete=@deprecated \ 28 obsolete=@deprecated \
239 ref= 29 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 30OPTIMIZE_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 31OPTIMIZE_OUTPUT_JAVA = NO
269 32SUBGROUPING = YES
270# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 33#---------------------------------------------------------------------------
271# at the bottom of the documentation of classes and structs. If set to YES the 34# Build related configuration options
272# list will mention the files that were used to generate the documentation. 35#---------------------------------------------------------------------------
273 36EXTRACT_ALL = NO
37EXTRACT_PRIVATE = NO
38EXTRACT_STATIC = YES
39EXTRACT_LOCAL_CLASSES = NO
40HIDE_UNDOC_MEMBERS = NO
41HIDE_UNDOC_CLASSES = YES
42HIDE_FRIEND_COMPOUNDS = NO
43HIDE_IN_BODY_DOCS = NO
44INTERNAL_DOCS = NO
45CASE_SENSE_NAMES = YES
46HIDE_SCOPE_NAMES = NO
47SHOW_INCLUDE_FILES = YES
48INLINE_INFO = YES
49SORT_MEMBER_DOCS = NO
50GENERATE_TODOLIST = YES
51GENERATE_TESTLIST = YES
52GENERATE_BUGLIST = YES
53GENERATE_DEPRECATEDLIST= YES
54ENABLED_SECTIONS =
55MAX_INITIALIZER_LINES = 30
274SHOW_USED_FILES = YES 56SHOW_USED_FILES = YES
275
276#--------------------------------------------------------------------------- 57#---------------------------------------------------------------------------
277# configuration options related to warning and progress messages 58# configuration options related to warning and progress messages
278#--------------------------------------------------------------------------- 59#---------------------------------------------------------------------------
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 60QUIET = 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 61WARNINGS = 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 62WARN_IF_UNDOCUMENTED = YES
296 63WARN_IF_DOC_ERROR = YES
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" 64WARN_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 65WARN_LOGFILE = Dox-Warning
309
310#--------------------------------------------------------------------------- 66#---------------------------------------------------------------------------
311# configuration options related to the input files 67# configuration options related to the input files
312#--------------------------------------------------------------------------- 68#---------------------------------------------------------------------------
313 69INPUT = .
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 \ 70FILE_PATTERNS = *.h \
329 *.cpp \ 71 *.cpp \
330 *.cc \ 72 *.cc \
331 *.hpp 73 *.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 74RECURSIVE = 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 = 75EXCLUDE =
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 76EXCLUDE_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.* \ 77EXCLUDE_PATTERNS = *.moc.* \
355 moc* \ 78 moc* \
356 *.all_cpp.* \ 79 *.all_cpp.* \
357 *unload.* \ 80 *unload.* \
358 */test/* \ 81 */test/* \
359 */tests/* 82 */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 = 83EXAMPLE_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 = 84EXAMPLE_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 85EXAMPLE_RECURSIVE = NO
380 86IMAGE_PATH = ../apidocs/api
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 = 87INPUT_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 88FILTER_SOURCE_FILES = NO
401
402#--------------------------------------------------------------------------- 89#---------------------------------------------------------------------------
403# configuration options related to source browsing 90# configuration options related to source browsing
404#--------------------------------------------------------------------------- 91#---------------------------------------------------------------------------
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 92SOURCE_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 93INLINE_SOURCES = NO
415 94STRIP_CODE_COMMENTS = YES
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 95REFERENCED_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 96REFERENCES_RELATION = YES
427 97VERBATIM_HEADERS = YES
428#--------------------------------------------------------------------------- 98#---------------------------------------------------------------------------
429# configuration options related to the alphabetical class index 99# configuration options related to the alphabetical class index
430#--------------------------------------------------------------------------- 100#---------------------------------------------------------------------------
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 101ALPHABETICAL_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 102COLS_IN_ALPHA_INDEX = 3
443 103IGNORE_PREFIX = O
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#--------------------------------------------------------------------------- 104#---------------------------------------------------------------------------
452# configuration options related to the HTML output 105# configuration options related to the HTML output
453#--------------------------------------------------------------------------- 106#---------------------------------------------------------------------------
454 107GENERATE_HTML = YES
455# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 108HTML_OUTPUT = libopie/html
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 109HTML_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 110HTML_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 111HTML_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 112HTML_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 113HTML_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 114GENERATE_HTMLHELP = NO
503 115CHM_FILE =
504# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 116HHC_LOCATION =
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 117GENERATE_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 118BINARY_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 119TOC_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 120DISABLE_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 121ENUM_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 122GENERATE_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 123TREEVIEW_WIDTH = 250
547
548#--------------------------------------------------------------------------- 124#---------------------------------------------------------------------------
549# configuration options related to the LaTeX output 125# configuration options related to the LaTeX output
550#--------------------------------------------------------------------------- 126#---------------------------------------------------------------------------
551 127GENERATE_LATEX = YES
552# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 128LATEX_OUTPUT = libopie/latex
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 129LATEX_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 130MAKEINDEX_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 131COMPACT_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 132PAPER_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 = 133EXTRA_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 = 134LATEX_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 135PDF_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 136USE_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 137LATEX_BATCHMODE = NO
616 138LATEX_HIDE_INDICES = NO
617#--------------------------------------------------------------------------- 139#---------------------------------------------------------------------------
618# configuration options related to the RTF output 140# configuration options related to the RTF output
619#--------------------------------------------------------------------------- 141#---------------------------------------------------------------------------
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 142GENERATE_RTF = NO
626 143RTF_OUTPUT = libopie/rtf
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 144COMPACT_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 145RTF_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 = 146RTF_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 = 147RTF_EXTENSIONS_FILE =
658
659#--------------------------------------------------------------------------- 148#---------------------------------------------------------------------------
660# configuration options related to the man page output 149# configuration options related to the man page output
661#--------------------------------------------------------------------------- 150#---------------------------------------------------------------------------
662 151GENERATE_MAN = YES
663# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 152MAN_OUTPUT = libopie/man
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 153MAN_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 154MAN_LINKS = YES
686
687#--------------------------------------------------------------------------- 155#---------------------------------------------------------------------------
688# configuration options related to the XML output 156# configuration options related to the XML output
689#--------------------------------------------------------------------------- 157#---------------------------------------------------------------------------
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 158GENERATE_XML = NO
698 159XML_OUTPUT = xml
160XML_SCHEMA =
161XML_DTD =
699#--------------------------------------------------------------------------- 162#---------------------------------------------------------------------------
700# configuration options for the AutoGen Definitions output 163# configuration options for the AutoGen Definitions output
701#--------------------------------------------------------------------------- 164#---------------------------------------------------------------------------
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 165GENERATE_AUTOGEN_DEF = NO
710 166#---------------------------------------------------------------------------
167# configuration options related to the Perl module output
168#---------------------------------------------------------------------------
169GENERATE_PERLMOD = NO
170PERLMOD_LATEX = NO
171PERLMOD_PRETTY = YES
172PERLMOD_MAKEVAR_PREFIX =
711#--------------------------------------------------------------------------- 173#---------------------------------------------------------------------------
712# Configuration options related to the preprocessor 174# Configuration options related to the preprocessor
713#--------------------------------------------------------------------------- 175#---------------------------------------------------------------------------
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 176ENABLE_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 177MACRO_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 178EXPAND_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 179SEARCH_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 = 180INCLUDE_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 = 181INCLUDE_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 182PREDEFINED = 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 = 183EXPAND_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 184SKIP_FUNCTION_MACROS = YES
773
774#--------------------------------------------------------------------------- 185#---------------------------------------------------------------------------
775# Configuration::addtions related to external references 186# Configuration::addtions related to external references
776#--------------------------------------------------------------------------- 187#---------------------------------------------------------------------------
777 188TAGFILES = ../apidocs/qt/qt.tag=../../qt \
778# The TAGFILES tag can be used to specify one or more tagfiles. 189 ../apidocs/libqpe/libqpe.tag=../../libqpe/html
779 190GENERATE_TAGFILE = ../apidocs/libopie/libopie.tag
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 191ALLEXTERNALS = 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 192EXTERNAL_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 = 193PERL_PATH =
803
804#--------------------------------------------------------------------------- 194#---------------------------------------------------------------------------
805# Configuration options related to the dot tool 195# Configuration options related to the dot tool
806#--------------------------------------------------------------------------- 196#---------------------------------------------------------------------------
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 197CLASS_DIAGRAMS = YES
815 198HIDE_UNDOC_RELATIONS = NO
816# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 199HAVE_DOT = YES
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 200CLASS_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 201COLLABORATION_GRAPH = YES
836 202UML_LOOK = NO
837# If set to YES, the inheritance and collaboration graphs will show the
838# relations between templates and their instances.
839
840TEMPLATE_RELATIONS = YES 203TEMPLATE_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 204INCLUDE_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 205INCLUDED_BY_GRAPH = YES
861 206CALL_GRAPH = NO
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 207GRAPHICAL_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 208DOT_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 = 209DOT_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 = 210DOTFILE_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 211MAX_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 212MAX_DOT_GRAPH_HEIGHT = 1024
899 213MAX_DOT_GRAPH_DEPTH = 0
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 214GENERATE_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 215DOT_CLEANUP = YES
911
912#--------------------------------------------------------------------------- 216#---------------------------------------------------------------------------
913# Configuration::addtions related to the search engine 217# Configuration::addtions related to the search engine
914#--------------------------------------------------------------------------- 218#---------------------------------------------------------------------------
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 219SEARCHENGINE = 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
index a26a8b0..ac12f3f 100644
--- a/doc/Doxyfile_libqpe
+++ b/doc/Doxyfile_libqpe
@@ -1,971 +1,218 @@
1# Doxyfile 1.2.15 1# Doxyfile 1.3.4
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 2
13#--------------------------------------------------------------------------- 3#---------------------------------------------------------------------------
14# General configuration options 4# Project related configuration options
15#--------------------------------------------------------------------------- 5#---------------------------------------------------------------------------
16 6PROJECT_NAME = "Qtopia library"
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 7PROJECT_NUMBER = "Version 1.5.5"
18# by quotes) that should identify the project. 8OUTPUT_DIRECTORY = ../apidocs
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 9OUTPUT_LANGUAGE = English
44 10USE_WINDOWS_ENCODING = NO
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 11BRIEF_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 12REPEAT_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 13ALWAYS_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 14INLINE_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 15FULL_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 = 16STRIP_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 17SHORT_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 18JAVADOC_AUTOBRIEF = YES
175 19MULTILINE_CPP_IS_BRIEF = NO
176# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 20DETAILS_AT_TOP = NO
177# member inherits the documentation from any documented member that it
178# reimplements.
179
180INHERIT_DOCS = YES 21INHERIT_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 22DISTRIBUTE_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 23TAB_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 \ 24ALIASES = libdoc=@mainpage \
235 sect=<p><b> \ 25 sect=<p><b> \
236 reimplemented= \ 26 reimplemented= \
237 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \ 27 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \
238 obsolete=@deprecated \ 28 obsolete=@deprecated \
239 ref= 29 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 30OPTIMIZE_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 31OPTIMIZE_OUTPUT_JAVA = NO
269 32SUBGROUPING = YES
270# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 33#---------------------------------------------------------------------------
271# at the bottom of the documentation of classes and structs. If set to YES the 34# Build related configuration options
272# list will mention the files that were used to generate the documentation. 35#---------------------------------------------------------------------------
273 36EXTRACT_ALL = NO
37EXTRACT_PRIVATE = NO
38EXTRACT_STATIC = YES
39EXTRACT_LOCAL_CLASSES = NO
40HIDE_UNDOC_MEMBERS = NO
41HIDE_UNDOC_CLASSES = YES
42HIDE_FRIEND_COMPOUNDS = NO
43HIDE_IN_BODY_DOCS = NO
44INTERNAL_DOCS = NO
45CASE_SENSE_NAMES = YES
46HIDE_SCOPE_NAMES = NO
47SHOW_INCLUDE_FILES = YES
48INLINE_INFO = YES
49SORT_MEMBER_DOCS = NO
50GENERATE_TODOLIST = YES
51GENERATE_TESTLIST = YES
52GENERATE_BUGLIST = YES
53GENERATE_DEPRECATEDLIST= YES
54ENABLED_SECTIONS =
55MAX_INITIALIZER_LINES = 30
274SHOW_USED_FILES = YES 56SHOW_USED_FILES = YES
275
276#--------------------------------------------------------------------------- 57#---------------------------------------------------------------------------
277# configuration options related to warning and progress messages 58# configuration options related to warning and progress messages
278#--------------------------------------------------------------------------- 59#---------------------------------------------------------------------------
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 60QUIET = 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 61WARNINGS = 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 62WARN_IF_UNDOCUMENTED = YES
296 63WARN_IF_DOC_ERROR = YES
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" 64WARN_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 65WARN_LOGFILE = Dox-Warnings
309
310#--------------------------------------------------------------------------- 66#---------------------------------------------------------------------------
311# configuration options related to the input files 67# configuration options related to the input files
312#--------------------------------------------------------------------------- 68#---------------------------------------------------------------------------
313 69INPUT = .
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 \ 70FILE_PATTERNS = *.h \
329 *.cpp \ 71 *.cpp \
330 *.cc \ 72 *.cc \
331 *.hpp 73 *.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 74RECURSIVE = 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 = 75EXCLUDE =
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 76EXCLUDE_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.* \ 77EXCLUDE_PATTERNS = *.moc.* \
355 moc* \ 78 moc* \
356 *.all_cpp.* \ 79 *.all_cpp.* \
357 *unload.* \ 80 *unload.* \
358 */test/* \ 81 */test/* \
359 */tests/* 82 */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 = 83EXAMPLE_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 = 84EXAMPLE_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 85EXAMPLE_RECURSIVE = NO
380 86IMAGE_PATH = ../apidocs/api
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 = 87INPUT_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 88FILTER_SOURCE_FILES = NO
401
402#--------------------------------------------------------------------------- 89#---------------------------------------------------------------------------
403# configuration options related to source browsing 90# configuration options related to source browsing
404#--------------------------------------------------------------------------- 91#---------------------------------------------------------------------------
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 92SOURCE_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 93INLINE_SOURCES = NO
415 94STRIP_CODE_COMMENTS = YES
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 95REFERENCED_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 96REFERENCES_RELATION = YES
427 97VERBATIM_HEADERS = YES
428#--------------------------------------------------------------------------- 98#---------------------------------------------------------------------------
429# configuration options related to the alphabetical class index 99# configuration options related to the alphabetical class index
430#--------------------------------------------------------------------------- 100#---------------------------------------------------------------------------
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 101ALPHABETICAL_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 102COLS_IN_ALPHA_INDEX = 3
443 103IGNORE_PREFIX = Q
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#--------------------------------------------------------------------------- 104#---------------------------------------------------------------------------
452# configuration options related to the HTML output 105# configuration options related to the HTML output
453#--------------------------------------------------------------------------- 106#---------------------------------------------------------------------------
454 107GENERATE_HTML = YES
455# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 108HTML_OUTPUT = libqpe/html
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 109HTML_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 110HTML_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 111HTML_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 112HTML_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 113HTML_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 114GENERATE_HTMLHELP = NO
503 115CHM_FILE =
504# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 116HHC_LOCATION =
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 117GENERATE_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 118BINARY_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 119TOC_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 120DISABLE_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 121ENUM_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 122GENERATE_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 123TREEVIEW_WIDTH = 250
547
548#--------------------------------------------------------------------------- 124#---------------------------------------------------------------------------
549# configuration options related to the LaTeX output 125# configuration options related to the LaTeX output
550#--------------------------------------------------------------------------- 126#---------------------------------------------------------------------------
551
552# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
553# generate Latex output.
554
555GENERATE_LATEX = NO 127GENERATE_LATEX = NO
556 128LATEX_OUTPUT = libqpe/latex
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 129LATEX_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 130MAKEINDEX_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 131COMPACT_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 132PAPER_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 = 133EXTRA_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 = 134LATEX_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 135PDF_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 136USE_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 137LATEX_BATCHMODE = NO
616 138LATEX_HIDE_INDICES = NO
617#--------------------------------------------------------------------------- 139#---------------------------------------------------------------------------
618# configuration options related to the RTF output 140# configuration options related to the RTF output
619#--------------------------------------------------------------------------- 141#---------------------------------------------------------------------------
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 142GENERATE_RTF = NO
626 143RTF_OUTPUT = libqpe/rtf
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 144COMPACT_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 145RTF_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 = 146RTF_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 = 147RTF_EXTENSIONS_FILE =
658
659#--------------------------------------------------------------------------- 148#---------------------------------------------------------------------------
660# configuration options related to the man page output 149# configuration options related to the man page output
661#--------------------------------------------------------------------------- 150#---------------------------------------------------------------------------
662
663# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
664# generate man pages
665
666GENERATE_MAN = NO 151GENERATE_MAN = NO
667 152MAN_OUTPUT = libqpe/man
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 153MAN_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 154MAN_LINKS = YES
686
687#--------------------------------------------------------------------------- 155#---------------------------------------------------------------------------
688# configuration options related to the XML output 156# configuration options related to the XML output
689#--------------------------------------------------------------------------- 157#---------------------------------------------------------------------------
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 158GENERATE_XML = NO
698 159XML_OUTPUT = xml
160XML_SCHEMA =
161XML_DTD =
699#--------------------------------------------------------------------------- 162#---------------------------------------------------------------------------
700# configuration options for the AutoGen Definitions output 163# configuration options for the AutoGen Definitions output
701#--------------------------------------------------------------------------- 164#---------------------------------------------------------------------------
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 165GENERATE_AUTOGEN_DEF = NO
710 166#---------------------------------------------------------------------------
167# configuration options related to the Perl module output
168#---------------------------------------------------------------------------
169GENERATE_PERLMOD = NO
170PERLMOD_LATEX = NO
171PERLMOD_PRETTY = YES
172PERLMOD_MAKEVAR_PREFIX =
711#--------------------------------------------------------------------------- 173#---------------------------------------------------------------------------
712# Configuration options related to the preprocessor 174# Configuration options related to the preprocessor
713#--------------------------------------------------------------------------- 175#---------------------------------------------------------------------------
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 176ENABLE_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 177MACRO_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 178EXPAND_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 179SEARCH_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 = 180INCLUDE_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 = 181INCLUDE_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 182PREDEFINED = 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 = 183EXPAND_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 184SKIP_FUNCTION_MACROS = YES
773
774#--------------------------------------------------------------------------- 185#---------------------------------------------------------------------------
775# Configuration::addtions related to external references 186# Configuration::addtions related to external references
776#--------------------------------------------------------------------------- 187#---------------------------------------------------------------------------
777 188TAGFILES = ../apidocs/qt/qt.tag=../../qt/
778# The TAGFILES tag can be used to specify one or more tagfiles. 189GENERATE_TAGFILE = ../apidocs/libqpe/libqpe.tag
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 190ALLEXTERNALS = 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 191EXTERNAL_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 = 192PERL_PATH =
803
804#--------------------------------------------------------------------------- 193#---------------------------------------------------------------------------
805# Configuration options related to the dot tool 194# Configuration options related to the dot tool
806#--------------------------------------------------------------------------- 195#---------------------------------------------------------------------------
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 196CLASS_DIAGRAMS = YES
815 197HIDE_UNDOC_RELATIONS = NO
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 198HAVE_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 199CLASS_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 200COLLABORATION_GRAPH = YES
836 201UML_LOOK = NO
837# If set to YES, the inheritance and collaboration graphs will show the
838# relations between templates and their instances.
839
840TEMPLATE_RELATIONS = YES 202TEMPLATE_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 203INCLUDE_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 204INCLUDED_BY_GRAPH = YES
861 205CALL_GRAPH = NO
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 206GRAPHICAL_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 207DOT_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 = 208DOT_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 = 209DOTFILE_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 210MAX_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 211MAX_DOT_GRAPH_HEIGHT = 1024
899 212MAX_DOT_GRAPH_DEPTH = 0
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 213GENERATE_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 214DOT_CLEANUP = YES
911
912#--------------------------------------------------------------------------- 215#---------------------------------------------------------------------------
913# Configuration::addtions related to the search engine 216# Configuration::addtions related to the search engine
914#--------------------------------------------------------------------------- 217#---------------------------------------------------------------------------
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 218SEARCHENGINE = 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
index 180fc1f..80a2660 100644
--- a/doc/Doxyfile_main
+++ b/doc/Doxyfile_main
@@ -1,975 +1,215 @@
1# Doxyfile 1.2.15 1# Doxyfile 1.3.4
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 2
13#--------------------------------------------------------------------------- 3#---------------------------------------------------------------------------
14# General configuration options 4# Project related configuration options
15#--------------------------------------------------------------------------- 5#---------------------------------------------------------------------------
16 6PROJECT_NAME = TheOPIEAPIReference
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 7PROJECT_NUMBER = "Version 1.1"
18# by quotes) that should identify the project. 8OUTPUT_DIRECTORY = ./apidocs
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 9OUTPUT_LANGUAGE = English
44 10USE_WINDOWS_ENCODING = NO
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 11BRIEF_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 12REPEAT_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 13ALWAYS_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 14INLINE_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 15FULL_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 = 16STRIP_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 17SHORT_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 18JAVADOC_AUTOBRIEF = YES
175 19MULTILINE_CPP_IS_BRIEF = NO
176# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 20DETAILS_AT_TOP = NO
177# member inherits the documentation from any documented member that it
178# reimplements.
179
180INHERIT_DOCS = YES 21INHERIT_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 22DISTRIBUTE_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 23TAB_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 \ 24ALIASES = libdoc=@mainpage \
235 sect=<p><b> \ 25 sect=<p><b> \
236 reimplemented= \ 26 reimplemented= \
237 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \ 27 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \
238 obsolete=@deprecated \ 28 obsolete=@deprecated \
239 ref= 29 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 30OPTIMIZE_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 31OPTIMIZE_OUTPUT_JAVA = NO
269 32SUBGROUPING = YES
270# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 33#---------------------------------------------------------------------------
271# at the bottom of the documentation of classes and structs. If set to YES the 34# Build related configuration options
272# list will mention the files that were used to generate the documentation. 35#---------------------------------------------------------------------------
273 36EXTRACT_ALL = YES
37EXTRACT_PRIVATE = NO
38EXTRACT_STATIC = YES
39EXTRACT_LOCAL_CLASSES = NO
40HIDE_UNDOC_MEMBERS = NO
41HIDE_UNDOC_CLASSES = YES
42HIDE_FRIEND_COMPOUNDS = NO
43HIDE_IN_BODY_DOCS = NO
44INTERNAL_DOCS = NO
45CASE_SENSE_NAMES = YES
46HIDE_SCOPE_NAMES = NO
47SHOW_INCLUDE_FILES = YES
48INLINE_INFO = YES
49SORT_MEMBER_DOCS = NO
50GENERATE_TODOLIST = YES
51GENERATE_TESTLIST = YES
52GENERATE_BUGLIST = YES
53GENERATE_DEPRECATEDLIST= YES
54ENABLED_SECTIONS =
55MAX_INITIALIZER_LINES = 30
274SHOW_USED_FILES = YES 56SHOW_USED_FILES = YES
275
276#--------------------------------------------------------------------------- 57#---------------------------------------------------------------------------
277# configuration options related to warning and progress messages 58# configuration options related to warning and progress messages
278#--------------------------------------------------------------------------- 59#---------------------------------------------------------------------------
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 60QUIET = 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 61WARNINGS = 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 62WARN_IF_UNDOCUMENTED = NO
296 63WARN_IF_DOC_ERROR = YES
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 = 64WARN_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 = 65WARN_LOGFILE =
309
310#--------------------------------------------------------------------------- 66#---------------------------------------------------------------------------
311# configuration options related to the input files 67# configuration options related to the input files
312#--------------------------------------------------------------------------- 68#---------------------------------------------------------------------------
313 69INPUT = .
314# The INPUT tag can be used to specify the files and/or directories that contain 70FILE_PATTERNS = *.dox
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 71RECURSIVE = 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 = 72EXCLUDE =
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 73EXCLUDE_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.* \ 74EXCLUDE_PATTERNS = *.moc.* \
355 moc* \ 75 moc* \
356 *.all_cpp.* \ 76 *.all_cpp.* \
357 *unload.* \ 77 *unload.* \
358 */test/* \ 78 */test/* \
359 */tests/* 79 */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 = 80EXAMPLE_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 = 81EXAMPLE_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 82EXAMPLE_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 = 83IMAGE_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 = 84INPUT_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 85FILTER_SOURCE_FILES = NO
401
402#--------------------------------------------------------------------------- 86#---------------------------------------------------------------------------
403# configuration options related to source browsing 87# configuration options related to source browsing
404#--------------------------------------------------------------------------- 88#---------------------------------------------------------------------------
405 89SOURCE_BROWSER = NO
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 90INLINE_SOURCES = NO
415 91STRIP_CODE_COMMENTS = YES
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 92REFERENCED_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 93REFERENCES_RELATION = YES
427 94VERBATIM_HEADERS = YES
428#--------------------------------------------------------------------------- 95#---------------------------------------------------------------------------
429# configuration options related to the alphabetical class index 96# configuration options related to the alphabetical class index
430#--------------------------------------------------------------------------- 97#---------------------------------------------------------------------------
431 98ALPHABETICAL_INDEX = NO
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 99COLS_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 100IGNORE_PREFIX = O
450
451#--------------------------------------------------------------------------- 101#---------------------------------------------------------------------------
452# configuration options related to the HTML output 102# configuration options related to the HTML output
453#--------------------------------------------------------------------------- 103#---------------------------------------------------------------------------
454 104GENERATE_HTML = YES
455# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 105HTML_OUTPUT = .
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 106HTML_FILE_EXTENSION = .html
471 107HTML_HEADER = apidocs/common/mainheader.html
472# The HTML_HEADER tag can be used to specify a personal HTML header for 108HTML_FOOTER = apidocs/common/mainfooter.html
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 109HTML_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 110HTML_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 111GENERATE_HTMLHELP = NO
503 112CHM_FILE =
504# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 113HHC_LOCATION =
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 114GENERATE_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 115BINARY_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 116TOC_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 117DISABLE_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 118ENUM_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 119GENERATE_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 120TREEVIEW_WIDTH = 250
547
548#--------------------------------------------------------------------------- 121#---------------------------------------------------------------------------
549# configuration options related to the LaTeX output 122# configuration options related to the LaTeX output
550#--------------------------------------------------------------------------- 123#---------------------------------------------------------------------------
551
552# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
553# generate Latex output.
554
555GENERATE_LATEX = NO 124GENERATE_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 = 125LATEX_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 126LATEX_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 127MAKEINDEX_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 128COMPACT_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 129PAPER_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 = 130EXTRA_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 = 131LATEX_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 132PDF_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 133USE_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 134LATEX_BATCHMODE = NO
616 135LATEX_HIDE_INDICES = NO
617#--------------------------------------------------------------------------- 136#---------------------------------------------------------------------------
618# configuration options related to the RTF output 137# configuration options related to the RTF output
619#--------------------------------------------------------------------------- 138#---------------------------------------------------------------------------
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 139GENERATE_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 = 140RTF_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 141COMPACT_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 142RTF_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 = 143RTF_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 = 144RTF_EXTENSIONS_FILE =
658
659#--------------------------------------------------------------------------- 145#---------------------------------------------------------------------------
660# configuration options related to the man page output 146# configuration options related to the man page output
661#--------------------------------------------------------------------------- 147#---------------------------------------------------------------------------
662
663# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
664# generate man pages
665
666GENERATE_MAN = NO 148GENERATE_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 = 149MAN_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 150MAN_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 151MAN_LINKS = YES
686
687#--------------------------------------------------------------------------- 152#---------------------------------------------------------------------------
688# configuration options related to the XML output 153# configuration options related to the XML output
689#--------------------------------------------------------------------------- 154#---------------------------------------------------------------------------
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 155GENERATE_XML = NO
698 156XML_OUTPUT = xml
157XML_SCHEMA =
158XML_DTD =
699#--------------------------------------------------------------------------- 159#---------------------------------------------------------------------------
700# configuration options for the AutoGen Definitions output 160# configuration options for the AutoGen Definitions output
701#--------------------------------------------------------------------------- 161#---------------------------------------------------------------------------
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 162GENERATE_AUTOGEN_DEF = NO
710 163#---------------------------------------------------------------------------
164# configuration options related to the Perl module output
165#---------------------------------------------------------------------------
166GENERATE_PERLMOD = NO
167PERLMOD_LATEX = NO
168PERLMOD_PRETTY = YES
169PERLMOD_MAKEVAR_PREFIX =
711#--------------------------------------------------------------------------- 170#---------------------------------------------------------------------------
712# Configuration options related to the preprocessor 171# Configuration options related to the preprocessor
713#--------------------------------------------------------------------------- 172#---------------------------------------------------------------------------
714 173ENABLE_PREPROCESSING = NO
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 174MACRO_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 175EXPAND_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 176SEARCH_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 = 177INCLUDE_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 = 178INCLUDE_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 179PREDEFINED = 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 = 180EXPAND_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 181SKIP_FUNCTION_MACROS = YES
773
774#--------------------------------------------------------------------------- 182#---------------------------------------------------------------------------
775# Configuration::addtions related to external references 183# Configuration::addtions related to external references
776#--------------------------------------------------------------------------- 184#---------------------------------------------------------------------------
777
778# The TAGFILES tag can be used to specify one or more tagfiles.
779
780TAGFILES = 185TAGFILES =
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 = 186GENERATE_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 187ALLEXTERNALS = 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 188EXTERNAL_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 = 189PERL_PATH =
803
804#--------------------------------------------------------------------------- 190#---------------------------------------------------------------------------
805# Configuration options related to the dot tool 191# Configuration options related to the dot tool
806#--------------------------------------------------------------------------- 192#---------------------------------------------------------------------------
807 193CLASS_DIAGRAMS = NO
808# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 194HIDE_UNDOC_RELATIONS = NO
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 195HAVE_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 196CLASS_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 197COLLABORATION_GRAPH = YES
836 198UML_LOOK = NO
837# If set to YES, the inheritance and collaboration graphs will show the
838# relations between templates and their instances.
839
840TEMPLATE_RELATIONS = YES 199TEMPLATE_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 200INCLUDE_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 201INCLUDED_BY_GRAPH = YES
861 202CALL_GRAPH = NO
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 203GRAPHICAL_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 204DOT_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 = 205DOT_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 = 206DOTFILE_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 207MAX_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 208MAX_DOT_GRAPH_HEIGHT = 640
899 209MAX_DOT_GRAPH_DEPTH = 0
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 210GENERATE_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 211DOT_CLEANUP = YES
911
912#--------------------------------------------------------------------------- 212#---------------------------------------------------------------------------
913# Configuration::addtions related to the search engine 213# Configuration::addtions related to the search engine
914#--------------------------------------------------------------------------- 214#---------------------------------------------------------------------------
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 215SEARCHENGINE = 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
index 60ef90b..b76761f 100644
--- a/doc/Doxyfile_pim
+++ b/doc/Doxyfile_pim
@@ -1,973 +1,220 @@
1# Doxyfile 1.2.15 1# Doxyfile 1.3.4
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 2
13#--------------------------------------------------------------------------- 3#---------------------------------------------------------------------------
14# General configuration options 4# Project related configuration options
15#--------------------------------------------------------------------------- 5#---------------------------------------------------------------------------
16 6PROJECT_NAME = "libopie PIM"
17# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 7PROJECT_NUMBER = "Version 1.1"
18# by quotes) that should identify the project. 8OUTPUT_DIRECTORY = ../../apidocs
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 9OUTPUT_LANGUAGE = English
44 10USE_WINDOWS_ENCODING = NO
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 11BRIEF_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 12REPEAT_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 13ALWAYS_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 14INLINE_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 15FULL_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 = 16STRIP_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 17SHORT_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 18JAVADOC_AUTOBRIEF = YES
175 19MULTILINE_CPP_IS_BRIEF = NO
176# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 20DETAILS_AT_TOP = NO
177# member inherits the documentation from any documented member that it
178# reimplements.
179
180INHERIT_DOCS = YES 21INHERIT_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 22DISTRIBUTE_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 23TAB_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 \ 24ALIASES = libdoc=@mainpage \
235 sect=<p><b> \ 25 sect=<p><b> \
236 reimplemented= \ 26 reimplemented= \
237 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \ 27 "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \
238 obsolete=@deprecated \ 28 obsolete=@deprecated \
239 ref= 29 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 30OPTIMIZE_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 31OPTIMIZE_OUTPUT_JAVA = NO
269 32SUBGROUPING = YES
270# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 33#---------------------------------------------------------------------------
271# at the bottom of the documentation of classes and structs. If set to YES the 34# Build related configuration options
272# list will mention the files that were used to generate the documentation. 35#---------------------------------------------------------------------------
273 36EXTRACT_ALL = NO
37EXTRACT_PRIVATE = NO
38EXTRACT_STATIC = YES
39EXTRACT_LOCAL_CLASSES = NO
40HIDE_UNDOC_MEMBERS = NO
41HIDE_UNDOC_CLASSES = YES
42HIDE_FRIEND_COMPOUNDS = NO
43HIDE_IN_BODY_DOCS = NO
44INTERNAL_DOCS = NO
45CASE_SENSE_NAMES = YES
46HIDE_SCOPE_NAMES = NO
47SHOW_INCLUDE_FILES = YES
48INLINE_INFO = YES
49SORT_MEMBER_DOCS = NO
50GENERATE_TODOLIST = YES
51GENERATE_TESTLIST = YES
52GENERATE_BUGLIST = YES
53GENERATE_DEPRECATEDLIST= YES
54ENABLED_SECTIONS =
55MAX_INITIALIZER_LINES = 30
274SHOW_USED_FILES = YES 56SHOW_USED_FILES = YES
275
276#--------------------------------------------------------------------------- 57#---------------------------------------------------------------------------
277# configuration options related to warning and progress messages 58# configuration options related to warning and progress messages
278#--------------------------------------------------------------------------- 59#---------------------------------------------------------------------------
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 60QUIET = 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 61WARNINGS = 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 62WARN_IF_UNDOCUMENTED = NO
296 63WARN_IF_DOC_ERROR = YES
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" 64WARN_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 65WARN_LOGFILE = Dox-Warning
309
310#--------------------------------------------------------------------------- 66#---------------------------------------------------------------------------
311# configuration options related to the input files 67# configuration options related to the input files
312#--------------------------------------------------------------------------- 68#---------------------------------------------------------------------------
313 69INPUT = .
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 \ 70FILE_PATTERNS = *.h \
329 *.cpp \ 71 *.cpp \
330 *.cc \ 72 *.cc \
331 *.hpp 73 *.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 74RECURSIVE = 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 = 75EXCLUDE =
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 76EXCLUDE_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.* \ 77EXCLUDE_PATTERNS = *.moc.* \
355 moc* \ 78 moc* \
356 *.all_cpp.* \ 79 *.all_cpp.* \
357 *unload.* \ 80 *unload.* \
358 */test/* \ 81 */test/* \
359 */tests/* 82 */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 = 83EXAMPLE_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 = 84EXAMPLE_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 85EXAMPLE_RECURSIVE = NO
380 86IMAGE_PATH = ../../apidocs/api
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 = 87INPUT_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 88FILTER_SOURCE_FILES = NO
401
402#--------------------------------------------------------------------------- 89#---------------------------------------------------------------------------
403# configuration options related to source browsing 90# configuration options related to source browsing
404#--------------------------------------------------------------------------- 91#---------------------------------------------------------------------------
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 92SOURCE_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 93INLINE_SOURCES = NO
415 94STRIP_CODE_COMMENTS = YES
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 95REFERENCED_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 96REFERENCES_RELATION = YES
427 97VERBATIM_HEADERS = YES
428#--------------------------------------------------------------------------- 98#---------------------------------------------------------------------------
429# configuration options related to the alphabetical class index 99# configuration options related to the alphabetical class index
430#--------------------------------------------------------------------------- 100#---------------------------------------------------------------------------
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 101ALPHABETICAL_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 102COLS_IN_ALPHA_INDEX = 3
443 103IGNORE_PREFIX = O
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#--------------------------------------------------------------------------- 104#---------------------------------------------------------------------------
452# configuration options related to the HTML output 105# configuration options related to the HTML output
453#--------------------------------------------------------------------------- 106#---------------------------------------------------------------------------
454 107GENERATE_HTML = YES
455# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 108HTML_OUTPUT = pim/html
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 109HTML_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 110HTML_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 111HTML_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 112HTML_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 113HTML_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 114GENERATE_HTMLHELP = NO
503 115CHM_FILE =
504# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 116HHC_LOCATION =
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 117GENERATE_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 118BINARY_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 119TOC_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 120DISABLE_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 121ENUM_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 122GENERATE_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 123TREEVIEW_WIDTH = 250
547
548#--------------------------------------------------------------------------- 124#---------------------------------------------------------------------------
549# configuration options related to the LaTeX output 125# configuration options related to the LaTeX output
550#--------------------------------------------------------------------------- 126#---------------------------------------------------------------------------
551
552# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
553# generate Latex output.
554
555GENERATE_LATEX = NO 127GENERATE_LATEX = NO
556 128LATEX_OUTPUT = pim/latex
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 129LATEX_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 130MAKEINDEX_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 131COMPACT_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 132PAPER_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 = 133EXTRA_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 = 134LATEX_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 135PDF_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 136USE_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 137LATEX_BATCHMODE = NO
616 138LATEX_HIDE_INDICES = NO
617#--------------------------------------------------------------------------- 139#---------------------------------------------------------------------------
618# configuration options related to the RTF output 140# configuration options related to the RTF output
619#--------------------------------------------------------------------------- 141#---------------------------------------------------------------------------
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 142GENERATE_RTF = NO
626 143RTF_OUTPUT = pim/rtf
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 144COMPACT_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 145RTF_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 = 146RTF_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 = 147RTF_EXTENSIONS_FILE =
658
659#--------------------------------------------------------------------------- 148#---------------------------------------------------------------------------
660# configuration options related to the man page output 149# configuration options related to the man page output
661#--------------------------------------------------------------------------- 150#---------------------------------------------------------------------------
662
663# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
664# generate man pages
665
666GENERATE_MAN = NO 151GENERATE_MAN = NO
667 152MAN_OUTPUT = pim/man
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 153MAN_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 154MAN_LINKS = YES
686
687#--------------------------------------------------------------------------- 155#---------------------------------------------------------------------------
688# configuration options related to the XML output 156# configuration options related to the XML output
689#--------------------------------------------------------------------------- 157#---------------------------------------------------------------------------
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 158GENERATE_XML = NO
698 159XML_OUTPUT = xml
160XML_SCHEMA =
161XML_DTD =
699#--------------------------------------------------------------------------- 162#---------------------------------------------------------------------------
700# configuration options for the AutoGen Definitions output 163# configuration options for the AutoGen Definitions output
701#--------------------------------------------------------------------------- 164#---------------------------------------------------------------------------
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 165GENERATE_AUTOGEN_DEF = NO
710 166#---------------------------------------------------------------------------
167# configuration options related to the Perl module output
168#---------------------------------------------------------------------------
169GENERATE_PERLMOD = NO
170PERLMOD_LATEX = NO
171PERLMOD_PRETTY = YES
172PERLMOD_MAKEVAR_PREFIX =
711#--------------------------------------------------------------------------- 173#---------------------------------------------------------------------------
712# Configuration options related to the preprocessor 174# Configuration options related to the preprocessor
713#--------------------------------------------------------------------------- 175#---------------------------------------------------------------------------
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 176ENABLE_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 177MACRO_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 178EXPAND_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 179SEARCH_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 = 180INCLUDE_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 = 181INCLUDE_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 182PREDEFINED = 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 = 183EXPAND_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 184SKIP_FUNCTION_MACROS = YES
773
774#--------------------------------------------------------------------------- 185#---------------------------------------------------------------------------
775# Configuration::addtions related to external references 186# Configuration::addtions related to external references
776#--------------------------------------------------------------------------- 187#---------------------------------------------------------------------------
777 188TAGFILES = ../../apidocs/qt/qt.tag=../../qt/ \
778# The TAGFILES tag can be used to specify one or more tagfiles. 189 ../../apidocs/libqpe/libqpe.tag=../../libqpe/html \
779 190 ../../apidocs/libopie/libopie.tag=../../libopie/html
780TAGFILES = 191GENERATE_TAGFILE = ../../apidocs/pim/pim.tag
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 192ALLEXTERNALS = 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 193EXTERNAL_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 = 194PERL_PATH =
803
804#--------------------------------------------------------------------------- 195#---------------------------------------------------------------------------
805# Configuration options related to the dot tool 196# Configuration options related to the dot tool
806#--------------------------------------------------------------------------- 197#---------------------------------------------------------------------------
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 198CLASS_DIAGRAMS = YES
815 199HIDE_UNDOC_RELATIONS = NO
816# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 200HAVE_DOT = YES
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 201CLASS_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 202COLLABORATION_GRAPH = YES
836 203UML_LOOK = NO
837# If set to YES, the inheritance and collaboration graphs will show the
838# relations between templates and their instances.
839
840TEMPLATE_RELATIONS = YES 204TEMPLATE_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 205INCLUDE_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 206INCLUDED_BY_GRAPH = YES
861 207CALL_GRAPH = NO
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 208GRAPHICAL_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 209DOT_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 = 210DOT_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 = 211DOTFILE_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 212MAX_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 213MAX_DOT_GRAPH_HEIGHT = 1024
899 214MAX_DOT_GRAPH_DEPTH = 0
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 215GENERATE_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 216DOT_CLEANUP = YES
911
912#--------------------------------------------------------------------------- 217#---------------------------------------------------------------------------
913# Configuration::addtions related to the search engine 218# Configuration::addtions related to the search engine
914#--------------------------------------------------------------------------- 219#---------------------------------------------------------------------------
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 220SEARCHENGINE = 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/Mainpage.dox b/doc/Mainpage.dox
new file mode 100755
index 0000000..4fb0d49
--- a/dev/null
+++ b/doc/Mainpage.dox
@@ -0,0 +1,30 @@
1/**
2 * @mainpage The OPIE API Reference
3 *
4 * This section contains the OPIE online class reference for the current
5 * development version of OPIE. You can also download (???&nbsp;MB)
6 * the complete API documentation. Additionally, you can subscribe or
7 * read the mailing lists for any additions and/or modifications to the API.
8 *
9 * - <a href="qt/index.html"><b>qt</b></a>
10 * (<a href="qt/classes.html">classes</a>)\n
11 * <i>Qt classes</i>
12 * - <a href="libqpe/html/index.html"><b>Qtopia library</b></a>
13 * (<a href="libqpe/html/classes.html">classes</a>)\n
14 * <i>Qtopia lib</i>
15 * - <a href="libopie/html/index.html"><b>libopie</b></a>
16 * (<a href="libopie/html/classes.html">classes</a>)\n
17 * <i>libopie</i>
18 * - <a href="pim/html/index.html"><b>PIM</b></a>
19 * (<a href="pim/html/classes.html">classes</a>)\n
20 * <i>Libopie PIM</i>
21 *
22 */
23
24/**
25 * @page search Search the API documentation
26 *
27 * <br>Under construction.
28 *
29 */
30