summaryrefslogtreecommitdiff
path: root/src/extras
diff options
context:
space:
mode:
authorCaroline Chao <caroline.chao@theqtcompany.com>2015-03-04 15:31:09 +0100
committerCaroline Chao <caroline.chao@theqtcompany.com>2015-03-06 13:20:40 +0000
commit0e022e36ba45b00986d113cf26161c292adc3a2b (patch)
tree815b7570ac144176702e1f4ab9ac65e7cd6c40a1 /src/extras
parent06e63332054e441ac1c51e19e40399a8accd5db6 (diff)
downloadqtquickcontrols-0e022e36ba45b00986d113cf26161c292adc3a2b.tar.gz
Doc: Fix qtdoc warnings
Mostly link errors and missing documentation. And removed useless references to {QtQuick.Controls.Styles} in the doc. Change-Id: Iad211a574c0bd23c84e067e0cbcc18c3e719cde7 Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/extras')
-rw-r--r--src/extras/CircularGauge.qml16
-rw-r--r--src/extras/DelayButton.qml2
-rw-r--r--src/extras/Dial.qml12
-rw-r--r--src/extras/Gauge.qml4
-rw-r--r--src/extras/PieMenu.qml7
-rw-r--r--src/extras/StatusIndicator.qml2
-rw-r--r--src/extras/ToggleButton.qml2
-rw-r--r--src/extras/Tumbler.qml6
-rw-r--r--src/extras/TumblerColumn.qml14
-rw-r--r--src/extras/doc/src/qtquickextras-examples.qdoc6
10 files changed, 35 insertions, 36 deletions
diff --git a/src/extras/CircularGauge.qml b/src/extras/CircularGauge.qml
index 426d6e49..c3bb7fff 100644
--- a/src/extras/CircularGauge.qml
+++ b/src/extras/CircularGauge.qml
@@ -58,9 +58,9 @@ import QtQuick.Extras.Private 1.0
The minimum and maximum values displayable by the gauge can be set with the
\l minimumValue and \l maximumValue properties. The angle at which these
values are displayed can be set with the
- \l {QtQuick.Controls.Styles::CircularGaugeStyle::}{minimumValueAngle} and
- \l {QtQuick.Controls.Styles::CircularGaugeStyle::}{maximumValueAngle} properties of
- \l {QtQuick.Controls.Styles::}{CircularGaugeStyle}.
+ \l {CircularGaugeStyle::}{minimumValueAngle} and
+ \l {CircularGaugeStyle::}{maximumValueAngle} properties of
+ \l {CircularGaugeStyle}.
Example:
\code
@@ -89,7 +89,7 @@ import QtQuick.Extras.Private 1.0
\endcode
You can create a custom appearance for a CircularGauge by assigning a
- \l {QtQuick.Controls.Styles::}{CircularGaugeStyle}.
+ \l {CircularGaugeStyle}.
*/
Control {
@@ -136,13 +136,13 @@ Control {
For more fine-grained control over what is displayed, the following
style components of
- \l {QtQuick.Controls.Styles::}{CircularGaugeStyle} can be
+ \l CircularGaugeStyle can be
used:
\list
- \li \l {QtQuick.Controls.Styles::CircularGaugeStyle::tickmark}{tickmark}
- \li \l {QtQuick.Controls.Styles::CircularGaugeStyle::minorTickmark}{minorTickmark}
- \li \l {QtQuick.Controls.Styles::CircularGaugeStyle::tickmarkLabel}{tickmarkLabel}
+ \li \l {CircularGaugeStyle::}{tickmark}
+ \li \l {CircularGaugeStyle::}{minorTickmark}
+ \li \l {CircularGaugeStyle::}{tickmarkLabel}
\endlist
*/
property bool tickmarksVisible: true
diff --git a/src/extras/DelayButton.qml b/src/extras/DelayButton.qml
index f855e90e..476b7702 100644
--- a/src/extras/DelayButton.qml
+++ b/src/extras/DelayButton.qml
@@ -67,7 +67,7 @@ import QtQuick.Controls.Private 1.0
A DelayButton after being activated
You can create a custom appearance for a DelayButton by assigning a
- \l {QtQuick.Controls.Styles::}{DelayButtonStyle}.
+ \l {DelayButtonStyle}.
*/
Button {
diff --git a/src/extras/Dial.qml b/src/extras/Dial.qml
index 4454c90d..eccab648 100644
--- a/src/extras/Dial.qml
+++ b/src/extras/Dial.qml
@@ -57,11 +57,11 @@ import QtQuick.Extras.Private 1.0
Like CircularGauge, Dial can display tickmarks to give an indication of
the current value. When a suitable stepSize is combined with
- \l {QtQuick.Controls.Styles::DialStyle::}{tickmarkStepSize},
+ \l {DialStyle::}{tickmarkStepSize},
the dial "snaps" to each tickmark.
You can create a custom appearance for a Dial by assigning a
- \l {QtQuick.Controls.Styles::}{DialStyle}.
+ \l {DialStyle}.
*/
Control {
@@ -149,12 +149,12 @@ Control {
For more fine-grained control over what is displayed, the following
style components of
- \l {QtQuick.Controls.Styles::}{DialStyle} can be used:
+ \l {DialStyle} can be used:
\list
- \li \l {QtQuick.Controls.Styles::DialStyle::tickmark}{tickmark}
- \li \l {QtQuick.Controls.Styles::DialStyle::minorTickmark}{minorTickmark}
- \li \l {QtQuick.Controls.Styles::DialStyle::tickmarkLabel}{tickmarkLabel}
+ \li \l {DialStyle::}{tickmark}
+ \li \l {DialStyle::}{minorTickmark}
+ \li \l {DialStyle::}{tickmarkLabel}
\endlist
The default value is \c true.
diff --git a/src/extras/Gauge.qml b/src/extras/Gauge.qml
index f5a0071e..1853af58 100644
--- a/src/extras/Gauge.qml
+++ b/src/extras/Gauge.qml
@@ -70,7 +70,7 @@ import QtQuick.Extras.Private 1.0
\endcode
You can create a custom appearance for a Gauge by assigning a
- \l {QtQuick.Controls.Styles::}{GaugeStyle}.
+ \l {GaugeStyle}.
*/
Control {
@@ -174,7 +174,7 @@ Control {
/*!
This property accepts a function that formats the given \a value for
display in
- \l {QtQuick.Controls.Styles::GaugeStyle}{tickmarkLabel}.
+ \l {GaugeStyle::}{tickmarkLabel}.
For example, to provide a custom format that displays all values with 3
decimal places:
diff --git a/src/extras/PieMenu.qml b/src/extras/PieMenu.qml
index d667a9a8..49698c15 100644
--- a/src/extras/PieMenu.qml
+++ b/src/extras/PieMenu.qml
@@ -147,12 +147,11 @@ import QtQuick.Extras.Private.CppUtils 1.0 as CppUtils
You can hide individual menu items by setting their visible property to
\c false. Hiding items does not affect the
- \l {QtQuick.Controls.Styles::PieMenuStyle::}{startAngle} or
- \l {QtQuick.Controls.Styles::PieMenuStyle::}{endAngle}; the
+ \l {PieMenuStyle::}{startAngle} or
+ \l {PieMenuStyle::}{endAngle}; the
remaining items will grow to consume the available space.
- You can create a custom appearance for a PieMenu by assigning a
- \l {QtQuick.Controls.Styles::}{PieMenuStyle}.
+ You can create a custom appearance for a PieMenu by assigning a \l {PieMenuStyle}
*/
Control {
diff --git a/src/extras/StatusIndicator.qml b/src/extras/StatusIndicator.qml
index a49df496..7348833d 100644
--- a/src/extras/StatusIndicator.qml
+++ b/src/extras/StatusIndicator.qml
@@ -82,7 +82,7 @@ import QtQuick.Extras.Private 1.0
\endtable
You can create a custom appearance for a StatusIndicator by assigning a
- \l {QtQuick.Controls.Styles::}{StatusIndicatorStyle}.
+ \l {StatusIndicatorStyle}.
*/
Control {
diff --git a/src/extras/ToggleButton.qml b/src/extras/ToggleButton.qml
index ca08e36f..a26ac286 100644
--- a/src/extras/ToggleButton.qml
+++ b/src/extras/ToggleButton.qml
@@ -58,7 +58,7 @@ import QtQuick.Controls.Private 1.0
placing color-coded indicators around the button.
You can create a custom appearance for a ToggleButton by assigning a
- \l {QtQuick.Controls.Styles::}{ToggleButtonStyle}.
+ \l {ToggleButtonStyle}.
*/
Button {
diff --git a/src/extras/Tumbler.qml b/src/extras/Tumbler.qml
index 561515b2..4743322b 100644
--- a/src/extras/Tumbler.qml
+++ b/src/extras/Tumbler.qml
@@ -122,13 +122,13 @@ import QtQuick.Layouts 1.0
\section1 Limitations
For technical reasons, the model count must be equal to or greater than
- \l {QtQuick.Controls.Styles::TumblerStyle}{visibleItemCount}
+ \l {TumblerStyle::}{visibleItemCount}
plus one. The
- \l {QtQuick.Controls.Styles::TumblerStyle::}{visibleItemCount}
+ \l {TumblerStyle::}{visibleItemCount}
must also be an odd number.
You can create a custom appearance for a Tumbler by assigning a
- \l {QtQuick.Controls.Styles::}{TumblerStyle}. To style
+ \l {TumblerStyle}. To style
individual columns, use the \l {TumblerColumn::delegate}{delegate} and
\l {TumblerColumn::highlight}{highlight} properties of TumblerColumn.
*/
diff --git a/src/extras/TumblerColumn.qml b/src/extras/TumblerColumn.qml
index 481f0869..6dfecb04 100644
--- a/src/extras/TumblerColumn.qml
+++ b/src/extras/TumblerColumn.qml
@@ -64,7 +64,7 @@ import QtQuick.Controls.Private 1.0
\endcode
You can create a custom appearance for a Tumbler by assigning a
- \l {QtQuick.Controls.Styles::}{TumblerStyle}.
+ \l {TumblerStyle}.
*/
QtObject {
@@ -116,8 +116,8 @@ QtObject {
If set, this delegate will be used to display items in this column,
instead of the
- \l {QtQuick.Controls.Styles::TumblerStyle::delegate}{delegate}
- property in \l {QtQuick.Controls.Styles::}{TumblerStyle}.
+ \l {TumblerStyle::}{delegate}
+ property in \l {TumblerStyle}.
The \l {Item::implicitHeight}{implicitHeight} property must be set,
and it must be the same for each delegate.
@@ -129,8 +129,8 @@ QtObject {
If set, this highlight will be used to display the highlight in this
column, instead of the
- \l {QtQuick.Controls.Styles::TumblerStyle::highlight}{highlight}
- property in \l {QtQuick.Controls.Styles::}{TumblerStyle}.
+ \l {TumblerStyle::}{highlight}
+ property in \l {TumblerStyle}.
*/
property Component highlight
@@ -139,8 +139,8 @@ QtObject {
If set, this component will be used to display the foreground in this
column, instead of the
- \l {QtQuick.Controls.Styles::TumblerStyle::columnForeground}{columnForeground}
- property in \l {QtQuick.Controls.Styles::}{TumblerStyle}.
+ \l {TumblerStyle::}{columnForeground}
+ property in \l {TumblerStyle}.
*/
property Component columnForeground
diff --git a/src/extras/doc/src/qtquickextras-examples.qdoc b/src/extras/doc/src/qtquickextras-examples.qdoc
index c966e48d..41043c86 100644
--- a/src/extras/doc/src/qtquickextras-examples.qdoc
+++ b/src/extras/doc/src/qtquickextras-examples.qdoc
@@ -35,7 +35,7 @@
*/
/*!
- \example extras/gallery
+ \example gallery
\title Qt Quick Extras - Gallery
\ingroup qtquickextras-examples
\brief An interactive showcase of the various controls.
@@ -46,7 +46,7 @@
*/
/*!
- \example extras/dashboard
+ \example dashboard
\title Qt Quick Extras - Dashboard
\ingroup qtquickextras-examples
\brief A car dashboard created using several CircularGauge controls.
@@ -56,7 +56,7 @@
*/
/*!
- \example extras/flat
+ \example flat
\title Qt Quick Extras - Flat
\ingroup qtquickextras-examples
\brief An interactive showcase of the flat style.