POD for Devel::Dwarn
[p5sagit/Data-Dumper-Concise.git] / lib / Data / Dumper / Concise / Sugar.pm
1 package Data::Dumper::Concise::Sugar;
2
3 use 5.006;
4
5 use Exporter ();
6 use Data::Dumper::Concise ();
7
8 BEGIN { @ISA = qw(Exporter) }
9
10 @EXPORT = qw(Dwarn DwarnS);
11
12 sub Dwarn { warn Data::Dumper::Concise::Dumper @_; @_ }
13
14 sub DwarnS ($) { warn Data::Dumper::Concise::Dumper $_[0]; $_[0] }
15
16 =head1 NAME
17
18 Data::Dumper::Concise::Sugar - return Dwarn @return_value
19
20 =head1 SYNOPSIS
21
22   use Data::Dumper::Concise::Sugar;
23
24   return Dwarn some_call(...)
25
26 is equivalent to:
27
28   use Data::Dumper::Concise;
29
30   my @return = some_call(...);
31   warn Dumper(@return);
32   return @return;
33
34 but shorter. If you need to force scalar context on the value,
35
36   use Data::Dumper::Concise::Sugar;
37
38   return DwarnS some_call(...)
39
40 is equivalent to:
41
42   use Data::Dumper::Concise;
43
44   my $return = some_call(...);
45   warn Dumper($return);
46   return $return;
47
48 =head1 DESCRIPTION
49
50   use Data::Dumper::Concise::Sugar;
51
52 will import Dwarn and DwarnS into your namespace. Using L<Exporter>, so see
53 its docs for ways to make it do something else.
54
55 =head2 Dwarn
56
57   sub Dwarn { warn Data::Dumper::Concise::Dumper @_; @_ }
58
59 =head3 DwarnS
60
61   sub DwarnS ($) { warn Data::Dumper::Concise::Dumper $_[0]; $_[0] }
62
63 =head1 SEE ALSO
64
65 You probably want L<Devel::Dwarn>, it's the shorter name for this module.
66
67 =cut
68
69 1;