Augment Documentation

Change-Id: Ie76de2631521cd3e50aa56f6b134fa33682b81cd
Reviewed-on: http://codereview.qt-project.org/5208
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Damian Jansen <damian.jansen@nokia.com>

diff --git a/src/declarative/particles/qsgparticleaffector.cpp b/src/declarative/particles/qsgparticleaffector.cpp
index ac2d0ab..12b8135 100644 (file)
--- a/src/declarative/particles/qsgparticleaffector.cpp
+++ b/src/declarative/particles/qsgparticleaffector.cpp
@@ -65,11 +65,17 @@ QT_BEGIN_NAMESPACE
     If empty, it will affect all particles.
 */
 /*!
-    \qmlproperty list<string> QtQuick.Particles2::Affector::collisionParticles
+    \qmlproperty list<string> QtQuick.Particles2::Affector::whenCollidingWith
     If any logical particle groups are specified here, then the affector
     will only be triggered if the particle being examined intersects with
     a particle of one of these groups.
 
+    This is different from the groups property. The groups property selects which
+    particles might be examined, and if they meet other criteria (including being
+    within the bounds of the Affector, modified by shape) then they will be tested
+    again to see if they intersect with a particles from one of the particle groups
+    in whenCollidingWith.
+
     By default, no groups are specified.
 */
 /*!