Add a DESCRIPTION to all modules

diff --git a/lib/Test/Valgrind/Carp.pm b/lib/Test/Valgrind/Carp.pm
index c4db1307a62da132bcb2586438e19dc3b4988871..2d1cdfc64d446fcb1a249abc862521ebde3f841a 100644 (file)
--- 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 ed212b9700729a0e41099a1f3edaf940ae8a7ef2..5c7dae36a97c55710ef9c970b6f1a7a006c2a0ec 100644 (file)
--- 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 ff72c3064476c5cf57bdb74ca864878ff38831dd..09311dbc49c8c43ed7c96a0a1e951ecee8004a6c 100644 (file)
--- 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 9331cec30952aa0b0dcb30e3a43a1ff7ad739a26..e0d5b286612dc7279e252b74f75c376083c8d132 100644 (file)
--- 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