From: Vincent Pit <vince@profvince.com>
Date: Sat, 26 Sep 2009 19:56:31 +0000 (+0200)
Subject: Add a DESCRIPTION to all modules
X-Git-Tag: v1.11~8
X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2FTest-Valgrind.git;a=commitdiff_plain;h=18be4c50c41cc9ee118fddc26d73ebf428a83080

Add a DESCRIPTION to all modules
---

diff --git a/lib/Test/Valgrind/Carp.pm b/lib/Test/Valgrind/Carp.pm
index c4db130..2d1cdfc 100644
--- a/lib/Test/Valgrind/Carp.pm
+++ b/lib/Test/Valgrind/Carp.pm
@@ -15,6 +15,14 @@ Version 1.10
 
 our $VERSION = '1.10';
 
+=head1 DESCRIPTION
+
+This class only provides a C<_croak> method that lazily requires L<Carp> and then croaks with the supplied message.
+
+The class should not be used outside from L<Test::Valgrind> and may be removed without notice.
+
+=cut
+
 sub _croak {
  shift;
  require Carp;
diff --git a/lib/Test/Valgrind/Component.pm b/lib/Test/Valgrind/Component.pm
index ed212b9..5c7dae3 100644
--- a/lib/Test/Valgrind/Component.pm
+++ b/lib/Test/Valgrind/Component.pm
@@ -15,6 +15,12 @@ Version 1.10
 
 our $VERSION = '1.10';
 
+=head1 DESCRIPTION
+
+This class is the base for all others that act as components that can be started and stopped.
+
+=cut
+
 use Scalar::Util ();
 
 use base qw/Test::Valgrind::Carp/;
diff --git a/lib/Test/Valgrind/Parser/XML/Twig.pm b/lib/Test/Valgrind/Parser/XML/Twig.pm
index ff72c30..09311db 100644
--- a/lib/Test/Valgrind/Parser/XML/Twig.pm
+++ b/lib/Test/Valgrind/Parser/XML/Twig.pm
@@ -15,6 +15,13 @@ Version 1.10
 
 our $VERSION = '1.10';
 
+=head1 DESCRIPTION
+
+This subclass of L<XML::Twig> 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
+
 use Scalar::Util ();
 
 use base qw/Test::Valgrind::Parser::XML Test::Valgrind::Carp XML::Twig/;
@@ -49,7 +56,7 @@ sub stash { shift->{Stash} }
 
 =head2 C<protocol_version>
 
-The version of the protocol that the stream is currently conforming to.
+The version of the protocol that the current stream is conforming to.
 It is reset before and after the parsing phase, so it's effectively only available from inside L</parse>.
 
 =cut
diff --git a/lib/Test/Valgrind/Report.pm b/lib/Test/Valgrind/Report.pm
index 9331cec..e0d5b28 100644
--- a/lib/Test/Valgrind/Report.pm
+++ b/lib/Test/Valgrind/Report.pm
@@ -15,6 +15,16 @@ Version 1.10
 
 our $VERSION = '1.10';
 
+=head1 DESCRIPTION
+
+This class provides a generic API for messages (the so-called I<reports>) generated by the parser, filtered by the tool and the command, and handled by the action.
+The tool has authority for deciding in which subclass of this one reports should be blessed.
+
+Reports are classified by I<kinds>.
+The C<Diag> kind is reserved for diagnostics.
+
+=cut
+
 use base qw/Test::Valgrind::Carp/;
 
 =head2 C<< new kind => $kind, id => $id, data => $data >>
@@ -65,7 +75,7 @@ sub new {
 
 =head2 C<< new_diag $data >>
 
-Constructs an object with kind C<'Diag'>, an auto-incremented identifier and the given C<$data>.
+Constructs a report with kind C<'Diag'>, an auto-incremented identifier and the given C<$data>.
 
 =cut