From dac411122a9275eac6b94c1cd3ca0c300937cf83 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Sun, 17 Aug 2014 19:37:32 +0200 Subject: 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 --- src/webchannel/doc/src/index.qdoc | 11 ++++++----- src/webchannel/qqmlwebchannel.cpp | 2 +- src/webchannel/qwebchannel.cpp | 6 +++--- 3 files changed, 10 insertions(+), 9 deletions(-) (limited to 'src') 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} */ /*! -- cgit v1.2.1