michaelh/zephyr
1
0
Fork 0
Code Releases Activity

drivers: serial: remove @return doc for void functions

Browse source 
For functions returning nothing, there is no need to document
with @return, as Doxgen complains about "documented empty
return type of ...".

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
This commit is contained in:
Daniel Leung 2022-01-06 16:43:40 -08:00 • committed by Anas Nashif
commit bff37a3a6c
14 changed files with 3 additions and 120 deletions
Download patch file Download diff file Expand all files Collapse all files

14
drivers/serial/uart_ns16550.c
View file

@ -655,8 +655,6 @@ static int uart_ns16550_fifo_read(const struct device *dev, uint8_t *rx_data,
* @brief Enable TX interrupt in IER
*
* @param dev UART device struct
*
* @return N/A
*/
static void uart_ns16550_irq_tx_enable(const struct device *dev)
{
@ -691,8 +689,6 @@ static void uart_ns16550_irq_tx_enable(const struct device *dev)
* @brief Disable TX interrupt in IER
*
* @param dev UART device struct
*
* @return N/A
*/
static void uart_ns16550_irq_tx_disable(const struct device *dev)
{
@ -764,8 +760,6 @@ static int uart_ns16550_irq_tx_complete(const struct device *dev)
* @brief Enable RX interrupt in IER
*
* @param dev UART device struct
*
* @return N/A
*/
static void uart_ns16550_irq_rx_enable(const struct device *dev)
{
@ -780,8 +774,6 @@ static void uart_ns16550_irq_rx_enable(const struct device *dev)
* @brief Disable RX interrupt in IER
*
* @param dev UART device struct
*
* @return N/A
*/
static void uart_ns16550_irq_rx_disable(const struct device *dev)
{
@ -814,8 +806,6 @@ static int uart_ns16550_irq_rx_ready(const struct device *dev)
* @brief Enable error interrupt in IER
*
* @param dev UART device struct
*
* @return N/A
*/
static void uart_ns16550_irq_err_enable(const struct device *dev)
{
@ -883,8 +873,6 @@ static int uart_ns16550_irq_update(const struct device *dev)
*
* @param dev UART device struct
* @param cb Callback function pointer.
*
* @return N/A
*/
static void uart_ns16550_irq_callback_set(const struct device *dev,
uart_irq_callback_user_data_t cb,
@ -905,8 +893,6 @@ static void uart_ns16550_irq_callback_set(const struct device *dev,
* This simply calls the callback function, if one exists.
*
* @param arg Argument to ISR.
*
* @return N/A
*/
static void uart_ns16550_isr(const struct device *dev)
{