remove C++ comment

[wxWidgets.git] / docs / latex / wx / joystick.tex

diff --git a/docs/latex/wx/joystick.tex b/docs/latex/wx/joystick.tex
index 782dc55f5a0a039539a3d48d8c39f58eaf7d57f7..1b1ca2cb85c32c23a602dc22abfa1cf7dd59e188 100644 (file)
--- a/docs/latex/wx/joystick.tex
+++ b/docs/latex/wx/joystick.tex
@@ -10,6 +10,10 @@ wxJoystick allows an application to control one or more joysticks.
 
 <wx/joystick.h>
 
 
 <wx/joystick.h>
 

+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxJoystickEvent}{wxjoystickevent}
 \wxheading{See also}
 
 \helpref{wxJoystickEvent}{wxjoystickevent}


@@ -39,6 +43,14 @@ significant bit, and so on.
 A bitlist of wxJOY\_BUTTONn identifiers, where n is 1, 2, 3 or 4 
 is available for historical reasons.
 
 A bitlist of wxJOY\_BUTTONn identifiers, where n is 1, 2, 3 or 4 
 is available for historical reasons.
 

+\constfunc{bool}{GetButtonState}{\param{unsigned}{ id}}
+
+Returns the state of the specified joystick button.
+
+\wxheading{Parameters}
+
+\docparam{id}{The button id to report, from 0 to \helpref{GetNumberButtons()}{wxjoystickgetnumberbuttons} - 1}
+

 \membersection{wxJoystick::GetManufacturerId}\label{wxjoystickgetmanufacturerid}
 
 \constfunc{int}{GetManufacturerId}{\void}
 \membersection{wxJoystick::GetManufacturerId}\label{wxjoystickgetmanufacturerid}
 
 \constfunc{int}{GetManufacturerId}{\void}


@@ -66,7 +78,7 @@ Returns the number of buttons for this joystick.
 
 \membersection{wxJoystick::GetNumberJoysticks}\label{wxjoystickgetnumberjoysticks}
 
 
 \membersection{wxJoystick::GetNumberJoysticks}\label{wxjoystickgetnumberjoysticks}
 

-\constfunc{int}{GetNumberJoysticks}{\void}
+\func{static int}{GetNumberJoysticks}{\void}

 
 Returns the number of joysticks currently attached to the computer.
 
 
 Returns the number of joysticks currently attached to the computer.
 


@@ -100,6 +112,14 @@ Returns the product name for the joystick.
 
 Returns the x, y position of the joystick.
 
 
 Returns the x, y position of the joystick.
 

+\constfunc{int}{GetPosition}{\param{unsigned}{ axis}}
+
+Returns the position of the specified joystick axis.
+
+\wxheading{Parameters}
+
+\docparam{axis}{The joystick axis to report, from 0 to \helpref{GetNumberAxes()}{wxjoystickgetnumberaxes} - 1.}
+

 \membersection{wxJoystick::GetPOVPosition}\label{wxjoystickgetpovposition}
 
 \constfunc{int}{GetPOVPosition}{\void}
 \membersection{wxJoystick::GetPOVPosition}\label{wxjoystickgetpovposition}
 
 \constfunc{int}{GetPOVPosition}{\void}


@@ -201,7 +221,7 @@ Returns the maximum z position.
 
 \membersection{wxJoystick::GetZMin}\label{wxjoystickgetzmin}
 
 
 \membersection{wxJoystick::GetZMin}\label{wxjoystickgetzmin}
 

-\constfunc{int}{GetXMin}{\void}
+\constfunc{int}{GetZMin}{\void}

 
 Returns the minimum z position.
 
 
 Returns the minimum z position.