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 | |
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>
-rw-r--r-- | doc/enginio_overview.qdoc | 11 | ||||
-rw-r--r-- | doc/qtenginiooverview.qdocconf | 2 | ||||
-rw-r--r-- | examples/enginio/widgets/todos-cpp/doc/src/todos-cpp.qdoc | 14 | ||||
-rw-r--r-- | src/enginio_client/doc/qtenginio.qdocconf | 2 | ||||
-rw-r--r-- | src/enginio_client/enginiomodel.cpp | 2 | ||||
-rw-r--r-- | src/enginio_client/enginioreply.cpp | 8 |
6 files changed, 20 insertions, 19 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 diff --git a/examples/enginio/widgets/todos-cpp/doc/src/todos-cpp.qdoc b/examples/enginio/widgets/todos-cpp/doc/src/todos-cpp.qdoc index ebbce73..69445d4 100644 --- a/examples/enginio/widgets/todos-cpp/doc/src/todos-cpp.qdoc +++ b/examples/enginio/widgets/todos-cpp/doc/src/todos-cpp.qdoc @@ -49,18 +49,18 @@ } \endcode - The first step is to create a TodosModel which inherits \l {EnginioModelCpp}{EnginioModel}, + The first step is to create a TodosModel which inherits \l [CPP] {EnginioModel}, and defines the main roles which will be used. As we are interested in the To Do \c title and the \c completed information we need to define these two roles. \snippet todos-cpp/todosmodel.h definition By default, views (for example \l QListView) use the \l{Qt::ItemDataRole} role to display or edit the content. - The newly created \l{EnginioModelCpp}{EnginioModel} is empty and defines basic roles. Most roles are created + The newly created \l [CPP] {EnginioModel} is empty and defines basic roles. Most roles are created dynamically, based on the JSON datastructure. They have no predefined value in the \l Qt::ItemDataRole enum. - \l{EnginioModelCpp}{EnginioModel} automatically populates itself as soon as the + \l [CPP] {EnginioModel} automatically populates itself as soon as the \l{EnginioModel::query}{query} and \l{EnginioModel::client}{client} properties have been set. When the data is downloaded, the model resets itself, and sets up the internal data cache and roles names. - \l{EnginioModelCpp}{EnginioModel} guesses the role names based on heuristics. It may be wrong if not all + \l [CPP] {EnginioModel} guesses the role names based on heuristics. It may be wrong if not all objects received from the backend have exactly the same structure. For example, a property can be missing in certain objects. To protect against such cases, we overload \l{EnginioModel::roleNames()}{roleNames()}. Overriding \l{EnginioModel::roleNames()}{roleNames()} can also be used to match default Qt roles to the named @@ -73,20 +73,20 @@ Remember to always call the base class implementation to avoid situations in which the internal cache is not in sync. - By default \l {EnginioModelCpp}{EnginioModel} operates on \l{QJsonValue}, and that is + By default \l [CPP] {EnginioModel} operates on \l{QJsonValue}, and that is what the \l{EnginioModel::data()}{data()} function returns inside the \l QVariant, but standard views, such as \l QListView, use predefined roles which do not map directly to our roles. That is why we need to write a mapping between them: \snippet todos-cpp/todosmodel.cpp data - As we have our model defined, we need to create an instance of \l EnginioClient: + As we have our model defined, we need to create an instance of \l {EnginioClient}: \snippet todos-cpp/mainwindow.cpp client It is used by the model to connect to the Enginio backend. Next we need to construct and configure our model too. The configuration is based on two steps, assigning - an \l EnginioClient instance and by creating a query. + an \l {EnginioClient} instance and by creating a query. \snippet todos-cpp/mainwindow.cpp model diff --git a/src/enginio_client/doc/qtenginio.qdocconf b/src/enginio_client/doc/qtenginio.qdocconf index ca1385c..c9037be 100644 --- a/src/enginio_client/doc/qtenginio.qdocconf +++ b/src/enginio_client/doc/qtenginio.qdocconf @@ -23,7 +23,7 @@ exampledirs += \ # Specify example install dir under QT_INSTALL_EXAMPLES examplesinstallpath = enginio/widgets -depends += qtcore qtgui qtwidgets qtnetwork qtenginiooverview +depends += qtcore qtgui qtwidgets qtnetwork qtquick qtenginioqml qtenginiooverview qhp.projects = QtEnginio diff --git a/src/enginio_client/enginiomodel.cpp b/src/enginio_client/enginiomodel.cpp index 3ff34a3..b1eb1b3 100644 --- a/src/enginio_client/enginiomodel.cpp +++ b/src/enginio_client/enginiomodel.cpp @@ -414,7 +414,7 @@ EnginioBaseModel::~EnginioBaseModel() \note Some objects may not contain value for a static role, it may happen for example when an item is not in sync with the backend. - \sa EnginioBaseModel::roleNames() + \sa QAbstractItemModel::roleNames() */ /*! diff --git a/src/enginio_client/enginioreply.cpp b/src/enginio_client/enginioreply.cpp index 3e5cfdd..78bc48b 100644 --- a/src/enginio_client/enginioreply.cpp +++ b/src/enginio_client/enginioreply.cpp @@ -278,8 +278,8 @@ bool EnginioReplyState::delayFinishedSignal() /*! \fn bool EnginioReply::isError() const - \brief EnginioReplyState::isError returns whether this reply was unsuccessful - \return true if the reply did not succeed + Returns whether this reply was unsuccessful. + Returns true if the reply did not succeed. */ bool EnginioReplyState::isError() const @@ -290,8 +290,8 @@ bool EnginioReplyState::isError() const /*! \fn bool EnginioReply::isFinished() const - \brief Returns whether this reply was finished or not - \return true if the reply was finished, false otherwise. + Returns whether this reply was finished or not. + Returns true if the reply was finished. */ bool EnginioReplyState::isFinished() const |