Tizen 2.4.0 rev3 SDK Public Release
[framework/graphics/dali.git] / dali / public-api / animation / path.h
index 66e63d3..80b2c3f 100644 (file)
@@ -37,7 +37,7 @@ class Path;
 /**
  * @brief A 3D parametric curve
  *
- * Paths can be used to animate position and orientation of actors using Dali::Animate( Actor, Path, ... )
+ * Paths can be used to animate position and orientation of actors using @ref Dali::Animate( Actor, Path, ... )
  *
  * @since_tizen 2.4
  */
@@ -53,8 +53,8 @@ public:
   {
     enum
     {
-      POINTS         = DEFAULT_OBJECT_PROPERTY_START_INDEX, ///< name "points",         type Vector3
-      CONTROL_POINTS,                                       ///< name "control-points", type Vector3
+      POINTS         = DEFAULT_OBJECT_PROPERTY_START_INDEX, ///< type Vector3 @since_tizen 2.4
+      CONTROL_POINTS,                                       ///< type Vector3 @since_tizen 2.4
     };
   };
 
@@ -62,26 +62,26 @@ public:
    * @brief Create an initialized Path handle.
    *
    * @since_tizen 2.4
-   * @return a handle to a newly allocated Dali resource.
+   * @return A handle to a newly allocated Dali resource.
    */
   static Path New();
 
   /**
-   * @brief Downcast an Object handle to Path handle.
+   * @brief Downcast a handle to Path handle.
    *
    * If handle points to a KeyFrames 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 Path object or an uninitialized handle
+   * @param[in] handle Handle to an object
+   * @return Handle to a Path object or an uninitialized handle
    */
   static Path DownCast( BaseHandle handle );
 
   /**
    * @brief Create an uninitialized Path handle.
    *
-   * This can be initialized with Path::New(). Calling member
-   * functions with an uninitialized Dali::Object is not allowed.
+   * This can be initialized with Path::New().
+   * Calling member functions with an uninitialized Path handle is not allowed.
    * @since_tizen 2.4
    */
   Path();
@@ -185,7 +185,7 @@ public:
 
 public: // Not intended for application developers
   /**
-   * @brief This constructor is used by Dali::New() methods.
+   * @brief This constructor is used by Path::New() methods.
    *
    * @since_tizen 2.4
    * @param[in] path A pointer to an internal path resource