This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perl5337delta: note that stadtx was removed
[perl5.git] / av.h
diff --git a/av.h b/av.h
index 56e2281..41cb6fe 100644 (file)
--- a/av.h
+++ b/av.h
@@ -37,8 +37,6 @@ struct xpvav {
  */
 
 /*
-=for apidoc_section AV Handling
-
 =for apidoc ADmnU||Nullav
 Null AV pointer.
 
@@ -53,6 +51,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
 */
 
@@ -79,7 +83,7 @@ C<av>.  It does not handle magic, hence the C<p> private indication in its name.
 #define AvREALISH(av)  (SvFLAGS(av) & (SVpav_REAL|SVpav_REIFY))
                                           
 #define AvFILL(av)     ((SvRMAGICAL((const SV *) (av))) \
-                        ? mg_size(MUTABLE_SV(av)) : AvFILLp(av))
+                         ? mg_size(MUTABLE_SV(av)) : AvFILLp(av))
 #define av_top_index(av) AvFILL(av)
 #define av_tindex(av)    av_top_index(av)