Skip to content

Commit

Permalink
kernel-doc: fix unnamed struct/union warning
Browse files Browse the repository at this point in the history
Fix kernel-doc warning:
Warning(linux-2.6.22-rc2-git2/include/linux/skbuff.h:316): No description found for parameter '}'

which is caused by nested anonymous structs/unions ending with:
  };
};

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
Randy Dunlap authored and Linus Torvalds committed Jul 19, 2007
1 parent 2ac534b commit 5f8c7c9
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions scripts/kernel-doc
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ use strict;

my $errors = 0;
my $warnings = 0;
my $anon_struct_union = 0;

# match expressions used to find embedded type information
my $type_constant = '\%([-_\w]+)';
Expand Down Expand Up @@ -1510,8 +1511,13 @@ sub push_parameter($$$) {
my $param = shift;
my $type = shift;
my $file = shift;
my $anon = 0;

if (($anon_struct_union == 1) && ($type eq "") &&
($param eq "}")) {
return; # ignore the ending }; from anon. struct/union
}

$anon_struct_union = 0;
my $param_name = $param;
$param_name =~ s/\[.*//;

Expand All @@ -1530,16 +1536,16 @@ sub push_parameter($$$) {
# handle unnamed (anonymous) union or struct:
{
$type = $param;
$param = "{unnamed_" . $param. "}";
$param = "{unnamed_" . $param . "}";
$parameterdescs{$param} = "anonymous\n";
$anon = 1;
$anon_struct_union = 1;
}

# warn if parameter has no description
# (but ignore ones starting with # as these are not parameters
# but inline preprocessor statements);
# also ignore unnamed structs/unions;
if (!$anon) {
if (!$anon_struct_union) {
if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {

$parameterdescs{$param_name} = $undescribed;
Expand Down

0 comments on commit 5f8c7c9

Please sign in to comment.