Remove "All rights reserved" line from license headers.
[profile/ivi/qtdeclarative.git] / src / qtquick1 / util / qdeclarativespringanimation.cpp
index 8afa5e7..d99f0d0 100644 (file)
@@ -1,8 +1,7 @@
 /****************************************************************************
 **
-** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
-** All rights reserved.
-** Contact: Nokia Corporation (qt-info@nokia.com)
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
 **
 ** This file is part of the QtDeclarative module of the Qt Toolkit.
 **
@@ -35,6 +34,7 @@
 **
 **
 **
+**
 ** $QT_END_LICENSE$
 **
 ****************************************************************************/
@@ -237,9 +237,10 @@ void QDeclarative1SpringAnimationPrivate::updateMode()
 
 /*!
     \qmlclass SpringAnimation QDeclarative1SpringAnimation
+    \inqmlmodule QtQuick 1
     \ingroup qml-animation-transition
     \inherits NumberAnimation
-    \since 4.7
+    \since QtQuick 1.0
 
     \brief The SpringAnimation element allows a property to track a value in a spring-like motion.
 
@@ -253,7 +254,7 @@ void QDeclarative1SpringAnimationPrivate::updateMode()
     on the \c x and \c y values indicates that whenever these values are
     changed, a SpringAnimation should be applied.
 
-    \snippet doc/src/snippets/declarative/springanimation.qml 0
+    \snippet doc/src/snippets/qtquick1/springanimation.qml 0
 
     Like any other animation element, a SpringAnimation can be applied in a
     number of ways, including transitions, behaviors and property value
@@ -275,7 +276,7 @@ QDeclarative1SpringAnimation::~QDeclarative1SpringAnimation()
 }
 
 /*!
-    \qmlproperty real SpringAnimation::velocity
+    \qmlproperty real QtQuick1::SpringAnimation::velocity
 
     This property holds the maximum velocity allowed when tracking the source.
 
@@ -297,7 +298,7 @@ void QDeclarative1SpringAnimation::setVelocity(qreal velocity)
 }
 
 /*!
-    \qmlproperty real SpringAnimation::spring
+    \qmlproperty real QtQuick1::SpringAnimation::spring
 
     This property describes how strongly the target is pulled towards the
     source. The default value is 0 (that is, the spring-like motion is disabled).
@@ -321,14 +322,16 @@ void QDeclarative1SpringAnimation::setSpring(qreal spring)
 }
 
 /*!
-    \qmlproperty real SpringAnimation::damping
+    \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
 {
@@ -347,7 +350,7 @@ void QDeclarative1SpringAnimation::setDamping(qreal damping)
 
 
 /*!
-    \qmlproperty real SpringAnimation::epsilon
+    \qmlproperty real QtQuick1::SpringAnimation::epsilon
     This property holds the spring epsilon.
 
     The epsilon is the rate and amount of change in the value which is close enough
@@ -369,7 +372,7 @@ void QDeclarative1SpringAnimation::setEpsilon(qreal epsilon)
 }
 
 /*!
-    \qmlproperty real SpringAnimation::modulus
+    \qmlproperty real QtQuick1::SpringAnimation::modulus
     This property holds the modulus value. The default value is 0.
 
     Setting a \a modulus forces the target value to "wrap around" at the modulus.
@@ -393,7 +396,7 @@ void QDeclarative1SpringAnimation::setModulus(qreal modulus)
 }
 
 /*!
-    \qmlproperty real SpringAnimation::mass
+    \qmlproperty real QtQuick1::SpringAnimation::mass
     This property holds the "mass" of the property being moved.
 
     The value is 1.0 by default.