| -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 @@ /** * @mainpage The OPIE API Reference * * This section contains the OPIE online class reference for the current * development version of OPIE. You can also download (??? MB) * the complete API documentation. Additionally, you can subscribe or * read the mailing lists for any additions and/or modifications to the API. * * - <a href="qt/index.html"><b>qt</b></a> * (<a href="qt/classes.html">classes</a>)\n * <i>Qt classes</i> * - <a href="libqpe/html/index.html"><b>Qtopia library</b></a> * (<a href="libqpe/html/classes.html">classes</a>)\n * <i>Qtopia lib</i> * - <a href="libopie/html/index.html"><b>libopie</b></a> * (<a href="libopie/html/classes.html">classes</a>)\n * <i>libopie</i> * - <a href="pim/html/index.html"><b>PIM</b></a> * (<a href="pim/html/classes.html">classes</a>)\n * <i>Libopie PIM</i> * - <a href="network/html/index.html"><b>Network Settings Modules</b></a> * (<a href="network/html/classes.html">classes</a>)\n * <i>Networksettings</i> * - <a href="core2/html/index.html"><b>Opie2 Core Classes</b></a> * (<a href="core2/html/classes.html">classes</a>)\n * <i>Core Classes</i> + * - <a href="mm2/html/index.html"><b>Opie2 MM Classes</b></a> + * (<a href="mm2/html/classes.html">classes</a>)\n + * <i>Multimedia Classes</i> * - <a href="ui2/html/index.html"><b>Opie2 UI Classes</b></a> * (<a href="ui2/html/classes.html">classes</a>)\n * <i>UI Classes</i> * - <a href="db2/html/index.html"><b>Opie2 DataBase Classes</b></a> * (<a href="db2/html/classes.html">classes</a>)\n * <i>DataBase Classes</i> * - <a href="net2/html/index.html"><b>Opie2 Network Classes</b></a> * (<a href="net2/html/classes.html">classes</a>)\n * <i>Network Classes</i> * - <a href="pim2/html/index.html"><b>Opie2 PIM Classes</b></a> * (<a href="pim2/html/classes.html">classes</a>)\n * <i>PIM Classes</i> * - <a href="libopie2/html/index.html"><b>All Opie2 Classes</b></a> * (<a href="libopie2/html/classes.html">classes</a>)\n * <i>LIB OPIE2</i> */ /** * @page search Search the API documentation * * <br>Under construction. * */ 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 @@ #!/bin/sh # small shell script to generate our API docs # it'll copy over qt # # create directory structure echo "Creating directory structure" rm -rf $OPIEDIR/apidocs mkdir $OPIEDIR/apidocs mkdir $OPIEDIR/apidocs/api mkdir $OPIEDIR/apidocs/common mkdir $OPIEDIR/apidocs/qt mkdir $OPIEDIR/apidocs/libqpe mkdir $OPIEDIR/apidocs/libopie mkdir $OPIEDIR/apidocs/pim mkdir $OPIEDIR/apidocs/network mkdir $OPIEDIR/apidocs/net2 mkdir $OPIEDIR/apidocs/core2 +mkdir $OPIEDIR/apidocs/mm2 mkdir $OPIEDIR/apidocs/pim2 mkdir $OPIEDIR/apidocs/ui2 mkdir $OPIEDIR/apidocs/db2 +mkdir $OPIEDIR/apidocs/libopie2 # now copy qt doc echo "Scanning and copying QT docu" cp -R $QTDIR/doc/html/* $OPIEDIR/apidocs/qt doxytag -t $OPIEDIR/apidocs/qt/qt.tag $OPIEDIR/apidocs/qt cp -r $OPIEDIR/doc/common/* $OPIEDIR/apidocs/common # now start with libqpe echo "Creating docu for qpe" cp $OPIEDIR/doc/Doxyfile_libqpe $OPIEDIR/library/Doxyfile cd $OPIEDIR/library doxygen Doxyfile rm -f Doxyfile # now do libopie echo "Creating docu for libopie" cp $OPIEDIR/doc/Doxyfile_libopie $OPIEDIR/libopie/Doxyfile cd $OPIEDIR/libopie doxygen Doxyfile rm -f Doxyfile echo "Creating docu for PIM" # now it's time for libopie/pim cp $OPIEDIR/doc/Doxyfile_pim $OPIEDIR/libopie/pim/Doxyfile cd $OPIEDIR/libopie/pim doxygen Doxyfile rm -f Doxyfile echo "Creating docu for NetworkSettings" # now do networksettings cp $OPIEDIR/doc/Doxyfile_net $OPIEDIR/noncore/settings/networksettings/Doxyfile cd $OPIEDIR/noncore/settings/networksettings doxygen Doxyfile rm -f Doxyfile echo "Creating docu for Opie2 Core" # now do networksettings cp $OPIEDIR/doc/Doxyfile_core2 $OPIEDIR/libopie2/opiecore/Doxyfile cd $OPIEDIR/libopie2/opiecore doxygen Doxyfile rm -f Doxyfile echo "Creating docu for Opie2 DB" # now do networksettings cp $OPIEDIR/doc/Doxyfile_db2 $OPIEDIR/libopie2/opiedb/Doxyfile cd $OPIEDIR/libopie2/opiedb doxygen Doxyfile rm -f Doxyfile echo "Creating docu for Opie2 mm" # now do networksettings cp $OPIEDIR/doc/Doxyfile_mm2 $OPIEDIR/libopie2/opiemm/Doxyfile cd $OPIEDIR/libopie2/opiemm doxygen Doxyfile rm -f Doxyfile echo "Creating docu for Opie2 net" # now do networksettings cp $OPIEDIR/doc/Doxyfile_net2 $OPIEDIR/libopie2/opienet/Doxyfile cd $OPIEDIR/libopie2/opienet doxygen Doxyfile rm -f Doxyfile echo "Creating docu for Opie2 ui" # now do networksettings cp $OPIEDIR/doc/Doxyfile_ui2 $OPIEDIR/libopie2/opieui/Doxyfile cd $OPIEDIR/libopie2/opieui doxygen Doxyfile rm -f Doxyfile echo "Creating docu for Opie2 pim" # now do networksettings cp $OPIEDIR/doc/Doxyfile_pim2 $OPIEDIR/libopie2/opiepim/Doxyfile cd $OPIEDIR/libopie2/opiepim doxygen Doxyfile rm -f Doxyfile echo "Making mainpage" # now generate the mainpage cp $OPIEDIR/doc/Doxyfile_main $OPIEDIR/Doxyfile cp $OPIEDIR/doc/Mainpage.dox $OPIEDIR/ cd $OPIEDIR doxygen Doxyfile rm -f Doxyfile rm -f Mainpage.dox echo "Done with generation!!! hopefully grin" |