X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=README;h=da35890530fddfbe3fceb4ec261f09b06e285c61;hb=3aeb72ad594397b579a9cdcbc8b58aa7308e8f97;hp=36020583b619ca2b8e82ade8314d1136cae7acb5;hpb=ed8af32fb71887b9d4bb8e43c0efa02d558da44e;p=perl%2Fmodules%2FB-RecDeparse.git diff --git a/README b/README index 3602058..da35890 100644 --- a/README +++ b/README @@ -2,15 +2,22 @@ NAME B::RecDeparse - Deparse recursively into subroutines. VERSION - Version 0.05 + Version 0.09 SYNOPSIS - perl -MO=RecDeparse,deparse,[@B__Deparse_opts],level,-1 [ -e '...' | bleh.pl ] + # Deparse recursively a Perl one-liner : + $ perl -MO=RecDeparse,deparse,@B__Deparse_opts,level,-1 -e '...' - # Or as a module : + # Or a complete Perl script : + $ perl -MO=RecDeparse,deparse,@B__Deparse_opts,level,-1 x.pl + + # Or a single code reference : use B::RecDeparse; - my $brd = B::RecDeparse->new(deparse => [ @b__deparse_opts ], level => $level); + my $brd = B::RecDeparse->new( + deparse => \@B__Deparse_opts, + level => $level, + ); my $code = $brd->coderef2text(sub { ... }); DESCRIPTION @@ -22,21 +29,32 @@ DESCRIPTION the two modules. METHODS - "new < deparse => [ @B__Deparse_opts ], level => $level >" + "new" + my $brd = B::RecDeparse->new( + deparse => \@B__Deparse_opts, + level => $level, + ); + The B::RecDeparse object constructor. You can specify the underlying B::Deparse constructor arguments by passing a string or an array reference as the value of the "deparse" key. The "level" option expects an integer that specifies how many levels of recursions are allowed : -1 means infinite while 0 means none and match B::Deparse behaviour. - "compile" - "init" - "deparse_sub" - "pp_entersub" - "pp_refgen" - "pp_gv" - Functions and methods from B::Deparse reimplemented by this module. - Never call them directly. + The following functions and methods from B::Deparse are reimplemented by + this module : + + * "compile" + + * "init" + + * "deparse_sub" + + * "pp_entersub" + + * "pp_refgen" + + * "pp_gv" Otherwise, B::RecDeparse inherits all methods from B::Deparse. @@ -71,7 +89,8 @@ SUPPORT . COPYRIGHT & LICENSE - Copyright 2008,2009,2010,2011 Vincent Pit, all rights reserved. + Copyright 2008,2009,2010,2011,2013,2014 Vincent Pit, all rights + reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.