add tests for version::is_strict() and version::is_lax()
[p5sagit/p5-mst-13.2.git] / lib / Dumpvalue.pm
index c9b1aca..af16b1d 100644 (file)
@@ -1,7 +1,7 @@
 use 5.006_001;                 # for (defined ref) and $#$v and our
 package Dumpvalue;
 use strict;
-our $VERSION = '1.10';
+our $VERSION = '1.13';
 our(%address, $stab, @stab, %stab, %subs);
 
 # documentation nits, handle complex data structures better by chromatic
@@ -488,10 +488,11 @@ Dumpvalue - provides screen dump of Perl data.
 =head1 SYNOPSIS
 
   use Dumpvalue;
-  my $dumper = new Dumpvalue;
+  my $dumper = Dumpvalue->new;
   $dumper->set(globPrint => 1);
   $dumper->dumpValue(\*::);
   $dumper->dumpvars('main');
+  my $dump = $dumper->stringify($some_value);
 
 =head1 DESCRIPTION
 
@@ -499,7 +500,7 @@ Dumpvalue - provides screen dump of Perl data.
 
 A new dumper is created by a call
 
-  $d = new Dumpvalue(option1 => value1, option2 => value2)
+  $d = Dumpvalue->new(option1 => value1, option2 => value2)
 
 Recognized options:
 
@@ -578,10 +579,22 @@ method and set() method (which accept multiple arguments).
   $dumper->dumpValue($value);
   $dumper->dumpValue([$value1, $value2]);
 
+Prints a dump to the currently selected filehandle.
+
 =item dumpValues
 
   $dumper->dumpValues($value1, $value2);
 
+Same as C<< $dumper->dumpValue([$value1, $value2]); >>.
+
+=item stringify
+
+  my $dump = $dumper->stringify($value [,$noticks] );
+
+Returns the dump of a single scalar without printing. If the second
+argument is true, the return value does not contain enclosing ticks.
+Does not handle data structures.
+
 =item dumpvars
 
   $dumper->dumpvars('my_package');
@@ -603,7 +616,7 @@ given quote char.  Possible values are C<auto>, C<'> and C<">.
 
 =item set_unctrl
 
-  $d->set_unctrl('"');
+  $d->set_unctrl('unctrl');
 
 Sets C<unctrl> option with checking for an invalid argument.
 Possible values are C<unctrl> and C<quote>.