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>

4 files changed, 9 insertions, 9 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.
diff --git a/src/particles/qquickitemparticle.cpp b/src/particles/qquickitemparticle.cpp
index bd4168eac3..d7dbbefc42 100644
--- a/src/particles/qquickitemparticle.cpp
+++ b/src/particles/qquickitemparticle.cpp
@@ -60,19 +60,19 @@ QT_BEGIN_NAMESPACE
 
 
 /*!
-    \qmlmethod void QtQuick.Particles2::ItemParticle::freeze(Item item)
+    \qmlmethod QtQuick.Particles2::ItemParticle::freeze(Item item)
 
     Suspends the flow of time for the logical particle which item represents, allowing you to control its movement.
 */
 
 /*!
-    \qmlmethod void QtQuick.Particles2::ItemParticle::unfreeze(Item item)
+    \qmlmethod QtQuick.Particles2::ItemParticle::unfreeze(Item item)
 
     Restarts the flow of time for the logical particle which item represents, allowing it to be moved by the particle system again.
 */
 
 /*!
-    \qmlmethod void QtQuick.Particles2::ItemParticle::take(Item item, bool prioritize)
+    \qmlmethod QtQuick.Particles2::ItemParticle::take(Item item, bool prioritize)
 
     Asks the ItemParticle to take over control of item. It will be emitted when there is a logical particle available.
 
@@ -80,7 +80,7 @@ QT_BEGIN_NAMESPACE
     head of the queue.
 */
 /*!
-    \qmlmethod void QtQuick.Particles2::ItemParticle::give(Item item)
+    \qmlmethod QtQuick.Particles2::ItemParticle::give(Item item)
 
     Orders the ItemParticle to give you control of the item. It will cease controlling it and the item will lose its association to the logical particle.
 */
diff --git a/src/particles/qquickparticleaffector.cpp b/src/particles/qquickparticleaffector.cpp
index 29f88fb5f8..94c2573bfa 100644
--- a/src/particles/qquickparticleaffector.cpp
+++ b/src/particles/qquickparticleaffector.cpp
@@ -115,15 +115,15 @@ QT_BEGIN_NAMESPACE
     non-rectangular area.
 */
 /*!
-    \qmlsignal QtQuick.Particles2::Affector::affected(real x, real y)
+    \qmlsignal QtQuick.Particles2::Affector::onAffected(real x, real y)
 
     This handler is called when a particle is selected to be affected. It will not be called
     if a particle is considered by the Affector but not actually altered in any way.
 
     In the special case where an Affector has no possible effect (e.g. Affector {}), affected
     will be emitted for all particles being considered if you connect to it. This allows you to
-    execute arbitrary code in response to particles (use the \l {QtQuick.Particles2::Affector::affectParticles}
-    {affectParticles} signal handler if you want to execute code which affects the particles
+    execute arbitrary code in response to particles (use the Affector::onAffectParticles
+    signal handler if you want to execute code which affects the particles
     themselves). As this executes JavaScript code per particle, it is not recommended to use this
     signal with a high-volume particle system.
 
diff --git a/src/particles/qquicktrailemitter.cpp b/src/particles/qquicktrailemitter.cpp
index 2371a5e548..9d0ad37b72 100644
--- a/src/particles/qquicktrailemitter.cpp
+++ b/src/particles/qquicktrailemitter.cpp
@@ -119,7 +119,7 @@ QQuickTrailEmitter::QQuickTrailEmitter(QQuickItem *parent) :
     \qmlproperty real QtQuick.Particles2::TrailEmitter::emitRatePerParticle
 */
 /*!
-    \qmlsignal QtQuick.Particles2::TrailEmitter::emitFollowParticles(Array particles, Particle followed)
+    \qmlsignal QtQuick.Particles2::TrailEmitter::onEmitFollowParticles(Array particles, Particle followed)
 
     This handler is called when particles are emitted from the \a followed particle. \a particles contains an array of particle objects which can be directly manipulated.