[3.0] Update doxygen comments
[platform/core/uifw/dali-core.git] / dali / public-api / events / long-press-gesture.h
index 2fc9bc4..1f7c4ee 100644 (file)
@@ -32,11 +32,12 @@ namespace Dali
 /**
  * @brief A LongPressGesture is emitted when the user touches and holds the screen with the stated number of fingers.
  *
- * This gesture can be in one of two states, when the long-press gesture is first detected: "Started";
- * and when the long-press gesture ends: "Finished".
+ * This gesture can be in one of two states, when the long-press gesture is first detected: Gesture::Started
+ * and when the long-press gesture ends: Gesture::Finished.
  *
  * Long press gesture finishes when all touches have been released.
  *
+ * @SINCE_1_0.0
  * @see LongPressGestureDetector
  */
 struct DALI_IMPORT_API LongPressGesture : public Gesture
@@ -44,24 +45,31 @@ struct DALI_IMPORT_API LongPressGesture : public Gesture
   // Construction & Destruction
 
   /**
-   * @brief Constructor
+   * @brief Constructor.
    *
-   * @param[in] state  The state of the gesture
+   * @SINCE_1_0.0
+   * @param[in] state The state of the gesture
    */
   LongPressGesture(Gesture::State state);
 
   /**
-   * @brief Copy constructor
+   * @brief Copy constructor.
+   * @SINCE_1_0.0
+   * @param[in] rhs A reference to the copied handle
    */
   LongPressGesture( const LongPressGesture& rhs );
 
   /**
-   * @brief Assignment operator
+   * @brief Assignment operator.
+   * @SINCE_1_0.0
+   * @param[in] rhs A reference to the copied handle
+   * @return A reference to this
    */
   LongPressGesture& operator=( const LongPressGesture& rhs );
 
   /**
-   * @brief Virtual destructor
+   * @brief Virtual destructor.
+   * @SINCE_1_0.0
    */
   virtual ~LongPressGesture();
 
@@ -84,7 +92,7 @@ struct DALI_IMPORT_API LongPressGesture : public Gesture
    * @brief This is the point, in local actor coordinates, where the long press occurred.
    *
    * If a multi-touch long press, then this is the centroid of all the touch points.
-   * @return The point where tap has occurred (in local actor coordinates).
+   * @return The point where tap has occurred (in local actor coordinates)
    */
   Vector2 localPoint;
 };