[3.0] Update doxygen comments

[platform/core/uifw/dali-core.git] / dali / public-api / animation / constraint-source.h

diff --git a/dali/public-api/animation/constraint-source.h b/dali/public-api/animation/constraint-source.h
index 9d107e8..c967eb0 100644 (file)
--- a/dali/public-api/animation/constraint-source.h
+++ b/dali/public-api/animation/constraint-source.h
@@ -24,29 +24,36 @@
 
 namespace Dali
 {
+/**
+ * @addtogroup dali_core_animation
+ * @{
+ */
 
 /**
- * @brief Constraint source types.
+ * @brief Enumeration for constraint source types.
  *
  * This specifies the location of a property, which is used as an input for a constraint function.
+ * @SINCE_1_0.0
  */
 enum SourceType
 {
-  OBJECT_PROPERTY, ///< The property comes from an arbitrary object.
-  LOCAL_PROPERTY,  ///< The property comes from the object which the constraint is applied to.
-  PARENT_PROPERTY  ///< The property comes from the parent of the object, which the constraint is applied to.
+  OBJECT_PROPERTY, ///< The property comes from an arbitrary object. @SINCE_1_0.0
+  LOCAL_PROPERTY,  ///< The property comes from the object which the constraint is applied to. @SINCE_1_0.0
+  PARENT_PROPERTY  ///< The property comes from the parent of the object, which the constraint is applied to. @SINCE_1_0.0
 };
 
 
 /**
  * @brief Identifies a property from an object.
+ * @SINCE_1_0.0
  */
 struct DALI_IMPORT_API LocalSource
 {
   /**
-   * @brief Create a local constraint source.
+   * @brief Creates a local constraint source.
    *
-   * @param [in] index The index of a property provided by the constrained object.
+   * @SINCE_1_0.0
+   * @param[in] index The index of a property provided by the constrained object
    */
   LocalSource( Property::Index index );
 
@@ -55,13 +62,15 @@ struct DALI_IMPORT_API LocalSource
 
 /**
  * @brief Identifies a property from the parent of an object.
+ * @SINCE_1_0.0
  */
 struct DALI_IMPORT_API ParentSource
 {
   /**
-   * @brief Create a local constraint source.
+   * @brief Creates a parent constraint source.
    *
-   * @param [in] index The index of a property, provided by the parent of the constrained object.
+   * @SINCE_1_0.0
+   * @param[in] index The index of a property, provided by the parent of the constrained object
    */
   ParentSource( Property::Index index );
 
@@ -70,14 +79,16 @@ struct DALI_IMPORT_API ParentSource
 
 /**
  * @brief Identifies a property from any object.
+ * @SINCE_1_0.0
  */
 struct DALI_IMPORT_API Source
 {
   /**
-   * @brief Create a constraint source.
+   * @brief Creates a constraint source.
    *
-   * @param [in] object The object providing the property.
-   * @param [in] index The index of a property provided by object.
+   * @SINCE_1_0.0
+   * @param[in] object The object providing the property
+   * @param[in] index The index of a property provided by object
    */
   Source( Handle& object, Property::Index index );
 
@@ -88,27 +99,31 @@ struct DALI_IMPORT_API Source
 
 /**
  * @brief The source of an input property for a constraint.
+ * @SINCE_1_0.0
  */
 struct DALI_IMPORT_API ConstraintSource
 {
   /**
-   * @brief Create a constraint source.
+   * @brief Creates a constraint source.
    *
-   * @param [in] source A constraint source from an arbitrary object.
+   * @SINCE_1_0.0
+   * @param[in] source A constraint source from an arbitrary object
    */
   ConstraintSource( Source source );
 
   /**
-   * @brief Create a constraint source.
+   * @brief Creates a constraint source.
    *
-   * @param [in] local A local constraint source.
+   * @SINCE_1_0.0
+   * @param[in] local A local constraint source
    */
   ConstraintSource( LocalSource local );
 
   /**
-   * @brief Create a constraint source.
+   * @brief Creates a constraint source.
    *
-   * @param [in] parent A parent constraint source.
+   * @SINCE_1_0.0
+   * @param[in] parent A parent constraint source
    */
   ConstraintSource( ParentSource parent );
 
@@ -119,6 +134,9 @@ struct DALI_IMPORT_API ConstraintSource
   Handle object; ///< The target object; only valid if sourceType == OBJECT_PROPERTY
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_CONSTRAINT_SOURCE_H__