[3.0] Update doxygen comments
[platform/core/uifw/dali-core.git] / dali / public-api / events / pinch-gesture.h
index 7351788..9b13be5 100644 (file)
@@ -33,12 +33,13 @@ namespace Dali
  * @brief A PinchGesture is emitted when the user moves two fingers towards or away from each other.
  *
  * This gesture can be in one of three states; when the pinch gesture is first detected, its
- * state is set to "Started".  After this, if there is change in the gesture, the state will
- * be "Continuing".  Finally, when the gesture ends, the state of the gesture changes to
- * "Finished".
+ * state is set to Gesture::Started.  After this, if there is change in the gesture, the state will
+ * be Gesture::Continuing. Finally, when the gesture ends, the state of the gesture changes to
+ * Gesture::Finished.
  *
  * A pinch gesture will continue to be sent to the actor under the center point of the pinch
  * until the pinch ends.
+ * @SINCE_1_0.0
  */
 struct DALI_IMPORT_API PinchGesture: public Gesture
 {
@@ -47,22 +48,29 @@ struct DALI_IMPORT_API PinchGesture: public Gesture
   /**
    * @brief Default Constructor.
    *
-   * @param[in]  state  The state of the gesture
+   * @SINCE_1_0.0
+   * @param[in] state The state of the gesture
    */
   PinchGesture(Gesture::State state);
 
   /**
    * @brief Copy constructor.
+   * @SINCE_1_0.0
+   * @param[in] rhs A reference to the copied handle
    */
   PinchGesture( const PinchGesture& rhs );
 
   /**
    * @brief Assignment operator.
+   * @SINCE_1_0.0
+   * @param[in] rhs A reference to the copied handle
+   * @return A reference to this
    */
   PinchGesture& operator=( const PinchGesture& rhs );
 
   /**
    * @brief Virtual destructor.
+   * @SINCE_1_0.0
    */
   virtual ~PinchGesture();