[3.0] Add missed doxygen documentation

[platform/core/uifw/dali-core.git] / dali / public-api / math / radian.h

diff --git a/dali/public-api/math/radian.h b/dali/public-api/math/radian.h
index 7fc3e64..e8a8faf 100644 (file)
--- a/dali/public-api/math/radian.h
+++ b/dali/public-api/math/radian.h
@@ -27,7 +27,7 @@
 namespace Dali
 {
 /**
- * @addtogroup dali-core-math
+ * @addtogroup dali_core_math
  * @{
  */
 
@@ -35,11 +35,13 @@ namespace Dali
  * @brief An angle in radians.
  *
  * This reduces ambiguity when using methods which accept angles in degrees or radians.
+ * @SINCE_1_0.0
  */
 struct Radian
 {
   /**
    * @brief default constructor, initialises to 0.
+   * @SINCE_1_0.0
    */
   Radian()
   : radian( 0.f )
@@ -48,6 +50,7 @@ struct Radian
   /**
    * @brief Create an angle in radians.
    *
+   * @SINCE_1_0.0
    * @param[in] value The initial value in radians.
    */
   explicit Radian( float value )
@@ -57,6 +60,7 @@ struct Radian
   /**
    * @brief Create an angle in radians from an angle in degrees.
    *
+   * @SINCE_1_0.0
    * @param[in] degree The initial value in degrees.
    */
   Radian( Degree degree )
@@ -66,8 +70,9 @@ struct Radian
   /**
    * @brief Assign an angle from a float value.
    *
+   * @SINCE_1_0.0
    * @param[in] value Float value in radians
-   * @return a reference to this object
+   * @return A reference to this
    */
   Radian& operator=( float value )
   {
@@ -78,8 +83,9 @@ struct Radian
   /**
    * @brief Assign an angle from a Degree value.
    *
+   * @SINCE_1_0.0
    * @param[in] degree The value in degrees.
-   * @return a reference to this object
+   * @return A reference to this
    */
   Radian& operator=( Degree degree )
   {
@@ -89,6 +95,7 @@ struct Radian
 
   /**
    * @brief Conversion to float
+   * @SINCE_1_0.0
    * @return the float value of this Radian
    */
   operator float() const
@@ -105,23 +112,10 @@ public:
 
 // compiler generated destructor, copy constructor and assignment operators are ok as this class is POD
 
-// useful constant angles
-static const Radian ANGLE_360 = Radian( Math::PI * 2.f     ); ///< 360 degree turn in radians
-static const Radian ANGLE_315 = Radian( Math::PI * 1.75f   ); ///< 315 degree turn in radians
-static const Radian ANGLE_270 = Radian( Math::PI * 1.50f   ); ///< 270 degree turn in radians
-static const Radian ANGLE_225 = Radian( Math::PI * 1.25f   ); ///< 225 degree turn in radians
-static const Radian ANGLE_180 = Radian( Math::PI           ); ///< 180 degree turn in radians
-static const Radian ANGLE_135 = Radian( Math::PI * 0.75f   ); ///< 135 degree turn in radians
-static const Radian ANGLE_120 = Radian( Math::PI * 2.f/3.f ); ///< 120 degree turn in radians
-static const Radian ANGLE_90  = Radian( Math::PI_2         ); ///< 90 degree turn in radians
-static const Radian ANGLE_45  = Radian( Math::PI_4         ); ///< 45 degree turn in radians
-static const Radian ANGLE_60  = Radian( Math::PI / 3.f     ); ///< 60 degree turn in radians
-static const Radian ANGLE_30  = Radian( Math::PI / 6.f     ); ///< 30 degree turn in radians
-static const Radian ANGLE_0   = Radian( 0.0f               ); ///< 0 degree turn in radians
-
 /**
  * @brief Compare equality between two radians.
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Radian to compare
  * @param[in] rhs Radian to compare to
  * @return true if the values are identical
@@ -134,6 +128,7 @@ inline bool operator==( Radian lhs, Radian rhs )
 /**
  * @brief Compare inequality between two radians.
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Radian to compare
  * @param[in] rhs Radian to compare to
  * @return true if the values are not identical
@@ -146,6 +141,7 @@ inline bool operator!=( Radian lhs, Radian rhs )
 /**
  * @brief Compare equality between a radian and degree.
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Radian to compare
  * @param[in] rhs Degree to compare to
  * @return true if the values are identical
@@ -158,6 +154,7 @@ inline bool operator==( Radian lhs, Degree rhs )
 /**
  * @brief Compare inequality between a radian and a degree.
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Radian to compare
  * @param[in] rhs Degree to compare to
  * @return true if the values are not identical
@@ -170,6 +167,7 @@ inline bool operator!=( Radian lhs, Degree rhs )
 /**
  * @brief Compare equality between a degree and a radian.
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Degree to compare
  * @param[in] rhs Radian to compare to
  * @return true if the values are identical
@@ -182,6 +180,7 @@ inline bool operator==( Degree lhs, Radian rhs )
 /**
  * @brief Compare inequality between a degree and a radian.
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Degree to compare
  * @param[in] rhs Radian to compare to
  * @return true if the values are not identical
@@ -194,6 +193,7 @@ inline bool operator!=( Degree lhs, Radian rhs )
 /**
  * @brief Compare greater than between two radians
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Radian to compare
  * @param[in] rhs Radian to compare to
  * @return true if lhs is greater than rhs
@@ -206,6 +206,7 @@ inline bool operator>( Radian lhs, Radian rhs )
 /**
  * @brief Compare greater than between a radian and a degree.
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Radian to compare
  * @param[in] rhs Degree to compare to
  * @return true if lhs is greater than rhs
@@ -218,6 +219,7 @@ inline bool operator>( Radian lhs, Degree rhs )
 /**
  * @brief Compare greater than between a radian and a degree.
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Radian to compare
  * @param[in] rhs Degree to compare to
  * @return true if lhs is greater than rhs
@@ -230,6 +232,7 @@ inline bool operator>( Degree lhs, Radian rhs )
 /**
  * @brief Compare less than between two radians.
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Radian to compare
  * @param[in] rhs Radian to compare to
  * @return true if lhs is less than rhs
@@ -242,6 +245,7 @@ inline bool operator<( Radian lhs, Radian rhs )
 /**
  * @brief Compare less than between a radian and a degree.
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Radian to compare
  * @param[in] rhs Degree to compare to
  * @return true if lhs is less than rhs
@@ -254,6 +258,7 @@ inline bool operator<( Radian lhs, Degree rhs )
 /**
  * @brief Compare less than between a degree and a radian.
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Degree to compare
  * @param[in] rhs Radian to compare to
  * @return true if lhs is less than rhs
@@ -266,6 +271,7 @@ inline bool operator<( Degree lhs, Radian rhs )
 /**
  * @brief Multiply Radian with a float
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Radian to multiply
  * @param[in] rhs float to multiply
  * @return result of the multiplication
@@ -277,6 +283,8 @@ inline Radian operator*( Radian lhs, float rhs )
 
 /**
  * @brief Negate the radian
+ * @SINCE_1_0.0
+ * @param[in] in Radian to negate
  * @return The negative angle
  */
 inline Radian operator-( Radian in )
@@ -286,6 +294,7 @@ inline Radian operator-( Radian in )
 
 /**
  * @brief Clamp a radian value
+ * @SINCE_1_0.0
  * @param angle to clamp
  * @param min value
  * @param max value