Documentation improvements - put driver example code into its own section, fix incorrect and missing section names.
This commit is contained in:
parent
2073b96d82
commit
a8b66f318d
109 changed files with 357 additions and 318 deletions
|
|
@ -44,7 +44,7 @@
|
|||
* The following files must be built with any user project that uses this module:
|
||||
* - None
|
||||
*
|
||||
* \section Module Description
|
||||
* \section Sec_ModDescription Module Description
|
||||
* 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.
|
||||
|
|
|
|||
|
|
@ -47,7 +47,10 @@
|
|||
* \note This file should not be included directly. It is automatically included as needed by the ADC driver
|
||||
* dispatch header located in LUFA/Drivers/Peripheral/ADC.h.
|
||||
*
|
||||
* <b>Example Usage:</b>
|
||||
* \section Sec_ExampleUsage Example Usage
|
||||
* The following snippet is an example of how this module may be used within a typical
|
||||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the ADC driver before first use
|
||||
* ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_32);
|
||||
|
|
|
|||
|
|
@ -45,7 +45,10 @@
|
|||
* \note This file should not be included directly. It is automatically included as needed by the TWI driver
|
||||
* dispatch header located in LUFA/Drivers/Peripheral/TWI.h.
|
||||
*
|
||||
* <b>Example Usage:</b>
|
||||
* \section Sec_ExampleUsage Example Usage
|
||||
* The following snippet is an example of how this module may be used within a typical
|
||||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the TWI driver before first use
|
||||
* TWI_Init();
|
||||
|
|
|
|||
|
|
@ -41,11 +41,14 @@
|
|||
* The following files must be built with any user project that uses this module:
|
||||
* - None
|
||||
*
|
||||
* \section Module Description
|
||||
* \section Sec_ModDescription Module Description
|
||||
* Driver for the hardware SPI port available 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.
|
||||
*
|
||||
* <b>Example Usage:</b>
|
||||
* \section Sec_ExampleUsage Example Usage
|
||||
* The following snippet is an example of how this module may be used within a typical
|
||||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the SPI driver before first use
|
||||
* SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |
|
||||
|
|
|
|||
|
|
@ -41,11 +41,14 @@
|
|||
* The following files must be built with any user project that uses this module:
|
||||
* - LUFA/Drivers/Peripheral/Serial.c <i>(Makefile source module name: LUFA_SRC_SERIAL)</i>
|
||||
*
|
||||
* \section Module Description
|
||||
* \section Sec_ModDescription Module Description
|
||||
* 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.
|
||||
*
|
||||
* <b>Example Usage:</b>
|
||||
* \section Sec_ExampleUsage Example Usage
|
||||
* The following snippet is an example of how this module may be used within a typical
|
||||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the serial USART driver before first use, with 9600 baud (and no double-speed mode)
|
||||
* Serial_Init(9600, false);
|
||||
|
|
|
|||
|
|
@ -44,13 +44,16 @@
|
|||
* The following files must be built with any user project that uses this module:
|
||||
* - LUFA/Drivers/Peripheral/SerialStream.c <i>(Makefile source module name: LUFA_SRC_SERIALSTREAM)</i>
|
||||
*
|
||||
* \section Module Description
|
||||
* \section Sec_ModDescription Module Description
|
||||
* Serial stream driver for the USART subsystem on supported USB AVRs. This makes use of the functions in the
|
||||
* regular USART driver (see \ref Group_Serial), but allows the avr-libc standard stream functions (printf,
|
||||
* puts, etc.) to work with the USART. Upon configuration, this will redirect the standard input and output
|
||||
* streams to the USART.
|
||||
*
|
||||
* <b>Example Usage:</b>
|
||||
* \section Sec_ExampleUsage Example Usage
|
||||
* The following snippet is an example of how this module may be used within a typical
|
||||
* application.
|
||||
*
|
||||
* \code
|
||||
* // Initialise the Serial Stream driver before first use, with 9600 baud (and no double-speed mode)
|
||||
* SerialStream_Init(9600, false);
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@
|
|||
* - LUFA/Drivers/Peripheral/TWI.c <i>(Makefile source module name: LUFA_SRC_TWI)</i>
|
||||
*
|
||||
*
|
||||
* \section Module Description
|
||||
* \section Sec_ModDescription Module Description
|
||||
* Master Mode Hardware TWI driver. This module provides an easy to use driver for the hardware
|
||||
* TWI present on many AVR models, for the transmission and reception of data on a TWI bus.
|
||||
*
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue