summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorLiang Qi <liang.qi@theqtcompany.com>2015-06-29 20:15:25 +0200
committerLiang Qi <liang.qi@theqtcompany.com>2015-06-29 20:15:25 +0200
commitb401f4ab3e0bcbf0da781a8d78032752f11500ab (patch)
treebc57ce0e3a14bde8c2b4bb6beabc94e34acdbbe8 /src
parent368adbf8e75c00712c7a30eb6b8d7a7e175e89d7 (diff)
parente0bf79a69dcec9825f815501bff181f12e3c33ed (diff)
downloadqtwebchannel-b401f4ab3e0bcbf0da781a8d78032752f11500ab.tar.gz
Merge remote-tracking branch 'origin/5.5' into dev
Conflicts: .qmake.conf Change-Id: Ia5b809f6aeaa29c6acd6f45b696da285fe06b5f2
Diffstat (limited to 'src')
-rw-r--r--src/webchannel/doc/src/index.qdoc18
1 files changed, 13 insertions, 5 deletions
diff --git a/src/webchannel/doc/src/index.qdoc b/src/webchannel/doc/src/index.qdoc
index 78534b6..5f354bd 100644
--- a/src/webchannel/doc/src/index.qdoc
+++ b/src/webchannel/doc/src/index.qdoc
@@ -31,13 +31,21 @@
\title Qt WebChannel
\brief Bridges the gap between Qt applications and HTML/JavaScript.
- 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.
+ Qt WebChannel enables peer-to-peer communication between the host
+ (QML/C++ application) and the client (HTML/JavaScript application). The
+ transport mechanism is supported out of the box by the two popular web
+ engines, Qt WebKit 2 and Qt WebEngine (experimental). It works on all
+ browsers that support Qt WebSockets, enabling Qt WebChannel applications
+ to run in any JavaScript runtime. Additionally, a custom transport
+ mechanism can also be implemented using Qt WebSockets to support Qt
+ WebChannel-based communication.
- \section1 Related Information
+ The module provides a JavaScript library for seamless integration of C++
+ and QML applications with HTML/JavaScript clients. The client must use the
+ JavaScript library to access the serialized QObjects published by the host
+ applications.
- For more information on how to use this module, please refer to the following pages:
+ \section1 Related Information
\list
\li \l{Qt WebChannel JavaScript API}{JavaScript API}