Add more const-ness to the stream endpoint/pipe functions where possible.

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

diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h
index 44e3ef6..1e31059 100644 (file)
--- a/LUFA/Drivers/Board/Buttons.h
+++ b/LUFA/Drivers/Board/Buttons.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
@@ -37,10 +37,10 @@
  *  User code should include this file, which will in turn include the correct Button driver header file for the
  *  currently selected board.
  *
- *  If the BOARD value is set to BOARD_USER, this will include the /Board/Buttons.h file in the user project
+ *  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.
  *
- *  For possible BOARD makefile values, see \ref Group_BoardTypes.
+ *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
  */
 
 /** \ingroup Group_BoardDrivers
@@ -50,16 +50,34 @@
  *  The following files must be built with any user project that uses this module:
  *    - None
  *
- *  \section Module Description
+ *  \section Sec_ModDescription Module Description
  *  Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.
  *  It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
  *  actions can be taken.
  *
- *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
+ *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project
  *  directory. Otherwise, it will include the appropriate built in board driver header file.
  *
- *  For possible BOARD makefile values, see \ref Group_BoardTypes.
+ *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
+ *
+ *  \section Sec_ExampleUsage Example Usage
+ *  The following snippet is an example of how this module may be used within a typical
+ *  application.
+ *
+ *  \code
+ *      // Initialise 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
+ * 
  *  @{
  */
 
@@ -74,7 +92,7 @@
 
        /* Includes: */
        #include "../../Common/Common.h"
-       
+
        #if (BOARD == BOARD_NONE)
                #error The Board Buttons driver cannot be used if the makefile BOARD option is not set.
        #elif (BOARD == BOARD_USBKEY)
@@ -90,7 +108,7 @@
        #elif (BOARD == BOARD_EVK527)
                #include "EVK527/Buttons.h"
        #elif (BOARD == BOARD_USBTINYMKII)
-               #include "USBTINYMKII/Buttons.h"                
+               #include "USBTINYMKII/Buttons.h"
        #elif (BOARD == BOARD_BENITO)
                #include "BENITO/Buttons.h"
        #elif (BOARD == BOARD_JMDBU2)
@@ -103,12 +121,16 @@
                #include "UDIP/Buttons.h"
        #elif (BOARD == BOARD_CULV3)
                #include "CULV3/Buttons.h"
+       #elif (BOARD == BOARD_MINIMUS)
+               #include "MINIMUS/Buttons.h"
+       #elif (BOARD == BOARD_MICROSIN162)
+               #include "MICROSIN162/Buttons.h"
        #elif (BOARD == BOARD_USER)
                #include "Board/Buttons.h"
        #else
                #error The selected board does not contain any GPIO buttons.
        #endif
-       
+
        /* Pseudo-Functions for Doxygen: */
        #if defined(__DOXYGEN__)
                /** Initialises the BUTTONS driver, so that the current button position can be read. This sets the appropriate
@@ -117,7 +139,7 @@
                 *  This must be called before any Button driver functions are used.
                 */
                static inline void Buttons_Init(void);
-               
+
                /** Returns a mask indicating which board buttons are currently pressed.
                 *
                 *  \return Mask indicating which board buttons are currently pressed.
@@ -128,3 +150,4 @@
 #endif
 
 /** @} */
+