Fixed haptic documentation typos (thanks, Elias!).
authorRyan C. Gordon <icculus@icculus.org>
Wed, 17 Sep 2014 14:47:42 -0400
changeset 9146 dbef1f283c3f
parent 9145 aa99e029b12e
child 9147 6bf589c8d549
Fixed haptic documentation typos (thanks, Elias!). Partially fixes Bugzilla #2701.
include/SDL_haptic.h
--- a/include/SDL_haptic.h	Wed Sep 17 11:41:12 2014 -0300
+++ b/include/SDL_haptic.h	Wed Sep 17 14:47:42 2014 -0400
@@ -492,7 +492,7 @@
  *  over time.  The type determines the shape of the wave and the parameters
  *  determine the dimensions of the wave.
  *
- *  Phase is given by hundredth of a cycle meaning that giving the phase a value
+ *  Phase is given by hundredth of a degree meaning that giving the phase a value
  *  of 9000 will displace it 25% of its period.  Here are sample values:
  *   -     0: No phase displacement.
  *   -  9000: Displaced 25% of its period.
@@ -555,7 +555,7 @@
     Uint16 period;      /**< Period of the wave. */
     Sint16 magnitude;   /**< Peak value. */
     Sint16 offset;      /**< Mean value of the wave. */
-    Uint16 phase;       /**< Horizontal shift given by hundredth of a cycle. */
+    Uint16 phase;       /**< Horizontal shift given by hundredth of a degree. */
 
     /* Envelope */
     Uint16 attack_length;   /**< Duration of the attack. */