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
@@ -298,639 +298,634 @@ int Categories::addCategory( const QString &appname,
         emit categoryAdded( *this, appname, uid );
         return uid;
     }
 
     CategoryGroup &cats = *appIt;
     int uid = cats.add( catname );
     if ( !uid )
         return 0;
     emit categoryAdded( *this, appname, uid );
     return uid;
 }
 
 /*!
   \internal
 */
 int Categories::addGlobalCategory( const QString &catname, int uid )
 {
     mGlobalCats.add( uid, catname );
     emit categoryAdded( *this, QString::null, uid );
     return uid;
 }
 
 /*!
   Add the global category \a catname while checking that it doesn't
   already exist globally. Return UID if added, 0 if conflicts.
 
   \sa addCategory()
  */
 int Categories::addGlobalCategory( const QString &catname )
 {
     int uid = mGlobalCats.add( catname );
     if ( !uid )
         return 0;
     emit categoryAdded( *this, QString::null, uid );
     return uid;
 }
 
 /*!
 
   Removes the \a catname from the application group. If it is not
   found in the application group and \a checkGlobal is TRUE, then it
   attempts to remove it from the global list
 */
 bool Categories::removeCategory( const QString &appname,
                                  const QString &catname,
                                  bool checkGlobal )
 {
     QMap< QString, CategoryGroup >::Iterator
         appIt = mAppCats.find( appname );
     if ( appIt != mAppCats.end() ) {
         CategoryGroup &cats = *appIt;
         int uid = cats.id( catname );
         if ( cats.remove( uid ) ) {
             emit categoryRemoved( *this, appname, uid );
             return TRUE;
         }
     }
     if ( !checkGlobal )
         return FALSE;
     return removeGlobalCategory( catname );
 }
 
 
 /*!
   Removes the \a uid from the application group \a appname. Returns TRUE
   if success, FALSE if not found.
 */
 bool Categories::removeCategory( const QString &appname, int uid )
 {
     QMap< QString, CategoryGroup >::Iterator
         appIt = mAppCats.find( appname );
     if ( appIt != mAppCats.end() ) {
         CategoryGroup &cats = *appIt;
         if ( cats.remove( uid ) ) {
             emit categoryRemoved( *this, appname, uid );
             return TRUE;
         }
     }
     return FALSE;
 }
 
 /*!
   Removes the global category \a catname. Returns TRUE
   if success, FALSE if not found.
 */
 bool Categories::removeGlobalCategory( const QString &catname )
 {
     int uid = mGlobalCats.id( catname );
     if ( mGlobalCats.remove( uid ) ) {
         emit categoryRemoved( *this, QString::null, uid );
         return TRUE;
     }
     return FALSE;
 }
 
 /*!
   Removes the global category \a uid. Returns TRUE
   if success, FALSE if not found.
 */
 bool Categories::removeGlobalCategory( int uid )
 {
      if ( mGlobalCats.remove( uid ) ) {
         emit categoryRemoved( *this, QString::null, uid );
         return TRUE;
     }
     return FALSE;
 }
 
 /*!
   Returns the sorted list of all categories that are associated with
   the \a app.  If \a includeGlobal is TRUE then the returned
   categories will include the global category items.
  */
 QStringList Categories::labels( const QString &app,
                                 bool includeGlobal,
                                 ExtraLabels extra ) const
 {
     QMap< QString, CategoryGroup >::ConstIterator
         appIt = mAppCats.find( app );
     QStringList cats;
 
     if ( appIt != mAppCats.end() )
         cats += (*appIt).labels();
     //else qDebug("Categories::labels didn't find app %s", app.latin1() );
     if ( includeGlobal )
         cats += mGlobalCats.labels();
 
     cats.sort();
     switch ( extra ) {
     case NoExtra: break;
     case AllUnfiled:
         cats.append( tr("All") );
         cats.append( tr("Unfiled") );
         break;
     case AllLabel:
         cats.append( tr("All") );
         break;
     case UnfiledLabel:
         cats.append( tr("Unfiled") );
         break;
     }
 
     return cats;
 }
 
 /*!
   Returns the label associated with the id
 */
 QString Categories::label( const QString &app, int id ) const
 {
     if ( mGlobalCats.contains( id ) )
         return mGlobalCats.label( id );
     QMap< QString, CategoryGroup >::ConstIterator
         appIt = mAppCats.find( app );
     if ( appIt == mAppCats.end() )
         return QString::null;
     return (*appIt).label( id );
 }
 
 /*!
   Returns a single string associated with \a catids for display in a
   combobox or any area that requires one string.  If \a catids are empty
   then "Unfiled" will be returned.  If multiple categories are
   assigned then the behavior depends on the DisplaySingle type.
 
   If \a display is set to ShowMulti then " (multi)" appended to the
   first string. If \a display is set to ShowAll, then a space
   seperated string is returned with all categories.  If ShowFirst is
   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;
 }
 
 /*!
   Returns the id associated with the app. If the id is not found in the
   application CategoryGroup, then it searches the global CategoryGroup.
   If it is not found it either, 0 is returned.
 */
 int Categories::id( const QString &app, const QString &cat ) const
 {
     if ( cat == tr("Unfiled") || cat.contains( tr(" (multi.)") ) )
         return 0;
     int uid = mGlobalCats.id( cat );
     if ( uid != 0 )
         return uid;
     return mAppCats[app].id( cat );
 }
 
 
 /*!
   Return TRUE if renaming succeeded; FALSE if \a appname or \a oldName
   is not found, or if \a newName conflicts with an existing category
   in the CategoryGroup.
 
   It will first search the CategoryGroup associated with \a appname
   and if not found it will try to replace in global CategoryGroup.
  */
 bool Categories::renameCategory( const QString &appname,
                                  const QString &oldName,
                                  const QString &newName )
 {
     QMap< QString, CategoryGroup >::Iterator
         appIt = mAppCats.find( appname );
 
     if ( appIt != mAppCats.end() ) {
         CategoryGroup &cats = *appIt;
         int id = cats.id( oldName );
         if ( id != 0 && cats.rename( id, newName ) ) {
             emit categoryRenamed( *this, appname, id );
             return TRUE;
         }
     }
     return renameGlobalCategory( oldName, newName );
 }
 
 /*!
   Return TRUE if renaming succeeded; FALSE if \a appname or \a oldName
   is not found, or if \a newName conflicts with an existing category
   in the CategoryGroup. This function will only rename categories found
   in the global CategoryGroup.
  */
 bool Categories::renameGlobalCategory( const QString &oldName,
                                        const QString &newName )
 {
     int uid = mGlobalCats.id( oldName );
     if ( uid != 0 && mGlobalCats.rename( uid, newName ) ) {
         emit categoryRenamed( *this, QString::null, uid );
         return TRUE;
     }
     return FALSE;
 }
 
 /*!
   Changes the grouping of a category. If a category was global and \a global
   is set to TRUE, then the \a catname will be moved to the \a appname group.
 */
 void Categories::setGlobal( const QString &appname,
                             const QString &catname,
                             bool global )
 {
     // if in global and should be in app; then move it
     if ( mGlobalCats.contains( catname ) && !global ) {
         mGlobalCats.remove( catname );
         addCategory( appname, catname );
         return ;
     }
 
     // if in app and should be in global, then move it
     if ( !global )
         return;
     if ( removeCategory( appname, catname, FALSE ) )
         addGlobalCategory( catname );
 }
 
 /*!
   Returns TRUE if the \a catname is in the global CategoryGroup, FALSE if not.
 */
 bool Categories::isGlobal( const QString &catname ) const
 {
     return mGlobalCats.contains( catname );
 }
 
 
 /*!
   Returns true if the \a catname is associated with any CategoryGroup,
   including global.
  */
 bool Categories::exists( const QString &catname ) const
 {
     if ( isGlobal(catname) )
         return TRUE;
 
     for ( QMap<QString, CategoryGroup>::ConstIterator appsIt = mAppCats.begin(); appsIt != mAppCats.end(); ++appsIt )
         if ( exists( appsIt.key(), catname ) )
             return TRUE;
 
     return FALSE;
 }
 
 /*!
   Returns TRUE if the \a catname is associated with the \a appname
   CategoryGroup, FALSE if not found.
  */
 bool Categories::exists( const QString &appname,
                          const QString &catname) const
 {
     QMap< QString, CategoryGroup >::ConstIterator
         appIt = mAppCats.find( appname );
 
     if ( appIt == mAppCats.end() )
         return FALSE;
 
     return (*appIt).contains( catname );
 }
 
 /*!
   Saves the Categories database to the \a fname. See categoryFileName()
   for the default file name string used for the shared category database.
 
   Returns FALSE if there is error writing the file or TRUE on success.
  */
 bool Categories::save( const QString &fname ) const
 {
     QString strNewFile = fname + ".new";
     QFile f( strNewFile );
     QString out;
     int total_written;
 
     if ( !f.open( IO_WriteOnly|IO_Raw ) ) {
         qWarning("Unable to write to %s", fname.latin1());
         return FALSE;
     }
 
     out = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
     out += "<!DOCTYPE CategoryList>\n";
 
     out += "<Categories>\n";
 
     for ( QMap<int, QString>::ConstIterator git = mGlobalCats.idMap().begin();
           git != mGlobalCats.idMap().end(); ++git )
         out += "<Category id=\"" + QString::number(git.key()) + "\"" +
           " name=\"" + escapeString(*git) + "\" />\n";
 
     for ( QMap<QString, CategoryGroup>::ConstIterator appsIt=mAppCats.begin();
           appsIt != mAppCats.end(); ++appsIt ) {
         const QString &app = appsIt.key();
         const QMap<int, QString> &appcats = (*appsIt).idMap();
         for ( QMap<int, QString>::ConstIterator appcatit = appcats.begin();
               appcatit != appcats.end(); ++appcatit )
             out += "<Category id=\"" + QString::number(appcatit.key()) + "\"" +
               " app=\"" + escapeString(app) + "\"" +
               " name=\"" + escapeString(*appcatit) + "\" />\n";
     }
     out += "</Categories>\n";
 
     QCString cstr = out.utf8();
     total_written = f.writeBlock( cstr.data(), cstr.length() );
     if ( total_written != int(cstr.length()) ) {
         f.close();
          QFile::remove( strNewFile );
          return FALSE;
     }
     f.close();
 
 #ifdef Q_OS_WIN32
     QFile::remove( fname );
 #endif
     if ( ::rename( strNewFile.latin1(), fname.latin1() ) < 0 ) {
         qWarning( "problem renaming file %s to %s",
                   strNewFile.latin1(), fname.latin1());
         // remove the tmp file...
         QFile::remove( strNewFile );
     }
 
     return TRUE;
 }
 
 /*!
   Loads the Categories database using \a fname. See categoryFileName()
   for the default file name string used for the shared category database.
 
   Returns FALSE if there is error reading the file or TRUE on success.
  */
 bool Categories::load( const QString &fname )
 {
     QFile file( fname );
     if ( !file.open( IO_ReadOnly ) ) {
         qWarning("Unable to open %s", fname.latin1());
 
         addGlobalCategory(tr("Business"));
         addGlobalCategory(tr("Personal"));
         save(fname);
 
         return FALSE;
     }
 
     clear();
     QByteArray ba = file.readAll();
     QString data = QString::fromUtf8( ba.data(), ba.size() );
     QChar *uc = (QChar *)data.unicode();
     int len = data.length();
 
     //     QTime t;
     //     t.start();
     QString name;
     QString id;
     QString app;
     int i = 0;
     while ( (i = data.find( "<Category ",  i)) != -1 ) {
 
         i += 10;
         name = QString::null;
         app = QString::null;
         while ( 1 ) {
             // skip white space
             while ( i < len &&
                     (uc[i] == ' ' || uc[i] == '\n' || uc[i] == '\r') )
                 i++;
             // if at the end, then done
             if ( i >= len-2 || (uc[i] == '/' && uc[i+1] == '>') )
                 break;
             // we have another attribute read it.
             int j = i;
             while ( j < len && uc[j] != '=' )
                 j++;
             QString attr = QConstString( uc+i, j-i ).string();
             i = ++j; // skip =
             while ( i < len && uc[i] != '"' )
                 i++;
             j = ++i;
             while ( j < len && uc[j] != '"' )
                 j++;
             QString value = Qtopia::plainString( QConstString( uc+i, j-i ).string() );
             i = j + 1;
 
         //      qDebug("attr='%s' value='%s'", attr.latin1(), value.latin1() );
             if ( attr == "id" )
                 id = value;
             else if ( attr == "app" )
                 app = value;
 
             else if ( attr == "name" )
                 name = value;
         }
 
         if ( name.isNull() || id.isNull() ) {
             qWarning("No name or id in the category");
             continue;
         }
         if ( app.isNull() )
             mGlobalCats.add( id.toInt(), name );
         else
             mAppCats[ app ].add( id.toInt(), name );
     }
 
     return TRUE;
 }
 
 /*!
   Clear the categories in memory. Equivelent to creating an empty Categories
   object.
 */
 void Categories::clear()
 {
     mGlobalCats.clear();
     mAppCats.clear();
 }
 
 /*!
   Dump the contents to standard out. Used for debugging only.
 */
 void Categories::dump() const
 {
     qDebug("\tglobal categories = %s", mGlobalCats.labels().join(", ").latin1() );
     for ( QMap<QString, CategoryGroup>::ConstIterator appsIt = mAppCats.begin(); appsIt != mAppCats.end(); ++appsIt ) {
         const QString &app = appsIt.key();
         QStringList appcats = (*appsIt).labels();
         qDebug("\tapp = %s\tcategories = %s", app.latin1(),
                appcats.join(", ").latin1() );
 
     }
 }
 
 QStringList CheckedListView::checked() const
 {
     QStringList strs;
     for ( QCheckListItem *i = (QCheckListItem *) firstChild();
           i; i = (QCheckListItem *)i->nextSibling() )
         if ( i->isOn() )
             strs += i->text( 0 );
     return strs;
 }
 
 void CheckedListView::addCheckableList( const QStringList &options )
 {
     for ( QStringList::ConstIterator it = options.begin();
           it != options.end(); ++it ) {
         (void) new QCheckListItem( this, *it,
                                    QCheckListItem::CheckBox );
     }
 }
 
 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 )
 
   Constructor for an empty Categories object.
 */
 
 /*! \fn Categories::Categories( const Categories &copyFrom )
 
   Deep copy constructor
 */
 
 /*! \fn Categories::~Categories()
 
   Empty destructor. Call save() before destruction if there are changes
   that need to be saved.
 */
 
 /*! \fn CategoryGroup::clear()
   \internal
 */
 
 /*! \fn const QMap<int, QString> &CategoryGroup::idMap() const
 
   Returns a const reference to the id to label QMap
 */
 
 /*! \fn CategoryGroup::CategoryGroup()
   \internal
 */
 
 /*! \fn CategoryGroup::CategoryGroup(const CategoryGroup &c)
   \internal
 */
 
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
@@ -1,226 +1,226 @@
 /**********************************************************************
 ** Copyright (C) 2000 Trolltech AS.  All rights reserved.
 **
 ** This file is part of Qtopia Environment.
 **
 ** This file may be distributed and/or modified under the terms of the
 ** GNU General Public License version 2 as published by the Free
 ** Software Foundation and appearing in the file LICENSE.GPL included
 ** in the packaging of this file.
 **
 ** 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_CATEGORIES_H
 #define QTPALMTOP_CATEGORIES_H
 
 #include <qstring.h>
 #include <qstringlist.h>
 #include <qmap.h>
 #include <qlistview.h>
 #include <qarray.h>
 #include "qpcglobal.h"
 #include "palmtopuidgen.h"
 
 class CategoryGroup;
 
 #if defined(QPC_TEMPLATEDLL)
 // MOC_SKIP_BEGIN
 template class QPC_EXPORT QMap<int, QString>;
 template class QPC_EXPORT QMap<QString, int>;
 template class QPC_EXPORT QMap< QString, CategoryGroup >;
 // MOC_SKIP_END
 #endif
 
 class QPC_EXPORT CategoryGroup
 {
     friend class Categories;
 public:
     CategoryGroup(): mIdLabelMap(), mLabelIdMap() { }
     CategoryGroup( const CategoryGroup &c ) :
         mIdLabelMap( c.mIdLabelMap), mLabelIdMap( c.mLabelIdMap ) { }
 
     void clear() { mIdLabelMap.clear(); mLabelIdMap.clear(); }
 
     int add( const QString &label );
     bool add( int uid, const QString &label );
 
     bool remove( const QString &label );
     bool remove( int uid );
 
     bool rename( int uid, const QString &newLabel );
     bool rename( const QString &oldLabel, const QString &newLabel );
 
     bool contains(int id) const;
     bool contains(const QString &label) const;
 
     /** 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).
     */
     int addCategory( const QString &appname, const QString &catname, int uid);
     /** Add the global category just checking that it doesn't
     *  already exist globally. Return UID if added, 0 if conflicts.
     */
     int addGlobalCategory( const QString &catname );
     /** Add the global category just checking that it doesn't
     *  already exist globally. Return UID if added, 0 if conflicts.
     */
     int addGlobalCategory( const QString &catname, int uid );
     /** Removes the category from the application; if it is not found
     *   in the application, then it removes it from the global list
     */
     bool removeCategory( const QString &appName, const QString &catName,
                          bool checkGlobal = TRUE);
     bool removeCategory( const QString &appName, int uid );
     bool removeGlobalCategory( const QString &catName );
     bool removeGlobalCategory( int uid );
 
     QArray<int> ids( const QString &app, const QStringList &labels) const;
 
     /** Returns the id associated with the app */
     int id( const QString &app, const QString &cat ) const;
     /** Returns the label associated with the id */
     QString label( const QString &app, int id ) const;
 
     enum ExtraLabels { NoExtra, AllUnfiled, AllLabel, UnfiledLabel };
     /** Returns the sorted list of all categories that are
     *   associated with the app.
     *   If includeGlobal parameter is TRUE then the returned
     *   categories will include the global category items.
     *   If extra = NoExtra, then
     *   If extra = AllUnfiled, then All and Unfiled will be prepended to
     *   the list
     *   If extra = AllLabel, then All is prepended
     *   If extra = UnfiledLabel, then Unfiled is prepended
     */
     QStringList labels( const QString &app,
                         bool includeGlobal = TRUE,
                         ExtraLabels extra = NoExtra ) const;
 
     enum DisplaySingle { ShowMulti, ShowAll, ShowFirst };
 
     /** Returns a single string associated with the cat ids for display in
     *   a combobox or any area that requires one string.  If catids are empty
     *   then "Unfiled" will be returned.  If multiple categories are assigned
     *   then the behavior depends on the DisplaySingle type.
     *   If /a display is set to ShowMulti then  " (multi)" appended to the
     *   first string. If /a display is set to ShowAll, then a space seperated
     *   string is returned with all categories.  If ShowFirst is returned,
     *   the just the first string is returned.
     */
     QString displaySingle( const QString &app,
                            const QArray<int> &catids,
                            DisplaySingle display ) const;
 
     QStringList globalCategories() const { return mGlobalCats.labels();}
 
     bool renameCategory( const QString &appname,
                          const QString &oldName,
                          const QString &newName );
     bool renameGlobalCategory( const QString &oldName,
                                const QString &newName );
 
     void setGlobal( const QString &appname, const QString &catname,
                     bool value );
     bool isGlobal( const QString &catname ) const;
 
 
     /** Returns true if the catname is associated with any application
     */
     bool exists( const QString &catname ) const;
     bool exists( const QString &appname, const QString &catname) const;
 
     bool save( const QString &fname ) const;
     bool load( const QString &fname );
 
     // for debugging
     void dump() const;
 
     const QMap<QString, CategoryGroup> &appGroupMap() const{ return mAppCats; }
     const CategoryGroup &globalGroup() const { return mGlobalCats; }
 
 signals:
     /** emitted if added a category;
     *  the second param is the application the category was added to
     *  or null if global
     *  the third param is the uid of the newly added category
     */
     void categoryAdded( const Categories &, const QString &, int );
     /** emitted if removed a category
     *  the second param is the application the category was removed from
     *  or null if global
     *  the third param is the uid of the removed category
     */
     void categoryRemoved( const Categories &, const QString &, int );
     /** emitted if a category is renamed; the second param is the uid of
     *   the removed category */
     void categoryRenamed( const Categories &, const QString &, int );
 
 private:
     CategoryGroup mGlobalCats;
     QMap< QString, CategoryGroup > mAppCats;
 };
 
 class QPC_EXPORT CheckedListView : public QListView
 {
 public:
     void addCheckableList( const QStringList &options );
     void setChecked( const QStringList &checked );
     QStringList checked() const;
 };
 
 #endif
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
@@ -1,368 +1,368 @@
 /**********************************************************************
 ** Copyright (C) 2000-2002 Trolltech AS.  All rights reserved.
 **
 ** This file is part of the Qtopia Environment.
 **
 ** This file may be distributed and/or modified under the terms of the
 ** GNU General Public License version 2 as published by the Free Software
 ** Foundation and appearing in the file LICENSE.GPL included in the
 ** packaging of this file.
 **
 ** 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.
 **
 **********************************************************************/
 
 #include "event.h"
 #include "qfiledirect_p.h"
 #include <qtopia/timeconversion.h>
 #include <qtopia/stringutil.h>
 #include <qtopia/private/recordfields.h>
 #include <qbuffer.h>
 #include <time.h>
 #include "vobject_p.h"
 
 #include <stdio.h>
 
 using namespace Qtopia;
 
 static void write( QString& buf, const Event::RepeatPattern &r )
 {
     buf += " rtype=\"";
     switch ( r.type ) {
         case Event::Daily:
             buf += "Daily";
             break;
         case Event::Weekly:
             buf += "Weekly";
             break;
         case Event::MonthlyDay:
             buf += "MonthlyDay";
             break;
         case Event::MonthlyDate:
             buf += "MonthlyDate";
             break;
         case Event::Yearly:
             buf += "Yearly";
             break;
         default:
             buf += "NoRepeat";
             break;
     }
     buf += "\"";
     if ( r.days > 0 )
         buf += " rweekdays=\"" + QString::number( static_cast<int>( r.days ) ) + "\"";
     if ( r.position != 0 )
         buf += " rposition=\"" + QString::number( r.position ) + "\"";
 
     buf += " rfreq=\"" + QString::number( r.frequency ) + "\"";
     buf += " rhasenddate=\"" + QString::number( static_cast<int>( r.hasEndDate ) ) + "\"";
      if ( r.hasEndDate )
         buf += " enddt=\""
                + QString::number( r.endDateUTC ? r.endDateUTC : time( 0 ) )
                + "\"";
     buf += " created=\"" + QString::number( r.createTime ) + "\"";
 }
 
 Qtopia::UidGen Event::sUidGen( Qtopia::UidGen::Qtopia );
 
 /*!
   \class Event event.h
   \brief The Event class holds the data of a calendar event.
 
   This data includes descriptive data of the event and schedualing information.
 
   \ingroup qtopiaemb
   \ingroup qtopiadesktop
 */
 
 /*!
   \class Event::RepeatPattern
   \class The Event::RepeatPattern class is internal.
   \internal
 */
 
 /*!
   \enum Event::Days
   \internal
 */
 
 /*!
   \enum Event::Type
   \internal
 */
 
 /*!
   \enum Event::SoundTypeChoice
 
   This enum type defines what kind of sound is made when an alarm occurs
   for an event.  The currently defined types are:
 
   <ul>
   <li>\c Silent - No sound is produced.
   <li>\c Loud - A loud sound is produced.
   </ul>
 */
 
 /*!
   \fn bool Event::operator<( const Event & ) const
   \internal
 */
 
 /*!
   \fn bool Event::operator<=( const Event & ) const
   \internal
 */
 
 /*!
   \fn bool Event::operator!=( const Event & ) const
   \internal
 */
 
 /*!
   \fn bool Event::operator>( const Event & ) const
   \internal
 */
 
 /*!
   \fn bool Event::operator>=( const Event & ) const
   \internal
 */
 
 /*!
   \enum Event::RepeatType
 
   This enum defines how a event will repeat, if at all.
 
   <ul>
   <li>\c NoRepeat - Event does not repeat.
   <li>\c Daily - Event occurs every n days.
   <li>\c Weekly - Event occurs every n weeks.
   <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()
 
   Clears the alarm for the event.
 */
 
 /*!
   \fn int Event::alarmDelay() const
 
   Returns the delay in minutes between the alarm for an event and the
   start of the event.
 */
 
 /*!
   \fn Event::RepeatType Event::repeatType() const
 
   Returns the repeat pattern type for the event.
 
   \sa frequency()
 */
 
 /*!
   \fn int Event::weekOffset() const
 
   Returns the number of weeks from the start of the month that this event
   occurs.
 */
 
 /*!
   \fn QDate Event::repeatTill() const
 
   Returns the date that the event will continue to repeat until.  If the event
   repeats forever the value returned is undefined.
 
   \sa repeatForever()
 */
 
 /*!
   \fn bool Event::repeatForever() const
 
   Returns FALSE if there is a date set for the event to continue until.
   Otherwise returns TRUE.
 */
 
 /*!
   \fn bool Event::doRepeat() const
   \internal
 */
 
 /*!
   \fn bool Event::repeatOnWeekDay(int day) const
 
   Returns TRUE if the event has a RepeatType of Weekly and is set to occur on
   \a day each week.  Otherwise returns FALSE.
 
   \sa QDate::dayName()
 */
 
 /*!
   \fn void Event::setRepeatOnWeekDay(int day, bool enable)
 
   If \a enable is TRUE then sets the event to occur on \a day each week.
   Otherwise sets the event not to occur on \a day.
 
   \warning this function is only relavent for a event with RepeatType of
   Weekly.
 
   \sa QDate::dayName()
 */
 
 /*!
   \fn int Event::frequency() const
 
   Returns how often the event repeats.
 
   \sa repeatType()
 */
 
 /*!
   \fn void Event::setRepeatType(RepeatType t)
 
   Sets the repeat pattern type of the event to \a t.
 
   \sa setFrequency()
 */
 
 /*!
   \fn void Event::setFrequency(int n)
 
   Sets how often the event occurs with in its repeat pattern.
 
   \sa setRepeatType()
 */
 
 /*!
   \fn void Event::setRepeatTill(const QDate &d)
 
   Sets the event to repeat until \a d.
 */
 
 /*!
   \fn void Event::setRepeatForever(bool enable)
 
   If \a enable is TRUE, sets the event to repeat forever.  Otherwise
   sets the event to stop repeating at some date.
 
   \warning This function may affect the specific date the event will repeat
   till.
 */
 
 /*!
   \fn bool Event::match(const QRegExp &r) const
 
   Returns TRUE if the event matches the regular expression \a r.
   Otherwise returns FALSE.
 */
 
 /*!
   \fn char Event::day(int)
   \internal
 */
 
 /*!
   Creates a new, empty event.
 */
 Event::Event() : Record()
 {
     startUTC = endUTC = time( 0 );
     typ = Normal;
     hAlarm = FALSE;
     hRepeat = FALSE;
     aMinutes = 0;
     aSound = Silent;
     pattern.type = NoRepeat;
     pattern.frequency = -1;
 }
 
 /*!
   \internal
 */
 Event::Event( const QMap<int, QString> &map )
 {
     setDescription( map[DatebookDescription] );
     setLocation( map[Location] );
     setCategories( idsFromString( map[DatebookCategory] ) );
     setTimeZone( map[TimeZone] );
     setNotes( map[Note] );
     setStart( TimeConversion::fromUTC( map[StartDateTime].toUInt() ) );
     setEnd( TimeConversion::fromUTC( map[EndDateTime].toUInt() ) );
     setType( (Event::Type) map[DatebookType].toInt() );
     setAlarm( ( map[HasAlarm] == "1" ? TRUE : FALSE ), map[AlarmTime].toInt(), (Event::SoundTypeChoice)map[SoundType].toInt() );
     Event::RepeatPattern p;
     p.type = (Event::RepeatType) map[ RepeatPatternType ].toInt();
     p.frequency = map[ RepeatPatternFrequency ].toInt();
     p.position = map[ RepeatPatternPosition ].toInt();
     p.days = map[ RepeatPatternDays ].toInt();
     p.hasEndDate = map[ RepeatPatternHasEndDate ].toInt();
     p.endDateUTC = map[ RepeatPatternEndDate ].toUInt();
     setRepeat( p );
 
     setUid( map[ DatebookUid ].toInt() );
 }
 
 /*!
   Destroys an event.
 */
 Event::~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
