Add a DESCRIPTION to all modules

[perl/modules/Test-Valgrind.git] / lib / Test / Valgrind / Parser / XML / Twig.pm

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