This is 1.12

[perl/modules/Test-Valgrind.git] / lib / Test / Valgrind / Report.pm

diff --git a/lib/Test/Valgrind/Report.pm b/lib/Test/Valgrind/Report.pm
index 1a02c373fd3bca492355b2390cdfeda58b317453..67b6ce9fa98ded9109c15fa6fd04561dd8aa071c 100644 (file)
--- a/lib/Test/Valgrind/Report.pm
+++ b/lib/Test/Valgrind/Report.pm
@@ -9,11 +9,21 @@ Test::Valgrind::Report - Base class for Test::Valgrind error reports.
 
 =head1 VERSION
 
-Version 1.00
+Version 1.12
 
 =cut
 
-our $VERSION = '1.00';
+our $VERSION = '1.12';
+
+=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/;
 
@@ -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