First cut at the documentation

[perl/modules/LaTeX-TikZ.git] / lib / LaTeX / TikZ / Mod.pm

diff --git a/lib/LaTeX/TikZ/Mod.pm b/lib/LaTeX/TikZ/Mod.pm
index b5921e9bcd3199d79b662e84a1481804e56af81c..87cec117c14162236baeeff5f8dbf6ca6811f994 100644 (file)
--- a/lib/LaTeX/TikZ/Mod.pm
+++ b/lib/LaTeX/TikZ/Mod.pm
@@ -15,9 +15,41 @@ Version 0.01
 
 our $VERSION = '0.01';
 
+=head1 DESCRIPTION
+
+This role should be consumed by all the modifier classes.
+
+=cut
+
 use Any::Moose 'Role';
 use Any::Moose 'Util::TypeConstraints';
 
+=head1 METHODS
+
+These methods are required by the interface :
+
+=over 4
+
+=item *
+
+C<tag>
+
+=item *
+
+C<cover>
+
+=item *
+
+C<declare>
+
+=item *
+
+C<apply>
+
+=back
+
+=cut
+
 requires qw(
  tag
  cover