NAME

Perinci::To::Text - Generate text documentation for a package from Rinci metadata

VERSION

version 0.24

SYNOPSIS

 use Perinci::To::POD;
 my $doc = Perinci::To::Text->new(url => "/Some/Module/");
 say $doc->gen_doc;

You can also try the peri-pkg-doc script (included in the Perinci::To::POD distribution) with the --format text option:

 % peri-pkg-doc --format text /Some/Module/

To generate documentation for a single function, see Perinci::Sub::To::Text or the provided command-line script peri-func-doc.

To generate a usage-like help message for a single function, you can try the peri-func-usage from the Perinci::CmdLine distribution.

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Steven Haryanto.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

DESCRIPTION

FUNCTIONS

None are exported by default, but they are exportable.