diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2014-03-21 14:15:19 +0100 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-03-28 10:32:38 +0100 |
| commit | 902e73e02d34b3739c74e758234ddc78893b1711 (patch) | |
| tree | 0003b72ea5ad5356ca308cb63a7ab5f2d2647566 /src/quickwidgets | |
| parent | 73b6dc26e8a128f93e53059f86f731d4b383fd60 (diff) | |
Doc: Add a module page for Qt Quick Widgets
Although the documentation is part of Qt Quick, a separate
module page with a \qtvariable command is still needed to
have correct information about which module to link against.
Task-number: QTBUG-37272
Change-Id: Ie00e9418be4feec299cb36c526ca366504c89008
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
Diffstat (limited to 'src/quickwidgets')
| -rw-r--r-- | src/quickwidgets/qquickwidget.cpp | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/src/quickwidgets/qquickwidget.cpp b/src/quickwidgets/qquickwidget.cpp index f1ad103d8c..ddb2124542 100644 --- a/src/quickwidgets/qquickwidget.cpp +++ b/src/quickwidgets/qquickwidget.cpp @@ -197,11 +197,28 @@ void QQuickWidgetPrivate::renderSceneGraph() } /*! + \module QtQuickWidgets + \title Qt Quick Widgets C++ Classes + \ingroup modules + \brief The C++ API provided by the Qt Quick Widgets module + \qtvariable quickwidgets + + To link against the module, add this line to your \l qmake + \c .pro file: + + \code + QT += quickwidgets + \endcode + + For more information, see the QQuickWidget class documentation. +*/ + +/*! \class QQuickWidget \since 5.3 \brief The QQuickWidget class provides a widget for displaying a Qt Quick user interface. - \inmodule QtQuick + \inmodule QtQuickWidgets This is a convenience wrapper for QQuickWindow which will automatically load and display a QML scene when given the URL of the main source file. Alternatively, you can instantiate your own |