diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-28 13:39:08 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-28 13:39:08 +0000 |
| commit | f1076ac4d6e56bff7fb6d2126746af1108211370 (patch) | |
| tree | 9a5f31cc5ff9c648d7ce63f1d9e8afab763d2801 /LUFA/Drivers/Peripheral/Serial.h | |
| parent | 3cbdcd36868693cfc1863231a1ec64507ce3d29f (diff) | |
| download | lufa-f1076ac4d6e56bff7fb6d2126746af1108211370.tar.gz lufa-f1076ac4d6e56bff7fb6d2126746af1108211370.tar.bz2 lufa-f1076ac4d6e56bff7fb6d2126746af1108211370.zip | |
Added const modifiers to device mode class drivers.
Added parameter directions to function parameter documentation.
Added new experimental FAST_STREAM_FUNCTIONS compile time option to speed up stream transfers at the expense of a higher FLASH consumption (needs testing to verify improved throughput).
Diffstat (limited to 'LUFA/Drivers/Peripheral/Serial.h')
| -rw-r--r-- | LUFA/Drivers/Peripheral/Serial.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h index 7e718fe0c..82cbcfc2c 100644 --- a/LUFA/Drivers/Peripheral/Serial.h +++ b/LUFA/Drivers/Peripheral/Serial.h @@ -88,13 +88,13 @@ /* Function Prototypes: */
/** Transmits a given string located in program space (FLASH) through the USART.
*
- * \param FlashStringPtr Pointer to a string located in program space
+ * \param[in] FlashStringPtr Pointer to a string located in program space
*/
void Serial_TxString_P(const char *FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1);
/** Transmits a given string located in SRAM memory through the USART.
*
- * \param StringPtr Pointer to a string located in SRAM space
+ * \param[in] StringPtr Pointer to a string located in SRAM space
*/
void Serial_TxString(const char *StringPtr) ATTR_NON_NULL_PTR_ARG(1);
@@ -102,8 +102,8 @@ /** Initializes the USART, ready for serial data transmission and reception. This initialises the interface to
* standard 8-bit, no parity, 1 stop bit settings suitable for most applications.
*
- * \param BaudRate Serial baud rate, in bits per second
- * \param DoubleSpeed Enables double speed mode when set, halving the sample time to double the baud rate
+ * \param[in] BaudRate Serial baud rate, in bits per second
+ * \param[in] DoubleSpeed Enables double speed mode when set, halving the sample time to double the baud rate
*/
static inline void Serial_Init(const uint32_t BaudRate, const bool DoubleSpeed)
{
@@ -119,7 +119,7 @@ /** Transmits a given byte through the USART.
*
- * \param DataByte Byte to transmit through the USART
+ * \param[in] DataByte Byte to transmit through the USART
*/
static inline void Serial_TxByte(const char DataByte)
{
|