From 52e5dc73b3f61e0453eb939314c3ea67b02ce7e3 Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Wed, 4 Dec 2019 16:51:06 +0100 Subject: Doc: Add a note about the deprecated controls 1 This will help readers who will end up on the Controls 1 pages through a web search. Change-Id: I9c40f6c66c72e5a456dd903485133c64cb386f8f Reviewed-by: Volker Hilsheimer Reviewed-by: Mitch Curtis --- src/controls/doc/qtquickcontrols1.qdocconf | 2 ++ src/controls/doc/src/qtquickcontrols-examples.qdoc | 23 ++++++++++++++++++++++ src/controls/doc/src/qtquickcontrols-index.qdoc | 2 ++ src/controls/doc/src/qtquickcontrols-overview.qdoc | 2 ++ .../doc/src/qtquickcontrols-platformnotes.qdoc | 2 ++ src/controls/doc/src/qtquickcontrols.qdoc | 2 ++ .../doc/src/qtquickcontrolsstyles-index.qdoc | 4 ++++ 7 files changed, 37 insertions(+) diff --git a/src/controls/doc/qtquickcontrols1.qdocconf b/src/controls/doc/qtquickcontrols1.qdocconf index 1a795dd1..7837fa3f 100644 --- a/src/controls/doc/qtquickcontrols1.qdocconf +++ b/src/controls/doc/qtquickcontrols1.qdocconf @@ -81,3 +81,5 @@ navigation.landingpage = "Qt Quick Controls 1" navigation.qmltypespage = "Qt Quick Controls 1 QML Types" tagfile = qtquickcontrols1.tags + +macro.deprecationwarning = "\\warning The Qt Quick Controls 1 module is deprecated since Qt 5.12. Use the latest \\l{Qt Quick Controls} module instead." diff --git a/src/controls/doc/src/qtquickcontrols-examples.qdoc b/src/controls/doc/src/qtquickcontrols-examples.qdoc index b6f2dca0..15498647 100644 --- a/src/controls/doc/src/qtquickcontrols-examples.qdoc +++ b/src/controls/doc/src/qtquickcontrols-examples.qdoc @@ -31,6 +31,8 @@ \title Qt Quick Controls 1 Examples \brief A Collection of examples for \l{Qt Quick Controls 1}, written in QML. + \deprecationwarning + These examples show how to create user interfaces using \l{Qt Quick Controls 1}. */ @@ -41,6 +43,8 @@ \ingroup qtquickcontrols_examples \brief A collection of components for a classic desktop-style UI. + \deprecationwarning + \raw HTML
@@ -69,6 +73,8 @@ \ingroup qtquickcontrols_examples \brief Demonstrates how to separate the application logic from the UI. + \deprecationwarning + \image qtquickcontrols-example-uiforms.png \e{UI Forms} demonstrates how to separate the application logic @@ -129,6 +135,9 @@ \title Qt Quick Controls 1 - Table View Example \ingroup qtquickcontrols_examples \brief An example for the TableView control. + + \deprecationwarning + \image qtquickcontrols-example-tableview.png This example project demonstrates the usage of \l {TableView} from @@ -170,6 +179,8 @@ \brief A QML app using Qt Quick Controls and a C++ class to provide a fully-functional rich-text editor application. + \deprecationwarning + \image qtquickcontrols-example-text.png The \e{Text Editor Example} presents a sample HTML file using the TextArea @@ -209,6 +220,9 @@ \title Qt Quick Controls 1 - Touch Gallery \ingroup qtquickcontrols_examples \brief Demonstrates UI controls for a touch interface. + + \deprecationwarning + \image qtquickcontrols-example-touch.png \e {Touch Gallery} demonstrates how to implement a UI suitable for touch @@ -455,6 +469,9 @@ \title Qt Quick Controls 1 - Calendar Example \ingroup qtquickcontrols_examples \brief Demonstrates the use of Calendar control. + + \deprecationwarning + \image qtquickcontrols-example-calendar.png The Calendar example displays a Calendar control and an events list for @@ -543,6 +560,9 @@ \title Qt Quick Controls 1 - Styles Example \ingroup qtquickcontrols_examples \brief Demonstrates custom styles. + + \deprecationwarning + \image qtquickcontrols-example-styles.png This example shows how to create custom styles for \l{Qt Quick Controls 1}. @@ -555,6 +575,9 @@ \title Qt Quick Controls 1 - File System Browser Example \ingroup qtquickcontrols_examples \brief An example for the TreeView control. + + \deprecationwarning + \image qtquickcontrols-example-filesystembrowser.png This example project demonstrates the usage of \l {TreeView} from diff --git a/src/controls/doc/src/qtquickcontrols-index.qdoc b/src/controls/doc/src/qtquickcontrols-index.qdoc index 727be41e..5c7e3299 100644 --- a/src/controls/doc/src/qtquickcontrols-index.qdoc +++ b/src/controls/doc/src/qtquickcontrols-index.qdoc @@ -31,6 +31,8 @@ \brief The Qt Quick Controls module provides a set of UI controls for Qt Quick. + \deprecationwarning + The Qt Quick Controls module provides a set of controls that can be used to build complete interfaces in Qt Quick. diff --git a/src/controls/doc/src/qtquickcontrols-overview.qdoc b/src/controls/doc/src/qtquickcontrols-overview.qdoc index dddec50b..f9acf353 100644 --- a/src/controls/doc/src/qtquickcontrols-overview.qdoc +++ b/src/controls/doc/src/qtquickcontrols-overview.qdoc @@ -30,6 +30,8 @@ \title Qt Quick Controls 1 Overview \brief A set of UI controls to create user interfaces in Qt Quick + \deprecationwarning + The Qt Quick Controls provide a set of UI controls to create user interfaces in Qt Quick. diff --git a/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc b/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc index 60d5e797..f1739aa9 100644 --- a/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc +++ b/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc @@ -30,6 +30,8 @@ \title Qt Quick Controls 1 Platform Notes \brief Platform specific notes for Qt Quick Controls. + \deprecationwarning + This page contains platform specific notes for creating applications that use \l{Qt Quick Controls 1}. diff --git a/src/controls/doc/src/qtquickcontrols.qdoc b/src/controls/doc/src/qtquickcontrols.qdoc index a57521d1..92606e47 100644 --- a/src/controls/doc/src/qtquickcontrols.qdoc +++ b/src/controls/doc/src/qtquickcontrols.qdoc @@ -31,6 +31,8 @@ \ingroup qmlmodules \brief Provides QML types for user interfaces. + \deprecationwarning + 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}. diff --git a/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc b/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc index dfe8f4d0..9333ee27 100644 --- a/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc +++ b/src/controls/doc/src/qtquickcontrolsstyles-index.qdoc @@ -60,6 +60,8 @@ \title Qt Quick Controls 1 Styles \brief The Qt Quick Controls Styles submodule provides custom styles for Qt Quick Controls. + \deprecation-warning + The Qt Quick Controls Styles submodule allows custom styling for \l {Qt Quick Controls 1}. The submodule was introduced in Qt 5.1. @@ -130,6 +132,8 @@ \ingroup qmlmodules \brief Provides QML types for Qt Quick Controls styles. + \deprecation-warning + The \l{Qt Quick Controls 1} module provides a set of QML types for handling styles. -- cgit v1.2.1