Miscellanous doc nits

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

diff --git a/lib/Test/Valgrind/Parser.pm b/lib/Test/Valgrind/Parser.pm
index e4b68b6392bc93ac2c0d1e83d4b9812bd73ef7f7..0f4985d3903a5c06a16fec83bfafb66f1a8746bb 100644 (file)
--- 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.02
+Version 1.10
 
 =cut
 
-our $VERSION = '1.02';
+our $VERSION = '1.10';
 
 =head1 DESCRIPTION
 
@@ -21,24 +21,25 @@ This class is the base for L<Test::Valgrind> parsers.
 
 =cut
 
-use base qw/Test::Valgrind::Carp/;
+use base qw/Test::Valgrind::Component Test::Valgrind::Carp/;
 
 =head1 METHODS
 
 =head2 C<new>
 
-=cut
+The parser constructor, called without arguments.
+
+Defaults to L<Test::Valgrind::Component/new>.
 
-sub new {
- my $class = shift;
- $class = ref($class) || $class;
+=head2 C<start $session>
 
- bless { }, $class;
-}
+Called when the C<$session> starts.
+
+Defaults to set L<Test::Valgrind::Component/started>.
 
 =head2 C<args $session, $fh>
 
-Returns the list of parser-specific arguments that are to be passed to C<valgrind>.
+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>.
 
 Defaults to the empty list.
 
@@ -48,15 +49,23 @@ sub args { }
 
 =head2 C<parse $session, $fh>
 
+Parse the output of the C<valgrind> process attached to the session C<$session> received through the filehandle C<$fh>.
+
 This method must be implemented when subclassing.
 
 =cut
 
 sub parse;
 
+=head2 C<finish $session>
+
+Called when the C<$session> finishes.
+
+Defaults to clear L<Test::Valgrind::Component/started>.
+
 =head1 SEE ALSO
 
-L<Test::Valgrind>, L<Test::Valgrind::Session>.
+L<Test::Valgrind>, L<Test::Valgrind::Component>, L<Test::Valgrind::Session>.
 
 =head1 AUTHOR