diff options
author | Jesse Luehrs <doy@tozt.net> | 2013-07-18 10:25:47 -0400 |
---|---|---|
committer | Jesse Luehrs <doy@tozt.net> | 2013-07-18 10:25:47 -0400 |
commit | 12a4bdfabf59bc6051bbd6f65772e830165eb904 (patch) | |
tree | 0f0237c2ed8e8bfb005349e492726a869685cd0b /lib/Spreadsheet/Template/Writer.pm | |
parent | 3ba1fc133b41eaa8cf3351e07131256fdfdf1f11 (diff) | |
download | spreadsheet-template-12a4bdfabf59bc6051bbd6f65772e830165eb904.tar.gz spreadsheet-template-12a4bdfabf59bc6051bbd6f65772e830165eb904.zip |
more docs
Diffstat (limited to 'lib/Spreadsheet/Template/Writer.pm')
-rw-r--r-- | lib/Spreadsheet/Template/Writer.pm | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/lib/Spreadsheet/Template/Writer.pm b/lib/Spreadsheet/Template/Writer.pm index d81ef3b..4bf41ee 100644 --- a/lib/Spreadsheet/Template/Writer.pm +++ b/lib/Spreadsheet/Template/Writer.pm @@ -4,6 +4,34 @@ use Moose::Role; requires 'write'; +=head1 SYNOPSIS + + package MyWriter; + use Moose; + + with 'Spreadsheet::Template::Writer'; + + sub write { + # ... + } + +=head1 DESCRIPTION + +This role should be consumed by any class which will be used as the +C<writer_class> in a L<Spreadsheet::Template> instance. + +=cut + +=method write($data) + +This method is required to be implemented by any classes which consume this +role. It should use the data in C<$data> (in the format described in +L<Spreadsheet::Template>) to create a new spreadsheet file containing that +data. It should return a string containing the binary contents of the +spreadsheet file. + +=cut + no Moose::Role; 1; |