From e5797a3ac6a26fac33af5016174e287c335b22dd Mon Sep 17 00:00:00 2001 From: J-P Nurmi Date: Mon, 18 Apr 2016 13:19:43 +0200 Subject: Doc: setup subprojects for QML Types, C++ Classes and Examples Change-Id: If85c87f4b3948a7e25b9281329d3886f664f6c13 Reviewed-by: Venugopal Shivashankar --- src/imports/controls/doc/qtquickcontrols2.qdocconf | 19 +++-- .../doc/src/qtquickcontrols2-cppclasses.qdoc | 50 +++++++++++++ .../doc/src/qtquickcontrols2-qmltypes.qdoc | 62 ++++++++++++++++ src/imports/controls/doc/src/qtquickcontrols2.qdoc | 86 ---------------------- 4 files changed, 125 insertions(+), 92 deletions(-) create mode 100644 src/imports/controls/doc/src/qtquickcontrols2-cppclasses.qdoc create mode 100644 src/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc delete mode 100644 src/imports/controls/doc/src/qtquickcontrols2.qdoc diff --git a/src/imports/controls/doc/qtquickcontrols2.qdocconf b/src/imports/controls/doc/qtquickcontrols2.qdocconf index 8260485b..0a19bdf5 100644 --- a/src/imports/controls/doc/qtquickcontrols2.qdocconf +++ b/src/imports/controls/doc/qtquickcontrols2.qdocconf @@ -16,12 +16,18 @@ qhp.QtQuickControls2.filterAttributes = qtquickcontrols2 $QT_VE qhp.QtQuickControls2.customFilters.Qt.name = QtQuickControls2 $QT_VERSION qhp.QtQuickControls2.customFilters.Qt.filterAttributes = qtquickcontrols2 $QT_VERSION -qhp.QtQuickControls2.subprojects = qtquickcontrols2qmltypes - -qhp.QtQuickControls2.subprojects.qtquickcontrols2qmltypes.title = Controls 2 QML Types -qhp.QtQuickControls2.subprojects.qtquickcontrols2qmltypes.indexTitle = Qt Quick Controls 2 QML Types -qhp.QtQuickControls2.subprojects.qtquickcontrols2qmltypes.selectors = qmlclass -qhp.QtQuickControls2.subprojects.qtquickcontrols2qmltypes.sortPages = true +qhp.QtQuickControls2.subprojects = qmltypes classes examples +qhp.QtQuickControls2.subprojects.qmltypes.title = QML Types +qhp.QtQuickControls2.subprojects.qmltypes.indexTitle = Qt Quick Controls 2 QML Types +qhp.QtQuickControls2.subprojects.qmltypes.selectors = qmlclass +qhp.QtQuickControls2.subprojects.qmltypes.sortPages = true +qhp.QtQuickControls2.subprojects.classes.title = C++ Classes +qhp.QtQuickControls2.subprojects.classes.indexTitle = Qt Quick Controls 2 C++ Classes +qhp.QtQuickControls2.subprojects.classes.selectors = class fake:headerfile +qhp.QtQuickControls2.subprojects.classes.sortPages = true +qhp.QtQuickControls2.subprojects.examples.title = Examples +qhp.QtQuickControls2.subprojects.examples.indexTitle = Qt Quick Controls 2 Examples +qhp.QtQuickControls2.subprojects.examples.selectors = fake:example depends = qtcore qtgui qtdoc qtqml qtquick qtquickdialogs qtquickcontrols qmake qtsql qtwidgets @@ -50,6 +56,7 @@ imagedirs += images navigation.landingpage = "Qt Quick Controls 2" navigation.qmltypespage = "Qt Quick Controls 2 QML Types" +navigation.cppclassespage = "Qt Quick Controls 2 C++ Classes" tagfile = qtquickcontrols2.tags diff --git a/src/imports/controls/doc/src/qtquickcontrols2-cppclasses.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-cppclasses.qdoc new file mode 100644 index 00000000..5c2b9486 --- /dev/null +++ b/src/imports/controls/doc/src/qtquickcontrols2-cppclasses.qdoc @@ -0,0 +1,50 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** 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 The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/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 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 + \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/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc new file mode 100644 index 00000000..fe509a6c --- /dev/null +++ b/src/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc @@ -0,0 +1,62 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** 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 The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/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$ +** +****************************************************************************/ + +/*! + \qmlmodule Qt.labs.controls 1.0 + \title Qt Quick Controls 2 QML Types + \ingroup qmlmodules + \brief Provides QML types for user interfaces (Qt Quick Controls 2). + + \l{Qt Quick Controls 2} provides QML types for creating user interfaces. + These QML types work in conjunction with \l{Qt Quick} and + \l{Qt Quick Layouts}. + + Qt Quick Controls 2 QML types can be imported into your application + using the following import statement in your .qml file: + + \badcode + import Qt.labs.controls 1.0 + \endcode + + The calendar related QML types can be imported using the + following statement: + + \badcode + import Qt.labs.calendar 1.0 + \endcode + + \labs + + \section1 QML Types + + \section2 Qt.labs.controls Module + \generatelist {qmltypesbymodule Qt.labs.controls} + \noautolist + + For more information on the Qt Quick Controls 2 module, see the + \l {Qt Quick Controls 2} module documentation. +*/ diff --git a/src/imports/controls/doc/src/qtquickcontrols2.qdoc b/src/imports/controls/doc/src/qtquickcontrols2.qdoc deleted file mode 100644 index 36785e23..00000000 --- a/src/imports/controls/doc/src/qtquickcontrols2.qdoc +++ /dev/null @@ -1,86 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2015 The Qt Company Ltd. -** Contact: http://www.qt.io/licensing/ -** -** 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 The Qt Company. For licensing terms -** and conditions see http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/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$ -** -****************************************************************************/ - -/*! - \qmlmodule Qt.labs.controls 1.0 - \title Qt Quick Controls 2 QML Types - \ingroup qmlmodules - \brief Provides QML types for user interfaces (Qt Quick Controls 2). - - \l{Qt Quick Controls 2} provides QML types for creating user interfaces. - These QML types work in conjunction with \l{Qt Quick} and - \l{Qt Quick Layouts}. - - Qt Quick Controls 2 QML types can be imported into your application - using the following import statement in your .qml file: - - \badcode - import Qt.labs.controls 1.0 - \endcode - - The calendar related QML types can be imported using the - following statement: - - \badcode - import Qt.labs.calendar 1.0 - \endcode - - \labs - - \section1 QML Types - - \section2 Qt.labs.controls Module - \generatelist {qmltypesbymodule Qt.labs.controls} - - \section2 Qt.labs.calendar Module - \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 - \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 -*/ -- cgit v1.2.3