aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/Board/Temperature.h
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/Temperature.h
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/Temperature.h')
-rw-r--r--LUFA/Drivers/Board/Temperature.h7
1 files changed, 5 insertions, 2 deletions
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);