[3.0] Update doxygen comments
[platform/core/uifw/dali-core.git] / dali / public-api / events / hover-event.h
index 95a7e7a..3cde5c4 100644 (file)
@@ -25,7 +25,7 @@
 namespace Dali
 {
 /**
- * @addtogroup dali-core-events
+ * @addtogroup dali_core_events
  * @{
  */
 
@@ -34,24 +34,28 @@ namespace Dali
  *
  * When a multi-touch event occurs, each touch point represents the points that are currently being
  * hovered or the points where a hover has stopped.
+ * @SINCE_1_0.0
  */
 struct DALI_IMPORT_API HoverEvent
 {
   // Construction & Destruction
 
   /**
-   * @brief Default constructor
+   * @brief Default constructor.
+   * @SINCE_1_0.0
    */
   HoverEvent();
 
   /**
-   * @brief Constructor
-   * @param[in]  time  The time the event occurred
+   * @brief Constructor.
+   * @SINCE_1_0.0
+   * @param[in] time The time the event occurred
    */
   HoverEvent(unsigned long time);
 
   /**
-   * @brief Destructor
+   * @brief Destructor.
+   * @SINCE_1_0.0
    */
   ~HoverEvent();
 
@@ -75,7 +79,8 @@ struct DALI_IMPORT_API HoverEvent
   /**
    * @brief Returns the total number of points in this HoverEvent.
    *
-   * @return Total number of Points.
+   * @SINCE_1_0.0
+   * @return Total number of Points
    */
   unsigned int GetPointCount() const;
 
@@ -84,10 +89,11 @@ struct DALI_IMPORT_API HoverEvent
    *
    * The first point in the set is always the primary
    * touch point (i.e. the first point touched in a multi-touch event).
+   * @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.
-   * @param[in] point The index of the required Point.
-   * @return Point requested
    */
   const TouchPoint& GetPoint(unsigned int point) const;
 };