diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-05-01 13:23:13 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-05-01 13:32:38 +0300 |
commit | 5b1fcf88334620af97f70ceb591eaf0fb153ed03 (patch) | |
tree | 7926462b4d8e1e2fcb700d370da805fc2a3baf1c /intern/ghost/GHOST_Rect.h | |
parent | 1cb091ae7ae4cc5442bc35c1bbbcf1aadc57fecd (diff) |
Cleanup: comments (long lines) in ghost
Diffstat (limited to 'intern/ghost/GHOST_Rect.h')
-rw-r--r-- | intern/ghost/GHOST_Rect.h | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/intern/ghost/GHOST_Rect.h b/intern/ghost/GHOST_Rect.h index cd4eb936066..d4c05a7b8aa 100644 --- a/intern/ghost/GHOST_Rect.h +++ b/intern/ghost/GHOST_Rect.h @@ -77,23 +77,24 @@ class GHOST_Rect { /** * Sets all members 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 + * \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. */ virtual inline void set(GHOST_TInt32 l, GHOST_TInt32 t, GHOST_TInt32 r, GHOST_TInt32 b); /** * Returns whether this rectangle is empty. * Empty rectangles are rectangles that have width==0 and/or height==0. - * \return boolean value (true==empty rectangle) + * \return boolean value (true==empty rectangle) */ virtual inline bool isEmpty() const; /** * 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. + * 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) */ virtual inline bool isValid() const; @@ -101,28 +102,28 @@ class GHOST_Rect { /** * Grows (or shrinks the rectangle). * The method avoids negative insets making the rectangle invalid - * \param i The amount of offset given to each extreme (negative values shrink the rectangle). + * \param i: The amount of offset given to each extreme (negative values shrink the rectangle). */ virtual void inset(GHOST_TInt32 i); /** * Does a union of the rectangle given and this rectangle. * The result is stored in this rectangle. - * \param r The rectangle that is input for the union operation. + * \param r: The rectangle that is input for the union operation. */ virtual inline void unionRect(const GHOST_Rect &r); /** * 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 unionPoint(GHOST_TInt32 x, GHOST_TInt32 y); /** * 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, GHOST_TInt32 ofs); |