aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@theqtcompany.com>2016-02-10 14:25:39 +0100
committerNico Vertriest <nico.vertriest@theqtcompany.com>2016-02-12 09:17:14 +0000
commitecca9422c4f8eb20f2d447df51994abc1e1d4e1b (patch)
treea7e8e8df01afe88e47aa45661c47f92ae2393142
parent3a45249a0f0d3491483cae4af92bc0fa09d0ee7d (diff)
Doc: Reviewed \brief statements in overview page
Change-Id: I7b01e3331edd32fb1b129bacb076310a5f3a4680 Task-number: QTBUG-50933 Reviewed-by: J-P Nurmi <jpnurmi@theqtcompany.com>
-rw-r--r--src/templates/qquickabstractbutton.cpp2
-rw-r--r--src/templates/qquickbusyindicator.cpp2
-rw-r--r--src/templates/qquickbutton.cpp2
-rw-r--r--src/templates/qquickbuttongroup.cpp2
-rw-r--r--src/templates/qquickcheckbox.cpp2
-rw-r--r--src/templates/qquickcombobox.cpp2
-rw-r--r--src/templates/qquickcontrol.cpp2
-rw-r--r--src/templates/qquickdrawer.cpp2
-rw-r--r--src/templates/qquickframe.cpp2
-rw-r--r--src/templates/qquickgroupbox.cpp2
-rw-r--r--src/templates/qquickitemdelegate.cpp2
-rw-r--r--src/templates/qquicklabel.cpp2
-rw-r--r--src/templates/qquickmenu.cpp2
-rw-r--r--src/templates/qquickpage.cpp2
-rw-r--r--src/templates/qquickpageindicator.cpp2
-rw-r--r--src/templates/qquickpane.cpp2
-rw-r--r--src/templates/qquickpopup.cpp2
-rw-r--r--src/templates/qquickprogressbar.cpp2
-rw-r--r--src/templates/qquickradiobutton.cpp2
-rw-r--r--src/templates/qquickslider.cpp2
-rw-r--r--src/templates/qquickspinbox.cpp2
-rw-r--r--src/templates/qquickswipeview.cpp2
-rw-r--r--src/templates/qquickswitch.cpp2
-rw-r--r--src/templates/qquicktabbar.cpp2
-rw-r--r--src/templates/qquicktabbutton.cpp2
-rw-r--r--src/templates/qquicktoolbar.cpp2
-rw-r--r--src/templates/qquicktoolbutton.cpp2
27 files changed, 27 insertions, 27 deletions
diff --git a/src/templates/qquickabstractbutton.cpp b/src/templates/qquickabstractbutton.cpp
index aed7ed5d..546eecb3 100644
--- a/src/templates/qquickabstractbutton.cpp
+++ b/src/templates/qquickabstractbutton.cpp
@@ -55,7 +55,7 @@ static const int AUTO_REPEAT_INTERVAL = 100;
\instantiates QQuickAbstractButton
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-buttons
- \brief The base of all button controls.
+ \brief Base type of all button controls.
AbstractButton provides the interface for controls with button-like
behavior; for example, push buttons and checkable controls like
diff --git a/src/templates/qquickbusyindicator.cpp b/src/templates/qquickbusyindicator.cpp
index 381ac5c7..d4e07d44 100644
--- a/src/templates/qquickbusyindicator.cpp
+++ b/src/templates/qquickbusyindicator.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickBusyIndicator
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-indicators
- \brief A busy indicator.
+ \brief Indicates activity while content is being loaded.
\image qtlabscontrols-busyindicator.gif
diff --git a/src/templates/qquickbutton.cpp b/src/templates/qquickbutton.cpp
index 1e40ec05..d193e68d 100644
--- a/src/templates/qquickbutton.cpp
+++ b/src/templates/qquickbutton.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickButton
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-buttons
- \brief A button control.
+ \brief A push-button control that can be clicked by the user.
\image qtlabscontrols-button.gif
diff --git a/src/templates/qquickbuttongroup.cpp b/src/templates/qquickbuttongroup.cpp
index c1822183..da282250 100644
--- a/src/templates/qquickbuttongroup.cpp
+++ b/src/templates/qquickbuttongroup.cpp
@@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickButtonGroup
\inqmlmodule Qt.labs.controls
\ingroup utilities
- \brief An exclusive group of checkable controls.
+ \brief A mutually-exclusive group of checkable controls.
ButtonGroup is a non-visual, mutually exclusive group of buttons.
It is used with controls such as RadioButton, where only one of the options
diff --git a/src/templates/qquickcheckbox.cpp b/src/templates/qquickcheckbox.cpp
index 644e151e..1272a271 100644
--- a/src/templates/qquickcheckbox.cpp
+++ b/src/templates/qquickcheckbox.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickCheckBox
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-buttons
- \brief A check box control.
+ \brief An option button that can be checked or unchecked.
CheckBox presents an option button that can be toggled on (checked) or
off (unchecked). Check boxes are typically used to select one or more
diff --git a/src/templates/qquickcombobox.cpp b/src/templates/qquickcombobox.cpp
index 3bef5acf..f51b301f 100644
--- a/src/templates/qquickcombobox.cpp
+++ b/src/templates/qquickcombobox.cpp
@@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickComboBox
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-input
- \brief A combo box control.
+ \brief A combined button and popup list taking minimal space.
\image qtlabscontrols-combobox.png
diff --git a/src/templates/qquickcontrol.cpp b/src/templates/qquickcontrol.cpp
index 348adc9e..a8235492 100644
--- a/src/templates/qquickcontrol.cpp
+++ b/src/templates/qquickcontrol.cpp
@@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE
\inherits Item
\instantiates QQuickControl
\inqmlmodule Qt.labs.controls
- \brief A user interface control.
+ \brief The base type of user interface controls.
Control is the base type of user interface controls.
diff --git a/src/templates/qquickdrawer.cpp b/src/templates/qquickdrawer.cpp
index 2eb12676..33e0ff8f 100644
--- a/src/templates/qquickdrawer.cpp
+++ b/src/templates/qquickdrawer.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-navigation
\ingroup qtlabscontrols-containers
- \brief A side panel control.
+ \brief Provides a swipe-based side panel.
Drawer provides a swipe-based side panel, similar to those often used in
touch interfaces to provide a central location for navigation.
diff --git a/src/templates/qquickframe.cpp b/src/templates/qquickframe.cpp
index 54f384dc..6b0a08ac 100644
--- a/src/templates/qquickframe.cpp
+++ b/src/templates/qquickframe.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickFrame
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-containers
- \brief A frame control.
+ \brief A logical group of controls within a visual frame.
Frame is used to layout a logical group of controls together, within a
visual frame. Frame does not provide a layout of its own, but requires
diff --git a/src/templates/qquickgroupbox.cpp b/src/templates/qquickgroupbox.cpp
index 011245b1..1dba509b 100644
--- a/src/templates/qquickgroupbox.cpp
+++ b/src/templates/qquickgroupbox.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickGroupBox
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-containers
- \brief A group box control.
+ \brief A frame with a logical group of controls.
GroupBox is used to layout a logical group of controls together, within
a titled visual frame. GroupBox does not provide a layout of its own, but
diff --git a/src/templates/qquickitemdelegate.cpp b/src/templates/qquickitemdelegate.cpp
index 98364fad..ab5e1925 100644
--- a/src/templates/qquickitemdelegate.cpp
+++ b/src/templates/qquickitemdelegate.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
\inherits AbstractButton
\instantiates QQuickItemDelegate
\inqmlmodule Qt.labs.controls
- \brief An item delegate.
+ \brief A standard view item that can be used in various views and controls.
ItemDelegate presents a standard view item. It can be used as a delegate
in various views and controls, such as \l ListView and \l ComboBox.
diff --git a/src/templates/qquicklabel.cpp b/src/templates/qquicklabel.cpp
index 8420deb1..92969d4f 100644
--- a/src/templates/qquicklabel.cpp
+++ b/src/templates/qquicklabel.cpp
@@ -55,7 +55,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickLabel
\inqmlmodule Qt.labs.controls
\ingroup text
- \brief A text label.
+ \brief A text label with inherited styling and font.
Label extends \l Text with styling and \l {Control::font}{font}
inheritance. The default colors and font are style specific. Label
diff --git a/src/templates/qquickmenu.cpp b/src/templates/qquickmenu.cpp
index 742a7e35..acfcdb70 100644
--- a/src/templates/qquickmenu.cpp
+++ b/src/templates/qquickmenu.cpp
@@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickMenu
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-menus
- \brief A menu control.
+ \brief A menu control that can be used as a context menu or popup menu.
\image qtlabscontrols-menu.png
diff --git a/src/templates/qquickpage.cpp b/src/templates/qquickpage.cpp
index da40a00c..8bafb2b9 100644
--- a/src/templates/qquickpage.cpp
+++ b/src/templates/qquickpage.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickPage
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-containers
- \brief A page control.
+ \brief A control that makes it convenient to add a header and footer to a page.
Page is a container control which makes it convenient to add
a \l header and \l footer item to a page.
diff --git a/src/templates/qquickpageindicator.cpp b/src/templates/qquickpageindicator.cpp
index 1333c245..ea50371d 100644
--- a/src/templates/qquickpageindicator.cpp
+++ b/src/templates/qquickpageindicator.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickPageIndicator
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-indicators
- \brief A page indicator control.
+ \brief Indicates the currently active page.
PageIndicator is used to indicate the currently active page
in a container of multiple pages. PageIndicator consists of
diff --git a/src/templates/qquickpane.cpp b/src/templates/qquickpane.cpp
index c660220c..a9428002 100644
--- a/src/templates/qquickpane.cpp
+++ b/src/templates/qquickpane.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickPane
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-containers
- \brief A pane control.
+ \brief Provides a background matching with the application style and theme.
Pane provides a background color that matches with the application style
and theme. Pane does not provide a layout of its own, but requires you to
diff --git a/src/templates/qquickpopup.cpp b/src/templates/qquickpopup.cpp
index 3cdf3bd2..0fed8109 100644
--- a/src/templates/qquickpopup.cpp
+++ b/src/templates/qquickpopup.cpp
@@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickPopup
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-popups
- \brief A popup control.
+ \brief The base type of popup-like user interface controls.
Popup is the base type of popup-like user interface controls.
diff --git a/src/templates/qquickprogressbar.cpp b/src/templates/qquickprogressbar.cpp
index cd490f50..62ad15f8 100644
--- a/src/templates/qquickprogressbar.cpp
+++ b/src/templates/qquickprogressbar.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickProgressBar
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-indicators
- \brief A progress bar control.
+ \brief Indicates the progress of an operation.
ProgressBar indicates the progress of an operation.
diff --git a/src/templates/qquickradiobutton.cpp b/src/templates/qquickradiobutton.cpp
index 7d7a64aa..e14427f9 100644
--- a/src/templates/qquickradiobutton.cpp
+++ b/src/templates/qquickradiobutton.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickRadioButton
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-buttons
- \brief A radio button control.
+ \brief An option button that can be toggled on or off.
RadioButton presents an option button that can be toggled on (checked) or
off (unchecked). Radio buttons are typically used to select one option
diff --git a/src/templates/qquickslider.cpp b/src/templates/qquickslider.cpp
index e6163e0c..a4165c3f 100644
--- a/src/templates/qquickslider.cpp
+++ b/src/templates/qquickslider.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickSlider
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-input
- \brief A slider control.
+ \brief Selects a value by sliding a handle along a track.
\image qtlabscontrols-slider.gif
diff --git a/src/templates/qquickspinbox.cpp b/src/templates/qquickspinbox.cpp
index 1144e3ad..6046d2e4 100644
--- a/src/templates/qquickspinbox.cpp
+++ b/src/templates/qquickspinbox.cpp
@@ -56,7 +56,7 @@ static const int AUTO_REPEAT_INTERVAL = 100;
\instantiates QQuickSpinBox
\inqmlmodule Qt.labs.controls
\ingroup input
- \brief A spinbox control.
+ \brief A spinbox control that allows the user from a set of preset values.
\image qtlabscontrols-spinbox.png
diff --git a/src/templates/qquickswipeview.cpp b/src/templates/qquickswipeview.cpp
index f4481b31..41091930 100644
--- a/src/templates/qquickswipeview.cpp
+++ b/src/templates/qquickswipeview.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-navigation
\ingroup qtlabscontrols-containers
- \brief A swipe view control.
+ \brief Enables the user to navigate pages by swiping sideways.
SwipeView provides a swipe-based navigation model.
diff --git a/src/templates/qquickswitch.cpp b/src/templates/qquickswitch.cpp
index 05422d8d..9acbc0f8 100644
--- a/src/templates/qquickswitch.cpp
+++ b/src/templates/qquickswitch.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickSwitch
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-buttons
- \brief A switch control.
+ \brief An option button that can be toggled on or off.
\image qtlabscontrols-switch.gif
diff --git a/src/templates/qquicktabbar.cpp b/src/templates/qquicktabbar.cpp
index 5b6ac890..00567019 100644
--- a/src/templates/qquicktabbar.cpp
+++ b/src/templates/qquicktabbar.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-navigation
\ingroup qtlabscontrols-containers
- \brief A tab bar control.
+ \brief A bar with icons allowing to switch between different views or subtasks.
TabBar provides a tab-based navigation model.
diff --git a/src/templates/qquicktabbutton.cpp b/src/templates/qquicktabbutton.cpp
index a70dcbe1..58eb9b85 100644
--- a/src/templates/qquicktabbutton.cpp
+++ b/src/templates/qquicktabbutton.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickTabButton
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-navigation
- \brief A tab button control.
+ \brief A tab button control that can be found on a TabBar.
\image qtlabscontrols-tabbutton.png
diff --git a/src/templates/qquicktoolbar.cpp b/src/templates/qquicktoolbar.cpp
index d093b431..6bc8f4d9 100644
--- a/src/templates/qquicktoolbar.cpp
+++ b/src/templates/qquicktoolbar.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickToolBar
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-containers
- \brief A tool bar control.
+ \brief A container with context-sensitive controls.
ToolBar is a container of application-wide and context sensitive
actions and controls, such as navigation buttons and search fields.
diff --git a/src/templates/qquicktoolbutton.cpp b/src/templates/qquicktoolbutton.cpp
index 775eedd1..d04358f5 100644
--- a/src/templates/qquicktoolbutton.cpp
+++ b/src/templates/qquicktoolbutton.cpp
@@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickToolButton
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-buttons
- \brief A tool button control.
+ \brief A button with a layout suitable for a ToolBar.
ToolButton is functionally similar to \l Button, but provides a look that
is more suitable within a \l ToolBar.