aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/Peripheral
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2010-12-26 14:55:26 +0000
committerDean Camera <dean@fourwalledcubicle.com>2010-12-26 14:55:26 +0000
commita8b66f318dda3cc18dfcedaa3af3d01ab68b82e8 (patch)
tree3f3e7d02bfebc4bab83983e96e84f5e04d044d02 /LUFA/Drivers/Peripheral
parent2073b96d82433607bd287e3b6529fd0d3cc428cd (diff)
downloadlufa-a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8.tar.gz
lufa-a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8.tar.bz2
lufa-a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8.zip
Documentation improvements - put driver example code into its own section, fix incorrect and missing section names.
Diffstat (limited to 'LUFA/Drivers/Peripheral')
-rw-r--r--LUFA/Drivers/Peripheral/ADC.h2
-rw-r--r--LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h5
-rw-r--r--LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h5
-rw-r--r--LUFA/Drivers/Peripheral/SPI.h7
-rw-r--r--LUFA/Drivers/Peripheral/Serial.h7
-rw-r--r--LUFA/Drivers/Peripheral/SerialStream.h7
-rw-r--r--LUFA/Drivers/Peripheral/TWI.h2
7 files changed, 25 insertions, 10 deletions
diff --git a/LUFA/Drivers/Peripheral/ADC.h b/LUFA/Drivers/Peripheral/ADC.h
index 0fba2d10e..79d2e89b1 100644
--- a/LUFA/Drivers/Peripheral/ADC.h
+++ b/LUFA/Drivers/Peripheral/ADC.h
@@ -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.
diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
index 3e736864c..8f3210a6c 100644
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
+++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h
@@ -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);
diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
index c6fb42009..634ecc986 100644
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
+++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
@@ -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();
diff --git a/LUFA/Drivers/Peripheral/SPI.h b/LUFA/Drivers/Peripheral/SPI.h
index ff45bc3ae..f22b6d99a 100644
--- a/LUFA/Drivers/Peripheral/SPI.h
+++ b/LUFA/Drivers/Peripheral/SPI.h
@@ -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 |
diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h
index f40201de5..549448d92 100644
--- a/LUFA/Drivers/Peripheral/Serial.h
+++ b/LUFA/Drivers/Peripheral/Serial.h
@@ -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);
diff --git a/LUFA/Drivers/Peripheral/SerialStream.h b/LUFA/Drivers/Peripheral/SerialStream.h
index bef52ac9e..3ea165066 100644
--- a/LUFA/Drivers/Peripheral/SerialStream.h
+++ b/LUFA/Drivers/Peripheral/SerialStream.h
@@ -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);
diff --git a/LUFA/Drivers/Peripheral/TWI.h b/LUFA/Drivers/Peripheral/TWI.h
index e8cc834c8..5c2223e41 100644
--- a/LUFA/Drivers/Peripheral/TWI.h
+++ b/LUFA/Drivers/Peripheral/TWI.h
@@ -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.
*