Add comment to the top of most .c files explaining their purpose

p4raw-id: //depot/perl@23176

1 files changed, 10 insertions, 0 deletions

diff --git a/hv.c b/hv.c
index 502856ee71..d3b86edd41 100644
--- a/hv.c
+++ b/hv.c
@@ -14,6 +14,16 @@
 
 /* 
 =head1 Hash Manipulation Functions
+
+A HV structure represents a Perl hash. It consists mainly of an array
+of pointers, each of which points to a linked list of HE structures. The
+array is indexed by the hash function of the key, so each linked list
+represents all the hash entries with the same hash value. Each HE contains
+a pointer to the actual value, plus a pointer to a HEK structure which
+holds the key and hash value.
+
+=cut
+
 */
 
 #include "EXTERN.h"