/ 
Perinci-To-Doc-0.51
River stage one • 3 direct dependents • 5 total dependents
/ Perinci::To::Text

NAME

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

VERSION

This document describes version 0.51 of Perinci::To::Text (from Perl distribution Perinci-To-Doc), released on 2014-05-01.

SYNOPSIS

use Perinci::To::POD;
my $doc = Perinci::To::Text->new(
    name=>'Foo::Bar', meta => {...}, child_metas=>{...});
say $doc->gen_doc;

You can also try the peri-doc script with the --format text option:

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

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

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Perinci-To-Doc.

SOURCE

Source repository is at https://github.com/sharyanto/perl-Perinci-To-Doc.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-To-Doc

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 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.