Add a DESCRIPTION to all modules

[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 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