Skip to content

Commit

Permalink
[PATCH] DocBook: warn for missing macro parameters
Browse files Browse the repository at this point in the history
Previously kernel-doc silently ignored missing parameter descriptions for
preprocessor macros.  Now that all such omissions are fixed up we can warn
about them in kernel-doc to be able to keep it that way.

Signed-off-by: Martin Waitz <tali@admingilde.org>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
  • Loading branch information
Martin Waitz authored and Linus Torvalds committed Jan 10, 2006
1 parent 0863afb commit a6d3fe7
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions scripts/kernel-doc
Original file line number Diff line number Diff line change
Expand Up @@ -1405,6 +1405,7 @@ sub create_parameterlist($$$) {
my $type;
my $param;

# temporarily replace commas inside function pointer definition
while ($args =~ /(\([^\),]+),/) {
$args =~ s/(\([^\),]+),/$1#/g;
}
Expand Down Expand Up @@ -1465,19 +1466,22 @@ sub push_parameter($$$) {
my $param_name = $param;
$param_name =~ s/\[.*//;

if ($type eq "" && $param eq "...")
if ($type eq "" && $param =~ /\.\.\.$/)
{
$type="";
$param="...";
$parameterdescs{"..."} = "variable arguments";
$parameterdescs{$param} = "variable arguments";
}
elsif ($type eq "" && ($param eq "" or $param eq "void"))
{
$type="";
$param="void";
$parameterdescs{void} = "no arguments";
}
if (defined $type && $type && !defined $parameterdescs{$param_name}) {
# warn if parameter has no description
# (but ignore ones starting with # as these are no parameters
# but inline preprocessor statements
if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {

$parameterdescs{$param_name} = $undescribed;

if (($type eq 'function') || ($type eq 'enum')) {
Expand Down

0 comments on commit a6d3fe7

Please sign in to comment.