diff options
Diffstat (limited to 'lib/Spreadsheet/Template/Processor.pm')
-rw-r--r-- | lib/Spreadsheet/Template/Processor.pm | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/lib/Spreadsheet/Template/Processor.pm b/lib/Spreadsheet/Template/Processor.pm index 9808476..8532fea 100644 --- a/lib/Spreadsheet/Template/Processor.pm +++ b/lib/Spreadsheet/Template/Processor.pm @@ -4,6 +4,33 @@ use Moose::Role; requires 'process'; +=head1 SYNOPSIS + + package MyProcessor; + use Moose; + + with 'Spreadsheet::Template::Processor'; + + sub process { + # ... + } + +=head1 DESCRIPTION + +This role should be consumed by any class which will be used as the +C<processor_class> in a L<Spreadsheet::Template> instance. + +=cut + +=method process($contents, $vars) + +This method is required to be implemented by any classes which consume this +role. It should take the contents of the template and return a JSON file as +described in L<Spreadsheet::Template>. This typically just means running it +through a template engine of some kind. + +=cut + no Moose::Role; 1; |