Merge pull request #294 from tomtor/fix-doc

rogerclarkmelbourne · web-flow · commit d4103b8cd161 · 2017-07-03T15:36:23.000+10:00
Fix documentation for usart_putc()
diff --git a/STM32F1/system/libmaple/include/libmaple/usart.h b/STM32F1/system/libmaple/include/libmaple/usart.h
@@ -439,8 +439,8 @@ static inline void usart_disable_all(void) {
 /**
  * @brief Transmit one character on a serial port.
  *
- * This function blocks until the character has been successfully
- * transmitted.
+ * This function blocks until the character has been queued
+ * for transmission.
  *
  * @param dev Serial port to send on.
  * @param byte Byte to transmit.

Original file line number	Diff line number	Diff line change
`@@ -439,8 +439,8 @@ static inline void usart_disable_all(void) {`
`439`	`439`	`/**`
`440`	`440`	`* @brief Transmit one character on a serial port.`
`441`	`441`	`*`
`442`		`- * This function blocks until the character has been successfully`
`443`		`- * transmitted.`
	`442`	`+ * This function blocks until the character has been queued`
	`443`	`+ * for transmission.`
`444`	`444`	`*`
`445`	`445`	`* @param dev Serial port to send on.`
`446`	`446`	`* @param byte Byte to transmit.`