diff options
author | Nico Vertriest <nico.vertriest@theqtcompany.com> | 2016-04-06 16:19:13 +0200 |
---|---|---|
committer | J-P Nurmi <jpnurmi@qt.io> | 2016-04-17 10:58:04 +0000 |
commit | fa02f4569d719a214b36303f323c3a4f49310c50 (patch) | |
tree | ff658cf2b30ccb6afb86b4b153a37b6dabe3ed4a | |
parent | e0b01d06836e23f576d104b573eb87313119f16f (diff) |
Doc: add section for C++ classes in overview page
Change-Id: I69a112f05b90e1296ad897da0e3d9b04b3e4af33
Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
-rw-r--r-- | src/imports/controls/doc/qtquickcontrols2.qdocconf | 4 | ||||
-rw-r--r-- | src/imports/controls/doc/src/qtquickcontrols2-index.qdoc | 29 | ||||
-rw-r--r-- | src/imports/controls/doc/src/qtquickcontrols2.qdoc | 24 | ||||
-rw-r--r-- | src/quickcontrols2/qquickstyle.cpp | 2 |
4 files changed, 56 insertions, 3 deletions
diff --git a/src/imports/controls/doc/qtquickcontrols2.qdocconf b/src/imports/controls/doc/qtquickcontrols2.qdocconf index 96176fcc..bb5845a6 100644 --- a/src/imports/controls/doc/qtquickcontrols2.qdocconf +++ b/src/imports/controls/doc/qtquickcontrols2.qdocconf @@ -39,11 +39,11 @@ examplesinstallpath = qtquickcontrols2/controls headerdirs += ../../../quicktemplates2 \ ../../calendar \ - ../../../controls + ../../../quickcontrols2 sourcedirs += ../../../quicktemplates2 \ ../../calendar \ - ../../../controls \ + ../../../quickcontrols2 \ src imagedirs += images diff --git a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc index a7bad347..c9aaff56 100644 --- a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc +++ b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc @@ -34,6 +34,34 @@ Qt Quick Controls 2 provides a set of controls that can be used to build complete interfaces in Qt Quick. + \section1 Prerequisites + + The QML types can be imported into your application using the following + import statement in your \c {.qml} file: + + \code + import QtQuick.Controls 2.0 + \endcode + + The C++ types can be included into your application using the following + include statement: + + \code + #include <QtQuickControls2> + \endcode + + \note If you are using a few classes from this module, we recommend including + those specific classes only instead of the module. + + To link against the corresponding C++ libraries, add the following to your + qmake project file: + + \code + QT += quickcontrols2 + \endcode + + For more details, see \l {Getting Started with Qt Quick Controls 2}. + \section1 QML Types \section2 Qt.labs.controls Module @@ -60,6 +88,7 @@ \li \l{Qt Labs Calendar} \li \l{Qt Quick Templates 2} \li \l{Qt Quick Controls 2 QML Types} + \li \l{Qt Quick Controls 2 C++ Classes} \li \l{Qt Quick Controls 2 Examples} \endlist */ diff --git a/src/imports/controls/doc/src/qtquickcontrols2.qdoc b/src/imports/controls/doc/src/qtquickcontrols2.qdoc index 8bcd12cf..36785e23 100644 --- a/src/imports/controls/doc/src/qtquickcontrols2.qdoc +++ b/src/imports/controls/doc/src/qtquickcontrols2.qdoc @@ -60,3 +60,27 @@ \generatelist {qmltypesbymodule Qt.labs.calendar} \noautolist */ + +/*! + \module QtQuickControls2 + \title Qt Quick Controls 2 C++ Classes + \ingroup modules + \brief Provides classes for setting up the controls from C++. + + The C++ types can be included into your application using the following + include statement: + + \code + #include <QtQuickControls2> + \endcode + + \note If you are using a few classes from this module, we recommend including + those specific classes only instead of the module. + + To link against the corresponding C++ libraries, add the following to your + qmake project file: + + \code + QT += quickcontrols2 + \endcode +*/ diff --git a/src/quickcontrols2/qquickstyle.cpp b/src/quickcontrols2/qquickstyle.cpp index bf6d9959..0bf53b4e 100644 --- a/src/quickcontrols2/qquickstyle.cpp +++ b/src/quickcontrols2/qquickstyle.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE /*! \class QQuickStyle \brief The QQQuickStyle class allows configuring the application style. - \inmodule QtLabsControls + \inmodule QtQuickControls2 QQuickStyle provides API for querying and configuring the application \l {Styling Qt Quick Controls 2}{styles} of Qt Quick Controls 2. |