Updated headers to match wiki documentation
authorSam Lantinga <slouken@libsdl.org>
Wed, 12 Jan 2011 09:47:33 -0800
changeset 4971158bb5752974
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
     1.1 --- a/include/SDL_events.h	Mon Jan 10 12:15:16 2011 -0800
     1.2 +++ b/include/SDL_events.h	Wed Jan 12 09:47:33 2011 -0800
     1.3 @@ -66,8 +66,8 @@
     1.4      SDL_SYSWMEVENT,             /**< System specific event */
     1.5  
     1.6      /* Keyboard events */
     1.7 -    SDL_KEYDOWN        = 0x300, /**< Keys pressed */
     1.8 -    SDL_KEYUP,                  /**< Keys released */
     1.9 +    SDL_KEYDOWN        = 0x300, /**< Key pressed */
    1.10 +    SDL_KEYUP,                  /**< Key released */
    1.11      SDL_TEXTEDITING,            /**< Keyboard text editing (composition) */
    1.12      SDL_TEXTINPUT,              /**< Keyboard text input */
    1.13  
     2.1 --- a/include/SDL_rwops.h	Mon Jan 10 12:15:16 2011 -0800
     2.2 +++ b/include/SDL_rwops.h	Wed Jan 12 09:47:33 2011 -0800
     2.3 @@ -24,7 +24,7 @@
     2.4   *  \file SDL_rwops.h
     2.5   *  
     2.6   *  This file provides a general interface for SDL to read and write
     2.7 - *  data sources.  It can easily be extended to files, memory, etc.
     2.8 + *  data streams.  It can easily be extended to files, memory, etc.
     2.9   */
    2.10  
    2.11  #ifndef _SDL_rwops_h
    2.12 @@ -50,14 +50,14 @@
    2.13       *  Seek to \c offset relative to \c whence, one of stdio's whence values:
    2.14       *  RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
    2.15       *  
    2.16 -     *  \return the final offset in the data source.
    2.17 +     *  \return the final offset in the data stream.
    2.18       */
    2.19      long (SDLCALL * seek) (struct SDL_RWops * context, long offset,
    2.20                             int whence);
    2.21  
    2.22      /**
    2.23       *  Read up to \c maxnum objects each of size \c size from the data
    2.24 -     *  source to the area pointed at by \c ptr.
    2.25 +     *  stream to the area pointed at by \c ptr.
    2.26       *  
    2.27       *  \return the number of objects read, or 0 at error or end of file.
    2.28       */
    2.29 @@ -66,7 +66,7 @@
    2.30  
    2.31      /**
    2.32       *  Write exactly \c num objects each of size \c size from the area
    2.33 -     *  pointed at by \c ptr to data source.
    2.34 +     *  pointed at by \c ptr to data stream.
    2.35       *  
    2.36       *  \return the number of objects written, or 0 at error or end of file.
    2.37       */
    2.38 @@ -121,7 +121,7 @@
    2.39  /**
    2.40   *  \name RWFrom functions
    2.41   *  
    2.42 - *  Functions to create SDL_RWops structures from various data sources.
    2.43 + *  Functions to create SDL_RWops structures from various data streams.
    2.44   */
    2.45  /*@{*/
    2.46  
     3.1 --- a/include/SDL_surface.h	Mon Jan 10 12:15:16 2011 -0800
     3.2 +++ b/include/SDL_surface.h	Wed Jan 12 09:47:33 2011 -0800
     3.3 @@ -161,9 +161,9 @@
     3.4  extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface);
     3.5  
     3.6  /**
     3.7 - *  Load a surface from a seekable SDL data source (memory or file).
     3.8 + *  Load a surface from a seekable SDL data stream (memory or file).
     3.9   *  
    3.10 - *  If \c freesrc is non-zero, the source will be closed after being read.
    3.11 + *  If \c freesrc is non-zero, the stream will be closed after being read.
    3.12   *  
    3.13   *  The new surface should be freed with SDL_FreeSurface().
    3.14   *  
    3.15 @@ -180,9 +180,9 @@
    3.16  #define SDL_LoadBMP(file)	SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1)
    3.17  
    3.18  /**
    3.19 - *  Save a surface to a seekable SDL data source (memory or file).
    3.20 + *  Save a surface to a seekable SDL data stream (memory or file).
    3.21   *  
    3.22 - *  If \c freedst is non-zero, the source will be closed after being written.
    3.23 + *  If \c freedst is non-zero, the stream will be closed after being written.
    3.24   *  
    3.25   *  \return 0 if successful or -1 if there was an error.
    3.26   */
    3.27 @@ -237,9 +237,9 @@
    3.28   *  \brief Set an additional color value used in blit operations.
    3.29   *  
    3.30   *  \param surface The surface to update.
    3.31 - *  \param r The red source color value multiplied into blit operations.
    3.32 - *  \param g The green source color value multiplied into blit operations.
    3.33 - *  \param b The blue source color value multiplied into blit operations.
    3.34 + *  \param r The red color value multiplied into blit operations.
    3.35 + *  \param g The green color value multiplied into blit operations.
    3.36 + *  \param b The blue color value multiplied into blit operations.
    3.37   *  
    3.38   *  \return 0 on success, or -1 if the surface is not valid.
    3.39   *  
    3.40 @@ -253,9 +253,9 @@
    3.41   *  \brief Get the additional color value used in blit operations.
    3.42   *  
    3.43   *  \param surface The surface to query.
    3.44 - *  \param r A pointer filled in with the source red color value.
    3.45 - *  \param g A pointer filled in with the source green color value.
    3.46 - *  \param b A pointer filled in with the source blue color value.
    3.47 + *  \param r A pointer filled in with the current red color value.
    3.48 + *  \param g A pointer filled in with the current green color value.
    3.49 + *  \param b A pointer filled in with the current blue color value.
    3.50   *  
    3.51   *  \return 0 on success, or -1 if the surface is not valid.
    3.52   *  
    3.53 @@ -269,7 +269,7 @@
    3.54   *  \brief Set an additional alpha value used in blit operations.
    3.55   *  
    3.56   *  \param surface The surface to update.
    3.57 - *  \param alpha The source alpha value multiplied into blit operations.
    3.58 + *  \param alpha The alpha value multiplied into blit operations.
    3.59   *  
    3.60   *  \return 0 on success, or -1 if the surface is not valid.
    3.61   *  
    3.62 @@ -282,7 +282,7 @@
    3.63   *  \brief Get the additional alpha value used in blit operations.
    3.64   *  
    3.65   *  \param surface The surface to query.
    3.66 - *  \param alpha A pointer filled in with the source alpha value.
    3.67 + *  \param alpha A pointer filled in with the current alpha value.
    3.68   *  
    3.69   *  \return 0 on success, or -1 if the surface is not valid.
    3.70   *  
     4.1 --- a/include/SDL_video.h	Mon Jan 10 12:15:16 2011 -0800
     4.2 +++ b/include/SDL_video.h	Wed Jan 12 09:47:33 2011 -0800
     4.3 @@ -885,9 +885,9 @@
     4.4   *  \brief Set an additional color value used in render copy operations.
     4.5   *  
     4.6   *  \param texture The texture to update.
     4.7 - *  \param r       The red source color value multiplied into copy operations.
     4.8 - *  \param g       The green source color value multiplied into copy operations.
     4.9 - *  \param b       The blue source color value multiplied into copy operations.
    4.10 + *  \param r       The red color value multiplied into copy operations.
    4.11 + *  \param g       The green color value multiplied into copy operations.
    4.12 + *  \param b       The blue color value multiplied into copy operations.
    4.13   *  
    4.14   *  \return 0 on success, or -1 if the texture is not valid or color modulation 
    4.15   *          is not supported.
    4.16 @@ -902,9 +902,9 @@
    4.17   *  \brief Get the additional color value used in render copy operations.
    4.18   *  
    4.19   *  \param texture The texture to query.
    4.20 - *  \param r         A pointer filled in with the source red color value.
    4.21 - *  \param g         A pointer filled in with the source green color value.
    4.22 - *  \param b         A pointer filled in with the source blue color value.
    4.23 + *  \param r         A pointer filled in with the current red color value.
    4.24 + *  \param g         A pointer filled in with the current green color value.
    4.25 + *  \param b         A pointer filled in with the current blue color value.
    4.26   *  
    4.27   *  \return 0 on success, or -1 if the texture is not valid.
    4.28   *  
    4.29 @@ -918,7 +918,7 @@
    4.30   *  \brief Set an additional alpha value used in render copy operations.
    4.31   *  
    4.32   *  \param texture The texture to update.
    4.33 - *  \param alpha     The source alpha value multiplied into copy operations.
    4.34 + *  \param alpha     The alpha value multiplied into copy operations.
    4.35   *  
    4.36   *  \return 0 on success, or -1 if the texture is not valid or alpha modulation 
    4.37   *          is not supported.
    4.38 @@ -932,7 +932,7 @@
    4.39   *  \brief Get the additional alpha value used in render copy operations.
    4.40   *  
    4.41   *  \param texture The texture to query.
    4.42 - *  \param alpha     A pointer filled in with the source alpha value.
    4.43 + *  \param alpha     A pointer filled in with the current alpha value.
    4.44   *  
    4.45   *  \return 0 on success, or -1 if the texture is not valid.
    4.46   *