diff options
author | Martin Smith <martin.smith@digia.com> | 2014-08-22 13:25:32 +0200 |
---|---|---|
committer | Jędrzej Nowacki <jedrzej.nowacki@digia.com> | 2014-08-29 13:43:24 +0200 |
commit | 449c15357646a1cfa0e2cccaef931a3a9c49d62b (patch) | |
tree | 3e676e80948c61d656520c708967afb58acea85d /doc | |
parent | 19a551e09264513766c569770539d55b6cc00d35 (diff) | |
download | qtenginio-449c15357646a1cfa0e2cccaef931a3a9c49d62b.tar.gz |
qdoc: Correct some links in QtEnginio
Several links in the Enginio docs are either broken, or they got to
the wrong page. This update fixes several cases in the overview.
Change-Id: I814b2b2c6826fb1a54ac7a8fccc509281298ef77
Task-number: QTBUG-40919
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/enginio_overview.qdoc | 11 | ||||
-rw-r--r-- | doc/qtenginiooverview.qdocconf | 2 |
2 files changed, 7 insertions, 6 deletions
diff --git a/doc/enginio_overview.qdoc b/doc/enginio_overview.qdoc index bac8f80..6db1761 100644 --- a/doc/enginio_overview.qdoc +++ b/doc/enginio_overview.qdoc @@ -90,7 +90,8 @@ To operate on objects of any type, the basic operations are: \endlist For a detailed description of the operations see the functions -in the \l {EnginioClientCpp}{EnginioClient Class} in C++ or \l {EnginioClientQml}{EnginioClient type} in QML. +in the \l [CPP] {EnginioClient} {EnginioClient Class} in C++ or +\l [QML] {EnginioClient} {EnginioClient type} in QML. \note User management and access control lists are conveniently done by the same functions. @@ -135,7 +136,7 @@ required as the native SSL framework is used. \section1 Setup a Qt Quick 2 application project -Create a new Qt Quick 2 Application. +Create a new \l [QtQuick] {Qt Quick} {Qt Quick 2} Application. You can use Qt Creator to get started with a template. (File ⇒ New File or Project ⇒ Applications ⇒ Qt Quick 2 Application) @@ -147,7 +148,7 @@ To use Enginio's QML API, you have to import the library. import Enginio 1.0 \endcode -Initialize the \l{EnginioClientQml}{EnginioClient} with the \c {backend id} value, which can be copied from the Dashboard. +Initialize the \l [QML] {EnginioClient} with the \c {backend id} value, which can be copied from the Dashboard. Go to Dashboard ⇒ Your Backend home-view ⇒ See ’Keys box’ ⇒ Copy backend id value. @@ -224,12 +225,12 @@ Create an object in JSON format and fill in the data: city.insert("population", 624000); \endcode -Create the object in the Enginio database by calling \l{EnginioClient}{EnginioClient::create()}: +Create the object in the Enginio database by calling \l {EnginioClient::create()}: \code client->create(city); connect(client, SIGNAL(finished(EnginioReply*)), this, SLOT(uploadFinished(EnginioReply*))); \endcode -Note that the \c create() method performs the actual asynchronous network communication. +Note that the \l {EnginioClient::create()} {create()} method performs the actual asynchronous network communication. You need to wait for its completion by connecting to the \l{EnginioClient::finished()}{finished} and \l{EnginioClient::error()}{error} signals. Now you can \l{Checking stored objects in the Dashboard}{check the Enginio dashboard} for the newly created object. diff --git a/doc/qtenginiooverview.qdocconf b/doc/qtenginiooverview.qdocconf index abc7a99..906ca26 100644 --- a/doc/qtenginiooverview.qdocconf +++ b/doc/qtenginiooverview.qdocconf @@ -11,7 +11,7 @@ headerdirs += . imagedirs += images -depends += qtcore qtgui qtwidgets qtnetwork qtdoc qtenginio qtenginioqml +depends += qtcore qtgui qtwidgets qtnetwork qtquick qtdoc qtenginio qtenginioqml qhp.projects = QtEnginioOverview |