aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/Board
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/Board
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/Board')
-rw-r--r--LUFA/Drivers/Board/Buttons.h7
-rw-r--r--LUFA/Drivers/Board/Dataflash.h7
-rw-r--r--LUFA/Drivers/Board/Joystick.h7
-rw-r--r--LUFA/Drivers/Board/LEDs.h7
-rw-r--r--LUFA/Drivers/Board/Temperature.h7
5 files changed, 25 insertions, 10 deletions
diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h
index e112683a8..27a2f3c22 100644
--- a/LUFA/Drivers/Board/Buttons.h
+++ b/LUFA/Drivers/Board/Buttons.h
@@ -50,7 +50,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 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.
@@ -60,7 +60,10 @@
*
* For possible BOARD makefile values, see \ref Group_BoardTypes.
*
- * <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 button driver before first use
* Buttons_Init();
diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h
index d443c8f5a..45654c000 100644
--- a/LUFA/Drivers/Board/Dataflash.h
+++ b/LUFA/Drivers/Board/Dataflash.h
@@ -50,7 +50,7 @@
* The following files must be built with any user project that uses this module:
* - None
*
- * \section Module Description
+ * \section Sec_ModDescription Module Description
* 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.
*
@@ -59,7 +59,10 @@
*
* For possible BOARD makefile values, see \ref Group_BoardTypes.
*
- * <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 and board Dataflash drivers before first use
* SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |
diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h
index f3c5c9d26..81be0ea3f 100644
--- a/LUFA/Drivers/Board/Joystick.h
+++ b/LUFA/Drivers/Board/Joystick.h
@@ -50,7 +50,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 Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick
* located on many boards.
*
@@ -59,7 +59,10 @@
*
* For possible BOARD makefile values, see \ref Group_BoardTypes.
*
- * <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 board Joystick driver before first use
* Joystick_Init();
diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h
index b05d55cf8..8cd3037a3 100644
--- a/LUFA/Drivers/Board/LEDs.h
+++ b/LUFA/Drivers/Board/LEDs.h
@@ -50,7 +50,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 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.
*
@@ -68,7 +68,10 @@
* compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers)
* which contains only stub functions and defines no LEDs.
*
- * <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 board LED driver before first use
* LEDs_Init();
diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h
index c8b36f586..fa86ccd24 100644
--- a/LUFA/Drivers/Board/Temperature.h
+++ b/LUFA/Drivers/Board/Temperature.h
@@ -41,13 +41,16 @@
* The following files must be built with any user project that uses this module:
* - LUFA/Drivers/Board/Temperature.c <i>(Makefile source module name: LUFA_SRC_TEMPERATURE)</i>
*
- * \section Module Description
+ * \section Sec_ModDescription Module Description
* 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.
*
- * <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 and board temperature sensor drivers before first use
* ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);