encounter
/
SDL
mirror of https://github.com/encounter/SDL.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed SDL_GameControllerOpen() and SDL_JoystickOpen() documentation in header.

This commit is contained in:
Philipp Wiesemann 2015-04-20 20:03:40 +02:00
parent 83c088a04a
commit 71c65b1569
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/SDL_gamecontroller.h
View File

@ -163,8 +163,9 @@ extern DECLSPEC const char *SDLCALL SDL_GameControllerNameForIndex(int joystick_
/** /**
* Open a game controller for use. * Open a game controller for use.
* The index passed as an argument refers to the N'th game controller on the system. * 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 * This index is not the value which will identify this controller in future
* events. * controller events. The joystick's instance id (::SDL_JoystickID) will be
* used there instead.
* *
* \return A controller identifier, or NULL if an error occurred. * \return A controller identifier, or NULL if an error occurred.
*/ */

5
include/SDL_joystick.h
View File

@ -88,8 +88,9 @@ extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index);
/** /**
* Open a joystick for use. * Open a joystick for use.
* The index passed as an argument refers to the N'th joystick on the system. * 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 * This index is not the value which will identify this joystick in future
* events. * joystick events. The joystick's instance id (::SDL_JoystickID) will be used
* there instead.
* *
* \return A joystick identifier, or NULL if an error occurred. * \return A joystick identifier, or NULL if an error occurred.
*/ */