michaelh/zephyr
1
0
Fork 0
Code Releases Activity

drivers: console: 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:39:27 -08:00 • committed by Anas Nashif
commit 44ee482b0a
5 changed files with 0 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

4
drivers/console/uart_console.c
View file

@ -566,10 +566,7 @@ void uart_register_input(struct k_fifo *avail, struct k_fifo *lines,
#endif #endif
/** /**
*
* @brief Install printk/stdout hook for UART console output * @brief Install printk/stdout hook for UART console output
*
* @return N/A
*/ */
static void uart_console_hook_install(void) static void uart_console_hook_install(void)
@ -583,7 +580,6 @@ static void uart_console_hook_install(void)
} }
/** /**
*
* @brief Initialize one UART as the console/debug port * @brief Initialize one UART as the console/debug port
* *
* @return 0 if successful, otherwise failed. * @return 0 if successful, otherwise failed.

1
drivers/console/xtensa_sim_console.c
View file

@ -51,7 +51,6 @@ extern void __printk_hook_install(int (*fn)(int));
/** /**
* @brief Install printk/stdout hook for Xtensa Simulator console output * @brief Install printk/stdout hook for Xtensa Simulator console output
* @return N/A
*/ */
static void xt_sim_console_hook_install(void) static void xt_sim_console_hook_install(void)
{ {

2
include/console/console.h
View file

@ -82,8 +82,6 @@ int console_putchar(char c);
* access to console via console_getline() function. This function * access to console via console_getline() function. This function
* supersedes, and incompatible with, callback (push-style) console * supersedes, and incompatible with, callback (push-style) console
* handling (via console_input_fn callback, etc.). * handling (via console_input_fn callback, etc.).
*
* @return N/A
*/ */
void console_getline_init(void); void console_getline_init(void);

2
include/drivers/console/console.h
View file

@ -38,8 +38,6 @@ struct console_input {
* @param lines k_fifo queue of entered lines which to be processed * @param lines k_fifo queue of entered lines which to be processed
* in the application code. * in the application code.
* @param completion callback for tab completion of entered commands * @param completion callback for tab completion of entered commands
*
* @return N/A
*/ */
typedef void (*console_input_fn)(struct k_fifo *avail, struct k_fifo *lines, typedef void (*console_input_fn)(struct k_fifo *avail, struct k_fifo *lines,
uint8_t (*completion)(char *str, uint8_t len)); uint8_t (*completion)(char *str, uint8_t len));

2
include/drivers/console/uart_console.h
View file

@ -26,8 +26,6 @@ extern "C" {
* @param lines k_fifo queue of entered lines which to be processed * @param lines k_fifo queue of entered lines which to be processed
* in the application code. * in the application code.
* @param completion callback for tab completion of entered commands * @param completion callback for tab completion of entered commands
*
* @return N/A
*/ */
void uart_register_input(struct k_fifo *avail, struct k_fifo *lines, void uart_register_input(struct k_fifo *avail, struct k_fifo *lines,
uint8_t (*completion)(char *str, uint8_t len)); uint8_t (*completion)(char *str, uint8_t len));