diff options
Diffstat (limited to 'src/webchannel/doc/src/module.qdoc')
| -rw-r--r-- | src/webchannel/doc/src/module.qdoc | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/src/webchannel/doc/src/module.qdoc b/src/webchannel/doc/src/module.qdoc new file mode 100644 index 0000000..345485e --- /dev/null +++ b/src/webchannel/doc/src/module.qdoc @@ -0,0 +1,60 @@ +/**************************************************************************** +** +** 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$ +** +****************************************************************************/ + +/*! + \module QtWebChannel + \title Qt WebChannel C++ Classes + \ingroup modules + \qtvariable webchannel + \since 5.4 + \brief List of C++ classes that provide the QtWebChannel functionality. + + To use these classes in your application, use the following include + statement: + + \code + #include <QtWebChannel/QtWebChannel> + \endcode + + To link against the module, add this line to your \l qmake \c .pro file: + + \code + QT += webchannel + \endcode +*/ + +/*! + \qmlmodule QtWebChannel 1.0 + \title Qt WebChannel QML Types + \since 5.4 + \brief List of QML types that provide WebChannel functionality. + + The QML types are accessed by using: + \badcode + import QtWebChannel 1.0 + \endcode +*/ |