Fix API docu

10 files changed, 65 insertions, 34 deletions

diff --git a/library/applnk.cpp b/library/applnk.cpp
index 35822dd..00030e8 100644
--- a/library/applnk.cpp
+++ b/library/applnk.cpp
@@ -334,3 +334,19 @@ const QArray<int>& AppLnk::categories() const
 */
+/*!
+  \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
+*/
 /*!
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
@@ -489,3 +489,3 @@ QString Categories::displaySingle( const QString &app,
     }
-    else r = strs.first(); 	
+    else r = strs.first();
     return r;
@@ -850,7 +850,2 @@ void CheckedListView::setChecked( const QStringList &checked )
 
-/*! \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
@@ -879,3 +874,3 @@ void CheckedListView::setChecked( const QStringList &checked )
   \a uid is the unique identifier associated with the added category
-*/	
+*/
 
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
@@ -87,3 +87,3 @@ private:
 
-/** Map from application name to categories */
+/* Map from application name to categories */
 class QPC_EXPORT Categories : public QObject
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
@@ -169,3 +169,3 @@ Qtopia::UidGen Event::sUidGen( Qtopia::UidGen::Qtopia );
 /*!
-  \fn QDateTime Event::start() const
+  \fn QDateTime Event::start(bool) const
 
@@ -175,3 +175,3 @@ Qtopia::UidGen Event::sUidGen( Qtopia::UidGen::Qtopia );
 /*!
-  \fn QDateTime Event::end() const
+  \fn QDateTime Event::end(bool) const
 
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
@@ -34,2 +34,6 @@ QPC_TEMPLATEEXTERN template class QPC_EXPORT QMap<QString, QString>;
 class QRegExp;
+/**
+ * @short Qtopia namespace
+ * The namespace of Qtopia
+ */
 namespace Qtopia {
@@ -37,2 +41,10 @@ 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
diff --git a/library/datebookdb.cpp b/library/datebookdb.cpp
index 0fedfa8..2f33255 100644
--- a/library/datebookdb.cpp
+++ b/library/datebookdb.cpp
@@ -73,3 +73,3 @@ bool nextOccurance(const Event &e, const QDate &from, QDateTime &next)
     int weekOfMonth;
-    
+
 
@@ -463,3 +463,3 @@ QValueList<EffectiveEvent> DateBookDB::getEffectiveEvents( const QDate &from,
     for (it = eventList.begin(); it != eventList.end(); ++it ) {
-	if (!(*it).isValidUid()) 
+	if (!(*it).isValidUid())
 	    (*it).assignUid(); // FIXME: Hack to restore cleared uids
@@ -508,3 +508,3 @@ QValueList<EffectiveEvent> DateBookDB::getEffectiveEvents( const QDate &from,
     for ( it = repeatEvents.begin(); it != repeatEvents.end(); ++it ) {
-	if (!(*it).isValidUid()) 
+	if (!(*it).isValidUid())
 	    (*it).assignUid(); // FIXME: Hack to restore cleared uids
@@ -625,3 +625,3 @@ void DateBookDB::editEvent( const Event &old, Event &editedEv )
     if ( oldHadRepeat ) {
-	if ( editedEv.hasRepeat() ) { // This mean that origRepeat was run above and 
+	if ( editedEv.hasRepeat() ) { // This mean that origRepeat was run above and
  	                              // orig is initialized
@@ -674,3 +674,3 @@ void DateBookDB::loadFile( const QString &strFile )
 {
-    
+
     QFile f( strFile );
@@ -725,3 +725,3 @@ void DateBookDB::loadFile( const QString &strFile )
 
-    
+
     QByteArray ba = f.readAll();
diff --git a/library/finddialog.cpp b/library/finddialog.cpp
index d9f430a..ddf41a7 100644
--- a/library/finddialog.cpp
+++ b/library/finddialog.cpp
@@ -30,2 +30,9 @@
 
+/*!
+  \class FindDialog finddialog.h
+  \brief A simple FindDialog
+
+  A find dialog. FIXME!!!!
+
+*/
 FindDialog::FindDialog( const QString &appName, QWidget *parent,
diff --git a/library/global.cpp b/library/global.cpp
index 68a3a75..ce39751 100644
--- a/library/global.cpp
+++ b/library/global.cpp
@@ -112,3 +112,3 @@ StartingAppList::StartingAppList( QObject *parent, const char* name )
 	     this, SLOT( handleNewChannel(const QString&)) );
-#endif	     
+#endif
     dict.setAutoDelete( TRUE );
@@ -390,3 +390,3 @@ void Global::statusMessage(const QString& message)
 {
-#if!defined(QT_NO_COP)
+#if !defined(QT_NO_COP)
     QCopEnvelope e( "QPE/TaskBar", "message(QString)" );
@@ -563,3 +563,3 @@ void Global::invoke(const QString &c)
 	{ QCopEnvelope env( ("QPE/Application/" + ap).latin1(), "raise()" ); }
-                
+
 	QCopEnvelope e("QPE/System", "notBusy(QString)" );
@@ -606,4 +606,4 @@ void Global::invoke(const QString &c)
 #endif
-    {           
-        bool success = false; 
+    {
+        bool success = false;
         int pfd [2];
@@ -611,5 +611,5 @@ void Global::invoke(const QString &c)
             pfd [0] = pfd [1] = -1;
-    
+
         pid_t pid = ::fork ( );
-        
+
         if ( pid == 0 ) { // child
@@ -624,3 +624,3 @@ void Global::invoke(const QString &c)
                 ::fcntl ( pfd [1], F_SETFD, FD_CLOEXEC );
-             
+
             // Try bindir first, so that foo/bar works too
@@ -628,3 +628,3 @@ void Global::invoke(const QString &c)
             ::execvp ( args [0], (char * const *) args );
-            
+
             char resultByte = 1;
@@ -632,3 +632,3 @@ void Global::invoke(const QString &c)
                 ::write ( pfd [1], &resultByte, 1 );
-            ::_exit ( -1 );                         
+            ::_exit ( -1 );
         }
@@ -636,4 +636,4 @@ void Global::invoke(const QString &c)
             success = true;
-        
-            if ( pfd [1] >= 0 ) 
+
+            if ( pfd [1] >= 0 )
                 ::close ( pfd [1] );
@@ -649,3 +649,3 @@ void Global::invoke(const QString &c)
                         continue;
-                        
+
                     break; // success
@@ -655,3 +655,3 @@ void Global::invoke(const QString &c)
         }
-        if ( success )    
+        if ( success )
             StartingAppList::add( list[0] );
diff --git a/library/qpeapplication.cpp b/library/qpeapplication.cpp
index c562f6c..2ef60d5 100644
--- a/library/qpeapplication.cpp
+++ b/library/qpeapplication.cpp
@@ -452,3 +452,3 @@ static void setTreble( int t = 0, int percent = -1 )
 /*!
-    \fn void QPEApplication::dateFormatChanged()
+    \fn void QPEApplication::dateFormatChanged(DateFormat)
 
@@ -1770,2 +1770,3 @@ void operator delete[]( void* p, size_t /*size*/ )
 
+
 void operator delete( void* p )
diff --git a/library/storage.cpp b/library/storage.cpp
index f4c1c02..12f9df9 100644
--- a/library/storage.cpp
+++ b/library/storage.cpp
@@ -202,3 +202,3 @@ bool deviceTab( const char *device) {
 /*!
- * @fn hasCf()
+ * @fn static bool StorageInfo::hasCf()
  * @brief returns whether device has Cf mounted
@@ -212,3 +212,3 @@ bool StorageInfo::hasCf()
 /*!
- * @fn hasSd()
+ * @fn static bool StorageInfo::hasSd()
  * @brief returns whether device has SD mounted
@@ -222,3 +222,3 @@ bool StorageInfo::hasSd()
 /*!
- * @fn hasMmc()
+ * @fn static bool StorageInfo::hasMmc()
  * @brief reutrns whether device has mmc mounted