Updated internal documentation comments.
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>
Wed, 11 Mar 2015 21:14:21 +0100
changeset 9380 07b7c1005a23
parent 9379 ff0e77a2f48c
child 9381 812b2dabf8a4
Updated internal documentation comments.
src/joystick/SDL_sysjoystick.h
src/joystick/android/SDL_sysjoystick.c
src/joystick/darwin/SDL_sysjoystick.c
src/joystick/dummy/SDL_sysjoystick.c
src/joystick/emscripten/SDL_sysjoystick.c
src/joystick/haiku/SDL_haikujoystick.cc
src/joystick/iphoneos/SDL_sysjoystick.m
src/joystick/linux/SDL_sysjoystick.c
src/joystick/psp/SDL_sysjoystick.c
src/joystick/windows/SDL_mmjoystick.c
src/joystick/windows/SDL_windowsjoystick.c
--- a/src/joystick/SDL_sysjoystick.h	Fri Mar 06 21:34:10 2015 +0100
+++ b/src/joystick/SDL_sysjoystick.h	Wed Mar 11 21:14:21 2015 +0100
@@ -78,14 +78,14 @@
 extern SDL_JoystickID SDL_SYS_GetInstanceIdOfDeviceIndex(int device_index);
 
 /* Function to open a joystick for use.
-   The joystick to open is specified by the index field of the joystick.
+   The joystick to open is specified by the device index.
    This should fill the nbuttons and naxes fields of the joystick structure.
    It returns 0, or -1 if there is an error.
  */
 extern int SDL_SYS_JoystickOpen(SDL_Joystick * joystick, int device_index);
 
 /* Function to query if the joystick is currently attached
- *   It returns 1 if attached, 0 otherwise.
+ * It returns SDL_TRUE if attached, SDL_FALSE otherwise.
  */
 extern SDL_bool SDL_SYS_JoystickAttached(SDL_Joystick * joystick);
 
--- a/src/joystick/android/SDL_sysjoystick.c	Fri Mar 06 21:34:10 2015 +0100
+++ b/src/joystick/android/SDL_sysjoystick.c	Wed Mar 11 21:14:21 2015 +0100
@@ -467,7 +467,7 @@
 }
 
 /* Function to open a joystick for use.
-   The joystick to open is specified by the index field of the joystick.
+   The joystick to open is specified by the device index.
    This should fill the nbuttons and naxes fields of the joystick structure.
    It returns 0, or -1 if there is an error.
  */
--- a/src/joystick/darwin/SDL_sysjoystick.c	Fri Mar 06 21:34:10 2015 +0100
+++ b/src/joystick/darwin/SDL_sysjoystick.c	Wed Mar 11 21:14:21 2015 +0100
@@ -646,7 +646,7 @@
 }
 
 /* Function to open a joystick for use.
- * The joystick to open is specified by the index field of the joystick.
+ * The joystick to open is specified by the device index.
  * This should fill the nbuttons and naxes fields of the joystick structure.
  * It returns 0, or -1 if there is an error.
  */
@@ -672,7 +672,7 @@
 }
 
 /* Function to query if the joystick is currently attached
- *   It returns 1 if attached, 0 otherwise.
+ * It returns SDL_TRUE if attached, SDL_FALSE otherwise.
  */
 SDL_bool
 SDL_SYS_JoystickAttached(SDL_Joystick * joystick)
--- a/src/joystick/dummy/SDL_sysjoystick.c	Fri Mar 06 21:34:10 2015 +0100
+++ b/src/joystick/dummy/SDL_sysjoystick.c	Wed Mar 11 21:14:21 2015 +0100
@@ -61,7 +61,7 @@
 }
 
 /* Function to open a joystick for use.
-   The joystick to open is specified by the index field of the joystick.
+   The joystick to open is specified by the device index.
    This should fill the nbuttons and naxes fields of the joystick structure.
    It returns 0, or -1 if there is an error.
  */
