From 6f610544d3db6198c90105b70fab1cc84f5a1fbd Mon Sep 17 00:00:00 2001
From: zecke <zecke>
Date: Sun, 13 Apr 2003 18:07:10 +0000
Subject: More API doc

QString -> const QString&
QString = 0l -> QString::null
---
(limited to 'libopie/pim/obackendfactory.h')

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
@@ -16,6 +16,11 @@
  * =====================================================================
  * History:
  * $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
  * Add XML datebookresource
  * -clean up todoaccessxml header
@@ -63,7 +68,21 @@
 #include "otodoaccesssql.h"
 #endif
 
-
+/**
+ * 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>
 class OBackendFactory
 {
@@ -76,6 +95,11 @@ class OBackendFactory
 		DATE
 	};
 
+        /**
+         * 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 ){
 
 		// __asm__("int3");
--
cgit v0.9.0.2