Sam Vilain > Class-Tangram > ct2pod

Download:
Class-Tangram-1.57.tar.gz

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Source  

NAME ^

ct2pod - convert Class::Tangram source files to POD

SYNOPSIS ^

ct2pod [options] module.pm

DESCRIPTION ^

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).

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.

COMMAND LINE OPTIONS ^

-s, --schema

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.

-t, --template=FILE

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.

-h, --help

Display a program usage screen and exit.

-V, --version

Display program version and exit.

-v, --verbose

Verbose command execution, displaying things like the commands run, their output, etc.

-q, --quiet

Suppress all normal program output; only display errors and warnings.

-d, --debug

Display output to help someone debug this script, not the process going on.

NAME ^

[% IF pod.name %][% pod.name %][% ELSE %] [% class %] - Class::Tangram data class [% END %]

SYNOPSIS ^

[% 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 %]

DESCRIPTION ^

[% IF pod.description %][% pod.description %][% ELSE %] [%

syntax highlighting: