diff options
Diffstat (limited to 'src/webchannel/doc')
| -rw-r--r-- | src/webchannel/doc/qtwebchannel.qdocconf | 3 | ||||
| -rw-r--r-- | src/webchannel/doc/src/examples.qdoc | 41 | ||||
| -rw-r--r-- | src/webchannel/doc/src/index.qdoc | 11 | ||||
| -rw-r--r-- | src/webchannel/doc/src/javascript.qdoc | 3 |
4 files changed, 51 insertions, 7 deletions
diff --git a/src/webchannel/doc/qtwebchannel.qdocconf b/src/webchannel/doc/qtwebchannel.qdocconf index e2ed336..cfb47e4 100644 --- a/src/webchannel/doc/qtwebchannel.qdocconf +++ b/src/webchannel/doc/qtwebchannel.qdocconf @@ -40,7 +40,7 @@ qhp.QtWebChannel.subprojects.javascript.indexTitle = Qt WebChannel JavaScript tagfile = ../../../doc/qtwebchannel/qtwebchannel.tags -depends += qtcore qtquick qtqml qmake +depends += qtcore qtquick qtqml qmake qtdoc headerdirs += .. \ ../../imports @@ -50,6 +50,7 @@ sourcedirs += .. \ exampledirs += ../../../examples/webchannel +examples.fileextensions += "*.html *.json" navigation.landingpage = "Qt WebChannel" navigation.cppclassespage = "Qt WebChannel C++ Classes" diff --git a/src/webchannel/doc/src/examples.qdoc b/src/webchannel/doc/src/examples.qdoc new file mode 100644 index 0000000..695e232 --- /dev/null +++ b/src/webchannel/doc/src/examples.qdoc @@ -0,0 +1,41 @@ +/**************************************************************************** +** +** Copyright (C) 2014 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Milian Wolff <milian.wolff@kdab.com> +** Contact: http://www.qt-project.org/legal +** +** This file is part of the QtWebChannel module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL21$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 or version 3 as published by the Free +** Software Foundation and appearing in the file LICENSE.LGPLv21 and +** LICENSE.LGPLv3 included in the packaging of this file. Please review the +** following information to ensure the GNU Lesser General Public License +** requirements will be met: https://www.gnu.org/licenses/lgpl.html and +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \title Qt WebChannel Examples + \group qtwebchannel-examples + \brief List of Qt WebChannel examples. + + The examples show how to use the QWebChannel C++ and WebChannel QML 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/doc/src/javascript.qdoc b/src/webchannel/doc/src/javascript.qdoc index de211d0..fa8edfe 100644 --- a/src/webchannel/doc/src/javascript.qdoc +++ b/src/webchannel/doc/src/javascript.qdoc @@ -49,7 +49,8 @@ Note that the JavaScript QWebChannel object should be constructed once the transport object is fully operational. In case of a WebSocket, that means you should create the QWebChannel in the - socket's \c onopen handler. Take a look at the \l{Standalone Example} to see how this is done. + socket's \c onopen handler. Take a look at the \l{Qt WebChannel Standalone Example} to see how + this is done. \section1 Interacting with QObjects |