From 902e73e02d34b3739c74e758234ddc78893b1711 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Fri, 21 Mar 2014 14:15:19 +0100 Subject: 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 Reviewed-by: Jerome Pasion Reviewed-by: Lars Knoll --- src/quickwidgets/qquickwidget.cpp | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) (limited to 'src/quickwidgets') 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 @@ -196,12 +196,29 @@ void QQuickWidgetPrivate::renderSceneGraph() q->update(); } +/*! + \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 -- cgit v1.2.3