diff options
| author | Jędrzej Nowacki <jedrzej.nowacki@digia.com> | 2013-11-26 11:39:15 +0000 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-11-26 14:23:32 +0100 |
| commit | 4f8ad89f6e43d8c8cdf025a93b401efade8f6f2c (patch) | |
| tree | de1b501ad8014fe62653ad79ae318aea151f4ac0 /examples | |
| parent | a4db9b5a5deed18bbbdb19cf7054cf0fa84a9d95 (diff) | |
| download | qtenginio-4f8ad89f6e43d8c8cdf025a93b401efade8f6f2c.tar.gz | |
Fix some qdoc errors.
EnginioModel::enginio was renamed to EnginioModel::client.
EnginioIdentity::prepareSessionToken and removeSessionToken were moved
to protected section and qdoc thinks that they are apis.
Enginio was renamed to EnginioClient in QML.
Change-Id: I2549c9eac8d2ccbf8b82660eb92c4dcbd25dbb60
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/quick/users/doc/src/users.qdoc | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/examples/quick/users/doc/src/users.qdoc b/examples/quick/users/doc/src/users.qdoc index 1a49b89..ce97e3b 100644 --- a/examples/quick/users/doc/src/users.qdoc +++ b/examples/quick/users/doc/src/users.qdoc @@ -81,9 +81,9 @@ \section1 User authentication Authentication is quite easy. The only thing that needs to be done is to assign an identity, for example - \l{EnginioOAuth2Authentication}{EnginioOAuth2Authentication} object to \l{Enginio::identity}{Enginio::identity}. - After a while, \l{Enginio::authenticationState}{Enginio::authenticationState} will change and - \l{Enginio::sessionAuthenticated}{sessionAuthenticated} or \l{Enginio::sessionAuthenticationError}{sessionAuthenticationError} + \l{EnginioOAuth2Authentication}{EnginioOAuth2Authentication} object to \l{EnginioClient::identity}{EnginioClient::identity}. + After a while, \l{EnginioClient::authenticationState}{EnginioClient::authenticationState} will change and + \l{EnginioClient::sessionAuthenticated}{sessionAuthenticated} or \l{EnginioClient::sessionAuthenticationError}{sessionAuthenticationError} will be emitted. The first thing we need to do is to create an identity object: \l{EnginioOAuth2Authentication}{EnginioOAuth2Authentication} @@ -97,7 +97,7 @@ Once the authentication query finishes, the state changes to "Authenticated" or "AuthenticationFailure" depending on the authentication result. Null - assignment to the \l{Enginio::identity}{identity} causes the session to terminate immediately: + assignment to the \l{EnginioClient::identity}{identity} causes the session to terminate immediately: \snippet users/Login.qml assignNull For educational purposes, in the example we also show a log window with data attached to @@ -106,7 +106,7 @@ \section1 Registering a new user Registration of a new user is as simple as adding a new object to the "users" collection. It can be achieved - by using the \l{Enginio::create}{create} function, as shown below: + by using the \l{EnginioClient::create}{create} function, as shown below: \snippet users/Register.qml create We could also use the \l{Enginio1::EnginioModel::append}{EnginioModel::append} method in the browsing example |