scripts/kernel-doc: check that non-void fcts describe their return value
authorYacine Belkadi <yacine.belkadi.1@gmail.com>
Tue, 27 Nov 2012 20:27:19 +0000 (21:27 +0100)
committerMichal Marek <mmarek@suse.cz>
Thu, 6 Dec 2012 10:49:28 +0000 (11:49 +0100)
commit9a52aeeb92853167a67225602b9783f3cf4e578e
treeaa7da70e2e13d085b2c0b7999eef8aff2aa89ab7
parentddf5eabd20c6cc2814fa2c00a1a033776fbc3e44
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>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Michal Marek <mmarek@suse.cz>
scripts/kernel-doc