Add some docs to QJsonDbWriteRequest

Change-Id: I41237c7afefbdf3bb70ccd7379e884191fff9ca6
Reviewed-by: Jamey Hicks <jamey.hicks@nokia.com>

1 files changed, 10 insertions, 0 deletions

diff --git a/src/client/qjsondbwriterequest.cpp b/src/client/qjsondbwriterequest.cpp
index 4d57d8e..8d88fc7 100644
--- a/src/client/qjsondbwriterequest.cpp
+++ b/src/client/qjsondbwriterequest.cpp
@@ -54,6 +54,15 @@ QT_BEGIN_NAMESPACE_JSONDB
 
     \brief The QJsonDbWriteRequest class allows to put objects into the database.
 
+    Every write request to JsonDb is essentially an update to the object store. You can
+    update the database by adding a new object, modifying an existing object
+    or removing an existing object.
+
+    All updates are carried out by passing a QJsonObject list to the setObjects() function
+    and then sending the write request object to the server via the QJsonDbConnection::send()
+    function. How JsonDb processes each object depends on which properties the object has.
+    For a description of these properties, please see the setObjects() function.
+
     \code
         QJsonObject object;
         object.insert(QStringLiteral("_type"), QLatin1String("Foo"));
@@ -80,6 +89,7 @@ QT_BEGIN_NAMESPACE_JSONDB
     objects.
 
     \sa QJsonDbObject
+    \sa setObjects()
 */
 /*!
     \enum QJsonDbWriteRequest::ErrorCode