From d2e2afcea59ec4e9d5edc30bad0866a8c18647b8 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 31 May 2016 16:37:14 +0200 Subject: Doc: Use standard verb form to start function docs For consistency, the first verb should be in 3rd person singular form. Change-Id: I5e24ecbbac1b1ab85e737f127b021f24a55c8dd4 Reviewed-by: Milian Wolff --- src/webchannel/qwebchannel.cpp | 8 ++++---- src/webchannel/qwebchannelabstracttransport.cpp | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/webchannel/qwebchannel.cpp b/src/webchannel/qwebchannel.cpp index 24f99a2..1e8ed8f 100644 --- a/src/webchannel/qwebchannel.cpp +++ b/src/webchannel/qwebchannel.cpp @@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE \class QWebChannel \inmodule QtWebChannel - \brief Expose QObjects to remote HTML clients. + \brief Exposes QObjects to remote HTML clients. \since 5.4 The QWebChannel fills the gap between C++ applications and HTML/JavaScript @@ -130,7 +130,7 @@ QWebChannel::~QWebChannel() } /*! - Register a group of objects to the QWebChannel. + Registers a group of objects to the QWebChannel. The properties, signals and public invokable methods of the objects are published to the remote clients. There, an object with the identifier used as key in the \a objects map is then constructed. @@ -160,7 +160,7 @@ QHash QWebChannel::registeredObjects() const } /*! - Register a single object to the QWebChannel. + Registers a single object to the QWebChannel. The properties, signals and public methods of the \a object are published to the remote clients. There, an object with the identifier \a id is then constructed. @@ -176,7 +176,7 @@ void QWebChannel::registerObject(const QString &id, QObject *object) } /*! - Deregister the given \a object from the QWebChannel. + Deregisters the given \a object from the QWebChannel. Remote clients will receive a \c destroyed signal for the given object. diff --git a/src/webchannel/qwebchannelabstracttransport.cpp b/src/webchannel/qwebchannelabstracttransport.cpp index 771325a..584342b 100644 --- a/src/webchannel/qwebchannelabstracttransport.cpp +++ b/src/webchannel/qwebchannelabstracttransport.cpp @@ -62,7 +62,7 @@ QT_BEGIN_NAMESPACE /*! \fn QWebChannelAbstractTransport::sendMessage(const QJsonObject &message) - Send a JSON \a message to the remote client. An implementation would serialize the message and + Sends a JSON \a message to the remote client. An implementation would serialize the message and transmit it to the remote JavaScript client. */ -- cgit v1.2.1