mirrors
/
SDL
mirror of https://github.com/libsdl-org/SDL
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

wikiheaders: Warn if a function returns non-void but has no `\returns` line.

This commit is contained in:
Ryan C. Gordon 2024-06-13 16:45:59 -04:00
parent 49f2a3463f
commit a9d0eaf34a
No known key found for this signature in database
GPG Key ID: FA148B892AB48044
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
build-scripts/wikiheaders.pl
View File

@ -1813,6 +1813,7 @@ if ($copy_direction == 1) { # --copy-to-headers
my %params = (); # have to parse these and build up the wiki tables after, since Markdown needs to know the length of the largest string. :/
my @paramsorder = ();
my $fnsigparams = $headersymsparaminfo{$sym};
my $has_returns = 0;
while (@doxygenlines) {
my $l = shift @doxygenlines;
@ -1851,6 +1852,7 @@ if ($copy_direction == 1) { # --copy-to-headers
$params{$arg} = $desc;
push @paramsorder, $arg;
} elsif ($l =~ /\A\\r(eturns?)\s+(.*)\Z/) {
$has_returns = 1;
# !!! FIXME: complain if this isn't a function or macro.
my $retstr = "R$1"; # "Return" or "Returns"
my $desc = $2;
@ -1937,6 +1939,10 @@ if ($copy_direction == 1) { # --copy-to-headers
}
}
if (($symtype == 1) && ($headersymsrettype{$sym} ne 'void') && !$has_returns) {
print STDERR "WARNING: Function '$sym' has a non-void return type but no '\\returns' declaration\n";
}
# Make sure %params is in the same order as the actual function signature and add C datatypes...
my $params_has_c_datatype = 0;
my @final_params = ();