summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/shared/model-query.qdocinc23
-rw-r--r--doc/shared/model-remove.qdocinc3
2 files changed, 15 insertions, 11 deletions
diff --git a/doc/shared/model-query.qdocinc b/doc/shared/model-query.qdocinc
index bdba13a..f9fe954 100644
--- a/doc/shared/model-query.qdocinc
+++ b/doc/shared/model-query.qdocinc
@@ -1,19 +1,24 @@
+/*!
+//![0]
\brief The query used to populate the model with data from the backend.
-It takes the same argument as \l EnginioClient::query(), so that the documentation
-for \l EnginioClient::query() can be consulted regarding how to construct the query.
+See
+//![0]
+\l {EnginioClient::query()}
+//![1]
+documentation for information on how to construct a query.
-While \l EnginioClient::query() returns the data of a query as a JSON
-object, for the model the query will be interpreted as the model data.
+While the EnginioClient implementation of \c query() returns
+the data of a query as a JSON object, for the model the query will be
+interpreted as the model data.
-Usually the query is for one object type and will return all objects
+Usually, the query is for a single object type and will return all objects
in the database of that type. The model will then represent each returned object
as one row. It can be limited and sorted just like its counterpart
in EnginioClient.
One important thing to note is that the model cannot keep the same sorting as
-the backend and thus sorting and limits are only preserved until
+the backend, and thus sorting and limits are only preserved until
an insertion or deletion happens.
-
-\return the EnginioReply from the backend
-\sa EnginioClient::query()
+//![1]
+*/
diff --git a/doc/shared/model-remove.qdocinc b/doc/shared/model-remove.qdocinc
index 94de12d..242ca9d 100644
--- a/doc/shared/model-remove.qdocinc
+++ b/doc/shared/model-remove.qdocinc
@@ -4,5 +4,4 @@
This function immediately removes the \a row from the local cache
and sends a remove request to the Enginio backend.
-\return the EnginioReply from the backend
-\sa EnginioClient::remove() \ No newline at end of file
+\return the EnginioReply from the backend.