This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: Document memEQs memNEs
authorKarl Williamson <khw@cpan.org>
Mon, 5 Aug 2019 00:26:16 +0000 (18:26 -0600)
committerKarl Williamson <khw@cpan.org>
Tue, 3 Sep 2019 03:52:10 +0000 (21:52 -0600)
handy.h

diff --git a/handy.h b/handy.h
index e2fb0aa..f7ca930 100644 (file)
--- a/handy.h
+++ b/handy.h
@@ -455,11 +455,21 @@ Test two buffers (which may contain embedded C<NUL> characters, to see if they
 are equal.  The C<len> parameter indicates the number of bytes to compare.
 Returns zero if equal, or non-zero if non-equal.
 
+=for apidoc Am|bool|memEQs|char* s1|STRLEN l1|"literal string" s2
+Like L</memEQ>, but the second string is a literal enclosed in double quotes,
+C<l1> gives the number of bytes in C<s1>.
+Returns zero if equal, or non-zero if non-equal.
+
 =for apidoc Am|bool|memNE|char* s1|char* s2|STRLEN len
 Test two buffers (which may contain embedded C<NUL> characters, to see if they
 are not equal.  The C<len> parameter indicates the number of bytes to compare.
 Returns zero if non-equal, or non-zero if equal.
 
+=for apidoc Am|bool|memNEs|char* s1|STRLEN l1|"literal string" s2
+Like L</memNE>, but the second string is a literal enclosed in double quotes,
+C<l1> gives the number of bytes in C<s1>.
+Returns zero if non-equal, or zero if non-equal.
+
 =cut
 
 New macros should use the following conventions for their names (which are