summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2014-08-17 19:37:32 +0200
committerMilian Wolff <milian.wolff@kdab.com>2014-08-23 16:11:50 +0200
commitdac411122a9275eac6b94c1cd3ca0c300937cf83 (patch)
tree01c78ef0e0f3028c80664443ba64a0a7d62496f5
parentbef82079db57ce6c4626dc4f3b6c36386713f7d1 (diff)
downloadqtwebchannel-dac411122a9275eac6b94c1cd3ca0c300937cf83.tar.gz
Doc: Edited links JavaScript API page and other documentation fixes.
The JavaScript API page is important to the rest of the documentation but there was no link to it. Task-number: QTBUG-40756 Change-Id: Id741a67ac2b57e21da548c2961c622c7516ac8cf Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
-rw-r--r--examples/webchannel/standalone/doc/src/standalone.qdoc6
-rw-r--r--src/webchannel/doc/src/index.qdoc11
-rw-r--r--src/webchannel/qqmlwebchannel.cpp2
-rw-r--r--src/webchannel/qwebchannel.cpp6
4 files changed, 14 insertions, 11 deletions
diff --git a/examples/webchannel/standalone/doc/src/standalone.qdoc b/examples/webchannel/standalone/doc/src/standalone.qdoc
index c5199c3..8dde2b1 100644
--- a/examples/webchannel/standalone/doc/src/standalone.qdoc
+++ b/examples/webchannel/standalone/doc/src/standalone.qdoc
@@ -46,7 +46,7 @@
\image standalone-screenshot.png
\brief Shows how to use the QWebChannel C++ API to communicate with an external client.
- The standalone example is a simple chat between a pure C++/Qt application and a remote HTML
+ The standalone example is a simple chat between a C++ application and a remote HTML
client running in your default browser.
\include examples-run.qdocinc
@@ -61,8 +61,10 @@
automatically gets propagated to the HTML client. When the user enters a message on the HTML
side, Dialog::receiveText() is called.
- All communication between the HTML client and the C++/Qt server is done over a WebSocket.
+ All communication between the HTML client and the C++ server is done over a WebSocket.
The C++ side instantiates a QWebSocketServer and wraps incoming QWebSocket connections
in WebSocketTransport objects, which implement QWebChannelAbstractTransport. These objects are
then connected to the QWebChannel instance.
+
+ \sa {Qt WebChannel JavaScript API}
*/
diff --git a/src/webchannel/doc/src/index.qdoc b/src/webchannel/doc/src/index.qdoc
index 635c8bd..5d012dc 100644
--- a/src/webchannel/doc/src/index.qdoc
+++ b/src/webchannel/doc/src/index.qdoc
@@ -29,9 +29,9 @@
\page qtwebchannel-index.html
\since 5.4
\title Qt WebChannel
- \brief Bridges the gap between C++/QML and HTML/JavaScript.
+ \brief Bridges the gap between Qt applications and HTML/JavaScript.
- The Qt WebChannel module provides a library for seamless integration of C++/QML applications
+ The Qt WebChannel module provides a library for seamless integration of C++ and QML applications
with HTML/JavaScript clients. Any QObject can be published to remote clients, where its public
API becomes available.
@@ -40,8 +40,9 @@
For more information on how to use this module, please refer to the following pages:
\list
- \li \l{Qt WebChannel C++ Classes} explains QWebChannel C++ API.
- \li \l{Qt WebChannel QML Types} explains the WebChannel QML API.
- \li The \l{Qt WebChannel Examples} show how use the API in practice.
+ \li \l{Qt WebChannel JavaScript API}{JavaScript API}
+ \li \l{Qt WebChannel C++ Classes}{C++ API}
+ \li \l{Qt WebChannel QML Types}{QML API}
+ \li \l{Qt WebChannel Examples}{Examples} - show how use the API in practice
\endlist
*/
diff --git a/src/webchannel/qqmlwebchannel.cpp b/src/webchannel/qqmlwebchannel.cpp
index ad17ce7..0b7d865 100644
--- a/src/webchannel/qqmlwebchannel.cpp
+++ b/src/webchannel/qqmlwebchannel.cpp
@@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE
The WebChannel provides a mechanism to transparently access QObject or QML objects from HTML
clients. All properties, signals and public slots can be used from the HTML clients.
- \sa QWebChannel
+ \sa QWebChannel, {Qt WebChannel JavaScript API}{JavaScript API}
*/
/*!
diff --git a/src/webchannel/qwebchannel.cpp b/src/webchannel/qwebchannel.cpp
index e3df0b9..928e8d4 100644
--- a/src/webchannel/qwebchannel.cpp
+++ b/src/webchannel/qwebchannel.cpp
@@ -59,7 +59,7 @@ QT_BEGIN_NAMESPACE
The QWebChannel fills the gap between C++ applications and HTML/JavaScript
applications. By publishing a QObject derived object to a QWebChannel and
- using \l{qtwebchannel-javascript.html}{\c qwebchannel.js} on the HTML side, one can transparently access
+ using the \l{Qt WebChannel JavaScript API}{qwebchannel.js} on the HTML side, one can transparently access
properties and public slots and methods of the QObject. No manual message
passing and serialization of data is required, property updates and signal emission
on the C++ side get automatically transmitted to the potentially remotely running HTML clients.
@@ -68,12 +68,12 @@ QT_BEGIN_NAMESPACE
The C++ QWebChannel API makes it possible to talk to any HTML client, which could run on a local
or even remote machine. The only limitation is that the HTML client supports the JavaScript
- features used by \l{qtwebchannel-javascript.html}{\c qwebchannel.js}. As such, one can interact
+ 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.
- \sa {Qt WebChannel Standalone Example}
+ \sa {Qt WebChannel Standalone Example}, {Qt WebChannel JavaScript API}{JavaScript API}
*/
/*!