Add some description to Parrot::Pmc2c::PMC::Proxy

parrot · Aug 15, 2012 · 3f147ee · 3f147ee
1 parent 3451668
commit 3f147ee
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/Parrot/Pmc2c/PMC/Proxy.pm b/lib/Parrot/Pmc2c/PMC/Proxy.pm
@@ -6,6 +6,12 @@ Parrot::Pmc2c::PMC::Proxy
 
 =head1 DESCRIPTION
 
+The threading implementation uses Proxy PMCs to allow accessing other threads's data without
+confusing the GC. Almost all of it's methods are auto generated and this module is the recipie.
+The proxy refuses all write calls by forwarding to cant_do_write_method which raises an exception.
+Read only calls are forwarded to the proxied PMC. If the call returns a PMC a new proxy is
+generated for the result.
+
 Instance Methods
 
 =head1 METHODS