Add ASF provider manifest file and adjust VSIX packing to compress the library contents.

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

diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h
index 0d91576..e39c225 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, 2013.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  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
@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
@@ -56,7 +56,7 @@
  *  located on many boards.
  *
  *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Joystick.h file in the user project
- *  directory. Otherwise, it will include the appropriate built in board driver header file.
+ *  directory. Otherwise, it will include the appropriate built-in board driver header file.
  *
  *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
  *
@@ -67,23 +67,23 @@
  *  \code
  *      // Initialize the board Joystick driver before first use
  *      Joystick_Init();
- *
+ *      
  *      printf("Waiting for joystick movement...\r\n");
- *
+ *      
  *      // Loop until a the joystick has been moved
  *      uint8_t JoystickMovement;
  *      while (!(JoystickMovement = Joystick_GetStatus())) {};
- *
+ *      
  *      // 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
  *
@@ -123,14 +123,18 @@
        #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.
+                *
+                *  This must be called before any Joystick driver functions are used.
                 */
                static inline void Joystick_Init(void);
 
+               /** Disables the joystick driver, releasing the I/O pins back to their default high-impedance 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.
+                *  \return Mask of \c JOYSTICK_* constants indicating the current joystick direction(s).
                 */
                static inline uint_reg_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
        #endif