More API doc

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

1 files changed, 12 insertions, 3 deletions

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
@@ -1,32 +1,41 @@
 #ifndef OPIE_DATE_BOOK_ACCESS_H
 #define OPIE_DATE_BOOK_ACCESS_H
 
 #include "odatebookaccessbackend.h"
 #include "opimaccesstemplate.h"
 
 #include "oevent.h"
 
+/**
+ * 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> {
 public:
     ODateBookAccess( ODateBookAccessBackend* = 0l, enum Access acc = Random );
     ~ODateBookAccess();
 
-    /** 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;
 
     OEffectiveEvent::ValueList effectiveEvents( const QDate& from, const QDate& to );
     OEffectiveEvent::ValueList effectiveEvents( const QDateTime& start );
 
 private:
     ODateBookAccessBackend* m_backEnd;
     class Private;
     Private* d;
 };
 
 #endif