aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2023-06-08 09:04:15 +0000
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2023-06-09 18:09:16 +0000
commit37f2c26a951415a530449b626adaf15fb35199e5 (patch)
tree64084ad0fa3727509648548e6b9bc027ab210e84
parent8bdfc425f844b2727ac135b10bd84fc282901feb (diff)
Doc: Use correct module identifiers in \qmlproperty commands
Multiple \qmlproperty commands used a QML module identifier different to what their parent \qmltype uses in \inqmlmodule. With upcoming changes to QDoc these will result in documentation warnings. Change-Id: I07cde85801506b374a9781ae79d211813d5dad4f Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> (cherry picked from commit 9aa13dd02b27fd39f624c824551fd0d520f9ffb6) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/labs/models/qqmldelegatecomponent.cpp14
-rw-r--r--src/qmlmodels/qqmlinstantiator.cpp18
-rw-r--r--src/qmlmodels/qquickpackage.cpp2
-rw-r--r--src/qmlxmllistmodel/qqmlxmllistmodel.cpp2
-rw-r--r--src/quick/items/qquickwindow.cpp30
-rw-r--r--src/quicktemplates/qquickheaderview.cpp12
-rw-r--r--src/quicktemplates/qquickselectionrectangle.cpp4
7 files changed, 41 insertions, 41 deletions
diff --git a/src/labs/models/qqmldelegatecomponent.cpp b/src/labs/models/qqmldelegatecomponent.cpp
index 3a9bb647c6..239e61daec 100644
--- a/src/labs/models/qqmldelegatecomponent.cpp
+++ b/src/labs/models/qqmldelegatecomponent.cpp
@@ -21,7 +21,7 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmlproperty variant QtQml.Models::DelegateChoice::roleValue
+ \qmlproperty variant Qt.labs.qmlmodels::DelegateChoice::roleValue
This property holds the value used to match the role data for the role provided by \l DelegateChooser::role.
*/
QVariant QQmlDelegateChoice::roleValue() const
@@ -39,7 +39,7 @@ void QQmlDelegateChoice::setRoleValue(const QVariant &value)
}
/*!
- \qmlproperty int QtQml.Models::DelegateChoice::row
+ \qmlproperty int Qt.labs.qmlmodels::DelegateChoice::row
This property holds the value used to match the row value of model elements.
With models that have only the index property (and thus only one column), this property
should be intended as an index, and set to the desired index value.
@@ -51,7 +51,7 @@ void QQmlDelegateChoice::setRoleValue(const QVariant &value)
*/
/*!
- \qmlproperty int QtQml.Models::DelegateChoice::index
+ \qmlproperty int Qt.labs.qmlmodels::DelegateChoice::index
This property holds the value used to match the index value of model elements.
This is effectively an alias for \l row.
@@ -73,7 +73,7 @@ void QQmlDelegateChoice::setRow(int r)
}
/*!
- \qmlproperty int QtQml.Models::DelegateChoice::column
+ \qmlproperty int Qt.labs.qmlmodels::DelegateChoice::column
This property holds the value used to match the column value of model elements.
*/
int QQmlDelegateChoice::column() const
@@ -96,7 +96,7 @@ QQmlComponent *QQmlDelegateChoice::delegate() const
}
/*!
- \qmlproperty Component QtQml.Models::DelegateChoice::delegate
+ \qmlproperty Component Qt.labs.qmlmodels::DelegateChoice::delegate
This property holds the delegate to use if this choice matches the model item.
*/
void QQmlDelegateChoice::setDelegate(QQmlComponent *delegate)
@@ -190,7 +190,7 @@ bool QQmlDelegateChoice::match(int row, int column, const QVariant &value) const
*/
/*!
- \qmlproperty string QtQml.Models::DelegateChooser::role
+ \qmlproperty string Qt.labs.qmlmodels::DelegateChooser::role
This property holds the role or the property name used to determine the delegate for a given model item.
\sa DelegateChoice
@@ -204,7 +204,7 @@ void QQmlDelegateChooser::setRole(const QString &role)
}
/*!
- \qmlproperty list<DelegateChoice> QtQml.Models::DelegateChooser::choices
+ \qmlproperty list<DelegateChoice> Qt.labs.qmlmodels::DelegateChooser::choices
\qmldefault
The list of DelegateChoices for the chooser.
diff --git a/src/qmlmodels/qqmlinstantiator.cpp b/src/qmlmodels/qqmlinstantiator.cpp
index fca56dd45a..329c644a01 100644
--- a/src/qmlmodels/qqmlinstantiator.cpp
+++ b/src/qmlmodels/qqmlinstantiator.cpp
@@ -210,7 +210,7 @@ QQmlInstantiator::~QQmlInstantiator()
}
/*!
- \qmlsignal QtQml::Instantiator::objectAdded(int index, QtObject object)
+ \qmlsignal QtQml.Models::Instantiator::objectAdded(int index, QtObject object)
This signal is emitted when an object is added to the Instantiator. The \a index
parameter holds the index which the object has been given, and the \a object
@@ -218,7 +218,7 @@ QQmlInstantiator::~QQmlInstantiator()
*/
/*!
- \qmlsignal QtQml::Instantiator::objectRemoved(int index, QtObject object)
+ \qmlsignal QtQml.Models::Instantiator::objectRemoved(int index, QtObject object)
This signal is emitted when an object is removed from the Instantiator. The \a index
parameter holds the index which the object had been given, and the \a object
@@ -228,7 +228,7 @@ QQmlInstantiator::~QQmlInstantiator()
in these cases it will be deleted shortly after the signal is handled.
*/
/*!
- \qmlproperty bool QtQml::Instantiator::active
+ \qmlproperty bool QtQml.Models::Instantiator::active
When active is true, and the delegate component is ready, the Instantiator will
create objects according to the model. When active is false, no objects
@@ -253,7 +253,7 @@ void QQmlInstantiator::setActive(bool newVal)
}
/*!
- \qmlproperty bool QtQml::Instantiator::asynchronous
+ \qmlproperty bool QtQml.Models::Instantiator::asynchronous
When asynchronous is true the Instantiator will attempt to create objects
asynchronously. This means that objects may not be available immediately,
@@ -280,7 +280,7 @@ void QQmlInstantiator::setAsync(bool newVal)
/*!
- \qmlproperty int QtQml::Instantiator::count
+ \qmlproperty int QtQml.Models::Instantiator::count
The number of objects the Instantiator is currently managing.
*/
@@ -292,7 +292,7 @@ int QQmlInstantiator::count() const
}
/*!
- \qmlproperty QtQml::Component QtQml::Instantiator::delegate
+ \qmlproperty QtQml::Component QtQml.Models::Instantiator::delegate
\qmldefault
The component used to create all objects.
@@ -331,7 +331,7 @@ void QQmlInstantiator::setDelegate(QQmlComponent* c)
}
/*!
- \qmlproperty variant QtQml::Instantiator::model
+ \qmlproperty variant QtQml.Models::Instantiator::model
This property can be set to any of the supported \l {qml-data-models}{data models}:
@@ -412,7 +412,7 @@ void QQmlInstantiator::setModel(const QVariant &v)
}
/*!
- \qmlproperty QtObject QtQml::Instantiator::object
+ \qmlproperty QtObject QtQml.Models::Instantiator::object
This is a reference to the first created object, intended as a convenience
for the case where only one object has been created.
@@ -426,7 +426,7 @@ QObject *QQmlInstantiator::object() const
}
/*!
- \qmlmethod QtObject QtQml::Instantiator::objectAt(int index)
+ \qmlmethod QtObject QtQml.Models::Instantiator::objectAt(int index)
Returns a reference to the object with the given \a index.
*/
diff --git a/src/qmlmodels/qquickpackage.cpp b/src/qmlmodels/qquickpackage.cpp
index 70a3a6c19b..2d05976662 100644
--- a/src/qmlmodels/qquickpackage.cpp
+++ b/src/qmlmodels/qquickpackage.cpp
@@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmlattachedproperty string QtQuick::Package::name
+ \qmlattachedproperty string QtQml.Models::Package::name
This attached property holds the name of an item within a Package.
*/
diff --git a/src/qmlxmllistmodel/qqmlxmllistmodel.cpp b/src/qmlxmllistmodel/qqmlxmllistmodel.cpp
index a0cf78aab1..2030ef4792 100644
--- a/src/qmlxmllistmodel/qqmlxmllistmodel.cpp
+++ b/src/qmlxmllistmodel/qqmlxmllistmodel.cpp
@@ -594,7 +594,7 @@ qreal QQmlXmlListModel::progress() const
}
/*!
- \qmlmethod QtQuick.XmlListModel::XmlListModel::errorString()
+ \qmlmethod QtQml.XmlListModel::XmlListModel::errorString()
Returns a string description of the last error that occurred
if \l status is \l {XmlListModel}.Error.
diff --git a/src/quick/items/qquickwindow.cpp b/src/quick/items/qquickwindow.cpp
index d9084f1535..7221555ea0 100644
--- a/src/quick/items/qquickwindow.cpp
+++ b/src/quick/items/qquickwindow.cpp
@@ -2264,7 +2264,7 @@ bool QQuickWindow::isSceneGraphInitialized() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::frameSwapped()
+ \qmlsignal QtQuick::Window::frameSwapped()
This signal is emitted when a frame has been queued for presenting. With
vertical synchronization enabled the signal is emitted at most once per
@@ -2280,7 +2280,7 @@ bool QQuickWindow::isSceneGraphInitialized() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::sceneGraphInitialized()
+ \qmlsignal QtQuick::Window::sceneGraphInitialized()
\internal
*/
@@ -2302,7 +2302,7 @@ bool QQuickWindow::isSceneGraphInitialized() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::sceneGraphInvalidated()
+ \qmlsignal QtQuick::Window::sceneGraphInvalidated()
\internal
*/
@@ -2322,7 +2322,7 @@ bool QQuickWindow::isSceneGraphInitialized() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::sceneGraphError(SceneGraphError error, QString message)
+ \qmlsignal QtQuick::Window::sceneGraphError(SceneGraphError error, QString message)
This signal is emitted when an \a error occurred during scene graph initialization.
@@ -2379,7 +2379,7 @@ bool QQuickWindow::isSceneGraphInitialized() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::closing(CloseEvent close)
+ \qmlsignal QtQuick::Window::closing(CloseEvent close)
\since 5.1
This signal is emitted when the user tries to close the window.
@@ -2691,7 +2691,7 @@ QQmlIncubationController *QQuickWindow::incubationController() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::beforeSynchronizing()
+ \qmlsignal QtQuick::Window::beforeSynchronizing()
\internal
*/
@@ -2718,7 +2718,7 @@ QQmlIncubationController *QQuickWindow::incubationController() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::afterSynchronizing()
+ \qmlsignal QtQuick::Window::afterSynchronizing()
\internal
\since 5.3
*/
@@ -2754,7 +2754,7 @@ QQmlIncubationController *QQuickWindow::incubationController() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::beforeRendering()
+ \qmlsignal QtQuick::Window::beforeRendering()
\internal
*/
@@ -2789,7 +2789,7 @@ QQmlIncubationController *QQuickWindow::incubationController() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::afterRendering()
+ \qmlsignal QtQuick::Window::afterRendering()
\internal
*/
@@ -2822,7 +2822,7 @@ QQmlIncubationController *QQuickWindow::incubationController() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::beforeRenderPassRecording()
+ \qmlsignal QtQuick::Window::beforeRenderPassRecording()
\internal
\since 5.14
*/
@@ -2877,7 +2877,7 @@ QQmlIncubationController *QQuickWindow::incubationController() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::beforeFrameBegin()
+ \qmlsignal QtQuick::Window::beforeFrameBegin()
\internal
*/
@@ -2902,12 +2902,12 @@ QQmlIncubationController *QQuickWindow::incubationController() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::afterFrameEnd()
+ \qmlsignal QtQuick::Window::afterFrameEnd()
\internal
*/
/*!
- \qmlsignal QtQuick.Window::Window::afterRenderPassRecording()
+ \qmlsignal QtQuick::Window::afterRenderPassRecording()
\internal
\since 5.14
*/
@@ -2927,7 +2927,7 @@ QQmlIncubationController *QQuickWindow::incubationController() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::afterAnimating()
+ \qmlsignal QtQuick::Window::afterAnimating()
This signal is emitted on the GUI thread before requesting the render thread to
perform the synchronization of the scene graph.
@@ -2961,7 +2961,7 @@ QQmlIncubationController *QQuickWindow::incubationController() const
*/
/*!
- \qmlsignal QtQuick.Window::Window::sceneGraphAboutToStop()
+ \qmlsignal QtQuick::Window::sceneGraphAboutToStop()
\internal
\since 5.3
*/
diff --git a/src/quicktemplates/qquickheaderview.cpp b/src/quicktemplates/qquickheaderview.cpp
index 576e1c97fa..3a1e56f554 100644
--- a/src/quicktemplates/qquickheaderview.cpp
+++ b/src/quicktemplates/qquickheaderview.cpp
@@ -83,7 +83,7 @@
*/
/*!
- \qmlproperty TableView QtQuick::HorizontalHeaderView::syncView
+ \qmlproperty TableView QtQuick.Controls::HorizontalHeaderView::syncView
This property holds the TableView to synchronize with.
@@ -98,7 +98,7 @@
*/
/*!
- \qmlproperty TableView QtQuick::VerticalHeaderView::syncView
+ \qmlproperty TableView QtQuick.Controls::VerticalHeaderView::syncView
This property holds the TableView to synchronize with.
@@ -113,7 +113,7 @@
*/
/*!
- \qmlproperty QVariant QtQuick::HorizontalHeaderView::model
+ \qmlproperty QVariant QtQuick.Controls::HorizontalHeaderView::model
This property holds the model providing data for the horizontal header view.
@@ -132,7 +132,7 @@
*/
/*!
- \qmlproperty QVariant QtQuick::VerticalHeaderView::model
+ \qmlproperty QVariant QtQuick.Controls::VerticalHeaderView::model
This property holds the model providing data for the vertical header view.
@@ -151,7 +151,7 @@
*/
/*!
- \qmlproperty QString QtQuick::HorizontalHeaderView::textRole
+ \qmlproperty QString QtQuick.Controls::HorizontalHeaderView::textRole
This property holds the model role used to display text in each header cell.
@@ -165,7 +165,7 @@
*/
/*!
- \qmlproperty QString QtQuick::VerticalHeaderView::textRole
+ \qmlproperty QString QtQuick.Controls::VerticalHeaderView::textRole
This property holds the model role used to display text in each header cell.
diff --git a/src/quicktemplates/qquickselectionrectangle.cpp b/src/quicktemplates/qquickselectionrectangle.cpp
index 501c724779..97a9c18713 100644
--- a/src/quicktemplates/qquickselectionrectangle.cpp
+++ b/src/quicktemplates/qquickselectionrectangle.cpp
@@ -144,14 +144,14 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmlattachedproperty SelectionRectangle QtQuick::SelectionRectangle::control
+ \qmlattachedproperty SelectionRectangle QtQuick.Controls::SelectionRectangle::control
This attached property holds the SelectionRectangle that manages the delegate instance.
It is attached to each handle instance.
*/
/*!
- \qmlattachedproperty bool QtQuick::SelectionRectangle::dragging
+ \qmlattachedproperty bool QtQuick.Controls::SelectionRectangle::dragging
This attached property will be \c true if the user is dragging on the handle.
It is attached to each handle instance.