aboutsummaryrefslogtreecommitdiffstats
path: root/src/quicktemplates2/qquickgroupbox.cpp
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2016-09-19 10:06:43 +0200
committerMitch Curtis <mitch.curtis@qt.io>2016-09-19 14:00:54 +0000
commit2b0db3a4809e6316114ec65bd55fa80ddefe97c5 (patch)
treeed77d9bc80813f61d34723a750f7b7aff93a5d1d /src/quicktemplates2/qquickgroupbox.cpp
parentba48e1e6ea375af6eb1e0310395c00e3a41770b4 (diff)
GroupBox: fix documentation review findings
Change-Id: I1663fed5d4639d35f93029b64e64f3cd14a8138d Task-number: QTBUG-55904 Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
Diffstat (limited to 'src/quicktemplates2/qquickgroupbox.cpp')
-rw-r--r--src/quicktemplates2/qquickgroupbox.cpp11
1 files changed, 7 insertions, 4 deletions
diff --git a/src/quicktemplates2/qquickgroupbox.cpp b/src/quicktemplates2/qquickgroupbox.cpp
index 45fe406f..27c325ef 100644
--- a/src/quicktemplates2/qquickgroupbox.cpp
+++ b/src/quicktemplates2/qquickgroupbox.cpp
@@ -48,10 +48,10 @@ QT_BEGIN_NAMESPACE
\inqmlmodule QtQuick.Controls
\since 5.7
\ingroup qtquickcontrols2-containers
- \brief A frame with a logical group of controls.
+ \brief A logical group of controls within a titled visual frame.
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
+ a \l {title}{titled} visual frame. GroupBox does not provide a layout of its own, but
requires you to position its contents, for instance by creating a \l RowLayout
or a \l ColumnLayout.
@@ -75,8 +75,8 @@ QT_BEGIN_NAMESPACE
\image qtquickcontrols2-groupbox-checkable.png
It is a common pattern to enable or disable the groupbox's children when
- its checkbox is toggled on or off, but it is the application that decides
- on the behavior of the groupbox.
+ its checkbox is toggled on or off, but it is up to the application to decide
+ on the behavior of the checkbox.
\snippet qtquickcontrols2-groupbox-checkable.qml 1
@@ -101,6 +101,9 @@ QQuickGroupBox::QQuickGroupBox(QQuickItem *parent) :
\qmlproperty string QtQuick.Controls::GroupBox::title
This property holds the title.
+
+ The title is typically displayed above the groupbox to
+ summarize its contents.
*/
QString QQuickGroupBox::title() const
{