summaryrefslogtreecommitdiffstats
path: root/lib/Spreadsheet/Template/Writer.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/Spreadsheet/Template/Writer.pm')
-rw-r--r--lib/Spreadsheet/Template/Writer.pm28
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;