--- a/src/joystick/emscripten/SDL_sysjoystick.c	Fri Mar 06 21:34:10 2015 +0100
+++ b/src/joystick/emscripten/SDL_sysjoystick.c	Wed Mar 11 21:14:21 2015 +0100
@@ -292,7 +292,7 @@
 }
 
 /* Function to open a joystick for use.
-   The joystick to open is specified by the index field of the joystick.
+   The joystick to open is specified by the device index.
    This should fill the nbuttons and naxes fields of the joystick structure.
    It returns 0, or -1 if there is an error.
  */
--- a/src/joystick/haiku/SDL_haikujoystick.cc	Fri Mar 06 21:34:10 2015 +0100
+++ b/src/joystick/haiku/SDL_haikujoystick.cc	Wed Mar 11 21:14:21 2015 +0100
@@ -106,7 +106,7 @@
     }
 
 /* Function to open a joystick for use.
-   The joystick to open is specified by the index field of the joystick.
+   The joystick to open is specified by the device index.
    This should fill the nbuttons and naxes fields of the joystick structure.
    It returns 0, or -1 if there is an error.
  */
--- a/src/joystick/iphoneos/SDL_sysjoystick.m	Fri Mar 06 21:34:10 2015 +0100
+++ b/src/joystick/iphoneos/SDL_sysjoystick.m	Wed Mar 11 21:14:21 2015 +0100
@@ -69,7 +69,7 @@
 }
 
 /* Function to open a joystick for use.
-   The joystick to open is specified by the index field of the joystick.
+   The joystick to open is specified by the device index.
    This should fill the nbuttons and naxes fields of the joystick structure.
    It returns 0, or -1 if there is an error.
  */
--- a/src/joystick/linux/SDL_sysjoystick.c	Fri Mar 06 21:34:10 2015 +0100
+++ b/src/joystick/linux/SDL_sysjoystick.c	Wed Mar 11 21:14:21 2015 +0100
@@ -566,7 +566,7 @@
 
 
 /* Function to open a joystick for use.
-   The joystick to open is specified by the index field of the joystick.
+   The joystick to open is specified by the device index.
    This should fill the nbuttons and naxes fields of the joystick structure.
    It returns 0, or -1 if there is an error.
  */
--- a/src/joystick/psp/SDL_sysjoystick.c	Fri Mar 06 21:34:10 2015 +0100
+++ b/src/joystick/psp/SDL_sysjoystick.c	Wed Mar 11 21:14:21 2015 +0100
@@ -164,7 +164,7 @@
 }
 
 /* Function to open a joystick for use.
-   The joystick to open is specified by the index field of the joystick.
+   The joystick to open is specified by the device index.
    This should fill the nbuttons and naxes fields of the joystick structure.
    It returns 0, or -1 if there is an error.
  */
@@ -182,12 +182,12 @@
 {
     return SDL_TRUE;
 }
+
 /* Function to update the state of a joystick - called as a device poll.
  * This function shouldn't update the joystick structure directly,
  * but instead should call SDL_PrivateJoystick*() to deliver events
  * and update joystick device state.
  */
-
 void SDL_SYS_JoystickUpdate(SDL_Joystick *joystick)
 {
     int i;
--- a/src/joystick/windows/SDL_mmjoystick.c	Fri Mar 06 21:34:10 2015 +0100
+++ b/src/joystick/windows/SDL_mmjoystick.c	Wed Mar 11 21:14:21 2015 +0100
@@ -210,7 +210,7 @@
 }
 
 /* Function to open a joystick for use.
-   The joystick to open is specified by the index field of the joystick.
+   The joystick to open is specified by the device index.
    This should fill the nbuttons and naxes fields of the joystick structure.
    It returns 0, or -1 if there is an error.
  */
--- a/src/joystick/windows/SDL_windowsjoystick.c	Fri Mar 06 21:34:10 2015 +0100
+++ b/src/joystick/windows/SDL_windowsjoystick.c	Wed Mar 11 21:14:21 2015 +0100
@@ -446,7 +446,7 @@
 }
 
 /* Function to open a joystick for use.
-   The joystick to open is specified by the index field of the joystick.
+   The joystick to open is specified by the device index.
    This should fill the nbuttons and naxes fields of the joystick structure.
    It returns 0, or -1 if there is an error.
  */