[3.0] Update doxygen comments

[platform/core/uifw/dali-core.git] / dali / public-api / events / long-press-gesture.h

diff --git a/dali/public-api/events/long-press-gesture.h b/dali/public-api/events/long-press-gesture.h
index 7258f0a..1f7c4ee 100644 (file)
--- a/dali/public-api/events/long-press-gesture.h
+++ b/dali/public-api/events/long-press-gesture.h
@@ -2,7 +2,7 @@
 #define __DALI_LONG_PRESS_GESTURE_H__
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2015 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,42 +22,54 @@
 #include <dali/public-api/events/gesture.h>
 #include <dali/public-api/math/vector2.h>
 
-namespace Dali DALI_IMPORT_API
+namespace Dali
 {
+/**
+ * @addtogroup dali_core_events
+ * @{
+ */
 
 /**
  * @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 LongPressGesture : public Gesture
+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();
 
@@ -80,11 +92,14 @@ struct 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;
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_LONG_PRESS_GESTURE_H__