X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/663f449c10b9a77a429aaa81066ce2b43ca6dc39..f9f1bcc25c17b031029200cd9648d76d4ee39dc4:/LUFA/Drivers/Board/Temperature.h

diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h
index 56e579076..f4ecf71b7 100644
--- a/LUFA/Drivers/Board/Temperature.h
+++ b/LUFA/Drivers/Board/Temperature.h
@@ -41,7 +41,10 @@
  *    - LUFA/Drivers/Board/Temperature.c
  *
  *  \section Module Description
- *  Functions, macros, variables, enums and types related to the control of board temperature sensors.
+ *  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.
  *
  *  @{
  */
@@ -61,8 +64,8 @@
 		#include "../Peripheral/ADC.h"
 	
 		#if !defined(BOARD)
-			#error #error BOARD must be set in makefile to a value specified in BoardTypes.h.	
-		#elif (BOARD != BOARD_USBKEY) && (BOARD != BOARD_STK525) && (BOARD != BOARD_STK526)
+			#error BOARD must be set in makefile to a value specified in BoardTypes.h.	
+		#elif (BOARD != BOARD_USBKEY) && (BOARD != BOARD_STK525) && (BOARD != BOARD_STK526) && (BOARD != BOARD_USER)
 			#error The selected board does not contain a temperature sensor.
 		#endif
 
@@ -76,10 +79,10 @@
 			/** ADC channel number for the temperature sensor. */
 			#define TEMP_ADC_CHANNEL   0
 			
-			/** Minimum returnable temperature from the Temperature_GetTemperature() function. */
+			/** Minimum returnable temperature from the \ref Temperature_GetTemperature() function. */
 			#define TEMP_MIN_TEMP      TEMP_TABLE_OFFSET
 
-			/** Maximum returnable temperature from the Temperature_GetTemperature() function. */
+			/** Maximum returnable temperature from the \ref Temperature_GetTemperature() function. */
 			#define TEMP_MAX_TEMP      ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET)
 		
 		/* Pseudo-Function Macros: */
@@ -97,7 +100,7 @@
 
 		/* Function Prototypes: */
 			/** Performs a complete ADC on the temperature sensor channel, and converts the result into a
-			 *  valid temperature between TEMP_MIN_TEMP and TEMP_MAX_TEMP in degrees Celsius.
+			 *  valid temperature between \ref TEMP_MIN_TEMP and \ref TEMP_MAX_TEMP in degrees Celsius.
 			 *
 			 *  \return Signed temperature in degrees Celsius
 			 */