Make sure the POD headings are linkable

[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 0f87b2a30f047a85589ed6d6bb69478b9ca2d014..3e0dcbcb1b3b850ef019d1eeed52faac6e161ca0 100644 (file)
--- a/lib/Test/Valgrind/Command.pm
+++ b/lib/Test/Valgrind/Command.pm
@@ -28,7 +28,12 @@ use base qw<Test::Valgrind::Carp>;
 
 =head1 METHODS
 
 
 =head1 METHODS
 

-=head2 C<< new command => $command, args => \@args >>
+=head2 C<new>
+
+    my $tvc = Test::Valgrind::Command->new(
+     command => $command,
+     args    => \@args,
+    );

 
 Creates a new command object of type C<$command> by requiring and redispatching the method call to the module named C<$command> if it contains C<'::'> or to C<Test::Valgrind::Command::$command> otherwise.
 The class represented by C<$command> must inherit this class.
 
 Creates a new command object of type C<$command> by requiring and redispatching the method call to the module named C<$command> if it contains C<'::'> or to C<Test::Valgrind::Command::$command> otherwise.
 The class represented by C<$command> must inherit this class.


@@ -68,7 +73,9 @@ Defaults to return C<undef>, which skips suppression generation.
 
 sub new_trainer { }
 
 
 sub new_trainer { }
 

-=head2 C<args $session>
+=head2 C<args>
+
+    my @args = $tvc->args($session);

 
 Returns the list of command-specific arguments that are to be passed to C<valgrind>.
 
 
 Returns the list of command-specific arguments that are to be passed to C<valgrind>.
 


@@ -78,7 +85,9 @@ Defaults to return the contents of the C<args> option.
 
 sub args { @{$_[0]->{args} || []} }
 
 
 sub args { @{$_[0]->{args} || []} }
 

-=head2 C<env $session>
+=head2 C<env>
+
+    my $env = $tvc->env($session);

 
 This event is called in scalar context before the command is ran, and the returned value goes out of scope when the analysis ends.
 It's useful for e.g. setting up C<%ENV> for the child process by returning an L<Env::Sanctify> object, hence the name.
 
 This event is called in scalar context before the command is ran, and the returned value goes out of scope when the analysis ends.
 It's useful for e.g. setting up C<%ENV> for the child process by returning an L<Env::Sanctify> object, hence the name.


@@ -89,7 +98,9 @@ Defaults to void.
 
 sub env { }
 
 
 sub env { }
 

-=head2 C<suppressions_tag $session>
+=head2 C<suppressions_tag>
+
+    my $tag = $tvc->suppressions_tag($session);

 
 Returns a identifier that will be used to pick up the right suppressions for running the command, or C<undef> to indicate that no special suppressions are needed.
 
 
 Returns a identifier that will be used to pick up the right suppressions for running the command, or C<undef> to indicate that no special suppressions are needed.
 


@@ -99,7 +110,9 @@ This method must be implemented when subclassing.
 
 sub suppressions_tag;
 
 
 sub suppressions_tag;
 

-=head2 C<filter $session, $report>
+=head2 C<filter>
+
+    my $filtered_report = $tvc->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.
 
 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.