This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add POD for AvARRAY.
authorFelipe Gasper <felipe@felipegasper.com>
Fri, 25 Sep 2020 12:57:02 +0000 (08:57 -0400)
committerℕicolas ℝ <nicolas@atoomic.org>
Tue, 29 Sep 2020 15:06:19 +0000 (09:06 -0600)
av.h

diff --git a/av.h b/av.h
index 56e2281..8466dc1 100644 (file)
--- a/av.h
+++ b/av.h
@@ -53,6 +53,12 @@ If the array C<av> is empty, this returns -1; otherwise it returns the maximum
 value of the indices of all the array elements which are currently defined in
 C<av>.  It does not handle magic, hence the C<p> private indication in its name.
 
+=for apidoc Am|SV**|AvARRAY|AV* av
+Returns a pointer to the AV's internal SV* array.
+
+This is useful for doing pointer arithmetic on the array.
+If all you need is to look up an array element, then prefer C<av_fetch>.
+
 =cut
 */