summaryrefslogtreecommitdiff
Unidiff
Diffstat (more/less context) (ignore whitespace changes)
-rwxr-xr-xdoc/Mainpage.dox3
-rwxr-xr-xdoc/generate_apidox2
2 files changed, 5 insertions, 0 deletions
diff --git a/doc/Mainpage.dox b/doc/Mainpage.dox
index 06ac189..51ce864 100755
--- a/doc/Mainpage.dox
+++ b/doc/Mainpage.dox
@@ -1,50 +1,53 @@
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 * - <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 * - <a href="core2/html/index.html"><b>Opie2 Core Classes</b></a> 24 * - <a href="core2/html/index.html"><b>Opie2 Core Classes</b></a>
25 * (<a href="core2/html/classes.html">classes</a>)\n 25 * (<a href="core2/html/classes.html">classes</a>)\n
26 * <i>Core Classes</i> 26 * <i>Core Classes</i>
27 * - <a href="mm2/html/index.html"><b>Opie2 MM Classes</b></a>
28 * (<a href="mm2/html/classes.html">classes</a>)\n
29 * <i>Multimedia Classes</i>
27 * - <a href="ui2/html/index.html"><b>Opie2 UI Classes</b></a> 30 * - <a href="ui2/html/index.html"><b>Opie2 UI Classes</b></a>
28 * (<a href="ui2/html/classes.html">classes</a>)\n 31 * (<a href="ui2/html/classes.html">classes</a>)\n
29 * <i>UI Classes</i> 32 * <i>UI Classes</i>
30 * - <a href="db2/html/index.html"><b>Opie2 DataBase Classes</b></a> 33 * - <a href="db2/html/index.html"><b>Opie2 DataBase Classes</b></a>
31 * (<a href="db2/html/classes.html">classes</a>)\n 34 * (<a href="db2/html/classes.html">classes</a>)\n
32 * <i>DataBase Classes</i> 35 * <i>DataBase Classes</i>
33 * - <a href="net2/html/index.html"><b>Opie2 Network Classes</b></a> 36 * - <a href="net2/html/index.html"><b>Opie2 Network Classes</b></a>
34 * (<a href="net2/html/classes.html">classes</a>)\n 37 * (<a href="net2/html/classes.html">classes</a>)\n
35 * <i>Network Classes</i> 38 * <i>Network Classes</i>
36 * - <a href="pim2/html/index.html"><b>Opie2 PIM Classes</b></a> 39 * - <a href="pim2/html/index.html"><b>Opie2 PIM Classes</b></a>
37 * (<a href="pim2/html/classes.html">classes</a>)\n 40 * (<a href="pim2/html/classes.html">classes</a>)\n
38 * <i>PIM Classes</i> 41 * <i>PIM Classes</i>
39 * - <a href="libopie2/html/index.html"><b>All Opie2 Classes</b></a> 42 * - <a href="libopie2/html/index.html"><b>All Opie2 Classes</b></a>
40 * (<a href="libopie2/html/classes.html">classes</a>)\n 43 * (<a href="libopie2/html/classes.html">classes</a>)\n
41 * <i>LIB OPIE2</i> 44 * <i>LIB OPIE2</i>
42 */ 45 */
43 46
44/** 47/**
45 * @page search Search the API documentation 48 * @page search Search the API documentation
46 * 49 *
47 * <br>Under construction. 50 * <br>Under construction.
48 * 51 *
49 */ 52 */
50 53
diff --git a/doc/generate_apidox b/doc/generate_apidox
index 5a4d714..5447ee1 100755
--- a/doc/generate_apidox
+++ b/doc/generate_apidox
@@ -1,109 +1,111 @@
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
8echo "Creating directory structure" 8echo "Creating directory structure"
9rm -rf $OPIEDIR/apidocs 9rm -rf $OPIEDIR/apidocs
10mkdir $OPIEDIR/apidocs 10mkdir $OPIEDIR/apidocs
11mkdir $OPIEDIR/apidocs/api 11mkdir $OPIEDIR/apidocs/api
12mkdir $OPIEDIR/apidocs/common 12mkdir $OPIEDIR/apidocs/common
13mkdir $OPIEDIR/apidocs/qt 13mkdir $OPIEDIR/apidocs/qt
14mkdir $OPIEDIR/apidocs/libqpe 14mkdir $OPIEDIR/apidocs/libqpe
15mkdir $OPIEDIR/apidocs/libopie 15mkdir $OPIEDIR/apidocs/libopie
16mkdir $OPIEDIR/apidocs/pim 16mkdir $OPIEDIR/apidocs/pim
17mkdir $OPIEDIR/apidocs/network 17mkdir $OPIEDIR/apidocs/network
18mkdir $OPIEDIR/apidocs/net2 18mkdir $OPIEDIR/apidocs/net2
19mkdir $OPIEDIR/apidocs/core2 19mkdir $OPIEDIR/apidocs/core2
20mkdir $OPIEDIR/apidocs/mm2
20mkdir $OPIEDIR/apidocs/pim2 21mkdir $OPIEDIR/apidocs/pim2
21mkdir $OPIEDIR/apidocs/ui2 22mkdir $OPIEDIR/apidocs/ui2
22mkdir $OPIEDIR/apidocs/db2 23mkdir $OPIEDIR/apidocs/db2
24mkdir $OPIEDIR/apidocs/libopie2
23 25
24# now copy qt doc 26# now copy qt doc
25echo "Scanning and copying QT docu" 27echo "Scanning and copying QT docu"
26cp -R $QTDIR/doc/html/* $OPIEDIR/apidocs/qt 28cp -R $QTDIR/doc/html/* $OPIEDIR/apidocs/qt
27doxytag -t $OPIEDIR/apidocs/qt/qt.tag $OPIEDIR/apidocs/qt 29doxytag -t $OPIEDIR/apidocs/qt/qt.tag $OPIEDIR/apidocs/qt
28 30
29cp -r $OPIEDIR/doc/common/* $OPIEDIR/apidocs/common 31cp -r $OPIEDIR/doc/common/* $OPIEDIR/apidocs/common
30# now start with libqpe 32# now start with libqpe
31echo "Creating docu for qpe" 33echo "Creating docu for qpe"
32cp $OPIEDIR/doc/Doxyfile_libqpe $OPIEDIR/library/Doxyfile 34cp $OPIEDIR/doc/Doxyfile_libqpe $OPIEDIR/library/Doxyfile
33cd $OPIEDIR/library 35cd $OPIEDIR/library
34doxygen Doxyfile 36doxygen Doxyfile
35rm -f Doxyfile 37rm -f Doxyfile
36 38
37# now do libopie 39# now do libopie
38echo "Creating docu for libopie" 40echo "Creating docu for libopie"
39cp $OPIEDIR/doc/Doxyfile_libopie $OPIEDIR/libopie/Doxyfile 41cp $OPIEDIR/doc/Doxyfile_libopie $OPIEDIR/libopie/Doxyfile
40cd $OPIEDIR/libopie 42cd $OPIEDIR/libopie
41doxygen Doxyfile 43doxygen Doxyfile
42rm -f Doxyfile 44rm -f Doxyfile
43 45
44echo "Creating docu for PIM" 46echo "Creating docu for PIM"
45# now it's time for libopie/pim 47# now it's time for libopie/pim
46cp $OPIEDIR/doc/Doxyfile_pim $OPIEDIR/libopie/pim/Doxyfile 48cp $OPIEDIR/doc/Doxyfile_pim $OPIEDIR/libopie/pim/Doxyfile
47cd $OPIEDIR/libopie/pim 49cd $OPIEDIR/libopie/pim
48doxygen Doxyfile 50doxygen Doxyfile
49rm -f Doxyfile 51rm -f Doxyfile
50 52
51echo "Creating docu for NetworkSettings" 53echo "Creating docu for NetworkSettings"
52# now do networksettings 54# now do networksettings
53cp $OPIEDIR/doc/Doxyfile_net $OPIEDIR/noncore/settings/networksettings/Doxyfile 55cp $OPIEDIR/doc/Doxyfile_net $OPIEDIR/noncore/settings/networksettings/Doxyfile
54cd $OPIEDIR/noncore/settings/networksettings 56cd $OPIEDIR/noncore/settings/networksettings
55doxygen Doxyfile 57doxygen Doxyfile
56rm -f Doxyfile 58rm -f Doxyfile
57 59
58echo "Creating docu for Opie2 Core" 60echo "Creating docu for Opie2 Core"
59# now do networksettings 61# now do networksettings
60cp $OPIEDIR/doc/Doxyfile_core2 $OPIEDIR/libopie2/opiecore/Doxyfile 62cp $OPIEDIR/doc/Doxyfile_core2 $OPIEDIR/libopie2/opiecore/Doxyfile
61cd $OPIEDIR/libopie2/opiecore 63cd $OPIEDIR/libopie2/opiecore
62doxygen Doxyfile 64doxygen Doxyfile
63rm -f Doxyfile 65rm -f Doxyfile
64 66
65echo "Creating docu for Opie2 DB" 67echo "Creating docu for Opie2 DB"
66# now do networksettings 68# now do networksettings
67cp $OPIEDIR/doc/Doxyfile_db2 $OPIEDIR/libopie2/opiedb/Doxyfile 69cp $OPIEDIR/doc/Doxyfile_db2 $OPIEDIR/libopie2/opiedb/Doxyfile
68cd $OPIEDIR/libopie2/opiedb 70cd $OPIEDIR/libopie2/opiedb
69doxygen Doxyfile 71doxygen Doxyfile
70rm -f Doxyfile 72rm -f Doxyfile
71 73
72echo "Creating docu for Opie2 mm" 74echo "Creating docu for Opie2 mm"
73# now do networksettings 75# now do networksettings
74cp $OPIEDIR/doc/Doxyfile_mm2 $OPIEDIR/libopie2/opiemm/Doxyfile 76cp $OPIEDIR/doc/Doxyfile_mm2 $OPIEDIR/libopie2/opiemm/Doxyfile
75cd $OPIEDIR/libopie2/opiemm 77cd $OPIEDIR/libopie2/opiemm
76doxygen Doxyfile 78doxygen Doxyfile
77rm -f Doxyfile 79rm -f Doxyfile
78 80
79echo "Creating docu for Opie2 net" 81echo "Creating docu for Opie2 net"
80# now do networksettings 82# now do networksettings
81cp $OPIEDIR/doc/Doxyfile_net2 $OPIEDIR/libopie2/opienet/Doxyfile 83cp $OPIEDIR/doc/Doxyfile_net2 $OPIEDIR/libopie2/opienet/Doxyfile
82cd $OPIEDIR/libopie2/opienet 84cd $OPIEDIR/libopie2/opienet
83doxygen Doxyfile 85doxygen Doxyfile
84rm -f Doxyfile 86rm -f Doxyfile
85 87
86echo "Creating docu for Opie2 ui" 88echo "Creating docu for Opie2 ui"
87# now do networksettings 89# now do networksettings
88cp $OPIEDIR/doc/Doxyfile_ui2 $OPIEDIR/libopie2/opieui/Doxyfile 90cp $OPIEDIR/doc/Doxyfile_ui2 $OPIEDIR/libopie2/opieui/Doxyfile
89cd $OPIEDIR/libopie2/opieui 91cd $OPIEDIR/libopie2/opieui
90doxygen Doxyfile 92doxygen Doxyfile
91rm -f Doxyfile 93rm -f Doxyfile
92 94
93echo "Creating docu for Opie2 pim" 95echo "Creating docu for Opie2 pim"
94# now do networksettings 96# now do networksettings
95cp $OPIEDIR/doc/Doxyfile_pim2 $OPIEDIR/libopie2/opiepim/Doxyfile 97cp $OPIEDIR/doc/Doxyfile_pim2 $OPIEDIR/libopie2/opiepim/Doxyfile
96cd $OPIEDIR/libopie2/opiepim 98cd $OPIEDIR/libopie2/opiepim
97doxygen Doxyfile 99doxygen Doxyfile
98rm -f Doxyfile 100rm -f Doxyfile
99 101
100echo "Making mainpage" 102echo "Making mainpage"
101# now generate the mainpage 103# now generate the mainpage
102cp $OPIEDIR/doc/Doxyfile_main $OPIEDIR/Doxyfile 104cp $OPIEDIR/doc/Doxyfile_main $OPIEDIR/Doxyfile
103cp $OPIEDIR/doc/Mainpage.dox $OPIEDIR/ 105cp $OPIEDIR/doc/Mainpage.dox $OPIEDIR/
104cd $OPIEDIR 106cd $OPIEDIR
105doxygen Doxyfile 107doxygen Doxyfile
106rm -f Doxyfile 108rm -f Doxyfile
107rm -f Mainpage.dox 109rm -f Mainpage.dox
108 110
109echo "Done with generation!!! hopefully grin" 111echo "Done with generation!!! hopefully grin"