gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-06-09 02:14:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor documentation improvements.

Browse Source
This commit is contained in:
Dean Camera 2012-08-20 21:02:17 +00:00
parent 1cb60c1214
commit a69a0cbeb8
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h
View File

@ -55,10 +55,13 @@
* Serial_Init(9600, false); * Serial_Init(9600, false);
* *
* // Send a string through the USART * // 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 * // Receive a byte through the USART (or -1 if no data received)
* uint8_t DataByte = Serial_RxByte(); * int16_t DataByte = Serial_ReceiveByte();
* \endcode * \endcode
* *
* @{ * @{
@ -116,13 +119,13 @@
#define SERIAL_2X_UBBRVAL(Baud) ((((F_CPU / 8) + (Baud / 2)) / (Baud)) - 1) #define SERIAL_2X_UBBRVAL(Baud) ((((F_CPU / 8) + (Baud / 2)) / (Baud)) - 1)
/* Function Prototypes: */ /* 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. * \param[in] FlashStringPtr Pointer to a string located in program space.
*/ */
void Serial_SendString_P(const char* FlashStringPtr) ATTR_NON_NULL_PTR_ARG(1); 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. * \param[in] StringPtr Pointer to a string located in SRAM space.
*/ */