More interface header reviews by Azriel Fasten, and added skeleton docs for wxBookCtr...

[wxWidgets.git] / interface / joystick.h

diff --git a/interface/joystick.h b/interface/joystick.h
index 266d41a9e02750d44ec02422432818cf5e7b7475..d9b739c6ffac4be938c4f69f8a83c8067f3d7d4a 100644 (file)
--- a/interface/joystick.h
+++ b/interface/joystick.h
@@ -35,7 +35,7 @@ public:
     //@{
     /**
         Returns the state of the specified joystick button.
     //@{
     /**
         Returns the state of the specified joystick button.

-        
+

         @param id
             The button id to report, from 0 to GetNumberButtons() - 1
     */
         @param id
             The button id to report, from 0 to GetNumberButtons() - 1
     */


@@ -98,7 +98,7 @@ public:
     //@{
     /**
         Returns the position of the specified joystick axis.
     //@{
     /**
         Returns the position of the specified joystick axis.

-        
+

         @param axis
             The joystick axis to report, from 0 to GetNumberAxes() - 1.
     */
         @param axis
             The joystick axis to report, from 0 to GetNumberAxes() - 1.
     */


@@ -239,25 +239,25 @@ public:
 
     /**
         Releases the capture set by @b SetCapture.
 
     /**
         Releases the capture set by @b SetCapture.

-        
-        @returns @true if the capture release succeeded.
-        
+
+        @return @true if the capture release succeeded.
+

         @see SetCapture(), wxJoystickEvent
     */
     bool ReleaseCapture();
 
     /**
         Sets the capture to direct joystick events to @e win.
         @see SetCapture(), wxJoystickEvent
     */
     bool ReleaseCapture();
 
     /**
         Sets the capture to direct joystick events to @e win.

-        
+

         @param win
             The window that will receive joystick events.
         @param pollingFreq
             If zero, movement events are sent when above the
             threshold. If greater than zero, events are received every pollingFreq
         milliseconds.
         @param win
             The window that will receive joystick events.
         @param pollingFreq
             If zero, movement events are sent when above the
             threshold. If greater than zero, events are received every pollingFreq
         milliseconds.

-        
-        @returns @true if the capture succeeded.
-        
+
+        @return @true if the capture succeeded.
+

         @see ReleaseCapture(), wxJoystickEvent
     */
     bool SetCapture(wxWindow* win, int pollingFreq = 0);
         @see ReleaseCapture(), wxJoystickEvent
     */
     bool SetCapture(wxWindow* win, int pollingFreq = 0);