More improvements to the incomplete BluetoothHost demo - add Disconnection Event...

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

diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h
index 1f57e62..18993c5 100644 (file)
--- a/LUFA/Drivers/Board/Joystick.h
+++ b/LUFA/Drivers/Board/Joystick.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r

 \r
 \r

-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r

   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -29,6 +29,7 @@
 */\r
 \r
 /** \file\r
 */\r
 \r
 /** \file\r

+ *  \brief Master include file for the board digital joystick driver.\r

  *\r
  *  This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a\r
  *  5-way joystick.\r
  *\r
  *  This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a\r
  *  5-way joystick.\r


@@ -40,33 +41,54 @@
  *  directory.\r
  */\r
  \r
  *  directory.\r
  */\r
  \r

+/** \ingroup Group_BoardDrivers\r
+ *  @defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h\r
+ *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - None\r
+ *\r
+ *  \section Module Description\r
+ *  Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick\r
+ *  located on many boards.\r
+ *\r
+ *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project\r
+ *  directory. Otherwise, it will include the appropriate built in board driver header file.\r
+ *\r
+ *  @{\r
+ */\r
+\r

 #ifndef __JOYSTICK_H__\r
 #define __JOYSTICK_H__\r
 \r
        /* Macros: */\r
        #if !defined(__DOXYGEN__)\r
 #ifndef __JOYSTICK_H__\r
 #define __JOYSTICK_H__\r
 \r
        /* Macros: */\r
        #if !defined(__DOXYGEN__)\r

+               #define __INCLUDE_FROM_JOYSTICK_H\r

                #define INCLUDE_FROM_JOYSTICK_H\r
                #define INCLUDE_FROM_JOYSTICK_H\r

-               #define INCLUDE_FROM_BOARD_DRIVER\r

        #endif\r
 \r
        /* Includes: */\r
        #include "../../Common/Common.h"\r
        \r
        #endif\r
 \r
        /* Includes: */\r
        #include "../../Common/Common.h"\r
        \r

-       #if !defined(BOARD)\r
-               #error BOARD must be set in makefile to a value specified in BoardTypes.h.\r
+       #if (BOARD == BOARD_NONE)\r
+               #error The Board Joystick driver cannot be used if the makefile BOARD option is not set.\r

        #elif (BOARD == BOARD_USBKEY)\r
                #include "USBKEY/Joystick.h"\r
        #elif (BOARD == BOARD_STK525)\r
                #include "STK525/Joystick.h"\r
        #elif (BOARD == BOARD_STK526)\r
                #include "STK526/Joystick.h"\r
        #elif (BOARD == BOARD_USBKEY)\r
                #include "USBKEY/Joystick.h"\r
        #elif (BOARD == BOARD_STK525)\r
                #include "STK525/Joystick.h"\r
        #elif (BOARD == BOARD_STK526)\r
                #include "STK526/Joystick.h"\r

+       #elif (BOARD == BOARD_BUMBLEB)\r
+               #include "BUMBLEB/Joystick.h"\r
+       #elif (BOARD == BOARD_EVK527)\r
+               #include "EVK527/Joystick.h"\r

        #elif (BOARD == BOARD_USER)\r
        #elif (BOARD == BOARD_USER)\r

-               #include "Board/Joystick.h"             \r
+               #include "Board/Joystick.h"\r

        #else\r
                #error The selected board does not contain a joystick.\r
        #endif\r
 \r
        #else\r
                #error The selected board does not contain a joystick.\r
        #endif\r
 \r

-       /* Psudo-Functions for Doxygen: */\r
+       /* Pseudo-Functions for Doxygen: */\r

        #if defined(__DOXYGEN__)\r
                /** Initializes the joystick driver so that the joystick position can be read. This sets the appropriate\r
                 *  I/O pins to inputs with their pull-ups enabled.\r
        #if defined(__DOXYGEN__)\r
                /** Initializes the joystick driver so that the joystick position can be read. This sets the appropriate\r
                 *  I/O pins to inputs with their pull-ups enabled.\r


@@ -83,3 +105,5 @@
        #endif\r
 \r
 #endif\r
        #endif\r
 \r
 #endif\r

+\r
+/** @} */\r