Skip to content

Commit

Permalink
kernel-doc: strip C99 comments
Browse files Browse the repository at this point in the history
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: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
  • Loading branch information
rddunlap authored and Linus Torvalds committed Jul 19, 2007
1 parent 5f8c7c9 commit 51f5a0c
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion scripts/kernel-doc
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down Expand Up @@ -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";
Expand Down Expand Up @@ -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
}
Expand All @@ -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 .= ";";
Expand Down Expand Up @@ -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*$//;
Expand Down

0 comments on commit 51f5a0c

Please sign in to comment.