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
@@ -331,9 +331,25 @@ const QArray<int>& AppLnk::categories() const
   \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()
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
@@ -486,9 +486,9 @@ QString Categories::displaySingle( const QString &app,
 	    r = strs.join(" ");
 	    break;
 	}
     }
-    else r = strs.first(); 	
+    else r = strs.first();
     return r;
 }
 
 /*!
@@ -847,13 +847,8 @@ void CheckedListView::setChecked( const QStringList &checked )
   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
 */
@@ -876,9 +871,9 @@ void CheckedListView::setChecked( const QStringList &checked )
 
   \a cats is a const reference to this object
   \a appname is the CategoryGroup application name that the category was added to or QString::null if it was global
   \a uid is the unique identifier associated with the added category
-*/	
+*/
 
 /*! \fn void Categories::categoryRemoved( const Categories &cats, const QString &appname,
   int uid)
 
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
@@ -84,9 +84,9 @@ private:
     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:
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
@@ -166,15 +166,15 @@ Qtopia::UidGen Event::sUidGen( Qtopia::UidGen::Qtopia );
   \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.
 */
 
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
@@ -31,11 +31,23 @@ 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() { }
diff --git a/library/datebookdb.cpp b/library/datebookdb.cpp
index 0fedfa8..2f33255 100644
--- a/library/datebookdb.cpp
+++ b/library/datebookdb.cpp
@@ -70,9 +70,9 @@ bool nextOccurance(const Event &e, const QDate &from, QDateTime &next)
     int iday, imonth, iyear;
     int dayOfWeek = 0;
     int firstOfWeek = 0;
     int weekOfMonth;
-    
+
 
     if (e.repeatPattern().hasEndDate && e.repeatPattern().endDate() < from)
 	return FALSE;
 
