[3.0] Update doxygen comments

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

diff --git a/dali/public-api/math/degree.h b/dali/public-api/math/degree.h
index 96e7bbd..8e53fc5 100644 (file)
--- a/dali/public-api/math/degree.h
+++ b/dali/public-api/math/degree.h
@@ -36,29 +36,33 @@ struct Radian;
  * @brief An angle in degrees.
  *
  * This reduces ambiguity when using methods which accept angles in degrees or radians.
+ * @SINCE_1_0.0
  */
 struct Degree
 {
   /**
-   * @brief default constructor, initialises to 0.
+   * @brief Default constructor, initialises to 0.
+   * @SINCE_1_0.0
    */
   Degree()
   : degree( 0.f )
   { }
 
   /**
-   * @brief Create an angle in degrees.
+   * @brief Creates an angle in degrees.
    *
-   * @param[in] value The initial value in degrees.
+   * @SINCE_1_0.0
+   * @param[in] value The initial value in degrees
    */
   explicit Degree( float value )
   : degree( value )
   { }
 
   /**
-   * @brief Create an angle in degrees from a Radian.
+   * @brief Creates an angle in degrees from a Radian.
    *
-   * @param[in] value The initial value in Radians.
+   * @SINCE_1_0.0
+   * @param[in] value The initial value in Radians
    */
   DALI_EXPORT_API Degree( Radian value );
 
@@ -86,11 +90,12 @@ DALI_EXPORT_API extern const Radian ANGLE_30;  ///< 30 degree turn in radians
 DALI_EXPORT_API extern const Radian ANGLE_0;   ///< 0 degree turn in radians
 
 /**
- * @brief Compare equality between two degrees.
+ * @brief Compares equality between two degrees.
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Degree to compare
  * @param[in] rhs Degree to compare to
- * @return true if the values are identical
+ * @return True if the values are identical
  */
 inline bool operator==( const Degree& lhs, const Degree& rhs )
 {
@@ -98,11 +103,12 @@ inline bool operator==( const Degree& lhs, const Degree& rhs )
 }
 
 /**
- * @brief Compare inequality between two degrees.
+ * @brief Compares inequality between two degrees.
  *
+ * @SINCE_1_0.0
  * @param[in] lhs Degree to compare
  * @param[in] rhs Degree to compare to
- * @return true if the values are not identical
+ * @return True if the values are not identical
  */
 inline bool operator!=( const Degree& lhs, const Degree& rhs )
 {
@@ -110,11 +116,12 @@ inline bool operator!=( const Degree& lhs, const Degree& rhs )
 }
 
 /**
- * @brief Clamp a radian value
+ * @brief Clamps a radian value.
+ * @SINCE_1_0.0
  * @param angle to clamp
  * @param min value
  * @param max value
- * @return the resulting radian
+ * @return The resulting radian
  */
 inline Degree Clamp( Degree angle, float min, float max )
 {