Jarkko Hietaniemi > perl > perlapi

Download:
perl-5.8.1.tar.gz

Annotate this POD

Source   Latest Release: perl-5.14.4

NAME ^

perlapi - autogenerated documentation for the perl public API

DESCRIPTION ^

This file contains the documentation of the perl public API generated by embed.pl, specifically a listing of functions, macros, flags, and variables that may be used by extension writers. The interfaces of any functions that are not listed here are subject to change without notice. For this reason, blindly using functions listed in proto.h is to be avoided when writing extensions.

Note that all Perl API global variables must be referenced with the PL_ prefix. Some macros are provided for compatibility with the older, unadorned names, but this support may be disabled in a future release.

The listing is alphabetical, case insensitive.

_EOB_

my $key; for $key (sort { uc($a) cmp uc($b); } keys %apidocs) { # case insensitive sort 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) { docout(\*DOC, $key, $section->{$key}); } print DOC "\n=back\n"; }

print DOC <<'_EOE_';

AUTHORS ^

Until May 1997, this document was maintained by Jeff Okamoto <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.

With lots of help and suggestions from Dean Roehrich, Malcolm Beattie, Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer, Stephen McCamant, and Gurusamy Sarathy.

API Listing originally by Dean Roehrich <roehrich@cray.com>.

Updated to be autogenerated from comments in the source by Benjamin Stuhl.

SEE ALSO ^

perlguts(1), perlxs(1), perlxstut(1), perlintern(1)

_EOE_

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'; =head1 NAME

perlintern - autogenerated documentation of purely internal Perl functions

DESCRIPTION ^

This file is the autogenerated documentation of functions in the Perl interpreter that are documented using Perl's internal documentation format but are not marked as part of the Perl API. In other words, they are not for use in extensions!

END

for $key (sort { uc($a) cmp uc($b); } keys %gutsdocs) { my $section = $gutsdocs{$key}; print GUTS "\n=head1 $key\n\n=over 8\n\n"; for my $key (sort { uc($a) cmp uc($b); } keys %$section) { docout(\*GUTS, $key, $section->{$key}); } print GUTS "\n=back\n"; }

print GUTS <<'END';

AUTHORS ^

The autodocumentation system was originally added to the Perl core by Benjamin Stuhl. Documentation is by whoever was kind enough to document their functions.

SEE ALSO ^

perlguts(1), perlapi(1)

END

close GUTS or die "Error closing pod/perlintern.pod: $!";

syntax highlighting: