summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@nokia.com>2012-06-19 15:43:09 +0200
committerQt by Nokia <qt-info@nokia.com>2012-06-19 15:55:27 +0200
commit7f8c6b2aa30e602efa331565ace9227692f6adb4 (patch)
treee41c3c0641e0ac2d822543cb35965108bc3efb50
parentb7125cfc8a7ed2200dfc51a76570b72c1dfacbc6 (diff)
Added "\brief statements"
Change-Id: Ic660a4a5838a276cfee0c35b8499c20ca0b79ca1 Reviewed-by: Jeremy Katz <jeremy.katz@nokia.com>
-rw-r--r--src/imports/jsondb-listmodel/jsondb-listmodel.cpp1
-rw-r--r--src/imports/jsondb/jsondatabase.cpp1
-rw-r--r--src/imports/jsondb/jsondblistmodel.cpp1
-rw-r--r--src/imports/jsondb/jsondbnotification.cpp1
-rw-r--r--src/imports/jsondb/jsondbpartition.cpp1
-rw-r--r--src/imports/jsondb/jsondbqueryobject.cpp1
6 files changed, 6 insertions, 0 deletions
diff --git a/src/imports/jsondb-listmodel/jsondb-listmodel.cpp b/src/imports/jsondb-listmodel/jsondb-listmodel.cpp
index a16e8dc4..dbb55dbd 100644
--- a/src/imports/jsondb-listmodel/jsondb-listmodel.cpp
+++ b/src/imports/jsondb-listmodel/jsondb-listmodel.cpp
@@ -500,6 +500,7 @@ static QVariantMap updateProperty(QVariantMap item, const QStringList &propertyC
\inqmlmodule QtAddOn.JsonDb 1.0
\inherits ListModel
\since 1.0
+ \brief Provides a ListModel displaying data items matching a query.
The JsonDbListModel provides a ListModel usable with views such as
ListView or GridView displaying data items matching a query.
diff --git a/src/imports/jsondb/jsondatabase.cpp b/src/imports/jsondb/jsondatabase.cpp
index 350b8953..d532fa04 100644
--- a/src/imports/jsondb/jsondatabase.cpp
+++ b/src/imports/jsondb/jsondatabase.cpp
@@ -58,6 +58,7 @@ QT_BEGIN_NAMESPACE_JSONDB
\qmlclass JsonDatabase JsonDatabase
\inqmlmodule QtJsonDb 1.0
\since 1.0
+ \brief Enables listing and accessing different JsonDb partitions.
JsonDatabase allows to list and access different JsonDb partitions. This is exposed
as a QML module, so that it can be used without creating a QML element.
diff --git a/src/imports/jsondb/jsondblistmodel.cpp b/src/imports/jsondb/jsondblistmodel.cpp
index f60719fe..fe6fe3ae 100644
--- a/src/imports/jsondb/jsondblistmodel.cpp
+++ b/src/imports/jsondb/jsondblistmodel.cpp
@@ -64,6 +64,7 @@ QT_BEGIN_NAMESPACE_JSONDB
\qmlclass JsonDbListModel JsonDbListModel
\inqmlmodule QtJsonDb 1.0
\since 1.0
+ \brief Provides a ListModel displaying data matching a query
The JsonDbListModel provides a read-only ListModel usable with views such as
ListView or GridView displaying data items matching a query. The sorting is done using
diff --git a/src/imports/jsondb/jsondbnotification.cpp b/src/imports/jsondb/jsondbnotification.cpp
index 8977072a..4d137533 100644
--- a/src/imports/jsondb/jsondbnotification.cpp
+++ b/src/imports/jsondb/jsondbnotification.cpp
@@ -50,6 +50,7 @@ QT_BEGIN_NAMESPACE_JSONDB
\qmlclass Notification JsonDbNotify
\inqmlmodule QtJsonDb 1.0
\since 1.0
+ \brief Allows registration for notifications matching a query in a partition.
This allows to register for different notifications that matches a query in a Partition.
Users can connect to onNotification signal which is fired for objects matching the query.
diff --git a/src/imports/jsondb/jsondbpartition.cpp b/src/imports/jsondb/jsondbpartition.cpp
index 7ff1ad18..ac7b1c5d 100644
--- a/src/imports/jsondb/jsondbpartition.cpp
+++ b/src/imports/jsondb/jsondbpartition.cpp
@@ -56,6 +56,7 @@ QT_BEGIN_NAMESPACE_JSONDB
\qmlclass Partition JsonDbPartition
\inqmlmodule QtJsonDb 1.0
\since 1.0
+ \brief Find, create, update, or remove objects in a partition.
The partition object allows you find, create, update, or remove objects from JsonDb.
It also allows to create query, notification and changesSince objects, query. A partition
diff --git a/src/imports/jsondb/jsondbqueryobject.cpp b/src/imports/jsondb/jsondbqueryobject.cpp
index 02d0133a..fb05da96 100644
--- a/src/imports/jsondb/jsondbqueryobject.cpp
+++ b/src/imports/jsondb/jsondbqueryobject.cpp
@@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE_JSONDB
\qmlclass Query JsonDbQueryObject
\inqmlmodule QtJsonDb 1.0
\since 1.0
+ \brief Allows querying for objects in a partition.
This allows to query for objects in a Partition. Users can execute the query by
calling the start(). To retrieve the results, connect to onResultsReady and/or onFinished.