X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/ef06bfd1c0ef5272c32808e23d0fd60d2d1bca9c..8f6b4ddf764c3a54e42d00a7502c82c5c3e71b1c:/LUFA/Drivers/Board/Temperature.h diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h index 17b8acfe1..6e1827edd 100644 --- a/LUFA/Drivers/Board/Temperature.h +++ b/LUFA/Drivers/Board/Temperature.h @@ -33,6 +33,14 @@ * Temperature sensor board driver for the USB boards which contain a temperature sensor. */ +/** \ingroup Group_BoardDrivers + * @defgroup Group_Temperature Temperature Driver - LUFA/Drivers/Board/Temperature.h + * + * Functions, macros, variables, enums and types related to the control of board temperature sensors. + * + * @{ + */ + #ifndef __TEMPERATURE_H__ #define __TEMPERATURE_H__ @@ -68,14 +76,19 @@ /** Maximum returnable temperature from the Temperature_GetTemperature() function. */ #define TEMP_MAX_TEMP ((TEMP_TABLE_SIZE - 1) + TEMP_TABLE_OFFSET) - - /** Initializes the temperature sensor driver, including setting up the appropriate ADC channel. - * This must be called before any other temperature sensor routines. - * - * The ADC itself (not the ADC channel) must be configured separately before calling the temperature - * sensor functions. - */ - #define Temperature_Init() ADC_SetupChannel(TEMP_ADC_CHANNEL); + + /* Psuedo-Functions: */ + #if defined(__DOXYGEN__) + /** Initializes the temperature sensor driver, including setting up the appropriate ADC channel. + * This must be called before any other temperature sensor routines. + * + * The ADC itself (not the ADC channel) must be configured separately before calling the temperature + * sensor functions. + */ + static inline void Temperature_Init(void); + #else + #define Temperature_Init() ADC_SetupChannel(TEMP_ADC_CHANNEL); + #endif /* Function Prototypes: */ /** Performs a complete ADC on the temperature sensor channel, and converts the result into a @@ -98,3 +111,5 @@ #endif #endif + +/** @} */