summaryrefslogtreecommitdiff
path: root/include/SDL_joystick.h
diff options
context:
space:
mode:
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>2015-04-20 20:03:40 +0200
committerPhilipp Wiesemann <philipp.wiesemann@arcor.de>2015-04-20 20:03:40 +0200
commit5269fc1dc043df011b6be1dfd45d2d6d519c14b9 (patch)
tree09aea568c9a9bdd5fcb7f7ca7ed9f9f653e712f3 /include/SDL_joystick.h
parent7611a0479f8cebc85a4885ade21bae80d2d56d79 (diff)
downloadsdl-5269fc1dc043df011b6be1dfd45d2d6d519c14b9.tar.gz
Fixed SDL_GameControllerOpen() and SDL_JoystickOpen() documentation in header.
Diffstat (limited to 'include/SDL_joystick.h')
-rw-r--r--include/SDL_joystick.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/include/SDL_joystick.h b/include/SDL_joystick.h
index f26bb9214..c2110716c 100644
--- a/include/SDL_joystick.h
+++ b/include/SDL_joystick.h
@@ -88,8 +88,9 @@ extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index);
/**
* 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.
*/