Commit 55f60847cbb70af926c83b2fb69af0b51e14c26f
2021-10-08T20:49:51
wikiheaders.pl: Try to handle functions with multiple declarations better.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
diff --git a/build-scripts/wikiheaders.pl b/build-scripts/wikiheaders.pl
index 7c2411a..0cb945a 100755
--- a/build-scripts/wikiheaders.pl
+++ b/build-scripts/wikiheaders.pl
@@ -402,14 +402,33 @@ while (readdir(DH)) {
#print("$fn:\n$str\n\n");
- $headerfuncs{$fn} = $str;
- $headerdecls{$fn} = $decl;
- $headerfuncslocation{$fn} = $dent;
- $headerfuncschunk{$fn} = scalar(@contents);
- $headerfuncshasdoxygen{$fn} = $has_doxygen;
-
- push @contents, join("\n", @templines);
- push @contents, join("\n", @decllines);
+ # There might be multiple declarations of a function due to #ifdefs,
+ # and only one of them will have documentation. If we hit an
+ # undocumented one before, delete the placeholder line we left for
+ # it so it doesn't accumulate a new blank line on each run.
+ my $skipfn = 0;
+ if (defined $headerfuncshasdoxygen{$fn}) {
+ if ($headerfuncshasdoxygen{$fn} == 0) { # An undocumented declaration already exists, nuke its placeholder line.
+ delete $contents[$headerfuncschunk{$fn}]; # delete DOES NOT RENUMBER existing elements!
+ } else { # documented function already existed?
+ $skipfn = 1; # don't add this copy to the list of functions.
+ if ($has_doxygen) {
+ print STDERR "WARNING: Function '$fn' appears to be documented in multiple locations. Only keeping the first one we saw!\n";
+ }
+ push @contents, join("\n", @decllines); # just put the existing declation in as-is.
+ }
+ }
+
+ if (!$skipfn) {
+ $headerfuncs{$fn} = $str;
+ $headerdecls{$fn} = $decl;
+ $headerfuncslocation{$fn} = $dent;
+ $headerfuncschunk{$fn} = scalar(@contents);
+ $headerfuncshasdoxygen{$fn} = $has_doxygen;
+ push @contents, join("\n", @templines);
+ push @contents, join("\n", @decllines);
+ }
+
}
close(FH);