| author | zecke <zecke> | 2004-03-06 15:12:31 (UTC) |
|---|---|---|
| committer | zecke <zecke> | 2004-03-06 15:12:31 (UTC) |
| commit | e580a1336207665b2009fcb0a928354fd07883e7 (patch) (unidiff) | |
| tree | 168555e250ba3266c81a933b408db4da475cda01 | |
| parent | e605df00284707a6dc4dd2ba51962531d43a5bea (diff) | |
| download | opie-e580a1336207665b2009fcb0a928354fd07883e7.zip opie-e580a1336207665b2009fcb0a928354fd07883e7.tar.gz opie-e580a1336207665b2009fcb0a928354fd07883e7.tar.bz2 | |
Add Opie2 Docu
| -rw-r--r-- | doc/Doxyfile_core2 | 224 | ||||
| -rw-r--r-- | doc/Doxyfile_db2 | 226 | ||||
| -rw-r--r-- | doc/Doxyfile_mm2 | 226 | ||||
| -rw-r--r-- | doc/Doxyfile_net2 | 226 | ||||
| -rw-r--r-- | doc/Doxyfile_pim2 | 229 | ||||
| -rw-r--r-- | doc/Doxyfile_ui2 | 228 | ||||
| -rwxr-xr-x | doc/Mainpage.dox | 21 | ||||
| -rwxr-xr-x | doc/generate_apidox | 47 |
8 files changed, 1425 insertions, 2 deletions
diff --git a/doc/Doxyfile_core2 b/doc/Doxyfile_core2 new file mode 100644 index 0000000..2f38efc --- a/dev/null +++ b/doc/Doxyfile_core2 | |||
| @@ -0,0 +1,224 @@ | |||
| 1 | # Doxyfile 1.3.5 | ||
| 2 | |||
| 3 | #--------------------------------------------------------------------------- | ||
| 4 | # Project related configuration options | ||
| 5 | #--------------------------------------------------------------------------- | ||
| 6 | PROJECT_NAME = "Libopie2 Core" | ||
| 7 | PROJECT_NUMBER = "Version 1.2" | ||
| 8 | OUTPUT_DIRECTORY = ../../apidocs | ||
| 9 | OUTPUT_LANGUAGE = English | ||
| 10 | USE_WINDOWS_ENCODING = NO | ||
| 11 | BRIEF_MEMBER_DESC = YES | ||
| 12 | REPEAT_BRIEF = YES | ||
| 13 | ABBREVIATE_BRIEF = | ||
| 14 | ALWAYS_DETAILED_SEC = YES | ||
| 15 | INLINE_INHERITED_MEMB = NO | ||
| 16 | FULL_PATH_NAMES = NO | ||
| 17 | STRIP_FROM_PATH = | ||
| 18 | SHORT_NAMES = NO | ||
| 19 | JAVADOC_AUTOBRIEF = YES | ||
| 20 | MULTILINE_CPP_IS_BRIEF = NO | ||
| 21 | DETAILS_AT_TOP = NO | ||
| 22 | INHERIT_DOCS = YES | ||
| 23 | DISTRIBUTE_GROUP_DOC = NO | ||
| 24 | TAB_SIZE = 4 | ||
| 25 | ALIASES = libdoc=@mainpage \ | ||
| 26 | sect=<p><b> \ | ||
| 27 | reimplemented= \ | ||
| 28 | "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \ | ||
| 29 | obsolete=@deprecated \ | ||
| 30 | ref= \ | ||
| 31 | slash=/ | ||
| 32 | OPTIMIZE_OUTPUT_FOR_C = NO | ||
| 33 | OPTIMIZE_OUTPUT_JAVA = NO | ||
| 34 | SUBGROUPING = YES | ||
| 35 | #--------------------------------------------------------------------------- | ||
| 36 | # Build related configuration options | ||
| 37 | #--------------------------------------------------------------------------- | ||
| 38 | EXTRACT_ALL = YES | ||
| 39 | EXTRACT_PRIVATE = NO | ||
| 40 | EXTRACT_STATIC = YES | ||
| 41 | EXTRACT_LOCAL_CLASSES = NO | ||
| 42 | HIDE_UNDOC_MEMBERS = NO | ||
| 43 | HIDE_UNDOC_CLASSES = NO | ||
| 44 | HIDE_FRIEND_COMPOUNDS = NO | ||
| 45 | HIDE_IN_BODY_DOCS = NO | ||
| 46 | INTERNAL_DOCS = NO | ||
| 47 | CASE_SENSE_NAMES = YES | ||
| 48 | HIDE_SCOPE_NAMES = NO | ||
| 49 | SHOW_INCLUDE_FILES = YES | ||
| 50 | INLINE_INFO = YES | ||
| 51 | SORT_MEMBER_DOCS = NO | ||
| 52 | GENERATE_TODOLIST = YES | ||
| 53 | GENERATE_TESTLIST = YES | ||
| 54 | GENERATE_BUGLIST = YES | ||
| 55 | GENERATE_DEPRECATEDLIST= YES | ||
| 56 | ENABLED_SECTIONS = | ||
| 57 | MAX_INITIALIZER_LINES = 30 | ||
| 58 | SHOW_USED_FILES = YES | ||
| 59 | #--------------------------------------------------------------------------- | ||
| 60 | # configuration options related to warning and progress messages | ||
| 61 | #--------------------------------------------------------------------------- | ||
| 62 | QUIET = YES | ||
| 63 | WARNINGS = YES | ||
| 64 | WARN_IF_UNDOCUMENTED = NO | ||
| 65 | WARN_IF_DOC_ERROR = YES | ||
| 66 | WARN_FORMAT = "$file:$line: $text" | ||
| 67 | WARN_LOGFILE = Dox-Warning | ||
| 68 | #--------------------------------------------------------------------------- | ||
| 69 | # configuration options related to the input files | ||
| 70 | #--------------------------------------------------------------------------- | ||
| 71 | INPUT = . \ | ||
| 72 | device | ||
| 73 | FILE_PATTERNS = *.h \ | ||
| 74 | *.cpp \ | ||
| 75 | *.cc \ | ||
| 76 | *.hpp | ||
| 77 | RECURSIVE = NO | ||
| 78 | EXCLUDE = | ||
| 79 | EXCLUDE_SYMLINKS = NO | ||
| 80 | EXCLUDE_PATTERNS = *.moc.* \ | ||
| 81 | moc* \ | ||
| 82 | *.all_cpp.* \ | ||
| 83 | *unload.* \ | ||
| 84 | */test/* \ | ||
| 85 | */tests/* | ||
| 86 | EXAMPLE_PATH = | ||
| 87 | EXAMPLE_PATTERNS = | ||
| 88 | EXAMPLE_RECURSIVE = NO | ||
| 89 | IMAGE_PATH = ../../apidocs/api | ||
| 90 | INPUT_FILTER = | ||
| 91 | FILTER_SOURCE_FILES = NO | ||
| 92 | #--------------------------------------------------------------------------- | ||
| 93 | # configuration options related to source browsing | ||
| 94 | #--------------------------------------------------------------------------- | ||
| 95 | SOURCE_BROWSER = YES | ||
| 96 | INLINE_SOURCES = NO | ||
| 97 | STRIP_CODE_COMMENTS = YES | ||
| 98 | REFERENCED_BY_RELATION = YES | ||
| 99 | REFERENCES_RELATION = YES | ||
| 100 | VERBATIM_HEADERS = YES | ||
| 101 | #--------------------------------------------------------------------------- | ||
| 102 | # configuration options related to the alphabetical class index | ||
| 103 | #--------------------------------------------------------------------------- | ||
| 104 | ALPHABETICAL_INDEX = YES | ||
| 105 | COLS_IN_ALPHA_INDEX = 3 | ||
| 106 | IGNORE_PREFIX = Opie::Core::0 \ | ||
| 107 | O | ||
| 108 | #--------------------------------------------------------------------------- | ||
| 109 | # configuration options related to the HTML output | ||
| 110 | #--------------------------------------------------------------------------- | ||
| 111 | GENERATE_HTML = YES | ||
| 112 | HTML_OUTPUT = core2/html | ||
| 113 | HTML_FILE_EXTENSION = .html | ||
| 114 | HTML_HEADER = ../../apidocs/common/header.html | ||
| 115 | HTML_FOOTER = ../../apidocs/common/footer.html | ||
| 116 | HTML_STYLESHEET = ../../apidocs/common/doxygen.css | ||
| 117 | HTML_ALIGN_MEMBERS = YES | ||
| 118 | GENERATE_HTMLHELP = NO | ||
| 119 | CHM_FILE = | ||
| 120 | HHC_LOCATION = | ||
| 121 | GENERATE_CHI = NO | ||
| 122 | BINARY_TOC = NO | ||
| 123 | TOC_EXPAND = NO | ||
| 124 | DISABLE_INDEX = YES | ||
| 125 | ENUM_VALUES_PER_LINE = 4 | ||
| 126 | GENERATE_TREEVIEW = NO | ||
| 127 | TREEVIEW_WIDTH = 250 | ||
| 128 | #--------------------------------------------------------------------------- | ||
| 129 | # configuration options related to the LaTeX output | ||
| 130 | #--------------------------------------------------------------------------- | ||
| 131 | GENERATE_LATEX = NO | ||
| 132 | LATEX_OUTPUT = pim/latex | ||
| 133 | LATEX_CMD_NAME = latex | ||
| 134 | MAKEINDEX_CMD_NAME = makeindex | ||
| 135 | COMPACT_LATEX = NO | ||
| 136 | PAPER_TYPE = a4wide | ||
| 137 | EXTRA_PACKAGES = | ||
| 138 | LATEX_HEADER = | ||
| 139 | PDF_HYPERLINKS = NO | ||
| 140 | USE_PDFLATEX = NO | ||
| 141 | LATEX_BATCHMODE = NO | ||
| 142 | LATEX_HIDE_INDICES = NO | ||
| 143 | #--------------------------------------------------------------------------- | ||
| 144 | # configuration options related to the RTF output | ||
| 145 | #--------------------------------------------------------------------------- | ||
| 146 | GENERATE_RTF = NO | ||
| 147 | RTF_OUTPUT = pim/rtf | ||
| 148 | COMPACT_RTF = NO | ||
| 149 | RTF_HYPERLINKS = NO | ||
| 150 | RTF_STYLESHEET_FILE = | ||
| 151 | RTF_EXTENSIONS_FILE = | ||
| 152 | #--------------------------------------------------------------------------- | ||
| 153 | # configuration options related to the man page output | ||
| 154 | #--------------------------------------------------------------------------- | ||
| 155 | GENERATE_MAN = NO | ||
| 156 | MAN_OUTPUT = pim/man | ||
| 157 | MAN_EXTENSION = .kde3 | ||
| 158 | MAN_LINKS = YES | ||
| 159 | #--------------------------------------------------------------------------- | ||
| 160 | # configuration options related to the XML output | ||
| 161 | #--------------------------------------------------------------------------- | ||
| 162 | GENERATE_XML = NO | ||
| 163 | XML_OUTPUT = xml | ||
| 164 | XML_SCHEMA = | ||
| 165 | XML_DTD = | ||
| 166 | XML_PROGRAMLISTING = YES | ||
| 167 | #--------------------------------------------------------------------------- | ||
| 168 | # configuration options for the AutoGen Definitions output | ||
| 169 | #--------------------------------------------------------------------------- | ||
| 170 | GENERATE_AUTOGEN_DEF = NO | ||
| 171 | #--------------------------------------------------------------------------- | ||
| 172 | # configuration options related to the Perl module output | ||
| 173 | #--------------------------------------------------------------------------- | ||
| 174 | GENERATE_PERLMOD = NO | ||
| 175 | PERLMOD_LATEX = NO | ||
| 176 | PERLMOD_PRETTY = YES | ||
| 177 | PERLMOD_MAKEVAR_PREFIX = | ||
| 178 | #--------------------------------------------------------------------------- | ||
| 179 | # Configuration options related to the preprocessor | ||
| 180 | #--------------------------------------------------------------------------- | ||
| 181 | ENABLE_PREPROCESSING = YES | ||
| 182 | MACRO_EXPANSION = NO | ||
| 183 | EXPAND_ONLY_PREDEF = NO | ||
| 184 | SEARCH_INCLUDES = YES | ||
| 185 | INCLUDE_PATH = | ||
| 186 | INCLUDE_FILE_PATTERNS = | ||
| 187 | PREDEFINED = | ||
| 188 | EXPAND_AS_DEFINED = | ||
| 189 | SKIP_FUNCTION_MACROS = YES | ||
| 190 | #--------------------------------------------------------------------------- | ||
| 191 | # Configuration::addtions related to external references | ||
| 192 | #--------------------------------------------------------------------------- | ||
| 193 | TAGFILES = ../../apidocs/qt/qt.tag=../../qt/ \ | ||
| 194 | ../../apidocs/libqpe/libqpe.tag=../../libqpe/html | ||
| 195 | GENERATE_TAGFILE = ../../apidocs/core2/core2.tag | ||
| 196 | ALLEXTERNALS = NO | ||
| 197 | EXTERNAL_GROUPS = NO | ||
| 198 | PERL_PATH = | ||
| 199 | #--------------------------------------------------------------------------- | ||
| 200 | # Configuration options related to the dot tool | ||
| 201 | #--------------------------------------------------------------------------- | ||
| 202 | CLASS_DIAGRAMS = YES | ||
| 203 | HIDE_UNDOC_RELATIONS = NO | ||
| 204 | HAVE_DOT = YES | ||
| 205 | CLASS_GRAPH = YES | ||
| 206 | COLLABORATION_GRAPH = YES | ||
| 207 | UML_LOOK = NO | ||
| 208 | TEMPLATE_RELATIONS = YES | ||
| 209 | INCLUDE_GRAPH = YES | ||
| 210 | INCLUDED_BY_GRAPH = YES | ||
| 211 | CALL_GRAPH = NO | ||
| 212 | GRAPHICAL_HIERARCHY = NO | ||
| 213 | DOT_IMAGE_FORMAT = png | ||
| 214 | DOT_PATH = | ||
| 215 | DOTFILE_DIRS = | ||
| 216 | MAX_DOT_GRAPH_WIDTH = 800 | ||
| 217 | MAX_DOT_GRAPH_HEIGHT = 1024 | ||
| 218 | MAX_DOT_GRAPH_DEPTH = 0 | ||
| 219 | GENERATE_LEGEND = YES | ||
| 220 | DOT_CLEANUP = YES | ||
| 221 | #--------------------------------------------------------------------------- | ||
| 222 | # Configuration::addtions related to the search engine | ||
| 223 | #--------------------------------------------------------------------------- | ||
| 224 | SEARCHENGINE = NO | ||
diff --git a/doc/Doxyfile_db2 b/doc/Doxyfile_db2 new file mode 100644 index 0000000..d3b87c6 --- a/dev/null +++ b/doc/Doxyfile_db2 | |||
| @@ -0,0 +1,226 @@ | |||
| 1 | # Doxyfile 1.3.5 | ||
| 2 | |||
| 3 | #--------------------------------------------------------------------------- | ||
| 4 | # Project related configuration options | ||
| 5 | #--------------------------------------------------------------------------- | ||
| 6 | PROJECT_NAME = "Libopie DB2" | ||
| 7 | PROJECT_NUMBER = "Version 1.2" | ||
| 8 | OUTPUT_DIRECTORY = ../../apidocs | ||
| 9 | OUTPUT_LANGUAGE = English | ||
| 10 | USE_WINDOWS_ENCODING = NO | ||
| 11 | BRIEF_MEMBER_DESC = YES | ||
| 12 | REPEAT_BRIEF = YES | ||
| 13 | ABBREVIATE_BRIEF = | ||
| 14 | ALWAYS_DETAILED_SEC = YES | ||
| 15 | INLINE_INHERITED_MEMB = NO | ||
| 16 | FULL_PATH_NAMES = NO | ||
| 17 | STRIP_FROM_PATH = | ||
| 18 | SHORT_NAMES = NO | ||
| 19 | JAVADOC_AUTOBRIEF = YES | ||
| 20 | MULTILINE_CPP_IS_BRIEF = NO | ||
| 21 | DETAILS_AT_TOP = NO | ||
| 22 | INHERIT_DOCS = YES | ||
| 23 | DISTRIBUTE_GROUP_DOC = NO | ||
| 24 | TAB_SIZE = 4 | ||
| 25 | ALIASES = libdoc=@mainpage \ | ||
| 26 | sect=<p><b> \ | ||
| 27 | reimplemented= \ | ||
| 28 | "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \ | ||
| 29 | obsolete=@deprecated \ | ||
| 30 | ref= \ | ||
| 31 | slash=/ | ||
| 32 | OPTIMIZE_OUTPUT_FOR_C = NO | ||
| 33 | OPTIMIZE_OUTPUT_JAVA = NO | ||
| 34 | SUBGROUPING = YES | ||
| 35 | #--------------------------------------------------------------------------- | ||
| 36 | # Build related configuration options | ||
| 37 | #--------------------------------------------------------------------------- | ||
| 38 | EXTRACT_ALL = YES | ||
| 39 | EXTRACT_PRIVATE = NO | ||
| 40 | EXTRACT_STATIC = YES | ||
| 41 | EXTRACT_LOCAL_CLASSES = NO | ||
| 42 | HIDE_UNDOC_MEMBERS = NO | ||
| 43 | HIDE_UNDOC_CLASSES = NO | ||
| 44 | HIDE_FRIEND_COMPOUNDS = NO | ||
| 45 | HIDE_IN_BODY_DOCS = NO | ||
| 46 | INTERNAL_DOCS = NO | ||
| 47 | CASE_SENSE_NAMES = YES | ||
| 48 | HIDE_SCOPE_NAMES = NO | ||
| 49 | SHOW_INCLUDE_FILES = YES | ||
| 50 | INLINE_INFO = YES | ||
| 51 | SORT_MEMBER_DOCS = NO | ||
| 52 | GENERATE_TODOLIST = YES | ||
| 53 | GENERATE_TESTLIST = YES | ||
| 54 | GENERATE_BUGLIST = YES | ||
| 55 | GENERATE_DEPRECATEDLIST= YES | ||
| 56 | ENABLED_SECTIONS = | ||
| 57 | MAX_INITIALIZER_LINES = 30 | ||
| 58 | SHOW_USED_FILES = YES | ||
| 59 | #--------------------------------------------------------------------------- | ||
| 60 | # configuration options related to warning and progress messages | ||
| 61 | #--------------------------------------------------------------------------- | ||
| 62 | QUIET = YES | ||
| 63 | WARNINGS = YES | ||
| 64 | WARN_IF_UNDOCUMENTED = NO | ||
| 65 | WARN_IF_DOC_ERROR = YES | ||
| 66 | WARN_FORMAT = "$file:$line: $text" | ||
| 67 | WARN_LOGFILE = Dox-Warning | ||
| 68 | #--------------------------------------------------------------------------- | ||
| 69 | # configuration options related to the input files | ||
| 70 | #--------------------------------------------------------------------------- | ||
| 71 | INPUT = . | ||
| 72 | FILE_PATTERNS = *.h \ | ||
| 73 | *.cpp \ | ||
| 74 | *.cc \ | ||
| 75 | *.hpp | ||
| 76 | RECURSIVE = NO | ||
| 77 | EXCLUDE = | ||
| 78 | EXCLUDE_SYMLINKS = NO | ||
| 79 | EXCLUDE_PATTERNS = *.moc.* \ | ||
| 80 | moc* \ | ||
| 81 | *.all_cpp.* \ | ||
| 82 | *unload.* \ | ||
| 83 | */test/* \ | ||
| 84 | */tests/* | ||
| 85 | EXAMPLE_PATH = | ||
| 86 | EXAMPLE_PATTERNS = | ||
| 87 | EXAMPLE_RECURSIVE = NO | ||
| 88 | IMAGE_PATH = ../../apidocs/api | ||
| 89 | INPUT_FILTER = | ||
| 90 | FILTER_SOURCE_FILES = NO | ||
| 91 | #--------------------------------------------------------------------------- | ||
| 92 | # configuration options related to source browsing | ||
| 93 | #--------------------------------------------------------------------------- | ||
| 94 | SOURCE_BROWSER = YES | ||
| 95 | INLINE_SOURCES = NO | ||
| 96 | STRIP_CODE_COMMENTS = YES | ||
| 97 | REFERENCED_BY_RELATION = YES | ||
| 98 | REFERENCES_RELATION = YES | ||
| 99 | VERBATIM_HEADERS = YES | ||
| 100 | #--------------------------------------------------------------------------- | ||
| 101 | # configuration options related to the alphabetical class index | ||
| 102 | #--------------------------------------------------------------------------- | ||
| 103 | ALPHABETICAL_INDEX = YES | ||
| 104 | COLS_IN_ALPHA_INDEX = 3 | ||
| 105 | IGNORE_PREFIX = Opie::Core::O \ | ||
| 106 | Opie::DB::O \ | ||
| 107 | O | ||
| 108 | |||
| 109 | #--------------------------------------------------------------------------- | ||
| 110 | # configuration options related to the HTML output | ||
| 111 | #--------------------------------------------------------------------------- | ||
| 112 | GENERATE_HTML = YES | ||
| 113 | HTML_OUTPUT = db2/html | ||
| 114 | HTML_FILE_EXTENSION = .html | ||
| 115 | HTML_HEADER = ../../apidocs/common/header.html | ||
| 116 | HTML_FOOTER = ../../apidocs/common/footer.html | ||
| 117 | HTML_STYLESHEET = ../../apidocs/common/doxygen.css | ||
| 118 | HTML_ALIGN_MEMBERS = YES | ||
| 119 | GENERATE_HTMLHELP = NO | ||
| 120 | CHM_FILE = | ||
| 121 | HHC_LOCATION = | ||
| 122 | GENERATE_CHI = NO | ||
| 123 | BINARY_TOC = NO | ||
| 124 | TOC_EXPAND = NO | ||
| 125 | DISABLE_INDEX = YES | ||
| 126 | ENUM_VALUES_PER_LINE = 4 | ||
| 127 | GENERATE_TREEVIEW = NO | ||
| 128 | TREEVIEW_WIDTH = 250 | ||
| 129 | #--------------------------------------------------------------------------- | ||
| 130 | # configuration options related to the LaTeX output | ||
| 131 | #--------------------------------------------------------------------------- | ||
| 132 | GENERATE_LATEX = NO | ||
| 133 | LATEX_OUTPUT = pim/latex | ||
| 134 | LATEX_CMD_NAME = latex | ||
| 135 | MAKEINDEX_CMD_NAME = makeindex | ||
| 136 | COMPACT_LATEX = NO | ||
| 137 | PAPER_TYPE = a4wide | ||
| 138 | EXTRA_PACKAGES = | ||
| 139 | LATEX_HEADER = | ||
| 140 | PDF_HYPERLINKS = NO | ||
| 141 | USE_PDFLATEX = NO | ||
| 142 | LATEX_BATCHMODE = NO | ||
| 143 | LATEX_HIDE_INDICES = NO | ||
| 144 | #--------------------------------------------------------------------------- | ||
| 145 | # configuration options related to the RTF output | ||
| 146 | #--------------------------------------------------------------------------- | ||
| 147 | GENERATE_RTF = NO | ||
| 148 | RTF_OUTPUT = pim/rtf | ||
| 149 | COMPACT_RTF = NO | ||
| 150 | RTF_HYPERLINKS = NO | ||
| 151 | RTF_STYLESHEET_FILE = | ||
| 152 | RTF_EXTENSIONS_FILE = | ||
| 153 | #--------------------------------------------------------------------------- | ||
| 154 | # configuration options related to the man page output | ||
| 155 | #--------------------------------------------------------------------------- | ||
| 156 | GENERATE_MAN = NO | ||
| 157 | MAN_OUTPUT = pim/man | ||
| 158 | MAN_EXTENSION = .kde3 | ||
| 159 | MAN_LINKS = YES | ||
| 160 | #--------------------------------------------------------------------------- | ||
| 161 | # configuration options related to the XML output | ||
| 162 | #--------------------------------------------------------------------------- | ||
| 163 | GENERATE_XML = NO | ||
| 164 | XML_OUTPUT = xml | ||
| 165 | XML_SCHEMA = | ||
| 166 | XML_DTD = | ||
| 167 | XML_PROGRAMLISTING = YES | ||
| 168 | #--------------------------------------------------------------------------- | ||
| 169 | # configuration options for the AutoGen Definitions output | ||
| 170 | #--------------------------------------------------------------------------- | ||
| 171 | GENERATE_AUTOGEN_DEF = NO | ||
| 172 | #--------------------------------------------------------------------------- | ||
| 173 | # configuration options related to the Perl module output | ||
| 174 | #--------------------------------------------------------------------------- | ||
| 175 | GENERATE_PERLMOD = NO | ||
| 176 | PERLMOD_LATEX = NO | ||
| 177 | PERLMOD_PRETTY = YES | ||
| 178 | PERLMOD_MAKEVAR_PREFIX = | ||
| 179 | #--------------------------------------------------------------------------- | ||
| 180 | # Configuration options related to the preprocessor | ||
| 181 | #--------------------------------------------------------------------------- | ||
| 182 | ENABLE_PREPROCESSING = YES | ||
| 183 | MACRO_EXPANSION = NO | ||
| 184 | EXPAND_ONLY_PREDEF = NO | ||
| 185 | SEARCH_INCLUDES = YES | ||
| 186 | INCLUDE_PATH = | ||
| 187 | INCLUDE_FILE_PATTERNS = | ||
| 188 | PREDEFINED = QT_VERSION=305 | ||
| 189 | EXPAND_AS_DEFINED = | ||
| 190 | SKIP_FUNCTION_MACROS = YES | ||
| 191 | #--------------------------------------------------------------------------- | ||
| 192 | # Configuration::addtions related to external references | ||
| 193 | #--------------------------------------------------------------------------- | ||
| 194 | TAGFILES = ../../apidocs/qt/qt.tag=../../qt/ \ | ||
| 195 | ../../apidocs/libqpe/libqpe.tag=../../libqpe/html \ | ||
| 196 | ../../apidocs/core2/core2.tag=../../core2/html | ||
| 197 | GENERATE_TAGFILE = ../../apidocs/db2/db2.tag | ||
| 198 | ALLEXTERNALS = NO | ||
| 199 | EXTERNAL_GROUPS = NO | ||
| 200 | PERL_PATH = | ||
| 201 | #--------------------------------------------------------------------------- | ||
| 202 | # Configuration options related to the dot tool | ||
| 203 | #--------------------------------------------------------------------------- | ||
| 204 | CLASS_DIAGRAMS = YES | ||
| 205 | HIDE_UNDOC_RELATIONS = NO | ||
| 206 | HAVE_DOT = YES | ||
| 207 | CLASS_GRAPH = YES | ||
| 208 | COLLABORATION_GRAPH = YES | ||
| 209 | UML_LOOK = NO | ||
| 210 | TEMPLATE_RELATIONS = YES | ||
| 211 | INCLUDE_GRAPH = YES | ||
| 212 | INCLUDED_BY_GRAPH = YES | ||
| 213 | CALL_GRAPH = NO | ||
| 214 | GRAPHICAL_HIERARCHY = NO | ||
| 215 | DOT_IMAGE_FORMAT = png | ||
| 216 | DOT_PATH = | ||
| 217 | DOTFILE_DIRS = | ||
| 218 | MAX_DOT_GRAPH_WIDTH = 800 | ||
| 219 | MAX_DOT_GRAPH_HEIGHT = 1024 | ||
| 220 | MAX_DOT_GRAPH_DEPTH = 0 | ||
| 221 | GENERATE_LEGEND = YES | ||
| 222 | DOT_CLEANUP = YES | ||
| 223 | #--------------------------------------------------------------------------- | ||
| 224 | # Configuration::addtions related to the search engine | ||
| 225 | #--------------------------------------------------------------------------- | ||
| 226 | SEARCHENGINE = NO | ||
diff --git a/doc/Doxyfile_mm2 b/doc/Doxyfile_mm2 new file mode 100644 index 0000000..33affaa --- a/dev/null +++ b/doc/Doxyfile_mm2 | |||
| @@ -0,0 +1,226 @@ | |||
| 1 | # Doxyfile 1.3.5 | ||
| 2 | |||
| 3 | #--------------------------------------------------------------------------- | ||
| 4 | # Project related configuration options | ||
| 5 | #--------------------------------------------------------------------------- | ||
| 6 | PROJECT_NAME = "Libopie2 MultiMedia 2" | ||
| 7 | PROJECT_NUMBER = "Version 1.2" | ||
| 8 | OUTPUT_DIRECTORY = ../../apidocs | ||
| 9 | OUTPUT_LANGUAGE = English | ||
| 10 | USE_WINDOWS_ENCODING = NO | ||
| 11 | BRIEF_MEMBER_DESC = YES | ||
| 12 | REPEAT_BRIEF = YES | ||
| 13 | ABBREVIATE_BRIEF = | ||
| 14 | ALWAYS_DETAILED_SEC = YES | ||
| 15 | INLINE_INHERITED_MEMB = NO | ||
| 16 | FULL_PATH_NAMES = NO | ||
| 17 | STRIP_FROM_PATH = | ||
| 18 | SHORT_NAMES = NO | ||
| 19 | JAVADOC_AUTOBRIEF = YES | ||
| 20 | MULTILINE_CPP_IS_BRIEF = NO | ||
| 21 | DETAILS_AT_TOP = NO | ||
| 22 | INHERIT_DOCS = YES | ||
| 23 | DISTRIBUTE_GROUP_DOC = NO | ||
| 24 | TAB_SIZE = 4 | ||
| 25 | ALIASES = libdoc=@mainpage \ | ||
| 26 | sect=<p><b> \ | ||
| 27 | reimplemented= \ | ||
| 28 | "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \ | ||
| 29 | obsolete=@deprecated \ | ||
| 30 | ref= \ | ||
| 31 | slash=/ | ||
| 32 | OPTIMIZE_OUTPUT_FOR_C = NO | ||
| 33 | OPTIMIZE_OUTPUT_JAVA = NO | ||
| 34 | SUBGROUPING = YES | ||
| 35 | #--------------------------------------------------------------------------- | ||
| 36 | # Build related configuration options | ||
| 37 | #--------------------------------------------------------------------------- | ||
| 38 | EXTRACT_ALL = YES | ||
| 39 | EXTRACT_PRIVATE = NO | ||
| 40 | EXTRACT_STATIC = YES | ||
| 41 | EXTRACT_LOCAL_CLASSES = NO | ||
| 42 | HIDE_UNDOC_MEMBERS = NO | ||
| 43 | HIDE_UNDOC_CLASSES = NO | ||
| 44 | HIDE_FRIEND_COMPOUNDS = NO | ||
| 45 | HIDE_IN_BODY_DOCS = NO | ||
| 46 | INTERNAL_DOCS = NO | ||
| 47 | CASE_SENSE_NAMES = YES | ||
| 48 | HIDE_SCOPE_NAMES = NO | ||
| 49 | SHOW_INCLUDE_FILES = YES | ||
| 50 | INLINE_INFO = YES | ||
| 51 | SORT_MEMBER_DOCS = NO | ||
| 52 | GENERATE_TODOLIST = YES | ||
| 53 | GENERATE_TESTLIST = YES | ||
| 54 | GENERATE_BUGLIST = YES | ||
| 55 | GENERATE_DEPRECATEDLIST= YES | ||
| 56 | ENABLED_SECTIONS = | ||
| 57 | MAX_INITIALIZER_LINES = 30 | ||
| 58 | SHOW_USED_FILES = YES | ||
| 59 | #--------------------------------------------------------------------------- | ||
| 60 | # configuration options related to warning and progress messages | ||
| 61 | #--------------------------------------------------------------------------- | ||
| 62 | QUIET = YES | ||
| 63 | WARNINGS = YES | ||
| 64 | WARN_IF_UNDOCUMENTED = NO | ||
| 65 | WARN_IF_DOC_ERROR = YES | ||
| 66 | WARN_FORMAT = "$file:$line: $text" | ||
| 67 | WARN_LOGFILE = Dox-Warning | ||
| 68 | #--------------------------------------------------------------------------- | ||
| 69 | # configuration options related to the input files | ||
| 70 | #--------------------------------------------------------------------------- | ||
| 71 | INPUT = . | ||
| 72 | FILE_PATTERNS = *.h \ | ||
| 73 | *.cpp \ | ||
| 74 | *.cc \ | ||
| 75 | *.hpp | ||
| 76 | RECURSIVE = NO | ||
| 77 | EXCLUDE = | ||
| 78 | EXCLUDE_SYMLINKS = NO | ||
| 79 | EXCLUDE_PATTERNS = *.moc.* \ | ||
| 80 | moc* \ | ||
| 81 | *.all_cpp.* \ | ||
| 82 | *unload.* \ | ||
| 83 | */test/* \ | ||
| 84 | */tests/* | ||
| 85 | EXAMPLE_PATH = | ||
| 86 | EXAMPLE_PATTERNS = | ||
| 87 | EXAMPLE_RECURSIVE = NO | ||
| 88 | IMAGE_PATH = ../../apidocs/api | ||
| 89 | INPUT_FILTER = | ||
| 90 | FILTER_SOURCE_FILES = NO | ||
| 91 | #--------------------------------------------------------------------------- | ||
| 92 | # configuration options related to source browsing | ||
| 93 | #--------------------------------------------------------------------------- | ||
| 94 | SOURCE_BROWSER = YES | ||
| 95 | INLINE_SOURCES = NO | ||
| 96 | STRIP_CODE_COMMENTS = YES | ||
| 97 | REFERENCED_BY_RELATION = YES | ||
| 98 | REFERENCES_RELATION = YES | ||
| 99 | VERBATIM_HEADERS = YES | ||
| 100 | #--------------------------------------------------------------------------- | ||
| 101 | # configuration options related to the alphabetical class index | ||
| 102 | #--------------------------------------------------------------------------- | ||
| 103 | ALPHABETICAL_INDEX = YES | ||
| 104 | COLS_IN_ALPHA_INDEX = 3 | ||
| 105 | IGNORE_PREFIX = Opie::Core::O \ | ||
| 106 | Opie::MM::O \ | ||
| 107 | O | ||
| 108 | |||
| 109 | #--------------------------------------------------------------------------- | ||
| 110 | # configuration options related to the HTML output | ||
| 111 | #--------------------------------------------------------------------------- | ||
| 112 | GENERATE_HTML = YES | ||
| 113 | HTML_OUTPUT = mm2/html | ||
| 114 | HTML_FILE_EXTENSION = .html | ||
| 115 | HTML_HEADER = ../../apidocs/common/header.html | ||
| 116 | HTML_FOOTER = ../../apidocs/common/footer.html | ||
| 117 | HTML_STYLESHEET = ../../apidocs/common/doxygen.css | ||
| 118 | HTML_ALIGN_MEMBERS = YES | ||
| 119 | GENERATE_HTMLHELP = NO | ||
| 120 | CHM_FILE = | ||
| 121 | HHC_LOCATION = | ||
| 122 | GENERATE_CHI = NO | ||
| 123 | BINARY_TOC = NO | ||
| 124 | TOC_EXPAND = NO | ||
| 125 | DISABLE_INDEX = YES | ||
| 126 | ENUM_VALUES_PER_LINE = 4 | ||
| 127 | GENERATE_TREEVIEW = NO | ||
| 128 | TREEVIEW_WIDTH = 250 | ||
| 129 | #--------------------------------------------------------------------------- | ||
| 130 | # configuration options related to the LaTeX output | ||
| 131 | #--------------------------------------------------------------------------- | ||
| 132 | GENERATE_LATEX = NO | ||
| 133 | LATEX_OUTPUT = pim/latex | ||
| 134 | LATEX_CMD_NAME = latex | ||
| 135 | MAKEINDEX_CMD_NAME = makeindex | ||
| 136 | COMPACT_LATEX = NO | ||
| 137 | PAPER_TYPE = a4wide | ||
| 138 | EXTRA_PACKAGES = | ||
| 139 | LATEX_HEADER = | ||
| 140 | PDF_HYPERLINKS = NO | ||
| 141 | USE_PDFLATEX = NO | ||
| 142 | LATEX_BATCHMODE = NO | ||
| 143 | LATEX_HIDE_INDICES = NO | ||
| 144 | #--------------------------------------------------------------------------- | ||
| 145 | # configuration options related to the RTF output | ||
| 146 | #--------------------------------------------------------------------------- | ||
| 147 | GENERATE_RTF = NO | ||
| 148 | RTF_OUTPUT = pim/rtf | ||
| 149 | COMPACT_RTF = NO | ||
| 150 | RTF_HYPERLINKS = NO | ||
| 151 | RTF_STYLESHEET_FILE = | ||
| 152 | RTF_EXTENSIONS_FILE = | ||
| 153 | #--------------------------------------------------------------------------- | ||
| 154 | # configuration options related to the man page output | ||
| 155 | #--------------------------------------------------------------------------- | ||
| 156 | GENERATE_MAN = NO | ||
| 157 | MAN_OUTPUT = pim/man | ||
| 158 | MAN_EXTENSION = .kde3 | ||
| 159 | MAN_LINKS = YES | ||
| 160 | #--------------------------------------------------------------------------- | ||
| 161 | # configuration options related to the XML output | ||
| 162 | #--------------------------------------------------------------------------- | ||
| 163 | GENERATE_XML = NO | ||
| 164 | XML_OUTPUT = xml | ||
| 165 | XML_SCHEMA = | ||
| 166 | XML_DTD = | ||
| 167 | XML_PROGRAMLISTING = YES | ||
| 168 | #--------------------------------------------------------------------------- | ||
| 169 | # configuration options for the AutoGen Definitions output | ||
| 170 | #--------------------------------------------------------------------------- | ||
| 171 | GENERATE_AUTOGEN_DEF = NO | ||
| 172 | #--------------------------------------------------------------------------- | ||
| 173 | # configuration options related to the Perl module output | ||
| 174 | #--------------------------------------------------------------------------- | ||
| 175 | GENERATE_PERLMOD = NO | ||
| 176 | PERLMOD_LATEX = NO | ||
| 177 | PERLMOD_PRETTY = YES | ||
| 178 | PERLMOD_MAKEVAR_PREFIX = | ||
| 179 | #--------------------------------------------------------------------------- | ||
| 180 | # Configuration options related to the preprocessor | ||
| 181 | #--------------------------------------------------------------------------- | ||
| 182 | ENABLE_PREPROCESSING = YES | ||
| 183 | MACRO_EXPANSION = NO | ||
| 184 | EXPAND_ONLY_PREDEF = NO | ||
| 185 | SEARCH_INCLUDES = YES | ||
| 186 | INCLUDE_PATH = | ||
| 187 | INCLUDE_FILE_PATTERNS = | ||
| 188 | PREDEFINED = QT_VERSION=305 | ||
| 189 | EXPAND_AS_DEFINED = | ||
| 190 | SKIP_FUNCTION_MACROS = YES | ||
| 191 | #--------------------------------------------------------------------------- | ||
| 192 | # Configuration::addtions related to external references | ||
| 193 | #--------------------------------------------------------------------------- | ||
| 194 | TAGFILES = ../../apidocs/qt/qt.tag=../../qt/ \ | ||
| 195 | ../../apidocs/libqpe/libqpe.tag=../../libqpe/html \ | ||
| 196 | ../../apidocs/core2/core2.tag=../../core2/html | ||
| 197 | GENERATE_TAGFILE = ../../apidocs/mm2/mm2.tag | ||
| 198 | ALLEXTERNALS = NO | ||
| 199 | EXTERNAL_GROUPS = NO | ||
| 200 | PERL_PATH = | ||
| 201 | #--------------------------------------------------------------------------- | ||
| 202 | # Configuration options related to the dot tool | ||
| 203 | #--------------------------------------------------------------------------- | ||
| 204 | CLASS_DIAGRAMS = YES | ||
| 205 | HIDE_UNDOC_RELATIONS = NO | ||
| 206 | HAVE_DOT = YES | ||
| 207 | CLASS_GRAPH = YES | ||
| 208 | COLLABORATION_GRAPH = YES | ||
| 209 | UML_LOOK = NO | ||
| 210 | TEMPLATE_RELATIONS = YES | ||
| 211 | INCLUDE_GRAPH = YES | ||
| 212 | INCLUDED_BY_GRAPH = YES | ||
| 213 | CALL_GRAPH = NO | ||
| 214 | GRAPHICAL_HIERARCHY = NO | ||
| 215 | DOT_IMAGE_FORMAT = png | ||
| 216 | DOT_PATH = | ||
| 217 | DOTFILE_DIRS = | ||
| 218 | MAX_DOT_GRAPH_WIDTH = 800 | ||
| 219 | MAX_DOT_GRAPH_HEIGHT = 1024 | ||
| 220 | MAX_DOT_GRAPH_DEPTH = 0 | ||
| 221 | GENERATE_LEGEND = YES | ||
| 222 | DOT_CLEANUP = YES | ||
| 223 | #--------------------------------------------------------------------------- | ||
| 224 | # Configuration::addtions related to the search engine | ||
| 225 | #--------------------------------------------------------------------------- | ||
| 226 | SEARCHENGINE = NO | ||
diff --git a/doc/Doxyfile_net2 b/doc/Doxyfile_net2 new file mode 100644 index 0000000..e87b9e9 --- a/dev/null +++ b/doc/Doxyfile_net2 | |||
| @@ -0,0 +1,226 @@ | |||
| 1 | # Doxyfile 1.3.5 | ||
| 2 | |||
| 3 | #--------------------------------------------------------------------------- | ||
| 4 | # Project related configuration options | ||
| 5 | #--------------------------------------------------------------------------- | ||
| 6 | PROJECT_NAME = "Libopie NET2" | ||
| 7 | PROJECT_NUMBER = "Version 1.2" | ||
| 8 | OUTPUT_DIRECTORY = ../../apidocs | ||
| 9 | OUTPUT_LANGUAGE = English | ||
| 10 | USE_WINDOWS_ENCODING = NO | ||
| 11 | BRIEF_MEMBER_DESC = YES | ||
| 12 | REPEAT_BRIEF = YES | ||
| 13 | ABBREVIATE_BRIEF = | ||
| 14 | ALWAYS_DETAILED_SEC = YES | ||
| 15 | INLINE_INHERITED_MEMB = NO | ||
| 16 | FULL_PATH_NAMES = NO | ||
| 17 | STRIP_FROM_PATH = | ||
| 18 | SHORT_NAMES = NO | ||
| 19 | JAVADOC_AUTOBRIEF = YES | ||
| 20 | MULTILINE_CPP_IS_BRIEF = NO | ||
| 21 | DETAILS_AT_TOP = NO | ||
| 22 | INHERIT_DOCS = YES | ||
| 23 | DISTRIBUTE_GROUP_DOC = NO | ||
| 24 | TAB_SIZE = 4 | ||
| 25 | ALIASES = libdoc=@mainpage \ | ||
| 26 | sect=<p><b> \ | ||
| 27 | reimplemented= \ | ||
| 28 | "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \ | ||
| 29 | obsolete=@deprecated \ | ||
| 30 | ref= \ | ||
| 31 | slash=/ | ||
| 32 | OPTIMIZE_OUTPUT_FOR_C = NO | ||
| 33 | OPTIMIZE_OUTPUT_JAVA = NO | ||
| 34 | SUBGROUPING = YES | ||
| 35 | #--------------------------------------------------------------------------- | ||
| 36 | # Build related configuration options | ||
| 37 | #--------------------------------------------------------------------------- | ||
| 38 | EXTRACT_ALL = YES | ||
| 39 | EXTRACT_PRIVATE = NO | ||
| 40 | EXTRACT_STATIC = YES | ||
| 41 | EXTRACT_LOCAL_CLASSES = NO | ||
| 42 | HIDE_UNDOC_MEMBERS = NO | ||
| 43 | HIDE_UNDOC_CLASSES = NO | ||
| 44 | HIDE_FRIEND_COMPOUNDS = NO | ||
| 45 | HIDE_IN_BODY_DOCS = NO | ||
| 46 | INTERNAL_DOCS = NO | ||
| 47 | CASE_SENSE_NAMES = YES | ||
| 48 | HIDE_SCOPE_NAMES = NO | ||
| 49 | SHOW_INCLUDE_FILES = YES | ||
| 50 | INLINE_INFO = YES | ||
| 51 | SORT_MEMBER_DOCS = NO | ||
| 52 | GENERATE_TODOLIST = YES | ||
| 53 | GENERATE_TESTLIST = YES | ||
| 54 | GENERATE_BUGLIST = YES | ||
| 55 | GENERATE_DEPRECATEDLIST= YES | ||
| 56 | ENABLED_SECTIONS = | ||
| 57 | MAX_INITIALIZER_LINES = 30 | ||
| 58 | SHOW_USED_FILES = YES | ||
| 59 | #--------------------------------------------------------------------------- | ||
| 60 | # configuration options related to warning and progress messages | ||
| 61 | #--------------------------------------------------------------------------- | ||
| 62 | QUIET = YES | ||
| 63 | WARNINGS = YES | ||
| 64 | WARN_IF_UNDOCUMENTED = NO | ||
| 65 | WARN_IF_DOC_ERROR = YES | ||
| 66 | WARN_FORMAT = "$file:$line: $text" | ||
| 67 | WARN_LOGFILE = Dox-Warning | ||
| 68 | #--------------------------------------------------------------------------- | ||
| 69 | # configuration options related to the input files | ||
| 70 | #--------------------------------------------------------------------------- | ||
| 71 | INPUT = . | ||
| 72 | FILE_PATTERNS = *.h \ | ||
| 73 | *.cpp \ | ||
| 74 | *.cc \ | ||
| 75 | *.hpp | ||
| 76 | RECURSIVE = NO | ||
| 77 | EXCLUDE = | ||
| 78 | EXCLUDE_SYMLINKS = NO | ||
| 79 | EXCLUDE_PATTERNS = *.moc.* \ | ||
| 80 | moc* \ | ||
| 81 | *.all_cpp.* \ | ||
| 82 | *unload.* \ | ||
| 83 | */test/* \ | ||
| 84 | */tests/* | ||
| 85 | EXAMPLE_PATH = | ||
| 86 | EXAMPLE_PATTERNS = | ||
| 87 | EXAMPLE_RECURSIVE = NO | ||
| 88 | IMAGE_PATH = ../../apidocs/api | ||
| 89 | INPUT_FILTER = | ||
| 90 | FILTER_SOURCE_FILES = NO | ||
| 91 | #--------------------------------------------------------------------------- | ||
| 92 | # configuration options related to source browsing | ||
| 93 | #--------------------------------------------------------------------------- | ||
| 94 | SOURCE_BROWSER = YES | ||
| 95 | INLINE_SOURCES = NO | ||
| 96 | STRIP_CODE_COMMENTS = YES | ||
| 97 | REFERENCED_BY_RELATION = YES | ||
| 98 | REFERENCES_RELATION = YES | ||
| 99 | VERBATIM_HEADERS = YES | ||
| 100 | #--------------------------------------------------------------------------- | ||
| 101 | # configuration options related to the alphabetical class index | ||
| 102 | #--------------------------------------------------------------------------- | ||
| 103 | ALPHABETICAL_INDEX = YES | ||
| 104 | COLS_IN_ALPHA_INDEX = 3 | ||
| 105 | IGNORE_PREFIX = Opie::Core::O \ | ||
| 106 | Opie::Net::O \ | ||
| 107 | O | ||
| 108 | |||
| 109 | #--------------------------------------------------------------------------- | ||
| 110 | # configuration options related to the HTML output | ||
| 111 | #--------------------------------------------------------------------------- | ||
| 112 | GENERATE_HTML = YES | ||
| 113 | HTML_OUTPUT = net2/html | ||
| 114 | HTML_FILE_EXTENSION = .html | ||
| 115 | HTML_HEADER = ../../apidocs/common/header.html | ||
| 116 | HTML_FOOTER = ../../apidocs/common/footer.html | ||
| 117 | HTML_STYLESHEET = ../../apidocs/common/doxygen.css | ||
| 118 | HTML_ALIGN_MEMBERS = YES | ||
| 119 | GENERATE_HTMLHELP = NO | ||
| 120 | CHM_FILE = | ||
| 121 | HHC_LOCATION = | ||
| 122 | GENERATE_CHI = NO | ||
| 123 | BINARY_TOC = NO | ||
| 124 | TOC_EXPAND = NO | ||
| 125 | DISABLE_INDEX = YES | ||
| 126 | ENUM_VALUES_PER_LINE = 4 | ||
| 127 | GENERATE_TREEVIEW = NO | ||
| 128 | TREEVIEW_WIDTH = 250 | ||
| 129 | #--------------------------------------------------------------------------- | ||
| 130 | # configuration options related to the LaTeX output | ||
| 131 | #--------------------------------------------------------------------------- | ||
| 132 | GENERATE_LATEX = NO | ||
| 133 | LATEX_OUTPUT = pim/latex | ||
| 134 | LATEX_CMD_NAME = latex | ||
| 135 | MAKEINDEX_CMD_NAME = makeindex | ||
| 136 | COMPACT_LATEX = NO | ||
| 137 | PAPER_TYPE = a4wide | ||
| 138 | EXTRA_PACKAGES = | ||
| 139 | LATEX_HEADER = | ||
| 140 | PDF_HYPERLINKS = NO | ||
| 141 | USE_PDFLATEX = NO | ||
| 142 | LATEX_BATCHMODE = NO | ||
| 143 | LATEX_HIDE_INDICES = NO | ||
| 144 | #--------------------------------------------------------------------------- | ||
| 145 | # configuration options related to the RTF output | ||
| 146 | #--------------------------------------------------------------------------- | ||
| 147 | GENERATE_RTF = NO | ||
| 148 | RTF_OUTPUT = pim/rtf | ||
| 149 | COMPACT_RTF = NO | ||
| 150 | RTF_HYPERLINKS = NO | ||
| 151 | RTF_STYLESHEET_FILE = | ||
| 152 | RTF_EXTENSIONS_FILE = | ||
| 153 | #--------------------------------------------------------------------------- | ||
| 154 | # configuration options related to the man page output | ||
| 155 | #--------------------------------------------------------------------------- | ||
| 156 | GENERATE_MAN = NO | ||
| 157 | MAN_OUTPUT = pim/man | ||
| 158 | MAN_EXTENSION = .kde3 | ||
| 159 | MAN_LINKS = YES | ||
| 160 | #--------------------------------------------------------------------------- | ||
| 161 | # configuration options related to the XML output | ||
| 162 | #--------------------------------------------------------------------------- | ||
| 163 | GENERATE_XML = NO | ||
| 164 | XML_OUTPUT = xml | ||
| 165 | XML_SCHEMA = | ||
| 166 | XML_DTD = | ||
| 167 | XML_PROGRAMLISTING = YES | ||
| 168 | #--------------------------------------------------------------------------- | ||
| 169 | # configuration options for the AutoGen Definitions output | ||
| 170 | #--------------------------------------------------------------------------- | ||
| 171 | GENERATE_AUTOGEN_DEF = NO | ||
| 172 | #--------------------------------------------------------------------------- | ||
| 173 | # configuration options related to the Perl module output | ||
| 174 | #--------------------------------------------------------------------------- | ||
| 175 | GENERATE_PERLMOD = NO | ||
| 176 | PERLMOD_LATEX = NO | ||
| 177 | PERLMOD_PRETTY = YES | ||
| 178 | PERLMOD_MAKEVAR_PREFIX = | ||
| 179 | #--------------------------------------------------------------------------- | ||
| 180 | # Configuration options related to the preprocessor | ||
| 181 | #--------------------------------------------------------------------------- | ||
| 182 | ENABLE_PREPROCESSING = YES | ||
| 183 | MACRO_EXPANSION = NO | ||
| 184 | EXPAND_ONLY_PREDEF = NO | ||
| 185 | SEARCH_INCLUDES = YES | ||
| 186 | INCLUDE_PATH = | ||
| 187 | INCLUDE_FILE_PATTERNS = | ||
| 188 | PREDEFINED = QT_VERSION=305 | ||
| 189 | EXPAND_AS_DEFINED = | ||
| 190 | SKIP_FUNCTION_MACROS = YES | ||
| 191 | #--------------------------------------------------------------------------- | ||
| 192 | # Configuration::addtions related to external references | ||
| 193 | #--------------------------------------------------------------------------- | ||
| 194 | TAGFILES = ../../apidocs/qt/qt.tag=../../qt/ \ | ||
| 195 | ../../apidocs/libqpe/libqpe.tag=../../libqpe/html \ | ||
| 196 | ../../apidocs/core2/core2.tag=../../core2/html | ||
| 197 | GENERATE_TAGFILE = ../../apidocs/net2/net2.tag | ||
| 198 | ALLEXTERNALS = NO | ||
| 199 | EXTERNAL_GROUPS = NO | ||
| 200 | PERL_PATH = | ||
| 201 | #--------------------------------------------------------------------------- | ||
| 202 | # Configuration options related to the dot tool | ||
| 203 | #--------------------------------------------------------------------------- | ||
| 204 | CLASS_DIAGRAMS = YES | ||
| 205 | HIDE_UNDOC_RELATIONS = NO | ||
| 206 | HAVE_DOT = YES | ||
| 207 | CLASS_GRAPH = YES | ||
| 208 | COLLABORATION_GRAPH = YES | ||
| 209 | UML_LOOK = NO | ||
| 210 | TEMPLATE_RELATIONS = YES | ||
| 211 | INCLUDE_GRAPH = YES | ||
| 212 | INCLUDED_BY_GRAPH = YES | ||
| 213 | CALL_GRAPH = NO | ||
| 214 | GRAPHICAL_HIERARCHY = NO | ||
| 215 | DOT_IMAGE_FORMAT = png | ||
| 216 | DOT_PATH = | ||
| 217 | DOTFILE_DIRS = | ||
| 218 | MAX_DOT_GRAPH_WIDTH = 800 | ||
| 219 | MAX_DOT_GRAPH_HEIGHT = 1024 | ||
| 220 | MAX_DOT_GRAPH_DEPTH = 0 | ||
| 221 | GENERATE_LEGEND = YES | ||
| 222 | DOT_CLEANUP = YES | ||
| 223 | #--------------------------------------------------------------------------- | ||
| 224 | # Configuration::addtions related to the search engine | ||
| 225 | #--------------------------------------------------------------------------- | ||
| 226 | SEARCHENGINE = NO | ||
diff --git a/doc/Doxyfile_pim2 b/doc/Doxyfile_pim2 new file mode 100644 index 0000000..476f7a6 --- a/dev/null +++ b/doc/Doxyfile_pim2 | |||
| @@ -0,0 +1,229 @@ | |||
| 1 | # Doxyfile 1.3.5 | ||
| 2 | |||
| 3 | #--------------------------------------------------------------------------- | ||
| 4 | # Project related configuration options | ||
| 5 | #--------------------------------------------------------------------------- | ||
| 6 | PROJECT_NAME = "libopie UI2" | ||
| 7 | PROJECT_NUMBER = "Version 1.2" | ||
| 8 | OUTPUT_DIRECTORY = ../../apidocs | ||
| 9 | OUTPUT_LANGUAGE = English | ||
| 10 | USE_WINDOWS_ENCODING = NO | ||
| 11 | BRIEF_MEMBER_DESC = YES | ||
| 12 | REPEAT_BRIEF = YES | ||
| 13 | ABBREVIATE_BRIEF = | ||
| 14 | ALWAYS_DETAILED_SEC = YES | ||
| 15 | INLINE_INHERITED_MEMB = NO | ||
| 16 | FULL_PATH_NAMES = NO | ||
| 17 | STRIP_FROM_PATH = | ||
| 18 | SHORT_NAMES = NO | ||
| 19 | JAVADOC_AUTOBRIEF = YES | ||
| 20 | MULTILINE_CPP_IS_BRIEF = NO | ||
| 21 | DETAILS_AT_TOP = NO | ||
| 22 | INHERIT_DOCS = YES | ||
| 23 | DISTRIBUTE_GROUP_DOC = NO | ||
| 24 | TAB_SIZE = 4 | ||
| 25 | ALIASES = libdoc=@mainpage \ | ||
| 26 | sect=<p><b> \ | ||
| 27 | reimplemented= \ | ||
| 28 | "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \ | ||
| 29 | obsolete=@deprecated \ | ||
| 30 | ref= \ | ||
| 31 | slash=/ | ||
| 32 | OPTIMIZE_OUTPUT_FOR_C = NO | ||
| 33 | OPTIMIZE_OUTPUT_JAVA = NO | ||
| 34 | SUBGROUPING = YES | ||
| 35 | #--------------------------------------------------------------------------- | ||
| 36 | # Build related configuration options | ||
| 37 | #--------------------------------------------------------------------------- | ||
| 38 | EXTRACT_ALL = YES | ||
| 39 | EXTRACT_PRIVATE = NO | ||
| 40 | EXTRACT_STATIC = YES | ||
| 41 | EXTRACT_LOCAL_CLASSES = NO | ||
| 42 | HIDE_UNDOC_MEMBERS = NO | ||
| 43 | HIDE_UNDOC_CLASSES = NO | ||
| 44 | HIDE_FRIEND_COMPOUNDS = NO | ||
| 45 | HIDE_IN_BODY_DOCS = NO | ||
| 46 | INTERNAL_DOCS = NO | ||
| 47 | CASE_SENSE_NAMES = YES | ||
| 48 | HIDE_SCOPE_NAMES = NO | ||
| 49 | SHOW_INCLUDE_FILES = YES | ||
| 50 | INLINE_INFO = YES | ||
| 51 | SORT_MEMBER_DOCS = NO | ||
| 52 | GENERATE_TODOLIST = YES | ||
| 53 | GENERATE_TESTLIST = YES | ||
| 54 | GENERATE_BUGLIST = YES | ||
| 55 | GENERATE_DEPRECATEDLIST= YES | ||
| 56 | ENABLED_SECTIONS = | ||
| 57 | MAX_INITIALIZER_LINES = 30 | ||
| 58 | SHOW_USED_FILES = YES | ||
| 59 | #--------------------------------------------------------------------------- | ||
| 60 | # configuration options related to warning and progress messages | ||
| 61 | #--------------------------------------------------------------------------- | ||
| 62 | QUIET = YES | ||
| 63 | WARNINGS = YES | ||
| 64 | WARN_IF_UNDOCUMENTED = NO | ||
| 65 | WARN_IF_DOC_ERROR = YES | ||
| 66 | WARN_FORMAT = "$file:$line: $text" | ||
| 67 | WARN_LOGFILE = Dox-Warning | ||
| 68 | #--------------------------------------------------------------------------- | ||
| 69 | # configuration options related to the input files | ||
| 70 | #--------------------------------------------------------------------------- | ||
| 71 | INPUT = . \ | ||
| 72 | ui \ | ||
| 73 | core | ||
| 74 | FILE_PATTERNS = *.h \ | ||
| 75 | *.cpp \ | ||
| 76 | *.cc \ | ||
| 77 | *.hpp | ||
| 78 | RECURSIVE = NO | ||
| 79 | EXCLUDE = | ||
| 80 | EXCLUDE_SYMLINKS = NO | ||
| 81 | EXCLUDE_PATTERNS = *.moc.* \ | ||
| 82 | moc* \ | ||
| 83 | *.all_cpp.* \ | ||
| 84 | *unload.* \ | ||
| 85 | */test/* \ | ||
| 86 | */tests/* | ||
| 87 | EXAMPLE_PATH = | ||
| 88 | EXAMPLE_PATTERNS = | ||
| 89 | EXAMPLE_RECURSIVE = NO | ||
| 90 | IMAGE_PATH = ../../apidocs/api | ||
| 91 | INPUT_FILTER = | ||
| 92 | FILTER_SOURCE_FILES = NO | ||
| 93 | #--------------------------------------------------------------------------- | ||
| 94 | # configuration options related to source browsing | ||
| 95 | #--------------------------------------------------------------------------- | ||
| 96 | SOURCE_BROWSER = YES | ||
| 97 | INLINE_SOURCES = NO | ||
| 98 | STRIP_CODE_COMMENTS = YES | ||
| 99 | REFERENCED_BY_RELATION = YES | ||
| 100 | REFERENCES_RELATION = YES | ||
| 101 | VERBATIM_HEADERS = YES | ||
| 102 | #--------------------------------------------------------------------------- | ||
| 103 | # configuration options related to the alphabetical class index | ||
| 104 | #--------------------------------------------------------------------------- | ||
| 105 | ALPHABETICAL_INDEX = YES | ||
| 106 | COLS_IN_ALPHA_INDEX = 3 | ||
| 107 | IGNORE_PREFIX = Opie::Core::O \ | ||
| 108 | Opie::Ui::O \ | ||
| 109 | Opie::Pim::OPim \ | ||
| 110 | Opie::Pim::O | ||
| 111 | #--------------------------------------------------------------------------- | ||
| 112 | # configuration options related to the HTML output | ||
| 113 | #--------------------------------------------------------------------------- | ||
| 114 | GENERATE_HTML = YES | ||
| 115 | HTML_OUTPUT = pim2/html | ||
| 116 | HTML_FILE_EXTENSION = .html | ||
| 117 | HTML_HEADER = ../../apidocs/common/header.html | ||
| 118 | HTML_FOOTER = ../../apidocs/common/footer.html | ||
| 119 | HTML_STYLESHEET = ../../apidocs/common/doxygen.css | ||
| 120 | HTML_ALIGN_MEMBERS = YES | ||
| 121 | GENERATE_HTMLHELP = NO | ||
| 122 | CHM_FILE = | ||
| 123 | HHC_LOCATION = | ||
| 124 | GENERATE_CHI = NO | ||
| 125 | BINARY_TOC = NO | ||
| 126 | TOC_EXPAND = NO | ||
| 127 | DISABLE_INDEX = YES | ||
| 128 | ENUM_VALUES_PER_LINE = 4 | ||
| 129 | GENERATE_TREEVIEW = NO | ||
| 130 | TREEVIEW_WIDTH = 250 | ||
| 131 | #--------------------------------------------------------------------------- | ||
| 132 | # configuration options related to the LaTeX output | ||
| 133 | #--------------------------------------------------------------------------- | ||
| 134 | GENERATE_LATEX = NO | ||
| 135 | LATEX_OUTPUT = pim/latex | ||
| 136 | LATEX_CMD_NAME = latex | ||
| 137 | MAKEINDEX_CMD_NAME = makeindex | ||
| 138 | COMPACT_LATEX = NO | ||
| 139 | PAPER_TYPE = a4wide | ||
| 140 | EXTRA_PACKAGES = | ||
| 141 | LATEX_HEADER = | ||
| 142 | PDF_HYPERLINKS = NO | ||
| 143 | USE_PDFLATEX = NO | ||
| 144 | LATEX_BATCHMODE = NO | ||
| 145 | LATEX_HIDE_INDICES = NO | ||
| 146 | #--------------------------------------------------------------------------- | ||
| 147 | # configuration options related to the RTF output | ||
| 148 | #--------------------------------------------------------------------------- | ||
| 149 | GENERATE_RTF = NO | ||
| 150 | RTF_OUTPUT = pim/rtf | ||
| 151 | COMPACT_RTF = NO | ||
| 152 | RTF_HYPERLINKS = NO | ||
| 153 | RTF_STYLESHEET_FILE = | ||
| 154 | RTF_EXTENSIONS_FILE = | ||
| 155 | #--------------------------------------------------------------------------- | ||
| 156 | # configuration options related to the man page output | ||
| 157 | #--------------------------------------------------------------------------- | ||
| 158 | GENERATE_MAN = NO | ||
| 159 | MAN_OUTPUT = pim/man | ||
| 160 | MAN_EXTENSION = .kde3 | ||
| 161 | MAN_LINKS = YES | ||
| 162 | #--------------------------------------------------------------------------- | ||
| 163 | # configuration options related to the XML output | ||
| 164 | #--------------------------------------------------------------------------- | ||
| 165 | GENERATE_XML = NO | ||
| 166 | XML_OUTPUT = xml | ||
| 167 | XML_SCHEMA = | ||
| 168 | XML_DTD = | ||
| 169 | XML_PROGRAMLISTING = YES | ||
| 170 | #--------------------------------------------------------------------------- | ||
| 171 | # configuration options for the AutoGen Definitions output | ||
| 172 | #--------------------------------------------------------------------------- | ||
| 173 | GENERATE_AUTOGEN_DEF = NO | ||
| 174 | #--------------------------------------------------------------------------- | ||
| 175 | # configuration options related to the Perl module output | ||
| 176 | #--------------------------------------------------------------------------- | ||
| 177 | GENERATE_PERLMOD = NO | ||
| 178 | PERLMOD_LATEX = NO | ||
| 179 | PERLMOD_PRETTY = YES | ||
| 180 | PERLMOD_MAKEVAR_PREFIX = | ||
| 181 | #--------------------------------------------------------------------------- | ||
| 182 | # Configuration options related to the preprocessor | ||
| 183 | #--------------------------------------------------------------------------- | ||
| 184 | ENABLE_PREPROCESSING = YES | ||
| 185 | MACRO_EXPANSION = NO | ||
| 186 | EXPAND_ONLY_PREDEF = NO | ||
| 187 | SEARCH_INCLUDES = YES | ||
| 188 | INCLUDE_PATH = | ||
| 189 | INCLUDE_FILE_PATTERNS = | ||
| 190 | PREDEFINED = | ||
| 191 | EXPAND_AS_DEFINED = | ||
| 192 | SKIP_FUNCTION_MACROS = YES | ||
| 193 | #--------------------------------------------------------------------------- | ||
| 194 | # Configuration::addtions related to external references | ||
| 195 | #--------------------------------------------------------------------------- | ||
| 196 | TAGFILES = ../../apidocs/qt/qt.tag=../../qt/ \ | ||
| 197 | ../../apidocs/libqpe/libqpe.tag=../../libqpe/html \ | ||
| 198 | ../../apidocs/core2/core2.tag=../../core2/html \ | ||
| 199 | ../../apidocs/ui2/ui2.tag=../../ui2/html | ||
| 200 | GENERATE_TAGFILE = ../../apidocs/pim2/pim2.tag | ||
| 201 | ALLEXTERNALS = NO | ||
| 202 | EXTERNAL_GROUPS = NO | ||
| 203 | PERL_PATH = | ||
| 204 | #--------------------------------------------------------------------------- | ||
| 205 | # Configuration options related to the dot tool | ||
| 206 | #--------------------------------------------------------------------------- | ||
| 207 | CLASS_DIAGRAMS = YES | ||
| 208 | HIDE_UNDOC_RELATIONS = NO | ||
| 209 | HAVE_DOT = YES | ||
| 210 | CLASS_GRAPH = YES | ||
| 211 | COLLABORATION_GRAPH = YES | ||
| 212 | UML_LOOK = NO | ||
| 213 | TEMPLATE_RELATIONS = YES | ||
| 214 | INCLUDE_GRAPH = YES | ||
| 215 | INCLUDED_BY_GRAPH = YES | ||
| 216 | CALL_GRAPH = NO | ||
| 217 | GRAPHICAL_HIERARCHY = NO | ||
| 218 | DOT_IMAGE_FORMAT = png | ||
| 219 | DOT_PATH = | ||
| 220 | DOTFILE_DIRS = | ||
| 221 | MAX_DOT_GRAPH_WIDTH = 800 | ||
| 222 | MAX_DOT_GRAPH_HEIGHT = 1024 | ||
| 223 | MAX_DOT_GRAPH_DEPTH = 0 | ||
| 224 | GENERATE_LEGEND = YES | ||
| 225 | DOT_CLEANUP = YES | ||
| 226 | #--------------------------------------------------------------------------- | ||
| 227 | # Configuration::addtions related to the search engine | ||
| 228 | #--------------------------------------------------------------------------- | ||
| 229 | SEARCHENGINE = NO | ||
diff --git a/doc/Doxyfile_ui2 b/doc/Doxyfile_ui2 new file mode 100644 index 0000000..bf6f0e8 --- a/dev/null +++ b/doc/Doxyfile_ui2 | |||
| @@ -0,0 +1,228 @@ | |||
| 1 | # Doxyfile 1.3.5 | ||
| 2 | |||
| 3 | #--------------------------------------------------------------------------- | ||
| 4 | # Project related configuration options | ||
| 5 | #--------------------------------------------------------------------------- | ||
| 6 | PROJECT_NAME = "libopie UI2" | ||
| 7 | PROJECT_NUMBER = "Version 1.2" | ||
| 8 | OUTPUT_DIRECTORY = ../../apidocs | ||
| 9 | OUTPUT_LANGUAGE = English | ||
| 10 | USE_WINDOWS_ENCODING = NO | ||
| 11 | BRIEF_MEMBER_DESC = YES | ||
| 12 | REPEAT_BRIEF = YES | ||
| 13 | ABBREVIATE_BRIEF = | ||
| 14 | ALWAYS_DETAILED_SEC = YES | ||
| 15 | INLINE_INHERITED_MEMB = NO | ||
| 16 | FULL_PATH_NAMES = NO | ||
| 17 | STRIP_FROM_PATH = | ||
| 18 | SHORT_NAMES = NO | ||
| 19 | JAVADOC_AUTOBRIEF = YES | ||
| 20 | MULTILINE_CPP_IS_BRIEF = NO | ||
| 21 | DETAILS_AT_TOP = NO | ||
| 22 | INHERIT_DOCS = YES | ||
| 23 | DISTRIBUTE_GROUP_DOC = NO | ||
| 24 | TAB_SIZE = 4 | ||
| 25 | ALIASES = libdoc=@mainpage \ | ||
| 26 | sect=<p><b> \ | ||
| 27 | reimplemented= \ | ||
| 28 | "deprecated=<b>This class or method is obsolete, it is provided for compatibility only.</b>" \ | ||
| 29 | obsolete=@deprecated \ | ||
| 30 | ref= \ | ||
| 31 | slash=/ | ||
| 32 | OPTIMIZE_OUTPUT_FOR_C = NO | ||
| 33 | OPTIMIZE_OUTPUT_JAVA = NO | ||
| 34 | SUBGROUPING = YES | ||
| 35 | #--------------------------------------------------------------------------- | ||
| 36 | # Build related configuration options | ||
| 37 | #--------------------------------------------------------------------------- | ||
| 38 | EXTRACT_ALL = YES | ||
| 39 | EXTRACT_PRIVATE = NO | ||
| 40 | EXTRACT_STATIC = YES | ||
| 41 | EXTRACT_LOCAL_CLASSES = NO | ||
| 42 | HIDE_UNDOC_MEMBERS = NO | ||
| 43 | HIDE_UNDOC_CLASSES = NO | ||
| 44 | HIDE_FRIEND_COMPOUNDS = NO | ||
| 45 | HIDE_IN_BODY_DOCS = NO | ||
| 46 | INTERNAL_DOCS = NO | ||
| 47 | CASE_SENSE_NAMES = YES | ||
| 48 | HIDE_SCOPE_NAMES = NO | ||
| 49 | SHOW_INCLUDE_FILES = YES | ||
| 50 | INLINE_INFO = YES | ||
| 51 | SORT_MEMBER_DOCS = NO | ||
| 52 | GENERATE_TODOLIST = YES | ||
| 53 | GENERATE_TESTLIST = YES | ||
| 54 | GENERATE_BUGLIST = YES | ||
| 55 | GENERATE_DEPRECATEDLIST= YES | ||
| 56 | ENABLED_SECTIONS = | ||
| 57 | MAX_INITIALIZER_LINES = 30 | ||
| 58 | SHOW_USED_FILES = YES | ||
| 59 | #--------------------------------------------------------------------------- | ||
| 60 | # configuration options related to warning and progress messages | ||
| 61 | #--------------------------------------------------------------------------- | ||
| 62 | QUIET = YES | ||
| 63 | WARNINGS = YES | ||
| 64 | WARN_IF_UNDOCUMENTED = NO | ||
| 65 | WARN_IF_DOC_ERROR = YES | ||
| 66 | WARN_FORMAT = "$file:$line: $text" | ||
| 67 | WARN_LOGFILE = Dox-Warning | ||
| 68 | #--------------------------------------------------------------------------- | ||
| 69 | # configuration options related to the input files | ||
| 70 | #--------------------------------------------------------------------------- | ||
| 71 | INPUT = . \ | ||
| 72 | big-screen/ \ | ||
| 73 | fileselector | ||
| 74 | FILE_PATTERNS = *.h \ | ||
| 75 | *.cpp \ | ||
| 76 | *.cc \ | ||
| 77 | *.hpp | ||
| 78 | RECURSIVE = NO | ||
| 79 | EXCLUDE = | ||
| 80 | EXCLUDE_SYMLINKS = NO | ||
| 81 | EXCLUDE_PATTERNS = *.moc.* \ | ||
| 82 | moc* \ | ||
| 83 | *.all_cpp.* \ | ||
| 84 | *unload.* \ | ||
| 85 | */test/* \ | ||
| 86 | */tests/* | ||
| 87 | EXAMPLE_PATH = | ||
| 88 | EXAMPLE_PATTERNS = | ||
| 89 | EXAMPLE_RECURSIVE = NO | ||
| 90 | IMAGE_PATH = ../../apidocs/api | ||
| 91 | INPUT_FILTER = | ||
| 92 | FILTER_SOURCE_FILES = NO | ||
| 93 | #--------------------------------------------------------------------------- | ||
| 94 | # configuration options related to source browsing | ||
| 95 | #--------------------------------------------------------------------------- | ||
| 96 | SOURCE_BROWSER = YES | ||
| 97 | INLINE_SOURCES = NO | ||
| 98 | STRIP_CODE_COMMENTS = YES | ||
| 99 | REFERENCED_BY_RELATION = YES | ||
| 100 | REFERENCES_RELATION = YES | ||
| 101 | VERBATIM_HEADERS = YES | ||
| 102 | #--------------------------------------------------------------------------- | ||
| 103 | # configuration options related to the alphabetical class index | ||
| 104 | #--------------------------------------------------------------------------- | ||
| 105 | ALPHABETICAL_INDEX = YES | ||
| 106 | COLS_IN_ALPHA_INDEX = 3 | ||
| 107 | IGNORE_PREFIX = Opie::Core::O \ | ||
| 108 | Opie::Ui::O \ | ||
| 109 | O | ||
| 110 | |||
| 111 | #--------------------------------------------------------------------------- | ||
| 112 | # configuration options related to the HTML output | ||
| 113 | #--------------------------------------------------------------------------- | ||
| 114 | GENERATE_HTML = YES | ||
| 115 | HTML_OUTPUT = ui2/html | ||
| 116 | HTML_FILE_EXTENSION = .html | ||
| 117 | HTML_HEADER = ../../apidocs/common/header.html | ||
| 118 | HTML_FOOTER = ../../apidocs/common/footer.html | ||
| 119 | HTML_STYLESHEET = ../../apidocs/common/doxygen.css | ||
| 120 | HTML_ALIGN_MEMBERS = YES | ||
| 121 | GENERATE_HTMLHELP = NO | ||
| 122 | CHM_FILE = | ||
| 123 | HHC_LOCATION = | ||
| 124 | GENERATE_CHI = NO | ||
| 125 | BINARY_TOC = NO | ||
| 126 | TOC_EXPAND = NO | ||
| 127 | DISABLE_INDEX = YES | ||
| 128 | ENUM_VALUES_PER_LINE = 4 | ||
| 129 | GENERATE_TREEVIEW = NO | ||
| 130 | TREEVIEW_WIDTH = 250 | ||
| 131 | #--------------------------------------------------------------------------- | ||
| 132 | # configuration options related to the LaTeX output | ||
| 133 | #--------------------------------------------------------------------------- | ||
| 134 | GENERATE_LATEX = NO | ||
| 135 | LATEX_OUTPUT = pim/latex | ||
| 136 | LATEX_CMD_NAME = latex | ||
| 137 | MAKEINDEX_CMD_NAME = makeindex | ||
| 138 | COMPACT_LATEX = NO | ||
| 139 | PAPER_TYPE = a4wide | ||
| 140 | EXTRA_PACKAGES = | ||
| 141 | LATEX_HEADER = | ||
| 142 | PDF_HYPERLINKS = NO | ||
| 143 | USE_PDFLATEX = NO | ||
| 144 | LATEX_BATCHMODE = NO | ||
| 145 | LATEX_HIDE_INDICES = NO | ||
| 146 | #--------------------------------------------------------------------------- | ||
| 147 | # configuration options related to the RTF output | ||
| 148 | #--------------------------------------------------------------------------- | ||
| 149 | GENERATE_RTF = NO | ||
| 150 | RTF_OUTPUT = pim/rtf | ||
| 151 | COMPACT_RTF = NO | ||
| 152 | RTF_HYPERLINKS = NO | ||
| 153 | RTF_STYLESHEET_FILE = | ||
| 154 | RTF_EXTENSIONS_FILE = | ||
| 155 | #--------------------------------------------------------------------------- | ||
| 156 | # configuration options related to the man page output | ||
| 157 | #--------------------------------------------------------------------------- | ||
| 158 | GENERATE_MAN = NO | ||
| 159 | MAN_OUTPUT = pim/man | ||
| 160 | MAN_EXTENSION = .kde3 | ||
| 161 | MAN_LINKS = YES | ||
| 162 | #--------------------------------------------------------------------------- | ||
| 163 | # configuration options related to the XML output | ||
| 164 | #--------------------------------------------------------------------------- | ||
| 165 | GENERATE_XML = NO | ||
| 166 | XML_OUTPUT = xml | ||
| 167 | XML_SCHEMA = | ||
| 168 | XML_DTD = | ||
| 169 | XML_PROGRAMLISTING = YES | ||
| 170 | #--------------------------------------------------------------------------- | ||
| 171 | # configuration options for the AutoGen Definitions output | ||
| 172 | #--------------------------------------------------------------------------- | ||
| 173 | GENERATE_AUTOGEN_DEF = NO | ||
| 174 | #--------------------------------------------------------------------------- | ||
| 175 | # configuration options related to the Perl module output | ||
| 176 | #--------------------------------------------------------------------------- | ||
| 177 | GENERATE_PERLMOD = NO | ||
| 178 | PERLMOD_LATEX = NO | ||
| 179 | PERLMOD_PRETTY = YES | ||
| 180 | PERLMOD_MAKEVAR_PREFIX = | ||
| 181 | #--------------------------------------------------------------------------- | ||
| 182 | # Configuration options related to the preprocessor | ||
| 183 | #--------------------------------------------------------------------------- | ||
| 184 | ENABLE_PREPROCESSING = YES | ||
| 185 | MACRO_EXPANSION = NO | ||
| 186 | EXPAND_ONLY_PREDEF = NO | ||
| 187 | SEARCH_INCLUDES = YES | ||
| 188 | INCLUDE_PATH = | ||
| 189 | INCLUDE_FILE_PATTERNS = | ||
| 190 | PREDEFINED = QT_VERSION=305 | ||
| 191 | EXPAND_AS_DEFINED = | ||
| 192 | SKIP_FUNCTION_MACROS = YES | ||
| 193 | #--------------------------------------------------------------------------- | ||
| 194 | # Configuration::addtions related to external references | ||
| 195 | #--------------------------------------------------------------------------- | ||
| 196 | TAGFILES = ../../apidocs/qt/qt.tag=../../qt/ \ | ||
| 197 | ../../apidocs/libqpe/libqpe.tag=../../libqpe/html \ | ||
| 198 | ../../apidocs/core2/core2.tag=../../core2/html | ||
| 199 | GENERATE_TAGFILE = ../../apidocs/ui2/ui2.tag | ||
| 200 | ALLEXTERNALS = NO | ||
| 201 | EXTERNAL_GROUPS = NO | ||
| 202 | PERL_PATH = | ||
| 203 | #--------------------------------------------------------------------------- | ||
| 204 | # Configuration options related to the dot tool | ||
| 205 | #--------------------------------------------------------------------------- | ||
| 206 | CLASS_DIAGRAMS = YES | ||
| 207 | HIDE_UNDOC_RELATIONS = NO | ||
| 208 | HAVE_DOT = YES | ||
| 209 | CLASS_GRAPH = YES | ||
| 210 | COLLABORATION_GRAPH = YES | ||
| 211 | UML_LOOK = NO | ||
| 212 | TEMPLATE_RELATIONS = YES | ||
| 213 | INCLUDE_GRAPH = YES | ||
| 214 | INCLUDED_BY_GRAPH = YES | ||
| 215 | CALL_GRAPH = NO | ||
| 216 | GRAPHICAL_HIERARCHY = NO | ||
| 217 | DOT_IMAGE_FORMAT = png | ||
| 218 | DOT_PATH = | ||
| 219 | DOTFILE_DIRS = | ||
| 220 | MAX_DOT_GRAPH_WIDTH = 800 | ||
| 221 | MAX_DOT_GRAPH_HEIGHT = 1024 | ||
| 222 | MAX_DOT_GRAPH_DEPTH = 0 | ||
| 223 | GENERATE_LEGEND = YES | ||
| 224 | DOT_CLEANUP = YES | ||
| 225 | #--------------------------------------------------------------------------- | ||
| 226 | # Configuration::addtions related to the search engine | ||
| 227 | #--------------------------------------------------------------------------- | ||
| 228 | SEARCHENGINE = NO | ||
diff --git a/doc/Mainpage.dox b/doc/Mainpage.dox index 9dcf52d..06ac189 100755 --- a/doc/Mainpage.dox +++ b/doc/Mainpage.dox | |||
| @@ -7,27 +7,44 @@ | |||
| 7 | * read the mailing lists for any additions and/or modifications to the API. | 7 | * read the mailing lists for any additions and/or modifications to the API. |
| 8 | * | 8 | * |
| 9 | * - <a href="qt/index.html"><b>qt</b></a> | 9 | * - <a href="qt/index.html"><b>qt</b></a> |
| 10 | * (<a href="qt/classes.html">classes</a>)\n | 10 | * (<a href="qt/classes.html">classes</a>)\n |
| 11 | * <i>Qt classes</i> | 11 | * <i>Qt classes</i> |
| 12 | * - <a href="libqpe/html/index.html"><b>Qtopia library</b></a> | 12 | * - <a href="libqpe/html/index.html"><b>Qtopia library</b></a> |
| 13 | * (<a href="libqpe/html/classes.html">classes</a>)\n | 13 | * (<a href="libqpe/html/classes.html">classes</a>)\n |
| 14 | * <i>Qtopia lib</i> | 14 | * <i>Qtopia lib</i> |
| 15 | * - <a href="libopie/html/index.html"><b>libopie</b></a> | 15 | * - <a href="libopie/html/index.html"><b>libopie</b></a> |
| 16 | * (<a href="libopie/html/classes.html">classes</a>)\n | 16 | * (<a href="libopie/html/classes.html">classes</a>)\n |
| 17 | * <i>libopie</i> | 17 | * <i>libopie</i> |
| 18 | * - <a href="pim/html/index.html"><b>PIM</b></a> | 18 | * - <a href="pim/html/index.html"><b>PIM</b></a> |
| 19 | * (<a href="pim/html/classes.html">classes</a>)\n | 19 | * (<a href="pim/html/classes.html">classes</a>)\n |
| 20 | * <i>Libopie PIM</i> | 20 | * <i>Libopie PIM</i> |
| 21 | * - <a href="network/html/index.html"><b>Network Settings Modules</b></a> | 21 | * - <a href="network/html/index.html"><b>Network Settings Modules</b></a> |
| 22 | * (<a href="network/html/classes.html">classes</a>)\n | 22 | * (<a href="network/html/classes.html">classes</a>)\n |
| 23 | * <i>Networksettings</i> | 23 | * <i>Networksettings</i> |
| 24 | * | 24 | * - <a href="core2/html/index.html"><b>Opie2 Core Classes</b></a> |
| 25 | * (<a href="core2/html/classes.html">classes</a>)\n | ||
| 26 | * <i>Core Classes</i> | ||
| 27 | * - <a href="ui2/html/index.html"><b>Opie2 UI Classes</b></a> | ||
| 28 | * (<a href="ui2/html/classes.html">classes</a>)\n | ||
| 29 | * <i>UI Classes</i> | ||
| 30 | * - <a href="db2/html/index.html"><b>Opie2 DataBase Classes</b></a> | ||
| 31 | * (<a href="db2/html/classes.html">classes</a>)\n | ||
| 32 | * <i>DataBase Classes</i> | ||
| 33 | * - <a href="net2/html/index.html"><b>Opie2 Network Classes</b></a> | ||
| 34 | * (<a href="net2/html/classes.html">classes</a>)\n | ||
| 35 | * <i>Network Classes</i> | ||
| 36 | * - <a href="pim2/html/index.html"><b>Opie2 PIM Classes</b></a> | ||
| 37 | * (<a href="pim2/html/classes.html">classes</a>)\n | ||
| 38 | * <i>PIM Classes</i> | ||
| 39 | * - <a href="libopie2/html/index.html"><b>All Opie2 Classes</b></a> | ||
| 40 | * (<a href="libopie2/html/classes.html">classes</a>)\n | ||
| 41 | * <i>LIB OPIE2</i> | ||
| 25 | */ | 42 | */ |
| 26 | 43 | ||
| 27 | /** | 44 | /** |
| 28 | * @page search Search the API documentation | 45 | * @page search Search the API documentation |
| 29 | * | 46 | * |
| 30 | * <br>Under construction. | 47 | * <br>Under construction. |
| 31 | * | 48 | * |
| 32 | */ | 49 | */ |
| 33 | 50 | ||
diff --git a/doc/generate_apidox b/doc/generate_apidox index f6eadc7..5a4d714 100755 --- a/doc/generate_apidox +++ b/doc/generate_apidox | |||
| @@ -2,32 +2,37 @@ | |||
| 2 | 2 | ||
| 3 | # small shell script to generate our API docs | 3 | # small shell script to generate our API docs |
| 4 | # it'll copy over qt | 4 | # it'll copy over qt |
| 5 | 5 | ||
| 6 | # | 6 | # |
| 7 | # create directory structure | 7 | # create directory structure |
| 8 | echo "Creating directory structure" | 8 | echo "Creating directory structure" |
| 9 | rm -rf $OPIEDIR/apidocs | 9 | rm -rf $OPIEDIR/apidocs |
| 10 | mkdir $OPIEDIR/apidocs | 10 | mkdir $OPIEDIR/apidocs |
| 11 | mkdir $OPIEDIR/apidocs/api | 11 | mkdir $OPIEDIR/apidocs/api |
| 12 | mkdir $OPIEDIR/apidocs/common | 12 | mkdir $OPIEDIR/apidocs/common |
| 13 | mkdir $OPIEDIR/apidocs/qt | 13 | mkdir $OPIEDIR/apidocs/qt |
| 14 | mkdir $OPIEDIR/apidocs/libqpe | 14 | mkdir $OPIEDIR/apidocs/libqpe |
| 15 | mkdir $OPIEDIR/apidocs/libopie | 15 | mkdir $OPIEDIR/apidocs/libopie |
| 16 | mkdir $OPIEDIR/apidocs/pim | 16 | mkdir $OPIEDIR/apidocs/pim |
| 17 | mkdir $OPIEDIR/apidocs/network | 17 | mkdir $OPIEDIR/apidocs/network |
| 18 | mkdir $OPIEDIR/apidocs/net2 | ||
| 19 | mkdir $OPIEDIR/apidocs/core2 | ||
| 20 | mkdir $OPIEDIR/apidocs/pim2 | ||
| 21 | mkdir $OPIEDIR/apidocs/ui2 | ||
| 22 | mkdir $OPIEDIR/apidocs/db2 | ||
| 18 | 23 | ||
| 19 | # now copy qt doc | 24 | # now copy qt doc |
| 20 | echo "Scanning and copying QT docu" | 25 | echo "Scanning and copying QT docu" |
| 21 | cp -R $QTDIR/doc/html/* $OPIEDIR/apidocs/qt | 26 | cp -R $QTDIR/doc/html/* $OPIEDIR/apidocs/qt |
| 22 | doxytag -t $OPIEDIR/apidocs/qt/qt.tag $OPIEDIR/apidocs/qt | 27 | doxytag -t $OPIEDIR/apidocs/qt/qt.tag $OPIEDIR/apidocs/qt |
| 23 | 28 | ||
| 24 | cp -r $OPIEDIR/doc/common/* $OPIEDIR/apidocs/common | 29 | cp -r $OPIEDIR/doc/common/* $OPIEDIR/apidocs/common |
| 25 | # now start with libqpe | 30 | # now start with libqpe |
| 26 | echo "Creating docu for qpe" | 31 | echo "Creating docu for qpe" |
| 27 | cp $OPIEDIR/doc/Doxyfile_libqpe $OPIEDIR/library/Doxyfile | 32 | cp $OPIEDIR/doc/Doxyfile_libqpe $OPIEDIR/library/Doxyfile |
| 28 | cd $OPIEDIR/library | 33 | cd $OPIEDIR/library |
| 29 | doxygen Doxyfile | 34 | doxygen Doxyfile |
| 30 | rm -f Doxyfile | 35 | rm -f Doxyfile |
| 31 | 36 | ||
| 32 | # now do libopie | 37 | # now do libopie |
| 33 | echo "Creating docu for libopie" | 38 | echo "Creating docu for libopie" |
| @@ -37,26 +42,68 @@ doxygen Doxyfile | |||
| 37 | rm -f Doxyfile | 42 | rm -f Doxyfile |
| 38 | 43 | ||
| 39 | echo "Creating docu for PIM" | 44 | echo "Creating docu for PIM" |
| 40 | # now it's time for libopie/pim | 45 | # now it's time for libopie/pim |
| 41 | cp $OPIEDIR/doc/Doxyfile_pim $OPIEDIR/libopie/pim/Doxyfile | 46 | cp $OPIEDIR/doc/Doxyfile_pim $OPIEDIR/libopie/pim/Doxyfile |
| 42 | cd $OPIEDIR/libopie/pim | 47 | cd $OPIEDIR/libopie/pim |
| 43 | doxygen Doxyfile | 48 | doxygen Doxyfile |
| 44 | rm -f Doxyfile | 49 | rm -f Doxyfile |
| 45 | 50 | ||
| 46 | echo "Creating docu for NetworkSettings" | 51 | echo "Creating docu for NetworkSettings" |
| 47 | # now do networksettings | 52 | # now do networksettings |
| 48 | cp $OPIEDIR/doc/Doxyfile_net $OPIEDIR/noncore/settings/networksettings/Doxyfile | 53 | cp $OPIEDIR/doc/Doxyfile_net $OPIEDIR/noncore/settings/networksettings/Doxyfile |
| 49 | cd $OPIEDIR/noncore/settings/networksettings | 54 | cd $OPIEDIR/noncore/settings/networksettings |
| 50 | doxygen Doxyfile | 55 | doxygen Doxyfile |
| 51 | rm -f Doxyfile | 56 | rm -f Doxyfile |
| 52 | 57 | ||
| 58 | echo "Creating docu for Opie2 Core" | ||
| 59 | # now do networksettings | ||
| 60 | cp $OPIEDIR/doc/Doxyfile_core2 $OPIEDIR/libopie2/opiecore/Doxyfile | ||
| 61 | cd $OPIEDIR/libopie2/opiecore | ||
| 62 | doxygen Doxyfile | ||
| 63 | rm -f Doxyfile | ||
| 64 | |||
| 65 | echo "Creating docu for Opie2 DB" | ||
| 66 | # now do networksettings | ||
| 67 | cp $OPIEDIR/doc/Doxyfile_db2 $OPIEDIR/libopie2/opiedb/Doxyfile | ||
| 68 | cd $OPIEDIR/libopie2/opiedb | ||
| 69 | doxygen Doxyfile | ||
| 70 | rm -f Doxyfile | ||
| 71 | |||
| 72 | echo "Creating docu for Opie2 mm" | ||
| 73 | # now do networksettings | ||
| 74 | cp $OPIEDIR/doc/Doxyfile_mm2 $OPIEDIR/libopie2/opiemm/Doxyfile | ||
| 75 | cd $OPIEDIR/libopie2/opiemm | ||
| 76 | doxygen Doxyfile | ||
| 77 | rm -f Doxyfile | ||
| 78 | |||
| 79 | echo "Creating docu for Opie2 net" | ||
| 80 | # now do networksettings | ||
| 81 | cp $OPIEDIR/doc/Doxyfile_net2 $OPIEDIR/libopie2/opienet/Doxyfile | ||
| 82 | cd $OPIEDIR/libopie2/opienet | ||
| 83 | doxygen Doxyfile | ||
| 84 | rm -f Doxyfile | ||
| 85 | |||
| 86 | echo "Creating docu for Opie2 ui" | ||
| 87 | # now do networksettings | ||
| 88 | cp $OPIEDIR/doc/Doxyfile_ui2 $OPIEDIR/libopie2/opieui/Doxyfile | ||
| 89 | cd $OPIEDIR/libopie2/opieui | ||
| 90 | doxygen Doxyfile | ||
| 91 | rm -f Doxyfile | ||
| 92 | |||
| 93 | echo "Creating docu for Opie2 pim" | ||
| 94 | # now do networksettings | ||
| 95 | cp $OPIEDIR/doc/Doxyfile_pim2 $OPIEDIR/libopie2/opiepim/Doxyfile | ||
| 96 | cd $OPIEDIR/libopie2/opiepim | ||
| 97 | doxygen Doxyfile | ||
| 98 | rm -f Doxyfile | ||
| 99 | |||
| 53 | echo "Making mainpage" | 100 | echo "Making mainpage" |
| 54 | # now generate the mainpage | 101 | # now generate the mainpage |
| 55 | cp $OPIEDIR/doc/Doxyfile_main $OPIEDIR/Doxyfile | 102 | cp $OPIEDIR/doc/Doxyfile_main $OPIEDIR/Doxyfile |
| 56 | cp $OPIEDIR/doc/Mainpage.dox $OPIEDIR/ | 103 | cp $OPIEDIR/doc/Mainpage.dox $OPIEDIR/ |
| 57 | cd $OPIEDIR | 104 | cd $OPIEDIR |
| 58 | doxygen Doxyfile | 105 | doxygen Doxyfile |
| 59 | rm -f Doxyfile | 106 | rm -f Doxyfile |
| 60 | rm -f Mainpage.dox | 107 | rm -f Mainpage.dox |
| 61 | 108 | ||
| 62 | echo "Done with generation!!! hopefully grin" | 109 | echo "Done with generation!!! hopefully grin" |