diff options
author | Tony Cook <tony@develop-help.com> | 2010-03-01 23:44:54 +1100 |
---|---|---|
committer | Rafael Garcia-Suarez <rgs@consttype.org> | 2010-03-08 10:28:45 +0100 |
commit | 5a0155e6981ef7c13c32b17445bd95138caa8dca (patch) | |
tree | 899d3911f2b2387d6be4422c9aa7464ca5dd6427 /autodoc.pl | |
parent | 5564a16944f291c2122d58c95dbf14d9010de2f5 (diff) | |
download | perl-5a0155e6981ef7c13c32b17445bd95138caa8dca.tar.gz |
list undocumented API and internal functions in perlapi.pod and perlintern.pod
List any functions from embed.fnc that don't have documentation in
their own section of perlapi/perlintern as a reminder to either
document them, remove them or perhaps flag them as undeserving of
documentation.
Diffstat (limited to 'autodoc.pl')
-rw-r--r-- | autodoc.pl | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/autodoc.pl b/autodoc.pl index 28ca96e309..a88af9cde6 100644 --- a/autodoc.pl +++ b/autodoc.pl @@ -150,7 +150,7 @@ removed without notice.\n\n" if $flags =~ /x/; } sub output { - my ($podname, $header, $dochash, $footer) = @_; + my ($podname, $header, $dochash, $missing, $footer) = @_; my $filename = "pod/$podname.pod"; open my $fh, '>', $filename or die "Can't open $filename: $!"; @@ -175,6 +175,15 @@ _EOH_ print $fh "\n=back\n"; } + if (@$missing) { + print $fh "=head1 Undocumented functions\n\n"; + print $fh "These functions are currently undocumented:\n\n=over\n\n"; + for my $missing (sort @$missing) { + print $fh "=item $missing\nX<$missing>\n\n"; + } + print $fh "=back\n\n"; + } + print $fh $footer, <<'_EOF_'; =cut @@ -250,7 +259,8 @@ foreach (sort keys %missing) { # walk table providing an array of components in each line to # subroutine, printing the result -output('perlapi', <<'_EOB_', $docs{api}, <<'_EOE_'); +my @missing_api = grep $funcflags{$_}{flags} =~ /A/ && !$docs{api}{$_}, keys %funcflags; +output('perlapi', <<'_EOB_', $docs{api}, \@missing_api, <<'_EOE_'); =head1 NAME perlapi - autogenerated documentation for the perl public API @@ -316,7 +326,9 @@ perlguts(1), perlxs(1), perlxstut(1), perlintern(1) _EOE_ -output('perlintern', <<'END', $docs{guts}, <<'END'); +my @missing_guts = grep $funcflags{$_}{flags} !~ /A/ && !$docs{guts}{$_}, keys %funcflags; + +output('perlintern', <<'END', $docs{guts}, \@missing_guts, <<'END'); =head1 NAME perlintern - autogenerated documentation of purely B<internal> |