kernel-doc: detect trailing kernel-doc line trash

Print a warning when a kernel-doc comment block ends with text on the same
line as the ending comment characters, e.g.:

 * this text is lost. */

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Randy Dunlap 2008-04-28 02:16:35 -07:00 committed by Linus Torvalds
parent 94dc7ad550
commit 46b958eb80

View file

@ -1950,6 +1950,11 @@ sub process_file($) {
$section = $section_default;
$contents = "";
}
# look for doc_com + <text> + doc_end:
if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
print STDERR "Warning(${file}:$.): suspicious ending line: $_";
++$warnings;
}
$prototype = "";
$state = 3;