[3.0] Update doxygen comments

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

diff --git a/dali/public-api/events/touch-point.h b/dali/public-api/events/touch-point.h
index ccd5652..3cd23f8 100644 (file)
--- a/dali/public-api/events/touch-point.h
+++ b/dali/public-api/events/touch-point.h
@@ -2,7 +2,7 @@
 #define __DALI_TOUCH_POINT_H__
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2016 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,6 +19,7 @@
  */
 
 // INTERNAL INCLUDES
+#include <dali/public-api/common/vector-wrapper.h>
 #include <dali/public-api/actors/actor.h>
 #include <dali/public-api/math/vector2.h>
 
@@ -32,13 +33,15 @@ namespace Dali
 /**
  * @brief A TouchPoint represents a point on the screen that is currently being touched
  * or where touch has stopped.
+ * @SINCE_1_0.0
  */
 struct DALI_IMPORT_API TouchPoint
 {
   // Enumerations
 
   /**
-   * @brief Touch state
+   * @brief Enumeration for Touch state.
+   * @SINCE_1_0.0
    */
   enum State
   {
@@ -58,29 +61,32 @@ struct DALI_IMPORT_API TouchPoint
   // Construction & Destruction
 
   /**
-   * @brief Constructor
+   * @brief Constructor.
    *
-   * @param[in]  id       The touch device ID.
-   * @param[in]  state    The state.
-   * @param[in]  screenX  The X co-ordinate relative to the screen's origin.
-   * @param[in]  screenY  The Y co-ordinate relative to the screen's origin.
+   * @SINCE_1_0.0
+   * @param[in] id      The touch device ID
+   * @param[in] state   The state
+   * @param[in] screenX The X co-ordinate relative to the screen's origin
+   * @param[in] screenY The Y co-ordinate relative to the screen's origin
    */
   TouchPoint(int id, State state, float screenX, float screenY);
 
   /**
-   * @brief Constructor
+   * @brief Constructor.
    *
-   * @param[in]  id       The touch device ID.
-   * @param[in]  state    The state.
-   * @param[in]  screenX  The X co-ordinate relative to the screen's origin.
-   * @param[in]  screenY  The Y co-ordinate relative to the screen's origin.
-   * @param[in]  localX   The X co-ordinate relative to the top-left (0.0, 0.0, 0.5) of the actor.
-   * @param[in]  localY   The Y co-ordinate relative to the top-left (0.0, 0.0, 0.5) of the actor.
+   * @SINCE_1_0.0
+   * @param[in] id      The touch device ID
+   * @param[in] state   The state
+   * @param[in] screenX The X co-ordinate relative to the screen's origin
+   * @param[in] screenY The Y co-ordinate relative to the screen's origin
+   * @param[in] localX  The X co-ordinate relative to the top-left (0.0, 0.0, 0.5) of the actor
+   * @param[in] localY  The Y co-ordinate relative to the top-left (0.0, 0.0, 0.5) of the actor
    */
   TouchPoint(int id, State state, float screenX, float screenY, float localX, float localY);
 
   /**
-   * @brief Destructor
+   * @brief Destructor.
+   * @SINCE_1_0.0
    */
   ~TouchPoint();
 
@@ -118,9 +124,9 @@ struct DALI_IMPORT_API TouchPoint
   Vector2 screen;
 };
 
-typedef std::vector<TouchPoint> TouchPointContainer; ///< Container of touch points.
-typedef TouchPointContainer::iterator TouchPointContainerIterator; ///< Iterator for Dali::TouchPointContainer
-typedef TouchPointContainer::const_iterator TouchPointContainerConstIterator; ///< Const iterator for Dali::TouchPointContainer
+typedef std::vector<TouchPoint> TouchPointContainer; ///< Container of touch points. @SINCE_1_0.0
+typedef TouchPointContainer::iterator TouchPointContainerIterator; ///< Iterator for Dali::TouchPointContainer @SINCE_1_0.0
+typedef TouchPointContainer::const_iterator TouchPointContainerConstIterator; ///< Const iterator for Dali::TouchPointContainer @SINCE_1_0.0
 
 /**
  * @}