Updated header documentation
authorSam Lantinga
Sat, 05 Aug 2006 22:41:33 +0000
changeset 19689f589a1f74a5
parent 1967 01e29c3e9a29
child 1969 5d3724f64f2b
Updated header documentation
include/SDL_video.h
     1.1 --- a/include/SDL_video.h	Sat Aug 05 22:34:23 2006 +0000
     1.2 +++ b/include/SDL_video.h	Sat Aug 05 22:41:33 2006 +0000
     1.3 @@ -434,7 +434,7 @@
     1.4  /**
     1.5   * \fn int SDL_GetDisplayMode(int index, SDL_DisplayMode *mode)
     1.6   *
     1.7 - * \brief Retrieve information about a specific display mode.
     1.8 + * \brief Fill in information about a specific display mode.
     1.9   *
    1.10   * \note The display modes are sorted in this priority:
    1.11   *       \li bits per pixel -> more colors to fewer colors
    1.12 @@ -450,14 +450,14 @@
    1.13  /**
    1.14   * \fn int SDL_GetDesktopDisplayMode(SDL_DisplayMode *mode)
    1.15   *
    1.16 - * \brief Retrieve information about the desktop display mode for the current display.
    1.17 + * \brief Fill in information about the desktop display mode for the current display.
    1.18   */
    1.19  extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayMode * mode);
    1.20  
    1.21  /**
    1.22   * \fn int SDL_GetCurrentDisplayMode(SDL_DisplayMode *mode)
    1.23   *
    1.24 - * \brief Retrieve information about the current display mode.
    1.25 + * \brief Fill in information about the current display mode.
    1.26   */
    1.27  extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayMode * mode);
    1.28  
    1.29 @@ -500,8 +500,8 @@
    1.30  /**
    1.31   * \fn int SDL_GetFullscreenDisplayMode(SDL_DisplayMode *mode)
    1.32   *
    1.33 - * \brief Query the display mode used when a fullscreen window is visible
    1.34 - *        on the currently selected display.
    1.35 + * \brief Fill in information about the display mode used when a fullscreen
    1.36 + *        window is visible on the currently selected display.
    1.37   */
    1.38  extern DECLSPEC int SDLCALL SDL_GetFullscreenDisplayMode(SDL_DisplayMode *
    1.39                                                           mode);