addition to 22036 (document SUPER better): superclass may be plural

[perl5.git] / autodoc.pl

diff --git a/autodoc.pl b/autodoc.pl
index 33c2223..f0b9919 100644 (file)
--- a/autodoc.pl
+++ b/autodoc.pl
@@ -3,7 +3,10 @@
 require 5.003; # keep this compatible, an old perl is all we may have before
                 # we build the new one
 
-BEGIN {  push @INC, 'lib' }    # glob() below requires File::Glob
+BEGIN {
+  push @INC, 'lib';
+  require 'regen_lib.pl';
+}      # glob() below requires File::Glob
 
 
 #
@@ -28,6 +31,7 @@ sub walk_table (&@) {
        $F = $filename;
     }
     else {
+       safer_unlink $filename;
        open F, ">$filename" or die "Can't open $filename: $!";
        $F = \*F;
     }
@@ -36,7 +40,7 @@ sub walk_table (&@) {
     while (<IN>) {
        chomp;
        next if /^:/;
-       while (s|\\$||) {
+       while (s|\\\s*$||) {
            $_ .= <IN>;
            chomp;
        }
@@ -50,7 +54,9 @@ sub walk_table (&@) {
        print $F $function->(@args);
     }
     print $F $trailer if $trailer;
-    close $F unless ref $filename;
+    unless (ref $filename) {
+       close $F or die "Error closing $filename: $!";
+    }
 }
 
 my %apidocs;
@@ -69,7 +75,7 @@ FUNC:
             next FUNC;
         }
        $line++;
-       if ($in =~ /^=for\s+apidoc\s+(.*)\n/) {
+       if ($in =~ /^=for\s+apidoc\s+(.*?)\s*\n/) {
            my $proto = $1;
            $proto = "||$proto" unless $proto =~ /\|/;
            my($flags, $ret, $name, @args) = split /\|/, $proto;
@@ -145,7 +151,7 @@ for $file (glob('*.c'), glob('*.h')) {
     close F or die "Error closing $file: $!\n";
 }
 
-unlink "pod/perlapi.pod";
+safer_unlink "pod/perlapi.pod";
 open (DOC, ">pod/perlapi.pod") or
        die "Can't create pod/perlapi.pod: $!\n";
 
@@ -155,16 +161,20 @@ walk_table {      # load documented functions into approriate hash
        return "" unless $flags =~ /d/;
        $func =~ s/\t//g; $flags =~ s/p//; # clean up fields from embed.pl
        $retval =~ s/\t//;
-       if ($flags =~ /A/) {
-           my $docref = delete $docfuncs{$func};
+       my $docref = delete $docfuncs{$func};
+       if ($docref and @$docref) {
+           if ($flags =~ /A/) {
+               $docref->[0].="x" if $flags =~ /M/;
+               $apidocs{$docref->[4]}{$func} = 
+                   [$docref->[0] . 'A', $docref->[1], $retval,
+                                               $docref->[3], @args];
+           } else {
+               $gutsdocs{$docref->[4]}{$func} = 
+                   [$docref->[0], $docref->[1], $retval, $docref->[3], @args];
+           }
+       }
+       else {
            warn "no docs for $func\n" unless $docref and @$docref;
-            $docref->[0].="x" if $flags =~ /M/;
-           $apidocs{$docref->[4]}{$func} = 
-                [$docref->[0] . 'A', $docref->[1], $retval, $docref->[3], @args];
-       } else {
-           my $docref = delete $docfuncs{$func};
-           $gutsdocs{$docref->[4]}{$func} = 
-                [$docref->[0], $docref->[1], $retval, $docref->[3], @args];
        }
     }
     return "";
@@ -199,7 +209,8 @@ The listing is alphabetical, case insensitive.
 _EOB_
 
 my $key;
-for $key (sort { uc($a) cmp uc($b); } keys %apidocs) { # case insensitive sort
+# case insensitive sort, with fallback for determinacy
+for $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %apidocs) {
     my $section = $apidocs{$key}; 
     print DOC "\n=head1 $key\n\n=over 8\n\n";
     for my $key (sort { uc($a) cmp uc($b); } keys %$section) {
@@ -231,8 +242,9 @@ perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
 _EOE_
 
 
-close(DOC);
+close(DOC) or die "Error closing pod/perlapi.pod: $!";
 
+safer_unlink "pod/perlintern.pod";
 open(GUTS, ">pod/perlintern.pod") or
                die "Unable to create pod/perlintern.pod: $!\n";
 print GUTS <<'END';
@@ -273,5 +285,4 @@ perlguts(1), perlapi(1)
 
 END
 
-close GUTS;
-
+close GUTS or die "Error closing pod/perlintern.pod: $!";