Corrected spelling in header files.
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>
Sat, 27 Apr 2013 17:52:58 +0200
changeset 7125082c0c53ac16
parent 7124 45e40ae31722
child 7126 6fce42265686
Corrected spelling in header files.
include/SDL_events.h
include/SDL_gamecontroller.h
include/SDL_haptic.h
include/SDL_surface.h
     1.1 --- a/include/SDL_events.h	Sat Apr 27 17:23:20 2013 +0200
     1.2 +++ b/include/SDL_events.h	Sat Apr 27 17:52:58 2013 +0200
     1.3 @@ -599,7 +599,7 @@
     1.4   *  Sets up a filter to process all events before they change internal state and
     1.5   *  are posted to the internal event queue.
     1.6   *  
     1.7 - *  The filter is protypted as:
     1.8 + *  The filter is prototyped as:
     1.9   *  \code
    1.10   *      int SDL_EventFilter(void *userdata, SDL_Event * event);
    1.11   *  \endcode
     2.1 --- a/include/SDL_gamecontroller.h	Sat Apr 27 17:23:20 2013 +0200
     2.2 +++ b/include/SDL_gamecontroller.h	Sat Apr 27 17:52:58 2013 +0200
     2.3 @@ -102,7 +102,7 @@
     2.4   *  Buttons can be used as a controller axis and vice versa.
     2.5   *
     2.6   *  This string shows an example of a valid mapping for a controller
     2.7 - * 	"341a3608000000000000504944564944,Aferglow PS3 Controller,a:b1,b:b2,y:b3,x:b0,start:b9,guide:b12,back:b8,dpup:h0.1,dpleft:h0.8,dpdown:h0.4,dpright:h0.2,leftshoulder:b4,rightshoulder:b5,leftstick:b10,rightstick:b11,leftx:a0,lefty:a1,rightx:a2,righty:a3,lefttrigger:b6,righttrigger:b7",
     2.8 + * 	"341a3608000000000000504944564944,Afterglow PS3 Controller,a:b1,b:b2,y:b3,x:b0,start:b9,guide:b12,back:b8,dpup:h0.1,dpleft:h0.8,dpdown:h0.4,dpright:h0.2,leftshoulder:b4,rightshoulder:b5,leftstick:b10,rightstick:b11,leftx:a0,lefty:a1,rightx:a2,righty:a3,lefttrigger:b6,righttrigger:b7",
     2.9   *
    2.10   */
    2.11  
     3.1 --- a/include/SDL_haptic.h	Sat Apr 27 17:23:20 2013 +0200
     3.2 +++ b/include/SDL_haptic.h	Sat Apr 27 17:52:58 2013 +0200
     3.3 @@ -489,13 +489,13 @@
     3.4   *  over time.  The type determines the shape of the wave and the parameters
     3.5   *  determine the dimensions of the wave.
     3.6   *  
     3.7 - *  Phase is given by hundredth of a cyle meaning that giving the phase a value
     3.8 - *  of 9000 will displace it 25% of it's period.  Here are sample values:
     3.9 + *  Phase is given by hundredth of a cycle meaning that giving the phase a value
    3.10 + *  of 9000 will displace it 25% of its period.  Here are sample values:
    3.11   *   -     0: No phase displacement.
    3.12 - *   -  9000: Displaced 25% of it's period.
    3.13 - *   - 18000: Displaced 50% of it's period.
    3.14 - *   - 27000: Displaced 75% of it's period.
    3.15 - *   - 36000: Displaced 100% of it's period, same as 0, but 0 is preffered.
    3.16 + *   -  9000: Displaced 25% of its period.
    3.17 + *   - 18000: Displaced 50% of its period.
    3.18 + *   - 27000: Displaced 75% of its period.
    3.19 + *   - 36000: Displaced 100% of its period, same as 0, but 0 is preferred.
    3.20   *
    3.21   *  Examples:
    3.22   *  \verbatim
    3.23 @@ -651,7 +651,7 @@
    3.24   *  \brief A structure containing a template for the ::SDL_HAPTIC_CUSTOM effect.
    3.25   *  
    3.26   *  A custom force feedback effect is much like a periodic effect, where the
    3.27 - *  application can define it's exact shape.  You will have to allocate the
    3.28 + *  application can define its exact shape.  You will have to allocate the
    3.29   *  data yourself.  Data should consist of channels * samples Uint16 samples.
    3.30   *  
    3.31   *  If channels is one, the effect is rotated using the defined direction.
    3.32 @@ -781,7 +781,7 @@
    3.33   *  This can be called before any joysticks are opened.
    3.34   *  If no name can be found, this function returns NULL.
    3.35   *  
    3.36 - *  \param device_index Index of the device to get it's name.
    3.37 + *  \param device_index Index of the device to get its name.
    3.38   *  \return Name of the device or NULL on error.
    3.39   *
    3.40   *  \sa SDL_NumHaptics
    3.41 @@ -794,7 +794,7 @@
    3.42   *  The index passed as an argument refers to the N'th Haptic device on this 
    3.43   *  system.
    3.44   *
    3.45 - *  When opening a haptic device, it's gain will be set to maximum and
    3.46 + *  When opening a haptic device, its gain will be set to maximum and
    3.47   *  autocenter will be disabled.  To modify these values use
    3.48   *  SDL_HapticSetGain() and SDL_HapticSetAutocenter().
    3.49   *
    3.50 @@ -999,7 +999,7 @@
    3.51                                                     SDL_HapticEffect * data);
    3.52  
    3.53  /**
    3.54 - *  \brief Runs the haptic effect on it's associated haptic device.
    3.55 + *  \brief Runs the haptic effect on its associated haptic device.
    3.56   *  
    3.57   *  If iterations are ::SDL_HAPTIC_INFINITY, it'll run the effect over and over
    3.58   *  repeating the envelope (attack and fade) every time.  If you only want the
    3.59 @@ -1021,7 +1021,7 @@
    3.60                                                  Uint32 iterations);
    3.61  
    3.62  /**
    3.63 - *  \brief Stops the haptic effect on it's associated haptic device.
    3.64 + *  \brief Stops the haptic effect on its associated haptic device.
    3.65   *  
    3.66   *  \param haptic Haptic device to stop the effect on.
    3.67   *  \param effect Identifier of the effect to stop.
    3.68 @@ -1053,7 +1053,7 @@
    3.69   *  Device must support the ::SDL_HAPTIC_STATUS feature.
    3.70   *  
    3.71   *  \param haptic Haptic device to query the effect status on.
    3.72 - *  \param effect Identifier of the effect to query it's status.
    3.73 + *  \param effect Identifier of the effect to query its status.
    3.74   *  \return 0 if it isn't playing, ::SDL_HAPTIC_PLAYING if it is playing
    3.75   *          or -1 on error.
    3.76   *  
     4.1 --- a/include/SDL_surface.h	Sat Apr 27 17:23:20 2013 +0200
     4.2 +++ b/include/SDL_surface.h	Sat Apr 27 17:52:58 2013 +0200
     4.3 @@ -404,7 +404,7 @@
     4.4        SDL_SRCALPHA not set:
     4.5          copy RGB.
     4.6          if SDL_SRCCOLORKEY set, only copy the pixels matching the
     4.7 -        RGB values of the source colour key, ignoring alpha in the
     4.8 +        RGB values of the source color key, ignoring alpha in the
     4.9          comparison.
    4.10     
    4.11      RGB->RGBA:
    4.12 @@ -415,7 +415,7 @@
    4.13          copy RGB, set destination alpha to source per-surface alpha value.
    4.14        both:
    4.15          if SDL_SRCCOLORKEY set, only copy the pixels matching the
    4.16 -        source colour key.
    4.17 +        source color key.
    4.18     
    4.19      RGBA->RGBA:
    4.20        SDL_SRCALPHA set:
    4.21 @@ -425,7 +425,7 @@
    4.22        SDL_SRCALPHA not set:
    4.23          copy all of RGBA to the destination.
    4.24          if SDL_SRCCOLORKEY set, only copy the pixels matching the
    4.25 -        RGB values of the source colour key, ignoring alpha in the
    4.26 +        RGB values of the source color key, ignoring alpha in the
    4.27         comparison.
    4.28     
    4.29      RGB->RGB: 
    4.30 @@ -435,7 +435,7 @@
    4.31          copy RGB.
    4.32        both:
    4.33          if SDL_SRCCOLORKEY set, only copy the pixels matching the
    4.34 -        source colour key.
    4.35 +        source color key.
    4.36      \endverbatim
    4.37   *  
    4.38   *  You should call SDL_BlitSurface() unless you know exactly how SDL