From 12a4bdfabf59bc6051bbd6f65772e830165eb904 Mon Sep 17 00:00:00 2001
From: Jesse Luehrs <doy@tozt.net>
Date: Thu, 18 Jul 2013 10:25:47 -0400
Subject: more docs

---
 lib/Spreadsheet/Template/Writer.pm | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

(limited to 'lib/Spreadsheet/Template/Writer.pm')

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;
-- 
cgit v1.2.3-54-g00ecf