summaryrefslogtreecommitdiff
path: root/autodoc.pl
diff options
context:
space:
mode:
authorSébastien Aperghis-Tramoni <sebastien@aperghis.net>2005-10-19 00:22:57 +0200
committerRafael Garcia-Suarez <rgarciasuarez@gmail.com>2005-10-19 07:52:20 +0000
commitd8c40edcf7b2eca3075e6c3cd36c64193c41e123 (patch)
treef5a81e98ce9d3d6c495b643c7dba702d5c44ff75 /autodoc.pl
parente886094b26c01a71243f931e1dd54d48122d46f1 (diff)
downloadperl-d8c40edcf7b2eca3075e6c3cd36c64193c41e123.tar.gz
Adding documentation index to perlapi.pod and perlintern.pod
Message-ID: <1129666977.435559a10cb95@imp5-g19.free.fr> (tweaked to remove trailing whitespace to doc entries) Plus, regenerate doc and headers p4raw-id: //depot/perl@25802
Diffstat (limited to 'autodoc.pl')
-rw-r--r--autodoc.pl5
1 files changed, 4 insertions, 1 deletions
diff --git a/autodoc.pl b/autodoc.pl
index d347e4c95e..6a2e28bfe8 100644
--- a/autodoc.pl
+++ b/autodoc.pl
@@ -120,13 +120,14 @@ DOC:
sub docout ($$$) { # output the docs for one function
my($fh, $name, $docref) = @_;
my($flags, $docs, $ret, $file, @args) = @$docref;
+ $name =~ s/\s*$//;
$docs .= "NOTE: this function is experimental and may change or be
removed without notice.\n\n" if $flags =~ /x/;
$docs .= "NOTE: the perl_ form of this function is deprecated.\n\n"
if $flags =~ /p/;
- print $fh "=item $name\n$docs";
+ print $fh "=item $name\nX<$name>\n$docs";
if ($flags =~ /U/) { # no usage
# nothing
@@ -200,6 +201,7 @@ print DOC <<'_EOB_';
perlapi - autogenerated documentation for the perl public API
=head1 DESCRIPTION
+X<Perl API> X<API> X<api>
This file contains the documentation of the perl public API generated by
embed.pl, specifically a listing of functions, macros, flags, and variables
@@ -264,6 +266,7 @@ perlintern - autogenerated documentation of purely B<internal>
Perl functions
=head1 DESCRIPTION
+X<internal Perl functions> X<interpreter functions>
This file is the autogenerated documentation of functions in the
Perl interpreter that are documented using Perl's internal documentation