Updated internal documentation comments.
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>
Wed, 11 Mar 2015 21:14:21 +0100
changeset 938007b7c1005a23
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
     1.1 --- a/src/joystick/SDL_sysjoystick.h	Fri Mar 06 21:34:10 2015 +0100
     1.2 +++ b/src/joystick/SDL_sysjoystick.h	Wed Mar 11 21:14:21 2015 +0100
     1.3 @@ -78,14 +78,14 @@
     1.4  extern SDL_JoystickID SDL_SYS_GetInstanceIdOfDeviceIndex(int device_index);
     1.5  
     1.6  /* Function to open a joystick for use.
     1.7 -   The joystick to open is specified by the index field of the joystick.
     1.8 +   The joystick to open is specified by the device index.
     1.9     This should fill the nbuttons and naxes fields of the joystick structure.
    1.10     It returns 0, or -1 if there is an error.
    1.11   */
    1.12  extern int SDL_SYS_JoystickOpen(SDL_Joystick * joystick, int device_index);
    1.13  
    1.14  /* Function to query if the joystick is currently attached
    1.15 - *   It returns 1 if attached, 0 otherwise.
    1.16 + * It returns SDL_TRUE if attached, SDL_FALSE otherwise.
    1.17   */
    1.18  extern SDL_bool SDL_SYS_JoystickAttached(SDL_Joystick * joystick);
    1.19  
     2.1 --- a/src/joystick/android/SDL_sysjoystick.c	Fri Mar 06 21:34:10 2015 +0100
     2.2 +++ b/src/joystick/android/SDL_sysjoystick.c	Wed Mar 11 21:14:21 2015 +0100
     2.3 @@ -467,7 +467,7 @@
     2.4  }
     2.5  
     2.6  /* Function to open a joystick for use.
     2.7 -   The joystick to open is specified by the index field of the joystick.
     2.8 +   The joystick to open is specified by the device index.
     2.9     This should fill the nbuttons and naxes fields of the joystick structure.
    2.10     It returns 0, or -1 if there is an error.
    2.11   */
     3.1 --- a/src/joystick/darwin/SDL_sysjoystick.c	Fri Mar 06 21:34:10 2015 +0100
     3.2 +++ b/src/joystick/darwin/SDL_sysjoystick.c	Wed Mar 11 21:14:21 2015 +0100
     3.3 @@ -646,7 +646,7 @@
     3.4  }
     3.5  
     3.6  /* Function to open a joystick for use.
     3.7 - * The joystick to open is specified by the index field of the joystick.
     3.8 + * The joystick to open is specified by the device index.
     3.9   * This should fill the nbuttons and naxes fields of the joystick structure.
    3.10   * It returns 0, or -1 if there is an error.
    3.11   */
    3.12 @@ -672,7 +672,7 @@
    3.13  }
    3.14  
    3.15  /* Function to query if the joystick is currently attached
    3.16 - *   It returns 1 if attached, 0 otherwise.
    3.17 + * It returns SDL_TRUE if attached, SDL_FALSE otherwise.
    3.18   */
    3.19  SDL_bool
    3.20  SDL_SYS_JoystickAttached(SDL_Joystick * joystick)
     4.1 --- a/src/joystick/dummy/SDL_sysjoystick.c	Fri Mar 06 21:34:10 2015 +0100
     4.2 +++ b/src/joystick/dummy/SDL_sysjoystick.c	Wed Mar 11 21:14:21 2015 +0100
     4.3 @@ -61,7 +61,7 @@
     4.4  }
     4.5  
     4.6  /* Function to open a joystick for use.
     4.7 -   The joystick to open is specified by the index field of the joystick.
     4.8 +   The joystick to open is specified by the device index.
     4.9     This should fill the nbuttons and naxes fields of the joystick structure.
    4.10     It returns 0, or -1 if there is an error.
    4.11   */
     5.1 --- a/src/joystick/emscripten/SDL_sysjoystick.c	Fri Mar 06 21:34:10 2015 +0100
     5.2 +++ b/src/joystick/emscripten/SDL_sysjoystick.c	Wed Mar 11 21:14:21 2015 +0100
     5.3 @@ -292,7 +292,7 @@
     5.4  }
     5.5  
     5.6  /* Function to open a joystick for use.
     5.7 -   The joystick to open is specified by the index field of the joystick.
     5.8 +   The joystick to open is specified by the device index.
     5.9     This should fill the nbuttons and naxes fields of the joystick structure.
    5.10     It returns 0, or -1 if there is an error.
    5.11   */
     6.1 --- a/src/joystick/haiku/SDL_haikujoystick.cc	Fri Mar 06 21:34:10 2015 +0100
     6.2 +++ b/src/joystick/haiku/SDL_haikujoystick.cc	Wed Mar 11 21:14:21 2015 +0100
     6.3 @@ -106,7 +106,7 @@
     6.4      }
     6.5  
     6.6  /* Function to open a joystick for use.
     6.7 -   The joystick to open is specified by the index field of the joystick.
     6.8 +   The joystick to open is specified by the device index.
     6.9     This should fill the nbuttons and naxes fields of the joystick structure.
    6.10     It returns 0, or -1 if there is an error.
    6.11   */
     7.1 --- a/src/joystick/iphoneos/SDL_sysjoystick.m	Fri Mar 06 21:34:10 2015 +0100
     7.2 +++ b/src/joystick/iphoneos/SDL_sysjoystick.m	Wed Mar 11 21:14:21 2015 +0100
     7.3 @@ -69,7 +69,7 @@
     7.4  }
     7.5  
     7.6  /* Function to open a joystick for use.
     7.7 -   The joystick to open is specified by the index field of the joystick.
     7.8 +   The joystick to open is specified by the device index.
     7.9     This should fill the nbuttons and naxes fields of the joystick structure.
    7.10     It returns 0, or -1 if there is an error.
    7.11   */
     8.1 --- a/src/joystick/linux/SDL_sysjoystick.c	Fri Mar 06 21:34:10 2015 +0100
     8.2 +++ b/src/joystick/linux/SDL_sysjoystick.c	Wed Mar 11 21:14:21 2015 +0100
     8.3 @@ -566,7 +566,7 @@
     8.4  
     8.5  
     8.6  /* Function to open a joystick for use.
     8.7 -   The joystick to open is specified by the index field of the joystick.
     8.8 +   The joystick to open is specified by the device index.
     8.9     This should fill the nbuttons and naxes fields of the joystick structure.
    8.10     It returns 0, or -1 if there is an error.
    8.11   */
     9.1 --- a/src/joystick/psp/SDL_sysjoystick.c	Fri Mar 06 21:34:10 2015 +0100
     9.2 +++ b/src/joystick/psp/SDL_sysjoystick.c	Wed Mar 11 21:14:21 2015 +0100
     9.3 @@ -164,7 +164,7 @@
     9.4  }
     9.5  
     9.6  /* Function to open a joystick for use.
     9.7 -   The joystick to open is specified by the index field of the joystick.
     9.8 +   The joystick to open is specified by the device index.
     9.9     This should fill the nbuttons and naxes fields of the joystick structure.
    9.10     It returns 0, or -1 if there is an error.
    9.11   */
    9.12 @@ -182,12 +182,12 @@
    9.13  {
    9.14      return SDL_TRUE;
    9.15  }
    9.16 +
    9.17  /* Function to update the state of a joystick - called as a device poll.
    9.18   * This function shouldn't update the joystick structure directly,
    9.19   * but instead should call SDL_PrivateJoystick*() to deliver events
    9.20   * and update joystick device state.
    9.21   */
    9.22 -
    9.23  void SDL_SYS_JoystickUpdate(SDL_Joystick *joystick)
    9.24  {
    9.25      int i;
    10.1 --- a/src/joystick/windows/SDL_mmjoystick.c	Fri Mar 06 21:34:10 2015 +0100
    10.2 +++ b/src/joystick/windows/SDL_mmjoystick.c	Wed Mar 11 21:14:21 2015 +0100
    10.3 @@ -210,7 +210,7 @@
    10.4  }
    10.5  
    10.6  /* Function to open a joystick for use.
    10.7 -   The joystick to open is specified by the index field of the joystick.
    10.8 +   The joystick to open is specified by the device index.
    10.9     This should fill the nbuttons and naxes fields of the joystick structure.
   10.10     It returns 0, or -1 if there is an error.
   10.11   */
    11.1 --- a/src/joystick/windows/SDL_windowsjoystick.c	Fri Mar 06 21:34:10 2015 +0100
    11.2 +++ b/src/joystick/windows/SDL_windowsjoystick.c	Wed Mar 11 21:14:21 2015 +0100
    11.3 @@ -446,7 +446,7 @@
    11.4  }
    11.5  
    11.6  /* Function to open a joystick for use.
    11.7 -   The joystick to open is specified by the index field of the joystick.
    11.8 +   The joystick to open is specified by the device index.
    11.9     This should fill the nbuttons and naxes fields of the joystick structure.
   11.10     It returns 0, or -1 if there is an error.
   11.11   */