-rwxr-xr-x | doc/Mainpage.dox | 3 | ||||
-rwxr-xr-x | doc/generate_apidox | 2 |
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 |
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 | 18 | mkdir $OPIEDIR/apidocs/net2 |
19 | mkdir $OPIEDIR/apidocs/core2 | 19 | mkdir $OPIEDIR/apidocs/core2 |
20 | mkdir $OPIEDIR/apidocs/mm2 | ||
20 | mkdir $OPIEDIR/apidocs/pim2 | 21 | mkdir $OPIEDIR/apidocs/pim2 |
21 | mkdir $OPIEDIR/apidocs/ui2 | 22 | mkdir $OPIEDIR/apidocs/ui2 |
22 | mkdir $OPIEDIR/apidocs/db2 | 23 | mkdir $OPIEDIR/apidocs/db2 |
24 | mkdir $OPIEDIR/apidocs/libopie2 | ||
23 | 25 | ||
24 | # now copy qt doc | 26 | # now copy qt doc |
25 | echo "Scanning and copying QT docu" | 27 | echo "Scanning and copying QT docu" |
26 | cp -R $QTDIR/doc/html/* $OPIEDIR/apidocs/qt | 28 | cp -R $QTDIR/doc/html/* $OPIEDIR/apidocs/qt |
27 | doxytag -t $OPIEDIR/apidocs/qt/qt.tag $OPIEDIR/apidocs/qt | 29 | doxytag -t $OPIEDIR/apidocs/qt/qt.tag $OPIEDIR/apidocs/qt |
28 | 30 | ||
29 | cp -r $OPIEDIR/doc/common/* $OPIEDIR/apidocs/common | 31 | cp -r $OPIEDIR/doc/common/* $OPIEDIR/apidocs/common |
30 | # now start with libqpe | 32 | # now start with libqpe |
31 | echo "Creating docu for qpe" | 33 | echo "Creating docu for qpe" |
32 | cp $OPIEDIR/doc/Doxyfile_libqpe $OPIEDIR/library/Doxyfile | 34 | cp $OPIEDIR/doc/Doxyfile_libqpe $OPIEDIR/library/Doxyfile |
33 | cd $OPIEDIR/library | 35 | cd $OPIEDIR/library |
34 | doxygen Doxyfile | 36 | doxygen Doxyfile |
35 | rm -f Doxyfile | 37 | rm -f Doxyfile |
36 | 38 | ||
37 | # now do libopie | 39 | # now do libopie |
38 | echo "Creating docu for libopie" | 40 | echo "Creating docu for libopie" |
39 | cp $OPIEDIR/doc/Doxyfile_libopie $OPIEDIR/libopie/Doxyfile | 41 | cp $OPIEDIR/doc/Doxyfile_libopie $OPIEDIR/libopie/Doxyfile |
40 | cd $OPIEDIR/libopie | 42 | cd $OPIEDIR/libopie |
41 | doxygen Doxyfile | 43 | doxygen Doxyfile |
42 | rm -f Doxyfile | 44 | rm -f Doxyfile |
43 | 45 | ||
44 | echo "Creating docu for PIM" | 46 | echo "Creating docu for PIM" |
45 | # now it's time for libopie/pim | 47 | # now it's time for libopie/pim |
46 | cp $OPIEDIR/doc/Doxyfile_pim $OPIEDIR/libopie/pim/Doxyfile | 48 | cp $OPIEDIR/doc/Doxyfile_pim $OPIEDIR/libopie/pim/Doxyfile |
47 | cd $OPIEDIR/libopie/pim | 49 | cd $OPIEDIR/libopie/pim |
48 | doxygen Doxyfile | 50 | doxygen Doxyfile |
49 | rm -f Doxyfile | 51 | rm -f Doxyfile |
50 | 52 | ||
51 | echo "Creating docu for NetworkSettings" | 53 | echo "Creating docu for NetworkSettings" |
52 | # now do networksettings | 54 | # now do networksettings |
53 | cp $OPIEDIR/doc/Doxyfile_net $OPIEDIR/noncore/settings/networksettings/Doxyfile | 55 | cp $OPIEDIR/doc/Doxyfile_net $OPIEDIR/noncore/settings/networksettings/Doxyfile |
54 | cd $OPIEDIR/noncore/settings/networksettings | 56 | cd $OPIEDIR/noncore/settings/networksettings |
55 | doxygen Doxyfile | 57 | doxygen Doxyfile |
56 | rm -f Doxyfile | 58 | rm -f Doxyfile |
57 | 59 | ||
58 | echo "Creating docu for Opie2 Core" | 60 | echo "Creating docu for Opie2 Core" |
59 | # now do networksettings | 61 | # now do networksettings |
60 | cp $OPIEDIR/doc/Doxyfile_core2 $OPIEDIR/libopie2/opiecore/Doxyfile | 62 | cp $OPIEDIR/doc/Doxyfile_core2 $OPIEDIR/libopie2/opiecore/Doxyfile |
61 | cd $OPIEDIR/libopie2/opiecore | 63 | cd $OPIEDIR/libopie2/opiecore |
62 | doxygen Doxyfile | 64 | doxygen Doxyfile |
63 | rm -f Doxyfile | 65 | rm -f Doxyfile |
64 | 66 | ||
65 | echo "Creating docu for Opie2 DB" | 67 | echo "Creating docu for Opie2 DB" |
66 | # now do networksettings | 68 | # now do networksettings |
67 | cp $OPIEDIR/doc/Doxyfile_db2 $OPIEDIR/libopie2/opiedb/Doxyfile | 69 | cp $OPIEDIR/doc/Doxyfile_db2 $OPIEDIR/libopie2/opiedb/Doxyfile |
68 | cd $OPIEDIR/libopie2/opiedb | 70 | cd $OPIEDIR/libopie2/opiedb |
69 | doxygen Doxyfile | 71 | doxygen Doxyfile |
70 | rm -f Doxyfile | 72 | rm -f Doxyfile |
71 | 73 | ||
72 | echo "Creating docu for Opie2 mm" | 74 | echo "Creating docu for Opie2 mm" |
73 | # now do networksettings | 75 | # now do networksettings |
74 | cp $OPIEDIR/doc/Doxyfile_mm2 $OPIEDIR/libopie2/opiemm/Doxyfile | 76 | cp $OPIEDIR/doc/Doxyfile_mm2 $OPIEDIR/libopie2/opiemm/Doxyfile |
75 | cd $OPIEDIR/libopie2/opiemm | 77 | cd $OPIEDIR/libopie2/opiemm |
76 | doxygen Doxyfile | 78 | doxygen Doxyfile |
77 | rm -f Doxyfile | 79 | rm -f Doxyfile |
78 | 80 | ||
79 | echo "Creating docu for Opie2 net" | 81 | echo "Creating docu for Opie2 net" |
80 | # now do networksettings | 82 | # now do networksettings |
81 | cp $OPIEDIR/doc/Doxyfile_net2 $OPIEDIR/libopie2/opienet/Doxyfile | 83 | cp $OPIEDIR/doc/Doxyfile_net2 $OPIEDIR/libopie2/opienet/Doxyfile |
82 | cd $OPIEDIR/libopie2/opienet | 84 | cd $OPIEDIR/libopie2/opienet |
83 | doxygen Doxyfile | 85 | doxygen Doxyfile |
84 | rm -f Doxyfile | 86 | rm -f Doxyfile |
85 | 87 | ||
86 | echo "Creating docu for Opie2 ui" | 88 | echo "Creating docu for Opie2 ui" |
87 | # now do networksettings | 89 | # now do networksettings |
88 | cp $OPIEDIR/doc/Doxyfile_ui2 $OPIEDIR/libopie2/opieui/Doxyfile | 90 | cp $OPIEDIR/doc/Doxyfile_ui2 $OPIEDIR/libopie2/opieui/Doxyfile |
89 | cd $OPIEDIR/libopie2/opieui | 91 | cd $OPIEDIR/libopie2/opieui |
90 | doxygen Doxyfile | 92 | doxygen Doxyfile |
91 | rm -f Doxyfile | 93 | rm -f Doxyfile |
92 | 94 | ||
93 | echo "Creating docu for Opie2 pim" | 95 | echo "Creating docu for Opie2 pim" |
94 | # now do networksettings | 96 | # now do networksettings |
95 | cp $OPIEDIR/doc/Doxyfile_pim2 $OPIEDIR/libopie2/opiepim/Doxyfile | 97 | cp $OPIEDIR/doc/Doxyfile_pim2 $OPIEDIR/libopie2/opiepim/Doxyfile |
96 | cd $OPIEDIR/libopie2/opiepim | 98 | cd $OPIEDIR/libopie2/opiepim |
97 | doxygen Doxyfile | 99 | doxygen Doxyfile |
98 | rm -f Doxyfile | 100 | rm -f Doxyfile |
99 | 101 | ||
100 | echo "Making mainpage" | 102 | echo "Making mainpage" |
101 | # now generate the mainpage | 103 | # now generate the mainpage |
102 | cp $OPIEDIR/doc/Doxyfile_main $OPIEDIR/Doxyfile | 104 | cp $OPIEDIR/doc/Doxyfile_main $OPIEDIR/Doxyfile |
103 | cp $OPIEDIR/doc/Mainpage.dox $OPIEDIR/ | 105 | cp $OPIEDIR/doc/Mainpage.dox $OPIEDIR/ |
104 | cd $OPIEDIR | 106 | cd $OPIEDIR |
105 | doxygen Doxyfile | 107 | doxygen Doxyfile |
106 | rm -f Doxyfile | 108 | rm -f Doxyfile |
107 | rm -f Mainpage.dox | 109 | rm -f Mainpage.dox |
108 | 110 | ||
109 | echo "Done with generation!!! hopefully grin" | 111 | echo "Done with generation!!! hopefully grin" |