summaryrefslogtreecommitdiff
path: root/pad.c
diff options
context:
space:
mode:
authorDave Mitchell <davem@fdisolutions.com>2004-07-31 16:21:50 +0000
committerDave Mitchell <davem@fdisolutions.com>2004-07-31 16:21:50 +0000
commit166f8a29442475f7fe0e9216f957512a793bc4ed (patch)
tree8e8ad9e187566d63a5ce23b4a3f7591a036f3d69 /pad.c
parentd75b63cf816cfa51767ad10e3bdb7a0c01242457 (diff)
downloadperl-166f8a29442475f7fe0e9216f957512a793bc4ed.tar.gz
Add comment to the top of most .c files explaining their purpose
p4raw-id: //depot/perl@23176
Diffstat (limited to 'pad.c')
-rw-r--r--pad.c5
1 files changed, 5 insertions, 0 deletions
diff --git a/pad.c b/pad.c
index 8b5f86a03e..dc220f5f1b 100644
--- a/pad.c
+++ b/pad.c
@@ -22,6 +22,11 @@
/*
=head1 Pad Data Structures
+This file contains the functions that create and manipluate scratchpads,
+which are array-of-array data structures attached to a CV (ie a sub)
+and which store lexical variables and opcode temporay and per-thread
+values.
+
=for apidoc m|AV *|CvPADLIST|CV *cv
CV's can have CvPADLIST(cv) set to point to an AV.