michaelh/zephyr
1
0
Fork 0
Code Releases Activity

uart: Improve line control documentation

Browse source 
Minor improvements to UART line control documentation.

Signed-off-by: Jacob Siverskog <jacob@teenage.engineering>
This commit is contained in:
Jacob Siverskog 2019-11-04 14:22:00 +01:00 • committed by Carles Cufí
commit eb4679d0c4
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/drivers/uart.h
View file

@ -1069,7 +1069,7 @@ static inline void uart_irq_callback_set(struct device *dev,
* @brief Manipulate line control for UART. * @brief Manipulate line control for UART.
* *
* @param dev UART device structure. * @param dev UART device structure.
* @param ctrl The line control to manipulate. * @param ctrl The line control to manipulate (see enum uart_line_ctrl).
* @param val Value to set to the line control. * @param val Value to set to the line control.
* *
* @retval 0 If successful. * @retval 0 If successful.
@ -1095,8 +1095,8 @@ static inline int z_impl_uart_line_ctrl_set(struct device *dev,
* @brief Retrieve line control for UART. * @brief Retrieve line control for UART.
* *
* @param dev UART device structure. * @param dev UART device structure.
* @param ctrl The line control to manipulate. * @param ctrl The line control to retrieve (see enum uart_line_ctrl).
* @param val Value to get for the line control. * @param val Pointer to variable where to store the line control value.
* *
* @retval 0 If successful. * @retval 0 If successful.
* @retval failed Otherwise. * @retval failed Otherwise.