X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/6a10d6b465be27db090d760dc0fbe722c94e4344..d753512ccae76a4fce665b2c16ba7d5867143a96:/LUFA/Drivers/Board/Joystick.h diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h index 1f57e62c3..082b51559 100644 --- a/LUFA/Drivers/Board/Joystick.h +++ b/LUFA/Drivers/Board/Joystick.h @@ -40,13 +40,29 @@ * directory. */ +/** \ingroup Group_BoardDrivers + * @defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h + * + * \section Sec_Dependencies Module Source Dependencies + * The following files must be built with any user project that uses this module: + * - None + * + * \section Module Description + * Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick + * located on many boards. + * + * If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project + * directory. Otherwise, it will include the appropriate built in board driver header file. + * + * @{ + */ + #ifndef __JOYSTICK_H__ #define __JOYSTICK_H__ /* Macros: */ #if !defined(__DOXYGEN__) #define INCLUDE_FROM_JOYSTICK_H - #define INCLUDE_FROM_BOARD_DRIVER #endif /* Includes: */ @@ -60,13 +76,15 @@ #include "STK525/Joystick.h" #elif (BOARD == BOARD_STK526) #include "STK526/Joystick.h" + #elif (BOARD == BOARD_BUMBLEB) + #include "BUMBLEB/Joystick.h" #elif (BOARD == BOARD_USER) #include "Board/Joystick.h" #else #error The selected board does not contain a joystick. #endif - /* Psudo-Functions for Doxygen: */ + /* 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. @@ -83,3 +101,5 @@ #endif #endif + +/** @} */