[3.0] Update doxygen comments

[platform/core/uifw/dali-core.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 1053afa..d802fb2 100644 (file)
--- a/dali/public-api/math/uint-16-pair.h
+++ b/dali/public-api/math/uint-16-pair.h
@@ -54,8 +54,8 @@ public:
   /**
    * @brief Constructor taking separate x and y (width and height) parameters.
    * @SINCE_1_0.0
-   * @param[in] width The width or X dimension of the tuple. Make sure it is less than 65536,
-   * @param[in] height The height or Y dimension of the tuple. Make sure it is less than 65536,
+   * @param[in] width The width or X dimension of the tuple. Make sure it is less than 65536
+   * @param[in] height The height or Y dimension of the tuple. Make sure it is less than 65536
    */
   Uint16Pair( uint32_t width, uint32_t height )
   {
@@ -73,7 +73,7 @@ public:
   /**
    * @brief Copy constructor.
    * @SINCE_1_0.0
-   * @param rhs to copy from
+   * @param[in] rhs A reference to assign
    */
   Uint16Pair( const Uint16Pair& rhs )
   {
@@ -83,7 +83,7 @@ public:
   /**
    * @brief Sets the width.
    * @SINCE_1_1.13
-   * @param[in] width The x dimension to be stored in this 2-tuple.
+   * @param[in] width The x dimension to be stored in this 2-tuple
    */
   void SetWidth( uint16_t width )
   {
@@ -91,8 +91,9 @@ public:
   }
 
   /**
-   * @brief @returns the x dimension stored in this 2-tuple.
+   * @brief Get the width.
    * @SINCE_1_0.0
+   * @return the x dimension stored in this 2-tuple
    */
   uint16_t GetWidth() const
   {
@@ -102,7 +103,7 @@ public:
   /**
    * @brief Sets the height.
    * @SINCE_1_1.13
-   * @param[in] height The y dimension to be stored in this 2-tuple.
+   * @param[in] height The y dimension to be stored in this 2-tuple
    */
   void SetHeight( uint16_t height )
   {
@@ -110,8 +111,9 @@ public:
   }
 
   /**
-   * @brief @returns the y dimension stored in this 2-tuple.
+   * @brief Returns the y dimension stored in this 2-tuple.
    * @SINCE_1_0.0
+   * @return Height
    */
   uint16_t GetHeight() const
   {
@@ -121,7 +123,7 @@ public:
   /**
    * @brief Sets the x dimension (same as width).
    * @SINCE_1_1.14
-   * @param[in] x The x dimension to be stored in this 2-tuple.
+   * @param[in] x The x dimension to be stored in this 2-tuple
    */
   void SetX( uint16_t x )
   {
@@ -129,8 +131,9 @@ public:
   }
 
   /**
-   * @brief @returns the x dimension stored in this 2-tuple.
+   * @brief Returns the x dimension stored in this 2-tuple.
    * @SINCE_1_0.0
+   * @return X
    */
   uint16_t GetX()  const
   {
@@ -140,7 +143,7 @@ public:
   /**
    * @brief Sets the y dimension (same as height).
    * @SINCE_1_1.14
-   * @param[in] y The y dimension to be stored in this 2-tuple.
+   * @param[in] y The y dimension to be stored in this 2-tuple
    */
   void SetY( uint16_t y )
   {
@@ -148,8 +151,9 @@ public:
   }
 
   /**
-   * @brief @returns the y dimension stored in this 2-tuple.
+   * @brief Returns the y dimension stored in this 2-tuple.
    * @SINCE_1_0.0
+   * @return Y
    */
   uint16_t GetY() const
   {
@@ -159,6 +163,8 @@ public:
   /**
    * @brief Assignment operator.
    * @SINCE_1_0.0
+   * @param[in] rhs Handle to an object
+   * @return A reference to this
    */
   Uint16Pair& operator=( const Uint16Pair& rhs )
   {
@@ -172,6 +178,8 @@ public:
   /**
    * @brief Equality operator.
    * @SINCE_1_0.0
+   * @param[in] rhs A reference for comparison
+   * @return True if same
    */
   bool operator==( const Uint16Pair& rhs ) const
   {
@@ -181,6 +189,8 @@ public:
   /**
    * @brief Inequality operator.
    * @SINCE_1_0.0
+   * @param[in] rhs A reference for comparison
+   * @return True if different
    */
   bool operator!=( const Uint16Pair& rhs ) const
   {
@@ -191,6 +201,8 @@ public:
    * @brief Less than comparison operator for storing in collections (not geometrically
    * meaningful).
    * @SINCE_1_0.0
+   * @param[in] rhs A reference for comparison
+   * @return True if less
    */
   bool operator<( const Uint16Pair& rhs ) const
   {
@@ -201,6 +213,8 @@ public:
    * @brief Greater than comparison operator for storing in collections (not
    * geometrically meaningful).
    * @SINCE_1_0.0
+   * @param[in] rhs A reference for comparison
+   * @return True if greater
    */
   bool operator>( const Uint16Pair& rhs ) const
   {
@@ -208,12 +222,14 @@ public:
   }
 
   /**
-   * @brief Create an instance by rounding a floating point vector to closest
+   * @brief Creates an instance by rounding a floating point vector to closest
    * integers.
    *
    * 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_1_0.0
+   * @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 )
@@ -224,12 +240,14 @@ public:
   }
 
   /**
-   * @brief Create an instance by rounding a floating point array to closest
+   * @brief Creates an instance by rounding a floating point array to closest
    * integers.
    *
    * Uses a template to allow any vector type with operator [] to be converted
    * in addition to plain arrays.
    * @SINCE_1_0.0
+   * @param[in] from Floating point array
+   * @return Closest integer value
    */
   template<typename FLOAT_ARRAY>
   static Uint16Pair FromFloatArray( const FLOAT_ARRAY& from )