Minor documentation improvements.
[pub/USBasp.git] / LUFA / Drivers / Board / AVR8 / XPLAIN / LEDs.h
index d00bbb6..9381548 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2012.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -29,7 +29,7 @@
 */
 
 /** \file
 */
 
 /** \file
- *  \brief Board specific LED driver header for the Atmel XPLAIN.
+ *  \brief Board specific LED driver header for the original Atmel XPLAIN.
  *  \copydetails Group_LEDs_XPLAIN
  *
  *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
  *  \copydetails Group_LEDs_XPLAIN
  *
  *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
  */
 
 /** \ingroup Group_LEDs
  */
 
 /** \ingroup Group_LEDs
+ *  \defgroup Group_LEDs_XPLAIN_REV1 XPLAIN_REV1
+ *  \brief Board specific LED driver header for the original Atmel XPLAIN, revision 1.
+ *
+ *  See \ref Group_LEDs_XPLAIN for more details.
+ */
+
+/** \ingroup Group_LEDs
  *  \defgroup Group_LEDs_XPLAIN XPLAIN
  *  \defgroup Group_LEDs_XPLAIN XPLAIN
- *  \brief Board specific LED driver header for the Atmel XPLAIN.
+ *  \brief Board specific LED driver header for the original Atmel XPLAIN.
  *
  *  Board specific LED driver header for the Atmel XPLAIN.
  *
  *
  *  Board specific LED driver header for the Atmel XPLAIN.
  *
                                PORTB |= LEDS_ALL_LEDS;
                        }
 
                                PORTB |= LEDS_ALL_LEDS;
                        }
 
+                       static inline void LEDs_Disable(void)
+                       {
+                               DDRB  &= ~LEDS_ALL_LEDS;
+                               PORTB &= ~LEDS_ALL_LEDS;
+                       }
+
                        static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
                        {
                                PORTB &= ~LEDMask;
                        static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
                        {
                                PORTB &= ~LEDMask;