Tizen 2.4.0 rev3 SDK Public Release

[framework/graphics/dali.git] / dali / public-api / events / pan-gesture-detector.h

diff --git a/dali/public-api/events/pan-gesture-detector.h b/dali/public-api/events/pan-gesture-detector.h
index 0b3febf..bb85515 100644 (file)
--- a/dali/public-api/events/pan-gesture-detector.h
+++ b/dali/public-api/events/pan-gesture-detector.h
@@ -58,10 +58,6 @@ struct PanGesture;
  * @since_tizen 2.4
  * @see PanGesture
  *
- * Signals
- * | %Signal Name | Method                |
- * |--------------|-----------------------|
- * | pan-detected | @ref DetectedSignal() |
  */
 class DALI_IMPORT_API PanGestureDetector : public GestureDetector
 {
@@ -75,21 +71,21 @@ public:
   {
     enum
     {
-      SCREEN_POSITION = DEFAULT_GESTURE_DETECTOR_PROPERTY_START_INDEX, ///< name "screen-position",     type Vector2
-      SCREEN_DISPLACEMENT,                                             ///< name "screen-displacement", type Vector2
-      SCREEN_VELOCITY,                                                 ///< name "screen-velocity",     type Vector2
-      LOCAL_POSITION,                                                  ///< name "local-position",      type Vector2
-      LOCAL_DISPLACEMENT,                                              ///< name "local-displacement",  type Vector2
-      LOCAL_VELOCITY,                                                  ///< name "local-velocity",      type Vector2
-      PANNING,                                                         ///< name "panning",             type bool
+      SCREEN_POSITION = DEFAULT_GESTURE_DETECTOR_PROPERTY_START_INDEX, ///< type Vector2 @since_tizen 2.4
+      SCREEN_DISPLACEMENT,                                             ///< type Vector2 @since_tizen 2.4
+      SCREEN_VELOCITY,                                                 ///< type Vector2 @since_tizen 2.4
+      LOCAL_POSITION,                                                  ///< type Vector2 @since_tizen 2.4
+      LOCAL_DISPLACEMENT,                                              ///< type Vector2 @since_tizen 2.4
+      LOCAL_VELOCITY,                                                  ///< type Vector2 @since_tizen 2.4
+      PANNING,                                                         ///< type bool @since_tizen 2.4
     };
   };
 
   // Typedefs
-  typedef Signal< void ( Actor, const PanGesture& ) > DetectedSignalType; ///< Pan gesture detected signal type
+  typedef Signal< void ( Actor, const PanGesture& ) > DetectedSignalType; ///< Pan gesture detected signal type @since_tizen 2.4
 
   // Directional Pan
-  typedef std::pair< Radian, Radian > AngleThresholdPair; ///< Range of angles for a direction
+  typedef std::pair< Radian, Radian > AngleThresholdPair; ///< Range of angles for a direction @since_tizen 2.4
 
   static const Radian DIRECTION_LEFT;       ///< For a left pan (-PI Radians).
   static const Radian DIRECTION_RIGHT;      ///< For a right pan (0 Radians).
@@ -105,7 +101,7 @@ public: // Creation & Destruction
   /**
    * @brief Create an uninitialized PanGestureDetector; this can be initialized with PanGestureDetector::New().
    *
-   * Calling member functions with an uninitialized Dali::Object is not allowed.
+   * Calling member functions with an uninitialized PanGestureDetector handle is not allowed.
    * @since_tizen 2.4
    */
   PanGestureDetector();
@@ -119,13 +115,13 @@ public: // Creation & Destruction
   static PanGestureDetector New();
 
   /**
-   * @brief Downcast an Object handle to PanGestureDetector handle.
+   * @brief Downcast a handle to PanGestureDetector handle.
    *
    * If handle points to a PanGestureDetector 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 PanGestureDetector object or an uninitialized handle
+   * @param[in] handle Handle to an object
+   * @return Handle to a PanGestureDetector object or an uninitialized handle
    */
   static PanGestureDetector DownCast( BaseHandle handle );
 
@@ -268,7 +264,7 @@ public: // Directional Panning
    * @brief Returns the angle by index that this pan gesture detector emits a signal.
    *
    * @since_tizen 2.4
-   * @return an angle threshold pair, or a zero valued angle pair when index is invalid.
+   * @return An angle threshold pair, or a zero valued angle pair when index is invalid.
    * @pre The gesture detector has been initialized.
    * @pre The index is less than GetAngleCount()
    */
@@ -336,10 +332,10 @@ public: // Pan Properties Setters
 public: // Not intended for Application developers
 
   /**
-   * @brief This constructor is used by Dali New() methods.
+   * @brief This constructor is used by PanGestureDetector::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 PanGestureDetector(Internal::PanGestureDetector* internal);