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/Rasterizer | |
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/Rasterizer')
-rw-r--r-- | source/gameengine/Rasterizer/RAS_FramingManager.h | 4 | ||||
-rw-r--r-- | source/gameengine/Rasterizer/RAS_ICanvas.h | 4 | ||||
-rw-r--r-- | source/gameengine/Rasterizer/RAS_IPolygonMaterial.h | 8 | ||||
-rw-r--r-- | source/gameengine/Rasterizer/RAS_IRasterizer.h | 38 | ||||
-rw-r--r-- | source/gameengine/Rasterizer/RAS_IRenderTools.h | 26 |
5 files changed, 40 insertions, 40 deletions
diff --git a/source/gameengine/Rasterizer/RAS_FramingManager.h b/source/gameengine/Rasterizer/RAS_FramingManager.h index 4ea2d998190..ddf889aeb37 100644 --- a/source/gameengine/Rasterizer/RAS_FramingManager.h +++ b/source/gameengine/Rasterizer/RAS_FramingManager.h @@ -39,7 +39,7 @@ class RAS_Rect; /** - * @section RAS_FrameSettings + * \section RAS_FrameSettings * This is a value type describing the framing used * by a particular scene in the game engine. * Each KX_Scene contains a RAS_FrameSetting describing @@ -193,7 +193,7 @@ enum RAS_SensorFit }; /** - * @section RAS_FramingManager + * \section RAS_FramingManager * This class helps to compute a view frustum * and a viewport rectangle given the * above settings and a description of the diff --git a/source/gameengine/Rasterizer/RAS_ICanvas.h b/source/gameengine/Rasterizer/RAS_ICanvas.h index e35ec1d16d2..b7c26928378 100644 --- a/source/gameengine/Rasterizer/RAS_ICanvas.h +++ b/source/gameengine/Rasterizer/RAS_ICanvas.h @@ -80,8 +80,8 @@ public: * Initializes the canvas for drawing. Drawing to the canvas is * only allowed between BeginDraw() and EndDraw(). * - * @retval false Acquiring the canvas failed. - * @retval true Acquiring the canvas succeeded. + * \retval false Acquiring the canvas failed. + * \retval true Acquiring the canvas succeeded. * */ diff --git a/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h b/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h index 0da0b17f6c1..3257682649f 100644 --- a/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h +++ b/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h @@ -135,7 +135,7 @@ public: /** * Returns the caching information for this material, * This can be used to speed up the rasterizing process. - * @return The caching information. + * \return The caching information. */ virtual TCachingInfo GetCachingInfo(void) const { return 0; } @@ -143,8 +143,8 @@ public: * Activates the material in the rasterizer. * On entry, the cachingInfo contains info about the last activated material. * On exit, the cachingInfo should contain updated info about this material. - * @param rasty The rasterizer in which the material should be active. - * @param cachingInfo The information about the material used to speed up rasterizing. + * \param rasty The rasterizer in which the material should be active. + * \param cachingInfo The information about the material used to speed up rasterizing. */ virtual bool Activate(RAS_IRasterizer* rasty, TCachingInfo& cachingInfo) const { @@ -177,7 +177,7 @@ public: virtual void Replace_IScene(SCA_IScene *val) {}; /* overridden by KX_BlenderMaterial */ /** - * @return the equivalent drawing mode for the material settings (equivalent to old TexFace tface->mode). + * \return the equivalent drawing mode for the material settings (equivalent to old TexFace tface->mode). */ int ConvertFaceMode(struct GameSettings *game, bool image) const; diff --git a/source/gameengine/Rasterizer/RAS_IRasterizer.h b/source/gameengine/Rasterizer/RAS_IRasterizer.h index c749868cf79..34ddafbf2cc 100644 --- a/source/gameengine/Rasterizer/RAS_IRasterizer.h +++ b/source/gameengine/Rasterizer/RAS_IRasterizer.h @@ -202,7 +202,7 @@ public: virtual void SetStereoMode(const StereoMode stereomode)=0; /** * Stereo can be used to query if the rasterizer is in stereo mode. - * @return true if stereo mode is enabled. + * \return true if stereo mode is enabled. */ virtual bool Stereo()=0; virtual StereoMode GetStereoMode()=0; @@ -236,7 +236,7 @@ public: /** * IndexPrimitives_3DText will render text into the polygons. - * The text to be rendered is from @param rendertools client object's text property. + * The text to be rendered is from \param rendertools client object's text property. */ virtual void IndexPrimitives_3DText(class RAS_MeshSlot& ms, class RAS_IPolyMaterial* polymat, @@ -247,7 +247,7 @@ public: /** * Set the projection matrix for the rasterizer. This projects * from camera coordinates to window coordinates. - * @param mat The projection matrix. + * \param mat The projection matrix. */ virtual void SetProjectionMatrix(const MT_Matrix4x4 & mat)=0; /** @@ -292,11 +292,11 @@ public: float alpha)=0; /** - * @param drawingmode = KX_BOUNDINGBOX, KX_WIREFRAME, KX_SOLID, KX_SHADED or KX_TEXTURED. + * \param drawingmode = KX_BOUNDINGBOX, KX_WIREFRAME, KX_SOLID, KX_SHADED or KX_TEXTURED. */ virtual void SetDrawingMode(int drawingmode)=0; /** - * @return the current drawing mode: KX_BOUNDINGBOX, KX_WIREFRAME, KX_SOLID, KX_SHADED or KX_TEXTURED. + * \return the current drawing mode: KX_BOUNDINGBOX, KX_WIREFRAME, KX_SOLID, KX_SHADED or KX_TEXTURED. */ virtual int GetDrawingMode()=0; /** @@ -312,13 +312,13 @@ public: virtual double GetTime()=0; /** * Generates a projection matrix from the specified frustum. - * @param left the left clipping plane - * @param right the right clipping plane - * @param bottom the bottom clipping plane - * @param top the top clipping plane - * @param frustnear the near clipping plane - * @param frustfar the far clipping plane - * @return a 4x4 matrix representing the projection transform. + * \param left the left clipping plane + * \param right the right clipping plane + * \param bottom the bottom clipping plane + * \param top the top clipping plane + * \param frustnear the near clipping plane + * \param frustfar the far clipping plane + * \return a 4x4 matrix representing the projection transform. */ virtual MT_Matrix4x4 GetFrustumMatrix( float left, @@ -333,13 +333,13 @@ public: /** * Generates a orthographic projection matrix from the specified frustum. - * @param left the left clipping plane - * @param right the right clipping plane - * @param bottom the bottom clipping plane - * @param top the top clipping plane - * @param frustnear the near clipping plane - * @param frustfar the far clipping plane - * @return a 4x4 matrix representing the projection transform. + * \param left the left clipping plane + * \param right the right clipping plane + * \param bottom the bottom clipping plane + * \param top the top clipping plane + * \param frustnear the near clipping plane + * \param frustfar the far clipping plane + * \return a 4x4 matrix representing the projection transform. */ virtual MT_Matrix4x4 GetOrthoMatrix( float left, diff --git a/source/gameengine/Rasterizer/RAS_IRenderTools.h b/source/gameengine/Rasterizer/RAS_IRenderTools.h index 27b328412d2..1d9f7052975 100644 --- a/source/gameengine/Rasterizer/RAS_IRenderTools.h +++ b/source/gameengine/Rasterizer/RAS_IRenderTools.h @@ -103,13 +103,13 @@ public: /** * Renders 3D text string using BFL. - * @param fontid The id of the font. - * @param text The string to render. - * @param size The size of the text. - * @param dpi The resolution of the text. - * @param color The color of the object. - * @param mat The Matrix of the text object. - * @param aspect A scaling factor to compensate for the size. + * \param fontid The id of the font. + * \param text The string to render. + * \param size The size of the text. + * \param dpi The resolution of the text. + * \param color The color of the object. + * \param mat The Matrix of the text object. + * \param aspect A scaling factor to compensate for the size. */ virtual void @@ -125,12 +125,12 @@ public: /** * Renders 2D text string. - * @param mode The type of text - * @param text The string to render. - * @param xco Position on the screen (origin in lower left corner). - * @param yco Position on the screen (origin in lower left corner). - * @param width Width of the canvas to draw to. - * @param height Height of the canvas to draw to. + * \param mode The type of text + * \param text The string to render. + * \param xco Position on the screen (origin in lower left corner). + * \param yco Position on the screen (origin in lower left corner). + * \param width Width of the canvas to draw to. + * \param height Height of the canvas to draw to. */ virtual void |