tree d6ef89dcde5b3ad99b27e27b1d51ef2bbff217f8
parent e65fe5a91404af97a7a487e6c7606fb5e3807d7d
author Yacine Belkadi <yacine.belkadi.1@gmail.com> 1353964947 +0100
committer Jiri Kosina <jkosina@suse.cz> 1354046975 +0100

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: Yacine Belkadi <yacine.belkadi.1@gmail.com>
Signed-off-by: Rob Landley <rob@landley.net>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>