This is 0.05

[perl/modules/Thread-Cleanup.git] / lib / Thread / Cleanup.pm

diff --git a/lib/Thread/Cleanup.pm b/lib/Thread/Cleanup.pm
index f7f815b60e7192b45ff3b3aa091056ece88280a6..ebb424ee67941871692ee4644bb5c5beb0d54e5d 100644 (file)
--- a/lib/Thread/Cleanup.pm
+++ b/lib/Thread/Cleanup.pm
@@ -11,14 +11,14 @@ Thread::Cleanup - Hook thread destruction.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.05
 
 =cut
 
 our $VERSION;
 
 BEGIN {
- $VERSION = '0.01';
+ $VERSION = '0.05';
  require XSLoader;
  XSLoader::load(__PACKAGE__, $VERSION);
 }
@@ -42,24 +42,27 @@ It acts globally on all the threads that may spawn anywhere in your program, wit
 
 =head1 FUNCTIONS
 
-=head2 C<register BLOCK>
+=head2 C<register>
 
-Specify that the C<BLOCK> will have to be called (in void context, without arguments) every time a thread finishes is job.
+    register { ... };
+    &register($coderef);
+
+Specify that the given block or code reference C<$coderef> will have to be called (in void context, without arguments) every time a thread finishes its job.
 More precisely,
 
 =over 4
 
 =item *
 
-it will always be called before the join for joined threads ;
+it will always be called before the joining for joined threads ;
 
 =item *
 
-it will be called for detached threads only if they terminate before the main thread, and the hook will then fire at C<END> time ;
+it will be called for detached threads if and only if they terminate before the main thread, and the hook will then fire at C<END> time ;
 
 =item *
 
-it won't trigger for the the destruction of the main thread.
+it won't trigger for the destruction of the main thread.
 
 =back
 
@@ -77,11 +80,14 @@ None.
 
 =head1 DEPENDENCIES
 
-C<perl> 5.8.
+L<perl> 5.8.
+
+A C compiler.
+This module may happen to build with a C++ compiler as well, but don't rely on it, as no guarantee is made in this regard.
 
-C<threads> 1.07.
+L<threads> 1.07.
 
-C<XSLoader>.
+L<XSLoader>.
 
 =head1 AUTHOR
 
@@ -103,7 +109,7 @@ Inspired by a question from TonyC on #p5p.
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2009 Vincent Pit, all rights reserved.
+Copyright 2009,2010,2013 Vincent Pit, all rights reserved.
 
 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.