Miscellanous doc nits

diff --git a/lib/Test/Valgrind/Command.pm b/lib/Test/Valgrind/Command.pm
index 2afa4b03695ad8b063b7e1ac0d20e35081bdd47f..158d4a3ecec275e4fba394a15700179213c14c1a 100644 (file)
--- a/lib/Test/Valgrind/Command.pm
+++ b/lib/Test/Valgrind/Command.pm
@@ -100,7 +100,7 @@ sub suppressions_tag;
 
 =head2 C<filter $session, $report>
 
 
 =head2 C<filter $session, $report>
 

-The <$session> calls this method after receiving a report from the tool and before forwarding it to the action.
+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.
 
 Defaults to the identity function.
 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.
 
 Defaults to the identity function.

diff --git a/lib/Test/Valgrind/Parser.pm b/lib/Test/Valgrind/Parser.pm
index 3489ae56c17bc5794fe0c26fa27e574fa67f1914..0f4985d3903a5c06a16fec83bfafb66f1a8746bb 100644 (file)
--- a/lib/Test/Valgrind/Parser.pm
+++ b/lib/Test/Valgrind/Parser.pm
@@ -31,9 +31,15 @@ The parser constructor, called without arguments.
 
 Defaults to L<Test::Valgrind::Component/new>.
 
 
 Defaults to L<Test::Valgrind::Component/new>.
 

+=head2 C<start $session>
+
+Called when the C<$session> starts.
+
+Defaults to set L<Test::Valgrind::Component/started>.
+

 =head2 C<args $session, $fh>
 
 =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.
 
 
 Defaults to the empty list.
 


@@ -43,18 +49,14 @@ sub args { }
 
 =head2 C<parse $session, $fh>
 
 
 =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;
 
 This method must be implemented when subclassing.
 
 =cut
 
 sub parse;
 

-=head2 C<start $session>
-
-Called when the C<$session> starts.
-
-Defaults to set L<Test::Valgrind::Component/started>.
-

 =head2 C<finish $session>
 
 Called when the C<$session> finishes.
 =head2 C<finish $session>
 
 Called when the C<$session> finishes.

diff --git a/lib/Test/Valgrind/Parser/Suppressions/Text.pm b/lib/Test/Valgrind/Parser/Suppressions/Text.pm
index 03a9556a1dc070477511c088ca439788a93dea6e..7a91d5fa80411d691845beef0abdb2a04eef7fa2 100644 (file)
--- a/lib/Test/Valgrind/Parser/Suppressions/Text.pm
+++ b/lib/Test/Valgrind/Parser/Suppressions/Text.pm
@@ -17,7 +17,7 @@ our $VERSION = '1.10';
 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 

-This is a L<Test::Valgrind::Parser> object that can extract suppressions from C<valgrind>'s text output.
+This is a L<Test::Valgrind::Parser::Text> object that can extract suppressions from C<valgrind>'s text output.

 
 =cut
 
 
 =cut
 


@@ -34,12 +34,6 @@ Their C<data> member contains the raw text of the suppression.
 
 sub report_class { 'Test::Valgrind::Report::Suppressions' }
 
 
 sub report_class { 'Test::Valgrind::Report::Suppressions' }
 

-=head2 C<parse $session, $fh>
-
-Parses the filehandle C<$fh> fed with the output of F<valgrind --gen-suppressions=all> and sends a report to the session C<$session> for each suppression.
-
-=cut
-

 sub parse {
  my ($self, $sess, $fh) = @_;
 
 sub parse {
  my ($self, $sess, $fh) = @_;
 

diff --git a/lib/Test/Valgrind/Parser/Text.pm b/lib/Test/Valgrind/Parser/Text.pm
index 81c8f70c2e763452916164f620bf878d2cd5ad24..0fb3ab6f23eb1bc23b3cba632c38a018b9680a71 100644 (file)
--- a/lib/Test/Valgrind/Parser/Text.pm
+++ b/lib/Test/Valgrind/Parser/Text.pm
@@ -27,7 +27,7 @@ use base qw/Test::Valgrind::Parser/;
 
 =head2 C<args $session, $fh>
 
 
 =head2 C<args $session, $fh>
 

-Returns the arguments needed to tell C<valgrind> to print to the filehandle C<$fh>.
+Returns the arguments needed to tell C<valgrind> to print in text to the filehandle C<$fh>.

 
 =cut
 
 
 =cut
 

diff --git a/lib/Test/Valgrind/Parser/XML/Twig.pm b/lib/Test/Valgrind/Parser/XML/Twig.pm
index 09311dbc49c8c43ed7c96a0a1e951ecee8004a6c..7d5bf66e01c91029a1e836892ed9647d49983b53 100644 (file)
--- a/lib/Test/Valgrind/Parser/XML/Twig.pm
+++ b/lib/Test/Valgrind/Parser/XML/Twig.pm
@@ -17,7 +17,7 @@ our $VERSION = '1.10';
 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 

-This subclass of L<XML::Twig> encapsulates an L<XML::Twig> parser inside the L<Test::Valgrind::Parser> framework.
+This subclass of L<XML::Twig> and L<Test::Valgrind::Parser::XML> encapsulates an L<XML::Twig> parser inside the L<Test::Valgrind::Parser> framework.

 It is able to parse the XML output from C<valgrind> up to protocol version 4 and to generate the appropriate reports accordingly.
 
 =cut
 It is able to parse the XML output from C<valgrind> up to protocol version 4 and to generate the appropriate reports accordingly.
 
 =cut

diff --git a/lib/Test/Valgrind/Tool.pm b/lib/Test/Valgrind/Tool.pm
index 7560d52217e64663a11af909a9102c1ac70ae934..7e0e7126edbf536104b7f90d703bbe7c671c330d 100644 (file)
--- a/lib/Test/Valgrind/Tool.pm
+++ b/lib/Test/Valgrind/Tool.pm
@@ -120,7 +120,7 @@ Defaults to set L<Test::Valgrind::Component/started>.
 
 =head2 C<filter $session, $report>
 
 
 =head2 C<filter $session, $report>
 

-The <$session> calls this method after receiving a report from the parser and before letting the command filter it.
+The C<$session> calls this method after receiving a report from the parser and before letting the command filter it.

 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.
 
 Defaults to the identity function.
 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.
 
 Defaults to the identity function.

diff --git a/lib/Test/Valgrind/Tool/memcheck.pm b/lib/Test/Valgrind/Tool/memcheck.pm
index 1213b7b29c71d8c365649e762c397aed15a92ed9..3600937dcdaa4cb9520f5fc99f43e0f138e6d0a0 100644 (file)
--- a/lib/Test/Valgrind/Tool/memcheck.pm
+++ b/lib/Test/Valgrind/Tool/memcheck.pm
@@ -75,7 +75,7 @@ sub suppressions_tag { 'memcheck-' . $_[1]->version }
 
 =head2 C<parser_class $session>
 
 
 =head2 C<parser_class $session>
 

-This tool uses a C<Test::Valgrind::Parser::XML::Twig> parser in analysis mode, and a C<Test::Valgrind::Parser::Suppressions::Text> parser in suppressions mode.
+This tool uses a L<Test::Valgrind::Parser::XML::Twig> parser in analysis mode, and a L<Test::Valgrind::Parser::Suppressions::Text> parser in suppressions mode.

 
 =cut
 
 
 =cut
 


@@ -94,7 +94,7 @@ sub parser_class {
 
 =head2 C<report_class $session>
 
 
 =head2 C<report_class $session>
 

-This tool emits C<Test::Valgrind::Tool::memcheck::Report> object reports in analysis mode.
+This tool emits C<Test::Valgrind::Tool::memcheck::Report> object reports in analysis mode, and C<Test::Valgrind::Report::Suppressions> object reports in suppressions mode.

 
 =cut
 
 
 =cut