aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/controls/doc/src
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@theqtcompany.com>2016-05-24 10:54:42 +0200
committerJ-P Nurmi <jpnurmi@qt.io>2016-06-07 21:05:32 +0000
commitd400ab8290eaae7c3d3e74ea99a9136247d87e4f (patch)
tree77c068eb710509ad101abb8f992484648d9b959b /src/imports/controls/doc/src
parenta5bb13cef380999fc5e856d1a7f9941acd73108c (diff)
Doc: Collect a list of guidelines pages
Change-Id: Ie64486275b7fc39005cc6f86f33f04444474c07e Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Diffstat (limited to 'src/imports/controls/doc/src')
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-buttons.qdoc6
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-delegates.qdoc7
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-guidelines.qdoc44
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-index.qdoc1
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-indicators.qdoc7
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-input.qdoc7
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-menus.qdoc2
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-navigation.qdoc2
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc7
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc5
10 files changed, 88 insertions, 0 deletions
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-buttons.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-buttons.qdoc
index ef084fcf..48b0097d 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-buttons.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-buttons.qdoc
@@ -28,6 +28,8 @@
/*!
\page qtquickcontrols2-buttons.html
\title Button Controls
+ \ingroup qtquickcontrols2-guidelines
+ \brief Guidelines for button controls
Qt Quick Controls 2 offers a selection of button-like controls.
@@ -162,4 +164,8 @@
\b {See also} \l ToolButton
+ \section1 Related Information
+ \list
+ \li \l {Qt Quick Controls 2 Guidelines}
+ \endlist
*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-delegates.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-delegates.qdoc
index 41e9ced4..0ecfdf42 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-delegates.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-delegates.qdoc
@@ -28,6 +28,8 @@
/*!
\page qtquickcontrols2-delegates.html
\title Delegate Controls
+ \ingroup qtquickcontrols2-guidelines
+ \brief Guidelines for delegate controls
Qt Quick Controls 2 offers a selection of controls that are used as
delegates in views.
@@ -62,5 +64,10 @@
\l SwitchDelegate presents a switchable delegate that can be toggled on or off.
\b {See also} \l {Switch Control}.
+
+ \section1 Related Information
+ \list
+ \li \l {Qt Quick Controls 2 Guidelines}
+ \endlist
*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-guidelines.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-guidelines.qdoc
new file mode 100644
index 00000000..87ba4cf1
--- /dev/null
+++ b/src/imports/controls/doc/src/qtquickcontrols2-guidelines.qdoc
@@ -0,0 +1,44 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \page qtquickcontrols2-guidelines.html
+ \title Qt Quick Controls 2 Guidelines
+
+ Qt Quick Controls 2 offers a selection of controls that can be used to
+ build complete interfaces in Qt Quick.
+
+ Below you will find practical guidelines on how and when to use
+ the controls.
+
+ \annotatedlist qtquickcontrols2-guidelines
+
+ \section1 Related Information
+ \list
+ \li \l{Qt Quick Controls 2 QML Types}{All Qt Quick Controls 2 QML Types}
+ \endlist
+*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc
index 3f4467d5..171239ce 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc
@@ -62,6 +62,7 @@
\section1 Important Concepts in Qt Quick Controls 2
\list
+ \li \l{Qt Quick Controls 2 Guidelines}
\li \l{Styling Qt Quick Controls 2}
\li \l{Customizing Qt Quick Controls 2}
\li \l{High-DPI Support in Qt Quick Controls 2}
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-indicators.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-indicators.qdoc
index 0d6818ce..010ff444 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-indicators.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-indicators.qdoc
@@ -28,6 +28,8 @@
/*!
\page qtquickcontrols2-indicators.html
\title Indicator Controls
+ \ingroup qtquickcontrols2-guidelines
+ \brief Guidelines for indicator controls
Qt Quick Controls 2 offers a selection of indicator-like controls.
@@ -65,4 +67,9 @@
\l ScrollIndicator is a non-interactive indicator that indicates the
current scroll position, and can be used to scroll to a specific position in a
\l {Flickable}.
+
+ \section1 Related Information
+ \list
+ \li \l {Qt Quick Controls 2 Guidelines}
+ \endlist
*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-input.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-input.qdoc
index e9aa3646..681a9d89 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-input.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-input.qdoc
@@ -28,6 +28,8 @@
/*!
\page qtquickcontrols2-input.html
\title Input Controls
+ \ingroup qtquickcontrols2-guidelines
+ \brief Guidelines for input controls
Qt Quick Controls 2 offers a variety of input controls for both numeric
and textual input.
@@ -104,4 +106,9 @@
\l Tumbler is a spinnable wheel of items that can be selected.
\b {See also} \l {ComboBox Control}.
+
+ \section1 Related Information
+ \list
+ \li \l {Qt Quick Controls 2 Guidelines}
+ \endlist
*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-menus.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-menus.qdoc
index 22b96e96..faa8c3bc 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-menus.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-menus.qdoc
@@ -28,6 +28,8 @@
/*!
\page qtquickcontrols2-menus.html
\title Menu Controls
+ \ingroup qtquickcontrols2-guidelines
+ \brief Guidelines for menu controls
\annotatedlist qtquickcontrols2-menus
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-navigation.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-navigation.qdoc
index 9180d480..a2bd15a6 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-navigation.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-navigation.qdoc
@@ -28,6 +28,8 @@
/*!
\page qtquickcontrols2-navigation.html
\title Navigation Controls
+ \ingroup qtquickcontrols2-guidelines
+ \brief Guidelines for navigation controls
Qt Quick Controls 2 offers a selection of navigation models.
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc
index c93f13e4..aa2efb90 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-popups.qdoc
@@ -28,6 +28,8 @@
/*!
\page qtquickcontrols2-popups.html
\title Popup Controls
+ \ingroup qtquickcontrols2-guidelines
+ \brief Guidelines for popup controls
\annotatedlist qtquickcontrols2-popups
@@ -89,4 +91,9 @@
\li Keep the tooltip text short so that it does not cover other content
while being displayed.
\endlist
+
+ \section1 Related Information
+ \list
+ \li \l {Qt Quick Controls 2 Guidelines}
+ \endlist
*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc
index 13a7f24e..52da41a7 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-qmltypes.qdoc
@@ -48,4 +48,9 @@
For more information on the Qt Quick Controls 2 module, see the
\l {Qt Quick Controls 2} module documentation.
+
+ \section1 Related Information
+ \list
+ \li \l {Qt Quick Controls 2 Guidelines}
+ \endlist
*/