POD for Devel::Dwarn

[p5sagit/Data-Dumper-Concise.git] / lib / Devel / Dwarn.pm

diff --git a/lib/Devel/Dwarn.pm b/lib/Devel/Dwarn.pm
index 403c742..9029cc0 100644 (file)
--- a/lib/Devel/Dwarn.pm
+++ b/lib/Devel/Dwarn.pm
@@ -6,4 +6,43 @@ sub import {
   Data::Dumper::Concise::Sugar->export_to_level(1, @_);
 }
 
+=head1 NAME
+
+Devel::Dwarn - return Dwarn @return_value
+
+=head1 SYNOPSIS
+
+  use Devel::Dwarn;
+
+  return Dwarn some_call(...)
+
+is equivalent to:
+
+  use Data::Dumper::Concise;
+
+  my @return = some_call(...);
+  warn Dumper(@return);
+  return @return;
+
+but shorter. If you need to force scalar context on the value,
+
+  use Devel::Dwarn;
+
+  return DwarnS some_call(...)
+
+is equivalent to:
+
+  use Data::Dumper::Concise;
+
+  my $return = some_call(...);
+  warn Dumper($return);
+  return $return;
+
+=head1 SEE ALSO
+
+This module is really just a shortcut for L<Data::Dumper::Concise::Sugar>, check
+it out for more complete documentation.
+
+=cut
+
 1;