Fix API docu

10 files changed, 43 insertions, 12 deletions

diff --git a/library/applnk.cpp b/library/applnk.cpp
index 35822dd..00030e8 100644
--- a/library/applnk.cpp
+++ b/library/applnk.cpp
@@ -323,25 +323,41 @@ const QArray<int>& AppLnk::categories() const
   Returns the id of the AppLnk. If the AppLnk is not in an AppLnkSet,
   this value is 0, otherwise it is a value that is unique for the
   duration of the current process.
 
   \sa AppLnkSet::find()
 */
 
 /*!
   \fn bool AppLnk::isValid() const
 
   Returns TRUE if this AppLnk is valid; otherwise returns FALSE.
 */
+/*!
+  \fn bool AppLnk::fileKnown() const
+
+  If the with the AppLnk associated file is not equal to QString::null
+*/
+/*!
+  \fn bool AppLnk::linkFileKnown()const
+
+  The filename of the AppLnk
 
+*/
+/*!
+  \fn void AppLnk::setRotation( const QString& )
+
+  The default rotation of the associated application. This
+  function is included inline for binary compatible issues
+*/
 /*!
   Creates an invalid AppLnk.
 
   \sa isValid()
 */
 AppLnk::AppLnk()
 {
     mId = 0;
     d = new AppLnkPrivate();
 }
 
 /*!
diff --git a/library/backend/categories.cpp b/library/backend/categories.cpp
index 2e84089..cce9f38 100644
--- a/library/backend/categories.cpp
+++ b/library/backend/categories.cpp
@@ -839,29 +839,24 @@ void CheckedListView::setChecked( const QStringList &checked )
 	   }
 	}
        else
 	   i->setOn( FALSE );
 }
 
 /*! \fn Categories &Categories::operator= ( const Categories &c )
 
   Performs deep copy.
  */
 
 
