summaryrefslogtreecommitdiff
path: root/src/webchannel/doc/src/index.qdoc
diff options
context:
space:
mode:
authorMilian Wolff <milian.wolff@kdab.com>2014-07-16 17:39:31 +0200
committerSumedha Widyadharma <sumedha.widyadharma@basyskom.com>2014-08-01 09:16:16 +0200
commitb84e46090b5230d7ebcdbdabd8c03a9ae5d2f860 (patch)
tree9687c3b47f4e77e931916a8afe1d516d3b280101 /src/webchannel/doc/src/index.qdoc
parent5051411b92b4aca4ed5ec462e7b0e52af4d3951e (diff)
downloadqtwebchannel-b84e46090b5230d7ebcdbdabd8c03a9ae5d2f860.tar.gz
Add documentation for the QtWebChannel module.
Please proof-read it and tell me what needs to be improved. I assume most people will probably not use the QWebChannel directly. Rather, they will only consume its features indirectly through the integration in QtWebKit/QtWebEngine. Thus the documentation here is for QWebChannel as a library. User-end documentation should be added to QtWebKit, I think. Change-Id: I259c204e24331271b8dc74ea11695988234a79d3 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/webchannel/doc/src/index.qdoc')
-rw-r--r--src/webchannel/doc/src/index.qdoc47
1 files changed, 47 insertions, 0 deletions
diff --git a/src/webchannel/doc/src/index.qdoc b/src/webchannel/doc/src/index.qdoc
new file mode 100644
index 0000000..635c8bd
--- /dev/null
+++ b/src/webchannel/doc/src/index.qdoc
@@ -0,0 +1,47 @@
+/****************************************************************************
+**
+** 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 documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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 Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \page qtwebchannel-index.html
+ \since 5.4
+ \title Qt WebChannel
+ \brief Bridges the gap between C++/QML and HTML/JavaScript.
+
+ The Qt WebChannel module provides a library for seamless integration of C++/QML applications
+ with HTML/JavaScript clients. Any QObject can be published to remote clients, where its public
+ API becomes available.
+
+ \section1 Related Information
+
+ 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.
+ \endlist
+*/