More API doc

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

26 files changed, 418 insertions, 34 deletions

diff --git a/libopie/pim/obackendfactory.h b/libopie/pim/obackendfactory.h
index 3a73210..ad6cf5a 100644
--- a/libopie/pim/obackendfactory.h
+++ b/libopie/pim/obackendfactory.h
@@ -18,2 +18,7 @@
  * $Log$
+ * Revision 1.6  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.5  2003/02/21 23:31:52  zecke
@@ -65,3 +70,17 @@
 
-
+/**
+ * This class is our factory. It will give us the default implementations
+ * of at least Todolist, Contacts and Datebook. In the future this class will
+ * allow users to switch the backend with ( XML->SQLite ) without the need
+ * to recompile.#
+ * This class as the whole PIM Api is making use of templates
+ *
+ * <pre>
+ *   OTodoAccessBackend* backend = OBackEndFactory<OTodoAccessBackend>::Default("todo", QString::null );
+ *   backend->load();
+ * </pre>
+ *
+ * @author Stefan Eilers
+ * @version 0.1
+ */
 template<class T>
@@ -78,2 +97,7 @@ class OBackendFactory
 
+        /**
+         * Returns a backend implementation for backendName
+         * @param backendName the type of the backend
+         * @param appName will be passed on to the backend
+         */
         static T* Default( const QString backendName, const QString& appName ){
diff --git a/libopie/pim/ocontact.h b/libopie/pim/ocontact.h
index 1fd1c75..25fa0e7 100644
--- a/libopie/pim/ocontact.h
+++ b/libopie/pim/ocontact.h
@@ -38,2 +38,9 @@ class ContactPrivate;
 
+/**
+ * OContact class represents a specialised PIM Record for contacts.
+ * It does store all kind of persopn related information.
+ *
+ * @short Contact Container
+ * @author TT, Stefan Eiler, Holger Freyther
+ */
 class QPC_EXPORT OContact : public OPimRecord
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
@@ -19,2 +19,7 @@
  * $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
@@ -57,5 +62,9 @@
 
-/** 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
@@ -67,3 +76,4 @@ class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
  public:
-        /** Create Database with contacts (addressbook).
+        /**
+         * Create Database with contacts (addressbook).
          * @param appname Name of application which wants access to the database
diff --git a/libopie/pim/ocontactaccessbackend.h b/libopie/pim/ocontactaccessbackend.h
index 821f5bf..ebeb42d 100644
--- a/libopie/pim/ocontactaccessbackend.h
+++ b/libopie/pim/ocontactaccessbackend.h
@@ -21,2 +21,7 @@
  * $Log$
+ * Revision 1.5  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.4  2002/11/13 14:14:51  eilers
@@ -46,4 +51,14 @@
 
-#include "qregexp.h"
+#include <qregexp.h>
 
+/**
+ * This class represents the interface of all Contact Backends.
+ * Derivates of this class will be used to access the contacts.
+ * As implementation currently XML and vCard exist. This class needs to be implemented
+ * if you want to provide your own storage.
+ * In all queries a list of uids is passed on instead of loading the actual record!
+ *
+ * @see OContactAccessBackend_VCard
+ * @see OContactAccessBackend_XML
+ */
 class OContactAccessBackend: public OPimAccessBackend<OContact> {
@@ -54,3 +69,4 @@ class OContactAccessBackend: public OPimAccessBackend<OContact> {
 
-        /** Return if database was changed externally.
+        /**
+         * Return if database was changed externally.
          * This may just make sense on file based databases like a XML-File.
@@ -70,3 +86,4 @@ class OContactAccessBackend: public OPimAccessBackend<OContact> {
 
-        /** Return all possible settings.
+        /**
+         *  Return all possible settings.
          *  @return All settings provided by the current backend
@@ -76,3 +93,4 @@ class OContactAccessBackend: public OPimAccessBackend<OContact> {
 
-        /** Check whether settings are correct.
+        /**
+         * Check whether settings are correct.
          * @return <i>true</i> if the given settings are correct and possible.
@@ -81,2 +99,6 @@ class OContactAccessBackend: public OPimAccessBackend<OContact> {
 
+        /**
+         * FIXME!!!
+         * Returns a sorted list of records either ascendinf or descending for a giving criteria and category
+         */
         virtual QArray<int> sorted( bool ascending, int sortOrder, int sortFilter, int cat ) = 0;
diff --git a/libopie/pim/ocontactaccessbackend_vcard.cpp b/libopie/pim/ocontactaccessbackend_vcard.cpp
index f24523f..270bef3 100644
--- a/libopie/pim/ocontactaccessbackend_vcard.cpp
+++ b/libopie/pim/ocontactaccessbackend_vcard.cpp
@@ -19,2 +19,7 @@
  * $Log$
+ * Revision 1.10  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.9  2003/03/21 10:33:09  eilers
@@ -78,3 +83,3 @@
 
-OContactAccessBackend_VCard::OContactAccessBackend_VCard ( QString , QString filename ):
+OContactAccessBackend_VCard::OContactAccessBackend_VCard ( const QString& , const QString& filename ):
         m_dirty( false ),
diff --git a/libopie/pim/ocontactaccessbackend_vcard.h b/libopie/pim/ocontactaccessbackend_vcard.h
index 93e2da3..712d769 100644
--- a/libopie/pim/ocontactaccessbackend_vcard.h
+++ b/libopie/pim/ocontactaccessbackend_vcard.h
@@ -19,2 +19,7 @@
  * $Log$
+ * Revision 1.6  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.5  2003/03/21 10:33:09  eilers
@@ -49,5 +54,10 @@ class VObject;
 
+/**
+ * This is the vCard 2.1 implementation of the Contact Storage
+ * @see OContactAccessBackend_XML
+ * @see OPimAccessBackend
+ */
 class OContactAccessBackend_VCard : public OContactAccessBackend {
  public:
-        OContactAccessBackend_VCard ( QString appname, QString filename = 0l );
+        OContactAccessBackend_VCard ( const QString& appname, const QString& filename = QString::null );
 
diff --git a/libopie/pim/ocontactaccessbackend_xml.cpp b/libopie/pim/ocontactaccessbackend_xml.cpp
index c5a7820..661cd51 100644
--- a/libopie/pim/ocontactaccessbackend_xml.cpp
+++ b/libopie/pim/ocontactaccessbackend_xml.cpp
@@ -19,2 +19,7 @@
  * $Log$
+ * Revision 1.5  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.4  2003/03/21 14:32:54  mickeyl
@@ -109,3 +114,3 @@ using namespace Opie;
 
-OContactAccessBackend_XML::OContactAccessBackend_XML ( QString appname, QString filename ):
+OContactAccessBackend_XML::OContactAccessBackend_XML ( const QString& appname, const QString& filename ):
         m_changed( false )
diff --git a/libopie/pim/ocontactaccessbackend_xml.h b/libopie/pim/ocontactaccessbackend_xml.h
index 4d6a7ef..7b5365b 100644
--- a/libopie/pim/ocontactaccessbackend_xml.h
+++ b/libopie/pim/ocontactaccessbackend_xml.h
@@ -19,2 +19,7 @@
  * $Log$
+ * Revision 1.14  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.13  2003/03/21 10:33:09  eilers
@@ -86,5 +91,10 @@
 /* the default xml implementation */
+/**
+ * This class is the XML implementation of a Contact backend
+ * it does implement everything available for OContact.
+ * @see OPimAccessBackend for more information of available methods
+ */
 class OContactAccessBackend_XML : public OContactAccessBackend {
  public:
-        OContactAccessBackend_XML ( QString appname, QString filename = 0l );
+        OContactAccessBackend_XML ( const QString& appname, const QString& filename = QString::null );
         
diff --git a/libopie/pim/odatebookaccess.cpp b/libopie/pim/odatebookaccess.cpp
index 08e61ff..a3661a3 100644
--- a/libopie/pim/odatebookaccess.cpp
+++ b/libopie/pim/odatebookaccess.cpp
@@ -3,2 +3,9 @@
 
+/**
+ * Simple constructor
+ * It takes a ODateBookAccessBackend as parent. If it is 0 the default implementation
+ * will be used!
+ * @param back The backend to be used or 0 for the default backend
+ * @param ac What kind of access is intended
+ */
 ODateBookAccess::ODateBookAccess( ODateBookAccessBackend* back, enum Access ac )
@@ -14,2 +21,6 @@ ODateBookAccess::~ODateBookAccess() {
 }
+
+/**
+ * @return all events available
+ */
 ODateBookAccess::List ODateBookAccess::rawEvents()const {
@@ -20,2 +31,6 @@ ODateBookAccess::List ODateBookAccess::rawEvents()const {
 }
+
+/**
+ * @return all repeating events
+ */
 ODateBookAccess::List ODateBookAccess::rawRepeats()const {
@@ -26,2 +41,6 @@ ODateBookAccess::List ODateBookAccess::rawRepeats()const {
 }
+
+/**
+ * @return all non repeating events
+ */
 ODateBookAccess::List ODateBookAccess::nonRepeats()const {
@@ -32,2 +51,8 @@ ODateBookAccess::List ODateBookAccess::nonRepeats()const {
 }
+
+/**
+ * @return dates in the time span between from and to
+ * @param from Include all events from...
+ * @param to Include all events to...
+ */
 OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents( const QDate& from, const QDate& to ) {
@@ -35,2 +60,5 @@ OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents( const QDate& from,
 }
+/**
+ * @return all events at a given datetime
+ */
 OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents( const QDateTime& start ) {
diff --git a/libopie/pim/odatebookaccess.h b/libopie/pim/odatebookaccess.h
index 7047039..7c7a63f 100644
--- a/libopie/pim/odatebookaccess.h
+++ b/libopie/pim/odatebookaccess.h
@@ -8,2 +8,11 @@
 
+/**
+ * This is the object orientated datebook database. It'll use OBackendFactory
+ * to query for a backend.
+ * All access to the datebook should be done via this class.
+ * Make sure to load and save the datebook this is not part of
+ * destructing and creating the object
+ *
+ * @author Holger Freyther
+ */
 class ODateBookAccess : public OPimAccessTemplate<OEvent> {
@@ -13,9 +22,9 @@ public:
 
-    /** return all events */
+    /* return all events */
     List rawEvents()const;
 
-    /** return repeating events */
+    /* return repeating events */
     List rawRepeats()const;
 
-    /** return non repeating events */
+    /* return non repeating events */
     List nonRepeats()const;
diff --git a/libopie/pim/odatebookaccessbackend.h b/libopie/pim/odatebookaccessbackend.h
index eb6e8fb..86ff298 100644
--- a/libopie/pim/odatebookaccessbackend.h
+++ b/libopie/pim/odatebookaccessbackend.h
@@ -8,2 +8,7 @@
 
+/**
+ * This class is the interface to the storage of Events.
+ * @see OPimAccessBackend
+ *
+ */
 class ODateBookAccessBackend : public OPimAccessBackend<OEvent> {
@@ -11,2 +16,6 @@ public:
     typedef int UID;
+
+    /**
+     * c'tor without parameter
+     */
     ODateBookAccessBackend();
@@ -14,4 +23,21 @@ public:
 
+    /**
+     * This method should return a list of UIDs containing
+     * all events. No filter should be applied
+     * @return list of events
+     */
     virtual QArray<UID> rawEvents()const = 0;
+
+    /**
+     * This method should return a list of UIDs containing
+     * all repeating events. No filter should be applied
+     * @return list of repeating events
+     */
     virtual QArray<UID> rawRepeats()const = 0;
+
+    /**
+     * This mthod should return a list of UIDs containing all non
+     * repeating events. No filter should be applied
+     * @return list of nonrepeating events
+     */
     virtual QArray<UID> nonRepeats() const = 0;
@@ -19,6 +45,11 @@ public:
     /**
-     * these two methods are used if you do not implement
-     * effectiveEvents...
+     * If you do not want to implement the effectiveEvents methods below
+     * you need to supply it with directNonRepeats.
+     * This method can return empty lists if effectiveEvents is implememted
      */
     virtual OEvent::ValueList directNonRepeats() = 0;
+
+    /**
+     * Same as above but return raw repeats!
+     */
     virtual OEvent::ValueList directRawRepeats() = 0;
@@ -26,3 +57,13 @@ public:
     /* is implemented by default but you can reimplement it*/
+    /**
+     * Effective Events are special event occuring during a time frame. This method does calcualte
+     * EffectiveEvents bases on the directNonRepeats and directRawRepeats. You may implement this method
+     * yourself
+     */
     virtual OEffectiveEvent::ValueList effecticeEvents( const QDate& from, const QDate& to );
+
+    /**
+     * this is an overloaded member function
+     * @see effecticeEvents
+     */
     virtual OEffectiveEvent::ValueList effecticeEvents( const QDateTime& start );
diff --git a/libopie/pim/odatebookaccessbackend_xml.h b/libopie/pim/odatebookaccessbackend_xml.h
index 563c31f..7848f7c 100644
--- a/libopie/pim/odatebookaccessbackend_xml.h
+++ b/libopie/pim/odatebookaccessbackend_xml.h
@@ -7,2 +7,8 @@
 
+/**
+ * This is the default XML implementation for DateBoook XML storage
+ * It fully implements the interface
+ * @see ODateBookAccessBackend
+ * @see OPimAccessBackend
+ */
 class ODateBookAccessBackend_XML : public ODateBookAccessBackend {
diff --git a/libopie/pim/oevent.h b/libopie/pim/oevent.h
index 585515c..57d32d0 100644
--- a/libopie/pim/oevent.h
+++ b/libopie/pim/oevent.h
@@ -32,2 +32,8 @@ class OPimNotifyManager;
 class ORecur;
+
+/**
+ * This is the container for all Events. It encapsules all
+ * available information for a single Event
+ * @short container for events.
+ */
 class OEvent : public OPimRecord {
@@ -35,2 +41,5 @@ public:
     typedef QValueList<OEvent> ValueList;
+    /**
+     * RecordFields contain possible attributes
+     */
     enum RecordFields {
@@ -51,3 +60,10 @@ public:
 
+    /**
+     * Start with an Empty OEvent. UID == 0 means that it is empty
+     */
     OEvent(int uid = 0);
+
+    /**
+     * copy c'tor
+     */
     OEvent( const OEvent& );
@@ -146,3 +162,2 @@ private:
  */
-
 class OEffectiveEvent {
diff --git a/libopie2/opiepim/backend/obackendfactory.h b/libopie2/opiepim/backend/obackendfactory.h
index 3a73210..ad6cf5a 100644
--- a/libopie2/opiepim/backend/obackendfactory.h
+++ b/libopie2/opiepim/backend/obackendfactory.h
@@ -18,2 +18,7 @@
  * $Log$
+ * Revision 1.6  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.5  2003/02/21 23:31:52  zecke
@@ -65,3 +70,17 @@
 
-
+/**
+ * This class is our factory. It will give us the default implementations
+ * of at least Todolist, Contacts and Datebook. In the future this class will
+ * allow users to switch the backend with ( XML->SQLite ) without the need
+ * to recompile.#
+ * This class as the whole PIM Api is making use of templates
+ *
+ * <pre>
+ *   OTodoAccessBackend* backend = OBackEndFactory<OTodoAccessBackend>::Default("todo", QString::null );
+ *   backend->load();
+ * </pre>
+ *
+ * @author Stefan Eilers
+ * @version 0.1
+ */
 template<class T>
@@ -78,2 +97,7 @@ class OBackendFactory
 
+        /**
+         * Returns a backend implementation for backendName
+         * @param backendName the type of the backend
+         * @param appName will be passed on to the backend
+         */
         static T* Default( const QString backendName, const QString& appName ){
diff --git a/libopie2/opiepim/backend/ocontactaccessbackend.h b/libopie2/opiepim/backend/ocontactaccessbackend.h
index 821f5bf..ebeb42d 100644
--- a/libopie2/opiepim/backend/ocontactaccessbackend.h
+++ b/libopie2/opiepim/backend/ocontactaccessbackend.h
@@ -21,2 +21,7 @@
  * $Log$
+ * Revision 1.5  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.4  2002/11/13 14:14:51  eilers
@@ -46,4 +51,14 @@
 
-#include "qregexp.h"
+#include <qregexp.h>
 
+/**
+ * This class represents the interface of all Contact Backends.
+ * Derivates of this class will be used to access the contacts.
+ * As implementation currently XML and vCard exist. This class needs to be implemented
+ * if you want to provide your own storage.
+ * In all queries a list of uids is passed on instead of loading the actual record!
+ *
+ * @see OContactAccessBackend_VCard
+ * @see OContactAccessBackend_XML
+ */
 class OContactAccessBackend: public OPimAccessBackend<OContact> {
@@ -54,3 +69,4 @@ class OContactAccessBackend: public OPimAccessBackend<OContact> {
 
-        /** Return if database was changed externally.
+        /**
+         * Return if database was changed externally.
          * This may just make sense on file based databases like a XML-File.
@@ -70,3 +86,4 @@ class OContactAccessBackend: public OPimAccessBackend<OContact> {
 
-        /** Return all possible settings.
+        /**
+         *  Return all possible settings.
          *  @return All settings provided by the current backend
@@ -76,3 +93,4 @@ class OContactAccessBackend: public OPimAccessBackend<OContact> {
 
-        /** Check whether settings are correct.
+        /**
+         * Check whether settings are correct.
          * @return <i>true</i> if the given settings are correct and possible.
@@ -81,2 +99,6 @@ class OContactAccessBackend: public OPimAccessBackend<OContact> {
 
+        /**
+         * FIXME!!!
+         * Returns a sorted list of records either ascendinf or descending for a giving criteria and category
+         */
         virtual QArray<int> sorted( bool ascending, int sortOrder, int sortFilter, int cat ) = 0;
diff --git a/libopie2/opiepim/backend/ocontactaccessbackend_vcard.cpp b/libopie2/opiepim/backend/ocontactaccessbackend_vcard.cpp
index f24523f..270bef3 100644
--- a/libopie2/opiepim/backend/ocontactaccessbackend_vcard.cpp
+++ b/libopie2/opiepim/backend/ocontactaccessbackend_vcard.cpp
@@ -19,2 +19,7 @@
  * $Log$
+ * Revision 1.10  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.9  2003/03/21 10:33:09  eilers
@@ -78,3 +83,3 @@
 
-OContactAccessBackend_VCard::OContactAccessBackend_VCard ( QString , QString filename ):
+OContactAccessBackend_VCard::OContactAccessBackend_VCard ( const QString& , const QString& filename ):
         m_dirty( false ),
diff --git a/libopie2/opiepim/backend/ocontactaccessbackend_vcard.h b/libopie2/opiepim/backend/ocontactaccessbackend_vcard.h
index 93e2da3..712d769 100644
--- a/libopie2/opiepim/backend/ocontactaccessbackend_vcard.h
+++ b/libopie2/opiepim/backend/ocontactaccessbackend_vcard.h
@@ -19,2 +19,7 @@
  * $Log$
+ * Revision 1.6  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.5  2003/03/21 10:33:09  eilers
@@ -49,5 +54,10 @@ class VObject;
 
+/**
+ * This is the vCard 2.1 implementation of the Contact Storage
+ * @see OContactAccessBackend_XML
+ * @see OPimAccessBackend
+ */
 class OContactAccessBackend_VCard : public OContactAccessBackend {
  public:
-        OContactAccessBackend_VCard ( QString appname, QString filename = 0l );
+        OContactAccessBackend_VCard ( const QString& appname, const QString& filename = QString::null );
 
diff --git a/libopie2/opiepim/backend/ocontactaccessbackend_xml.cpp b/libopie2/opiepim/backend/ocontactaccessbackend_xml.cpp
index c5a7820..661cd51 100644
--- a/libopie2/opiepim/backend/ocontactaccessbackend_xml.cpp
+++ b/libopie2/opiepim/backend/ocontactaccessbackend_xml.cpp
@@ -19,2 +19,7 @@
  * $Log$
+ * Revision 1.5  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.4  2003/03/21 14:32:54  mickeyl
@@ -109,3 +114,3 @@ using namespace Opie;
 
-OContactAccessBackend_XML::OContactAccessBackend_XML ( QString appname, QString filename ):
+OContactAccessBackend_XML::OContactAccessBackend_XML ( const QString& appname, const QString& filename ):
         m_changed( false )
diff --git a/libopie2/opiepim/backend/ocontactaccessbackend_xml.h b/libopie2/opiepim/backend/ocontactaccessbackend_xml.h
index 4d6a7ef..7b5365b 100644
--- a/libopie2/opiepim/backend/ocontactaccessbackend_xml.h
+++ b/libopie2/opiepim/backend/ocontactaccessbackend_xml.h
@@ -19,2 +19,7 @@
  * $Log$
+ * Revision 1.14  2003/04/13 18:07:10  zecke
+ * More API doc
+ * QString -> const QString&
+ * QString = 0l -> QString::null
+ *
  * Revision 1.13  2003/03/21 10:33:09  eilers
@@ -86,5 +91,10 @@
 /* the default xml implementation */
+/**
+ * This class is the XML implementation of a Contact backend
+ * it does implement everything available for OContact.
+ * @see OPimAccessBackend for more information of available methods
+ */
 class OContactAccessBackend_XML : public OContactAccessBackend {
  public:
-        OContactAccessBackend_XML ( QString appname, QString filename = 0l );
+        OContactAccessBackend_XML ( const QString& appname, const QString& filename = QString::null );
         
diff --git a/libopie2/opiepim/backend/odatebookaccessbackend.h b/libopie2/opiepim/backend/odatebookaccessbackend.h
index eb6e8fb..86ff298 100644
--- a/libopie2/opiepim/backend/odatebookaccessbackend.h
+++ b/libopie2/opiepim/backend/odatebookaccessbackend.h
@@ -8,2 +8,7 @@
 
+/**
+ * This class is the interface to the storage of Events.
+ * @see OPimAccessBackend
+ *
+ */
 class ODateBookAccessBackend : public OPimAccessBackend<OEvent> {
@@ -11,2 +16,6 @@ public:
     typedef int UID;
+
+    /**
+     * c'tor without parameter
+     */
     ODateBookAccessBackend();
@@ -14,4 +23,21 @@ public:
 
+    /**
+     * This method should return a list of UIDs containing
+     * all events. No filter should be applied
+     * @return list of events
+     */
     virtual QArray<UID> rawEvents()const = 0;
+
+    /**
+     * This method should return a list of UIDs containing
+     * all repeating events. No filter should be applied
+     * @return list of repeating events
+     */
     virtual QArray<UID> rawRepeats()const = 0;
+
+    /**
+     * This mthod should return a list of UIDs containing all non
+     * repeating events. No filter should be applied
+     * @return list of nonrepeating events
+     */
     virtual QArray<UID> nonRepeats() const = 0;
@@ -19,6 +45,11 @@ public:
     /**
-     * these two methods are used if you do not implement
-     * effectiveEvents...
+     * If you do not want to implement the effectiveEvents methods below
+     * you need to supply it with directNonRepeats.
+     * This method can return empty lists if effectiveEvents is implememted
      */
     virtual OEvent::ValueList directNonRepeats() = 0;
+
+    /**
+     * Same as above but return raw repeats!
+     */
     virtual OEvent::ValueList directRawRepeats() = 0;
@@ -26,3 +57,13 @@ public:
     /* is implemented by default but you can reimplement it*/
+    /**
+     * Effective Events are special event occuring during a time frame. This method does calcualte
+     * EffectiveEvents bases on the directNonRepeats and directRawRepeats. You may implement this method
+     * yourself
+     */
     virtual OEffectiveEvent::ValueList effecticeEvents( const QDate& from, const QDate& to );
+
+    /**
+     * this is an overloaded member function
+     * @see effecticeEvents
+     */
     virtual OEffectiveEvent::ValueList effecticeEvents( const QDateTime& start );
diff --git a/libopie2/opiepim/backend/odatebookaccessbackend_xml.h b/libopie2/opiepim/backend/odatebookaccessbackend_xml.h
index 563c31f..7848f7c 100644
--- a/libopie2/opiepim/backend/odatebookaccessbackend_xml.h
+++ b/libopie2/opiepim/backend/odatebookaccessbackend_xml.h
@@ -7,2 +7,8 @@
 
+/**
+ * This is the default XML implementation for DateBoook XML storage
+ * It fully implements the interface
+ * @see ODateBookAccessBackend
+ * @see OPimAccessBackend
+ */
 class ODateBookAccessBackend_XML : public ODateBookAccessBackend {
diff --git a/libopie2/opiepim/core/ocontactaccess.h b/libopie2/opiepim/core/ocontactaccess.h
index 32b2dcb..d7ceaf2 100644
--- a/libopie2/opiepim/core/ocontactaccess.h
+++ b/libopie2/opiepim/core/ocontactaccess.h
@@ -19,2 +19,7 @@
  * $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
@@ -57,5 +62,9 @@
 
-/** 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
@@ -67,3 +76,4 @@ class OContactAccess: public QObject, public OPimAccessTemplate<OContact>
  public:
-        /** Create Database with contacts (addressbook).
+        /**
+         * Create Database with contacts (addressbook).
          * @param appname Name of application which wants access to the database
diff --git a/libopie2/opiepim/core/odatebookaccess.cpp b/libopie2/opiepim/core/odatebookaccess.cpp
index 08e61ff..a3661a3 100644
--- a/libopie2/opiepim/core/odatebookaccess.cpp
+++ b/libopie2/opiepim/core/odatebookaccess.cpp
@@ -3,2 +3,9 @@
 
+/**
+ * Simple constructor
+ * It takes a ODateBookAccessBackend as parent. If it is 0 the default implementation
+ * will be used!
+ * @param back The backend to be used or 0 for the default backend
+ * @param ac What kind of access is intended
+ */
 ODateBookAccess::ODateBookAccess( ODateBookAccessBackend* back, enum Access ac )
@@ -14,2 +21,6 @@ ODateBookAccess::~ODateBookAccess() {
 }
+
+/**
+ * @return all events available
+ */
 ODateBookAccess::List ODateBookAccess::rawEvents()const {
@@ -20,2 +31,6 @@ ODateBookAccess::List ODateBookAccess::rawEvents()const {
 }
+
+/**
+ * @return all repeating events
+ */
 ODateBookAccess::List ODateBookAccess::rawRepeats()const {
@@ -26,2 +41,6 @@ ODateBookAccess::List ODateBookAccess::rawRepeats()const {
 }
+
+/**
+ * @return all non repeating events
+ */
 ODateBookAccess::List ODateBookAccess::nonRepeats()const {
@@ -32,2 +51,8 @@ ODateBookAccess::List ODateBookAccess::nonRepeats()const {
 }
+
+/**
+ * @return dates in the time span between from and to
+ * @param from Include all events from...
+ * @param to Include all events to...
+ */
 OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents( const QDate& from, const QDate& to ) {
@@ -35,2 +60,5 @@ OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents( const QDate& from,
 }
+/**
+ * @return all events at a given datetime
+ */
 OEffectiveEvent::ValueList ODateBookAccess::effectiveEvents( const QDateTime& start ) {
diff --git a/libopie2/opiepim/core/odatebookaccess.h b/libopie2/opiepim/core/odatebookaccess.h
index 7047039..7c7a63f 100644
--- a/libopie2/opiepim/core/odatebookaccess.h
+++ b/libopie2/opiepim/core/odatebookaccess.h
@@ -8,2 +8,11 @@
 
+/**
+ * This is the object orientated datebook database. It'll use OBackendFactory
+ * to query for a backend.
+ * All access to the datebook should be done via this class.
+ * Make sure to load and save the datebook this is not part of
+ * destructing and creating the object
+ *
+ * @author Holger Freyther
+ */
 class ODateBookAccess : public OPimAccessTemplate<OEvent> {
@@ -13,9 +22,9 @@ public:
 
-    /** return all events */
+    /* return all events */
     List rawEvents()const;
 
-    /** return repeating events */
+    /* return repeating events */
     List rawRepeats()const;
 
-    /** return non repeating events */
+    /* return non repeating events */
     List nonRepeats()const;
diff --git a/libopie2/opiepim/ocontact.h b/libopie2/opiepim/ocontact.h
index 1fd1c75..25fa0e7 100644
--- a/libopie2/opiepim/ocontact.h
+++ b/libopie2/opiepim/ocontact.h
@@ -38,2 +38,9 @@ class ContactPrivate;
 
+/**
+ * OContact class represents a specialised PIM Record for contacts.
+ * It does store all kind of persopn related information.
+ *
+ * @short Contact Container
+ * @author TT, Stefan Eiler, Holger Freyther
+ */
 class QPC_EXPORT OContact : public OPimRecord
diff --git a/libopie2/opiepim/oevent.h b/libopie2/opiepim/oevent.h
index 585515c..57d32d0 100644
--- a/libopie2/opiepim/oevent.h
+++ b/libopie2/opiepim/oevent.h
@@ -32,2 +32,8 @@ class OPimNotifyManager;
 class ORecur;
+
+/**
+ * This is the container for all Events. It encapsules all
+ * available information for a single Event
+ * @short container for events.
+ */
 class OEvent : public OPimRecord {
@@ -35,2 +41,5 @@ public:
     typedef QValueList<OEvent> ValueList;
+    /**
+     * RecordFields contain possible attributes
+     */
     enum RecordFields {
@@ -51,3 +60,10 @@ public:
 
+    /**
+     * Start with an Empty OEvent. UID == 0 means that it is empty
+     */
     OEvent(int uid = 0);
+
+    /**
+     * copy c'tor
+     */
     OEvent( const OEvent& );
@@ -146,3 +162,2 @@ private:
  */
-
 class OEffectiveEvent {