michaelh/zephyr
1
0
Fork 0
Code Releases Activity

shell: 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 17:29:36 -08:00 • committed by Anas Nashif
commit 39d33fc352
1 changed files with 0 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
include/shell/shell.h
View file

@ -842,8 +842,6 @@ int shell_init(const struct shell *shell, const void *transport_config,
*
* @param shell Pointer to shell instance.
* @param cb Callback called when uninitialization is completed.
*
* @return Standard error code.
*/
void shell_uninit(const struct shell *shell, shell_uninit_cb_t cb);