This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document AvFILLp; clarify related entries
[perl5.git] / av.h
diff --git a/av.h b/av.h
index d7281e8..56e2281 100644 (file)
--- a/av.h
+++ b/av.h
@@ -44,13 +44,14 @@ Null AV pointer.
 
 (deprecated - use C<(AV *)NULL> instead)
 
-=for apidoc Am|int|AvFILL|AV* av
-Same as C<av_top_index()> or C<av_tindex()>.
+=for apidoc Am|SSize_t|AvFILL|AV* av
+Same as C<L</av_top_index>> or C<L</av_tindex>>.
 
-=for apidoc av_tindex
-Same as C<av_top_index()>.
+=for apidoc Cm|SSize_t|AvFILLp|AV* av
 
-=for apidoc m|int|AvFILLp|AV* av
+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.
 
 =cut
 */