]> git.vpit.fr Git - perl/modules/Test-Valgrind.git/blobdiff - lib/Test/Valgrind/Action.pm
Make sure the POD headings are linkable
[perl/modules/Test-Valgrind.git] / lib / Test / Valgrind / Action.pm
index af23f094d36b37c51b6ed9b46c87066ac8018fc7..23c3ae1fe2dfac88b25db86210503e84576cd615 100644 (file)
@@ -27,7 +27,9 @@ use base qw<Test::Valgrind::Component Test::Valgrind::Carp>;
 
 =head1 METHODS
 
-=head2 C<< new action => $action >>
+=head2 C<new>
+
+    my $tva = Test::Valgrind::Action->new(action => $action);
 
 Creates a new action object of type C<$action> by requiring and redispatching the method call to the module named C<$action> if it contains C<'::'> or to C<Test::Valgrind::Action::$action> otherwise.
 The class represented by C<$action> must inherit this class.
@@ -60,13 +62,17 @@ Indicates if the action wants C<valgrind> to run in suppression-generating mode
 
 sub do_suppressions { 0 }
 
-=head2 C<start $session>
+=head2 C<start>
+
+    $tva->start($session);
 
 Called when the C<$session> starts.
 
 Defaults to set L<Test::Valgrind::Component/started>.
 
-=head2 C<report $session, $report>
+=head2 C<report>
+
+    $tva->report($session, $report);
 
 Invoked each time the C<valgrind> process attached to the C<$session> spots an error.
 C<$report> is a L<Test::Valgrind::Report> object describing the error.
@@ -83,7 +89,9 @@ sub report {
  return;
 }
 
-=head2 C<abort $session, $msg>
+=head2 C<abort>
+
+    $tva->abort($session, $msg);
 
 Triggered when the C<$session> has to interrupt the action.
 
@@ -93,13 +101,17 @@ Defaults to croak.
 
 sub abort { $_[0]->_croak($_[2]) }
 
-=head2 C<finish $session>
+=head2 C<finish>
+
+    $tva->finish($session);
 
 Called when the C<$session> finishes.
 
 Defaults to clear L<Test::Valgrind::Component/started>.
 
-=head2 C<status $session>
+=head2 C<status>
+
+    $tva->status($session);
 
 Returns the status code corresponding to the last run of the action.