More API doc

QString -> const QString&
QString = 0l -> QString::null

1 files changed, 13 insertions, 3 deletions

diff --git a/libopie/pim/ocontactaccess.h b/libopie/pim/ocontactaccess.h
index 32b2dcb..d7ceaf2 100644
--- a/libopie/pim/ocontactaccess.h
+++ b/libopie/pim/ocontactaccess.h
@@ -8,24 +8,29 @@
          *This program is free software; you can redistribute it and/or
          *modify it under the terms of the GNU Library General Public
  *      License as published by the Free Software Foundation;
  *      either version 2 of the License, or (at your option) any later
  *      version.
  * =====================================================================
  * ToDo: Define enum for query settings
  * =====================================================================
  * Version: $Id$
  * =====================================================================
  * History:
  * $Log$
+ * Revision 1.7  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.6  2003/01/02 14:27:12  eilers
  * Improved query by example: Search by date is possible.. First step
  * for a today plugin for birthdays..
  *
  * Revision 1.5  2002/11/13 14:14:51  eilers
  * Added sorted for Contacts..
  *
  * Revision 1.4  2002/11/01 15:10:42  eilers
  * Added regExp-search in database for all fields in a contact.
  *
  * Revision 1.3  2002/10/16 10:52:40  eilers
  * Added some docu to the interface and now using the cache infrastucture by zecke.. :)
@@ -46,35 +51,40 @@
 
 #include <qobject.h>
 
 #include <qpe/qcopenvelope_qws.h>
 
 #include <qvaluelist.h>
 #include <qfileinfo.h>
 
 #include "ocontact.h"
 #include "ocontactaccessbackend.h"
 #include "opimaccesstemplate.h"
 
-/** Class to access the contacts database.
+/**
+ * Class to access the contacts database.
  * This is just a frontend for the real database handling which is
  * done by the backend.
+ * This class is used to access the Contacts on a system. This class as any OPIE PIM
+ * class is backend independent.
+
  * @see OPimAccessTemplate
  */
 class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
 {
     Q_OBJECT
 
  public:
-        /** Create Database with contacts (addressbook).
+        /**
+         * Create Database with contacts (addressbook).
          * @param appname Name of application which wants access to the database
          * (i.e. "todolist")
          * @param filename The name of the database file. If not set, the default one
          * is used.
          * @param backend Pointer to an alternative Backend. If not set, we will use
          * the default backend.
          * @param handlesync If <b>true</b> the database stores the current state
          * automatically if it receives the signals <i>flush()</i> and <i>reload()</i>
          * which are used before and after synchronisation. If the application wants
          * to react itself, it should be disabled by setting it to <b>false</b>
          * @see OContactAccessBackend
          */
@@ -90,25 +100,25 @@ class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
         enum QuerySettings {
                 WildCards  = 0x0001,
                 IgnoreCase = 0x0002,
                 RegExp     = 0x0004,
                 ExactMatch = 0x0008,
                 MatchOne   = 0x0010, // Only one Entry must match
                 DateDiff   = 0x0020, // Find all entries from today until given date
                 DateYear   = 0x0040, // The year matches
                 DateMonth  = 0x0080, // The month matches
                 DateDay    = 0x0100, // The day matches
         };
 
-        
+
         ORecordList<OContact> matchRegexp(  const QRegExp &r )const;
 
         /** Return all Contacts in a sorted manner.
          *  @param ascending true: Sorted in acending order.
          *  @param sortOrder Currently not implemented. Just defined to stay compatible to otodoaccess
          *  @param sortFilter Currently not implemented. Just defined to stay compatible to otodoaccess
          *  @param cat Currently not implemented. Just defined to stay compatible to otodoaccess
          */
         List sorted( bool ascending, int sortOrder, int sortFilter, int cat ) const;
 
         /** Return all possible settings.
          *  @return All settings provided by the current backend