From: Vincent Pit <vince@profvince.com>
Date: Sat, 26 Sep 2009 09:27:04 +0000 (+0200)
Subject: Complete POD coverage
X-Git-Tag: v1.11~12
X-Git-Url: http://git.vpit.fr/?a=commitdiff_plain;h=d44c95e8e9820ee69e76506bde7c2c5fbe37b568;p=perl%2Fmodules%2FTest-Valgrind.git

Complete POD coverage
---

diff --git a/lib/Test/Valgrind.pm b/lib/Test/Valgrind.pm
index ea43703..c76ce60 100644
--- a/lib/Test/Valgrind.pm
+++ b/lib/Test/Valgrind.pm
@@ -308,14 +308,14 @@ What your tests output to C<STDOUT> and C<STDERR> is eaten unless you pass the C
 
 =head1 DEPENDENCIES
 
-Valgrind 3.1.0 (L<http://valgrind.org>).
-
 L<XML::Twig>, L<version>, L<File::HomeDir>, L<Env::Sanctify>, L<Perl::Destruct::Level>.
 
 =head1 SEE ALSO
 
 All the C<Test::Valgrind::*> API, including L<Test::Valgrind::Command>, L<Test::Valgrind::Tool>, L<Test::Valgrind::Action> and L<Test::Valgrind::Session>.
 
+The C<valgrind(1)> man page.
+
 L<Test::LeakTrace>.
 
 L<Devel::Leak>, L<Devel::LeakTrace>, L<Devel::LeakTrace::Fast>.
diff --git a/lib/Test/Valgrind/Parser/XML/Twig.pm b/lib/Test/Valgrind/Parser/XML/Twig.pm
index bc0df39..f3e268f 100644
--- a/lib/Test/Valgrind/Parser/XML/Twig.pm
+++ b/lib/Test/Valgrind/Parser/XML/Twig.pm
@@ -3,6 +3,16 @@ package Test::Valgrind::Parser::XML::Twig;
 use strict;
 use warnings;
 
+=head1 NAME
+
+Test::Valgrind::Parser::XML::Twig - Parse valgrind XML output with XML::Twig.
+
+=head1 VERSION
+
+Version 1.10
+
+=cut
+
 our $VERSION = '1.10';
 
 use Scalar::Util ();
@@ -16,6 +26,10 @@ my %handlers = (
  '/valgrindoutput/error'           => \&handle_error,
 );
 
+=head1 METHODS
+
+=cut
+
 sub new {
  my $class = shift;
  $class = ref($class) || $class;
@@ -33,6 +47,12 @@ sub new {
 
 sub stash { shift->{Stash} }
 
+=head2 C<protocol_version>
+
+The version of the protocol that the stream is currently conforming to.
+
+=cut
+
 eval "sub $_ { \@_ <= 1 ? \$_[0]->{$_} : (\$_[0]->{$_} = \$_[1]) }"
                                               for qw/_session protocol_version/;
 
@@ -123,6 +143,37 @@ sub handle_error {
  $twig->purge;
 }
 
+=head1 SEE ALSO
+
+L<Test::Valgrind>, L<Test::Valgrind::Parser>, L<Test::Valgrind::Parser::XML>.
+
+L<XML::Twig>.
+
+=head1 AUTHOR
+
+Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
+
+You can contact me by mail or on C<irc.perl.org> (vincent).
+
+=head1 BUGS
+
+Please report any bugs or feature requests to C<bug-test-valgrind at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Valgrind>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
+
+=head1 SUPPORT
+
+You can find documentation for this module with the perldoc command.
+
+    perldoc Test::Valgrind::Parser::XML::Twig
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright 2009 Vincent Pit, all rights reserved.
+
+This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
+
+=cut
+
 # End of Test::Valgrind::Parser::XML::Twig
 
 package Test::Valgrind::Parser::XML::Twig::Elt;
diff --git a/lib/Test/Valgrind/Tool/memcheck.pm b/lib/Test/Valgrind/Tool/memcheck.pm
index c1ec7e1..1213b7b 100644
--- a/lib/Test/Valgrind/Tool/memcheck.pm
+++ b/lib/Test/Valgrind/Tool/memcheck.pm
@@ -17,7 +17,7 @@ our $VERSION = '1.10';
 
 =head1 DESCRIPTION
 
-This tool parses the XML output of a C<memcheck> run with L<XML::Twig>.
+This class contains the information required by the session for running the C<memcheck> tool.
 
 =cut
 
@@ -130,8 +130,6 @@ sub args {
 
 L<Test::Valgrind>, L<Test::Valgrind::Tool>.
 
-L<XML::Twig>.
-
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
diff --git a/t/92-pod-coverage.t b/t/92-pod-coverage.t
index 79ffd62..a225486 100644
--- a/t/92-pod-coverage.t
+++ b/t/92-pod-coverage.t
@@ -18,7 +18,7 @@ plan skip_all => "Pod::Coverage $min_pc required for testing POD coverage" if $@
 
 my $trustparents = { coverage_class => 'Pod::Coverage::CountParents' };
 
-plan tests => 16;
+plan tests => 21;
 
 pod_coverage_ok('Test::Valgrind');
 
@@ -34,7 +34,16 @@ pod_coverage_ok('Test::Valgrind::Command::Aggregate', $trustparents);
 pod_coverage_ok('Test::Valgrind::Command::Perl', $trustparents);
 pod_coverage_ok('Test::Valgrind::Command::PerlScript', $trustparents);
 
-pod_coverage_ok('Test::Valgrind::Parser::Suppressions::Text');
+pod_coverage_ok('Test::Valgrind::Component');
+
+pod_coverage_ok('Test::Valgrind::Parser');
+pod_coverage_ok('Test::Valgrind::Parser::Suppressions::Text', $trustparents);
+pod_coverage_ok('Test::Valgrind::Parser::Text', $trustparents);
+pod_coverage_ok('Test::Valgrind::Parser::XML', $trustparents);
+pod_coverage_ok('Test::Valgrind::Parser::XML::Twig', {
+ %$trustparents,
+ also_private => [ qr/^handle_/, qw/stash/ ],
+});
 
 pod_coverage_ok('Test::Valgrind::Report');
 pod_coverage_ok('Test::Valgrind::Session');