diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2012-08-20 21:02:17 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2012-08-20 21:02:17 +0000 |
| commit | a69a0cbeb88f0e81bd32b4381489d50c008c34e4 (patch) | |
| tree | 82cd394853175060d36ce9c862db392ebc73586d /LUFA/Drivers/Peripheral | |
| parent | 1cb60c1214c82ac117a7ede9e29351e902ee7c35 (diff) | |
| download | lufa-a69a0cbeb88f0e81bd32b4381489d50c008c34e4.tar.gz lufa-a69a0cbeb88f0e81bd32b4381489d50c008c34e4.tar.bz2 lufa-a69a0cbeb88f0e81bd32b4381489d50c008c34e4.zip | |
Minor documentation improvements.
Diffstat (limited to 'LUFA/Drivers/Peripheral')
| -rw-r--r-- | LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h index b7b50f434..b949513dd 100644 --- a/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h @@ -55,10 +55,13 @@ * Serial_Init(9600, false); * * // Send a string through the USART - * Serial_TxString("Test String\r\n"); + * Serial_SendString("Test String\r\n"); + * + * // Send a raw byte through the USART + * Serial_SendByte(0xDC); * - * // Receive a byte through the USART - * uint8_t DataByte = Serial_RxByte(); + * // Receive a byte through the USART (or -1 if no data received) + * int16_t DataByte = Serial_ReceiveByte(); * \endcode * * @{ @@ -116,13 +119,13 @@ #define SERIAL_2X_UBBRVAL(Baud) ((((F_CPU / 8) + (Baud / 2)) / (Baud)) - 1) /* Function Prototypes: */ - /** Transmits a given string located in program space (FLASH) through the USART. + /** Transmits a given NUL terminated string located in program space (FLASH) through the USART. * * \param[in] FlashStringPtr Pointer to a string located in program space. */ void Serial_SendString_P(const char* FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1); - /** Transmits a given string located in SRAM memory through the USART. + /** Transmits a given NUL terminated string located in SRAM memory through the USART. * * \param[in] StringPtr Pointer to a string located in SRAM space. */ |