Commit 46b958eb authored Apr 28, 2008 by Randy Dunlap Committed by Linus Torvalds Apr 28, 2008

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>

parent 94dc7ad5

scripts/kernel-doc

+5 −0

Original line number	Original line	Diff line number	Diff line
	@@ -1950,6 +1950,11 @@ sub process_file($) {
	$section = $section_default;		$section = $section_default;
	$contents = "";		$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 = "";		$prototype = "";
	$state = 3;		$state = 3;