Minor documentation improvements.
[pub/lufa.git] / LUFA / Drivers / Board / Temperature.h
index f7a2b6d..8b38442 100644 (file)
 */
 
 /** \file
- *  \brief Master include file for the board temperature sensor driver.
+ *  \brief NTC Temperature Sensor board hardware driver.
  *
  *  Master include file for the board temperature sensor driver, for the USB boards which contain a temperature sensor.
  */
 
 /** \ingroup Group_BoardDrivers
  *  \defgroup Group_Temperature Temperature Sensor Driver - LUFA/Drivers/Board/Temperature.h
+ *  \brief NTC Temperature Sensor board hardware driver.
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *  application.
  *
  *  \code
- *      // Initialise the ADC and board temperature sensor drivers before first use
+ *      // Initialize the ADC and board temperature sensor drivers before first use
  *      ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);
  *      Temperature_Init();
  *
  *      // Display converted temperature in degrees Celsius
  *      printf("Current Temperature: %d Degrees\r\n", Temperature_GetTemperature());
  *  \endcode
- * 
+ *
  *  @{
  */
 
@@ -90,7 +91,7 @@
 
                        /** ADC channel MUX mask for the temperature sensor. */
                        #define TEMP_ADC_CHANNEL_MASK  ADC_CHANNEL0
-                       
+
                        /** Size of the temperature sensor lookup table, in lookup values */
                        #define TEMP_TABLE_SIZE        120
 
                        #define TEMP_MAX_TEMP          ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET_DEGREES)
 
                /* Inline Functions: */
-                       /** Initialises the temperature sensor driver, including setting up the appropriate ADC channel.
+                       /** Initializes the temperature sensor driver, including setting up the appropriate ADC channel.
                         *  This must be called before any other temperature sensor routines.
                         *
                         *  \pre The ADC itself (not the ADC channel) must be configured separately before calling the