Change over Joystick demo HID report descriptor to use USAGE_MINIMUM and USAGE_MAXIMU...

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

diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h
index 4d38976..0e2d484 100644 (file)
--- a/LUFA/Drivers/Board/LEDs.h
+++ b/LUFA/Drivers/Board/LEDs.h
@@ -1,13 +1,13 @@
 /*
              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
   software and its documentation for any purpose is hereby granted
@@ -37,10 +37,10 @@
  *  User code should include this file, which will in turn include the correct LED driver header file for the
  *  currently selected board.
  *
- *  If the BOARD value is set to BOARD_USER, this will include the /Board/LEDs.h file in the user project
+ *  If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/LEDs.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,15 +50,15 @@
  *  The following files must be built with any user project that uses this module:
  *    - None
  *
- *  \section Module Description
+ *  \section Sec_ModDescription Module Description
  *  Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It
  *  provides an interface to configure, test and change the status of all the board LEDs.
  *
- *  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. If the BOARD value
- *  is set to BOARD_NONE, this driver is silently disabled.
+ *  is set to \c BOARD_NONE, this driver is silently disabled.
  *
- *  For possible BOARD makefile values, see \ref Group_BoardTypes.
+ *  For possible \c BOARD makefile values, see \ref Group_BoardTypes.
  *
  *  \note To make code as compatible as possible, it is assumed that all boards carry a minimum of four LEDs. If
  *        a board contains less than four LEDs, the remaining LED masks are defined to 0 so as to have no effect.
@@ -68,6 +68,32 @@
  *        compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers)
  *        which contains only stub functions and defines no LEDs.
  *
+ *  \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 board LED driver before first use
+ *      LEDs_Init();
+ *
+ *      // Turn on each of the four LEDs in turn
+ *      LEDs_SetAllLEDs(LEDS_LED1); 
+ *      _delay_ms(500);
+ *      LEDs_SetAllLEDs(LEDS_LED1); 
+ *      _delay_ms(500);
+ *      LEDs_SetAllLEDs(LEDS_LED1); 
+ *      _delay_ms(500);
+ *      LEDs_SetAllLEDs(LEDS_LED1); 
+ *      _delay_ms(500);
+ *
+ *      // Turn on all LEDs
+ *      LEDs_SetAllLEDs(LEDS_ALL_LEDS);
+ *      _delay_ms(1000);
+ *
+ *      // Turn on LED 1, turn off LED 2, leaving LEDs 3 and 4 in their current state
+ *      LEDs_ChangeLEDs((LEDS_LED1 | LEDS_LED2), LEDS_LED1);
+ *  \endcode
+ *
  *  @{
  */
 
@@ -133,6 +159,10 @@
                #include "MAXIMUS/LEDs.h"
        #elif (BOARD == BOARD_MINIMUS)
                #include "MINIMUS/LEDs.h"
+       #elif (BOARD == BOARD_ADAFRUITU4)
+               #include "ADAFRUITU4/LEDs.h"
+       #elif (BOARD == BOARD_MICROSIN162)
+               #include "MICROSIN162/LEDs.h"
        #elif (BOARD == BOARD_USER)
                #include "Board/LEDs.h"
        #endif