Skip to content

Commit

Permalink
Update centurion.hpp
Browse files Browse the repository at this point in the history
  • Loading branch information
@albin-johansson
albin-johansson committed May 3, 2021
1 parent 2012a2d commit d04405a
Showing 1 changed file with 38 additions and 50 deletions.
88 changes: 38 additions & 50 deletions include/centurion.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8516,8 +8516,6 @@ class common_event
*
* \return the event type value associated with the event.
*
* \see EventType
*
* \since 4.0.0
*/
[[nodiscard]] auto type() const noexcept -> event_type
Expand Down Expand Up @@ -8782,8 +8780,6 @@ class common_event
*
* \return the event type value associated with the event.
*
* \see EventType
*
* \since 4.0.0
*/
[[nodiscard]] auto type() const noexcept -> event_type
Expand Down Expand Up @@ -20907,8 +20903,7 @@ class mouse_motion_event final : public common_event<SDL_MouseMotionEvent>
{}

/**
* \brief Creates a `MouseMotionEvent` that is based on the supplied SDL
* event.
* \brief Creates an event based on an SDL event.
*
* \param event the SDL event that will be copied.
*
Expand Down Expand Up @@ -21180,8 +21175,7 @@ class mouse_wheel_event final : public common_event<SDL_MouseWheelEvent>
{}

/**
* \brief Creates a `MouseMotionEvent` that is based on the supplied SDL
* event.
* \brief Creates an event based on the supplied SDL event.
*
* \param event the SDL event that will be copied.
*
Expand Down Expand Up @@ -21426,8 +21420,7 @@ class multi_gesture_event final : public common_event<SDL_MultiGestureEvent>
{}

/**
* \brief Creates a `MultiGestureEvent` that is based on the supplied SDL
* event.
* \brief Creates an event that is based on the supplied SDL event.
*
* \param event the SDL event that will be copied.
*
Expand Down Expand Up @@ -21880,8 +21873,7 @@ class text_editing_event final : public common_event<SDL_TextEditingEvent>
}

/**
* \brief Creates a `TextEditingEvent` that is based on the supplied SDL
* event.
* \brief Creates an event that is based on the supplied SDL event.
*
* \param event the SDL event that will be copied.
*
Expand Down Expand Up @@ -22044,7 +22036,7 @@ class text_input_event final : public common_event<SDL_TextInputEvent>
{}

/**
* \brief Creates a `TextInputEvent` that is based on the supplied SDL event.
* \brief Creates an event that is based on the supplied SDL event.
*
* \param event the SDL event that will be copied.
*
Expand Down Expand Up @@ -22572,8 +22564,8 @@ class window_event final : public common_event<SDL_WindowEvent>
/**
* \brief Returns the event ID of this window event.
*
* \details There are many different kinds of window events, use this
* method to check what kind of action that triggered this event.
* \details There are many different kinds of window events, use this method to check
* what kind of action that triggered this event.
*
* \return the event ID of this window event.
*
Expand All @@ -22587,13 +22579,13 @@ class window_event final : public common_event<SDL_WindowEvent>
/**
* \brief Returns the value of the first data value.
*
* \details The meaning of this value is dependent on the window event ID
* of this window event.
* \details The meaning of this value is dependent on the window event ID of this window
* event.
*
* For instance, if the event ID is `SizeChanged`, then data1 and data2
* represent the new width and height of the window respectively. See the
* `WindowEventID` documentation for more details about whether the value
* returned from this method is meaningful in regard to the window event ID.
* For instance, if the event ID is `window_event_id::size_changed`, then data1 and
* data2 represent the new width and height of the window respectively. See the
* `window_event_id` documentation for more details about whether the value returned
* from this method is meaningful in regard to the window event ID.
*
* \return the value of the first data value.
*
Expand All @@ -22607,13 +22599,13 @@ class window_event final : public common_event<SDL_WindowEvent>
/**
* \brief Returns the value of the second data value.
*
* \details The meaning of this value is dependent on the window event ID
* of this window event.
* \details The meaning of this value is dependent on the window event ID of this window
* event.
*
* For instance, if the event ID is `SizeChanged`, then data1 and data2
* represent the new width and height of the window respectively. See the
* `WindowEventID` documentation for more details about whether the value
* returned from this method is meaningful in regard to the window event ID.
* For instance, if the event ID is `window_event_id::size_changed`, then data1 and
* data2 represent the new width and height of the window respectively. See the
* `window_event_id` documentation for more details about whether the value returned
* from this method is meaningful in regard to the window event ID.
*
* \return the value of the second data value.
*
Expand Down Expand Up @@ -25749,8 +25741,7 @@ class mouse_motion_event final : public common_event<SDL_MouseMotionEvent>
{}

/**
* \brief Creates a `MouseMotionEvent` that is based on the supplied SDL
* event.
* \brief Creates an event based on an SDL event.
*
* \param event the SDL event that will be copied.
*
Expand Down Expand Up @@ -26022,8 +26013,7 @@ class mouse_wheel_event final : public common_event<SDL_MouseWheelEvent>
{}

/**
* \brief Creates a `MouseMotionEvent` that is based on the supplied SDL
* event.
* \brief Creates an event based on the supplied SDL event.
*
* \param event the SDL event that will be copied.
*
Expand Down Expand Up @@ -26268,8 +26258,7 @@ class multi_gesture_event final : public common_event<SDL_MultiGestureEvent>
{}

/**
* \brief Creates a `MultiGestureEvent` that is based on the supplied SDL
* event.
* \brief Creates an event that is based on the supplied SDL event.
*
* \param event the SDL event that will be copied.
*
Expand Down Expand Up @@ -26561,8 +26550,7 @@ class text_editing_event final : public common_event<SDL_TextEditingEvent>
}

/**
* \brief Creates a `TextEditingEvent` that is based on the supplied SDL
* event.
* \brief Creates an event that is based on the supplied SDL event.
*
* \param event the SDL event that will be copied.
*
Expand Down Expand Up @@ -26725,7 +26713,7 @@ class text_input_event final : public common_event<SDL_TextInputEvent>
{}

/**
* \brief Creates a `TextInputEvent` that is based on the supplied SDL event.
* \brief Creates an event that is based on the supplied SDL event.
*
* \param event the SDL event that will be copied.
*
Expand Down Expand Up @@ -27253,8 +27241,8 @@ class window_event final : public common_event<SDL_WindowEvent>
/**
* \brief Returns the event ID of this window event.
*
* \details There are many different kinds of window events, use this
* method to check what kind of action that triggered this event.
* \details There are many different kinds of window events, use this method to check
* what kind of action that triggered this event.
*
* \return the event ID of this window event.
*
Expand All @@ -27268,13 +27256,13 @@ class window_event final : public common_event<SDL_WindowEvent>
/**
* \brief Returns the value of the first data value.
*
* \details The meaning of this value is dependent on the window event ID
* of this window event.
* \details The meaning of this value is dependent on the window event ID of this window
* event.
*
* For instance, if the event ID is `SizeChanged`, then data1 and data2
* represent the new width and height of the window respectively. See the
* `WindowEventID` documentation for more details about whether the value
* returned from this method is meaningful in regard to the window event ID.
* For instance, if the event ID is `window_event_id::size_changed`, then data1 and
* data2 represent the new width and height of the window respectively. See the
* `window_event_id` documentation for more details about whether the value returned
* from this method is meaningful in regard to the window event ID.
*
* \return the value of the first data value.
*
Expand All @@ -27288,13 +27276,13 @@ class window_event final : public common_event<SDL_WindowEvent>
/**
* \brief Returns the value of the second data value.
*
* \details The meaning of this value is dependent on the window event ID
* of this window event.
* \details The meaning of this value is dependent on the window event ID of this window
* event.
*
* For instance, if the event ID is `SizeChanged`, then data1 and data2
* represent the new width and height of the window respectively. See the
* `WindowEventID` documentation for more details about whether the value
* returned from this method is meaningful in regard to the window event ID.
* For instance, if the event ID is `window_event_id::size_changed`, then data1 and
* data2 represent the new width and height of the window respectively. See the
* `window_event_id` documentation for more details about whether the value returned
* from this method is meaningful in regard to the window event ID.
*
* \return the value of the second data value.
*
Expand Down

0 comments on commit d04405a

Please sign in to comment.