Add a DESCRIPTION to all modules

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

diff --git a/lib/Test/Valgrind/Carp.pm b/lib/Test/Valgrind/Carp.pm
index c4db1307a62da132bcb2586438e19dc3b4988871..2d1cdfc64d446fcb1a249abc862521ebde3f841a 100644 (file)
--- a/lib/Test/Valgrind/Carp.pm
+++ b/lib/Test/Valgrind/Carp.pm
@@ -15,6 +15,14 @@ Version 1.10
 
 our $VERSION = '1.10';
 
+=head1 DESCRIPTION
+
+This class only provides a C<_croak> method that lazily requires L<Carp> and then croaks with the supplied message.
+
+The class should not be used outside from L<Test::Valgrind> and may be removed without notice.
+
+=cut
+
 sub _croak {
  shift;
  require Carp;