@@ -1,95 +1,107 @@
 /**********************************************************************
 ** Copyright (C) 2000-2002 Trolltech AS.  All rights reserved.
 **
 ** This file is part of the Qtopia Environment.
 **
 ** This file may be distributed and/or modified under the terms of the
 ** GNU General Public License version 2 as published by the Free Software
 ** Foundation and appearing in the file LICENSE.GPL included in the
 ** packaging of this file.
 **
 ** 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 ); }
     bool isValidUid() const { return mUid != 0; }
     void assignUid() { setUid( uidGen().generate() ); }
 
     virtual QString customField(const QString &) const;
     virtual void setCustomField(const QString &, const QString &);
     virtual void removeCustomField(const QString &);
 
     virtual bool operator == ( const Record &r ) const
 { return mUid == r.mUid; }
     virtual bool operator != ( const Record &r ) const
 { return mUid != r.mUid; }
 
     // convenience methods provided for loading and saving to xml
     static QString idsToString( const QArray<int> &ids );
     // convenience methods provided for loading and saving to xml
     static QArray<int> idsFromString( const QString &str );
 
     // for debugging
     static void dump( const QMap<int, QString> &map );
 
 protected:
     virtual UidGen &uidGen() = 0;
     virtual QString customToXml() const;
 private:
     int mUid;
     QArray<int> mCats;
     QMap<QString, QString> customMap;
     RecordPrivate *d;
 };
 
 }
 
 #endif