diff options
| author | Karl Williamson <khw@cpan.org> | 2022-05-01 10:07:07 -0600 |
|---|---|---|
| committer | Karl Williamson <khw@cpan.org> | 2022-05-08 08:25:22 -0600 |
| commit | 71b454dc73b0aa829699af6ec5991620565c3a43 (patch) | |
| tree | 68b8b95ac3e8d7fb1103a37c75f8ff35fbe32983 /cop.h | |
| parent | c7c0c00cb7591609820973b56b463c7161043810 (diff) | |
| download | perl-71b454dc73b0aa829699af6ec5991620565c3a43.tar.gz | |
perlapi: Consolidate CopLABEL* entries
Making these a single entry makes perlapi more concise.
Diffstat (limited to 'cop.h')
| -rw-r--r-- | cop.h | 18 |
1 files changed, 8 insertions, 10 deletions
@@ -636,19 +636,17 @@ be zero. cophh_2hv(CopHINTHASH_get(cop), flags) /* -=for apidoc Am|const char *|CopLABEL|COP *const cop +=for apidoc Am|const char *|CopLABEL |COP *const cop +=for apidoc_item|const char *|CopLABEL_len |COP *const cop|STRLEN *len +=for apidoc_item|const char *|CopLABEL_len_flags|COP *const cop|STRLEN *len|U32 *flags -Returns the label attached to a cop. +These return the label attached to a cop. -=for apidoc Am|const char *|CopLABEL_len|COP *const cop|STRLEN *len +C<CopLABEL_len> and C<CopLABEL_len_flags> additionally store the number of +bytes comprising the returned label into C<*len>. -Returns the label attached to a cop, and stores its length in bytes into -C<*len>. - -=for apidoc Am|const char *|CopLABEL_len_flags|COP *const cop|STRLEN *len|U32 *flags - -Returns the label attached to a cop, and stores its length in bytes into -C<*len>. Upon return, C<*flags> will be set to either C<SVf_UTF8> or 0. +C<CopLABEL_len_flags> additionally returns the UTF-8ness of the returned label, +by setting C<*flags> to 0 or C<SVf_UTF8>. =cut */ |