diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2014-04-02 12:40:16 +0200 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-04-02 15:31:16 +0200 |
| commit | 37eac18a0fbbf32a43f2b7f5dba108807f12ff87 (patch) | |
| tree | be0c5b4192f2131c739da0092f59a0be1b6cc129 /doc/shared | |
| parent | a31f7383e4f81dce6009e62fec1cc9ef6d8b95a7 (diff) | |
| download | qtenginio-37eac18a0fbbf32a43f2b7f5dba108807f12ff87.tar.gz | |
Doc: Avoid linking to collision pages
C++ class and QML type references for EnginioModel use a shared
doc-include file to document a number of property/method.
This commit splits the model-query.qdocinc content in two, so
that we can pass a correctly disambiguated link as an argument
from the documentation that uses the include. This way, we
avoid linking to collision pages.
Also moves the 'see also' links to the actual property/method
documentation, fixes the \return commands, and does some other
cleanup.
Change-Id: Ia6e178f0ee91625e62289134eada7fb1edc85f62
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
Diffstat (limited to 'doc/shared')
| -rw-r--r-- | doc/shared/model-query.qdocinc | 23 | ||||
| -rw-r--r-- | doc/shared/model-remove.qdocinc | 3 |
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. |