Minor documentation updates.

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

diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h
index 91734db..e0267f6 100644 (file)
--- a/LUFA/Drivers/Board/LEDs.h
+++ b/LUFA/Drivers/Board/LEDs.h
@@ -47,11 +47,11 @@
  *  \defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h
  *  \brief LED board hardware driver.
  *
  *  \defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h
  *  \brief LED board hardware driver.
  *

- *  \section Sec_Dependencies Module Source Dependencies
+ *  \section Sec_LEDs_Dependencies Module Source Dependencies

  *  The following files must be built with any user project that uses this module:
  *    - None
  *
  *  The following files must be built with any user project that uses this module:
  *    - None
  *

- *  \section Sec_ModDescription Module Description
+ *  \section Sec_LEDs_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.
  *
  *  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.
  *


@@ -69,14 +69,14 @@
  *        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.
  *
  *        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
+ *  \section Sec_LEDs_ExampleUsage Example Usage

  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *
  *  \code
  *      // Initialize the board LED driver before first use
  *      LEDs_Init();
  *  The following snippet is an example of how this module may be used within a typical
  *  application.
  *
  *  \code
  *      // Initialize 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);
  *      // Turn on each of the four LEDs in turn
  *      LEDs_SetAllLEDs(LEDS_LED1);
  *      Delay_MS(500);


@@ -86,11 +86,11 @@
  *      Delay_MS(500);
  *      LEDs_SetAllLEDs(LEDS_LED4);
  *      Delay_MS(500);
  *      Delay_MS(500);
  *      LEDs_SetAllLEDs(LEDS_LED4);
  *      Delay_MS(500);

- *      
+ *

  *      // Turn on all LEDs
  *      LEDs_SetAllLEDs(LEDS_ALL_LEDS);
  *      Delay_MS(1000);
  *      // 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
  *      // 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


@@ -197,12 +197,26 @@
                        #include "AVR8/LEONARDO/LEDs.h"
                #elif (BOARD == BOARD_UC3A3_XPLAINED)
                        #include "UC3/UC3A3_XPLAINED/LEDs.h"
                        #include "AVR8/LEONARDO/LEDs.h"
                #elif (BOARD == BOARD_UC3A3_XPLAINED)
                        #include "UC3/UC3A3_XPLAINED/LEDs.h"

+               #elif (BOARD == BOARD_STANGE_ISP)
+                       #include "AVR8/STANGE_ISP/LEDs.h"
+               #elif (BOARD == BOARD_C3_XPLAINED)
+                       #include "XMEGA/C3_XPLAINED/LEDs.h"
+               #elif (BOARD == BOARD_U2S)
+                       #include "AVR8/U2S/LEDs.h"

                #else
                        #include "Board/LEDs.h"
                #endif
 
        /* Preprocessor Checks: */
                #if !defined(__DOXYGEN__)
                #else
                        #include "Board/LEDs.h"
                #endif
 
        /* Preprocessor Checks: */
                #if !defined(__DOXYGEN__)

+                       #if !defined(LEDS_NO_LEDS)
+                               #define LEDS_NO_LEDS   0
+                       #endif
+
+                       #if !defined(LEDS_ALL_LEDS)
+                               #define LEDS_ALL_LEDS  (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
+                       #endif
+

                        #if !defined(LEDS_LED1)
                                #define LEDS_LED1      0
                        #endif
                        #if !defined(LEDS_LED1)
                                #define LEDS_LED1      0
                        #endif