Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 51f5a0c8 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

kernel-doc: strip C99 comments 



Strip C99-style comments from the input stream.
/*...*/ comments are already stripped.
C99 comments confuse the kernel-doc script.

Also update some comments.

Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 5f8c7c98

scripts/kernel-doc

+7 −1
Original line number Diff line number Diff line
@@ -719,6 +719,7 @@ sub output_struct_xml(%) { 
	    # pointer-to-function

	    print "  $1 $parameter) ($2);\n";

	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {

	    # bitfield

	    print "  $1 $parameter$2;\n";

	} else {

	    print "  ".$type." ".$parameter.";\n";
@@ -1261,6 +1262,7 @@ sub output_struct_text(%) { 
	    # pointer-to-function

	    print "\t$1 $parameter) ($2);\n";

	} elsif ($type =~ m/^(.*?)\s*(:.*)/) {

	    # bitfield

	    print "\t$1 $parameter$2;\n";

	} else {

	    print "\t".$type." ".$parameter.";\n";
@@ -1697,6 +1699,8 @@ sub process_state3_function($$) { 
    my $x = shift;

    my $file = shift;



    $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line



    if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#define/)) {

	# do nothing

    }
@@ -1719,6 +1723,8 @@ sub process_state3_type($$) { 
    $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.

    $x =~ s@^\s+@@gos; # strip leading spaces

    $x =~ s@\s+$@@gos; # strip trailing spaces

    $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line



    if ($x =~ /^#/) {

	# To distinguish preprocessor directive from regular declaration later.

	$x .= ";";
@@ -1802,7 +1808,7 @@ sub process_file($) { 


		$state = 2;

		if (/-(.*)/) {

		    # strip leading/trailing/multiple spaces #RDD:T:

		    # strip leading/trailing/multiple spaces

		    $descr= $1;

		    $descr =~ s/^\s*//;

		    $descr =~ s/\s*$//;