Updated headers to match wiki documentation
authorSam Lantinga <slouken@libsdl.org>
Wed, 12 Jan 2011 09:47:33 -0800
changeset 4971 158bb5752974
parent 4970 b9eed029844a
child 4972 0a9a77f3d552
Updated headers to match wiki documentation
include/SDL_events.h
include/SDL_rwops.h
include/SDL_surface.h
include/SDL_video.h
--- a/include/SDL_events.h	Mon Jan 10 12:15:16 2011 -0800
+++ b/include/SDL_events.h	Wed Jan 12 09:47:33 2011 -0800
@@ -66,8 +66,8 @@
     SDL_SYSWMEVENT,             /**< System specific event */
 
     /* Keyboard events */
-    SDL_KEYDOWN        = 0x300, /**< Keys pressed */
-    SDL_KEYUP,                  /**< Keys released */
+    SDL_KEYDOWN        = 0x300, /**< Key pressed */
+    SDL_KEYUP,                  /**< Key released */
     SDL_TEXTEDITING,            /**< Keyboard text editing (composition) */
     SDL_TEXTINPUT,              /**< Keyboard text input */
 
--- a/include/SDL_rwops.h	Mon Jan 10 12:15:16 2011 -0800
+++ b/include/SDL_rwops.h	Wed Jan 12 09:47:33 2011 -0800
@@ -24,7 +24,7 @@
  *  \file SDL_rwops.h
  *  
  *  This file provides a general interface for SDL to read and write
- *  data sources.  It can easily be extended to files, memory, etc.
+ *  data streams.  It can easily be extended to files, memory, etc.
  */
 
 #ifndef _SDL_rwops_h
@@ -50,14 +50,14 @@
      *  Seek to \c offset relative to \c whence, one of stdio's whence values:
      *  RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
      *  
-     *  \return the final offset in the data source.
+     *  \return the final offset in the data stream.
      */
     long (SDLCALL * seek) (struct SDL_RWops * context, long offset,
                            int whence);
 
     /**
      *  Read up to \c maxnum objects each of size \c size from the data
-     *  source to the area pointed at by \c ptr.
+     *  stream to the area pointed at by \c ptr.
      *  
      *  \return the number of objects read, or 0 at error or end of file.
      */
@@ -66,7 +66,7 @@
 
     /**
      *  Write exactly \c num objects each of size \c size from the area
-     *  pointed at by \c ptr to data source.
+     *  pointed at by \c ptr to data stream.
      *  
      *  \return the number of objects written, or 0 at error or end of file.
      */
@@ -121,7 +121,7 @@
 /**
  *  \name RWFrom functions
  *  
- *  Functions to create SDL_RWops structures from various data sources.
+ *  Functions to create SDL_RWops structures from various data streams.
  */
 /*@{*/
 
--- a/include/SDL_surface.h	Mon Jan 10 12:15:16 2011 -0800
+++ b/include/SDL_surface.h	Wed Jan 12 09:47:33 2011 -0800
@@ -161,9 +161,9 @@
 extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface);
 
 /**
- *  Load a surface from a seekable SDL data source (memory or file).
+ *  Load a surface from a seekable SDL data stream (memory or file).
  *  
- *  If \c freesrc is non-zero, the source will be closed after being read.
+ *  If \c freesrc is non-zero, the stream will be closed after being read.
  *  
  *  The new surface should be freed with SDL_FreeSurface().
  *  
@@ -180,9 +180,9 @@
 #define SDL_LoadBMP(file)	SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1)
 
 /**
- *  Save a surface to a seekable SDL data source (memory or file).
+ *  Save a surface to a seekable SDL data stream (memory or file).
  *  
- *  If \c freedst is non-zero, the source will be closed after being written.
+ *  If \c freedst is non-zero, the stream will be closed after being written.
  *  
  *  \return 0 if successful or -1 if there was an error.
  */
