Minor documentation corrections.

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

diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h
index 3dd89a9..c5995af 100644 (file)
--- a/LUFA/Drivers/Board/Buttons.h
+++ b/LUFA/Drivers/Board/Buttons.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
@@ -57,7 +57,7 @@
  *  actions can be taken.
  *
  *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Buttons.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.
  *
@@ -68,13 +68,13 @@
  *  \code
  *      // Initialize the button driver before first use
  *      Buttons_Init();
- *
+ *      
  *      printf("Waiting for button press...\r\n");
- *
+ *      
  *      // Loop until a board button has been pressed
  *      uint8_t ButtonPress;
  *      while (!(ButtonPress = Buttons_GetStatus())) {};
- *
+ *      
  *      // Display which button was pressed (assuming two board buttons)
  *      printf("Button pressed: %s\r\n", (ButtonPress == BUTTONS_BUTTON1) ? "Button 1" : "Button 2");
  *  \endcode
@@ -135,6 +135,22 @@
                        #include "XMEGA/A3BU_XPLAINED/Buttons.h"
                #elif ((BOARD == BOARD_USB2AX) || (BOARD == BOARD_USB2AX_V3))
                        #include "AVR8/USB2AX/Buttons.h"
+               #elif ((BOARD == BOARD_MICROPENDOUS_32U2) || (BOARD == BOARD_MICROPENDOUS_A) || \
+                      (BOARD == BOARD_MICROPENDOUS_1)    || (BOARD == BOARD_MICROPENDOUS_2) || \
+                      (BOARD == BOARD_MICROPENDOUS_3)    || (BOARD == BOARD_MICROPENDOUS_4) || \
+                      (BOARD == BOARD_MICROPENDOUS_REV1) || (BOARD == BOARD_MICROPENDOUS_REV2) || \
+                      (BOARD == BOARD_MICROPENDOUS_DIP))
+                       #include "AVR8/MICROPENDOUS/Buttons.h"
+               #elif (BOARD == BOARD_B1_XPLAINED)
+                       #include "XMEGA/B1_XPLAINED/Buttons.h"
+               #elif (BOARD == BOARD_OLIMEX32U4)
+                       #include "AVR8/OLIMEX32U4/Buttons.h"
+               #elif (BOARD == BOARD_OLIMEXT32U4)
+                       #include "AVR8/OLIMEXT32U4/Buttons.h"
+               #elif (BOARD == BOARD_OLIMEXISPMK2)
+                       #include "AVR8/OLIMEXISPMK2/Buttons.h"
+               #elif (BOARD == BOARD_UC3A3_XPLAINED)
+                       #include "UC3/UC3A3_XPLAINED/Buttons.h"
                #else
                        #include "Board/Buttons.h"
                #endif
@@ -148,12 +164,12 @@
                 */
                static inline void Buttons_Init(void);
 
-               /** Disables the buttons driver, releasing the I/O pins back to their default high-impedence input mode. */
+               /** Disables the buttons driver, releasing the I/O pins back to their default high-impedance input mode. */
                static inline void Buttons_Disable(void);
 
                /** Returns a mask indicating which board buttons are currently pressed.
                 *
-                *  \return Mask indicating which board buttons are currently pressed.
+                *  \return Mask of \c BUTTONS_BUTTON* constants indicating which board buttons are currently pressed.
                 */
                static inline uint_reg_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
        #endif