Add new tag for the LUFA-120219-BETA release.

[pub/USBasp.git] / LUFA / Drivers / Board / Joystick.h

diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h
index 7affe2e..0a1f9fa 100644 (file)
--- a/LUFA/Drivers/Board/Joystick.h
+++ b/LUFA/Drivers/Board/Joystick.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2012.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -76,14 +76,14 @@
  *
  *      // Display which direction the joystick was moved in
  *      printf("Joystick moved:\r\n");
- *      
+ *
  *      if (JoystickMovement & (JOY_UP | JOY_DOWN))
  *        printf("%s ", (JoystickMovement & JOY_UP) ? "Up" : "Down");
  *
  *      if (JoystickMovement & (JOY_LEFT | JOY_RIGHT))
  *        printf("%s ", (JoystickMovement & JOY_LEFT) ? "Left" : "Right");
  *
- *      if (JoystickMovement & JOY_PRESSED)
+ *      if (JoystickMovement & JOY_PRESS)
  *        printf("Pressed");
  *  \endcode
  *
@@ -119,21 +119,24 @@
                        #include "Board/Joystick.h"
                #endif
 
-               /* Pseudo-Functions for Doxygen: */
-               #if defined(__DOXYGEN__)
-                       /** Initializes the joystick driver so that the joystick position can be read. This sets the appropriate
-                        *  I/O pins to inputs with their pull-ups enabled.
-                        */
-                       static inline void Joystick_Init(void);
-
-                       /** Returns the current status of the joystick, as a mask indicating the direction the joystick is
-                        *  currently facing in (multiple bits can be set).
-                        *
-                        *  \return Mask indicating the joystick direction - see corresponding board specific Joystick.h file
-                        *          for direction masks.
-                        */
-                       static inline uint_reg_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
-               #endif
+       /* Pseudo-Functions for Doxygen: */
+       #if defined(__DOXYGEN__)
+               /** Initializes the joystick driver so that the joystick position can be read. This sets the appropriate
+                *  I/O pins to inputs with their pull-ups enabled.
+                */
+               static inline void Joystick_Init(void);
+
+               /** Disables the joystick driver, releasing the I/O pins back to their default high-impedence input mode. */
+               static inline void Joystick_Disable(void);
+
+               /** Returns the current status of the joystick, as a mask indicating the direction the joystick is
+                *  currently facing in (multiple bits can be set).
+                *
+                *  \return Mask indicating the joystick direction - see corresponding board specific Joystick.h file
+                *          for direction masks.
+                */
+               static inline uint_reg_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
+       #endif
 
 #endif