Store the exec callback into the private object

[perl/modules/re-engine-Plugin.git] / Plugin.pod

diff --git a/Plugin.pod b/Plugin.pod
index 76e8b3a7971423c35c7c1f010701aa4a2b73b21a..137199c10c43926c405946dadc26544a6a7065d6 100644 (file)
--- a/Plugin.pod
+++ b/Plugin.pod
@@ -19,12 +19,12 @@ C</pattern/> or runtime for C<qr//> patterns, or something inbetween
 depending on variable interpolation etc.
 
 When this module is loaded into a scope it inserts a hook into
-C<$^H{regcomp}> (as described in L<perlreapi>) to have each regexp
-constructed in its lexical scope handled by this engine, but it
-differs from other engines in that it also inserts other hooks into
-C<%^H> in the same scope that point to user-defined subroutines to use
-during compilation, execution etc, these are described in
-L</CALLBACKS> below.
+C<$^H{regcomp}> (as described in L<perlreapi> and L<perlpragma>) to
+have each regexp constructed in its lexical scope handled by this
+engine, but it differs from other engines in that it also inserts
+other hooks into C<%^H> in the same scope that point to user-defined
+subroutines to use during compilation, execution etc, these are
+described in L</CALLBACKS> below.
 
 The callbacks (e.g. L</comp>) then get called with a
 L<re::engine::Plugin> object as their first argument. This object
@@ -51,7 +51,7 @@ caller's scope use use the following snippet:
 
     sub import
     {
-        # Populates the caller's %^H with our callbacks
+        # Sets the caller's $^H{regcomp} his %^H with our callbacks
         re::engine::Plugin->import(
             comp => \&comp,
             exec => \&exec,
@@ -391,14 +391,18 @@ Please report any bugs that aren't already listed at
 L<http://rt.cpan.org/Dist/Display.html?Queue=re-engine-Plugin> to
 L<http://rt.cpan.org/Public/Bug/Report.html?Queue=re-engine-Plugin>
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-E<AElig>var ArnfjE<ouml>rE<eth> Bjarmason <avar@cpan.org>
+E<AElig>var ArnfjE<ouml>rE<eth> Bjarmason C<< <avar at cpan.org> >>
+
+Vincent Pit C<< <perl at profvince.com> >>
 
 =head1 LICENSE
 
 Copyright 2007-2008 E<AElig>var ArnfjE<ouml>rE<eth> Bjarmason.
 
+Copyright 2009 Vincent Pit.
+
 This program is free software; you can redistribute it and/or modify it
 under the same terms as Perl itself.