Fixed SDL_GameControllerOpen() and SDL_JoystickOpen() documentation in header.
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>
Mon, 20 Apr 2015 20:03:40 +0200
changeset 9569 162adf32623f
parent 9568 a02d603d1de3
child 9570 8681778c5ede
Fixed SDL_GameControllerOpen() and SDL_JoystickOpen() documentation in header.
include/SDL_gamecontroller.h
include/SDL_joystick.h
--- a/include/SDL_gamecontroller.h	Mon Apr 20 20:03:26 2015 +0200
+++ b/include/SDL_gamecontroller.h	Mon Apr 20 20:03:40 2015 +0200
@@ -163,8 +163,9 @@
 /**
  *  Open a game controller for use.
  *  The index passed as an argument refers to the N'th game controller on the system.
- *  This index is the value which will identify this controller in future controller
- *  events.
+ *  This index is not the value which will identify this controller in future
+ *  controller events.  The joystick's instance id (::SDL_JoystickID) will be
+ *  used there instead.
  *
  *  \return A controller identifier, or NULL if an error occurred.
  */
--- a/include/SDL_joystick.h	Mon Apr 20 20:03:26 2015 +0200
+++ b/include/SDL_joystick.h	Mon Apr 20 20:03:40 2015 +0200
@@ -88,8 +88,9 @@
 /**
  *  Open a joystick for use.
  *  The index passed as an argument refers to the N'th joystick on the system.
- *  This index is the value which will identify this joystick in future joystick
- *  events.
+ *  This index is not the value which will identify this joystick in future
+ *  joystick events.  The joystick's instance id (::SDL_JoystickID) will be used
+ *  there instead.
  *
  *  \return A joystick identifier, or NULL if an error occurred.
  */