More API doc

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

1 files changed, 26 insertions, 4 deletions

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;