[DOC PATCH] Document Dumpvalue::stringify
authorAndreas König <a.koenig@mind.de>
Sat, 30 Mar 2002 06:12:36 +0000 (07:12 +0100)
committerJarkko Hietaniemi <jhi@iki.fi>
Sat, 30 Mar 2002 16:52:09 +0000 (16:52 +0000)
Message-ID: <m3hemyvdtn.fsf@anima.de>

p4raw-id: //depot/perl@15626

lib/Dumpvalue.pm

index c9b1aca..7944e78 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.11';
 our(%address, $stab, @stab, %stab, %subs);
 
 # documentation nits, handle complex data structures better by chromatic
@@ -492,6 +492,7 @@ Dumpvalue - provides screen dump of Perl data.
   $dumper->set(globPrint => 1);
   $dumper->dumpValue(\*::);
   $dumper->dumpvars('main');
+  my $dump = $dumper->stringify($some_value);
 
 =head1 DESCRIPTION
 
@@ -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');