ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added better module summaries.

Browse source
This commit is contained in:
Dean Camera 2009-07-14 07:33:06 +00:00
parent e9215b4b36
commit 312748702a
16 changed files with 37 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

4
LUFA/Drivers/Board/Buttons.h
View file

@ -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.

3
LUFA/Drivers/Board/Dataflash.h
View file

@ -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.

3
LUFA/Drivers/Board/Joystick.h
View file

@ -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.

3
LUFA/Drivers/Board/LEDs.h
View file

@ -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.

5
LUFA/Drivers/Board/Temperature.h
View file

@ -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.
*
* @{
*/

4
LUFA/Drivers/Peripheral/ADC.h
View file

@ -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__

3
LUFA/Drivers/Peripheral/SPI.h
View file

@ -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.
*
* @{
*/

3
LUFA/Drivers/Peripheral/Serial.h
View file

@ -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.
*
* @{
*/

4
LUFA/Drivers/USB/USB.h
View file

@ -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