@@ -460,9 +460,9 @@ QValueList<EffectiveEvent> DateBookDB::getEffectiveEvents( const QDate &from,
     QDateTime dtTmp,
 	      dtEnd;
 
     for (it = eventList.begin(); it != eventList.end(); ++it ) {
-	if (!(*it).isValidUid()) 
+	if (!(*it).isValidUid())
 	    (*it).assignUid(); // FIXME: Hack to restore cleared uids
 
         dtTmp = (*it).start(TRUE);
 	dtEnd = (*it).end(TRUE);
@@ -505,9 +505,9 @@ QValueList<EffectiveEvent> DateBookDB::getEffectiveEvents( const QDate &from,
     }
     // check for repeating events...
     QDateTime repeat;
     for ( it = repeatEvents.begin(); it != repeatEvents.end(); ++it ) {
-	if (!(*it).isValidUid()) 
+	if (!(*it).isValidUid())
 	    (*it).assignUid(); // FIXME: Hack to restore cleared uids
 
 	/* create a false end date, to short circuit on hard
 	   MonthlyDay recurences */
@@ -622,9 +622,9 @@ void DateBookDB::editEvent( const Event &old, Event &editedEv )
     // Delete old event
     if ( old.hasAlarm() )
 	delEventAlarm( old );
     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
 	    // assumption, when someone edits a repeating event, they
 	    // want to change them all, maybe not perfect, but it works
 	    // for the moment...
@@ -671,9 +671,9 @@ void DateBookDB::removeJFEvent( const Event&ev )
 
 // also handles journaling...
 void DateBookDB::loadFile( const QString &strFile )
 {
-    
+
     QFile f( strFile );
     if ( !f.open( IO_ReadOnly ) )
 	return;
 
@@ -722,9 +722,9 @@ void DateBookDB::loadFile( const QString &strFile )
     dict.insert( "action", new int(FAction) );
     dict.insert( "actionkey", new int(FActionKey) );
     dict.insert( "actionorig", new int (FJournalOrigHadRepeat) );
 
-    
+
     QByteArray ba = f.readAll();
     char* dt = ba.data();
     int len = ba.size();
     int currentAction,
diff --git a/library/finddialog.cpp b/library/finddialog.cpp
index d9f430a..ddf41a7 100644
--- a/library/finddialog.cpp
+++ b/library/finddialog.cpp
@@ -27,8 +27,15 @@
 
 #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 )
 {
diff --git a/library/global.cpp b/library/global.cpp
index 68a3a75..ce39751 100644
--- a/library/global.cpp
+++ b/library/global.cpp
@@ -109,9 +109,9 @@ StartingAppList::StartingAppList( QObject *parent, const char* name )
 {
 #if QT_VERSION >= 232 && defined(QWS)
     connect( qwsServer, SIGNAL( newChannel(const QString&)),
 	     this, SLOT( handleNewChannel(const QString&)) );
-#endif	     
+#endif
     dict.setAutoDelete( TRUE );
 }
 
 void StartingAppList::add( const QString& name )
@@ -387,9 +387,9 @@ void Global::createDocDir()
   in the taskbar for a short amount of time, then disappears.
 */
 void Global::statusMessage(const QString& message)
 {
-#if!defined(QT_NO_COP)
+#if !defined(QT_NO_COP)
     QCopEnvelope e( "QPE/TaskBar", "message(QString)" );
     e << message;
 #endif
 }
@@ -560,9 +560,9 @@ void Global::invoke(const QString &c)
     // XXX should lock file /tmp/qcop-msg-ap
     if ( QCopChannel::isRegistered( ("QPE/Application/" + ap).latin1() ) ) {
 	// If the channel is already register, the app is already running, so show it.
 	{ QCopEnvelope env( ("QPE/Application/" + ap).latin1(), "raise()" ); }
-                
+
 	QCopEnvelope e("QPE/System", "notBusy(QString)" );
 	e << ap;
 	return;
     }
@@ -603,16 +603,16 @@ void Global::invoke(const QString &c)
 	qDebug("calling quickexec %s", libexe.latin1() );
 	quickexecv( libexe.utf8().data(), (const char **)args );
     } else
 #endif
-    {           
-        bool success = false; 
+    {
+        bool success = false;
         int pfd [2];
         if ( ::pipe ( pfd ) < 0 )
             pfd [0] = pfd [1] = -1;
-    
+
         pid_t pid = ::fork ( );
-        
+
         if ( pid == 0 ) { // child
             for ( int fd = 3; fd < 100; fd++ ) {
                 if ( fd != pfd [1] )
                     ::close ( fd );
@@ -621,22 +621,22 @@ void Global::invoke(const QString &c)
 
             // Closing of fd[1] indicates that the execvp succeeded!
             if ( pfd [1] >= 0 )
                 ::fcntl ( pfd [1], F_SETFD, FD_CLOEXEC );
-             
+
             // Try bindir first, so that foo/bar works too
             ::execv ( qpeDir ( ) + "/bin/" + args [0], (char * const *) args );
             ::execvp ( args [0], (char * const *) args );
-            
+
             char resultByte = 1;
             if ( pfd [1] >= 0 )
                 ::write ( pfd [1], &resultByte, 1 );
-            ::_exit ( -1 );                         
+            ::_exit ( -1 );
         }
         else if ( pid > 0 ) {
             success = true;
-        
-            if ( pfd [1] >= 0 ) 
+
+            if ( pfd [1] >= 0 )
                 ::close ( pfd [1] );
             if ( pfd [0] >= 0 ) {
                 while ( true ) {
                     char resultByte;
@@ -646,15 +646,15 @@ void Global::invoke(const QString &c)
                         break;
                     }
                     if (( n == -1 ) && (( errno == ECHILD ) || ( errno == EINTR )))
                         continue;
-                        
+
                     break; // success
                 }
                 ::close ( pfd [0] );
             }
         }
-        if ( success )    
+        if ( success )
             StartingAppList::add( list[0] );
         else
             QMessageBox::warning( 0, "Error", "Could not start the application " + c, "Ok", 0, 0, 0, 1 );
     }
diff --git a/library/qpeapplication.cpp b/library/qpeapplication.cpp
index c562f6c..2ef60d5 100644
--- a/library/qpeapplication.cpp
+++ b/library/qpeapplication.cpp
@@ -449,9 +449,9 @@ static void setTreble( int t = 0, int percent = -1 )
     Sunday.
 */
 
 /*!
-    \fn void QPEApplication::dateFormatChanged()
+    \fn void QPEApplication::dateFormatChanged(DateFormat)
 
     This signal is emitted whenever the date format is changed.
 */
 
@@ -1767,8 +1767,9 @@ void operator delete[]( void* p, size_t /*size*/ )
 {
 	free( p );
 }
 
+
 void operator delete( void* p )
 {
 	free( p );
 }
diff --git a/library/storage.cpp b/library/storage.cpp
index f4c1c02..12f9df9 100644
--- a/library/storage.cpp
+++ b/library/storage.cpp
@@ -199,9 +199,9 @@ bool deviceTab( const char *device) {
     return hasDevice;
 }
 
 /*!
- * @fn hasCf()
+ * @fn static bool StorageInfo::hasCf()
  * @brief returns whether device has Cf mounted
  *
  */
 bool StorageInfo::hasCf()
@@ -209,9 +209,9 @@ bool StorageInfo::hasCf()
     return deviceTab("/dev/hd");
 }
 
 /*!
- * @fn hasSd()
+ * @fn static bool StorageInfo::hasSd()
  * @brief returns whether device has SD mounted
  *
  */
 bool StorageInfo::hasSd()
@@ -219,9 +219,9 @@ bool StorageInfo::hasSd()
     return deviceTab("/dev/mmcd");
 }
 
 /*!
- * @fn hasMmc()
+ * @fn static bool StorageInfo::hasMmc()
  * @brief reutrns whether device has mmc mounted
  *
  */
 bool StorageInfo::hasMmc()