Fixed documentation
authorSam Lantinga <slouken@libsdl.org>
Tue, 14 Sep 2010 21:57:29 -0700
changeset 4883511948f4919e
parent 4882 e725a6a60c32
child 4884 27ab20a36eba
Fixed documentation
include/SDL_video.h
     1.1 --- a/include/SDL_video.h	Wed Sep 15 00:28:19 2010 -0400
     1.2 +++ b/include/SDL_video.h	Tue Sep 14 21:57:29 2010 -0700
     1.3 @@ -568,7 +568,7 @@
     1.4  extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
     1.5  
     1.6  /**
     1.7 - *  \brief Get the numeric ID of the window, for logging purposes.
     1.8 + *  \brief Get the numeric ID of a window, for logging purposes.
     1.9   */
    1.10  extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
    1.11  
    1.12 @@ -583,7 +583,7 @@
    1.13  extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
    1.14  
    1.15  /**
    1.16 - *  \brief Set the title of the window, in UTF-8 format.
    1.17 + *  \brief Set the title of a window, in UTF-8 format.
    1.18   *  
    1.19   *  \sa SDL_GetWindowTitle()
    1.20   */
    1.21 @@ -591,16 +591,16 @@
    1.22                                                  const char *title);
    1.23  
    1.24  /**
    1.25 - *  \brief Get the title of the window, in UTF-8 format.
    1.26 + *  \brief Get the title of a window, in UTF-8 format.
    1.27   *  
    1.28   *  \sa SDL_SetWindowTitle()
    1.29   */
    1.30  extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
    1.31  
    1.32  /**
    1.33 - *  \brief Set the icon of the window.
    1.34 + *  \brief Set the icon of a window.
    1.35   *  
    1.36 - *  \param icon The icon for the window.
    1.37 + *  \param icon The icon for a window.
    1.38   */
    1.39  extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
    1.40                                                 SDL_Surface * icon);
    1.41 @@ -614,14 +614,14 @@
    1.42                                                 void *userdata);
    1.43  
    1.44  /**
    1.45 - *  \brief Retrieve the data pointer associated with the window.
    1.46 + *  \brief Retrieve the data pointer associated with a window.
    1.47   *  
    1.48   *  \sa SDL_SetWindowData()
    1.49   */
    1.50  extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window);
    1.51  
    1.52  /**
    1.53 - *  \brief Set the position of the window.
    1.54 + *  \brief Set the position of a window.
    1.55   *  
    1.56   *  \param window The window to reposition.
    1.57   *  \param x        The x coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
    1.58 @@ -637,7 +637,7 @@
    1.59                                                     int x, int y);
    1.60  
    1.61  /**
    1.62 - *  \brief Get the position of the window.
    1.63 + *  \brief Get the position of a window.
    1.64   *  
    1.65   *  \sa SDL_SetWindowPosition()
    1.66   */
    1.67 @@ -645,7 +645,7 @@
    1.68                                                     int *x, int *y);
    1.69  
    1.70  /**
    1.71 - *  \brief Set the size of the window's client area.
    1.72 + *  \brief Set the size of a window's client area.
    1.73   *  
    1.74   *  \note You can't change the size of a fullscreen window, it automatically
    1.75   *        matches the size of the display mode.
    1.76 @@ -656,7 +656,7 @@
    1.77                                                 int h);
    1.78  
    1.79  /**
    1.80 - *  \brief Get the size of the window's client area.
    1.81 + *  \brief Get the size of a window's client area.
    1.82   *  
    1.83   *  \sa SDL_SetWindowSize()
    1.84   */
    1.85 @@ -664,33 +664,33 @@
    1.86                                                 int *h);
    1.87  
    1.88  /**
    1.89 - *  \brief Show the window.
    1.90 + *  \brief Show a window.
    1.91   *  
    1.92   *  \sa SDL_HideWindow()
    1.93   */
    1.94  extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
    1.95  
    1.96  /**
    1.97 - *  \brief Hide the window.
    1.98 + *  \brief Hide a window.
    1.99   *  
   1.100   *  \sa SDL_ShowWindow()
   1.101   */
   1.102  extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
   1.103  
   1.104  /**
   1.105 - *  \brief Raise the window above other windows and set the input focus.
   1.106 + *  \brief Raise a window above other windows and set the input focus.
   1.107   */
   1.108  extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
   1.109  
   1.110  /**
   1.111 - *  \brief Make the window as large as possible.
   1.112 + *  \brief Make a window as large as possible.
   1.113   *  
   1.114   *  \sa SDL_RestoreWindow()
   1.115   */
   1.116  extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
   1.117  
   1.118  /**
   1.119 - *  \brief Minimize the window to an iconic representation.
   1.120 + *  \brief Minimize a window to an iconic representation.
   1.121   *  
   1.122   *  \sa SDL_RestoreWindow()
   1.123   */
   1.124 @@ -705,7 +705,7 @@
   1.125  extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
   1.126  
   1.127  /**
   1.128 - *  \brief Set the window's fullscreen state.
   1.129 + *  \brief Set a window's fullscreen state.
   1.130   *  
   1.131   *  \return 0 on success, or -1 if setting the display mode failed.
   1.132   *  
   1.133 @@ -716,7 +716,7 @@
   1.134                                                      int fullscreen);
   1.135  
   1.136  /**
   1.137 - *  \brief Set the window's input grab mode.
   1.138 + *  \brief Set a window's input grab mode.
   1.139   *  
   1.140   *  \param mode This is 1 to grab input, and 0 to release input.
   1.141   *  
   1.142 @@ -726,7 +726,7 @@
   1.143                                                 int mode);
   1.144  
   1.145  /**
   1.146 - *  \brief Get the window's input grab mode.
   1.147 + *  \brief Get a window's input grab mode.
   1.148   *  
   1.149   *  \return This returns 1 if input is grabbed, and 0 otherwise.
   1.150   *  
   1.151 @@ -1430,7 +1430,7 @@
   1.152  extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
   1.153  
   1.154  /**
   1.155 - * \brief Swap the OpenGL buffers for the window, if double-buffering is 
   1.156 + * \brief Swap the OpenGL buffers for a window, if double-buffering is 
   1.157   *        supported.
   1.158   */
   1.159  extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);