From deed746d3716d59153e04860c646bfb7b82ca820 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Thu, 17 Jun 2010 08:15:58 +0000 Subject: Renamed SERIAL_STREAM_ASSERT() macro to STDOUT_ASSERT(). Minor tweaks to the library documentation. --- LUFA/Drivers/Board/Buttons.h | 2 +- LUFA/Drivers/Board/Dataflash.h | 4 ++-- LUFA/Drivers/Board/Joystick.h | 2 +- LUFA/Drivers/Board/LEDs.h | 14 +++++++------- LUFA/Drivers/Board/Temperature.h | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) (limited to 'LUFA/Drivers/Board') diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h index ec25f5fd6..11c31910a 100644 --- a/LUFA/Drivers/Board/Buttons.h +++ b/LUFA/Drivers/Board/Buttons.h @@ -108,7 +108,7 @@ /** Returns a mask indicating which board buttons are currently pressed. * - * \return Mask indicating which board buttons are currently pressed + * \return Mask indicating which board buttons are currently pressed. */ static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT; #endif diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h index 5281a1936..eb0bebd8c 100644 --- a/LUFA/Drivers/Board/Dataflash.h +++ b/LUFA/Drivers/Board/Dataflash.h @@ -218,8 +218,8 @@ /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with * dataflash commands which require a complete 24-byte address. * - * \param[in] PageAddress Page address within the selected dataflash IC - * \param[in] BufferByte Address within the dataflash's buffer + * \param[in] PageAddress Page address within the selected dataflash IC. + * \param[in] BufferByte Address within the dataflash's buffer. */ static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte); diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h index cbbaf0ea5..2953b72af 100644 --- a/LUFA/Drivers/Board/Joystick.h +++ b/LUFA/Drivers/Board/Joystick.h @@ -99,7 +99,7 @@ * currently facing in (multiple bits can be set). * * \return Mask indicating the joystick direction - see corresponding board specific Joystick.h file - * for direction masks + * for direction masks. */ static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT; #endif diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h index 85eced9f1..0aebbde5c 100644 --- a/LUFA/Drivers/Board/LEDs.h +++ b/LUFA/Drivers/Board/LEDs.h @@ -140,41 +140,41 @@ /** Turns on the LEDs specified in the given LED mask. * - * \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file) + * \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file). */ static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask); /** Turns off the LEDs specified in the given LED mask. * - * \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file) + * \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file). */ static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask); /** Turns off all LEDs not specified in the given LED mask, and turns on all the LEDs in the given LED * mask. * - * \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file) + * \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file). */ static inline void LEDs_SetAllLEDs(const uint8_t LEDMask); /** Turns off all LEDs in the LED mask that are not set in the active mask, and turns on all the LEDs * specified in both the LED and active masks. * - * \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file) - * \param[in] ActiveMask Mask of whether the LEDs in the LED mask should be turned on or off + * \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file). + * \param[in] ActiveMask Mask of whether the LEDs in the LED mask should be turned on or off. */ static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask); /** Toggles all LEDs in the LED mask, leaving all others in their current states. * - * \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file) + * \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file). */ static inline void LEDs_ToggleLEDs(const uint8_t LEDMask); /** Returns the status of all the board LEDs; set LED masks in the return value indicate that the * corresponding LED is on. * - * \return Mask of the board LEDs which are currently turned on + * \return Mask of the board LEDs which are currently turned on. */ static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT; #endif diff --git a/LUFA/Drivers/Board/Temperature.h b/LUFA/Drivers/Board/Temperature.h index 561f651c2..98bd23498 100644 --- a/LUFA/Drivers/Board/Temperature.h +++ b/LUFA/Drivers/Board/Temperature.h @@ -103,7 +103,7 @@ /** Performs a complete ADC on the temperature sensor channel, and converts the result into a * valid temperature between \ref TEMP_MIN_TEMP and \ref TEMP_MAX_TEMP in degrees Celsius. * - * \return Signed temperature in degrees Celsius + * \return Signed temperature value in degrees Celsius. */ int8_t Temperature_GetTemperature(void) ATTR_WARN_UNUSED_RESULT; -- cgit v1.2.3