From fe78623820c5601402ebdfedccd5085859d2cf27 Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Thu, 12 Mar 2015 16:56:09 +0100 Subject: Doc: Added a brief overview about the module Change-Id: Ib45c48613c687fdfcafd121ed9d4932cbc116799 Reviewed-by: Milian Wolff --- src/webchannel/doc/src/index.qdoc | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) (limited to 'src') 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} -- cgit v1.2.1