Add file-level brief documentation.

Remove accidentally duplicated model-specific peripheral driver files.
This commit is contained in:
Dean Camera
2010-03-29 07:49:58 +00:00
parent ec19436d54
commit 0557676013
111 changed files with 1039 additions and 453 deletions

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Buttons driver header for the ATAVRUSBRF01.
* \brief Board specific Buttons driver header for the ATAVRUSBRF01.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific LED driver header for the ATAVRUSBRF01.
* \brief Board specific LED driver header for the ATAVRUSBRF01.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.

View File

@@ -29,9 +29,10 @@
*/
/** \file
* \brief Board specific Buttons driver header for the BUMBLEB.
*
* Board specific Buttons driver header for the BUMBLEB. The BUMBLEB third-party board does not include any on-board
* peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.
* The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended
* external peripheral layout for buttons, LEDs and a Joystick.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.

View File

@@ -29,9 +29,10 @@
*/
/** \file
* \brief Board specific joystick driver header for the BUMLEB.
*
* Board specific joystick driver header for the USBKEY. The BUMBLEB third-party board does not include any on-board
* peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.
* The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended
* external peripheral layout for buttons, LEDs and a Joystick.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.
@@ -40,7 +41,7 @@
/** \ingroup Group_Joystick
* @defgroup Group_Joystick_BUMBLEB BUMBLEB
*
* Board specific joystick driver header for the USBKEY. The BUMBLEB third-party board does not include any on-board
* Board specific joystick driver header for the BUMBLEB. The BUMBLEB third-party board does not include any on-board
* peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver

View File

@@ -29,9 +29,10 @@
*/
/** \file
* \brief Board specific LED driver header for the BUMBLEB.
*
* Board specific LED driver header for the BUMBLEB. The BUMBLEB third-party board does not include any on-board
* peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.
* The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended
* external peripheral layout for buttons, LEDs and a Joystick.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.

View File

@@ -29,6 +29,7 @@
*/
/** \file
* \brief Master include file for the board digital button driver.
*
* This file is the master dispatch header file for the board-specific Buttons driver, for boards containing
* physical pushbuttons connected to the AVR's GPIO pins.

View File

@@ -29,6 +29,7 @@
*/
/** \file
* \brief Master include file for the board dataflash IC driver.
*
* This file is the master dispatch header file for the board-specific dataflash driver, for boards containing
* dataflash ICs for external non-volatile storage.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Dataflash commands header for the AT45DB321C as mounted on the EVK527.
* \brief Board specific Dataflash commands header for the AT45DB321C as mounted on the EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Buttons driver header for the EVK527.
* \brief Board specific Buttons driver header for the EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Dataflash driver header for the EVK527.
* \brief Board specific Dataflash driver header for the EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific joystick driver header for the EVK527.
* \brief Board specific joystick driver header for the EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific LED driver header for the EVK527.
* \brief Board specific LED driver header for the EVK527.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.

View File

@@ -29,6 +29,7 @@
*/
/** \file
* \brief Master include file for the board digital joystick driver.
*
* This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a
* 5-way joystick.

View File

@@ -29,6 +29,7 @@
*/
/** \file
* \brief Master include file for the board LEDs driver.
*
* This file is the master dispatch header file for the board-specific LED driver, for boards containing user
* controllable LEDs.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific LED driver header for the RZUSBSTICK.
* \brief Board specific LED driver header for the RZUSBSTICK.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Dataflash commands header for the AT45DB321C as mounted on the STK525.
* \brief Board specific Dataflash commands header for the AT45DB321C as mounted on the STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Buttons driver header for the STK525.
* \brief Board specific Buttons driver header for the STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Dataflash driver header for the STK525.
* \brief Board specific Dataflash driver header for the STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific joystick driver header for the STK525.
* \brief Board specific joystick driver header for the STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific LED driver header for the STK525.
* \brief Board specific LED driver header for the STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Dataflash commands header for the AT45DB642D as mounted on the STK526.
* \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the STK526.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Buttons driver header for the STK526.
* \brief Board specific Buttons driver header for the STK526.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Dataflash driver header for the STK525.
* \brief Board specific Dataflash driver header for the STK525.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific joystick driver header for the STK526.
* \brief Board specific joystick driver header for the STK526.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific LED driver header for the STK526.
* \brief Board specific LED driver header for the STK526.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific LED driver header for the PJRC Teensy series boards.
* \brief Board specific LED driver header for the PJRC Teensy boards.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.

View File

@@ -29,6 +29,7 @@
*/
/** \file
* \brief Master include file for the board temperature sensor driver.
*
* Temperature sensor board driver for the USB boards which contain a temperature sensor.
*/

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Dataflash commands header for the AT45DB642D as mounted on the USBKEY.
* \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the USBKEY.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Buttons driver header for the USBKEY.
* \brief Board specific Buttons driver header for the USBKEY.
*
* \note This file should not be included directly. It is automatically included as needed by the Buttons driver
* dispatch header located in LUFA/Drivers/Board/Buttons.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Dataflash driver header for the USBKEY.
* \brief Board specific Dataflash driver header for the USBKEY.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific joystick driver header for the USBKEY.
* \brief Board specific joystick driver header for the USBKEY.
*
* \note This file should not be included directly. It is automatically included as needed by the joystick driver
* dispatch header located in LUFA/Drivers/Board/Joystick.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific LED driver header for the USBKEY.
* \brief Board specific LED driver header for the USBKEY.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Dataflash commands header for the AT45DB642D as mounted on the XPLAIN.
* \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the XPLAIN.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific Dataflash driver header for the XPLAIN.
* \brief Board specific Dataflash driver header for the XPLAIN.
*
* \note This file should not be included directly. It is automatically included as needed by the dataflash driver
* dispatch header located in LUFA/Drivers/Board/Dataflash.h.

View File

@@ -29,8 +29,7 @@
*/
/** \file
*
* Board specific LED driver header for the XPLAIN.
* \brief Board specific LED driver header for the XPLAIN.
*
* \note This file should not be included directly. It is automatically included as needed by the LEDs driver
* dispatch header located in LUFA/Drivers/Board/LEDs.h.