mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-06 19:38:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

include: add \brief to includes

Browse Source
This commit is contained in:
Anonymous Maarten
2023-02-18 18:32:06 +01:00
committed by Sam Lantinga
parent 0625695898
commit 549cedfa88
68 changed files with 159 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
include/SDL3/SDL_joystick.h
View File

@@ -22,17 +22,17 @@
/**
* \file SDL_joystick.h
*
* Include file for SDL joystick event handling
* \brief Include file for SDL joystick event handling
*
* The term "instance_id" is the current instantiation of a joystick device in the system, if the joystick is removed and then re-inserted
* then it will get a new instance_id, instance_id's are monotonically increasing identifiers of a joystick plugged in.
* The term "instance_id" is the current instantiation of a joystick device in the system, if the joystick is removed and then re-inserted
* then it will get a new instance_id, instance_id's are monotonically increasing identifiers of a joystick plugged in.
*
* The term "player_index" is the number assigned to a player on a specific
* controller. For XInput controllers this returns the XInput user index.
* Many joysticks will not be able to supply this information.
* The term "player_index" is the number assigned to a player on a specific
* controller. For XInput controllers this returns the XInput user index.
* Many joysticks will not be able to supply this information.
*
* The term JoystickGUID is a stable 128-bit identifier for a joystick device that does not change over time, it identifies class of
* the device (a X360 wired controller for example). This identifier is platform dependent.
* The term JoystickGUID is a stable 128-bit identifier for a joystick device that does not change over time, it identifies class of
* the device (a X360 wired controller for example). This identifier is platform dependent.
*/
#ifndef SDL_joystick_h_