aboutsummaryrefslogtreecommitdiff
path: root/LUFA/Drivers/Peripheral/SPI.h
diff options
context:
space:
mode:
authorDean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28>2010-12-26 14:55:26 +0000
committerDean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28>2010-12-26 14:55:26 +0000
commit1c6e8e42c1cbaa5992d985b702a3669d97d34806 (patch)
tree3f3e7d02bfebc4bab83983e96e84f5e04d044d02 /LUFA/Drivers/Peripheral/SPI.h
parentbeda2c5f54a97c4e76c648120d2212705189a906 (diff)
Documentation improvements - put driver example code into its own section, fix incorrect and missing section names.
git-svn-id: http://lufa-lib.googlecode.com/svn/trunk@1616 d5102386-fcda-11dd-9fdb-3debd5008f28
Diffstat (limited to 'LUFA/Drivers/Peripheral/SPI.h')
-rw-r--r--LUFA/Drivers/Peripheral/SPI.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/LUFA/Drivers/Peripheral/SPI.h b/LUFA/Drivers/Peripheral/SPI.h
index ff45bc3a..f22b6d99 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 |