-rw-r--r-- | doc/Doxyfile_net | 224 | ||||
-rwxr-xr-x | doc/Mainpage.dox | 5 | ||||
-rwxr-xr-x | doc/generate_apidox | 8 |
3 files changed, 236 insertions, 1 deletions
diff --git a/doc/Doxyfile_net b/doc/Doxyfile_net new file mode 100644 index 0000000..833fe02 --- a/dev/null +++ b/doc/Doxyfile_net | |||
@@ -0,0 +1,224 @@ | |||
1 | # Doxyfile 1.3.5 | ||
2 | |||
3 | #--------------------------------------------------------------------------- | ||
4 | # Project related configuration options | ||
5 | #--------------------------------------------------------------------------- | ||
6 | PROJECT_NAME = "Networksettings API" | ||
7 | PROJECT_NUMBER = "Version 1.0" | ||
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 = NO | ||
39 | EXTRACT_PRIVATE = NO | ||
40 | EXTRACT_STATIC = YES | ||
41 | EXTRACT_LOCAL_CLASSES = NO | ||
42 | HIDE_UNDOC_MEMBERS = NO | ||
43 | HIDE_UNDOC_CLASSES = YES | ||
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 = YES | ||
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 | interfaces | ||
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 = O | ||
107 | #--------------------------------------------------------------------------- | ||
108 | # configuration options related to the HTML output | ||
109 | #--------------------------------------------------------------------------- | ||
110 | GENERATE_HTML = YES | ||
111 | HTML_OUTPUT = network/html | ||
112 | HTML_FILE_EXTENSION = .html | ||
113 | HTML_HEADER = ../../../apidocs/common/header.html | ||
114 | HTML_FOOTER = ../../../apidocs/common/footer.html | ||
115 | HTML_STYLESHEET = ../../../apidocs/common/doxygen.css | ||
116 | HTML_ALIGN_MEMBERS = YES | ||
117 | GENERATE_HTMLHELP = NO | ||
118 | CHM_FILE = | ||
119 | HHC_LOCATION = | ||
120 | GENERATE_CHI = NO | ||
121 | BINARY_TOC = NO | ||
122 | TOC_EXPAND = NO | ||
123 | DISABLE_INDEX = YES | ||
124 | ENUM_VALUES_PER_LINE = 4 | ||
125 | GENERATE_TREEVIEW = NO | ||
126 | TREEVIEW_WIDTH = 250 | ||
127 | #--------------------------------------------------------------------------- | ||
128 | # configuration options related to the LaTeX output | ||
129 | #--------------------------------------------------------------------------- | ||
130 | GENERATE_LATEX = NO | ||
131 | LATEX_OUTPUT = libopie/latex | ||
132 | LATEX_CMD_NAME = latex | ||
133 | MAKEINDEX_CMD_NAME = makeindex | ||
134 | COMPACT_LATEX = NO | ||
135 | PAPER_TYPE = a4wide | ||
136 | EXTRA_PACKAGES = | ||
137 | LATEX_HEADER = | ||
138 | PDF_HYPERLINKS = NO | ||
139 | USE_PDFLATEX = NO | ||
140 | LATEX_BATCHMODE = NO | ||
141 | LATEX_HIDE_INDICES = NO | ||
142 | #--------------------------------------------------------------------------- | ||
143 | # configuration options related to the RTF output | ||
144 | #--------------------------------------------------------------------------- | ||
145 | GENERATE_RTF = NO | ||
146 | RTF_OUTPUT = libopie/rtf | ||
147 | COMPACT_RTF = NO | ||
148 | RTF_HYPERLINKS = NO | ||
149 | RTF_STYLESHEET_FILE = | ||
150 | RTF_EXTENSIONS_FILE = | ||
151 | #--------------------------------------------------------------------------- | ||
152 | # configuration options related to the man page output | ||
153 | #--------------------------------------------------------------------------- | ||
154 | GENERATE_MAN = NO | ||
155 | MAN_OUTPUT = libopie/man | ||
156 | MAN_EXTENSION = .kde3 | ||
157 | MAN_LINKS = YES | ||
158 | #--------------------------------------------------------------------------- | ||
159 | # configuration options related to the XML output | ||
160 | #--------------------------------------------------------------------------- | ||
161 | GENERATE_XML = NO | ||
162 | XML_OUTPUT = xml | ||
163 | XML_SCHEMA = | ||
164 | XML_DTD = | ||
165 | XML_PROGRAMLISTING = YES | ||
166 | #--------------------------------------------------------------------------- | ||
167 | # configuration options for the AutoGen Definitions output | ||
168 | #--------------------------------------------------------------------------- | ||
169 | GENERATE_AUTOGEN_DEF = NO | ||
170 | #--------------------------------------------------------------------------- | ||
171 | # configuration options related to the Perl module output | ||
172 | #--------------------------------------------------------------------------- | ||
173 | GENERATE_PERLMOD = NO | ||
174 | PERLMOD_LATEX = NO | ||
175 | PERLMOD_PRETTY = YES | ||
176 | PERLMOD_MAKEVAR_PREFIX = | ||
177 | #--------------------------------------------------------------------------- | ||
178 | # Configuration options related to the preprocessor | ||
179 | #--------------------------------------------------------------------------- | ||
180 | ENABLE_PREPROCESSING = YES | ||
181 | MACRO_EXPANSION = NO | ||
182 | EXPAND_ONLY_PREDEF = NO | ||
183 | SEARCH_INCLUDES = YES | ||
184 | INCLUDE_PATH = | ||
185 | INCLUDE_FILE_PATTERNS = | ||
186 | PREDEFINED = QT_VERSION=305 | ||
187 | EXPAND_AS_DEFINED = | ||
188 | SKIP_FUNCTION_MACROS = YES | ||
189 | #--------------------------------------------------------------------------- | ||
190 | # Configuration::addtions related to external references | ||
191 | #--------------------------------------------------------------------------- | ||
192 | TAGFILES = ../../../apidocs/qt/qt.tag=../../qt \ | ||
193 | ../../../apidocs/libopie/libopie.tag=../../libopie/html \ | ||
194 | ../../../apidocs/libqpe/libqpe.tag=../../libqpe/html | ||
195 | GENERATE_TAGFILE = ../../../apidocs/network/net.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/Mainpage.dox b/doc/Mainpage.dox index 4fb0d49..9dcf52d 100755 --- a/doc/Mainpage.dox +++ b/doc/Mainpage.dox | |||
@@ -1,30 +1,33 @@ | |||
1 | /** | 1 | /** |
2 | * @mainpage The OPIE API Reference | 2 | * @mainpage The OPIE API Reference |
3 | * | 3 | * |
4 | * This section contains the OPIE online class reference for the current | 4 | * This section contains the OPIE online class reference for the current |
5 | * development version of OPIE. You can also download (??? MB) | 5 | * development version of OPIE. You can also download (??? MB) |
6 | * the complete API documentation. Additionally, you can subscribe or | 6 | * the complete API documentation. Additionally, you can subscribe or |
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 | * | 21 | * - <a href="network/html/index.html"><b>Network Settings Modules</b></a> |
22 | * (<a href="network/html/classes.html">classes</a>)\n | ||
23 | * <i>Networksettings</i> | ||
24 | * | ||
22 | */ | 25 | */ |
23 | 26 | ||
24 | /** | 27 | /** |
25 | * @page search Search the API documentation | 28 | * @page search Search the API documentation |
26 | * | 29 | * |
27 | * <br>Under construction. | 30 | * <br>Under construction. |
28 | * | 31 | * |
29 | */ | 32 | */ |
30 | 33 | ||
diff --git a/doc/generate_apidox b/doc/generate_apidox index db77e20..f6eadc7 100755 --- a/doc/generate_apidox +++ b/doc/generate_apidox | |||
@@ -1,54 +1,62 @@ | |||
1 | #!/bin/sh | 1 | #!/bin/sh |
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 | 18 | ||
18 | # now copy qt doc | 19 | # now copy qt doc |
19 | echo "Scanning and copying QT docu" | 20 | echo "Scanning and copying QT docu" |
20 | cp -R $QTDIR/doc/html/* $OPIEDIR/apidocs/qt | 21 | cp -R $QTDIR/doc/html/* $OPIEDIR/apidocs/qt |
21 | doxytag -t $OPIEDIR/apidocs/qt/qt.tag $OPIEDIR/apidocs/qt | 22 | doxytag -t $OPIEDIR/apidocs/qt/qt.tag $OPIEDIR/apidocs/qt |
22 | 23 | ||
23 | cp -r $OPIEDIR/doc/common/* $OPIEDIR/apidocs/common | 24 | cp -r $OPIEDIR/doc/common/* $OPIEDIR/apidocs/common |
24 | # now start with libqpe | 25 | # now start with libqpe |
25 | echo "Creating docu for qpe" | 26 | echo "Creating docu for qpe" |
26 | cp $OPIEDIR/doc/Doxyfile_libqpe $OPIEDIR/library/Doxyfile | 27 | cp $OPIEDIR/doc/Doxyfile_libqpe $OPIEDIR/library/Doxyfile |
27 | cd $OPIEDIR/library | 28 | cd $OPIEDIR/library |
28 | doxygen Doxyfile | 29 | doxygen Doxyfile |
29 | rm -f Doxyfile | 30 | rm -f Doxyfile |
30 | 31 | ||
31 | # now do libopie | 32 | # now do libopie |
32 | echo "Creating docu for libopie" | 33 | echo "Creating docu for libopie" |
33 | cp $OPIEDIR/doc/Doxyfile_libopie $OPIEDIR/libopie/Doxyfile | 34 | cp $OPIEDIR/doc/Doxyfile_libopie $OPIEDIR/libopie/Doxyfile |
34 | cd $OPIEDIR/libopie | 35 | cd $OPIEDIR/libopie |
35 | doxygen Doxyfile | 36 | doxygen Doxyfile |
36 | rm -f Doxyfile | 37 | rm -f Doxyfile |
37 | 38 | ||
38 | echo "Creating docu for PIM" | 39 | echo "Creating docu for PIM" |
39 | # now it's time for libopie/pim | 40 | # now it's time for libopie/pim |
40 | cp $OPIEDIR/doc/Doxyfile_pim $OPIEDIR/libopie/pim/Doxyfile | 41 | cp $OPIEDIR/doc/Doxyfile_pim $OPIEDIR/libopie/pim/Doxyfile |
41 | cd $OPIEDIR/libopie/pim | 42 | cd $OPIEDIR/libopie/pim |
42 | doxygen Doxyfile | 43 | doxygen Doxyfile |
43 | rm -f Doxyfile | 44 | rm -f Doxyfile |
44 | 45 | ||
46 | echo "Creating docu for NetworkSettings" | ||
47 | # now do networksettings | ||
48 | cp $OPIEDIR/doc/Doxyfile_net $OPIEDIR/noncore/settings/networksettings/Doxyfile | ||
49 | cd $OPIEDIR/noncore/settings/networksettings | ||
50 | doxygen Doxyfile | ||
51 | rm -f Doxyfile | ||
52 | |||
45 | echo "Making mainpage" | 53 | echo "Making mainpage" |
46 | # now generate the mainpage | 54 | # now generate the mainpage |
47 | cp $OPIEDIR/doc/Doxyfile_main $OPIEDIR/Doxyfile | 55 | cp $OPIEDIR/doc/Doxyfile_main $OPIEDIR/Doxyfile |
48 | cp $OPIEDIR/doc/Mainpage.dox $OPIEDIR/ | 56 | cp $OPIEDIR/doc/Mainpage.dox $OPIEDIR/ |
49 | cd $OPIEDIR | 57 | cd $OPIEDIR |
50 | doxygen Doxyfile | 58 | doxygen Doxyfile |
51 | rm -f Doxyfile | 59 | rm -f Doxyfile |
52 | rm -f Mainpage.dox | 60 | rm -f Mainpage.dox |
53 | 61 | ||
54 | echo "Done with generation!!! hopefully grin" | 62 | echo "Done with generation!!! hopefully grin" |