diff options
Diffstat (limited to 'intern/ghost/GHOST_Rect.h')
-rw-r--r-- | intern/ghost/GHOST_Rect.h | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/intern/ghost/GHOST_Rect.h b/intern/ghost/GHOST_Rect.h index fcc9da20197..dae2a2a8cbb 100644 --- a/intern/ghost/GHOST_Rect.h +++ b/intern/ghost/GHOST_Rect.h @@ -37,10 +37,10 @@ class GHOST_Rect { public: /** * Constructs a rectangle with the given values. - * \param l requested left coordinate of the rectangle - * \param t requested top coordinate of the rectangle - * \param r requested right coordinate of the rectangle - * \param b requested bottom coordinate of the rectangle + * \param l: requested left coordinate of the rectangle. + * \param t: requested top coordinate of the rectangle. + * \param r: requested right coordinate of the rectangle. + * \param b: requested bottom coordinate of the rectangle. */ GHOST_Rect(GHOST_TInt32 l = 0, GHOST_TInt32 t = 0, GHOST_TInt32 r = 0, GHOST_TInt32 b = 0) : m_l(l), m_t(t), m_r(r), m_b(b) @@ -56,13 +56,13 @@ class GHOST_Rect { /** * Access to rectangle width. - * \return width of the rectangle + * \return width of the rectangle. */ virtual inline GHOST_TInt32 getWidth() const; /** * Access to rectangle height. - * \return height of the rectangle + * \return height of the rectangle. */ virtual inline GHOST_TInt32 getHeight() const; @@ -86,7 +86,7 @@ class GHOST_Rect { * Returns whether this rectangle is valid. * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. * Thus, empty rectangles are valid. - * \return boolean value (true==valid rectangle) + * \return boolean value (true==valid rectangle) */ virtual inline bool isValid() const; @@ -113,8 +113,8 @@ class GHOST_Rect { /** * Grows the rectangle to included a point. - * \param x The x-coordinate of the point. - * \param y The y-coordinate of the point. + * \param x: The x-coordinate of the point. + * \param y: The y-coordinate of the point. */ virtual inline void wrapPoint(GHOST_TInt32 &x, GHOST_TInt32 &y, @@ -124,24 +124,24 @@ class GHOST_Rect { /** * Returns whether the point is inside this rectangle. * Point on the boundary is considered inside. - * \param x x-coordinate of point to test. - * \param y y-coordinate of point to test. + * \param x: x-coordinate of point to test. + * \param y: y-coordinate of point to test. * \return boolean value (true if point is inside). */ virtual inline bool isInside(GHOST_TInt32 x, GHOST_TInt32 y) const; /** * Returns whether the rectangle is inside this rectangle. - * \param r rectangle to test. - * \return visibility (not, partially or fully visible). + * \param r: rectangle to test. + * \return visibility (not, partially or fully visible). */ virtual GHOST_TVisibility getVisibility(GHOST_Rect &r) const; /** * Sets rectangle members. * Sets rectangle members such that it is centered at the given location. - * \param cx requested center x-coordinate of the rectangle - * \param cy requested center y-coordinate of the rectangle + * \param cx: requested center x-coordinate of the rectangle. + * \param cy: requested center y-coordinate of the rectangle. */ virtual void setCenter(GHOST_TInt32 cx, GHOST_TInt32 cy); @@ -149,10 +149,10 @@ class GHOST_Rect { * Sets rectangle members. * Sets rectangle members such that it is centered at the given location, * with the width requested. - * \param cx requested center x-coordinate of the rectangle - * \param cy requested center y-coordinate of the rectangle - * \param w requested width of the rectangle - * \param h requested height of the rectangle + * \param cx: requested center x-coordinate of the rectangle. + * \param cy: requested center y-coordinate of the rectangle. + * \param w: requested width of the rectangle. + * \param h: requested height of the rectangle. */ virtual void setCenter(GHOST_TInt32 cx, GHOST_TInt32 cy, GHOST_TInt32 w, GHOST_TInt32 h); @@ -160,8 +160,8 @@ class GHOST_Rect { * Clips a rectangle. * Updates the rectangle given such that it will fit within this one. * This can result in an empty rectangle. - * \param r the rectangle to clip - * \return whether clipping has occurred + * \param r: the rectangle to clip. + * \return whether clipping has occurred */ virtual bool clip(GHOST_Rect &r) const; |