include/SDL_rect.h
changeset 3407 d3baf5ac4e37
parent 2909 3da0bb421d83
child 3536 0267b8b1595c
     1.1 --- a/include/SDL_rect.h	Sun Oct 18 23:21:15 2009 +0000
     1.2 +++ b/include/SDL_rect.h	Mon Oct 19 13:31:58 2009 +0000
     1.3 @@ -21,9 +21,9 @@
     1.4  */
     1.5  
     1.6  /**
     1.7 - * \file SDL_rect.h
     1.8 - *
     1.9 - * Header file for SDL_rect definition and management functions
    1.10 + *  \file SDL_rect.h
    1.11 + *  
    1.12 + *  Header file for SDL_rect definition and management functions.
    1.13   */
    1.14  
    1.15  #ifndef _SDL_rect_h
    1.16 @@ -43,15 +43,13 @@
    1.17  #endif
    1.18  
    1.19  /**
    1.20 - * \struct SDL_Rect
    1.21 - *
    1.22 - * \brief A rectangle, with the origin at the upper left.
    1.23 - *
    1.24 - * \sa SDL_RectEmpty
    1.25 - * \sa SDL_RectEquals
    1.26 - * \sa SDL_HasIntersection
    1.27 - * \sa SDL_IntersectRect
    1.28 - * \sa SDL_UnionRect
    1.29 + *  \brief A rectangle, with the origin at the upper left.
    1.30 + *  
    1.31 + *  \sa SDL_RectEmpty
    1.32 + *  \sa SDL_RectEquals
    1.33 + *  \sa SDL_HasIntersection
    1.34 + *  \sa SDL_IntersectRect
    1.35 + *  \sa SDL_UnionRect
    1.36   */
    1.37  typedef struct SDL_Rect
    1.38  {
    1.39 @@ -60,56 +58,44 @@
    1.40  } SDL_Rect;
    1.41  
    1.42  /**
    1.43 - * \def SDL_RectEmpty()
    1.44 - *
    1.45 - * \brief Returns true if the rectangle has no area.
    1.46 + *  \brief Returns true if the rectangle has no area.
    1.47   */
    1.48  #define SDL_RectEmpty(X)    (((X)->w <= 0) || ((X)->h <= 0))
    1.49  
    1.50  /**
    1.51 - * \def SDL_RectEquals()
    1.52 - *
    1.53 - * \brief Returns true if the two rectangles are equal.
    1.54 + *  \brief Returns true if the two rectangles are equal.
    1.55   */
    1.56  #define SDL_RectEquals(A, B)   (((A)->x == (B)->x) && ((A)->y == (B)->y) && \
    1.57                                  ((A)->w == (B)->w) && ((A)->h == (B)->h))
    1.58  
    1.59  /**
    1.60 - * \fn SDL_bool SDL_HasIntersection(const SDL_Rect * A, const SDL_Rect * B);
    1.61 - *
    1.62 - * \brief Determine whether two rectangles intersect.
    1.63 - *
    1.64 - * \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
    1.65 + *  \brief Determine whether two rectangles intersect.
    1.66 + *  
    1.67 + *  \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
    1.68   */
    1.69  extern DECLSPEC SDL_bool SDLCALL SDL_HasIntersection(const SDL_Rect * A,
    1.70                                                       const SDL_Rect * B);
    1.71  
    1.72  /**
    1.73 - * \fn SDL_bool SDL_IntersectRect(const SDL_Rect * A, const SDL_Rect * B, SDL_Rect * result)
    1.74 - *
    1.75 - * \brief Calculate the intersection of two rectangles.
    1.76 - *
    1.77 - * \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
    1.78 + *  \brief Calculate the intersection of two rectangles.
    1.79 + *  
    1.80 + *  \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
    1.81   */
    1.82  extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRect(const SDL_Rect * A,
    1.83                                                     const SDL_Rect * B,
    1.84                                                     SDL_Rect * result);
    1.85  
    1.86  /**
    1.87 - * \fn void SDL_UnionRect(const SDL_Rect * A, const SDL_Rect * B, SDL_Rect * result)
    1.88 - *
    1.89 - * \brief Calculate the union of two rectangles
    1.90 + *  \brief Calculate the union of two rectangles.
    1.91   */
    1.92  extern DECLSPEC void SDLCALL SDL_UnionRect(const SDL_Rect * A,
    1.93                                             const SDL_Rect * B,
    1.94                                             SDL_Rect * result);
    1.95  
    1.96  /**
    1.97 - * \fn SDL_bool SDL_IntersectRectAndLine(const SDL_Rect *rect, int *X1, int *Y1, int *X2, int *Y2)
    1.98 - *
    1.99 - * \brief Calculate the intersection of a rectangle and line segment.
   1.100 - *
   1.101 - * \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
   1.102 + *  \brief Calculate the intersection of a rectangle and line segment.
   1.103 + *  
   1.104 + *  \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
   1.105   */
   1.106  extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRectAndLine(const SDL_Rect *
   1.107                                                            rect, int *X1,