Make sure the POD headings are linkable

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

diff --git a/lib/Test/Valgrind/Session.pm b/lib/Test/Valgrind/Session.pm
index 22a9129ebf728058d62cca6b7d6688faa8c32dd4..7964761af446495c0c8d9bbfdb243e812d3671f1 100644 (file)
--- a/lib/Test/Valgrind/Session.pm
+++ b/lib/Test/Valgrind/Session.pm
@@ -34,7 +34,16 @@ use base qw<Test::Valgrind::Carp>;
 
 =head1 METHODS
 
-=head2 C<< new search_dirs => \@search_dirs, valgrind => [ $valgrind | \@valgrind ], min_version => $min_version, no_def_supp => $no_def_supp, extra_supps => \@extra_supps >>
+=head2 C<new>
+
+    my $tvs = Test::Valgrind::Session->new(
+     search_dirs => \@search_dirs,
+     valgrind    => $valgrind,  # One candidate
+     valgrind    => \@valgrind, # Several candidates
+     min_version => $min_version,
+     no_def_supp => $no_def_supp,
+     extra_supps => \@extra_supps,
+    );
 
 The package constructor, which takes several options :
 
@@ -130,10 +139,14 @@ sub new {
 
 =head2 C<valgrind>
 
+    my $valgrind_path = $tvs->valgrind;
+
 The path to the selected C<valgrind> executable.
 
 =head2 C<version>
 
+    my $valgrind_version = $tvs->version;
+
 The L<version> object associated to the selected C<valgrind>.
 
 =cut
@@ -149,6 +162,8 @@ sub version {
 
 =head2 C<no_def_supp>
 
+    my $no_def_supp = $tvs->no_def_supp;
+
 Read-only accessor for the C<no_def_supp> option.
 
 =cut
@@ -157,13 +172,21 @@ eval "sub $_ { \$_[0]->{$_} }" for qw<valgrind no_def_supp>;
 
 =head2 C<extra_supps>
 
+    my @extra_supps = $tvs->extra_supps;
+
 Read-only accessor for the C<extra_supps> option.
 
 =cut
 
 sub extra_supps { @{$_[0]->{extra_supps} || []} }
 
-=head2 C<< run action => $action, tool => $tool, command => $command >>
+=head2 C<run>
+
+    $tvs->run(
+     action  => $action,
+     tool    => $tool,
+     command => $command,
+    );
 
 Runs the command C<$command> through C<valgrind> with the tool C<$tool>, which will report to the action C<$action>.
 
@@ -358,6 +381,8 @@ sub def_supp_file {
 
 =head2 C<suppressions>
 
+    my @suppressions = $tvs->suppressions;
+
 Returns the list of all the suppressions that will be passed to C<valgrind>.
 Honors L</no_def_supp> and L</extra_supps>.
 
@@ -378,6 +403,12 @@ sub suppressions {
 
 =head2 C<start>
 
+    $tvs->start(
+     action  => $action,
+     tool    => $tool,
+     command => $command,
+    );
+
 Starts the action and tool associated to the current run.
 It's automatically called at the beginning of L</run>.
 
@@ -405,7 +436,9 @@ sub start {
  return;
 }
 
-=head2 C<abort $msg>
+=head2 C<abort>
+
+    $tvs->abort($msg);
 
 Forwards to C<< ->action->abort >> after unshifting the session object to the argument list.
 
@@ -417,7 +450,9 @@ sub abort {
  $self->action->abort($self, @_);
 }
 
-=head2 C<report $report>
+=head2 C<report>
+
+    $tvs->report($report);
 
 Forwards to C<< ->action->report >> after unshifting the session object to the argument list.
 
@@ -438,6 +473,8 @@ sub report {
 
 =head2 C<finish>
 
+    $tvs->finish;
+
 Finishes the action and tool associated to the current run.
 It's automatically called at the end of L</run>.
 
@@ -462,6 +499,8 @@ sub finish {
 
 =head2 C<status>
 
+    my $status = $tvs->status;
+
 Returns the status code of the last run of the session.
 
 =cut