@@ -237,9 +237,9 @@
  *  \brief Set an additional color value used in blit operations.
  *  
  *  \param surface The surface to update.
- *  \param r The red source color value multiplied into blit operations.
- *  \param g The green source color value multiplied into blit operations.
- *  \param b The blue source color value multiplied into blit operations.
+ *  \param r The red color value multiplied into blit operations.
+ *  \param g The green color value multiplied into blit operations.
+ *  \param b The blue color value multiplied into blit operations.
  *  
  *  \return 0 on success, or -1 if the surface is not valid.
  *  
@@ -253,9 +253,9 @@
  *  \brief Get the additional color value used in blit operations.
  *  
  *  \param surface The surface to query.
- *  \param r A pointer filled in with the source red color value.
- *  \param g A pointer filled in with the source green color value.
- *  \param b A pointer filled in with the source blue color value.
+ *  \param r A pointer filled in with the current red color value.
+ *  \param g A pointer filled in with the current green color value.
+ *  \param b A pointer filled in with the current blue color value.
  *  
  *  \return 0 on success, or -1 if the surface is not valid.
  *  
@@ -269,7 +269,7 @@
  *  \brief Set an additional alpha value used in blit operations.
  *  
  *  \param surface The surface to update.
- *  \param alpha The source alpha value multiplied into blit operations.
+ *  \param alpha The alpha value multiplied into blit operations.
  *  
  *  \return 0 on success, or -1 if the surface is not valid.
  *  
@@ -282,7 +282,7 @@
  *  \brief Get the additional alpha value used in blit operations.
  *  
  *  \param surface The surface to query.
- *  \param alpha A pointer filled in with the source alpha value.
+ *  \param alpha A pointer filled in with the current alpha value.
  *  
  *  \return 0 on success, or -1 if the surface is not valid.
  *  
--- a/include/SDL_video.h	Mon Jan 10 12:15:16 2011 -0800
+++ b/include/SDL_video.h	Wed Jan 12 09:47:33 2011 -0800
@@ -885,9 +885,9 @@
  *  \brief Set an additional color value used in render copy operations.
  *  
  *  \param texture The texture to update.
- *  \param r       The red source color value multiplied into copy operations.
- *  \param g       The green source color value multiplied into copy operations.
- *  \param b       The blue source color value multiplied into copy operations.
+ *  \param r       The red color value multiplied into copy operations.
+ *  \param g       The green color value multiplied into copy operations.
+ *  \param b       The blue color value multiplied into copy operations.
  *  
  *  \return 0 on success, or -1 if the texture is not valid or color modulation 
  *          is not supported.
@@ -902,9 +902,9 @@
  *  \brief Get the additional color value used in render copy operations.
  *  
  *  \param texture The texture to query.
- *  \param r         A pointer filled in with the source red color value.
- *  \param g         A pointer filled in with the source green color value.
- *  \param b         A pointer filled in with the source blue color value.
+ *  \param r         A pointer filled in with the current red color value.
+ *  \param g         A pointer filled in with the current green color value.
+ *  \param b         A pointer filled in with the current blue color value.
  *  
  *  \return 0 on success, or -1 if the texture is not valid.
  *  
@@ -918,7 +918,7 @@
  *  \brief Set an additional alpha value used in render copy operations.
  *  
  *  \param texture The texture to update.
- *  \param alpha     The source alpha value multiplied into copy operations.
+ *  \param alpha     The alpha value multiplied into copy operations.
  *  
  *  \return 0 on success, or -1 if the texture is not valid or alpha modulation 
  *          is not supported.
@@ -932,7 +932,7 @@
  *  \brief Get the additional alpha value used in render copy operations.
  *  
  *  \param texture The texture to query.
- *  \param alpha     A pointer filled in with the source alpha value.
+ *  \param alpha     A pointer filled in with the current alpha value.
  *  
  *  \return 0 on success, or -1 if the texture is not valid.
  *