include: drivers: uart: fix incorrect event name in brief

jenmwms · nashif · commit 783f8158c1dd · 2021-02-03T09:44:21.000-05:00
The use of UART_RX_DONE was incorrect/invalid (the event does not exist). This corrects the reference to UART_RX_RDY. Fixes #31207 Signed-off-by: Jennifer Williams <jennifer.m.williams@intel.com>
diff --git a/include/drivers/uart.h b/include/drivers/uart.h
@@ -49,8 +49,9 @@ enum uart_line_ctrl {
  *
  *    - Provide second buffer using uart_rx_buf_rsp, when first buffer is
  *      filled, receiving will automatically start to second buffer.
- *    - Ignore the event, this way when current buffer is filled UART_RX_DONE
- *      event will be generated and receiving will be stopped.
+ *    - Ignore the event, this way when current buffer is filled
+ *      @ref uart_event_type::UART_RX_RDY event will be generated and
+ *      receiving will be stopped.
  *
  * 3. If some data was received and timeout occurred
  *    @ref uart_event_type::UART_RX_RDY event will be generated. It can happen

Original file line number	Diff line number	Diff line change
`@@ -49,8 +49,9 @@ enum uart_line_ctrl {`
`49`	`49`	`*`
`50`	`50`	`* - Provide second buffer using uart_rx_buf_rsp, when first buffer is`
`51`	`51`	`* filled, receiving will automatically start to second buffer.`
`52`		`- * - Ignore the event, this way when current buffer is filled UART_RX_DONE`
`53`		`- * event will be generated and receiving will be stopped.`
	`52`	`+ * - Ignore the event, this way when current buffer is filled`
	`53`	`+ * @ref uart_event_type::UART_RX_RDY event will be generated and`
	`54`	`+ * receiving will be stopped.`
`54`	`55`	`*`
`55`	`56`	`* 3. If some data was received and timeout occurred`
`56`	`57`	`* @ref uart_event_type::UART_RX_RDY event will be generated. It can happen`