Minor documentation improvements.
authorDean Camera <dean@fourwalledcubicle.com>
Sun, 15 Mar 2015 08:51:15 +0000 (19:51 +1100)
committerDean Camera <dean@fourwalledcubicle.com>
Sun, 15 Mar 2015 08:51:15 +0000 (19:51 +1100)
LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h
LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h

index e8860a5..0d6e5be 100644 (file)
                        /** 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,
index ad34c85..1fed433 100644 (file)
                         *  standard 8-bit, no parity, 1 stop bit settings suitable for most applications.
                         *
                         *  \param[in,out] USART        Pointer to the base of the USART peripheral within the device.
-                        *  \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(USART_t* const USART,