summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMilian Wolff <milian.wolff@kdab.com>2014-08-01 15:20:35 +0200
committerMilian Wolff <milian.wolff@kdab.com>2014-08-04 14:52:07 +0200
commit0ed8f57e9aba977acede9496a83401058f3b090b (patch)
tree9c02e3ab36780bb9fd8780c01e7a75ff439a1065 /src
parentaa75a39b3e3a4ae762f05b4a2e91d9790c8d5c88 (diff)
downloadqtwebchannel-0ed8f57e9aba977acede9496a83401058f3b090b.tar.gz
Fixup documentation issues.
These issues were raised by Sze Howe Koh in code review 89965 of change I259c204e. This change set does not yet include any comparison to the old Qt WebKit bridging functionality. I'll hand this in later. Change-Id: Idc7df0e02bfcda3c3fcf1a4e147c1dfac4f18a64 Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
Diffstat (limited to 'src')
-rw-r--r--src/webchannel/doc/src/javascript.qdoc4
-rw-r--r--src/webchannel/doc/src/module.qdoc2
-rw-r--r--src/webchannel/qwebchannel.cpp4
-rw-r--r--src/webchannel/qwebchannelabstracttransport.cpp2
4 files changed, 6 insertions, 6 deletions
diff --git a/src/webchannel/doc/src/javascript.qdoc b/src/webchannel/doc/src/javascript.qdoc
index 36bc4ab..de211d0 100644
--- a/src/webchannel/doc/src/javascript.qdoc
+++ b/src/webchannel/doc/src/javascript.qdoc
@@ -34,7 +34,7 @@
\section1 Setup
To communicate with a QWebChannel or WebChannel, any HTML client must use and setup the
- JavaScript API provided by \c qwebchannel.js. For HTML clients run inside QtWebKit, you
+ JavaScript API provided by \c qwebchannel.js. For HTML clients run inside Qt WebKit, you
can load the file via \c qrc:///qtwebchannel/qwebchannel.js. For external clients you will
need to copy the file to your webserver. Then instantiate a QWebChannel object and pass
it a transport object and a callback function, which will be invoked once the
@@ -44,7 +44,7 @@
with a \c send() function, which takes a stringified JSON message and transmits it to the
server-side QWebChannelAbstractTransport object. Furthermore, its \c onmessage property should
be called when a message from the server was received. This interface is implemented internally
- by the QtWebKit navigator.qtWebChannelTransport object. Alternatively, you can also use a
+ by the Qt WebKit navigator.qtWebChannelTransport object. Alternatively, you can also use a
WebSocket, which also implements this interface.
Note that the JavaScript QWebChannel object should be constructed once the transport object is
diff --git a/src/webchannel/doc/src/module.qdoc b/src/webchannel/doc/src/module.qdoc
index 345485e..2c07873 100644
--- a/src/webchannel/doc/src/module.qdoc
+++ b/src/webchannel/doc/src/module.qdoc
@@ -31,7 +31,7 @@
\ingroup modules
\qtvariable webchannel
\since 5.4
- \brief List of C++ classes that provide the QtWebChannel functionality.
+ \brief List of C++ classes that provide the Qt WebChannel functionality.
To use these classes in your application, use the following include
statement:
diff --git a/src/webchannel/qwebchannel.cpp b/src/webchannel/qwebchannel.cpp
index 0d096b4..99becfb 100644
--- a/src/webchannel/qwebchannel.cpp
+++ b/src/webchannel/qwebchannel.cpp
@@ -140,7 +140,7 @@ QWebChannel::~QWebChannel()
/*!
Register a group of objects to the QWebChannel.
- The properties, signals and public methods of the objects are published to the remote clients.
+ 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.
\note A current limitation is that objects must be registered before any client is initialized.
@@ -203,7 +203,7 @@ void QWebChannel::deregisterObject(QObject *object)
\brief When set to true, updates are blocked and remote clients will not be notified about property changes.
The changes are recorded and sent to the clients once updates become unblocked again by setting
- this property to false.
+ this property to false. By default, updates are not blocked.
*/
diff --git a/src/webchannel/qwebchannelabstracttransport.cpp b/src/webchannel/qwebchannelabstracttransport.cpp
index 0d56ff6..f261698 100644
--- a/src/webchannel/qwebchannelabstracttransport.cpp
+++ b/src/webchannel/qwebchannelabstracttransport.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
Users of the QWebChannel must implement this interface and connect instances of it
to the QWebChannel server for every client that should be connected to the QWebChannel.
- The {Standalone Example} shows how this can be done using QtWebSockets. QtWebKit implements
+ The {Standalone Example} shows how this can be done using Qt WebSockets. Qt WebKit implements
this interface internally and uses the native WebKit IPC mechanism to transmit messages
to HTML clients.