Skip to content

Commit 71b454d

Browse files
committed
perlapi: Consolidate CopLABEL* entries
Making these a single entry makes perlapi more concise.
1 parent c7c0c00 commit 71b454d

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

cop.h

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -636,19 +636,17 @@ be zero.
636636
cophh_2hv(CopHINTHASH_get(cop), flags)
637637

638638
/*
639-
=for apidoc Am|const char *|CopLABEL|COP *const cop
639+
=for apidoc Am|const char *|CopLABEL |COP *const cop
640+
=for apidoc_item|const char *|CopLABEL_len |COP *const cop|STRLEN *len
641+
=for apidoc_item|const char *|CopLABEL_len_flags|COP *const cop|STRLEN *len|U32 *flags
640642
641-
Returns the label attached to a cop.
643+
These return the label attached to a cop.
642644
643-
=for apidoc Am|const char *|CopLABEL_len|COP *const cop|STRLEN *len
645+
C<CopLABEL_len> and C<CopLABEL_len_flags> additionally store the number of
646+
bytes comprising the returned label into C<*len>.
644647
645-
Returns the label attached to a cop, and stores its length in bytes into
646-
C<*len>.
647-
648-
=for apidoc Am|const char *|CopLABEL_len_flags|COP *const cop|STRLEN *len|U32 *flags
649-
650-
Returns the label attached to a cop, and stores its length in bytes into
651-
C<*len>. Upon return, C<*flags> will be set to either C<SVf_UTF8> or 0.
648+
C<CopLABEL_len_flags> additionally returns the UTF-8ness of the returned label,
649+
by setting C<*flags> to 0 or C<SVf_UTF8>.
652650
653651
=cut
654652
*/

0 commit comments

Comments
 (0)