Commit 78d3a713de8d3486e28c5079e3188ed1c8e6d01d

Sam Lantinga 2022-12-29T15:00:32

Fixed documentation for SDL_JoystickGetDeviceInstanceID Fixes https://github.com/libsdl-org/SDL/issues/6946

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
diff --git a/include/SDL_joystick.h b/include/SDL_joystick.h
index 9dcadc7..00e83cb 100644
--- a/include/SDL_joystick.h
+++ b/include/SDL_joystick.h
@@ -288,13 +288,12 @@ extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_in
 /**
  * Get the instance ID of a joystick.
  *
- * This can be called before any joysticks are opened. If the index is out of
- * range, this function will return -1.
+ * This can be called before any joysticks are opened.
  *
  * \param device_index the index of the joystick to query (the N'th joystick
  *                     on the system
  * \returns the instance id of the selected joystick. If called on an invalid
- *          index, this function returns zero
+ *          index, this function returns -1.
  *
  * \since This function is available since SDL 2.0.6.
  */