diff options
| author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2016-05-31 16:55:01 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2016-06-01 06:43:23 +0000 |
| commit | 7774f94b5d5cf8cea863ba22258bbd4543fab5ac (patch) | |
| tree | 8907927b19773332fd6c4d0f68acab0fafbf7467 | |
| parent | d2e2afcea59ec4e9d5edc30bad0866a8c18647b8 (diff) | |
| download | qtwebchannel-7774f94b5d5cf8cea863ba22258bbd4543fab5ac.tar.gz | |
Doc: Use 3rd person singular verb form to begin method docs
And fix a typo "connectect".
Change-Id: I14c4b249af3cad142a5f6042b2059f653a9c3eae
Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
| -rw-r--r-- | src/webchannel/qqmlwebchannel.cpp | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/src/webchannel/qqmlwebchannel.cpp b/src/webchannel/qqmlwebchannel.cpp index 277cd62..c9567a3 100644 --- a/src/webchannel/qqmlwebchannel.cpp +++ b/src/webchannel/qqmlwebchannel.cpp @@ -128,8 +128,8 @@ QQmlWebChannel::~QQmlWebChannel() /*! \qmlmethod void WebChannel::registerObjects(QVariantMap objects) - Register objects to make them accessible to HTML clients. The key of the map is used as an identifier - for the object on the client side. + Registers objects to make them accessible to HTML clients. The key of the + map is used as an identifier for the object on the client side. Once registered, all signals and property changes are automatically propagated to the clients. Public invokable methods, including slots, are also accessible to the clients. @@ -161,7 +161,8 @@ QQmlWebChannelAttached *QQmlWebChannel::qmlAttachedProperties(QObject *obj) /*! \qmlmethod void WebChannel::connectTo(QWebChannelAbstractTransport transport) - \brief Connectect to the \a transport, which represents a communication channel to a single client. + \brief Connects to the \a transport, which represents a communication + channel to a single client. The transport object must be an implementation of QWebChannelAbstractTransport. @@ -179,7 +180,7 @@ void QQmlWebChannel::connectTo(QObject *transport) /*! \qmlmethod void WebChannel::disconnectFrom(QWebChannelAbstractTransport transport) - \brief Disconnect the \a transport from this WebChannel. + \brief Disconnects the \a transport from this WebChannel. The client will not be able to communicate with the WebChannel anymore, nor will it receive any signals or property updates. |