]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/commit - scripts/kernel-doc
scripts/kernel-doc: check that non-void fcts describe their return value
authorYacine Belkadi <yacine.belkadi.1@gmail.com>
Mon, 26 Nov 2012 21:22:27 +0000 (22:22 +0100)
committerJiri Kosina <jkosina@suse.cz>
Tue, 27 Nov 2012 20:09:35 +0000 (21:09 +0100)
commit4092bac77131048b8f69cb1f939326c55d93709f
treed6ef89dcde5b3ad99b27e27b1d51ef2bbff217f8
parente65fe5a91404af97a7a487e6c7606fb5e3807d7d
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>
scripts/kernel-doc