Update doxygen comments

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

diff --git a/dali/public-api/events/pinch-gesture-detector.h b/dali/public-api/events/pinch-gesture-detector.h
index 7109ca6..33b4e9f 100644 (file)
--- a/dali/public-api/events/pinch-gesture-detector.h
+++ b/dali/public-api/events/pinch-gesture-detector.h
@@ -24,6 +24,10 @@
 
 namespace Dali
 {
+/**
+ * @addtogroup dali_core_events
+ * @{
+ */
 
 namespace Internal DALI_INTERNAL
 {
@@ -46,12 +50,13 @@ struct PinchGesture;
  * detector.DetectedSignal().Connect(this, &MyApplication::OnPinch);
  * @endcode
  *
+ * @SINCE_1_0.0
  * @see PinchGesture
  *
  * Signals
  * | %Signal Name   | Method                |
  * |----------------|-----------------------|
- * | pinch-detected | @ref DetectedSignal() |
+ * | pinchDetected  | @ref DetectedSignal() |
  */
 class DALI_IMPORT_API PinchGestureDetector : public GestureDetector
 {
@@ -59,53 +64,60 @@ public: // Typedefs
 
   /**
    * @brief Signal type.
+   * @SINCE_1_0.0
    */
   typedef Signal< void ( Actor, const PinchGesture& ) > DetectedSignalType;
 
 public: // Creation & Destruction
 
   /**
-   * @brief Create an uninitialized PinchGestureDetector; this can be initialized with PinchGestureDetector::New().
+   * @brief Creates an uninitialized PinchGestureDetector; this can be initialized with PinchGestureDetector::New().
    *
-   * Calling member functions with an uninitialized Dali::Object is not allowed.
+   * Calling member functions with an uninitialized PinchGestureDetector handle is not allowed.
+   * @SINCE_1_0.0
    */
   PinchGestureDetector();
 
   /**
-   * @brief Create an initialized PinchGestureDetector.
+   * @brief Creates an initialized PinchGestureDetector.
    *
-   * @return A handle to a newly allocated Dali resource.
+   * @SINCE_1_0.0
+   * @return A handle to a newly allocated Dali resource
    */
   static PinchGestureDetector New();
 
   /**
-   * @brief Downcast an Object handle to PinchGestureDetector handle.
+   * @brief Downcasts a handle to PinchGestureDetector handle.
    *
-   * If handle points to a PinchGestureDetector object the
-   * downcast produces valid handle. If not the returned handle is left uninitialized.
-   * @param[in] handle to An object
-   * @return handle to a PinchGestureDetector object or an uninitialized handle
+   * If handle points to a PinchGestureDetector object, the
+   * downcast produces valid handle. If not, the returned handle is left uninitialized.
+   * @SINCE_1_0.0
+   * @param[in] handle Handle to an object
+   * @return Handle to a PinchGestureDetector object or an uninitialized handle
    */
   static PinchGestureDetector DownCast( BaseHandle handle );
 
   /**
-   * @brief Destructor
+   * @brief Destructor.
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
+   * @SINCE_1_0.0
    */
   ~PinchGestureDetector();
 
   /**
    * @brief This copy constructor is required for (smart) pointer semantics.
    *
-   * @param [in] handle A reference to the copied handle
+   * @SINCE_1_0.0
+   * @param[in] handle A reference to the copied handle
    */
   PinchGestureDetector(const PinchGestureDetector& handle);
 
   /**
    * @brief This assignment operator is required for (smart) pointer semantics.
    *
-   * @param [in] rhs  A reference to the copied handle
+   * @SINCE_1_0.0
+   * @param[in] rhs A reference to the copied handle
    * @return A reference to this
    */
   PinchGestureDetector& operator=(const PinchGestureDetector& rhs);
@@ -119,22 +131,29 @@ public: // Signals
    * @code
    *   void YourCallbackName( Actor actor, const PinchGesture& gesture );
    * @endcode
+   * @SINCE_1_0.0
+   * @return The signal to connect to
    * @pre The gesture detector has been initialized.
-   * @return The signal to connect to.
    */
   DetectedSignalType& DetectedSignal();
 
 public: // Not intended for Application developers
 
+  /// @cond internal
   /**
-   * @brief This constructor is used by Dali New() methods.
+   * @brief This constructor is used by PinchGestureDetector::New() methods.
    *
-   * @param [in]  internal  A pointer to a newly allocated Dali resource.
+   * @SINCE_1_0.0
+   * @param[in] internal A pointer to a newly allocated Dali resource
    */
   explicit DALI_INTERNAL PinchGestureDetector(Internal::PinchGestureDetector* internal);
+  /// @endcond
 
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_PINCH_GESTURE_DETECTOR_H__