[3.0] Update doxygen comments

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

diff --git a/dali/public-api/events/wheel-event.h b/dali/public-api/events/wheel-event.h
index 7fb5c1b..fe53b91 100644 (file)
--- a/dali/public-api/events/wheel-event.h
+++ b/dali/public-api/events/wheel-event.h
@@ -26,7 +26,7 @@
 namespace Dali
 {
 /**
- * @addtogroup dali-core-events
+ * @addtogroup dali_core_events
  * @{
  */
 
@@ -39,67 +39,75 @@ namespace Dali
  *
  * We support a mouse device and there may be another custom device that support the wheel event. The device type is specified as \e type.
  * The mouse wheel event can be sent to the specific actor but the custom wheel event will be sent to the stage.
+ * @SINCE_1_0.0
  */
 struct DALI_IMPORT_API WheelEvent
 {
   // Enumerations
 
   /**
-   * @brief Specifies the type of the wheel event.
+   * @brief Enumeration for specifying the type of the wheel event.
+   * @SINCE_1_0.0
    */
   enum Type
   {
-    MOUSE_WHEEL,      ///< Mouse wheel event
-    CUSTOM_WHEEL      ///< Custom wheel event
+    MOUSE_WHEEL,      ///< Mouse wheel event @SINCE_1_0.0
+    CUSTOM_WHEEL      ///< Custom wheel event @SINCE_1_0.0
   };
 
   /**
    * @brief Default constructor.
+   * @SINCE_1_0.0
    */
   WheelEvent();
 
   /**
    * @brief Constructor.
    *
-   * @param[in]  type       The type of the wheel event
-   * @param[in]  direction  The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel)
-   * @param[in]  modifiers  modifier keys pressed during the event (such as shift, alt and control)
-   * @param[in]  point      The co-ordinates of the cursor relative to the top-left of the screen.
-   * @param[in]  z          The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise)
-   * @param[in]  timeStamp  The time the wheel is being rolled.
+   * @SINCE_1_0.0
+   * @param[in] type      The type of the wheel event
+   * @param[in] direction The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel)
+   * @param[in] modifiers Modifier keys pressed during the event (such as shift, alt and control)
+   * @param[in] point     The co-ordinates of the cursor relative to the top-left of the screen
+   * @param[in] z         The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise)
+   * @param[in] timeStamp The time the wheel is being rolled
    */
   WheelEvent( Type type, int direction, unsigned int modifiers, Vector2 point, int z, unsigned int timeStamp );
 
   /**
    * @brief Destructor.
+   * @SINCE_1_0.0
    */
   ~WheelEvent();
 
   /**
-   * @brief Check to see if Shift key modifier has been supplied.
+   * @brief Checks to see if Shift key modifier has been supplied.
    *
-   * @return bool true if shift modifier
+   * @SINCE_1_0.0
+   * @return True if shift modifier
    */
   bool IsShiftModifier() const;
 
   /**
-   * @brief Check to see if Ctrl (control) key modifier has been supplied.
+   * @brief Checks to see if Ctrl (control) key modifier has been supplied.
    *
-   * @return bool true if ctrl modifier
+   * @SINCE_1_0.0
+   * @return True if ctrl modifier
    */
   bool IsCtrlModifier() const;
 
   /**
-   * @brief Check to see if Alt key modifier has been supplied.
+   * @brief Checks to see if Alt key modifier has been supplied.
    *
-   * @return bool true if alt modifier
+   * @SINCE_1_0.0
+   * @return True if alt modifier
    */
   bool IsAltModifier() const;
 
   // Data
 
   /**
-   * @brief Type of the event
+   * @brief Type of the event.
    *
    * @see Type
    */
@@ -108,7 +116,7 @@ struct DALI_IMPORT_API WheelEvent
   /**
    * @brief The direction in which the wheel is being rolled.
    *
-   * 0 means the default vertical wheel, and 1 means horizontal wheel
+   * 0 means the default vertical wheel, and 1 means horizontal wheel.
    */
   int direction;