Add documentation for the Open method in the joystick class.
This commit is contained in:
parent
d1644d7e4f
commit
c8e6696716
@ -10,9 +10,52 @@
|
||||
* src/kits/device/Joystick.cpp hrev48613
|
||||
*/
|
||||
|
||||
/*!
|
||||
\file Joystick.h
|
||||
\ingroup device
|
||||
\brief BJoystick class definition.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\class Joystick
|
||||
\ingroup device
|
||||
\brief Class that provides an interface to a joystick and other similar game
|
||||
controllers.
|
||||
|
||||
This class adds support for joysticks and other similar game controllers
|
||||
through game ports, both, on cards and some build-in ports.
|
||||
|
||||
The class also provides two modes - standard and enhanced
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn int32 BJoystick::CountDevices()
|
||||
\brief Count the number of joysticks connected.
|
||||
|
||||
\return The number of joystick devices connected.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn status_t BJoystick::Open(const char *portname, bool enhanced)
|
||||
\brief Open a specific game port.
|
||||
|
||||
This method can be used to open the game port specified by the parameter
|
||||
\c portname amd also allows you to specify whether to use enhanced mode or
|
||||
not.
|
||||
|
||||
Enhanced mode adds support for up to 32 buttons per joystick, an indefinite
|
||||
number of axes and thumb controls, and also allows you to connect multiple
|
||||
joysticks to a single game port. It provides several methods to determine
|
||||
the state of a joystick and also a preference application.
|
||||
|
||||
Enhanced mode also provides a mechanism to determine what joysticks are
|
||||
available and what types of and how many controls are available on them.
|
||||
|
||||
\param portname The name of the game port to be opened.
|
||||
\param enhanced Specifies whether to use enhanced mode while opening the port.
|
||||
\return B_BAD_VALUE if portname is null.
|
||||
B_ERROR if the specified port is unable to open or if portname is not valid.
|
||||
A positive integer if the port is opened succesfully.
|
||||
\see CountDevices()
|
||||
GetDeviceName()
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user