Skip to content

Commit bf8bf69

Browse files
committed
Update SerialBase sync() function description
1 parent 6f6b665 commit bf8bf69

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

drivers/include/drivers/SerialBase.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,9 @@ class SerialBase : private NonCopyable<SerialBase> {
119119
*/
120120
void send_break();
121121

122-
/** Flush hardware buffers associated with serial port
122+
/** Ensures all data stored in peripheral buffers is transmitted to the bus
123+
*
124+
* The function shall block until all the content of peripheral buffers is transmitted.
123125
*
124126
* @return 0 on success, negative error code on failure
125127
*/

0 commit comments

Comments
 (0)