NAME

Perinci::Sub::To::Text - Generate text documentation from Rinci function metadata

VERSION

version 0.23

SYNOPSIS

use Perinci::Sub::To::Text;

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

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

% peri-func-doc --format text /Some/Module/somefunc

To generate a usage-like help message for a function, you can try peri-func-usage which is included in the Perinci::CmdLine distribution.

% peri-func-usage http://example.com/api/somefunc

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.