From 28a1ee29a1a200c8e8c76355a9036a7456425bc3 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 20 Feb 2011 14:07:20 +0000 Subject: More Doxygen updates for multiple architecture support. --- LUFA/Drivers/Board/Buttons.h | 5 +++-- LUFA/Drivers/Board/Dataflash.h | 6 ++++-- LUFA/Drivers/Board/Joystick.h | 5 +++-- LUFA/Drivers/Board/LEDs.h | 3 ++- LUFA/Drivers/Board/Temperature.h | 3 ++- 5 files changed, 14 insertions(+), 8 deletions(-) (limited to 'LUFA/Drivers/Board') diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h index 686fe5ad9..624ce2436 100644 --- a/LUFA/Drivers/Board/Buttons.h +++ b/LUFA/Drivers/Board/Buttons.h @@ -29,10 +29,10 @@ */ /** \file - * \brief Master include file for the board digital button driver. + * \brief Digital button board hardware 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. + * physical pushbuttons connected to the microcontroller's GPIO pins. * * User code should include this file, which will in turn include the correct Button driver header file for the * currently selected board. @@ -45,6 +45,7 @@ /** \ingroup Group_BoardDrivers * \defgroup Group_Buttons Buttons Driver - LUFA/Drivers/Board/Buttons.h + * \brief Digital button board hardware driver. * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h index 06c1e62ac..0158e0200 100644 --- a/LUFA/Drivers/Board/Dataflash.h +++ b/LUFA/Drivers/Board/Dataflash.h @@ -30,9 +30,10 @@ /** \file * \brief Master include file for the board dataflash IC driver. + * \brief Atmel Dataflash storage IC board hardware 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. + * This file is the master dispatch header file for the board-specific Atmel dataflash driver, for boards containing + * Atmel Dataflash ICs for external non-volatile storage. * * User code should include this file, which will in turn include the correct dataflash driver header file for * the currently selected board. @@ -45,6 +46,7 @@ /** \ingroup Group_BoardDrivers * \defgroup Group_Dataflash Dataflash Driver - LUFA/Drivers/Board/Dataflash.h + * \brief Atmel Dataflash storage IC board hardware driver. * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h index a9448ffb7..21e5e922d 100644 --- a/LUFA/Drivers/Board/Joystick.h +++ b/LUFA/Drivers/Board/Joystick.h @@ -29,10 +29,10 @@ */ /** \file - * \brief Master include file for the board digital joystick driver. + * \brief Digital joystick board hardware driver. * * This file is the master dispatch header file for the board-specific Joystick driver, for boards containing a - * 5-way joystick. + * digital joystick. * * User code should include this file, which will in turn include the correct joystick driver header file for the * currently selected board. @@ -45,6 +45,7 @@ /** \ingroup Group_BoardDrivers * \defgroup Group_Joystick Joystick Driver - LUFA/Drivers/Board/Joystick.h + * \brief Digital joystick board hardware driver. * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h index 9ef2ea195..2a74de72e 100644 --- a/LUFA/Drivers/Board/LEDs.h +++ b/LUFA/Drivers/Board/LEDs.h @@ -29,7 +29,7 @@ */ /** \file - * \brief Master include file for the board LEDs driver. + * \brief LED board hardware driver. * * This file is the master dispatch header file for the board-specific LED driver, for boards containing user * controllable LEDs. @@ -45,6 +45,7 @@ /** \ingroup Group_BoardDrivers * \defgroup Group_LEDs LEDs Driver - LUFA/Drivers/Board/LEDs.h + * \brief LED board hardware driver. * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h index f7a2b6d87..e9f310e53 100644 --- a/LUFA/Drivers/Board/Temperature.h +++ b/LUFA/Drivers/Board/Temperature.h @@ -29,13 +29,14 @@ */ /** \file - * \brief Master include file for the board temperature sensor driver. + * \brief NTC Temperature Sensor board hardware driver. * * Master include file for the board temperature sensor driver, for the USB boards which contain a temperature sensor. */ /** \ingroup Group_BoardDrivers * \defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h + * \brief NTC Temperature Sensor board hardware driver. * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: -- cgit v1.2.3