diff options
author | J-P Nurmi <jpnurmi@qt.io> | 2016-11-02 11:09:35 +0100 |
---|---|---|
committer | J-P Nurmi <jpnurmi@qt.io> | 2016-11-02 11:03:56 +0000 |
commit | 43419084fe3c7489adcca3307b2643f70bd7094c (patch) | |
tree | b99b2c6093eb564d14ce3ea5f10e339c62680dad /src | |
parent | ac53939d496c2b3802f785d2bdf0047ecad7f876 (diff) |
Doc: revise brief descriptions
Change-Id: If7bdd4c11aaeb2df87622c769b1a65ac82ac7e73
Task-number: QTBUG-55904
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src')
37 files changed, 37 insertions, 37 deletions
diff --git a/src/quicktemplates2/qquickabstractbutton.cpp b/src/quicktemplates2/qquickabstractbutton.cpp index 7e8c6ced..d922cfb1 100644 --- a/src/quicktemplates2/qquickabstractbutton.cpp +++ b/src/quicktemplates2/qquickabstractbutton.cpp @@ -56,7 +56,7 @@ static const int AUTO_REPEAT_INTERVAL = 100; \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-buttons - \brief Base type of all button controls. + \brief Abstract base type providing functionality common to buttons. AbstractButton provides the interface for controls with button-like behavior; for example, push buttons and checkable controls like diff --git a/src/quicktemplates2/qquickapplicationwindow.cpp b/src/quicktemplates2/qquickapplicationwindow.cpp index f70a6fc1..3a454353 100644 --- a/src/quicktemplates2/qquickapplicationwindow.cpp +++ b/src/quicktemplates2/qquickapplicationwindow.cpp @@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-containers - \brief Provides a top-level application window. + \brief Styled top-level window with support for a header and footer. ApplicationWindow is a \l Window which makes it convenient to add a \l header and \l footer item to the window. diff --git a/src/quicktemplates2/qquickbusyindicator.cpp b/src/quicktemplates2/qquickbusyindicator.cpp index dc7acbd4..2cd3f62d 100644 --- a/src/quicktemplates2/qquickbusyindicator.cpp +++ b/src/quicktemplates2/qquickbusyindicator.cpp @@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-indicators - \brief Indicates activity while content is being loaded. + \brief Indicates background activity, for example, while content is being loaded. \image qtquickcontrols2-busyindicator.gif diff --git a/src/quicktemplates2/qquickbutton.cpp b/src/quicktemplates2/qquickbutton.cpp index fc34aba4..ca6d4551 100644 --- a/src/quicktemplates2/qquickbutton.cpp +++ b/src/quicktemplates2/qquickbutton.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-buttons - \brief A push-button control that can be clicked by the user. + \brief Push-button that can be clicked to perform a command or answer a question. \image qtquickcontrols2-button.gif diff --git a/src/quicktemplates2/qquickbuttongroup.cpp b/src/quicktemplates2/qquickbuttongroup.cpp index 3d3e9c05..6ed75a2b 100644 --- a/src/quicktemplates2/qquickbuttongroup.cpp +++ b/src/quicktemplates2/qquickbuttongroup.cpp @@ -52,7 +52,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup utilities - \brief A mutually-exclusive group of checkable controls. + \brief Mutually-exclusive group of checkable buttons. 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/quicktemplates2/qquickcheckbox.cpp b/src/quicktemplates2/qquickcheckbox.cpp index ae967c34..fd5ab6ba 100644 --- a/src/quicktemplates2/qquickcheckbox.cpp +++ b/src/quicktemplates2/qquickcheckbox.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-buttons - \brief An option button that can be checked or unchecked. + \brief Check button that can be toggled on or off. \image qtquickcontrols2-checkbox.gif diff --git a/src/quicktemplates2/qquickcheckdelegate.cpp b/src/quicktemplates2/qquickcheckdelegate.cpp index 304d2b6c..51bc8501 100644 --- a/src/quicktemplates2/qquickcheckdelegate.cpp +++ b/src/quicktemplates2/qquickcheckdelegate.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-delegates - \brief An item delegate that can be checked or unchecked. + \brief Item delegate with a check indicator that can be toggled on or off. \image qtquickcontrols2-checkdelegate.gif diff --git a/src/quicktemplates2/qquickcombobox.cpp b/src/quicktemplates2/qquickcombobox.cpp index 5194582b..442c43a4 100644 --- a/src/quicktemplates2/qquickcombobox.cpp +++ b/src/quicktemplates2/qquickcombobox.cpp @@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-input - \brief A combined button and popup list taking minimal space. + \brief Combined button and popup list for selecting options. \image qtquickcontrols2-combobox.gif diff --git a/src/quicktemplates2/qquickcontainer.cpp b/src/quicktemplates2/qquickcontainer.cpp index be2acf39..c95cfc75 100644 --- a/src/quicktemplates2/qquickcontainer.cpp +++ b/src/quicktemplates2/qquickcontainer.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-containers - \brief A container control base type. + \brief Abstract base type providing functionality common to containers. Container is the base type of container-like user interface controls that allow dynamic insertion and removal of items. diff --git a/src/quicktemplates2/qquickcontrol.cpp b/src/quicktemplates2/qquickcontrol.cpp index f18483e7..cb891ee9 100644 --- a/src/quicktemplates2/qquickcontrol.cpp +++ b/src/quicktemplates2/qquickcontrol.cpp @@ -64,7 +64,7 @@ QT_BEGIN_NAMESPACE \instantiates QQuickControl \inqmlmodule QtQuick.Controls \since 5.7 - \brief The base type of user interface controls. + \brief Abstract base type providing functionality common to all controls. Control is the base type of user interface controls. It receives input events from the window system, and paints a representation of itself on diff --git a/src/quicktemplates2/qquickdial.cpp b/src/quicktemplates2/qquickdial.cpp index abce2e33..22c1133b 100644 --- a/src/quicktemplates2/qquickdial.cpp +++ b/src/quicktemplates2/qquickdial.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-input - \brief A circular dial that is rotated to set a value. + \brief Circular dial that is rotated to set a value. The Dial is similar to a traditional dial knob that is found on devices such as stereos or industrial equipment. It allows the user to specify a diff --git a/src/quicktemplates2/qquickdrawer.cpp b/src/quicktemplates2/qquickdrawer.cpp index d210c015..1dae911e 100644 --- a/src/quicktemplates2/qquickdrawer.cpp +++ b/src/quicktemplates2/qquickdrawer.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE \since 5.7 \ingroup qtquickcontrols2-navigation \ingroup qtquickcontrols2-popups - \brief Provides a swipe-based side panel. + \brief Side panel that can be opened and closed using a swipe gesture. 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/quicktemplates2/qquickframe.cpp b/src/quicktemplates2/qquickframe.cpp index d51ea60a..9deef6be 100644 --- a/src/quicktemplates2/qquickframe.cpp +++ b/src/quicktemplates2/qquickframe.cpp @@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-containers - \brief A logical group of controls within a visual frame. + \brief Visual frame for a logical group of controls. 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/quicktemplates2/qquickgroupbox.cpp b/src/quicktemplates2/qquickgroupbox.cpp index 996351a7..dd6d1883 100644 --- a/src/quicktemplates2/qquickgroupbox.cpp +++ b/src/quicktemplates2/qquickgroupbox.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-containers - \brief A logical group of controls within a titled visual frame. + \brief Visual frame and title for a logical group of controls. GroupBox is used to layout a logical group of controls together, within a \l {title}{titled} visual frame. GroupBox does not provide a layout of its own, but diff --git a/src/quicktemplates2/qquickitemdelegate.cpp b/src/quicktemplates2/qquickitemdelegate.cpp index 9b21eb30..411cb224 100644 --- a/src/quicktemplates2/qquickitemdelegate.cpp +++ b/src/quicktemplates2/qquickitemdelegate.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \instantiates QQuickItemDelegate \inqmlmodule QtQuick.Controls \since 5.7 - \brief A standard view item that can be used in various views and controls. + \brief Basic item delegate that can be used in various views and controls. \image qtquickcontrols2-itemdelegate.gif diff --git a/src/quicktemplates2/qquicklabel.cpp b/src/quicktemplates2/qquicklabel.cpp index b3596022..ebd1755a 100644 --- a/src/quicktemplates2/qquicklabel.cpp +++ b/src/quicktemplates2/qquicklabel.cpp @@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup text - \brief A text label with inherited styling and font. + \brief Styled text label with inherited 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/quicktemplates2/qquickmenu.cpp b/src/quicktemplates2/qquickmenu.cpp index 509a4022..2203e574 100644 --- a/src/quicktemplates2/qquickmenu.cpp +++ b/src/quicktemplates2/qquickmenu.cpp @@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE \since 5.7 \ingroup qtquickcontrols2-menus \ingroup qtquickcontrols2-popups - \brief A menu control that can be used as a context menu or popup menu. + \brief Menu popup that can be used as a context menu or popup menu. \image qtquickcontrols2-menu.png diff --git a/src/quicktemplates2/qquickmenuitem.cpp b/src/quicktemplates2/qquickmenuitem.cpp index 902889b0..564d3f38 100644 --- a/src/quicktemplates2/qquickmenuitem.cpp +++ b/src/quicktemplates2/qquickmenuitem.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-menus - \brief A menu item within a Menu. + \brief Presents an item within a Menu. MenuItem is a convenience type that implements the AbstractButton API, providing a familiar way to respond to menu items being \l triggered, for diff --git a/src/quicktemplates2/qquickpage.cpp b/src/quicktemplates2/qquickpage.cpp index a0de71db..c71ecd42 100644 --- a/src/quicktemplates2/qquickpage.cpp +++ b/src/quicktemplates2/qquickpage.cpp @@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-containers - \brief A control that makes it convenient to add a header and footer to a page. + \brief Styled page control with support for a header and footer. 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/quicktemplates2/qquickpopup.cpp b/src/quicktemplates2/qquickpopup.cpp index 10657e90..21303ffe 100644 --- a/src/quicktemplates2/qquickpopup.cpp +++ b/src/quicktemplates2/qquickpopup.cpp @@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-popups - \brief The base type of popup-like user interface controls. + \brief Base type of popup-like user interface controls. Popup is the base type of popup-like user interface controls. It can be used with \l Window or \l ApplicationWindow. diff --git a/src/quicktemplates2/qquickradiobutton.cpp b/src/quicktemplates2/qquickradiobutton.cpp index a8d11377..acddb50d 100644 --- a/src/quicktemplates2/qquickradiobutton.cpp +++ b/src/quicktemplates2/qquickradiobutton.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-buttons - \brief An option button that can be toggled on or off. + \brief Exclusive radio button that can be toggled on or off. \image qtquickcontrols2-radiobutton.gif diff --git a/src/quicktemplates2/qquickradiodelegate.cpp b/src/quicktemplates2/qquickradiodelegate.cpp index bf3557e8..4580dcf2 100644 --- a/src/quicktemplates2/qquickradiodelegate.cpp +++ b/src/quicktemplates2/qquickradiodelegate.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-delegates - \brief An item delegate that can be checked or unchecked. + \brief Exclusive item delegate with a radio indicator that can be toggled on or off. \image qtquickcontrols2-radiodelegate.gif diff --git a/src/quicktemplates2/qquickrangeslider.cpp b/src/quicktemplates2/qquickrangeslider.cpp index 316efb31..17871cfe 100644 --- a/src/quicktemplates2/qquickrangeslider.cpp +++ b/src/quicktemplates2/qquickrangeslider.cpp @@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-input - \brief A slider control used to select a range of values. + \brief Used to select a range of values by sliding two handles along a track. \image qtquickcontrols2-rangeslider.gif diff --git a/src/quicktemplates2/qquickscrollbar.cpp b/src/quicktemplates2/qquickscrollbar.cpp index d3a2355c..5d921fe3 100644 --- a/src/quicktemplates2/qquickscrollbar.cpp +++ b/src/quicktemplates2/qquickscrollbar.cpp @@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-indicators - \brief An interactive scroll bar control. + \brief Vertical or horizontal interactive scroll bar. \image qtquickcontrols2-scrollbar.gif diff --git a/src/quicktemplates2/qquickscrollindicator.cpp b/src/quicktemplates2/qquickscrollindicator.cpp index 91d03ec9..968f671d 100644 --- a/src/quicktemplates2/qquickscrollindicator.cpp +++ b/src/quicktemplates2/qquickscrollindicator.cpp @@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-indicators - \brief A non-interactive scroll indicator control. + \brief Vertical or horizontal non-interactive scroll indicator. \image qtquickcontrols2-scrollindicator.gif diff --git a/src/quicktemplates2/qquickslider.cpp b/src/quicktemplates2/qquickslider.cpp index e0df7e69..e403aa6d 100644 --- a/src/quicktemplates2/qquickslider.cpp +++ b/src/quicktemplates2/qquickslider.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-input - \brief Selects a value by sliding a handle along a track. + \brief Used to select a value by sliding a handle along a track. \image qtquickcontrols2-slider.gif diff --git a/src/quicktemplates2/qquickspinbox.cpp b/src/quicktemplates2/qquickspinbox.cpp index 466f1b89..79ec5da0 100644 --- a/src/quicktemplates2/qquickspinbox.cpp +++ b/src/quicktemplates2/qquickspinbox.cpp @@ -57,7 +57,7 @@ static const int AUTO_REPEAT_INTERVAL = 100; \inqmlmodule QtQuick.Controls \since 5.7 \ingroup input - \brief A spinbox control that allows the user to select from a set of preset values. + \brief Allows the user to select from a set of preset values. \image qtquickcontrols2-spinbox.png diff --git a/src/quicktemplates2/qquickswipedelegate.cpp b/src/quicktemplates2/qquickswipedelegate.cpp index b812f939..3dec1f2e 100644 --- a/src/quicktemplates2/qquickswipedelegate.cpp +++ b/src/quicktemplates2/qquickswipedelegate.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-delegates - \brief A swipable item delegate. + \brief Swipable item delegate. SwipeDelegate presents a view item that can be swiped left or right to expose more options or information. It is used as a delegate in views such diff --git a/src/quicktemplates2/qquickswitch.cpp b/src/quicktemplates2/qquickswitch.cpp index 8c3d9f0b..fa08a1d8 100644 --- a/src/quicktemplates2/qquickswitch.cpp +++ b/src/quicktemplates2/qquickswitch.cpp @@ -51,7 +51,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-buttons - \brief An option button that can be toggled on or off. + \brief Switch button that can be toggled on or off. \image qtquickcontrols2-switch.gif diff --git a/src/quicktemplates2/qquickswitchdelegate.cpp b/src/quicktemplates2/qquickswitchdelegate.cpp index edfb15d5..81e282d9 100644 --- a/src/quicktemplates2/qquickswitchdelegate.cpp +++ b/src/quicktemplates2/qquickswitchdelegate.cpp @@ -47,7 +47,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-delegates - \brief An item delegate that can be toggled on or off. + \brief Item delegate with a switch indicator that can be toggled on or off. \image qtquickcontrols2-switchdelegate.gif diff --git a/src/quicktemplates2/qquicktabbar.cpp b/src/quicktemplates2/qquicktabbar.cpp index 73c7734c..ee3436f9 100644 --- a/src/quicktemplates2/qquicktabbar.cpp +++ b/src/quicktemplates2/qquicktabbar.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \since 5.7 \ingroup qtquickcontrols2-navigation \ingroup qtquickcontrols2-containers - \brief A bar with tabs that allows the user to switch between different views or subtasks. + \brief Allows the user to switch between different views or subtasks. TabBar provides a tab-based navigation model. diff --git a/src/quicktemplates2/qquicktabbutton.cpp b/src/quicktemplates2/qquicktabbutton.cpp index 3f097947..b5cbdd12 100644 --- a/src/quicktemplates2/qquicktabbutton.cpp +++ b/src/quicktemplates2/qquicktabbutton.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-navigation - \brief A tab button control that can be used in a TabBar. + \brief Button with a look suitable for a TabBar. \image qtquickcontrols2-tabbutton.png diff --git a/src/quicktemplates2/qquicktextarea.cpp b/src/quicktemplates2/qquicktextarea.cpp index ee20d477..a66d7bf5 100644 --- a/src/quicktemplates2/qquicktextarea.cpp +++ b/src/quicktemplates2/qquicktextarea.cpp @@ -59,7 +59,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-input - \brief A multi line text input control. + \brief Multi-line text input area. TextArea is a multi-line text editor. TextArea extends TextEdit with a \l {placeholderText}{placeholder text} functionality, and adds decoration. diff --git a/src/quicktemplates2/qquicktextfield.cpp b/src/quicktemplates2/qquicktextfield.cpp index 7882b642..610df907 100644 --- a/src/quicktemplates2/qquicktextfield.cpp +++ b/src/quicktemplates2/qquicktextfield.cpp @@ -58,7 +58,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-input - \brief A single line text input control. + \brief Single-line text input field. TextField is a single line text editor. TextField extends TextInput with a \l {placeholderText}{placeholder text} functionality, and adds decoration. diff --git a/src/quicktemplates2/qquicktoolbar.cpp b/src/quicktemplates2/qquicktoolbar.cpp index e6d705ad..12ecb702 100644 --- a/src/quicktemplates2/qquicktoolbar.cpp +++ b/src/quicktemplates2/qquicktoolbar.cpp @@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-containers - \brief A container for context-sensitive controls. + \brief Container for 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/quicktemplates2/qquicktoolbutton.cpp b/src/quicktemplates2/qquicktoolbutton.cpp index 8009ac28..e8827b4c 100644 --- a/src/quicktemplates2/qquicktoolbutton.cpp +++ b/src/quicktemplates2/qquicktoolbutton.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-buttons - \brief A button with a look suitable for a ToolBar. + \brief Button with a look suitable for a ToolBar. ToolButton is functionally similar to \l Button, but provides a look that is more suitable within a \l ToolBar. diff --git a/src/quicktemplates2/qquicktumbler.cpp b/src/quicktemplates2/qquicktumbler.cpp index ba026571..9f19f661 100644 --- a/src/quicktemplates2/qquicktumbler.cpp +++ b/src/quicktemplates2/qquicktumbler.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \inqmlmodule QtQuick.Controls \since 5.7 \ingroup qtquickcontrols2-input - \brief A spinnable wheel of items that can be selected. + \brief Spinnable wheel of items that can be selected. \image qtquickcontrols2-tumbler-wrap.gif |