[PATCH] kernel-doc: detect trailing kernel-doc line trash

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@xxxxxxxxxx>

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@xxxxxxxxxx>
---
 scripts/kernel-doc |    5 +++++
 1 file changed, 5 insertions(+)

--- lin2625-rc8-kdoc.orig/scripts/kernel-doc
+++ lin2625-rc8-kdoc/scripts/kernel-doc
@@ -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;
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/