Add more include protection macros to give the user warnings when they try to manuall...

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

diff --git a/LUFA/Drivers/Board/USBKEY/Joystick.h b/LUFA/Drivers/Board/USBKEY/Joystick.h
index 6c2d72a..b082991 100644 (file)
--- a/LUFA/Drivers/Board/USBKEY/Joystick.h
+++ b/LUFA/Drivers/Board/USBKEY/Joystick.h
@@ -1,21 +1,21 @@
 /*\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
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\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
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\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
@@ -35,7 +35,18 @@
  *  \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
  *        dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
  */\r
- \r
+\r
+/** \ingroup Group_Joystick\r
+ *  @defgroup Group_Joystick_USBKEY USBKEY\r
+ *\r
+ *  Board specific joystick driver header for the USBKEY.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
+ *\r
+ *  @{\r
+ */\r
+\r
 #ifndef __JOYSTICK_USBKEY_H__\r
 #define __JOYSTICK_USBKEY_H__\r
 \r
@@ -50,7 +61,7 @@
                #endif\r
 \r
        /* Preprocessor Checks: */\r
-               #if !defined(INCLUDE_FROM_JOYSTICK_H)\r
+               #if !defined(__INCLUDE_FROM_JOYSTICK_H)\r
                        #error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead.\r
                #endif\r
 \r
@@ -87,7 +98,7 @@
 \r
                                PORTB |= JOY_BMASK;\r
                                PORTE |= JOY_EMASK;                             \r
-                       };\r
+                       }\r
                        \r
                        static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;\r
                        static inline uint8_t Joystick_GetStatus(void)\r
@@ -102,3 +113,5 @@
                #endif\r
 \r
 #endif\r
+\r
+/** @} */\r