aboutsummaryrefslogtreecommitdiffstats
path: root/src/particles/qquickcustomaffector.cpp
diff options
context:
space:
mode:
authorBea Lam <bea.lam@nokia.com>2012-08-06 14:25:24 +1000
committerQt by Nokia <qt-info@nokia.com>2012-08-08 04:11:17 +0200
commitb2120f68683b7948891d72fe077f44ab7e6baf18 (patch)
treeede9def668f55f2f32448700da5e6fdf80b3cad6 /src/particles/qquickcustomaffector.cpp
parentec519529087cc3005d55242569dcbca3dcee91bf (diff)
Fix uses of various qml doc commands
Signals documented with \qmlsignal should indicate handler name, i.e. 'onSignal' rather than 'signal'. Methods documented with \qmlmethod do not need to document 'void' return values. Also the name of any documented attribute should be qualified with 'QtQuick2::<qmltype>'. Change-Id: I206dd9e8f39c3b84e029ae9d4101b05d0bfb3478 Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
Diffstat (limited to 'src/particles/qquickcustomaffector.cpp')
-rw-r--r--src/particles/qquickcustomaffector.cpp2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/particles/qquickcustomaffector.cpp b/src/particles/qquickcustomaffector.cpp
index 0482b2745f..5f013cf108 100644
--- a/src/particles/qquickcustomaffector.cpp
+++ b/src/particles/qquickcustomaffector.cpp
@@ -49,7 +49,7 @@ QT_BEGIN_NAMESPACE
//TODO: Move docs (and inheritence) to real base when docs can propagate. Currently this pretends to be the base class!
/*!
- \qmlsignal QtQuick.Particles2::Affector::affectParticles(Array particles, real dt)
+ \qmlsignal QtQuick.Particles2::Affector::onAffectParticles(Array particles, real dt)
This handler is called when particles are selected to be affected. particles contains
an array of particle objects which can be directly manipulated.