[3.0] Update doxygen comments

[platform/core/uifw/dali-core.git] / dali / public-api / object / property-conditions.h

diff --git a/dali/public-api/object/property-conditions.h b/dali/public-api/object/property-conditions.h
index 9b64967..6a4bf16 100644 (file)
--- a/dali/public-api/object/property-conditions.h
+++ b/dali/public-api/object/property-conditions.h
@@ -25,6 +25,10 @@
 
 namespace Dali
 {
+/**
+ * @addtogroup dali_core_object
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -33,6 +37,7 @@ class PropertyCondition;
 
 /**
  * @brief This represents a condition that can be evaluated on a Property::Value.
+ * @SINCE_1_0.0
  */
 class DALI_IMPORT_API PropertyCondition : public BaseHandle
 {
@@ -40,25 +45,29 @@ public:
 
   /**
    * @brief Constructor for condition clause.
+   * @SINCE_1_0.0
    */
   PropertyCondition();
 
   /**
    * @brief Destructor.
+   * @SINCE_1_0.0
    */
   ~PropertyCondition();
 
   /**
    * @brief This copy constructor is required for (smart) pointer semantics.
    *
-   * @param [in] handle A reference to the copied handle
+   * @SINCE_1_0.0
+   * @param[in] handle A reference to the copied handle
    */
   PropertyCondition( const PropertyCondition& handle );
 
   /**
    * @brief This assignment operator is required for (smart) pointer semantics.
    *
-   * @param [in] rhs  A reference to the copied handle
+   * @SINCE_1_0.0
+   * @param[in] rhs A reference to the copied handle
    * @return A reference to this
    */
   PropertyCondition& operator=( const PropertyCondition& rhs );
@@ -66,15 +75,18 @@ public:
 public:
 
   /**
-   * @brief Retrieve the arguments that this condition uses.
+   * @brief Retrieves the arguments that this condition uses.
    *
+   * @SINCE_1_0.0
    * @return The arguments used for this condition
    */
   std::size_t GetArgumentCount() const;
 
   /**
-   * @brief Retrieve the arguments that this condition uses.
+   * @brief Retrieves the arguments that this condition uses.
    *
+   * @SINCE_1_0.0
+   * @param[in] index The condition index to get the argument
    * @return The arguments used for this condition
    * @note The container will only be valid as long PropertyCondition is valid.
    */
@@ -91,6 +103,7 @@ public:
  * vector2 (the 2D length)
  * vector3 (the 3D length)
  * vector4 (the 4D length)
+ * @SINCE_1_0.0
  * @param[in] arg The argument for the condition
  * @return A property condition function object
  */
@@ -105,6 +118,7 @@ DALI_IMPORT_API PropertyCondition LessThanCondition( float arg );
  * vector2 (the 2D length)
  * vector3 (the 3D length)
  * vector4 (the 4D length)
+ * @SINCE_1_0.0
  * @param[in] arg The argument for the condition
  * @return A property condition function object
  */
@@ -119,6 +133,7 @@ DALI_IMPORT_API PropertyCondition GreaterThanCondition( float arg );
  * vector2 (the 2D length)
  * vector3 (the 3D length)
  * vector4 (the 4D length)
+ * @SINCE_1_0.0
  * @param[in] arg0 The first argument for the condition
  * @param[in] arg1 The second argument for the condition
  * @return A property condition function object
@@ -134,6 +149,7 @@ DALI_IMPORT_API PropertyCondition InsideCondition( float arg0, float arg1 );
  * vector2 (the 2D length)
  * vector3 (the 3D length)
  * vector4 (the 4D length)
+ * @SINCE_1_0.0
  * @param[in] arg0 The first argument for the condition
  * @param[in] arg1 The second argument for the condition
  * @return A property condition function object
@@ -141,13 +157,14 @@ DALI_IMPORT_API PropertyCondition InsideCondition( float arg0, float arg1 );
 DALI_IMPORT_API PropertyCondition OutsideCondition( float arg0, float arg1 );
 
 /**
- * @brief Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount
+ * @brief Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount.
  *
  * property type:
  * float (float)
  * vector2 (the 2D length)
  * vector3 (the 3D length)
  * vector4 (the 4D length)
+ * @SINCE_1_0.0
  * @param[in] stepAmount The step size required to trigger condition
  * @param[in] initialValue The initial value to step from
  * @return A property condition function object
@@ -155,18 +172,22 @@ DALI_IMPORT_API PropertyCondition OutsideCondition( float arg0, float arg1 );
 DALI_IMPORT_API PropertyCondition StepCondition( float stepAmount, float initialValue = 0.0f );
 
 /**
- * @brief Receive notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending
+ * @brief Receives notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending.
  *
  * property type:
  * float (float)
  * vector2 (the 2D length)
  * vector3 (the 3D length)
  * vector4 (the 4D length)
+ * @SINCE_1_0.0
  * @param[in] steps List of values to receive notifications for as a property crosses them
  * @return A property condition function object
  */
 DALI_IMPORT_API PropertyCondition VariableStepCondition( const Dali::Vector<float>& steps );
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PROPERTY_CONDITIONS_H__