Doc: Fix documentation warnings for Qt Quick Controls 2
- The correct module header name is QtQuickControls2 - Add dependency to qtgraphicaleffetcs - RangeSlider: Move \qmlsignal commands out of \qmlpropertygroup - Fix linking to content[Width|Height] for ScrollView Change-Id: I1636fef5f4365a8e9f80b0b8df17e78999bfd3f8 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
This commit is contained in:
parent
e23d4b68f3
commit
335314146d
|
@ -1,6 +1,8 @@
|
||||||
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
|
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
|
||||||
include(manifest-meta.qdocconf)
|
include(manifest-meta.qdocconf)
|
||||||
|
|
||||||
|
moduleheader = QtQuickControls2
|
||||||
|
|
||||||
project = QtQuickControls
|
project = QtQuickControls
|
||||||
description = Qt Quick Controls Reference Documentation
|
description = Qt Quick Controls Reference Documentation
|
||||||
version = $QT_VERSION
|
version = $QT_VERSION
|
||||||
|
@ -31,7 +33,7 @@ qhp.QtQuickControls.subprojects.examples.title = Examples
|
||||||
qhp.QtQuickControls.subprojects.examples.indexTitle = Qt Quick Controls Examples
|
qhp.QtQuickControls.subprojects.examples.indexTitle = Qt Quick Controls Examples
|
||||||
qhp.QtQuickControls.subprojects.examples.selectors = fake:example
|
qhp.QtQuickControls.subprojects.examples.selectors = fake:example
|
||||||
|
|
||||||
depends = qtcore qtgui qtdoc qtqml qtquick qtquickdialogs qtquickcontrols1 qtquickextras qmake qtsql qtwidgets qtlabscalendar qtlabsplatform
|
depends = qtcore qtgui qtdoc qtqml qtquick qtquickdialogs qtquickcontrols1 qtquickextras qmake qtsql qtwidgets qtlabscalendar qtlabsplatform qtgraphicaleffects
|
||||||
|
|
||||||
# Specify the install path under QT_INSTALL_EXAMPLES
|
# Specify the install path under QT_INSTALL_EXAMPLES
|
||||||
# Note: paths passed to \example command must contain the parent directory, e.g.
|
# Note: paths passed to \example command must contain the parent directory, e.g.
|
||||||
|
|
|
@ -752,7 +752,6 @@ qreal QQuickRangeSlider::valueAt(qreal position) const
|
||||||
\qmlproperty bool QtQuick.Controls::RangeSlider::first.hovered
|
\qmlproperty bool QtQuick.Controls::RangeSlider::first.hovered
|
||||||
\qmlproperty real QtQuick.Controls::RangeSlider::first.implicitHandleWidth
|
\qmlproperty real QtQuick.Controls::RangeSlider::first.implicitHandleWidth
|
||||||
\qmlproperty real QtQuick.Controls::RangeSlider::first.implicitHandleHeight
|
\qmlproperty real QtQuick.Controls::RangeSlider::first.implicitHandleHeight
|
||||||
\qmlsignal void QtQuick.Controls::RangeSlider::moved()
|
|
||||||
|
|
||||||
\table
|
\table
|
||||||
\header
|
\header
|
||||||
|
@ -801,15 +800,9 @@ qreal QQuickRangeSlider::valueAt(qreal position) const
|
||||||
\li implicitHandleHeight
|
\li implicitHandleHeight
|
||||||
\li This property holds the implicit height of the first handle.
|
\li This property holds the implicit height of the first handle.
|
||||||
This property was introduced in QtQuick.Controls 2.5.
|
This property was introduced in QtQuick.Controls 2.5.
|
||||||
\row
|
|
||||||
\li moved()
|
|
||||||
\li This signal is emitted when the first handle has been interactively moved
|
|
||||||
by the user by either touch, mouse, or keys.
|
|
||||||
|
|
||||||
This signal was introduced in QtQuick.Controls 2.5.
|
|
||||||
\endtable
|
\endtable
|
||||||
|
|
||||||
\sa first.increase(), first.decrease()
|
\sa first.moved(), first.increase(), first.decrease()
|
||||||
*/
|
*/
|
||||||
QQuickRangeSliderNode *QQuickRangeSlider::first() const
|
QQuickRangeSliderNode *QQuickRangeSlider::first() const
|
||||||
{
|
{
|
||||||
|
@ -817,6 +810,17 @@ QQuickRangeSliderNode *QQuickRangeSlider::first() const
|
||||||
return d->first;
|
return d->first;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\qmlsignal void QtQuick.Controls::RangeSlider::first.moved()
|
||||||
|
\qmlsignal void QtQuick.Controls::RangeSlider::second.moved()
|
||||||
|
\since QtQuick.Controls 2.5
|
||||||
|
|
||||||
|
This signal is emitted when either the first or second handle has been
|
||||||
|
interactively moved by the user by either touch, mouse, or keys.
|
||||||
|
|
||||||
|
\sa first, second
|
||||||
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\qmlpropertygroup QtQuick.Controls::RangeSlider::second
|
\qmlpropertygroup QtQuick.Controls::RangeSlider::second
|
||||||
\qmlproperty real QtQuick.Controls::RangeSlider::second.value
|
\qmlproperty real QtQuick.Controls::RangeSlider::second.value
|
||||||
|
@ -827,7 +831,6 @@ QQuickRangeSliderNode *QQuickRangeSlider::first() const
|
||||||
\qmlproperty bool QtQuick.Controls::RangeSlider::second.hovered
|
\qmlproperty bool QtQuick.Controls::RangeSlider::second.hovered
|
||||||
\qmlproperty real QtQuick.Controls::RangeSlider::second.implicitHandleWidth
|
\qmlproperty real QtQuick.Controls::RangeSlider::second.implicitHandleWidth
|
||||||
\qmlproperty real QtQuick.Controls::RangeSlider::second.implicitHandleHeight
|
\qmlproperty real QtQuick.Controls::RangeSlider::second.implicitHandleHeight
|
||||||
\qmlsignal void QtQuick.Controls::RangeSlider::moved()
|
|
||||||
|
|
||||||
\table
|
\table
|
||||||
\header
|
\header
|
||||||
|
@ -876,15 +879,9 @@ QQuickRangeSliderNode *QQuickRangeSlider::first() const
|
||||||
\li implicitHandleHeight
|
\li implicitHandleHeight
|
||||||
\li This property holds the implicit height of the second handle.
|
\li This property holds the implicit height of the second handle.
|
||||||
This property was introduced in QtQuick.Controls 2.5.
|
This property was introduced in QtQuick.Controls 2.5.
|
||||||
\row
|
|
||||||
\li moved()
|
|
||||||
\li This signal is emitted when the second handle has been interactively moved
|
|
||||||
by the user by either touch, mouse, or keys.
|
|
||||||
|
|
||||||
This signal was introduced in QtQuick.Controls 2.5.
|
|
||||||
\endtable
|
\endtable
|
||||||
|
|
||||||
\sa second.increase(), second.decrease()
|
\sa second.moved(), second.increase(), second.decrease()
|
||||||
*/
|
*/
|
||||||
QQuickRangeSliderNode *QQuickRangeSlider::second() const
|
QQuickRangeSliderNode *QQuickRangeSlider::second() const
|
||||||
{
|
{
|
||||||
|
|
|
@ -78,7 +78,8 @@ QT_BEGIN_NAMESPACE
|
||||||
\li If only a single item is used within a ScrollView, the content size is
|
\li If only a single item is used within a ScrollView, the content size is
|
||||||
automatically calculated based on the implicit size of its contained item.
|
automatically calculated based on the implicit size of its contained item.
|
||||||
However, if more than one item is used (or an implicit size is not
|
However, if more than one item is used (or an implicit size is not
|
||||||
provided), the \l contentWidth and \l contentHeight properties must
|
provided), the \l {QtQuick.Controls::Pane::}{contentWidth} and
|
||||||
|
\l {QtQuick.Controls::Pane::}{contentHeight} properties must
|
||||||
be set to the combined size of its contained items.
|
be set to the combined size of its contained items.
|
||||||
\li If the content size is less than or equal to the size of the ScrollView,
|
\li If the content size is less than or equal to the size of the ScrollView,
|
||||||
it will not be flickable.
|
it will not be flickable.
|
||||||
|
|
Loading…
Reference in New Issue