summaryrefslogtreecommitdiff
path: root/pad.h
diff options
context:
space:
mode:
authorFather Chrysostomos <sprout@cpan.org>2013-10-30 16:54:06 -0700
committerFather Chrysostomos <sprout@cpan.org>2013-10-30 16:54:39 -0700
commit57ee99bb286d6d63dbe7471fdbfa7327c210eaa5 (patch)
tree3ff790ae9d85f1660ca9568db84cd5bd8e3854dc /pad.h
parent636eb14b5af56544a07c740d2a7698bd6c054a87 (diff)
downloadperl-57ee99bb286d6d63dbe7471fdbfa7327c210eaa5.tar.gz
pad.h: Correct PadlistMAX docs
They have been wrong since I added them.
Diffstat (limited to 'pad.h')
-rw-r--r--pad.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/pad.h b/pad.h
index 2558b7ed3e..32bdb6135f 100644
--- a/pad.h
+++ b/pad.h
@@ -179,7 +179,9 @@ The C array of a padlist, containing the pads. Only subscript it with
numbers >= 1, as the 0th entry is not guaranteed to remain usable.
=for apidoc Amx|SSize_t|PadlistMAX|PADLIST padlist
-The index of the last pad in the padlist.
+The index of the last allocated space in the padlist. Note that the last
+pad may be in an earlier slot. Any entries following it will be NULL in
+that case.
=for apidoc Amx|PADNAMELIST *|PadlistNAMES|PADLIST padlist
The names associated with pad entries.