X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FTest%2FValgrind%2FParser%2FXML%2FTwig.pm;h=7d5bf66e01c91029a1e836892ed9647d49983b53;hb=93bdd32c84466f212aded61d70219e82cb538620;hp=ff72c3064476c5cf57bdb74ca864878ff38831dd;hpb=592b66b1302df332a2a1731e8cab6e6765fe54fb;p=perl%2Fmodules%2FTest-Valgrind.git

diff --git a/lib/Test/Valgrind/Parser/XML/Twig.pm b/lib/Test/Valgrind/Parser/XML/Twig.pm
index ff72c30..7d5bf66 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> 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
+
 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