Document the diagnostics

[perl/modules/indirect.git] / lib / indirect.pm

diff --git a/lib/indirect.pm b/lib/indirect.pm
index af8d4f7a8c71efaacbbc40e5ee60ae42fed3be68..f793a831a8d549306976c653f032bc70c5d4a36b 100644 (file)
--- a/lib/indirect.pm
+++ b/lib/indirect.pm
@@ -33,6 +33,8 @@ BEGIN {
       my $z = new Pineapple 'fresh'; # croaks 'You really wanted Pineapple->new at blurp.pm:13'
      }
     }
+    try { ... }; # warns
+
     no indirect ':fatal';
     if (defied $foo) { ... } # croaks, note the typo
 
@@ -76,7 +78,8 @@ If it's the string C<':fatal'>, the compilation will croak on the first indirect
 
 =item *
 
-If the key/value pair C<< hook => $hook >> comes first, C<$hook> will be called for each error with the object name as C<$_[0]>, the method name as C<$_[1]>, the current file as C<$_[2]> and the line number as C<$_[3]>.
+If the key/value pair C<< hook => $hook >> comes first, C<$hook> will be called for each error with a string representation of the object as C<$_[0]>, the method name as C<$_[1]>, the current file as C<$_[2]> and the line number as C<$_[3]>.
+If and only if the object is actually a block, C<$_[0]> is assured to start by C<'{'>.
 
 =item *
 
@@ -140,6 +143,16 @@ sub msg {
 
 True iff the module could have been built with thread-safety features enabled.
 
+=head1 DIAGNOSTICS
+
+=head2 C<Indirect call of method "%s" on object "%s" at %s line %d.>
+
+The default warning/exception message thrown when an indirect call on an object is found.
+
+=head2 C<Indirect call of method "%s" on a block at %s line %d.>
+
+The default warning/exception message thrown when an indirect call on a block is found.
+
 =head1 CAVEATS
 
 The implementation was tweaked to work around several limitations of vanilla C<perl> pragmas : it's thread safe, and doesn't suffer from a C<perl 5.8.x-5.10.0> bug that causes all pragmas to propagate into C<require>d scopes.
@@ -178,6 +191,8 @@ Tests code coverage report is available at L<http://www.profvince.com/perl/cover
 
 Bram, for motivation and advices.
 
+Andrew Main and Florian Ragwitz, for testing on real-life code and reporting issues.
+
 =head1 COPYRIGHT & LICENSE
 
 Copyright 2008-2009 Vincent Pit, all rights reserved.