X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FTest%2FValgrind%2FParser.pm;h=c051e628bbeca9699765ef422faf183f19e5c536;hb=f2071d95aaaa4817e91cc33530deedc8d701d44d;hp=4a07478cd8e4eff1e0556e8850b8260379f471bd;hpb=195f0244c01e942307e13d693f196156b9263444;p=perl%2Fmodules%2FTest-Valgrind.git

diff --git a/lib/Test/Valgrind/Parser.pm b/lib/Test/Valgrind/Parser.pm
index 4a07478..c051e62 100644
--- a/lib/Test/Valgrind/Parser.pm
+++ b/lib/Test/Valgrind/Parser.pm
@@ -9,11 +9,11 @@ Test::Valgrind::Parser - Base class for Test::Valgrind parsers.
 
 =head1 VERSION
 
-Version 1.11
+Version 1.19
 
 =cut
 
-our $VERSION = '1.11';
+our $VERSION = '1.19';
 
 =head1 DESCRIPTION
 
@@ -21,23 +21,29 @@ This class is the base for L<Test::Valgrind> parsers.
 
 =cut
 
-use base qw/Test::Valgrind::Component Test::Valgrind::Carp/;
+use base qw<Test::Valgrind::Component Test::Valgrind::Carp>;
 
 =head1 METHODS
 
 =head2 C<new>
 
+    my $tvp = Test::Valgrind::Parser->new;
+
 The parser constructor, called without arguments.
 
 Defaults to L<Test::Valgrind::Component/new>.
 
-=head2 C<start $session>
+=head2 C<start>
+
+    $tvp->start($session);
 
 Called when the C<$session> starts.
 
 Defaults to set L<Test::Valgrind::Component/started>.
 
-=head2 C<args $session, $fh>
+=head2 C<args>
+
+    my @args = $tvp->args($session, $fh);
 
 Returns the list of parser-specific arguments that are to be passed to the C<valgrind> process spawned by the session C<$session> and whose output will be captured by the filehandle C<$fh>.
 
@@ -47,9 +53,12 @@ Defaults to the empty list.
 
 sub args { }
 
-=head2 C<parse $session, $fh>
+=head2 C<parse>
 
-Parse the output of the C<valgrind> process attached to the session C<$session> received through the filehandle C<$fh>.
+    my $aborted = $tvp->parse($session, $fh);
+
+Parses the output of the C<valgrind> process attached to the session C<$session> received through the filehandle C<$fh>.
+Returns true when the output indicates that C<valgrind> has aborted.
 
 This method must be implemented when subclassing.
 
@@ -57,7 +66,9 @@ This method must be implemented when subclassing.
 
 sub parse;
 
-=head2 C<finish $session>
+=head2 C<finish>
+
+    $tvp->finish($session);
 
 Called when the C<$session> finishes.
 
@@ -86,7 +97,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,2013,2015,2016 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.