Tizen 2.4.0 rev3 SDK Public Release

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

diff --git a/dali/public-api/math/vector2.h b/dali/public-api/math/vector2.h
index 0bb1c53..5e59ad5 100644 (file)
--- a/dali/public-api/math/vector2.h
+++ b/dali/public-api/math/vector2.h
@@ -73,7 +73,7 @@ public:
    * @brief Conversion constructor from an array of two floats.
    *
    * @since_tizen 2.4
-   * @param [in] array of xy
+   * @param [in] array Array of xy
    */
   explicit Vector2(const float* array)
   : x(array[0]),
@@ -112,8 +112,8 @@ public:
    * @brief Assignment operator.
    *
    * @since_tizen 2.4
-   * @param[in] array of floats
-   * @return itself
+   * @param[in] array Array of floats
+   * @return Itself
    */
   Vector2& operator=(const float* array)
   {
@@ -127,8 +127,8 @@ public:
    * @brief Assignment operator.
    *
    * @since_tizen 2.4
-   * @param[in] rhs vector to assign.
-   * @return itself
+   * @param[in] rhs Vector to assign.
+   * @return Itself
    */
   Vector2& operator=(const Vector3& rhs);
 
@@ -136,8 +136,8 @@ public:
    * @brief Assignment operator.
    *
    * @since_tizen 2.4
-   * @param[in] rhs vector to assign.
-   * @return itself
+   * @param[in] rhs Vector to assign.
+   * @return Itself
    */
   Vector2& operator=(const Vector4& rhs);
 
@@ -145,7 +145,7 @@ public:
    * @brief Addition operator.
    *
    * @since_tizen 2.4
-   * @param[in] rhs vector to add.
+   * @param[in] rhs Vector to add.
    * @return A vector containing the result of the addition
    */
   Vector2 operator+(const Vector2& rhs) const
@@ -159,8 +159,8 @@ public:
    * @brief Addition assignment operator.
    *
    * @since_tizen 2.4
-   * @param[in] rhs vector to add.
-   * @return itself
+   * @param[in] rhs Vector to add.
+   * @return Itself
    */
   Vector2& operator+=(const Vector2& rhs)
   {
@@ -174,7 +174,7 @@ public:
    * @brief Subtraction operator.
    *
    * @since_tizen 2.4
-   * @param[in] rhs  the vector to subtract
+   * @param[in] rhs  The vector to subtract
    * @return A vector containing the result of the subtraction
    */
   Vector2 operator-(const Vector2& rhs) const
@@ -188,8 +188,8 @@ public:
    * @brief Subtraction assignment operator.
    *
    * @since_tizen 2.4
-   * @param[in] rhs the vector to subtract
-   * @return itself
+   * @param[in] rhs The vector to subtract
+   * @return Itself
    */
   Vector2& operator-=(const Vector2& rhs)
   {
@@ -203,7 +203,7 @@ public:
    * @brief Multiplication operator.
    *
    * @since_tizen 2.4
-   * @param[in] rhs the vector to multiply
+   * @param[in] rhs The vector to multiply
    * @return A vector containing the result of the multiplication
    */
   Vector2 operator*(const Vector2& rhs) const
@@ -215,7 +215,7 @@ public:
    * @brief Multiplication operator.
    *
    * @since_tizen 2.4
-   * @param[in] rhs the float value to scale the vector
+   * @param[in] rhs The float value to scale the vector
    * @return A vector containing the result of the scaling
    */
   Vector2 operator*(float rhs) const
@@ -227,8 +227,8 @@ public:
    * @brief Multiplication assignment operator.
    *
    * @since_tizen 2.4
-   * @param[in] rhs the vector to multiply
-   * @return itself
+   * @param[in] rhs The vector to multiply
+   * @return Itself
    */
   Vector2& operator*=(const Vector2& rhs)
   {
@@ -242,8 +242,8 @@ public:
    * @brief Multiplication assignment operator.
    *
    * @since_tizen 2.4
-   * @param[in] rhs the float value to scale the vector
-   * @return itself
+   * @param[in] rhs The float value to scale the vector
+   * @return Itself
    */
   Vector2& operator*=(float rhs)
   {
@@ -257,7 +257,7 @@ public:
    * @brief Division operator.
    *
    * @since_tizen 2.4
-   * @param[in] rhs the vector to divide
+   * @param[in] rhs The vector to divide
    * @return A vector containing the result of the division
    */
   Vector2 operator/(const Vector2& rhs) const
@@ -282,8 +282,8 @@ public:
    * @brief Division assignment operator.
    *
    * @since_tizen 2.4
-   * @param[in] rhs the vector to divide
-   * @return itself
+   * @param[in] rhs The vector to divide
+   * @return Itself
    */
   Vector2& operator/=(const Vector2& rhs)
   {
@@ -297,8 +297,8 @@ public:
    * @brief Division assignment operator.
    *
    * @since_tizen 2.4
-   * @param[in] rhs the float value to scale the vector by
-   * @return itself
+   * @param[in] rhs The float value to scale the vector by
+   * @return Itself
    */
   Vector2& operator/=(float rhs)
   {
@@ -328,7 +328,7 @@ public:
    *
    * @since_tizen 2.4
    * @param[in] rhs The vector to test against
-   * @return true if the vectors are equal
+   * @return True if the vectors are equal
    */
   bool operator==(const Vector2& rhs) const;
 
@@ -339,7 +339,7 @@ public:
    *
    * @since_tizen 2.4
    * @param[in] rhs The vector to test against
-   * @return true if the vectors are not equal
+   * @return True if the vectors are not equal
    */
   bool operator!=(const Vector2& rhs) const
   {
@@ -351,7 +351,7 @@ public:
    *
    * Asserts if index is out of range. Should be 0 or 1
    * @since_tizen 2.4
-   * @param[in] index Subscript
+   * @param[in] index Subscript index
    * @return    The float at the given index
    */
   const float& operator[](const unsigned int index) const
@@ -380,7 +380,7 @@ public:
    * @brief Returns the length of the vector.
    *
    * @since_tizen 2.4
-   * @return the length of the vector
+   * @return The length of the vector
    */
   float Length() const;
 
@@ -390,7 +390,7 @@ public:
    * This is more efficient than Length() for threshold
    * testing as it avoids the use of a square root.
    * @since_tizen 2.4
-   * @return the length of the vector squared.
+   * @return The length of the vector squared.
    */
   float LengthSquared() const;
 
@@ -405,8 +405,8 @@ public:
     * @brief Clamps the vector between minimum and maximum vectors.
     *
     * @since_tizen 2.4
-    * @param [in] min the minimum vector
-    * @param [in] max the maximum vector
+    * @param [in] min The minimum vector
+    * @param [in] max The maximum vector
    */
   void Clamp( const Vector2& min, const Vector2& max );
 
@@ -417,8 +417,8 @@ public:
    * 0: x (or width)
    * 1: y (or height)
    * @since_tizen 2.4
-   * @return the vector contents as an array of 2 floats.
-   * @note inlined for performance reasons (generates less code than a function call)
+   * @return The vector contents as an array of 2 floats.
+   * @note Inlined for performance reasons (generates less code than a function call)
    */
   const float* AsFloat() const {return &x;}
 
@@ -429,8 +429,8 @@ public:
    * 0: x (or width)
    * 1: y (or height)
    * @since_tizen 2.4
-   * @return the vector contents as an array of 2 floats.
-   * @note inlined for performance reasons (generates less code than a function call)
+   * @return The vector contents as an array of 2 floats.
+   * @note Inlined for performance reasons (generates less code than a function call)
    */
   float* AsFloat() {return &x;}
 
@@ -502,9 +502,9 @@ inline Vector2 Max( const Vector2& a, const Vector2& b )
  * @brief Clamps each of vector v's components between minimum and maximum values.
  *
  * @since_tizen 2.4
- * @param [in] v     a vector
- * @param [in] min the minimum value
- * @param [in] max the maximum value
+ * @param [in] v     A vector
+ * @param [in] min The minimum value
+ * @param [in] max The maximum value
  * @return     a vector containing the clamped components of v
  */
 DALI_IMPORT_API Vector2 Clamp( const Vector2& v, const float& min, const float& max );