Skip to content
Snippets Groups Projects
Verified Commit f7878036 authored by rahix's avatar rahix
Browse files

doc: Mention epic_uart_read_chr() is bad 


Signed-off-by: default avatarRahix <rahix@rahix.de>
parent 7fefa791
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 5 additions and 2 deletions
epicardium/epicardium.h
+ 5
− 2
View file @ f7878036
...@@ -101,8 +101,11 @@ API(API_UART_WRITE, void epic_uart_write_str(const char *str, intptr_t length)); ...@@ -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. * Blocking read a single character from any connected serial device.
* ``epic_uart_read_chr`` only returns * ``epic_uart_read_chr`` only returns once one byte has been read.
* once one byte has been read. *
* .. todo::
*
* This API function is currently in violation of the API rules.
* *
* :return: The byte. * :return: The byte.
*/ */
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment