Put each POD sentence on its own line

[perl/modules/Test-Valgrind.git] / lib / Test / Valgrind / Command.pm

diff --git a/lib/Test/Valgrind/Command.pm b/lib/Test/Valgrind/Command.pm
index eb5a3476a2e83cc3cbc345dc1fc659b9ef89bc10..0f87b2a30f047a85589ed6d6bb69478b9ca2d014 100644 (file)
--- a/lib/Test/Valgrind/Command.pm
+++ b/lib/Test/Valgrind/Command.pm
@@ -9,21 +9,22 @@ Test::Valgrind::Command - Base class for Test::Valgrind commands.
 
 =head1 VERSION
 
-Version 1.01
+Version 1.13
 
 =cut
 
-our $VERSION = '1.01';
+our $VERSION = '1.13';
 
 =head1 DESCRIPTION
 
 This class is the base for L<Test::Valgrind> commands.
 
-Commands gather information about the target of the analysis. They should also provide a default setup for generating suppressions.
+Commands gather information about the target of the analysis.
+They should also provide a default setup for generating suppressions.
 
 =cut
 
-use base qw/Test::Valgrind::Carp/;
+use base qw<Test::Valgrind::Carp>;
 
 =head1 METHODS
 
@@ -98,6 +99,17 @@ This method must be implemented when subclassing.
 
 sub suppressions_tag;
 
+=head2 C<filter $session, $report>
+
+The C<$session> calls this method after receiving a report from the tool and before forwarding it to the action.
+You can either return a mangled C<$report> (which does not need to be a clone of the original) or C<undef> if you want the action to ignore it completely.
+
+Defaults to the identity function.
+
+=cut
+
+sub filter { $_[2] }
+
 =head1 SEE ALSO
 
 L<Test::Valgrind>, L<Test::Valgrind::Session>.
@@ -121,7 +133,7 @@ You can find documentation for this module with the perldoc command.
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2009 Vincent Pit, all rights reserved.
+Copyright 2009,2010,2011 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.