More documentation boilerplate

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

diff --git a/lib/LaTeX/TikZ/Set/Mutable.pm b/lib/LaTeX/TikZ/Set/Mutable.pm
index c6e21434e65e9a3bcf0e3500d3dfb24ae045334c..92fa0f9ef8b543d514f1f54ffcbce412dc1ff53d 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Mutable.pm
+++ b/lib/LaTeX/TikZ/Set/Mutable.pm
@@ -11,16 +11,39 @@ LaTeX::TikZ::Set::Mutable - A role for set objects that can be appended to.
 
 Version 0.01
 
+=head1 DESCRIPTION
+
+L<LaTeX::TikZ::Set> objects that are mutable consume this role.
+This forces them to implement an C<add> method describing how more elements can be added to the set.
+
 =cut
 
 our $VERSION = '0.01';
 
 use Any::Moose 'Role';
 
+=head1 METHODS
+
+This method is required by the interface :
+
+=over 4
+
+=item *
+
+C<add>
+
+=back
+
+=cut
+
 requires qw(
  add
 );
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Set>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.