Revert "[Tizen] Add codes for Dali Windows Backend"

[platform/core/uifw/dali-core.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 f0af62e..5f92d43 100644 (file)
--- a/dali/public-api/animation/alpha-function.h
+++ b/dali/public-api/animation/alpha-function.h
@@ -2,7 +2,7 @@
 #define __DALI_ALPHA_FUNCTION_H__
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2018 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,17 +35,19 @@ namespace Dali
 
 typedef float (*AlphaFunctionPrototype)(float progress); ///< Prototype of an alpha function @SINCE_1_0.0
 
-  /*
+  /**
    * @brief Alpha functions are used in animations to specify the rate of change of the animation parameter over time.
+   *
    * Understanding an animation as a parametric function over time, the alpha function is applied to the parameter of
    * the animation before computing the final animation value.
+   * @SINCE_1_0.0
    */
-class DALI_IMPORT_API AlphaFunction
+class DALI_CORE_API AlphaFunction
 {
 public:
 
   /**
-   * @brief Built-in alpha functions
+   * @brief Enumeration for built-in alpha functions.
    * @SINCE_1_0.0
    */
   enum BuiltinFunction
@@ -73,19 +75,19 @@ public:
   };
 
   /**
-   * @brief All possible functioning modes for the alpha function
+   * @brief Enumeration for all possible functioning modes for the alpha function.
    * @SINCE_1_0.0
    */
   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_1_0.0
+    CUSTOM_FUNCTION,   ///< The user has provided a custom function @SINCE_1_0.0
+    BEZIER             ///< The user has provided the control points of a bezier curve @SINCE_1_0.0
   };
 
   /**
    * @brief Default constructor.
-   * Creates an alpha function object with the default built-in alpha function
+   * Creates an alpha function object with the default built-in alpha function.
    * @SINCE_1_0.0
    * @return The alpha function
    */
@@ -94,7 +96,7 @@ public:
   /**
    * @brief Constructor.
    * Creates an alpha function object with the built-in alpha function passed as a parameter
-   * to the constructor
+   * to the constructor.
    * @SINCE_1_0.0
    * @param[in] function One of the built-in alpha functions
    * @return The alpha function
@@ -103,8 +105,8 @@ public:
 
   /**
    * @brief Constructor.
-   * Creates an alpha function object using a pointer to an alpha function passed as a paramter
-   * to the constructor
+   * Creates an alpha function object using a pointer to an alpha function passed as a parameter
+   * to the constructor.
    * @SINCE_1_0.0
    * @param[in] function A pointer to an alpha function
    * @return The alpha function
@@ -113,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_1_0.0
@@ -125,25 +128,25 @@ public:
   AlphaFunction( const Dali::Vector2& controlPoint0, const Dali::Vector2& controlPoint1 );
 
   /**
-   * @brief Return the control points of the alpha function
+   * @brief Returns the control points of the alpha function.
    * @SINCE_1_0.0
-   * @return Vector4 containing the two control points of the curve.
+   * @return Vector4 containing the two control points of the curve
    * (xy for the first point and zw for the second)
    */
   Vector4 GetBezierControlPoints() const;
 
   /**
-   * @brief Returns the pointer to the custom function
+   * @brief Returns the pointer to the custom function.
    * @SINCE_1_0.0
-   * @return A pointer to a custom alpha function or 0 if not defined
+   * @return A pointer to a custom alpha function, or @c 0 if not defined
    */
   AlphaFunctionPrototype GetCustomFunction() const;
 
   /**
-   * @brief Returns the built0in function used by the alpha function
+   * @brief Returns the built-in function used by the alpha function.
    * @SINCE_1_0.0
    * @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;