[3.0] Update doxygen comments

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

diff --git a/dali/public-api/math/math-utils.h b/dali/public-api/math/math-utils.h
index 47b10ea..96df09b 100644 (file)
--- a/dali/public-api/math/math-utils.h
+++ b/dali/public-api/math/math-utils.h
@@ -25,7 +25,7 @@
 namespace Dali
 {
 /**
- * @addtogroup dali-core-math
+ * @addtogroup dali_core_math
  * @{
  */
 
@@ -33,9 +33,10 @@ namespace Dali
  * @brief Returns the next power of two.
  *
  * In case of numbers which are already a power of two this function returns the original number.
- * If i is zero returns 1
- * @param[in] i input number
- * @return    next power of two or i itself in case it's a power of two
+ * If i is zero returns 1.
+ * @SINCE_1_0.0
+ * @param[in] i Input number
+ * @return The next power of two or i itself in case it's a power of two
  */
 inline unsigned int NextPowerOfTwo( unsigned int i )
 {
@@ -58,8 +59,9 @@ inline unsigned int NextPowerOfTwo( unsigned int i )
 /**
  * @brief Whether a number is power of two.
  *
- * @param[in] i input number
- * @return    true if i is power of two
+ * @SINCE_1_0.0
+ * @param[in] i Input number
+ * @return    True if i is power of two.
  */
 inline bool IsPowerOfTwo( unsigned int i )
 {
@@ -69,6 +71,7 @@ inline bool IsPowerOfTwo( unsigned int i )
 /**
  * @brief Clamp a value.
  *
+ * @SINCE_1_0.0
  * @param[in] value The value to clamp.
  * @param[in] min The minimum allowed value.
  * @param[in] max The maximum allowed value.
@@ -85,6 +88,7 @@ inline const T& Clamp( const T& value, const T& min, const T& max )
 /**
  * @brief Clamp a value directly.
  *
+ * @SINCE_1_0.0
  * @param[in,out] value The value that will be clamped.
  * @param[in] min The minimum allowed value.
  * @param[in] max The maximum allowed value.
@@ -101,8 +105,9 @@ inline void ClampInPlace( T& value, const T& min, const T& max )
 /**
  * @brief Linear interpolation between two values.
  *
+ * @SINCE_1_0.0
  * @param[in] offset The offset through the range @p low to @p high.
- *                   This value is clamped between 0 and 1
+ *                   This value is clamped between 0 and 1.
  * @param[in] low    Lowest value in range
  * @param[in] high   Highest value in range
  * @return A value between low and high.
@@ -116,6 +121,7 @@ inline const T Lerp( const float offset, const T& low, const T& high )
 /**
  * @brief Get an epsilon that is valid for the given range.
  *
+ * @SINCE_1_0.0
  * @param[in] a the first value in the range
  * @param[in] b the second value in the range.
  * @return a suitable epsilon
@@ -154,6 +160,7 @@ inline float GetRangedEpsilon( float a, float b )
 /**
  * @brief Helper function to compare equality of a floating point value with zero.
  *
+ * @SINCE_1_0.0
  * @param[in] value the value to compare
  * @return true if the value is equal to zero
  */
@@ -168,6 +175,7 @@ inline bool EqualsZero( float value )
 /**
  * @brief Helper function to compare equality of two floating point values.
  *
+ * @SINCE_1_0.0
  * @param[in] a the first value to compare
  * @param[in] b the second value to compare
  * @return true if the values are equal within a minimal epsilon for their values
@@ -180,6 +188,7 @@ inline bool Equals( float a, float b )
 /**
  * @brief Helper function to compare equality of two floating point values.
  *
+ * @SINCE_1_0.0
  * @param[in] a the first value to compare
  * @param[in] b the second value to compare
  * @param[in] epsilon the minimum epsilon value that will be used to consider the values different
@@ -193,6 +202,7 @@ inline bool Equals( float a, float b, float epsilon )
 /**
  * @brief Get an float that is rounded at specified place of decimals.
  *
+ * @SINCE_1_0.0
  * @param[in] value float value
  * @param[in] pos decimal place
  * @return a rounded float
@@ -216,27 +226,30 @@ inline float Round(float value, int pos)
  * start: 2
  * end: 8
  *
+ * @code
  *   2                         8
  * (\ / start)               (\ / end)
  *   |----x                    |
+ * @endcode
  *
  * The value x will be confined to this domain.
  * If x is below 2 e.g. 0, then it is wraped to 6.
  * If x is above or equal to 8 e.g. 8.1 then it is
- * wrapped to 2.1
+ * wrapped to 2.1.
  *
  * Domain wrapping is useful for various problems from
  * calculating positions in a space that repeats, to
  * computing angles that range from 0 to 360.
  *
+ * @SINCE_1_0.0
  * @param[in] x the point to be wrapped within the domain
  * @param[in] start The start of the domain
  * @param[in] end The end of the domain
  *
- * @note if start = end (i.e. size of domain 0), then wrapping will not occur
+ * @return the wrapped value over the domain (start) (end)
+ * @note If start = end (i.e. size of domain 0), then wrapping will not occur
  * and result will always be equal to start.
  *
- * @return the wrapped value over the domain (start) (end)
  */
 inline float WrapInDomain(float x, float start, float end)
 {
@@ -256,8 +269,10 @@ inline float WrapInDomain(float x, float start, float end)
  * @brief Find the shortest distance (magnitude) and direction (sign)
  * from (a) to (b) in domain (start) to (end).
  *
- * (\ / start)               (\ / end)
- *   |-a                 b<----|
+ * @code
+ *  (\ / start)               (\ / end)
+ *    |-a                 b<----|
+ * @endcode
  *
  * Knowing the shortest distance is useful with wrapped domains
  * to solve problems such as determing the closest object to
@@ -271,14 +286,15 @@ inline float WrapInDomain(float x, float start, float end)
  * return -20. i.e. subtract 20 from current value (10) to reach
  * target wrapped value (350).
  *
- * @note assumes both (a) and (b) are already within the domain
- * (start) to (end)
- *
+ * @SINCE_1_0.0
  * @param a the current value
  * @param b the target value
  * @param start the start of the domain
  * @param end the end of the domain
  * @return the shortest direction (the sign) and distance (the magnitude)
+ * @note Assumes both (a) and (b) are already within the domain
+ * (start) to (end).
+ *
  */
 inline float ShortestDistanceInDomain( float a, float b, float start, float end )
 {
@@ -311,6 +327,19 @@ inline float ShortestDistanceInDomain( float a, float b, float start, float end
 }
 
 /**
+ * @brief Extracts the sign of a number
+ *
+ * @SINCE_1_0.0
+ * @param[in] value The value we want to extract the sign
+ * @return -1 for negative values, +1 for positive values and 0 if value is 0
+ */
+template <typename T>
+int Sign( T value )
+{
+  return ( T(0) < value ) - ( value < T(0) );
+}
+
+/**
  * @}
  */
 } // namespace Dali