diff options
Diffstat (limited to 'lib/Spreadsheet/Template/Generator/Parser.pm')
-rw-r--r-- | lib/Spreadsheet/Template/Generator/Parser.pm | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/lib/Spreadsheet/Template/Generator/Parser.pm b/lib/Spreadsheet/Template/Generator/Parser.pm index d1d7735..ec22f9f 100644 --- a/lib/Spreadsheet/Template/Generator/Parser.pm +++ b/lib/Spreadsheet/Template/Generator/Parser.pm @@ -4,6 +4,32 @@ use Moose::Role; requires 'parse'; +=head1 SYNOPSIS + + package MyParser; + use Moose; + + with 'Spreadsheet::Template::Generator::Parser'; + + sub parse { + # ... + } + +=head1 DESCRIPTION + +This role should be consumed by any class which will be used as the +C<parser_class> in a L<Spreadsheet::Template::Generator> instance. + +=cut + +=method parse($filename) (required) + +This method should parse the spreadsheet specified by C<$filename> and return +the intermediate data structure containing all of the data in that spreadsheet. +The intermediate data format is documented in L<Spreadsheet::Template>. + +=cut + no Moose::Role; 1; |