From: Jesse Luehrs <doy@tozt.net>
Date: Sun, 14 Nov 2010 20:53:44 +0000 (-0600)
Subject: document get_all_symbols
X-Git-Tag: 0.14~4
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=1156452d1223901f0d17c629f7e721f036231f12;p=gitmo%2FPackage-Stash-XS.git

document get_all_symbols
---

diff --git a/lib/Package/Stash.pm b/lib/Package/Stash.pm
index 5811d7e..f31ebc1 100644
--- a/lib/Package/Stash.pm
+++ b/lib/Package/Stash.pm
@@ -148,6 +148,13 @@ etc). Note that if the package contained any C<BEGIN> blocks, perl will leave
 an empty typeglob in the C<BEGIN> slot, so this will show up if no filter is
 used (and similarly for C<INIT>, C<END>, etc).
 
+=method get_all_symbols $type_filter
+
+Returns a hashref, keyed by the variable names in the package. If
+C<$type_filter> is passed, the hash will contain every variable of that type in
+the package as values, otherwise, it will contain the typeglobs corresponding
+to the variable names (basically, a clone of the stash).
+
 =head1 BUGS
 
 No known bugs.