diff --git a/epicardium/epicardium.h b/epicardium/epicardium.h index 485cb2e1b19bc47af0ee31192cd43cb9470d2fb8..00562f1c6c0db9bcc65652a10928a2642f4c0ba2 100644 --- a/epicardium/epicardium.h +++ b/epicardium/epicardium.h @@ -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. */