Tizen 2.4.0 rev3 SDK Public Release

[framework/graphics/dali.git] / dali / public-api / math / quaternion.h

diff --git a/dali/public-api/math/quaternion.h b/dali/public-api/math/quaternion.h
index 4bfff41..b24730d 100644 (file)
--- a/dali/public-api/math/quaternion.h
+++ b/dali/public-api/math/quaternion.h
@@ -67,7 +67,7 @@ public:
    * @brief Construct from a quaternion represented by a vector.
    *
    * @since_tizen 2.4
-   * @param[in] vector - x,y,z fields represent i,j,k coefficients, w represents cos(theta/2)
+   * @param[in] vector x,y,z fields represent i,j,k coefficients, w represents cos(theta/2)
    */
   explicit Quaternion( const Vector4& vector );
 
@@ -75,8 +75,8 @@ public:
    * @brief Constructor from an axis and angle.
    *
    * @since_tizen 2.4
-   * @param[in] angle - the angle around the axis
-   * @param[in] axis  - the vector of the axis
+   * @param[in] angle The angle around the axis
+   * @param[in] axis  The vector of the axis
    */
   Quaternion( Radian angle, const Vector3& axis );
 
@@ -133,7 +133,7 @@ public:
    * @brief Helper to check if this is an identity quaternion
    *
    * @since_tizen 2.4
-   * @return true if this is identity quaternion
+   * @return True if this is identity quaternion
    */
   bool IsIdentity() const;
 
@@ -142,8 +142,8 @@ public:
    *
    * @since_tizen 2.4
    * @param[out] axis
-   * @param[out] angle in radians
-   * @return true if converted correctly
+   * @param[out] angle Angle in radians
+   * @return True if converted correctly
    */
   bool ToAxisAngle( Vector3& axis, Radian& angle ) const;
 
@@ -151,7 +151,7 @@ public:
    * @brief Return the quaternion as a vector.
    *
    * @since_tizen 2.4
-   * @return the vector representation of the quaternion
+   * @return The vector representation of the quaternion
    */
   const Vector4& AsVector() const;
 
@@ -169,7 +169,7 @@ public:
    * @brief returns the Euler angles from a rotation Quaternion.
    *
    * @since_tizen 2.4
-   * @return a vector of Euler angles (x == pitch, y == yaw, z == roll)
+   * @return A vector of Euler angles (x == pitch, y == yaw, z == roll)
    */
   Vector4 EulerAngles() const;
 
@@ -213,7 +213,7 @@ public:
    * @brief Division operator.
    *
    * @since_tizen 2.4
-   * @param[in] other a quaternion to divide by
+   * @param[in] other A quaternion to divide by
    * @return A quaternion containing the result
    */
   const Quaternion operator/( const Quaternion& other ) const;
@@ -249,7 +249,7 @@ public:
    *
    * @since_tizen 2.4
    * @param[in] other The quaternion to add
-   * @return itself
+   * @return A reference to this
    */
   const Quaternion& operator+=( const Quaternion& other );
 
@@ -258,7 +258,7 @@ public:
    *
    * @since_tizen 2.4
    * @param[in] other The quaternion to subtract
-   * @return itself
+   * @return A reference to this
    */
   const Quaternion& operator-=( const Quaternion& other );
 
@@ -267,7 +267,7 @@ public:
    *
    * @since_tizen 2.4
    * @param[in] other The quaternion to multiply
-   * @return itself
+   * @return A reference to this
    */
   const Quaternion& operator*=( const Quaternion& other );
 
@@ -276,7 +276,7 @@ public:
    *
    * @since_tizen 2.4
    * @param[in] scale the value to scale by
-   * @return itself
+   * @return A reference to this
    */
   const Quaternion& operator*=( float scale );
 
@@ -284,8 +284,8 @@ public:
    * @brief Scale with Assignment operator.
    *
    * @since_tizen 2.4
-   * @param[in] scale the value to scale by
-   * @return itself
+   * @param[in] scale The value to scale by
+   * @return A reference to this
    */
   const Quaternion& operator/=( float scale );
 
@@ -311,7 +311,7 @@ public:
    * @brief Return the length of the quaternion.
    *
    * @since_tizen 2.4
-   * @return the length of the quaternion
+   * @return The length of the quaternion
    */
   float Length() const;
 
@@ -319,7 +319,7 @@ public:
    * @brief Return the squared length of the quaternion.
    *
    * @since_tizen 2.4
-   * @return the squared length of the quaternion
+   * @return The squared length of the quaternion
    */
   float LengthSquared() const;
 
@@ -334,7 +334,7 @@ public:
    * @brief Normalized.
    *
    * @since_tizen 2.4
-   * @return a normalized version of this quaternion
+   * @return A normalized version of this quaternion
    */
   Quaternion Normalized() const;
 
@@ -356,7 +356,7 @@ public:
    * @brief Performs the logarithm of a Quaternion = v*a where q = (cos(a),v*sin(a)).
    *
    * @since_tizen 2.4
