[dali_1.1.21] Merge branch 'devel/master'

[platform/core/uifw/dali-core.git] / dali / public-api / events / touch-event.h

diff --git a/dali/public-api/events/touch-event.h b/dali/public-api/events/touch-event.h
index d1eebc5..3fc4463 100644 (file)
--- a/dali/public-api/events/touch-event.h
+++ b/dali/public-api/events/touch-event.h
@@ -2,7 +2,7 @@
 #define __DALI_TOUCH_EVENT_H__
 
 /*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2015 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.
@@ -19,17 +19,22 @@
  */
 
 // INTERNAL INCLUDES
-#include <dali/public-api/common/vector-wrapper.h>
 #include <dali/public-api/common/dali-common.h>
 #include <dali/public-api/events/touch-point.h>
 
-namespace Dali DALI_IMPORT_API
+namespace Dali
 {
 /**
+ * @addtogroup dali_core_events
+ * @{
+ */
+
+/**
  * @brief Touch events are a collection of touch points at a specific moment in time.
  *
  * When a multi-touch event occurs, each touch point represents the points that are currently being
  * touched or the points where a touch has stopped.
+ * @SINCE_1_0.0
  */
 struct DALI_IMPORT_API TouchEvent
 {
@@ -37,17 +42,20 @@ struct DALI_IMPORT_API TouchEvent
 
   /**
    * @brief Default constructor
+   * @SINCE_1_0.0
    */
   TouchEvent();
 
   /**
    * @brief Constructor
-   * @param[in]  time  The time the event occurred
+   * @SINCE_1_0.0
+   * @param[in] time The time the event occurred
    */
   TouchEvent(unsigned long time);
 
   /**
    * @brief Destructor
+   * @SINCE_1_0.0
    */
   ~TouchEvent();
 
@@ -71,6 +79,7 @@ struct DALI_IMPORT_API TouchEvent
   /**
    * @brief Returns the total number of points in this TouchEvent.
    *
+   * @SINCE_1_0.0
    * @return Total number of Points.
    */
   unsigned int GetPointCount() const;
@@ -80,14 +89,18 @@ struct DALI_IMPORT_API TouchEvent
    *
    * The first point in the set is always the primary
    * touch point (i.e. the first point touched in a multi-touch event).
-   * @note "point" should be less than the value returned by GetPointCount().
-   *       If out of range, then program asserts.
+   * @SINCE_1_0.0
    * @param[in] point The index of the required Point.
    * @return Point requested
+   * @note "point" should be less than the value returned by GetPointCount().
+   *       If out of range, then program asserts.
    */
   const TouchPoint& GetPoint(unsigned int point) const;
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_TOUCH_EVENT_H__