diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2015-03-15 19:51:15 +1100 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2015-03-15 19:51:15 +1100 |
| commit | be2df78637004801ea05902afe2b0e55da43ff47 (patch) | |
| tree | abc251b4a46890506b29083f3ed69963dc118088 /LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h | |
| parent | 4dbe0176ba4fb5be8cecd51e8e66b77462659bb9 (diff) | |
| download | lufa-be2df78637004801ea05902afe2b0e55da43ff47.tar.gz lufa-be2df78637004801ea05902afe2b0e55da43ff47.tar.bz2 lufa-be2df78637004801ea05902afe2b0e55da43ff47.zip | |
Minor documentation improvements.
Diffstat (limited to 'LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h')
| -rw-r--r-- | LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h index e8860a511..0d6e5be6d 100644 --- a/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h @@ -168,7 +168,8 @@ /** Initializes the USART, ready for serial data transmission and reception. This initializes the interface to * standard 8-bit, no parity, 1 stop bit settings suitable for most applications. * - * \param[in] BaudRate Serial baud rate, in bits per second. + * \param[in] BaudRate Serial baud rate, in bits per second. This should be the target baud rate regardless of the + * \c DoubleSpeed parameter's value. * \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, |