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 | |
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')
5 files changed, 49 insertions, 49 deletions
diff --git a/source/gameengine/GamePlayer/common/GPC_Canvas.h b/source/gameengine/GamePlayer/common/GPC_Canvas.h index 28105a8cdd8..cd2bc7e374e 100644 --- a/source/gameengine/GamePlayer/common/GPC_Canvas.h +++ b/source/gameengine/GamePlayer/common/GPC_Canvas.h @@ -106,7 +106,7 @@ public: virtual void ResizeWindow(int width, int height){}; /** - * @section Methods inherited from abstract base class RAS_ICanvas. + * \section Methods inherited from abstract base class RAS_ICanvas. */ int @@ -157,7 +157,7 @@ public: void ClearColor(float r, float g, float b, float a); /** - * @section Methods inherited from abstract base class RAS_ICanvas. + * \section Methods inherited from abstract base class RAS_ICanvas. * Semantics are not yet honored. */ @@ -176,20 +176,20 @@ public: void ClearBuffer(int type); /** - * @section Services provided by this class. + * \section Services provided by this class. */ /** * Enables display of a banner. * The image data is copied inside. - * @param bannerWidth Display width of the banner. - * @param bannerHeight Display height of the banner. - * @param imageWidth Width of the banner image in pixels. - * @param imageHeight Height of the banner image in pixels. - * @param imageData Pointer to the pixels of the image to display. - * @param alignment Where the banner will be positioned on the canvas. - * @param enabled Whether the banner will be displayed initially. - * @return A banner id. + * \param bannerWidth Display width of the banner. + * \param bannerHeight Display height of the banner. + * \param imageWidth Width of the banner image in pixels. + * \param imageHeight Height of the banner image in pixels. + * \param imageData Pointer to the pixels of the image to display. + * \param alignment Where the banner will be positioned on the canvas. + * \param enabled Whether the banner will be displayed initially. + * \return A banner id. */ TBannerId AddBanner( unsigned int bannerWidth, unsigned int bannerHeight, @@ -199,7 +199,7 @@ public: /** * Disposes a banner. - * @param id Banner to be disposed. + * \param id Banner to be disposed. */ void DisposeBanner(TBannerId id); @@ -210,21 +210,21 @@ public: /** * Enables or disables display of a banner. - * @param id Banner id of the banner to be enabled/disabled. - * @param enabled New state of the banner. + * \param id Banner id of the banner to be enabled/disabled. + * \param enabled New state of the banner. */ void SetBannerEnabled(TBannerId id, bool enabled = true); /** * Enables or disables display of all banners. - * @param enabled New state of the banners. + * \param enabled New state of the banners. */ void SetBannerDisplayEnabled(bool enabled = true); protected: /** * Disposes a banner. - * @param it Banner to be disposed. + * \param it Banner to be disposed. */ void DisposeBanner(TBannerData& banner); diff --git a/source/gameengine/GamePlayer/common/GPC_KeyboardDevice.h b/source/gameengine/GamePlayer/common/GPC_KeyboardDevice.h index ba4213b190c..63e051dd1d4 100644 --- a/source/gameengine/GamePlayer/common/GPC_KeyboardDevice.h +++ b/source/gameengine/GamePlayer/common/GPC_KeyboardDevice.h @@ -45,7 +45,7 @@ * System independent implementation of SCA_IInputDevice. * System dependent keyboard devices need only to inherit this class * and fill the m_reverseKeyTranslateTable key translation map. - * @see SCA_IInputDevice + * \see SCA_IInputDevice */ class GPC_KeyboardDevice : public SCA_IInputDevice 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); }; diff --git a/source/gameengine/GamePlayer/common/GPC_RawImage.h b/source/gameengine/GamePlayer/common/GPC_RawImage.h index 86a5feb8ea3..4d3f45597f8 100644 --- a/source/gameengine/GamePlayer/common/GPC_RawImage.h +++ b/source/gameengine/GamePlayer/common/GPC_RawImage.h @@ -52,16 +52,16 @@ public: /** * Loads the image form the resource into memory. * Converts size of the image and places it with given alignment. - * @param hInstApp The application's instance (location of the resources). - * @param lpName Name of the resource. - * @param lpType Type of the resource. - * @param srcWidth The width of the resource image. - * @param srcHeight The height of the resource image. - * @param width The width of the image created. - * @param height The height of the image created. - * @param alignment How the resource image is located in the image created. - * @param offsetX Amount of horizontal offset applied to the resource image. - * @param offsetY Amount of vertical offset applied to the resource image. + * \param hInstApp The application's instance (location of the resources). + * \param lpName Name of the resource. + * \param lpType Type of the resource. + * \param srcWidth The width of the resource image. + * \param srcHeight The height of the resource image. + * \param width The width of the image created. + * \param height The height of the image created. + * \param alignment How the resource image is located in the image created. + * \param offsetX Amount of horizontal offset applied to the resource image. + * \param offsetY Amount of vertical offset applied to the resource image. */ virtual bool Load(const char *srcName, int destWidth, int destHeight, @@ -70,7 +70,7 @@ public: /** * Returns the width of the image. - * @return The width of the image. + * \return The width of the image. */ virtual int Width() const { @@ -79,7 +79,7 @@ public: /** * Returns the height of the image. - * @return The height of the image. + * \return The height of the image. */ virtual int Height() const { @@ -88,7 +88,7 @@ public: /** * Returns a pointer to the data loaded from the resource. - * @return A pointer to the data loaded from the resource. + * \return A pointer to the data loaded from the resource. */ virtual unsigned char *Data() const { @@ -97,7 +97,7 @@ public: /** * Returns the size of the data loaded from the resource. - * @return The size of the loaded from the resource. + * \return The size of the loaded from the resource. */ virtual int DataSize() const { diff --git a/source/gameengine/GamePlayer/common/GPC_RenderTools.h b/source/gameengine/GamePlayer/common/GPC_RenderTools.h index 54bf45fc74b..166a931beab 100644 --- a/source/gameengine/GamePlayer/common/GPC_RenderTools.h +++ b/source/gameengine/GamePlayer/common/GPC_RenderTools.h @@ -77,7 +77,7 @@ public: float* color, double* mat, float aspect); - /* @attention mode is ignored here */ + /* \attention mode is ignored here */ void RenderText2D(RAS_TEXT_RENDER_MODE mode, const char* text, int xco, |