summaryrefslogtreecommitdiff
path: root/av.h
diff options
context:
space:
mode:
authorFelipe Gasper <felipe@felipegasper.com>2020-09-25 08:57:02 -0400
committerℕicolas ℝ <nicolas@atoomic.org>2020-09-29 09:06:19 -0600
commit941f2f38259a2fa17ca703554d5158c5435d7fc5 (patch)
treeb86684c33527ce9cb96adeed894383b345846945 /av.h
parent097ac3f8d72c31cfde2f68c417ec54ada7e055fc (diff)
downloadperl-941f2f38259a2fa17ca703554d5158c5435d7fc5.tar.gz
Add POD for AvARRAY.
Diffstat (limited to 'av.h')
-rw-r--r--av.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/av.h b/av.h
index 56e22818bf..8466dc17f4 100644
--- 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
*/