diff options
author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2018-10-26 14:16:56 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2018-10-26 20:45:59 +0000 |
commit | 5db6659d65062353cfa6425f7790ea34f1b4a3f4 (patch) | |
tree | cf4bd839e8e9194ea54c135c2cb0f1297f474258 /src/controls/doc | |
parent | c345d1ddf66fa73660a299826b9e3a3328519bed (diff) |
Doc: Document Qt Quick Controls explicitly as 'version 1'
This is to explicitly identify Qt Quick Controls as Controls 1,
so that Controls 2 can be referred generally as Qt Quick Controls.
Task-number: QTBUG-70333
Change-Id: I798c0354ad47ab96978575829322a254876529fb
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/controls/doc')
-rw-r--r-- | src/controls/doc/qtquickcontrols.qdocconf | 77 | ||||
-rw-r--r-- | src/controls/doc/qtquickcontrols1.qdocconf | 80 | ||||
-rw-r--r-- | src/controls/doc/src/qtquickcontrols-examples.qdoc | 34 | ||||
-rw-r--r-- | src/controls/doc/src/qtquickcontrols-index.qdoc | 16 | ||||
-rw-r--r-- | src/controls/doc/src/qtquickcontrols-overview.qdoc | 10 | ||||
-rw-r--r-- | src/controls/doc/src/qtquickcontrols-platformnotes.qdoc | 6 | ||||
-rw-r--r-- | src/controls/doc/src/qtquickcontrols.qdoc | 6 | ||||
-rw-r--r-- | src/controls/doc/src/qtquickcontrolsstyles-index.qdoc | 12 |
8 files changed, 122 insertions, 119 deletions
diff --git a/src/controls/doc/qtquickcontrols.qdocconf b/src/controls/doc/qtquickcontrols.qdocconf deleted file mode 100644 index e81777e05..000000000 --- a/src/controls/doc/qtquickcontrols.qdocconf +++ /dev/null @@ -1,77 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) - -project = QtQuickControls -description = Qt Quick Controls Reference Documentation -version = $QT_VERSION - -qhp.projects = QtQuickControls - -qhp.QtQuickControls.file = qtquickcontrols.qhp -qhp.QtQuickControls.namespace = org.qt-project.qtquickcontrols.$QT_VERSION_TAG -qhp.QtQuickControls.virtualFolder = qtquickcontrols -qhp.QtQuickControls.indexTitle = Qt Quick Controls -qhp.QtQuickControls.indexRoot = -#qhp.QtQuickControls.extraFiles = style/qtquickcontrols.css - -qhp.QtQuickControls.filterAttributes = qtquickcontrols $QT_VERSION qtrefdoc -qhp.QtQuickControls.customFilters.Qt.name = QtQuickControls $QT_VERSION -qhp.QtQuickControls.customFilters.Qt.filterAttributes = qtquickcontrols $QT_VERSION - -qhp.QtQuickControls.subprojects = qqcqmltypes qqcstylesqmltypes qqcexamples - -qhp.QtQuickControls.subprojects.qqcqmltypes.title = Controls QML Types -qhp.QtQuickControls.subprojects.qqcqmltypes.indexTitle = Qt Quick Controls QML Types -qhp.QtQuickControls.subprojects.qqcqmltypes.selectors = group:controls -qhp.QtQuickControls.subprojects.qqcqmltypes.sortPages = true - -qhp.QtQuickControls.subprojects.qqcstylesqmltypes.title = Controls Styles QML Types -qhp.QtQuickControls.subprojects.qqcstylesqmltypes.indexTitle = Qt Quick Controls Styles QML Types -qhp.QtQuickControls.subprojects.qqcstylesqmltypes.selectors = group:controlsstyling -qhp.QtQuickControls.subprojects.qqcstylesqmltypes.sortPages = true - -qhp.QtQuickControls.subprojects.qqcexamples.title = Examples and Tutorials -qhp.QtQuickControls.subprojects.qqcexamples.indexTitle = Qt Quick Controls Examples -qhp.QtQuickControls.subprojects.qqcexamples.selectors = doc:example group:stylingtutorials -qhp.QtQuickControls.subprojects.qqcexamples.sortpages = true - -depends = qtcore qtdoc qtgui qtwidgets qtqml qtquick qtquicklayouts qtquickdialogs qtquickextras qtgraphicaleffects - -# 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/quickcontrols/controls \ - snippets -examplesinstallpath = quickcontrols/controls - -headerdirs += .. - -sourcedirs += .. - -sources += ../Private/AbstractCheckable.qml \ - ../Private/BasicButton.qml \ - ../Private/FocusFrame.qml \ - ../Private/ModalPopupBehavior.qml \ - ../Private/ScrollBar.qml \ - ../Private/TabBar.qml \ - ../Private/Control.qml \ - ../Private/qquickstyleitem.cpp \ - ../Private/Style.qml \ - ../Private/qquickabstractstyle_p.h \ - ../Private/qquickabstractstyle.cpp - -excludefiles += ../TableView.qml \ - ../TreeView.qml \ - ../Styles/Base/TableViewStyle.qml \ - ../Styles/Base/TreeViewStyle.qml - -excludedirs += ../Styles/Desktop \ - ../Styles/Android \ - ../Styles/iOS - -imagedirs += images \ - ../../extras/doc/images - -navigation.landingpage = "Qt Quick Controls" -navigation.qmltypespage = "Qt Quick Controls QML Types" - -tagfile = qtquickcontrols.tags diff --git a/src/controls/doc/qtquickcontrols1.qdocconf b/src/controls/doc/qtquickcontrols1.qdocconf new file mode 100644 index 000000000..29a01ae2b --- /dev/null +++ b/src/controls/doc/qtquickcontrols1.qdocconf @@ -0,0 +1,80 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) + +project = QtQuickControls1 +description = Qt Quick Controls 1 Reference Documentation +version = $QT_VERSION + +qhp.projects = QtQuickControls1 + +qhp.QtQuickControls1.file = qtquickcontrols1.qhp +qhp.QtQuickControls1.namespace = org.qt-project.qtquickcontrols1.$QT_VERSION_TAG +qhp.QtQuickControls1.virtualFolder = qtquickcontrols1 +qhp.QtQuickControls1.indexTitle = Qt Quick Controls 1 +qhp.QtQuickControls1.indexRoot = +#qhp.QtQuickControls1.extraFiles = style/qtquickcontrols1.css + +qhp.QtQuickControls1.filterAttributes = qtquickcontrols1 $QT_VERSION qtrefdoc +qhp.QtQuickControls1.customFilters.Qt.name = QtQuickControls1 $QT_VERSION +qhp.QtQuickControls1.customFilters.Qt.filterAttributes = qtquickcontrols1 $QT_VERSION + +qhp.QtQuickControls1.subprojects = qqcqmltypes qqcstylesqmltypes qqcexamples + +qhp.QtQuickControls1.subprojects.qqcqmltypes.title = Controls 1 QML Types +qhp.QtQuickControls1.subprojects.qqcqmltypes.indexTitle = Qt Quick Controls 1 QML Types +qhp.QtQuickControls1.subprojects.qqcqmltypes.selectors = group:controls1 +qhp.QtQuickControls1.subprojects.qqcqmltypes.sortPages = true + +qhp.QtQuickControls1.subprojects.qqcstylesqmltypes.title = Controls 1 Styles QML Types +qhp.QtQuickControls1.subprojects.qqcstylesqmltypes.indexTitle = Qt Quick Controls 1 Styles QML Types +qhp.QtQuickControls1.subprojects.qqcstylesqmltypes.selectors = group:controlsstyling +qhp.QtQuickControls1.subprojects.qqcstylesqmltypes.sortPages = true + +qhp.QtQuickControls1.subprojects.qqcexamples.title = Examples and Tutorials +qhp.QtQuickControls1.subprojects.qqcexamples.indexTitle = Qt Quick Controls 1 Examples +qhp.QtQuickControls1.subprojects.qqcexamples.selectors = doc:example group:stylingtutorials +qhp.QtQuickControls1.subprojects.qqcexamples.sortpages = true + +depends = qtcore qtdoc qtgui qtwidgets qtqml qtquick qtquickdialogs qtquickextras qtgraphicaleffects + +# 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/quickcontrols/controls \ + snippets +examplesinstallpath = quickcontrols/controls + +# This module has no documented C++ types, clear the module header +moduleheader = + +headerdirs += .. + +sourcedirs += .. + +sources += ../Private/AbstractCheckable.qml \ + ../Private/BasicButton.qml \ + ../Private/FocusFrame.qml \ + ../Private/ModalPopupBehavior.qml \ + ../Private/ScrollBar.qml \ + ../Private/TabBar.qml \ + ../Private/Control.qml \ + ../Private/qquickstyleitem.cpp \ + ../Private/Style.qml \ + ../Private/qquickabstractstyle_p.h \ + ../Private/qquickabstractstyle.cpp + +excludefiles += ../TableView.qml \ + ../TreeView.qml \ + ../Styles/Base/TableViewStyle.qml \ + ../Styles/Base/TreeViewStyle.qml + +excludedirs += ../Styles/Desktop \ + ../Styles/Android \ + ../Styles/iOS + +imagedirs += images \ + ../../extras/doc/images + +navigation.landingpage = "Qt Quick Controls 1" +navigation.qmltypespage = "Qt Quick Controls 1 QML Types" + +tagfile = qtquickcontrols1.tags diff --git a/src/controls/doc/src/qtquickcontrols-examples.qdoc b/src/controls/doc/src/qtquickcontrols-examples.qdoc index fff6103e3..b6f2dca09 100644 --- a/src/controls/doc/src/qtquickcontrols-examples.qdoc +++ b/src/controls/doc/src/qtquickcontrols-examples.qdoc @@ -28,16 +28,16 @@ /*! \group qtquickcontrols_examples \ingroup all-examples - \title Qt Quick Controls Examples - \brief A Collection of examples for \l{Qt Quick Controls}, written in QML. + \title Qt Quick Controls 1 Examples + \brief A Collection of examples for \l{Qt Quick Controls 1}, written in QML. These examples show how to create user interfaces using - \l{Qt Quick Controls}. + \l{Qt Quick Controls 1}. */ /*! \example gallery - \title Qt Quick Controls - Gallery + \title Qt Quick Controls 1 - Gallery \ingroup qtquickcontrols_examples \brief A collection of components for a classic desktop-style UI. @@ -58,14 +58,14 @@ \endraw This example project demonstrates the various UI components provided by - \l{Qt Quick Controls}. + \l{Qt Quick Controls 1}. \include examples-run.qdocinc */ /*! \example uiforms - \title Qt Quick Controls - UI Forms + \title Qt Quick Controls 1 - UI Forms \ingroup qtquickcontrols_examples \brief Demonstrates how to separate the application logic from the UI. @@ -126,13 +126,13 @@ /*! \example tableview - \title Qt Quick Controls - Table View Example + \title Qt Quick Controls 1 - Table View Example \ingroup qtquickcontrols_examples \brief An example for the TableView control. \image qtquickcontrols-example-tableview.png This example project demonstrates the usage of \l {TableView} from - \l{Qt Quick Controls} - a control to display one or more columns of + \l{Qt Quick Controls 1} - a control to display one or more columns of information from a data list model. The example includes a model that supports sorting and filtering. @@ -165,7 +165,7 @@ /*! \example texteditor - \title Qt Quick Controls - Text Editor Example + \title Qt Quick Controls 1 - Text Editor Example \ingroup qtquickcontrols_examples \brief A QML app using Qt Quick Controls and a C++ class to provide a fully-functional rich-text editor application. @@ -206,13 +206,13 @@ /*! \example touch - \title Qt Quick Controls - Touch Gallery + \title Qt Quick Controls 1 - Touch Gallery \ingroup qtquickcontrols_examples \brief Demonstrates UI controls for a touch interface. \image qtquickcontrols-example-touch.png \e {Touch Gallery} demonstrates how to implement a UI suitable for touch - input using the following \l{Qt Quick Controls}: + input using the following \l{Qt Quick Controls 1}: \list \li \l ApplicationWindow @@ -228,7 +228,7 @@ \endlist The appearance of the controls is customized by using - \l {Qt Quick Controls Styles}. + \l {Qt Quick Controls 1 Styles}. \include examples-run.qdocinc @@ -452,7 +452,7 @@ /*! \example calendar - \title Qt Quick Controls - Calendar Example + \title Qt Quick Controls 1 - Calendar Example \ingroup qtquickcontrols_examples \brief Demonstrates the use of Calendar control. \image qtquickcontrols-example-calendar.png @@ -540,25 +540,25 @@ /*! \example styles - \title Qt Quick Controls - Styles Example + \title Qt Quick Controls 1 - Styles Example \ingroup qtquickcontrols_examples \brief Demonstrates custom styles. \image qtquickcontrols-example-styles.png - This example shows how to create custom styles for \l{Qt Quick Controls}. + This example shows how to create custom styles for \l{Qt Quick Controls 1}. \include examples-run.qdocinc */ /*! \example filesystembrowser - \title Qt Quick Controls - File System Browser Example + \title Qt Quick Controls 1 - File System Browser Example \ingroup qtquickcontrols_examples \brief An example for the TreeView control. \image qtquickcontrols-example-filesystembrowser.png This example project demonstrates the usage of \l {TreeView} from - \l{Qt Quick Controls} - a control to display a tree representation of items + \l{Qt Quick Controls 1} - a control to display a tree representation of items from a model derived from the QAbstractItemModel class. The example displays the home path data given by the QFileSystemModel model. diff --git a/src/controls/doc/src/qtquickcontrols-index.qdoc b/src/controls/doc/src/qtquickcontrols-index.qdoc index 28bc3644e..727be41e1 100644 --- a/src/controls/doc/src/qtquickcontrols-index.qdoc +++ b/src/controls/doc/src/qtquickcontrols-index.qdoc @@ -26,8 +26,8 @@ ****************************************************************************/ /*! - \page qtquickcontrols-index.html - \title Qt Quick Controls + \page qtquickcontrols1-index.html + \title Qt Quick Controls 1 \brief The Qt Quick Controls module provides a set of UI controls for Qt Quick. @@ -36,7 +36,7 @@ The module was introduced in Qt 5.1. - Visit the \l{Qt Quick Controls Overview} page to get started. + Visit the \l{Qt Quick Controls 1 Overview} page to get started. \section1 Application Window Components used to describe the basic window properties of an application. @@ -67,11 +67,11 @@ \list \li \l{Qt Quick} - \li \l{Qt Quick Controls Overview} - \li \l{Qt Quick Controls QML Types}{Qt Quick Controls QML Types} - \li \l{Qt Quick Controls Platform Notes} - \li \l{Qt Quick Controls Examples} - \li \l{Qt Quick Controls Styles} + \li \l{Qt Quick Controls 1 Overview} + \li \l{Qt Quick Controls 1 QML Types} + \li \l{Qt Quick Controls 1 Platform Notes} + \li \l{Qt Quick Controls 1 Examples} + \li \l{Qt Quick Controls 1 Styles} \li \l{Qt Quick Layouts} \li \l{Qt Quick Dialogs} \endlist diff --git a/src/controls/doc/src/qtquickcontrols-overview.qdoc b/src/controls/doc/src/qtquickcontrols-overview.qdoc index 5b7b1c07b..dddec50bf 100644 --- a/src/controls/doc/src/qtquickcontrols-overview.qdoc +++ b/src/controls/doc/src/qtquickcontrols-overview.qdoc @@ -27,7 +27,7 @@ /*! \page qtquickcontrols-overview.html - \title Qt Quick Controls Overview + \title Qt Quick Controls 1 Overview \brief A set of UI controls to create user interfaces in Qt Quick The Qt Quick Controls provide a set of UI controls to create user interfaces @@ -61,8 +61,8 @@ } \endcode - For an overview of the controls provided by \l{Qt Quick Controls}, you can look at - the \l{Qt Quick Controls - Gallery}{Gallery} example. + For an overview of the controls provided by \l{Qt Quick Controls 1}, you can look at + the \l{Qt Quick Controls 1 - Gallery}{Gallery} example. \image qtquickcontrols-example-gallery-osx.png @@ -134,7 +134,7 @@ \list \li \l{Qt Quick} - \li \l{Qt Quick Controls} - \li \l{Qt Quick Controls Examples} + \li \l{Qt Quick Controls 1} + \li \l{Qt Quick Controls 1 Examples} \endlist */ diff --git a/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc b/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc index 920105621..60d5e7971 100644 --- a/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc +++ b/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc @@ -27,11 +27,11 @@ /*! \page qtquickcontrols-platformnotes.html - \title Qt Quick Controls Platform Notes + \title Qt Quick Controls 1 Platform Notes \brief Platform specific notes for Qt Quick Controls. This page contains platform specific notes for creating applications - that use \l{Qt Quick Controls}. + that use \l{Qt Quick Controls 1}. \section1 Android Style @@ -71,7 +71,7 @@ including various navigation modes, actions, an options menu, a back button, and also displays the application icon and title. - Unlike \l{Qt Widgets}, Qt Quick Controls do not use the native action + Unlike \l{Qt Widgets}, Qt Quick Controls 1 do not use the native action bar on Android. ToolBar and MenuBar are offered as a cross-platform replacement. They are unified to a single "action bar" when assigned to the appropriate ApplicationWindow properties. diff --git a/src/controls/doc/src/qtquickcontrols.qdoc b/src/controls/doc/src/qtquickcontrols.qdoc index 974345f58..a57521d18 100644 --- a/src/controls/doc/src/qtquickcontrols.qdoc +++ b/src/controls/doc/src/qtquickcontrols.qdoc @@ -27,15 +27,15 @@ /*! \qmlmodule QtQuick.Controls 1.4 - \title Qt Quick Controls QML Types + \title Qt Quick Controls 1 QML Types \ingroup qmlmodules \brief Provides QML types for user interfaces. - The \l{Qt Quick Controls} module provides QML types for creating user + The \l{Qt Quick Controls 1} module provides QML types for creating user interfaces. These QML types work in conjunction with \l{Qt Quick} and \l{Qt Quick Layouts}. - Controls can be styled using the \l{Qt Quick Controls Styles QML Types}{Styles QML Types}. + Controls can be styled using the \l{Qt Quick Controls 1 Styles QML Types}{Styles QML Types}. The QML types can be imported into your application using the following import statement in your .qml file. diff --git a/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc b/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc index 100868a92..dfe8f4d0f 100644 --- a/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc +++ b/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc @@ -57,10 +57,10 @@ /*! \page qtquickcontrolsstyles-index.html - \title Qt Quick Controls Styles + \title Qt Quick Controls 1 Styles \brief The Qt Quick Controls Styles submodule provides custom styles for Qt Quick Controls. - The Qt Quick Controls Styles submodule allows custom styling for \l {Qt Quick Controls}. + The Qt Quick Controls Styles submodule allows custom styling for \l {Qt Quick Controls 1}. The submodule was introduced in Qt 5.1. @@ -118,19 +118,19 @@ \list \li \l{Qt Quick} - \li \l{Qt Quick Controls} - \li \l{Qt Quick Controls Styles QML Types} + \li \l{Qt Quick Controls 1} + \li \l{Qt Quick Controls 1 Styles QML Types} \endlist */ /*! \qmlmodule QtQuick.Controls.Styles 1.4 - \title Qt Quick Controls Styles QML Types + \title Qt Quick Controls 1 Styles QML Types \ingroup qmlmodules \brief Provides QML types for Qt Quick Controls styles. - The \l{Qt Quick Controls} module provides a set of QML types for handling + The \l{Qt Quick Controls 1} module provides a set of QML types for handling styles. Some of the controls allow custom styling similar to widget style sheets. |