X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FTest%2FValgrind%2FReport.pm;h=1192f7200a79da3c97b3ac08c10d8b0da08c252c;hb=cea977523ce9c4be865b97a0813a5e14cce873f9;hp=9c31ca96caed59249fb746adebee0a7178596260;hpb=abe419ac02d109283a1fe5615f5ab9d0a9a5572f;p=perl%2Fmodules%2FTest-Valgrind.git

diff --git a/lib/Test/Valgrind/Report.pm b/lib/Test/Valgrind/Report.pm
index 9c31ca9..1192f72 100644
--- a/lib/Test/Valgrind/Report.pm
+++ b/lib/Test/Valgrind/Report.pm
@@ -9,13 +9,23 @@ Test::Valgrind::Report - Base class for Test::Valgrind error reports.
 
 =head1 VERSION
 
-Version 1.01
+Version 1.13
 
 =cut
 
-our $VERSION = '1.01';
+our $VERSION = '1.13';
 
-use base qw/Test::Valgrind::Carp/;
+=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
 
@@ -148,7 +158,7 @@ You can find documentation for this module with the perldoc command.
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2009 Vincent Pit, all rights reserved.
+Copyright 2009,2010,2011 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.