Updated header documentation
authorSam Lantinga <slouken@libsdl.org>
Sat, 05 Aug 2006 22:41:33 +0000
changeset 1968 9f589a1f74a5
parent 1967 01e29c3e9a29
child 1969 5d3724f64f2b
Updated header documentation
include/SDL_video.h
--- a/include/SDL_video.h	Sat Aug 05 22:34:23 2006 +0000
+++ b/include/SDL_video.h	Sat Aug 05 22:41:33 2006 +0000
@@ -434,7 +434,7 @@
 /**
  * \fn int SDL_GetDisplayMode(int index, SDL_DisplayMode *mode)
  *
- * \brief Retrieve information about a specific display mode.
+ * \brief Fill in information about a specific display mode.
  *
  * \note The display modes are sorted in this priority:
  *       \li bits per pixel -> more colors to fewer colors
@@ -450,14 +450,14 @@
 /**
  * \fn int SDL_GetDesktopDisplayMode(SDL_DisplayMode *mode)
  *
- * \brief Retrieve information about the desktop display mode for the current display.
+ * \brief Fill in information about the desktop display mode for the current display.
  */
 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayMode * mode);
 
 /**
  * \fn int SDL_GetCurrentDisplayMode(SDL_DisplayMode *mode)
  *
- * \brief Retrieve information about the current display mode.
+ * \brief Fill in information about the current display mode.
  */
 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayMode * mode);
 
@@ -500,8 +500,8 @@
 /**
  * \fn int SDL_GetFullscreenDisplayMode(SDL_DisplayMode *mode)
  *
- * \brief Query the display mode used when a fullscreen window is visible
- *        on the currently selected display.
+ * \brief Fill in information about the display mode used when a fullscreen
+ *        window is visible on the currently selected display.
  */
 extern DECLSPEC int SDLCALL SDL_GetFullscreenDisplayMode(SDL_DisplayMode *
                                                          mode);