Tizen 2.4.0 rev3 SDK Public Release

[framework/graphics/dali.git] / dali / public-api / animation / alpha-function.h

diff --git a/dali/public-api/animation/alpha-function.h b/dali/public-api/animation/alpha-function.h
index f9097c3..ff9b95a 100644 (file)
--- a/dali/public-api/animation/alpha-function.h
+++ b/dali/public-api/animation/alpha-function.h
@@ -33,7 +33,7 @@ namespace Dali
  * @{
  */
 
-typedef float (*AlphaFunctionPrototype)(float progress); ///< Prototype of an alpha function
+typedef float (*AlphaFunctionPrototype)(float progress); ///< Prototype of an alpha function @since_tizen 2.4
 
   /**
    * @brief Alpha functions are used in animations to specify the rate of change of the animation parameter over time.
@@ -52,24 +52,24 @@ public:
    */
   enum BuiltinFunction
   {
-    DEFAULT,            ///< Linear
-    LINEAR,             ///< No transformation
-    REVERSE,            ///< Reverse linear
+    DEFAULT,            ///< Linear @since_tizen 2.4
+    LINEAR,             ///< No transformation @since_tizen 2.4
+    REVERSE,            ///< Reverse linear @since_tizen 2.4
 
-    EASE_IN_SQUARE,     ///< Speeds up and comes to a sudden stop (Square)
-    EASE_OUT_SQUARE,    ///< Sudden start and slows to a gradual stop (Square)
+    EASE_IN_SQUARE,     ///< Speeds up and comes to a sudden stop (Square) @since_tizen 2.4
+    EASE_OUT_SQUARE,    ///< Sudden start and slows to a gradual stop (Square) @since_tizen 2.4
 
-    EASE_IN,            ///< Speeds up and comes to a sudden stop (Cubic)
-    EASE_OUT,           ///< Sudden start and slows to a gradual stop (Cubic)
-    EASE_IN_OUT,        ///< Speeds up and slows to a gradual stop (Cubic)
+    EASE_IN,            ///< Speeds up and comes to a sudden stop (Cubic) @since_tizen 2.4
+    EASE_OUT,           ///< Sudden start and slows to a gradual stop (Cubic) @since_tizen 2.4
+    EASE_IN_OUT,        ///< Speeds up and slows to a gradual stop (Cubic) @since_tizen 2.4
 
-    EASE_IN_SINE,       ///< Speeds up and comes to a sudden stop (sinusoidal)
-    EASE_OUT_SINE,      ///< Sudden start and slows to a gradual stop (sinusoidal)
-    EASE_IN_OUT_SINE,   ///< Speeds up and slows to a gradual stop (sinusoidal)
+    EASE_IN_SINE,       ///< Speeds up and comes to a sudden stop (sinusoidal) @since_tizen 2.4
+    EASE_OUT_SINE,      ///< Sudden start and slows to a gradual stop (sinusoidal) @since_tizen 2.4
+    EASE_IN_OUT_SINE,   ///< Speeds up and slows to a gradual stop (sinusoidal) @since_tizen 2.4
 
-    BOUNCE,             ///< Sudden start, loses momentum and returns to start position
-    SIN,                ///< Single revolution
-    EASE_OUT_BACK,      ///< Sudden start, exceed end position and return to a gradual stop
+    BOUNCE,             ///< Sudden start, loses momentum and returns to start position @since_tizen 2.4
+    SIN,                ///< Single revolution @since_tizen 2.4
+    EASE_OUT_BACK,      ///< Sudden start, exceed end position and return to a gradual stop @since_tizen 2.4
 
     COUNT
   };
@@ -80,9 +80,9 @@ public:
    */
   enum Mode
   {
-    BUILTIN_FUNCTION,  //< The user has specified a built-in function
-    CUSTOM_FUNCTION,   //< The user has provided a custom function
-    BEZIER             //< The user has provided the control points of a bezier curve
+    BUILTIN_FUNCTION,  ///< The user has specified a built-in function @since_tizen 2.4
+    CUSTOM_FUNCTION,   ///< The user has provided a custom function @since_tizen 2.4
+    BEZIER             ///< The user has provided the control points of a bezier curve @since_tizen 2.4
   };
 
   /**
@@ -115,6 +115,7 @@ public:
 
   /**
    * @brief Constructor.
+   *
    * Creates a bezier alpha function. The bezier will have the first point at (0,0) and
    * the end point at (1,1).
    * @since_tizen 2.4
@@ -145,7 +146,7 @@ public:
    * @brief Returns the built0in function used by the alpha function
    * @since_tizen 2.4
    * @return One of the built-in alpha functions. In case no built-in function
-   * has been specified, it will return AlphaFunction::DEfAULT
+   * has been specified, it will return AlphaFunction::DEFAULT
    */
   BuiltinFunction GetBuiltinFunction() const;