This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
embed.fnc: Fix wrong comment
authorKarl Williamson <khw@cpan.org>
Sun, 21 Jul 2019 19:12:43 +0000 (13:12 -0600)
committerKarl Williamson <khw@cpan.org>
Tue, 23 Jul 2019 17:14:47 +0000 (11:14 -0600)
embed.fnc

index 818f48e..3f1d2ec 100644 (file)
--- a/embed.fnc
+++ b/embed.fnc
 :
 :         add entry to the list of exported symbols (unless e or m);
 :         any doc entry goes in perlapi.pod rather than perlintern.pod.  If
-:            none specified, autodoc.pl does not list this function/macro as
-:            part of the public API.  If x isn't specified, and no
-:            documentation is furnished, autodoc.pl lists this in perlapi as
-:            existing and being undocumented.
+:            no documentation is furnished, x controls what happens: If x
+:            isn't specified, autodoc.pl lists this in perlapi as existing and
+:           being undocumented; otherwise it simply isn't listed.
 :         makes '#define foo Perl_foo' scope not just for PERL_CORE/PERL_EXT
 :
 :      If the function is only exported for use in a public macro, see X.