Tizen 2.4.0 rev3 SDK Public Release
[framework/graphics/dali.git] / dali / public-api / events / tap-gesture-detector.h
index 7363678..3a95c8e 100644 (file)
@@ -40,9 +40,9 @@ struct TapGesture;
  * @brief This class emits a signal when a tap gesture occurs that meets the requirements set by the
  * application.
  *
- * See TapGestureDetector::SetTapsRequired
+ * See @ref TapGestureDetector::SetTapsRequired
  *
- * A Tap Gesture is a discrete gesture, which means it does not have any state information attached
+ * A TapGesture is a discrete gesture, which means it does not have any state information attached
  * to it.  Please see TapGesture for more information.
  *
  * The application programmer can use this gesture detector as follows:
@@ -55,10 +55,6 @@ struct TapGesture;
  * @since_tizen 2.4
  * @note Multi-touch taps are not currently supported. However, multiple taps (double & triple tap etc.) ARE supported.
  *
- * Signals
- * | %Signal Name | Method                |
- * |--------------|-----------------------|
- * | tap-detected | @ref DetectedSignal() |
  * @see TapGesture
  *
  */
@@ -77,7 +73,7 @@ public: // Creation & Destruction
   /**
    * @brief Create an uninitialized TapGestureDetector; this can be initialized with TapGestureDetector::New().
    *
-   * Calling member functions with an uninitialized Dali::Object is not allowed.
+   * Calling member functions with an uninitialized TapGestureDetector handle is not allowed.
    * @since_tizen 2.4
    */
   TapGestureDetector();
@@ -95,19 +91,19 @@ public: // Creation & Destruction
    * @brief Create an initialized TapGestureDetector with the specified parameters.
    *
    * @since_tizen 2.4
-   * @param[in]  tapsRequired     The minimum & maximum number of taps required.
+   * @param[in] tapsRequired The minimum & maximum number of taps required.
    * @return A handle to a newly allocated Dali resource.
    */
   static TapGestureDetector New( unsigned int tapsRequired );
 
   /**
-   * @brief Downcast an Object handle to TapGestureDetector handle.
+   * @brief Downcast a handle to TapGestureDetector handle.
    *
    * If handle points to a TapGestureDetector object the
    * downcast produces valid handle. If not the returned handle is left uninitialized.
    * @since_tizen 2.4
-   * @param[in] handle to An object
-   * @return handle to a TapGestureDetector object or an uninitialized handle
+   * @param[in] handle Handle to an object
+   * @return Handle to a TapGestureDetector object or an uninitialized handle
    */
   static TapGestureDetector DownCast( BaseHandle handle );
 
@@ -198,10 +194,10 @@ public: // Signals
 public: // Not intended for Application developers
 
   /**
-   * @brief This constructor is used by Dali New() methods.
+   * @brief This constructor is used by TapGestureDetector::New() methods.
    *
    * @since_tizen 2.4
-   * @param [in]  internal  A pointer to a newly allocated Dali resource.
+   * @param [in] internal A pointer to a newly allocated Dali resource.
    */
   explicit DALI_INTERNAL TapGestureDetector(Internal::TapGestureDetector* internal);
 };