diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2023-07-04 10:55:59 +0000 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-07-05 14:33:03 +0000 |
| commit | b48b689e68c492f69b9b9bc4a0ecd00491e7cab4 (patch) | |
| tree | 89743c8584ac6f8ff444ccb967a1079a086e898a | |
| parent | d4f85c5db27c17de12391ea6ddd17e5e247eab1b (diff) | |
Doc: Fix documentation issues for Affector and PathView QML types
qquickcustomaffector.cpp:13:
(qdoc) warning: Undocumented parameter 'particles' in
Affector::affectParticles().
(qdoc) warning: Undocumented parameter 'dt' in
Affector::affectParticles().
qquickpathview.cpp:1511:
(qdoc) warning: No such type 'QQuickPathView' in QML
module 'QtQuick.
Change-Id: I0c21af05781dcfaf0e76b4cdf7406a97d7bc20d2
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
(cherry picked from commit 1cf5665e1590b93ecc5abea099cdb86573f60f18)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/particles/qquickcustomaffector.cpp | 13 | ||||
| -rw-r--r-- | src/quick/items/qquickpathview.cpp | 2 |
2 files changed, 8 insertions, 7 deletions
diff --git a/src/particles/qquickcustomaffector.cpp b/src/particles/qquickcustomaffector.cpp index 71ada8a5b9..d34e256e40 100644 --- a/src/particles/qquickcustomaffector.cpp +++ b/src/particles/qquickcustomaffector.cpp @@ -13,14 +13,15 @@ QT_BEGIN_NAMESPACE /*! \qmlsignal QtQuick.Particles::Affector::affectParticles(Array particles, real dt) - This signal is emitted when particles are selected to be affected. particles contains - an array of particle objects which can be directly manipulated. + This signal is emitted when particles are selected to be affected. + \a particles is an array of particle objects which can be directly + manipulated. - dt is the time since the last time it was affected. Use dt to normalize - trajectory manipulations to real time. + \a dt is the time since the last time it was affected. Use \a dt to + normalize trajectory manipulations to real time. - Note that JavaScript is slower to execute, so it is not recommended to use this in - high-volume particle systems. + \note JavaScript is slower to execute, so it is not recommended to use + this in high-volume particle systems. */ /*! diff --git a/src/quick/items/qquickpathview.cpp b/src/quick/items/qquickpathview.cpp index 47aad50b2b..4b87f7b5f7 100644 --- a/src/quick/items/qquickpathview.cpp +++ b/src/quick/items/qquickpathview.cpp @@ -1503,7 +1503,7 @@ QQuickItem *QQuickPathView::itemAt(qreal x, qreal y) const } /*! - \qmlmethod Item QtQuick::QQuickPathView::itemAtIndex(int index) + \qmlmethod Item QtQuick::PathView::itemAtIndex(int index) Returns the item for \a index. If there is no item for that index, for example because it has not been created yet, or because it has been panned out of |