Tizen 2.4.0 rev3 SDK Public Release

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

diff --git a/dali/public-api/animation/constraint.h b/dali/public-api/animation/constraint.h
index 9310f07..bff70fb 100644 (file)
--- a/dali/public-api/animation/constraint.h
+++ b/dali/public-api/animation/constraint.h
@@ -40,7 +40,7 @@ namespace Internal DALI_INTERNAL
 class ConstraintBase;
 }
 
-typedef Vector< PropertyInput* > PropertyInputContainer;
+typedef Vector< PropertyInput* > PropertyInputContainer;  ///< Container for PropertyInput @since_tizen 2.4
 
 /**
  * @brief An abstract base class for Constraints.
@@ -283,8 +283,8 @@ public:
    */
   enum RemoveAction
   {
-    Bake,   ///< When the constraint is fully-applied, the constrained value is saved.
-    Discard ///< When the constraint is removed, the constrained value is discarded.
+    Bake,   ///< When the constraint is fully-applied, the constrained value is saved. @since_tizen 2.4
+    Discard ///< When the constraint is removed, the constrained value is discarded. @since_tizen 2.4
   };
 
   static const RemoveAction  DEFAULT_REMOVE_ACTION;  ///< Bake
@@ -292,7 +292,8 @@ public:
   /**
    * @brief Create an uninitialized Constraint; this can be initialized with Constraint::New().
    *
-   * Calling member functions with an uninitialized Dali::Object is not allowed.
+   * Calling member functions with an uninitialized Constraint handle is not allowed.
+   *
    * @since_tizen 2.4
    */
   Constraint();
@@ -306,6 +307,7 @@ public:
    * @endcode
    *
    * Create the constraint with this function as follows:
+   *
    * @code
    *   Constraint constraint = Constraint::New< Vector3 >( handle, CONSTRAINING_PROPERTY_INDEX, &MyFunction );
    * @endcode
@@ -337,6 +339,7 @@ public:
    * @endcode
    *
    * Create the constraint with this object as follows:
+   *
    * @code
    *   Constraint constraint = Constraint::New< Vector3 >( handle, CONSTRAINING_PROPERTY_INDEX, MyObject() );
    * @endcode
@@ -369,6 +372,7 @@ public:
    * @endcode
    *
    * Create the constraint with this object as follows:
+   *
    * @code
    *   Constraint constraint = Constraint::New< Vector3 >( handle, CONSTRAINING_PROPERTY_INDEX, MyObject(), &MyObject::MyMethod );
    * @endcode
@@ -426,13 +430,13 @@ public:
   Constraint& operator=( const Constraint& rhs );
 
   /**
-   * @brief Downcast an Object handle to Constraint handle.
+   * @brief Downcast a handle to Constraint handle.
    *
    * If handle points to a Constraint object the
    * downcast produces valid handle. If not the returned handle is left uninitialized.
    * @since_tizen 2.4
-   * @param[in]  baseHandle  to An object
-   * @return handle to a Constraint object or an uninitialized handle
+   * @param[in] baseHandle BaseHandle to an object
+   * @return Handle to a Constraint object or an uninitialized handle
    */
   static Constraint DownCast( BaseHandle baseHandle );
 
@@ -491,7 +495,7 @@ public:
    *
    * Otherwise the constrained value will be discarded, when the constraint is removed.
    * @since_tizen 2.4
-   * @return The apply-action.
+   * @return The remove-action.
    */
   RemoveAction GetRemoveAction() const;
 
@@ -514,7 +518,7 @@ public:
 public: // Not intended for use by Application developers
 
   /**
-   * @brief This constructor is used by Dali New() methods
+   * @brief This constructor is used by Constraint::New() methods
    * @since_tizen 2.4
    * @param [in] constraint A pointer to a newly allocated Dali resource
    */