Tizen 2.4.0 rev3 SDK Public Release

[framework/graphics/dali.git] / dali / public-api / animation / linear-constrainer.h

diff --git a/dali/public-api/animation/linear-constrainer.h b/dali/public-api/animation/linear-constrainer.h
index a68becd..663e54c 100644 (file)
--- a/dali/public-api/animation/linear-constrainer.h
+++ b/dali/public-api/animation/linear-constrainer.h
@@ -38,9 +38,8 @@ namespace Internal DALI_INTERNAL
 }
 
 /**
- * @brief
+ * @brief LinearConstrainer applies constraints to objects given a linear map.
  *
- * LinearConstrainer applies constraints to objects given a linear map.
  * A linear map is defined by a set of value-progress pairs.
  * Progress must be normalized between [0,1]. If no progress is defined, the values
  * are considered to be equally spaced along the x axis.
@@ -58,8 +57,8 @@ public:
   {
     enum
     {
-      VALUE     = DEFAULT_OBJECT_PROPERTY_START_INDEX,  ///< name "value" type Array of float
-      PROGRESS,                                         ///< name "progress" type Array of float
+      VALUE     = DEFAULT_OBJECT_PROPERTY_START_INDEX,  ///< type Array of float @since_tizen 2.4
+      PROGRESS,                                         ///< type Array of float @since_tizen 2.4
     };
   };
 
@@ -67,26 +66,26 @@ public:
    * @brief Create an initialized LinearConstrainer handle.
    *
    * @since_tizen 2.4
-   * @return a handle to a newly allocated Dali resource.
+   * @return A handle to a newly allocated Dali resource.
    */
   static LinearConstrainer New();
 
   /**
-   * @brief Downcast an Object handle to LinearConstrainer handle.
+   * @brief Downcast a handle to LinearConstrainer handle.
    *
    * If handle points to a LinearConstrainer object the downcast produces
    * valid handle. If not the returned handle is left uninitialized.
    * @since_tizen 2.4
-   * @param[in] handle to An object
-   * @return handle to a LinearConstrainer object or an uninitialized handle
+   * @param[in] handle Handle to an object
+   * @return Handle to a LinearConstrainer object or an uninitialized handle
    */
   static LinearConstrainer DownCast( BaseHandle handle );
 
   /**
    * @brief Create an uninitialized LinearConstrainer handle.
    *
-   * This can be initialized with PathConstrainer::New(). Calling member
-   * functions with an uninitialized Dali::Object is not allowed.
+   * This can be initialized with @ref PathConstrainer::New
+   * Calling member functions with an uninitialized LinearConstrainer handle is not allowed.
    * @since_tizen 2.4
    */
   LinearConstrainer();
@@ -123,7 +122,7 @@ public:
    * @param[in] target Property to be constrained
    * @param[in] source Property used as parameter for the path
    * @param[in] range The range of values in the source property which will be mapped to [0,1]
-   * @param[in] wrap Wrapping domain. Source property will be wrapped in the domain [wrap.x,wrap.y] before mapping to [0,1]
+   * @param[in] wrap Wrapping domain. Source property will be wrapped in the domain [wrap.x,wrap.y] before mapping to [0,1]. See cfloat.h for FLT_MAX
    */
   void Apply( Dali::Property target, Dali::Property source, const Vector2& range, const Vector2& wrap = Vector2(-FLT_MAX, FLT_MAX) );
 
@@ -137,7 +136,7 @@ public:
 
 public: // Not intended for application developers
   /**
-   * @brief This constructor is used by Dali::New() methods.
+   * @brief This constructor is used by LinearConstrainer::New() methods.
    *
    * @since_tizen 2.4
    * @param[in] pathConstrainer A pointer to an internal PathConstrainer resource