From 9cec85bfd92a77a97e7d12625897de2682dfacd7 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Wed, 22 Apr 2009 14:28:55 +0000 Subject: Documentation enhancements to improve documentation cross-references. --- LUFA/Drivers/Board/Dataflash.h | 2 +- LUFA/Drivers/Board/Temperature.h | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'LUFA/Drivers/Board') diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h index 01ee88930..20300930e 100644 --- a/LUFA/Drivers/Board/Dataflash.h +++ b/LUFA/Drivers/Board/Dataflash.h @@ -79,7 +79,7 @@ #if defined(__DOXYGEN__) /** Determines the currently selected dataflash chip. * - * \return Mask of the currently selected Dataflash chip, either DATAFLASH_NO_CHIP if no chip is selected + * \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected * or a DATAFLASH_CHIPn mask (where n is the chip number). */ static inline uint8_t Dataflash_GetSelectedChip(void); diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h index 56e579076..30c311f83 100644 --- a/LUFA/Drivers/Board/Temperature.h +++ b/LUFA/Drivers/Board/Temperature.h @@ -76,10 +76,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 +97,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 */ -- cgit v1.2.3