From 9ebaffbd531f0db4b3f528ebb7812b281520117d Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 31 May 2016 15:56:35 +0200 Subject: Doc: Fix links to other modules -Remove references to Qt WebKit Change-Id: I0bd184021b1a87828e93f5783c38b9ba97f37763 Reviewed-by: Milian Wolff --- src/webchannel/doc/src/javascript.qdoc | 17 ++++++++--------- src/webchannel/qwebchannel.cpp | 2 +- src/webchannel/qwebchannelabstracttransport.cpp | 5 ++--- 3 files changed, 11 insertions(+), 13 deletions(-) (limited to 'src') diff --git a/src/webchannel/doc/src/javascript.qdoc b/src/webchannel/doc/src/javascript.qdoc index cfb5b21..a508ff9 100644 --- a/src/webchannel/doc/src/javascript.qdoc +++ b/src/webchannel/doc/src/javascript.qdoc @@ -31,21 +31,20 @@ \brief This page explains how to use the JavaScript QWebChannel API in HTML clients. - \section1 Setup + \section1 Setting up the JavaScript API - 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 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 + To communicate with a QWebChannel or \l [QML] WebChannel, a client must use and set up the + JavaScript API provided by \c qwebchannel.js. For clients run inside \l{Qt WebEngine}, you + can load the file via \c qrc:///qtwebchannel/qwebchannel.js. For external clients, you + need to copy the file to your web server. Then instantiate a QWebChannel object and pass it a transport object and a callback function, which will be invoked once the - initialization of the channel finished and published objects become available. + initialization of the channel finishes and the published objects become available. The transport object implements a minimal message passing interface. It should be an object 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 Qt WebKit navigator.qtWebChannelTransport object. Alternatively, you can also use a - WebSocket, which also implements this interface. + be called when a message from the server was received. Alternatively, you can use a + \l{Qt WebSockets}{WebSocket} to implement the interface. Note that the JavaScript QWebChannel object should be constructed once the transport object is fully operational. In case of a WebSocket, that means you should create the QWebChannel in the diff --git a/src/webchannel/qwebchannel.cpp b/src/webchannel/qwebchannel.cpp index d440556..24f99a2 100644 --- a/src/webchannel/qwebchannel.cpp +++ b/src/webchannel/qwebchannel.cpp @@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE features used by \c{qwebchannel.js}. As such, one can interact with basically any modern HTML browser or standalone JavaScript runtime, such as node.js. - There also exists a declarative WebChannel API. + There also exists a declarative \l{Qt WebChannel QML Types}{WebChannel API}. \sa {Qt WebChannel Standalone Example}, {Qt WebChannel JavaScript API}{JavaScript API} */ diff --git a/src/webchannel/qwebchannelabstracttransport.cpp b/src/webchannel/qwebchannelabstracttransport.cpp index 8d91dd1..771325a 100644 --- a/src/webchannel/qwebchannelabstracttransport.cpp +++ b/src/webchannel/qwebchannelabstracttransport.cpp @@ -44,9 +44,8 @@ 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 {Qt WebChannel Standalone Example}{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. + The \l{Qt WebChannel Standalone Example} shows how this can be done + using \l{Qt WebSockets}. \note The JSON message protocol is considered internal and might change over time. -- cgit v1.2.1