This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: Fix docs for 2 scope related macros
authorKarl Williamson <khw@cpan.org>
Thu, 13 Oct 2016 00:27:26 +0000 (18:27 -0600)
committerKarl Williamson <khw@cpan.org>
Thu, 13 Oct 2016 01:22:47 +0000 (19:22 -0600)
These 2 macros were using =item instead of =for apidoc, so they silently
were not included in perlapi.  This commit also changes  their
references to links.

scope.h

diff --git a/scope.h b/scope.h
index ad276a9..88c182d 100644 (file)
--- a/scope.h
+++ b/scope.h
@@ -167,20 +167,16 @@ Opening bracket on a callback.  See C<L</LEAVE>> and L<perlcall>.
 =for apidoc Ams||LEAVE
 Closing bracket on a callback.  See C<L</ENTER>> and L<perlcall>.
 
-=over
+=for apidoc Ams||ENTER_with_name(name)
 
-=item ENTER_with_name(name)
-
-Same as C<ENTER>, but when debugging is enabled it also associates the
+Same as C<L</ENTER>>, but when debugging is enabled it also associates the
 given literal string with the new scope.
 
-=item LEAVE_with_name(name)
+=for apidoc Ams||LEAVE_with_name(name)
 
-Same as C<LEAVE>, but when debugging is enabled it first checks that the
+Same as C<L</LEAVE>>, but when debugging is enabled it first checks that the
 scope has the given name. C<name> must be a C<NUL>-terminated literal string.
 
-=back
-
 =cut
 */