Tizen 2.4.0 rev3 SDK Public Release

[framework/graphics/dali.git] / dali / public-api / math / uint-16-pair.h

diff --git a/dali/public-api/math/uint-16-pair.h b/dali/public-api/math/uint-16-pair.h
index c9db70f..9f89a0f 100644 (file)
--- a/dali/public-api/math/uint-16-pair.h
+++ b/dali/public-api/math/uint-16-pair.h
@@ -73,6 +73,7 @@ public:
   /**
    * @brief Copy constructor.
    * @since_tizen 2.4
+   * @param[in] rhs A reference to the copied Uint16Pair
    */
   Uint16Pair( const Uint16Pair& rhs )
   {
@@ -89,8 +90,9 @@ public:
   }
 
   /**
-   * @brief @returns the y dimension stored in this 2-tuple.
+   * @brief Returns the y dimension stored in this 2-tuple.
    * @since_tizen 2.4
+   * @return Height
    */
   uint16_t GetHeight() const
   {
@@ -98,8 +100,9 @@ public:
   }
 
   /**
-   * @brief @returns the x dimension stored in this 2-tuple.
+   * @brief Returns the x dimension stored in this 2-tuple.
    * @since_tizen 2.4
+   * @return X
    */
   uint16_t GetX()  const
   {
@@ -107,8 +110,9 @@ public:
   }
 
   /**
-   * @brief @returns the y dimension stored in this 2-tuple.
+   * @brief Returns the y dimension stored in this 2-tuple.
    * @since_tizen 2.4
+   * @return Y
    */
   uint16_t GetY() const
   {
@@ -118,6 +122,8 @@ public:
   /**
    * @brief Equality operator.
    * @since_tizen 2.4
+   * @param[i] rhs A reference for comparison
+   * @return True if same
    */
   bool operator==( const Uint16Pair& rhs ) const
   {
@@ -127,6 +133,8 @@ public:
   /**
    * @brief Inequality operator.
    * @since_tizen 2.4
+   * @param[i] rhs A reference for comparison
+   * @return True if different
    */
   bool operator!=( const Uint16Pair& rhs ) const
   {
@@ -137,6 +145,8 @@ public:
    * @brief Less than comparison operator for storing in collections (not geometrically
    * meaningful).
    * @since_tizen 2.4
+   * @param[i] rhs A reference for comparison
+   * @return True if less
    */
   bool operator<( const Uint16Pair& rhs ) const
   {
@@ -147,6 +157,8 @@ public:
    * @brief Greater than comparison operator for storing in collections (not
    * geometrically meaningful).
    * @since_tizen 2.4
+   * @param[i] rhs A reference for comparison
+   * @return True if greater
    */
   bool operator>( const Uint16Pair& rhs ) const
   {
@@ -160,6 +172,8 @@ public:
    * Uses a template for loose coupling, to save a header include, and allow any
    * vector type with .x and .y members to be converted.
    * @since_tizen 2.4
+   * @param[in] from Floating point vector2
+   * @return Closest integer value.
    */
   template<typename FLOAT_VECTOR_N_TYPE>
   static Uint16Pair FromFloatVec2( const FLOAT_VECTOR_N_TYPE& from )
@@ -176,6 +190,8 @@ public:
    * Uses a template to allow any vector type with operator [] to be converted
    * in addition to plain arrays.
    * @since_tizen 2.4
+   * @param[in] from Floating point array
+   * @return Closest integer value.
    */
   template<typename FLOAT_ARRAY>
   static Uint16Pair FromFloatArray( const FLOAT_ARRAY& from )