Skip to content
Snippets Groups Projects
Commit 4092bac7 authored by Yacine Belkadi's avatar Yacine Belkadi Committed by Jiri Kosina
Browse files

scripts/kernel-doc: check that non-void fcts describe their return value


If a function has a return value, but its kernel-doc comment doesn't contain a
"Return" section, then emit the following warning:

   Warning(file.h:129): No description found for return value of 'fct'

Note: This check emits a lot of warnings at the moment, because many functions
don't have a 'Return' doc section. So until the number of warnings goes
sufficiently down, the check is only performed in verbose mode.

Signed-off-by: default avatarYacine Belkadi <yacine.belkadi.1@gmail.com>
Signed-off-by: default avatarRob Landley <rob@landley.net>
Signed-off-by: default avatarJiri Kosina <jkosina@suse.cz>
parent e65fe5a9
No related branches found
No related tags found
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment