Merge "Add descriptions and example codes" into devel/master

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

diff --git a/dali/public-api/events/long-press-gesture-detector.h b/dali/public-api/events/long-press-gesture-detector.h
index 9d383be..a0502c5 100644 (file)
--- a/dali/public-api/events/long-press-gesture-detector.h
+++ b/dali/public-api/events/long-press-gesture-detector.h
@@ -39,7 +39,6 @@ struct LongPressGesture;
 /**
  * @brief This class emits a signals when a long press gesture occurs that meets the requirements set by the application.
  * @SINCE_1_0.0
- * @see LongPressGestureDetector::SetTouchesRequired.
  *
  * For any valid long press, two signals will be emitted:
  * - First identifying the beginning (state = Started) i.e. when fingers held down for the required time.
@@ -70,7 +69,7 @@ public: // Creation & Destruction
   /**
    * @brief Create an uninitialized LongPressGestureDetector; this can be initialized with LongPressGestureDetector::New().
    *
-   * Calling member functions with an uninitialized Dali::Object is not allowed.
+   * Calling member functions with an uninitialized LongPressGestureDetector handle is not allowed.
    * @SINCE_1_0.0
    */
   LongPressGestureDetector();
@@ -108,13 +107,13 @@ public: // Creation & Destruction
   static LongPressGestureDetector New(unsigned int minTouches, unsigned int maxTouches);
 
   /**
-   * @brief Downcast an Object handle to LongPressGestureDetector handle.
+   * @brief Downcast a handle to LongPressGestureDetector handle.
    *
    * If handle points to a LongPressGestureDetector object the
    * downcast produces valid handle. If not the returned handle is left uninitialized.
    * @SINCE_1_0.0
-   * @param[in] handle to An object
-   * @return handle to a LongPressGestureDetector object or an uninitialized handle
+   * @param[in] handle Handle to an object
+   * @return Handle to a LongPressGestureDetector object or an uninitialized handle
    */
   static LongPressGestureDetector DownCast( BaseHandle handle );
 
@@ -210,13 +209,15 @@ public: // Signals
 
 public: // Not intended for Application developers
 
+  /// @cond internal
   /**
-   * @brief This constructor is used by Dali New() methods.
+   * @brief This constructor is used by LongPressGestureDetector::New() methods.
    *
    * @SINCE_1_0.0
    * @param [in]  internal  A pointer to a newly allocated Dali resource.
    */
   explicit DALI_INTERNAL LongPressGestureDetector(Internal::LongPressGestureDetector* internal);
+  /// @endcond
 
 };