diff options
author | Topi Reinio <topi.reinio@digia.com> | 2015-09-28 14:01:08 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@digia.com> | 2015-09-30 14:04:46 +0000 |
commit | 45cf8b973b9160af5b1ef01194cdc820283c0d56 (patch) | |
tree | bbcd8a02a0c0b4db671821d780713819b8f6c51e /src | |
parent | 8ad7b8c20cd203cefd49d1d08f4614dd01ccec87 (diff) |
Doc: Use a single documentation project for Controls + Calendar
QML types from QtQuick.Calendar module use their own import statement,
but in the documentation they can listed as part of Controls.
Edit the landing page and module pages to list (or link to) the
usage and QML type info for both modules.
Change-Id: I4e711a8d7ae84d888736eea59f5e25dadc1d35d5
Reviewed-by: J-P Nurmi <jpnurmi@theqtcompany.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/imports/calendar/calendar.pro | 2 | ||||
-rw-r--r-- | src/imports/calendar/doc/qtquickcalendar2.qdocconf | 50 | ||||
-rw-r--r-- | src/imports/controls/doc/images/qtquickcalendar2-calendarview-layout.png (renamed from src/imports/calendar/doc/images/qtquickcalendar2-calendarview-layout.png) | bin | 22876 -> 22876 bytes | |||
-rw-r--r-- | src/imports/controls/doc/images/qtquickcalendar2-calendarview.png (renamed from src/imports/calendar/doc/images/qtquickcalendar2-calendarview.png) | bin | 13614 -> 13614 bytes | |||
-rw-r--r-- | src/imports/controls/doc/images/qtquickcalendar2-dayofweekrow-layout.png (renamed from src/imports/calendar/doc/images/qtquickcalendar2-dayofweekrow-layout.png) | bin | 19480 -> 19480 bytes | |||
-rw-r--r-- | src/imports/controls/doc/images/qtquickcalendar2-dayofweekrow.png (renamed from src/imports/calendar/doc/images/qtquickcalendar2-dayofweekrow.png) | bin | 5599 -> 5599 bytes | |||
-rw-r--r-- | src/imports/controls/doc/images/qtquickcalendar2-weeknumbercolumn-layout.png (renamed from src/imports/calendar/doc/images/qtquickcalendar2-weeknumbercolumn-layout.png) | bin | 17256 -> 17256 bytes | |||
-rw-r--r-- | src/imports/controls/doc/images/qtquickcalendar2-weeknumbercolumn.png (renamed from src/imports/calendar/doc/images/qtquickcalendar2-weeknumbercolumn.png) | bin | 3397 -> 3397 bytes | |||
-rw-r--r-- | src/imports/controls/doc/qtquickcontrols2.qdocconf | 19 | ||||
-rw-r--r-- | src/imports/controls/doc/src/calendar/qtquickcalendar2-index.qdoc (renamed from src/imports/calendar/doc/src/qtquickcalendar2-index.qdoc) | 3 | ||||
-rw-r--r-- | src/imports/controls/doc/src/calendar/qtquickcalendar2.qdoc (renamed from src/imports/calendar/doc/src/qtquickcalendar2.qdoc) | 14 | ||||
-rw-r--r-- | src/imports/controls/doc/src/qtquickcontrols2-index.qdoc | 12 | ||||
-rw-r--r-- | src/imports/controls/doc/src/qtquickcontrols2.qdoc | 24 |
13 files changed, 52 insertions, 72 deletions
diff --git a/src/imports/calendar/calendar.pro b/src/imports/calendar/calendar.pro index 78fe53d3..e8e29b8f 100644 --- a/src/imports/calendar/calendar.pro +++ b/src/imports/calendar/calendar.pro @@ -5,8 +5,6 @@ IMPORT_VERSION = 2.0 QT += qml quick QT += core-private gui-private qml-private quick-private quicktemplates-private -QMAKE_DOCS = $$PWD/doc/qtquickcalendar2.qdocconf - DEFINES += QT_NO_CAST_TO_ASCII QT_NO_CAST_FROM_ASCII INCLUDEPATH += $$PWD diff --git a/src/imports/calendar/doc/qtquickcalendar2.qdocconf b/src/imports/calendar/doc/qtquickcalendar2.qdocconf deleted file mode 100644 index a3313e86..00000000 --- a/src/imports/calendar/doc/qtquickcalendar2.qdocconf +++ /dev/null @@ -1,50 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) - -project = QtQuickCalendar2 -description = Qt Quick Calendar 2 Reference Documentation -version = $QT_VERSION - -qhp.projects = QtQuickCalendar2 - -qhp.QtQuickCalendar2.file = QtQuickCalendar2.qhp -qhp.QtQuickCalendar2.namespace = org.qt-project.QtQuickCalendar2.$QT_VERSION_TAG -qhp.QtQuickCalendar2.virtualFolder = QtQuickCalendar2 -qhp.QtQuickCalendar2.indexTitle = Qt Quick Calendar 2 -qhp.QtQuickCalendar2.indexRoot = - -qhp.QtQuickCalendar2.filterAttributes = QtQuickCalendar2 $QT_VERSION qtrefdoc -qhp.QtQuickCalendar2.customFilters.Qt.name = QtQuickCalendar2 $QT_VERSION -qhp.QtQuickCalendar2.customFilters.Qt.filterAttributes = QtQuickCalendar2 $QT_VERSION - -qhp.QtQuickCalendar2.subprojects = QtQuickCalendar2qmltypes - -qhp.QtQuickCalendar2.subprojects.QtQuickCalendar2qmltypes.title = Calendar 2 QML Types -qhp.QtQuickCalendar2.subprojects.QtQuickCalendar2qmltypes.indexTitle = Qt Quick Calendar 2 QML Types -qhp.QtQuickCalendar2.subprojects.QtQuickCalendar2qmltypes.selectors = qmlclass -qhp.QtQuickCalendar2.subprojects.QtQuickCalendar2qmltypes.sortPages = true - -depends = qtcore qtgui qtdoc qtqml qtquick qtquicklayouts qtquickcontrols2 - -# Specify the install path under QT_INSTALL_EXAMPLES -# Examples will be installed under quick/calendar - 'calendar' subdirectory -# is given as part of \example commands -exampledirs += ../../../../examples/quick/calendar \ - ../ \ - snippets \ - ../../../../tests/auto/snippets/data -examplesinstallpath = quick/calendar - -headerdirs += ../ -sourcedirs += ../ - -imagedirs += images - -navigation.landingpage = "Qt Quick Calendar 2" -navigation.qmltypespage = "Qt Quick Calendar 2 QML Types" - -tagfile = QtQuickCalendar2.tags - -# Specify a QML module suffix, applied to html filenames, to avoid -# clashes with Qt Quick Controls 1 documentation. -outputsuffixes = QML -outputsuffixes.QML = 2 diff --git a/src/imports/calendar/doc/images/qtquickcalendar2-calendarview-layout.png b/src/imports/controls/doc/images/qtquickcalendar2-calendarview-layout.png Binary files differindex c5182644..c5182644 100644 --- a/src/imports/calendar/doc/images/qtquickcalendar2-calendarview-layout.png +++ b/src/imports/controls/doc/images/qtquickcalendar2-calendarview-layout.png diff --git a/src/imports/calendar/doc/images/qtquickcalendar2-calendarview.png b/src/imports/controls/doc/images/qtquickcalendar2-calendarview.png Binary files differindex 79d0ebc0..79d0ebc0 100644 --- a/src/imports/calendar/doc/images/qtquickcalendar2-calendarview.png +++ b/src/imports/controls/doc/images/qtquickcalendar2-calendarview.png diff --git a/src/imports/calendar/doc/images/qtquickcalendar2-dayofweekrow-layout.png b/src/imports/controls/doc/images/qtquickcalendar2-dayofweekrow-layout.png Binary files differindex fd4dc065..fd4dc065 100644 --- a/src/imports/calendar/doc/images/qtquickcalendar2-dayofweekrow-layout.png +++ b/src/imports/controls/doc/images/qtquickcalendar2-dayofweekrow-layout.png diff --git a/src/imports/calendar/doc/images/qtquickcalendar2-dayofweekrow.png b/src/imports/controls/doc/images/qtquickcalendar2-dayofweekrow.png Binary files differindex 2d650a88..2d650a88 100644 --- a/src/imports/calendar/doc/images/qtquickcalendar2-dayofweekrow.png +++ b/src/imports/controls/doc/images/qtquickcalendar2-dayofweekrow.png diff --git a/src/imports/calendar/doc/images/qtquickcalendar2-weeknumbercolumn-layout.png b/src/imports/controls/doc/images/qtquickcalendar2-weeknumbercolumn-layout.png Binary files differindex f11be89d..f11be89d 100644 --- a/src/imports/calendar/doc/images/qtquickcalendar2-weeknumbercolumn-layout.png +++ b/src/imports/controls/doc/images/qtquickcalendar2-weeknumbercolumn-layout.png diff --git a/src/imports/calendar/doc/images/qtquickcalendar2-weeknumbercolumn.png b/src/imports/controls/doc/images/qtquickcalendar2-weeknumbercolumn.png Binary files differindex 07ecc9f4..07ecc9f4 100644 --- a/src/imports/calendar/doc/images/qtquickcalendar2-weeknumbercolumn.png +++ b/src/imports/controls/doc/images/qtquickcalendar2-weeknumbercolumn.png diff --git a/src/imports/controls/doc/qtquickcontrols2.qdocconf b/src/imports/controls/doc/qtquickcontrols2.qdocconf index 3da4b48c..db9d8e1b 100644 --- a/src/imports/controls/doc/qtquickcontrols2.qdocconf +++ b/src/imports/controls/doc/qtquickcontrols2.qdocconf @@ -23,21 +23,26 @@ qhp.QtQuickControls2.subprojects.qtquickcontrols2qmltypes.indexTitle = Qt Quick qhp.QtQuickControls2.subprojects.qtquickcontrols2qmltypes.selectors = qmlclass qhp.QtQuickControls2.subprojects.qtquickcontrols2qmltypes.sortPages = true -depends = qtcore qtgui qtdoc qtqml qtquick qtquicklayouts qtquickdialogs qtquickcontrols qtquickcalendar2 +depends = qtcore qtgui qtdoc qtqml qtquick qtquicklayouts qtquickdialogs qtquickcontrols # Specify the install path under QT_INSTALL_EXAMPLES -# Examples will be installed under quick/controls - 'controls' subdirectory -# is given as part of \example commands -exampledirs += ../../../../examples/quick/controls \ +# Note: paths passed to \example command must contain the parent directory, e.g. +# \example controls/tabs +exampledirs += ../../../../examples/quick \ ../ \ ../../../templates \ + ../../calendar \ ../../../../tests/auto/controls/data \ ../../../../tests/auto/snippets/data \ snippets -examplesinstallpath = quick/controls -headerdirs += ../../../templates -sourcedirs += ../../../templates +examplesinstallpath = quick + +headerdirs += ../../../templates \ + ../../calendar \ + +sourcedirs += ../../../templates \ + ../../calendar imagedirs += images diff --git a/src/imports/calendar/doc/src/qtquickcalendar2-index.qdoc b/src/imports/controls/doc/src/calendar/qtquickcalendar2-index.qdoc index a483ac95..47f5e6ad 100644 --- a/src/imports/calendar/doc/src/qtquickcalendar2-index.qdoc +++ b/src/imports/controls/doc/src/calendar/qtquickcalendar2-index.qdoc @@ -39,12 +39,11 @@ \generatelist {qmltypesbymodule QtQuick.Calendar} - \section1 Related information + \section1 Related Information \list \li \l{Qt Quick} \li \l{Qt Quick Layouts} \li \l{Qt Quick Controls 2} - \li \l{Qt Quick Calendar 2 QML Types}{Qt Quick Calendar 2 QML Types} \endlist */ diff --git a/src/imports/calendar/doc/src/qtquickcalendar2.qdoc b/src/imports/controls/doc/src/calendar/qtquickcalendar2.qdoc index 21bf780b..7dcb5f1e 100644 --- a/src/imports/calendar/doc/src/qtquickcalendar2.qdoc +++ b/src/imports/controls/doc/src/calendar/qtquickcalendar2.qdoc @@ -36,11 +36,21 @@ \l{Qt Quick Controls 2}. The QML types can be imported into your application using the - following import statement in your .qml file. + following import statement in your .qml file: - \code + \badcode import QtQuick.Calendar 2.0 \endcode \section1 QML Types + + \generatelist {qmltypesbymodule QtQuick.Calendar} + + \section1 Related Information + + \list + \li \l {Qt Quick Controls 2 QML Types} + \endlist + + \noautolist */ diff --git a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc index d6c5ac6a..8e526926 100644 --- a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc +++ b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc @@ -29,16 +29,19 @@ \page qtquickcontrols2-index.html \title Qt Quick Controls 2 - \brief The Qt Quick Controls 2 module provides a set of UI controls for Qt - Quick. + \brief Provides a set of UI controls for Qt Quick. - The Qt Quick Controls 2 module provides a set of controls that can be used + Qt Quick Controls 2 provides a set of controls that can be used to build complete interfaces in Qt Quick. \section1 QML Types + \section2 QtQuick.Controls Module \generatelist {qmltypesbymodule QtQuick.Controls} + \section2 QtQuick.Calendar Module + \generatelist {qmltypesbymodule QtQuick.Calendar} + \section1 Differences between Qt Quick Controls Qt Quick Controls were originally developed to support desktop platforms, @@ -328,11 +331,12 @@ TODO - \section1 Related information + \section1 Related Information \list \li \l{Qt Quick} \li \l{Qt Quick Layouts} + \li \l{Qt Quick Calendar 2} \li \l{Qt Quick Controls 2 QML Types}{Qt Quick Controls 2 QML Types} \endlist */ diff --git a/src/imports/controls/doc/src/qtquickcontrols2.qdoc b/src/imports/controls/doc/src/qtquickcontrols2.qdoc index 87bc0c5f..9157db0f 100644 --- a/src/imports/controls/doc/src/qtquickcontrols2.qdoc +++ b/src/imports/controls/doc/src/qtquickcontrols2.qdoc @@ -31,16 +31,30 @@ \ingroup qmlmodules \brief Provides QML types for user interfaces (Qt Quick Controls 2). - The \l{Qt Quick Controls 2} module provides QML types for creating user - interfaces. These QML types work in conjunction with \l{Qt Quick} and + \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}. - The QML types can be imported into your application using the - following import statement in your .qml file. + Qt Quick Controls 2 QML types can be imported into your application + using the following import statement in your .qml file: - \code + \badcode import QtQuick.Controls 2.0 \endcode + The CalendarView and related QML types can be imported using the + following statement: + + \badcode + import QtQuick.Calendar 2.0 + \endcode + \section1 QML Types + + \section2 QtQuick.Controls Module + \generatelist {qmltypesbymodule QtQuick.Controls} + + \section2 QtQuick.Calendar Module + \generatelist {qmltypesbymodule QtQuick.Calendar} + \noautolist */ |