ct2pod - convert Class::Tangram source files to POD
ct2pod [options] module.pm
ct2pod produces POD documentation files from Class::Tangram style Perl Modules. This script can either run on a single Perl module (traditional Class::Tangram style), or generate a series of POD files from a Tangram::Schema compatible data structure (Class::Tangram::Generator style).
ct2pod
POD files are written in the same directory as the Perl module file. POD files are not updated unless they are older than the module files.
Specify to look for a schema that contains a data structure describing several classes at once. For this to work, the module must call Class::Tangram::Generator::new with the schema structure you want to generate POD files for.
Class::Tangram::Generator::new
Specify the name of the Template Toolkit template to use as a source for making the POD files. The default is a built-in template.
Display a program usage screen and exit.
Display program version and exit.
Verbose command execution, displaying things like the commands run, their output, etc.
Suppress all normal program output; only display errors and warnings.
Display output to help someone debug this script, not the process going on.
[% IF pod.name %][% pod.name %][% ELSE %] [% class %] - Class::Tangram data class [% END %]
[% IF pod.synopsis %][% pod.synopsis %][% ELSE %] use [% class %];
my $object = [% class %]->new [% IF required %] ( [% FOR item = required %] [% item.name %] => [% item.example %], [% END %] ); [% END %][%# required %] [% END %]
[% FOR type = fields.keys.sort %] [% IF type.match("i?set") %] [% FOR fields = fields.$type.keys.sort %] $obj-> [% END %] [% END %]
[% IF pod.description %][% pod.description %][% ELSE %] [%
To install Class::Tangram, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Class::Tangram
CPAN shell
perl -MCPAN -e shell install Class::Tangram
For more information on module installation, please visit the detailed CPAN module installation guide.