diff options
author | Campbell Barton <ideasman42@gmail.com> | 2012-03-02 20:05:54 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2012-03-02 20:05:54 +0400 |
commit | 7bbf4b78313df9f6d2c760b527eb36a5d0418b82 (patch) | |
tree | ace55a086362cf5b35174d55442322a793dd32c1 /source/gameengine/GamePlayer/common/GPC_MouseDevice.h | |
parent | c8636ca3dd8bde1cc548ef21fb7a1fd304799164 (diff) |
style cleanup
- spelling - turns out we had tessellation spelt wrong all over.
- use \directive for doxy (not @directive)
- remove BLI_sparsemap.h - was from bmesh merge IIRC but entire file commented and not used.
Diffstat (limited to 'source/gameengine/GamePlayer/common/GPC_MouseDevice.h')
-rw-r--r-- | source/gameengine/GamePlayer/common/GPC_MouseDevice.h | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/source/gameengine/GamePlayer/common/GPC_MouseDevice.h b/source/gameengine/GamePlayer/common/GPC_MouseDevice.h index c5576d1d234..2db1b1ec34c 100644 --- a/source/gameengine/GamePlayer/common/GPC_MouseDevice.h +++ b/source/gameengine/GamePlayer/common/GPC_MouseDevice.h @@ -41,7 +41,7 @@ /** * Generic Ketsji mouse device. - * @see SCA_IInputDevice + * \see SCA_IInputDevice */ class GPC_MouseDevice : public SCA_IInputDevice { @@ -65,39 +65,39 @@ public: /** * Call this routine to update the mouse device when a button state changes. - * @param button Which button state changes. - * @param isDown The new state of the button. - * @param x Position x-coordinate of the cursor at the time of the state change. - * @param y Position y-coordinate of the cursor at the time of the state change. - * @return Indication as to whether the event was processed. + * \param button Which button state changes. + * \param isDown The new state of the button. + * \param x Position x-coordinate of the cursor at the time of the state change. + * \param y Position y-coordinate of the cursor at the time of the state change. + * \return Indication as to whether the event was processed. */ virtual bool ConvertButtonEvent(TButtonId button, bool isDown); /** * Call this routine to update the mouse device when a button state and * cursor position changes at the same time (e.g. in Win32 messages). - * @param button Which button state changes. - * @param isDown The new state of the button. - * @param x Position x-coordinate of the cursor at the time of the state change. - * @param y Position y-coordinate of the cursor at the time of the state change. - * @return Indication as to whether the event was processed. + * \param button Which button state changes. + * \param isDown The new state of the button. + * \param x Position x-coordinate of the cursor at the time of the state change. + * \param y Position y-coordinate of the cursor at the time of the state change. + * \return Indication as to whether the event was processed. */ virtual bool ConvertButtonEvent(TButtonId button, bool isDown, int x, int y); /** * Call this routine to update the mouse device when the cursor has moved. - * @param x Position x-coordinate of the cursor. - * @param y Position y-coordinate of the cursor. - * @return Indication as to whether the event was processed. + * \param x Position x-coordinate of the cursor. + * \param y Position y-coordinate of the cursor. + * \return Indication as to whether the event was processed. */ virtual bool ConvertMoveEvent(int x, int y); protected: /** * This routine converts a single mouse event to a Ketsji mouse event. - * @param kxevent Ketsji event code. - * @param eventval Value for this event. - * @return Indication as to whether the event was processed. + * \param kxevent Ketsji event code. + * \param eventval Value for this event. + * \return Indication as to whether the event was processed. */ virtual bool ConvertEvent(KX_EnumInputs kxevent, int eventval); }; |