Verified Commit f7878036 authored by Rahix's avatar Rahix
Browse files

doc: Mention epic_uart_read_chr() is bad



Signed-off-by: Rahix's avatarRahix <rahix@rahix.de>
parent 7fefa791
......@@ -101,8 +101,11 @@ API(API_UART_WRITE, void epic_uart_write_str(const char *str, intptr_t length));
/**
* Blocking read a single character from any connected serial device.
* ``epic_uart_read_chr`` only returns
* once one byte has been read.
* ``epic_uart_read_chr`` only returns once one byte has been read.
*
* .. todo::
*
* This API function is currently in violation of the API rules.
*
* :return: The byte.
*/
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment