Add docs for hv_ename_*
authorFather Chrysostomos <sprout@cpan.org>
Sat, 30 Oct 2010 05:17:44 +0000 (22:17 -0700)
committerFather Chrysostomos <sprout@cpan.org>
Sat, 30 Oct 2010 05:49:14 +0000 (22:49 -0700)
hv.c

diff --git a/hv.c b/hv.c
index 57efdaa455e1e83d11510e802b198662e558afb7..da8d76421dec9a7f3df3685c764312de1c47470b 100644 (file)
--- a/hv.c
+++ b/hv.c
@@ -2106,6 +2106,18 @@ Perl_hv_name_set(pTHX_ HV *hv, const char *name, U32 len, U32 flags)
     iter->xhv_name_count = 0;
 }
 
+/*
+=for apidoc hv_ename_add
+
+Adds a name to a stash's internal list of effective names. See
+C<hv_ename_delete>.
+
+This is called when a stash is assigned to a new location in the symbol
+table.
+
+=cut
+*/
+
 void
 Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len)
 {
@@ -2150,6 +2162,18 @@ Perl_hv_ename_add(pTHX_ HV *hv, const char *name, U32 len)
     }
 }
 
+/*
+=for apidoc hv_ename_delete
+
+Removes a name from a stash's internal list of effective names. If this is
+the name returned by C<HvENAME>, then another name in the list will take
+its place (C<HvENAME> will use it).
+
+This is called when a stash is deleted from the symbol table.
+
+=cut
+*/
+
 void
 Perl_hv_ename_delete(pTHX_ HV *hv, const char *name, U32 len)
 {