Fix warning when not compiled for UID auto-selection mode.

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

diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h
index f34041e..63c997b 100644 (file)
--- a/LUFA/Drivers/Board/LEDs.h
+++ b/LUFA/Drivers/Board/LEDs.h
@@ -39,6 +39,8 @@
  *
  *  If the BOARD value is set to BOARD_USER, this will include the /Board/LEDs.h file in the user project
  *  directory.
  *
  *  If the BOARD value is set to BOARD_USER, this will include the /Board/LEDs.h file in the user project
  *  directory.

+ *
+ *  For possible BOARD makefile values, see \ref Group_BoardTypes.

  */
 
 /** \ingroup Group_BoardDrivers
  */
 
 /** \ingroup Group_BoardDrivers


@@ -56,6 +58,8 @@
  *  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.
  *
  *  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.
  *

+ *  For possible 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.
  *        If other behaviour is desired, either alias the remaining LED masks to existing LED masks via the -D 
  *  \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.
  *        If other behaviour is desired, either alias the remaining LED masks to existing LED masks via the -D 


@@ -111,6 +115,14 @@
                #include "BENITO/LEDs.h"
        #elif (BOARD == BOARD_JMDBU2)
                #include "JMDBU2/LEDs.h"
                #include "BENITO/LEDs.h"
        #elif (BOARD == BOARD_JMDBU2)
                #include "JMDBU2/LEDs.h"

+       #elif (BOARD == BOARD_OLIMEX162)
+               #include "OLIMEX162/LEDs.h"
+       #elif (BOARD == BOARD_USBFOO)
+               #include "USBFOO/LEDs.h"
+       #elif (BOARD == BOARD_UDIP)
+               #include "UDIP/LEDs.h"          
+       #elif (BOARD == BOARD_BUI)
+               #include "BUI/LEDs.h"           

        #elif (BOARD == BOARD_USER)
                #include "Board/LEDs.h"
        #endif
        #elif (BOARD == BOARD_USER)
                #include "Board/LEDs.h"
        #endif


@@ -133,48 +145,49 @@
        
        /* Pseudo-Functions for Doxygen: */
        #if defined(__DOXYGEN__)
        
        /* Pseudo-Functions for Doxygen: */
        #if defined(__DOXYGEN__)

-               /** Initializes the board LED driver so that the LEDs can be controlled. This sets the appropriate port
+               /** Initialises the board LED driver so that the LEDs can be controlled. This sets the appropriate port

                 *  I/O pins as outputs, and sets the LEDs to default to off.
                 */
                static inline void LEDs_Init(void);
 
                /** Turns on the LEDs specified in the given LED mask.
                 *
                 *  I/O pins as outputs, and sets the LEDs to default to off.
                 */
                static inline void LEDs_Init(void);
 
                /** Turns on the LEDs specified in the given LED mask.
                 *

-                *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)
+                *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).

                 */
                static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask);
 
                /** Turns off the LEDs specified in the given LED mask.
                 *
                 */
                static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask);
 
                /** Turns off the LEDs specified in the given LED mask.
                 *

-                *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)
+                *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).

                 */
                static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask);
 
                /** Turns off all LEDs not specified in the given LED mask, and turns on all the LEDs in the given LED
                 *  mask.
                 *
                 */
                static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask);
 
                /** Turns off all LEDs not specified in the given LED mask, and turns on all the LEDs in the given LED
                 *  mask.
                 *

-                *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)
+                *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).

                 */
                static inline void LEDs_SetAllLEDs(const uint8_t LEDMask);
 
                /** Turns off all LEDs in the LED mask that are not set in the active mask, and turns on all the LEDs
                 *  specified in both the LED and active masks.
                 *
                 */
                static inline void LEDs_SetAllLEDs(const uint8_t LEDMask);
 
                /** Turns off all LEDs in the LED mask that are not set in the active mask, and turns on all the LEDs
                 *  specified in both the LED and active masks.
                 *

-                *  \param[in] LEDMask     Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)
-                *  \param[in] ActiveMask  Mask of whether the LEDs in the LED mask should be turned on or off
+                *  \param[in] LEDMask     Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).
+                *  \param[in] ActiveMask  Mask of whether the LEDs in the LED mask should be turned on or off.

                 */
                 */

-               static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask);
+               static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
+                                                  const uint8_t ActiveMask);

                
                /** Toggles all LEDs in the LED mask, leaving all others in their current states.
                 *
                
                /** Toggles all LEDs in the LED mask, leaving all others in their current states.
                 *

-                *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)
+                *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file).

                 */
                static inline void LEDs_ToggleLEDs(const uint8_t LEDMask);
 
                /** Returns the status of all the board LEDs; set LED masks in the return value indicate that the
                 *  corresponding LED is on.
                 *
                 */
                static inline void LEDs_ToggleLEDs(const uint8_t LEDMask);
 
                /** Returns the status of all the board LEDs; set LED masks in the return value indicate that the
                 *  corresponding LED is on.
                 *

-                *  \return Mask of the board LEDs which are currently turned on
+                *  \return Mask of the board LEDs which are currently turned on.

                 */
                static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
        #endif
                 */
                static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
        #endif