summaryrefslogtreecommitdiff
path: root/libopie2/opiepim/backend
Side-by-side diff
Diffstat (limited to 'libopie2/opiepim/backend') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opiepim/backend/obackendfactory.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/libopie2/opiepim/backend/obackendfactory.h b/libopie2/opiepim/backend/obackendfactory.h
index c8a4627..6f46652 100644
--- a/libopie2/opiepim/backend/obackendfactory.h
+++ b/libopie2/opiepim/backend/obackendfactory.h
@@ -64,13 +64,13 @@ class OBackendPrivate;
* 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>
- * OPimTodoAccessBackend* backend = OBackEndFactory<OPimTodoAccessBackend>::Default("todo", QString::null );
+ * OPimTodoAccessBackend* backend = OBackEndFactory<OPimTodoAccessBackend>::Default( OPimGlobal::TODOLIST, QString::null );
* backend->load();
* </pre>
*
* @author Stefan Eilers
* @version 0.1
*/
@@ -83,12 +83,13 @@ class OBackendFactory
/**
* Returns a selected backend implementation
* @param type the type of the backend
* @param database the type of the used database
* @param appName The name of your application. It will be passed on to the backend.
* @param filename Filename of the database file if you don't want to access the default
+ * @see OPimGlobal()
*/
static T* create( OPimGlobal::PimType type, OPimGlobal::DatabaseStyle database,
const QString& appName, const QString& filename = QString::null ){
qWarning("Selected backend for %d is: %d", type, database );
// If we should use the dafult database style, we have to request it
OPimGlobal::DatabaseStyle use_database = database;
@@ -162,13 +163,13 @@ class OBackendFactory
}
/**
* Returns the style of the default database which is used to contact PIM data.
* @param type the type of the backend
- * @see OPimGlobal
+ * @see OPimGlobal()
*/
static OPimGlobal::DatabaseStyle defaultDB( OPimGlobal::PimType type ){
QString group_name;
switch ( type ){
case OPimGlobal::TODOLIST:
group_name = "todo";
@@ -205,12 +206,13 @@ class OBackendFactory
/**
* Returns the default backend implementation for backendName. Which one is used, is defined
* by the configfile "pimaccess.conf".
* @param type The type of the backend (@see OPimGlobal())
* @param appName The name of your application. It will be passed on to the backend
+ * @see OPimGlobal()
*/
static T* defaultBackend( OPimGlobal::PimType type, const QString& appName ){
return create( type, OPimGlobal::DEFAULT, appName );
}
private:
OBackendPrivate* d;