Fix API docu

4 files changed, 17 insertions, 10 deletions

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
@@ -466,49 +466,49 @@ QString Categories::label( const QString &app, int id ) const
   set, the just the first string is returned.
 */
 QString Categories::displaySingle( const QString &app,
 				   const QArray<int> &catids,
 				   DisplaySingle display ) const
 {
     QStringList strs = labels( app, catids );
     if ( !strs.count() )
 	return tr("Unfiled");
     strs.sort();
     QString r;
     if ( strs.count() > 1 ) {
 	switch ( display ) {
 	case ShowFirst:
 	    r = strs.first();
 	    break;
 	case ShowMulti:
 	    r = strs.first() + tr(" (multi.)");
 	    break;
 	case ShowAll:
 	    r = strs.join(" ");
 	    break;
 	}
     }
-    else r = strs.first(); 	
+    else r = strs.first();
     return r;
 }
 
 /*!
 
   Returns all ids associated with the application CategoryGroup \a app
   and the passed in \a labels in that group.
 */
 QArray<int> Categories::ids( const QString &app, const QStringList &labels) const
 {
   QArray<int> results;
   QStringList::ConstIterator it;
   int i;
 
   for ( i=0, it=labels.begin(); it!=labels.end(); i++, ++it ) {
     int value = id( app, *it );
     if ( value != 0 ) {
       int tmp = results.size();
       results.resize( tmp + 1 );
       results[ tmp ] = value;
     }
   }
   return results;
 }
@@ -827,78 +827,73 @@ void CheckedListView::setChecked( const QStringList &checked )
     // iterate over all items
     bool showingChecked = FALSE;
     for ( QCheckListItem *i = (QCheckListItem *) firstChild();
 	  i; i = (QCheckListItem *)i->nextSibling() )
 	// see if the item should be checked by searching the
 	// checked list
 	if ( checked.find( i->text( 0 ) ) != checked.end() ) {
 	   i->setOn( TRUE );
 	   // make sure it is showing at least one checked item
 	   if ( !showingChecked ) {
 	       ensureItemVisible( i );
 	       showingChecked = TRUE;
 	   }
 	}
        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
 
   Returns the global CategoryGroup. The CategoryGroup
   class defines a map of ids to category labels and category labels to ids.
 */
 
 /*! \fn void Categories::categoryAdded( const Categories &cats, const QString &appname, int uid)
 
   Emitted if a category is added.
 
   \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)
 
   Emitted if removed category is removed.
 
   \a cats is a const reference to this object
   \a appname is the CategoryGroup application name that the category was removed from or QString::null if it was the global CategoryGroup
   \a uid is the unique identifier associated with the removed category
 */
 
 
 /*! \fn void Categories::categoryRenamed( const Categories &cats, const QString &appname,
   int uid)
 
   Emitted if \a uid in the \a appname CategoryGroup is renamed in \a cats
   object.
 
   \a cats is a const reference to this object
   \a appname is the CategoryGroup application name that the category was renamed in or QString::null if it was the global CategoryGroup
   \a uid is the unique identifier associated with the renamed category
 */
 
 /*! \fn Categories::Categories( QObject *parent=0, const char *name = 0 )
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
@@ -64,49 +64,49 @@ public:
 
     /** Returns label associated with the uid or QString::null if
     *   not found
     */
     const QString &label(int id) const;
     /** Returns the uid associated with label or 0 if not found */
     int id(const QString &label) const;
 
     /** Returns a sorted list of labels */
     QStringList labels() const;
 
     QStringList labels( const QArray<int> &catids ) const;
 
     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 )
 { mAppCats = c.mAppCats; mGlobalCats = c.mGlobalCats; return *this; }
 
     void clear();
 
     /** Add the category name as long as it doesn't already exist
     *  locally or globally.  Return UID if added, 0 if conflicts
     *  (error).
     */
     int addCategory( const QString &appname, const QString &catname);
     /** Add the category name as long as it doesn't already exist
     *  locally or globally.  Return UID if added, 0 if conflicts
     *  (error).
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
@@ -146,55 +146,55 @@ Qtopia::UidGen Event::sUidGen( Qtopia::UidGen::Qtopia );
   <li>\c MonthlyDay - Event occurs every n months.  Event will always occur in
   the same week and same day of week as the first event.
   <li>\c MonthlyDate - Event occurs every n months.  Event will always occur
   on the same day of the month as the first event.
   <li>\c Yearly - Event occurs every n years.
   </ul>
 */
 
 /*!
   \fn bool Event::isAllDay() const
 
   Returns TRUE if the event is an all day event.  Otherwise returns FALSE.
 */
 
 /*!
   \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
 */
 
 /*!
   \fn void Event::setAlarm(int delay, SoundTypeChoice s)
 
   Sets the alarm delay of the event to \a delay and the sound type of the
   alarm to \a s.
 */
 
 /*!
   \fn void Event::clearAlarm()
 
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
@@ -11,51 +11,63 @@
 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 **
 ** See http://www.trolltech.com/gpl/ for GPL licensing information.
 **
 ** Contact info@trolltech.com if any conditions of this licensing are
 ** not clear to you.
 **
 **********************************************************************/
 #ifndef QTPALMTOP_RECORD_H
 #define QTPALMTOP_RECORD_H
 #include <qglobal.h>
 #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(); }
     void setCategories( int single );
     const QArray<int> &categories() const { return mCats; }
 
     void reassignCategoryId( int oldId, int newId )
     {
 	int index = mCats.find( oldId );
 	if ( index >= 0 )
 	    mCats[index] = newId;
     }
 
     int uid() const { return mUid; };
     virtual void setUid( int i ) { mUid = i; uidGen().store( mUid ); }