diff options
author | Frank Meerkoetter <frank.meerkoetter@basyskom.com> | 2016-03-26 22:00:00 +0100 |
---|---|---|
committer | Frank Meerkoetter <frank.meerkoetter@basyskom.com> | 2016-04-25 11:58:26 +0000 |
commit | 9ea8ff6330b0e9259faf332de4af8bd0bfc3fcbf (patch) | |
tree | 318a37056b1f481666241618b1b4a6fa06aa051b /src/webchannel/doc/src/index.qdoc | |
parent | 1dec6caf448702bbe2bc56541846131c05a3de7e (diff) | |
download | qtwebchannel-9ea8ff6330b0e9259faf332de4af8bd0bfc3fcbf.tar.gz |
Clarify the module description
Change-Id: Ib651958ec7aa12eb205a11a515fa9a464e254bd0
Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
Diffstat (limited to 'src/webchannel/doc/src/index.qdoc')
-rw-r--r-- | src/webchannel/doc/src/index.qdoc | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/src/webchannel/doc/src/index.qdoc b/src/webchannel/doc/src/index.qdoc index 5f354bd..a4eaad0 100644 --- a/src/webchannel/doc/src/index.qdoc +++ b/src/webchannel/doc/src/index.qdoc @@ -31,14 +31,13 @@ \title Qt WebChannel \brief Bridges the gap between Qt applications and HTML/JavaScript. - 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. + Qt WebChannel enables peer-to-peer communication between a host + (QML/C++ application) and a client (HTML/JavaScript application). + It is supported out of the box by Qt WebKit 2 and Qt WebEngine. + In addition it can work on all + browsers that support WebSockets, enabling Qt WebChannel clients + to run in any JavaScript environment (including QML). This requires + the implementation of a custom transport based on Qt WebSockets. The module provides a JavaScript library for seamless integration of C++ and QML applications with HTML/JavaScript clients. The client must use the |