Augment SpringAnimation::damping documentation

Task-number: QTBUG-20120

Change-Id: Ifaa0e7eaa0f61052680338a6cfd35bb6aca63157
Reviewed-on: http://codereview.qt.nokia.com/2333
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Martin Jones <martin.jones@nokia.com>

diff --git a/src/qtquick1/util/qdeclarativespringanimation.cpp b/src/qtquick1/util/qdeclarativespringanimation.cpp
index 6d950c8..d6dd68c 100644 (file)
--- a/src/qtquick1/util/qdeclarativespringanimation.cpp
+++ b/src/qtquick1/util/qdeclarativespringanimation.cpp
@@ -325,11 +325,13 @@ void QDeclarative1SpringAnimation::setSpring(qreal spring)
     \qmlproperty real QtQuick1::SpringAnimation::damping
     This property holds the spring damping value.
 
-    This value describes how quickly the spring-like motion comes to rest.
+    This parameter can be used to tweak the spring behaviour by exerting a resisting force
+    (like friction).
+
     The default value is 0.
 
-    The useful value range is 0 - 1.0. The lower the value, the faster it
-    comes to rest.
+    The useful value range is 0 - 1.0. The higher the value, the faster it
+    usually comes to rest.
 */
 qreal QDeclarative1SpringAnimation::damping() const
 {