-/*! \fn  QStringList Categories::labels( const QString & app, const QArray<int> &catids ) const
-
-  Returns list of labels associated with the application and catids
-*/
-
 /*! \fn QStringList Categories::globalCategories() const
 
   Returns list of all global category labels
 */
 
 /*! \fn const QMap<QString, CategoryGroup> &Categories::appGroupMap() const
 
   Returns a map of application names to CategoryGroup. The CategoryGroup
   class defines a map of ids to category labels and category labels to ids.
 */
 
 /*! \fn const CategoryGroup &Categories::globalGroup() const
diff --git a/library/backend/categories.h b/library/backend/categories.h
index ba65ee3..d5b3669 100644
--- a/library/backend/categories.h
+++ b/library/backend/categories.h
@@ -76,25 +76,25 @@ public:
 
     const QMap<int, QString> &idMap() const { return mIdLabelMap; }
 
 private:
     void insert( int uid, const QString &label );
     QMap<int, QString> mIdLabelMap;
     QMap<QString, int> mLabelIdMap;
 
     static Qtopia::UidGen &uidGen() { return sUidGen; }
     static Qtopia::UidGen sUidGen;
 };
 
-/** Map from application name to categories */
+/* Map from application name to categories */
 class QPC_EXPORT Categories : public QObject
 {
     Q_OBJECT
 public:
     Categories( QObject *parent=0, const char *name = 0 )
 	: QObject( parent, name ),  mGlobalCats(), mAppCats() { }
     Categories( const Categories &copyFrom ) : QObject( copyFrom.parent() ),
 	mGlobalCats( copyFrom.mGlobalCats ),
     mAppCats( copyFrom.mAppCats ) { }
     virtual ~Categories() { }
 
     Categories &operator= ( const Categories &c )
diff --git a/library/backend/event.cpp b/library/backend/event.cpp
index d906f19..4c24ab3 100644
--- a/library/backend/event.cpp
+++ b/library/backend/event.cpp
@@ -158,31 +158,31 @@ Qtopia::UidGen Event::sUidGen( Qtopia::UidGen::Qtopia );
 */
 
 /*!
   \fn void Event::setAllDay(bool allday)
 
   If \a allday is TRUE, will set the event to be an all day event.
   Otherwise sets the event to not be an all day event.
 
   \warning This function may affect the start and end times of the event.
 */
 
 /*!
-  \fn QDateTime Event::start() const
+  \fn QDateTime Event::start(bool) const
 
   Returns the start date and time of the first occurance of the event.
 */
 
 /*!
-  \fn QDateTime Event::end() const
+  \fn QDateTime Event::end(bool) const
 
   Returns the end date and time of the first occurance of the event.
 */
 
 /*!
   \fn time_t Event::startTime() const
   \internal
 */
 
 /*!
   \fn time_t Event::endTime() const
   \internal
diff --git a/library/backend/palmtoprecord.h b/library/backend/palmtoprecord.h
index 72f7d1c..15cdd6a 100644
--- a/library/backend/palmtoprecord.h
+++ b/library/backend/palmtoprecord.h
@@ -23,27 +23,39 @@
 #include "qpcglobal.h"
 #include "palmtopuidgen.h"
 #include <qarray.h>
 #include <qmap.h>
 
 #if defined(QPC_TEMPLATEDLL)
 // MOC_SKIP_BEGIN
 QPC_TEMPLATEEXTERN template class QPC_EXPORT QMap<QString, QString>;
 // MOC_SKIP_END
 #endif
 
 class QRegExp;
+/**
+ * @short Qtopia namespace
+ * The namespace of Qtopia
+ */
 namespace Qtopia {
 
 class RecordPrivate;
+/**
+ * @short The base class of all Records
+ *
+ * The base class for Records in Qtopia
+ * @see Task
+ * @see Event
+ * @see Contact
+ */
 class QPC_EXPORT Record
 {
 public:
     Record() : mUid(0), mCats() { }
     Record( const Record &c ) :	mUid( c.mUid ), mCats ( c.mCats ), customMap(c.customMap) { }
     virtual ~Record() { }
 
     Record &operator=( const Record &c );
 
     virtual bool match( const QRegExp & ) const { return FALSE; }
 
     void setCategories( const QArray<int> &v ) { mCats = v; mCats.sort(); }
diff --git a/library/datebookdb.cpp b/library/datebookdb.cpp
index 0fedfa8..2f33255 100644
--- a/library/datebookdb.cpp
+++ b/library/datebookdb.cpp
diff --git a/library/finddialog.cpp b/library/finddialog.cpp
index d9f430a..ddf41a7 100644
--- a/library/finddialog.cpp
+++ b/library/finddialog.cpp
@@ -19,24 +19,31 @@
 **********************************************************************/
 
 // WARNING: Do *NOT* define this yourself. The SL5xxx from SHARP does NOT
 //      have this class.
 #define QTOPIA_INTERNAL_FD
 
 #include "finddialog.h"
 #include "findwidget_p.h"
 
 #include <qlayout.h>
 #include <qpushbutton.h>
 
+/*!
+  \class FindDialog finddialog.h
+  \brief A simple FindDialog
+
+  A find dialog. FIXME!!!!
+
+*/
 FindDialog::FindDialog( const QString &appName, QWidget *parent,
                         const char *name, bool modal )
     : QDialog( parent, name, modal )
 {
     setCaption( tr("Find") );
     QVBoxLayout *vb;
     vb = new QVBoxLayout( this );
     fw = new FindWidget( appName, this, "Find Widget" );
     vb->addWidget( fw );
     QObject::connect( fw, SIGNAL(signalFindClicked(const QString&,
 						   bool,bool,int)),
 		      this, SIGNAL(signalFindClicked(const QString&,
diff --git a/library/global.cpp b/library/global.cpp
index 68a3a75..ce39751 100644
--- a/library/global.cpp
+++ b/library/global.cpp
diff --git a/library/qpeapplication.cpp b/library/qpeapplication.cpp
index c562f6c..2ef60d5 100644
--- a/library/qpeapplication.cpp
+++ b/library/qpeapplication.cpp
@@ -441,25 +441,25 @@ static void setTreble( int t = 0, int percent = -1 )
 */
 
 /*!
     \fn void QPEApplication::weekChanged( bool startOnMonday )
 
     This signal is emitted if the week start day is changed. If \a
     startOnMonday is TRUE then the first day of the week is Monday; if
     \a startOnMonday is FALSE then the first day of the week is
     Sunday.
 */
 
 /*!
-    \fn void QPEApplication::dateFormatChanged()
+    \fn void QPEApplication::dateFormatChanged(DateFormat)
 
     This signal is emitted whenever the date format is changed.
 */
 
 /*!
     \fn void QPEApplication::flush()
 
     ###
 */
 
 /*!
   \fn void QPEApplication::reload()
@@ -1759,24 +1759,25 @@ void* operator new( size_t size )
 }
 
 void operator delete[]( void* p )
 {
 	free( p );
 }
 
 void operator delete[]( void* p, size_t /*size*/ )
 {
 	free( p );
 }
 
+
 void operator delete( void* p )
 {
 	free( p );
 }
 
 void operator delete( void* p, size_t /*size*/ )
 {
 	free( p );
 }
 
 #endif
 
diff --git a/library/storage.cpp b/library/storage.cpp
index f4c1c02..12f9df9 100644
--- a/library/storage.cpp
+++ b/library/storage.cpp
@@ -191,45 +191,45 @@ bool deviceTab( const char *device) {
           QString deviceName = me->mnt_fsname;
 //          qDebug(deviceName);
             if( deviceName.left(name.length()) == name) {
                hasDevice = true;
             }
         }
     }
     endmntent( mntfp );
     return hasDevice;
 }
 
 /*!
- * @fn hasCf()
+ * @fn static bool StorageInfo::hasCf()
  * @brief returns whether device has Cf mounted
  *
  */
 bool StorageInfo::hasCf()
 {
     return deviceTab("/dev/hd");
 }
 
 /*!
- * @fn hasSd()
+ * @fn static bool StorageInfo::hasSd()
  * @brief returns whether device has SD mounted
  *
  */
 bool StorageInfo::hasSd()
 {
     return deviceTab("/dev/mmcd");
 }
 
 /*!
- * @fn hasMmc()
+ * @fn static bool StorageInfo::hasMmc()
  * @brief reutrns whether device has mmc mounted
  *
  */
 bool StorageInfo::hasMmc()
 {
    bool hasMmc=false;
    if( deviceTab("/dev/mmc/part"))
       hasMmc=true;
    if( deviceTab("/dev/mmcd"))
       hasMmc=true;
    return hasMmc;
 }