From 4773418916deaaf9ad5fb1d283c719b60c6d8b1f Mon Sep 17 00:00:00 2001
From: Jens Bache-Wiig <jens.bache-wiig@digia.com>
Date: Wed, 27 Feb 2013 18:50:50 +0100
Subject: [PATCH] Make the doc index page actually useful
Improved group labels and added direct links from the
index page.
Change-Id: I856df138880b1aac8c574f676424ac4644e298f9
Reviewed-by: J-P Nurmi <jpnurmi@digia.com>
---
src/controls/Button.qml | 4 +--
src/controls/CheckBox.qml | 2 +-
src/controls/ComboBox.qml | 5 ++--
src/controls/Label.qml | 2 +-
src/controls/MenuBar.qml | 1 +
src/controls/Page.qml | 2 +-
src/controls/PageStack.qml | 3 ++-
src/controls/ProgressBar.qml | 4 +--
src/controls/ScrollView.qml | 2 +-
src/controls/StatusBar.qml | 2 +-
src/controls/Tab.qml | 8 +++---
src/controls/TabView.qml | 4 +--
src/controls/TableViewColumn.qml | 2 +-
src/controls/TextField.qml | 2 +-
src/controls/ToolButton.qml | 2 +-
.../doc/src/qtquickcontrols-index.qdoc | 27 +++++++------------
src/controls/doc/src/views.qdoc | 4 +--
17 files changed, 35 insertions(+), 41 deletions(-)
diff --git a/src/controls/Button.qml b/src/controls/Button.qml
index b00530d41..e3f6f58cf 100644
--- a/src/controls/Button.qml
+++ b/src/controls/Button.qml
@@ -47,9 +47,9 @@ import "Styles/Settings.js" as Settings
\qmltype Button
\inqmlmodule QtQuick.Controls 1.0
\ingroup controls
- \brief A normal button
+ \brief A push button with a text label.
- A normal command button. Similar to the QPushButton widget.
+ A normal push button. Similar to the QPushButton widget.
The push button is perhaps the most commonly used widget in any graphical user interface.
Push (click) a button to command the computer to perform some action, or to answer a question.
diff --git a/src/controls/CheckBox.qml b/src/controls/CheckBox.qml
index d2ee44ce4..e9c03073c 100644
--- a/src/controls/CheckBox.qml
+++ b/src/controls/CheckBox.qml
@@ -48,7 +48,7 @@ import "Styles/Settings.js" as Settings
\qmltype CheckBox
\inqmlmodule QtQuick.Controls 1.0
\ingroup controls
- \brief A checkbox with a text label
+ \brief A checkbox with a text label.
A CheckBox is an option button that can be toggled on (checked) or off
(unchecked). Checkboxes are typically used to represent features in an
diff --git a/src/controls/ComboBox.qml b/src/controls/ComboBox.qml
index e1b019e1d..f5dbaca8a 100644
--- a/src/controls/ComboBox.qml
+++ b/src/controls/ComboBox.qml
@@ -47,8 +47,9 @@ import "Styles/Settings.js" as Settings
\qmltype ComboBox
\inqmlmodule QtQuick.Controls 1.0
\ingroup controls
- \brief ComboBox is a combined button and popup list. The popup menu itself is platform
- native, and cannot by styled from QML code.
+ \brief ComboBox is a combined button and popup list.
+
+ The popup menu itself is platform native, and cannot by styled from QML code.
Add menu items to the comboBox by either adding MenuItem children inside the popup, or
assign it a ListModel (or both).
diff --git a/src/controls/Label.qml b/src/controls/Label.qml
index 361696356..6e01701b8 100644
--- a/src/controls/Label.qml
+++ b/src/controls/Label.qml
@@ -44,7 +44,7 @@ import QtQuick 2.0
\qmltype Label
\inqmlmodule QtQuick.Controls 1.0
\ingroup controls
- \brief Label is a text display.
+ \brief A text label.
In addition to the normal \l Text element, Label follows the font and
color scheme of the system.
diff --git a/src/controls/MenuBar.qml b/src/controls/MenuBar.qml
index 5018c1a8d..6f351d126 100644
--- a/src/controls/MenuBar.qml
+++ b/src/controls/MenuBar.qml
@@ -47,6 +47,7 @@ import "Styles/Settings.js" as Settings
/*!
\qmltype MenuBar
\inqmlmodule QtQuick.Controls 1.0
+ \ingroup applicationwindow
\inherits Item
\brief The MenuBar item provides a horizontal menu bar.
diff --git a/src/controls/Page.qml b/src/controls/Page.qml
index ed64c8894..35c07be78 100644
--- a/src/controls/Page.qml
+++ b/src/controls/Page.qml
@@ -44,7 +44,7 @@ import QtQuick.Controls 1.0
/*!
\qmltype Page
\inqmlmodule QtQuick.Controls 1.0
- \ingroup navigation
+ \ingroup viewitems
\brief A Page is an Item you can push on a PageStack
A \a Page is the main Item pushed onto a \l PageStack. It normally contains a discrete
diff --git a/src/controls/PageStack.qml b/src/controls/PageStack.qml
index a1a13558f..b98244c65 100644
--- a/src/controls/PageStack.qml
+++ b/src/controls/PageStack.qml
@@ -46,9 +46,10 @@ import "Private/PageStack.js" as JSArray
/*!
\qmltype PageStack
\inherits Item
+ \ingroup views
\inqmlmodule QtQuick.Controls 1.0
- \brief The central component for building page-based applications
+ \brief Provides a stack-based navigation model.
PageStack implements a stack-based navigation model for an application.
A stack-based navigation model means that "pages" (discrete views of information)
diff --git a/src/controls/ProgressBar.qml b/src/controls/ProgressBar.qml
index 12a7c1405..e7260d3b9 100644
--- a/src/controls/ProgressBar.qml
+++ b/src/controls/ProgressBar.qml
@@ -46,8 +46,8 @@ import "Styles/Settings.js" as Settings
/*!
\qmltype ProgressBar
\inqmlmodule QtQuick.Controls 1.0
- \ingroup indicators
- \brief A progress bar
+ \ingroup controls
+ \brief A progress indicator.
The ProgressBar is used to give an indication of the progress of an operation.
\l value is updated regularly and must be between \l minimumValue and \l maximumValue.
diff --git a/src/controls/ScrollView.qml b/src/controls/ScrollView.qml
index 21812b5a8..a8f2621a4 100644
--- a/src/controls/ScrollView.qml
+++ b/src/controls/ScrollView.qml
@@ -45,7 +45,7 @@ import QtQuick.Controls.Private 1.0
/*!
\qmltype ScrollView
\inqmlmodule QtQuick.Controls 1.0
- \ingroup navigation
+ \ingroup views
\brief The ScrollView class provides a scrolling view onto another Item.
A ScrollView can be used either instead of a \l Flickable or to decorate an
diff --git a/src/controls/StatusBar.qml b/src/controls/StatusBar.qml
index 68beeaab0..8ae7cfc8b 100644
--- a/src/controls/StatusBar.qml
+++ b/src/controls/StatusBar.qml
@@ -46,7 +46,7 @@ import QtQuick.Controls.Private 1.0
\qmltype StatusBar
\inqmlmodule QtQuick.Controls 1.0
\ingroup applicationwindow
- \brief StatusBar is for containing status informating in your app
+ \brief StatusBar is for containing status informating in your app.
The common way of using StatusBar is in relation to \l ApplicationWindow.
diff --git a/src/controls/Tab.qml b/src/controls/Tab.qml
index 568ce8ceb..119c17756 100644
--- a/src/controls/Tab.qml
+++ b/src/controls/Tab.qml
@@ -43,14 +43,16 @@ import QtQuick 2.0
/*!
\qmltype Tab
\inqmlmodule QtQuick.Controls 1.0
- \ingroup navigation
- \brief Tab is doing bla...bla...
+ \ingroup viewaddons
+ \brief Tab represents the content of a tab in a TabView
*/
Item {
id:tab
anchors.fill: parent
+
+ /*! This property holds the title of the tab. */
property string title
- property int contentMargin
+
Accessible.role: Accessible.PageTab
}
diff --git a/src/controls/TabView.qml b/src/controls/TabView.qml
index e5996bde1..89649255f 100644
--- a/src/controls/TabView.qml
+++ b/src/controls/TabView.qml
@@ -46,8 +46,8 @@ import "Styles/Settings.js" as Settings
/*!
\qmltype TabView
\inqmlmodule QtQuick.Controls 1.0
- \ingroup navigation
- \brief Represents a control that contains multiple items that share the same space on the screen.
+ \ingroup views
+ \brief A conrol that allows the user to select one of multiple stacked items.
*/
diff --git a/src/controls/TableViewColumn.qml b/src/controls/TableViewColumn.qml
index 7b09f7fe3..62d57d9d4 100644
--- a/src/controls/TableViewColumn.qml
+++ b/src/controls/TableViewColumn.qml
@@ -43,7 +43,7 @@ import QtQuick 2.0
/*!
\qmltype TableViewColumn
\inqmlmodule QtQuick.Controls 1.0
- \ingroup views
+ \ingroup viewitems
\brief Used by the \l TableView to define a column header.
*/
diff --git a/src/controls/TextField.qml b/src/controls/TextField.qml
index 13266cbdd..55d90fa76 100644
--- a/src/controls/TextField.qml
+++ b/src/controls/TextField.qml
@@ -48,7 +48,7 @@ import "Styles/Settings.js" as Settings
\qmltype TextField
\inqmlmodule QtQuick.Controls 1.0
\ingroup controls
- \brief TextField displays a single line of editable plain text
+ \brief TextField displays a single line of editable plain text.
TextField is used to accept a line of text input. Input constraints
can be placed on a TextField item (for example, through a \l validator or \l inputMask),
diff --git a/src/controls/ToolButton.qml b/src/controls/ToolButton.qml
index 5a756d2a5..02c98a076 100644
--- a/src/controls/ToolButton.qml
+++ b/src/controls/ToolButton.qml
@@ -47,7 +47,7 @@ import "Styles/Settings.js" as Settings
\qmltype ToolButton
\inqmlmodule QtQuick.Controls 1.0
\ingroup applicationwindow
- \brief ToolButton provides a button type that is typically used within a ToolBar
+ \brief ToolButton provides a button type that is typically used within a ToolBar.
ToolButton is functionally similar to \l Button but can provide a look that is more
suitable within a \l ToolBar.
diff --git a/src/controls/doc/src/qtquickcontrols-index.qdoc b/src/controls/doc/src/qtquickcontrols-index.qdoc
index 1f3ab44e0..abb96416d 100644
--- a/src/controls/doc/src/qtquickcontrols-index.qdoc
+++ b/src/controls/doc/src/qtquickcontrols-index.qdoc
@@ -31,33 +31,25 @@
\brief The Qt Quick Controls module is an add-on module of Qt.
- \image placeholder.png
-
\section1 Getting started
The QML types can be imported into your applciation using the following import statement in your \c {.qml} file.
\code
import QtQuick.Controls 1.0
- import QtQuick.Controls.Styles 1.0
\endcode
- \section1 Components
+ \section1 Application Window
+ Components used to describe the basic window properties of an application.
+ \annotatedlist applicationwindow
- \section2 Application
- \list
- \li \l{Application Window}{Window}
- \li \l{Application Menus}{Menus}
- \li \l{Application Navigation}{Navigation}
- \endlist
+ \section1 Navigation and Views
+ Views are controls that present or present other items on screen.
+ \annotatedlist views
- \section2 Controls and Layout
- \list
- \li \l{Buttons and Controls}
- \li \l{Layout and Containers}
- \li \l{Tables}
- \li \l{Status Indicators}
- \endlist
+ \section1 Controls
+ Controls are typically items that are used to present or receive input from the user.
+ \annotatedlist controls
\section1 Related information
@@ -69,7 +61,6 @@
\section2 Reference
\list
\li \l{Qt Quick Controls QML Types}{Qt Quick Controls QML Types}
- \li \l{Qt Quick Controls Styles QML Types}{Qt Quick Controls Styles QML Types}
\endlist
\section2 Examples
diff --git a/src/controls/doc/src/views.qdoc b/src/controls/doc/src/views.qdoc
index c92cb7dae..cda1e38e7 100644
--- a/src/controls/doc/src/views.qdoc
+++ b/src/controls/doc/src/views.qdoc
@@ -27,7 +27,5 @@
/*!
\group views
- \title Views
-
- \image placeholder.png
+ \title Application Navigation and Views
*/
--
GitLab