Making DALi public API typesafe using guaranteed types; uint8_t, uint32_t

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

diff --git a/dali/public-api/events/tap-gesture.h b/dali/public-api/events/tap-gesture.h
index a448499..6fc6852 100644 (file)
--- a/dali/public-api/events/tap-gesture.h
+++ b/dali/public-api/events/tap-gesture.h
@@ -2,7 +2,7 @@
 #define __DALI_TAP_GESTURE_H__
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2018 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.
@@ -24,34 +24,46 @@
 
 namespace Dali
 {
+/**
+ * @addtogroup dali_core_events
+ * @{
+ */
 
 /**
  * @brief A TapGesture is emitted when the user taps the screen with the stated number of fingers a stated number of times.
  *
  * This is a discrete gesture so does not have any state information.
+ * @SINCE_1_0.0
  * @see TapGestureDetector
  */
-struct DALI_IMPORT_API TapGesture : public Gesture
+struct DALI_CORE_API TapGesture : public Gesture
 {
   // Construction & Destruction
 
   /**
-   * @brief Default Constructor
+   * @brief Default Constructor.
+   * @SINCE_1_0.0
    */
   TapGesture();
 
   /**
-   * @brief Copy constructor
+   * @brief Copy constructor.
+   * @SINCE_1_0.0
+   * @param rhs A reference to the copied handle
    */
   TapGesture( const TapGesture& rhs );
 
   /**
-   * @brief Assignment operator
+   * @brief Assignment operator.
+   * @SINCE_1_0.0
+   * @param rhs A reference to the copied handle
+   * @return A reference to this
    */
   TapGesture& operator=( const TapGesture& rhs );
 
   /**
-   * @brief Virtual destructor
+   * @brief Virtual destructor.
+   * @SINCE_1_0.0
    */
   virtual ~TapGesture();
 
@@ -60,13 +72,13 @@ struct DALI_IMPORT_API TapGesture : public Gesture
   /**
    * @brief The number of taps in this tap gesture.
    */
-  unsigned int numberOfTaps;
+  uint32_t numberOfTaps;
 
   /**
    * @brief The number of touch points in this tap gesture, i.e. the number of fingers the user had on the
    * screen to generate the tap gesture.
    */
-  unsigned int numberOfTouches;
+  uint32_t numberOfTouches;
 
   /**
    * @brief This is the point, in screen coordinates, where the tap occurred.
@@ -79,11 +91,14 @@ struct DALI_IMPORT_API TapGesture : public Gesture
    * @brief This is the point, in local actor coordinates, where the tap occurred.
    *
    * If a multi-touch tap, 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_TAP_GESTURE_H__