Add briefs for the library core structures.

This commit is contained in:
Dean Camera 2010-03-29 13:32:36 +00:00
parent 0557676013
commit 9257f4ab8e
73 changed files with 382 additions and 87 deletions

View file

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Buttons driver header for the ATAVRUSBRF01.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific LED driver header for the ATAVRUSBRF01.
*
* 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

@ -31,6 +31,8 @@
/** \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.
*

View file

@ -31,6 +31,8 @@
/** \file
* \brief Board specific joystick driver header for the BUMLEB.
*
* Board specific joystick driver header for the BUMLEB.
*
* 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.
*

View file

@ -31,6 +31,8 @@
/** \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.
*

View file

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash commands header for the AT45DB321C as mounted on the EVK527.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Buttons driver header for the EVK527.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash driver header for the EVK527.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific joystick driver header for the EVK527.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific LED driver header for the EVK527.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific LED driver header for the RZUSBSTICK.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash commands header for the AT45DB321C as mounted on the STK525.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Buttons driver header for the STK525.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash driver header for the STK525.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific joystick driver header for the STK525.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific LED driver header for the STK525.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the STK526.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Buttons driver header for the STK526.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash driver header for the STK525.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific joystick driver header for the STK526.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific LED driver header for the STK526.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific LED driver header for the PJRC Teensy boards.
*
* 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

@ -31,7 +31,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.
* Master include file for the board temperature sensor driver, for the USB boards which contain a temperature sensor.
*/
/** \ingroup Group_BoardDrivers

View file

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the USBKEY.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Buttons driver header for the USBKEY.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash driver header for the USBKEY.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific joystick driver header for the USBKEY.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific LED driver header for the USBKEY.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash commands header for the AT45DB642D as mounted on the XPLAIN.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific Dataflash driver header for the XPLAIN.
*
* 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

@ -31,6 +31,8 @@
/** \file
* \brief Board specific LED driver header for the XPLAIN.
*
* 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.
*/