Tizen 2.4.0 rev3 SDK Public Release
[framework/graphics/dali.git] / dali / public-api / math / compile-time-math.h
index 570be1b..7aa7dde 100644 (file)
@@ -34,11 +34,11 @@ namespace Dali
 /**
  * @brief Compile time template to calculate base to the power of N.
  *
- * Note! values need to be compile time constants
- * Usage: <code>Power< 10, 2 >::value; // value=100</code>
  * @since_tizen 2.4
- * @param mantissa to raise to exponent
- * @param N exponent to use for mantissa
+ * @tparam mantissa to raise to exponent
+ * @tparam N exponent to use for mantissa
+ * @note values need to be compile time constants
+ * Usage: <code>Power< 10, 2 >::value; // value=100</code>
  */
 template< size_t mantissa, size_t exponent >
 struct Power
@@ -51,7 +51,7 @@ struct Power
  *
  * Specialisation for power of 1
  * @since_tizen 2.4
- * @param mantissa to raise to exponent
+ * @tparam mantissa to raise to exponent
  */
 template< size_t mantissa >
 struct Power< mantissa, 1 >
@@ -64,7 +64,7 @@ struct Power< mantissa, 1 >
  *
  * Specialisation for power of 0
  * @since_tizen 2.4
- * @param mantissa to raise to exponent
+ * @tparam mantissa to raise to exponent
  */
 template< size_t mantissa >
 struct Power< mantissa, 0 >
@@ -75,11 +75,11 @@ struct Power< mantissa, 0 >
 /**
  * @brief Compile time template to calculate base logarithm of N.
  *
- * Note! values need to be compile time constants
- * Usage: <code>Log< 100, 10 >::value; value equals 2</code>
  * @since_tizen 2.4
- * @param number for which to calculate the logarithm
- * @param base logarithm to calculate
+ * @tparam number for which to calculate the logarithm
+ * @tparam base logarithm to calculate
+ * @note values need to be compile time constants
+ * Usage: <code>Log< 100, 10 >::value; value equals 2</code>
  */
 template< size_t number, size_t base = 2 >
 struct Log
@@ -92,7 +92,7 @@ struct Log
  *
  * Specialisation for logarithm of 1
  * @since_tizen 2.4
- * @param base logarithm to calculate
+ * @tparam base logarithm to calculate
  */
 template< size_t base >
 struct Log< 1, base >
@@ -105,7 +105,7 @@ struct Log< 1, base >
  *
  * Specialisation for logarithm of 0
  * @since_tizen 2.4
- * @param base logarithm to calculate
+ * @tparam base logarithm to calculate
  */
 template< size_t base >
 struct Log< 0, base >
@@ -117,10 +117,10 @@ struct Log< 0, base >
 /**
  * @brief Compile time template to calculate the machine epsilon for a given floating point number.
  *
- * Note! value needs to be compile time constant
- * Usage: <code>Epsilon<1000>::value; value equals 0.000119209</code>
  * @since_tizen 2.4
- * @param N the number for which to calculate the machine epsilon
+ * @tparam N the number for which to calculate the machine epsilon
+ * @note value needs to be compile time constant
+ * Usage: <code>Epsilon<1000>::value; value equals 0.000119209</code>
  */
 template< size_t N >
 struct Epsilon