-   * @return a quaternion representing the logarithm
+   * @return A quaternion representing the logarithm
    */
   Quaternion Log() const;
 
@@ -364,7 +364,7 @@ public:
    * @brief Performs an exponent e^Quaternion = Exp(v*a) = (cos(a),vsin(a)).
    *
    * @since_tizen 2.4
-   * @return a quaternion representing the exponent
+   * @return A quaternion representing the exponent
    */
   Quaternion Exp() const;
 
@@ -372,9 +372,9 @@ public:
    * @brief Return the dot product of two quaternions.
    *
    * @since_tizen 2.4
-   * @param[in] q1 - the first quaternion
-   * @param[in] q2 - the second quaternion
-   * @return the dot product of the two quaternions
+   * @param[in] q1 The first quaternion
+   * @param[in] q2 The second quaternion
+   * @return The dot product of the two quaternions
    */
   static float Dot( const Quaternion &q1, const Quaternion &q2 );
 
@@ -382,10 +382,10 @@ public:
    * @brief Linear Interpolation (using a straight line between the two quaternions).
    *
    * @since_tizen 2.4
-   * @param[in] q1 - the start quaternion
-   * @param[in] q2 - the end quaternion
-   * @param[in] t  - a progress value between 0 and 1
-   * @return the interpolated quaternion
+   * @param[in] q1 The start quaternion
+   * @param[in] q2 The end quaternion
+   * @param[in] t  A progress value between 0 and 1
+   * @return The interpolated quaternion
    */
   static Quaternion Lerp( const Quaternion &q1, const Quaternion &q2, float t );
 
@@ -394,10 +394,10 @@ public:
    * the two quaternions).
    *
    * @since_tizen 2.4
-   * @param[in] q1 - the start quaternion
-   * @param[in] q2 - the end quaternion
-   * @param[in] progress  - a progress value between 0 and 1
-   * @return the interpolated quaternion
+   * @param[in] q1 The start quaternion
+   * @param[in] q2 The end quaternion
+   * @param[in] progress A progress value between 0 and 1
+   * @return The interpolated quaternion
    */
   static Quaternion Slerp( const Quaternion &q1, const Quaternion &q2, float progress );
 
@@ -405,10 +405,10 @@ public:
    * @brief This version of Slerp, used by Squad, does not check for theta > 90.
    *
    * @since_tizen 2.4
-   * @param[in] q1 - the start quaternion
-   * @param[in] q2 - the end quaternion
-   * @param[in] t  - a progress value between 0 and 1
-   * @return the interpolated quaternion
+   * @param[in] q1 The start quaternion
+   * @param[in] q2 The end quaternion
+   * @param[in] t  A progress value between 0 and 1
+   * @return The interpolated quaternion
    */
   static Quaternion SlerpNoInvert( const Quaternion &q1, const Quaternion &q2, float t );
 
@@ -416,12 +416,12 @@ public:
    * @brief Spherical Cubic Interpolation.
    *
    * @since_tizen 2.4
-   * @param[in] start - the start quaternion
-   * @param[in] end - the end quaternion
-   * @param[in] ctrl1  - the control quaternion for q1
-   * @param[in] ctrl2  - the control quaternion for q2
-   * @param[in] t  - a progress value between 0 and 1
-   * @return the interpolated quaternion
+   * @param[in] start The start quaternion
+   * @param[in] end The end quaternion
+   * @param[in] ctrl1 The control quaternion for q1
+   * @param[in] ctrl2 The control quaternion for q2
+   * @param[in] t  A progress value between 0 and 1
+   * @return The interpolated quaternion
    */
   static Quaternion Squad( const Quaternion& start, const Quaternion& end,  const Quaternion& ctrl1,  const Quaternion& ctrl2, float t );
 
@@ -429,9 +429,9 @@ public:
    * @brief Returns the shortest angle between two quaternions in Radians.
    *
    * @since_tizen 2.4
-   * @param[in] q1 - the first quaternion
-   * @param[in] q2 - the second quaternion
-   * @return the angle between the two quaternions.
+   * @param[in] q1 The first quaternion
+   * @param[in] q2 The second quaternion
+   * @return The angle between the two quaternions.
    */
   static float AngleBetween( const Quaternion& q1, const Quaternion& q2 );
 
@@ -439,8 +439,8 @@ public:
    * @brief Rotate v by this Quaternion (Quaternion must be unit).
    *
    * @since_tizen 2.4
-   * @param[in] vector a vector to rotate
-   * @return the rotated vector
+   * @param[in] vector A vector to rotate
+   * @return The rotated vector
    */
   Vector4 Rotate( const Vector4& vector ) const;
 
@@ -448,8 +448,8 @@ public:
    * @brief Rotate v by this Quaternion (Quaternion must be unit).
    *
    * @since_tizen 2.4
-   * @param[in] vector a vector to rotate
-   * @return the rotated vector
+   * @param[in] vector A vector to rotate
+   * @return The rotated vector
    */
   Vector3 Rotate( const Vector3& vector ) const;