aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2009-07-14 07:33:06 +0000
committerDean Camera <dean@fourwalledcubicle.com>2009-07-14 07:33:06 +0000
commit312748702a0f87f79c6e86745d3699d09a91778c (patch)
treeb7d4e9fb21e3903002a498ae8098c281d8e67cd9 /LUFA/Drivers
parente9215b4b3657938774b4979c5e02e4a95824aa43 (diff)
downloadlufa-312748702a0f87f79c6e86745d3699d09a91778c.tar.gz
lufa-312748702a0f87f79c6e86745d3699d09a91778c.tar.bz2
lufa-312748702a0f87f79c6e86745d3699d09a91778c.zip
Added better module summaries.
Diffstat (limited to 'LUFA/Drivers')
-rw-r--r--LUFA/Drivers/Board/Buttons.h4
-rw-r--r--LUFA/Drivers/Board/Dataflash.h3
-rw-r--r--LUFA/Drivers/Board/Joystick.h3
-rw-r--r--LUFA/Drivers/Board/LEDs.h3
-rw-r--r--LUFA/Drivers/Board/Temperature.h5
-rw-r--r--LUFA/Drivers/Peripheral/ADC.h4
-rw-r--r--LUFA/Drivers/Peripheral/SPI.h3
-rw-r--r--LUFA/Drivers/Peripheral/Serial.h3
-rw-r--r--LUFA/Drivers/USB/USB.h4
9 files changed, 23 insertions, 9 deletions
diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h
index 1ea3668cb..e1d234657 100644
--- a/LUFA/Drivers/Board/Buttons.h
+++ b/LUFA/Drivers/Board/Buttons.h
@@ -48,7 +48,9 @@
* - None
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the control of physical board GPIO buttons.
+ * Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards.
+ * It provides a way to easily configure and check the status of all the buttons on the board so that appropriate
+ * actions can be taken.
*
* If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
* directory. Otherwise, it will include the appropriate built in board driver header file.
diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h
index e58828c5b..acdcc4c40 100644
--- a/LUFA/Drivers/Board/Dataflash.h
+++ b/LUFA/Drivers/Board/Dataflash.h
@@ -48,7 +48,8 @@
* - None
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the control of board Dataflash ICs.
+ * Dataflash driver. This module provides an easy to use interface for the Dataflash ICs located on many boards,
+ * for the storage of large amounts of data into the Dataflash's non-volatile memory.
*
* If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
* directory. Otherwise, it will include the appropriate built in board driver header file.
diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h
index c7eb313b8..7699e90c5 100644
--- a/LUFA/Drivers/Board/Joystick.h
+++ b/LUFA/Drivers/Board/Joystick.h
@@ -48,7 +48,8 @@
* - None
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the control of board joystick.
+ * Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick
+ * located on many boards.
*
* If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
* directory. Otherwise, it will include the appropriate built in board driver header file.
diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h
index 969399994..cd2b857a4 100644
--- a/LUFA/Drivers/Board/LEDs.h
+++ b/LUFA/Drivers/Board/LEDs.h
@@ -48,7 +48,8 @@
* - None
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the control of board LEDs.
+ * Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It
+ * provides an interface to configure, test and change the status of all the board LEDs.
*
* If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
* directory. Otherwise, it will include the appropriate built in board driver header file.
diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h
index b5157e434..f4ecf71b7 100644
--- a/LUFA/Drivers/Board/Temperature.h
+++ b/LUFA/Drivers/Board/Temperature.h
@@ -41,7 +41,10 @@
* - LUFA/Drivers/Board/Temperature.c
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the control of board temperature sensors.
+ * Temperature sensor driver. This provides an easy to use interface for the hardware temperature sensor located
+ * on many boards. It provides an interface to configure the sensor and appropriate ADC channel, plus read out the
+ * current temperature in degrees C. It is designed for and will only work with the temperature sensor located on the
+ * official Atmel USB AVR boards, as each sensor has different characteristics.
*
* @{
*/
diff --git a/LUFA/Drivers/Peripheral/ADC.h b/LUFA/Drivers/Peripheral/ADC.h
index 381900acc..2be4c2ab9 100644
--- a/LUFA/Drivers/Peripheral/ADC.h
+++ b/LUFA/Drivers/Peripheral/ADC.h
@@ -44,7 +44,9 @@
* - None
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the setup of a the ADC subsystem.
+ * Hardware ADC driver. This module provides an easy to use driver for the hardware
+ * ADC present on many AVR models, for the conversion of analogue signals into the
+ * digital domain.
*/
#ifndef __ADC_H__
diff --git a/LUFA/Drivers/Peripheral/SPI.h b/LUFA/Drivers/Peripheral/SPI.h
index dc8661ad5..6048d86a6 100644
--- a/LUFA/Drivers/Peripheral/SPI.h
+++ b/LUFA/Drivers/Peripheral/SPI.h
@@ -41,7 +41,8 @@
* - None
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the setup of a the SPI port.
+ * Driver for the hardware SPI port avaliable on most AVR models. This module provides
+ * an easy to use driver for the setup of and transfer of data over the AVR's SPI port.
*
* @{
*/
diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h
index 82cbcfc2c..e688cfc02 100644
--- a/LUFA/Drivers/Peripheral/Serial.h
+++ b/LUFA/Drivers/Peripheral/Serial.h
@@ -41,7 +41,8 @@
* - LUFA/Drivers/Peripheral/Serial.c
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the setup of the USART for serial communications.
+ * Hardware serial USART driver. This module provides an easy to use driver for
+ * the setup of and transfer of data over the AVR's USART port.
*
* @{
*/
diff --git a/LUFA/Drivers/USB/USB.h b/LUFA/Drivers/USB/USB.h
index 9abd275cc..d38000d6d 100644
--- a/LUFA/Drivers/USB/USB.h
+++ b/LUFA/Drivers/USB/USB.h
@@ -51,7 +51,9 @@
* - LUFA/Drivers/USB/HighLevel/ConfigDescriptor.c
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the management of USB communications.
+ * Driver and framework for the USB controller hardware on the USB series of AVR microcontrollers. This module
+ * consists of many submodules, and is designed to provide an easy way to configure and control USB host, device
+ * or OTG mode USB applications.
*/
/** \ingroup Group_USB