drivers: uart: clarification of poll_out blocking duration
The API docs state that the uart_poll_out is a blocking call,
but it does not specify how long a call to this function should
block the calling thread. This is described in the UART driver
documentation.
This patch clarifies the API docs and alignes it with the driver
documentation.
Signed-off-by: Hubert Miś <hubert.mis@nordicsemi.no>
diff --git a/include/zephyr/drivers/uart.h b/include/zephyr/drivers/uart.h
index 5cc9d2d..d6ce894 100644
--- a/include/zephyr/drivers/uart.h
+++ b/include/zephyr/drivers/uart.h
@@ -380,10 +380,11 @@
/**
* @brief Write a character to the device for output.
*
- * This routine checks if the transmitter is full. When the
+ * This routine checks if the transmitter is full. When the
* transmitter is not full, it writes a character to the data
- * register. It waits and blocks the calling thread, otherwise. This
- * function is a blocking call.
+ * register. It waits and blocks the calling thread otherwise. This
+ * function is a blocking call. It blocks the calling thread until the
+ * character is sent.
*
* To send a character when hardware flow control is enabled, the handshake
* signal CTS must be asserted.