Document the Set/Set::Op roles

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

diff --git a/lib/LaTeX/TikZ/Set/Op.pm b/lib/LaTeX/TikZ/Set/Op.pm
index 2c85f0bace0788f560f46f221d32b820c682cac1..c7229c05db45ab6cbe18948236383f20443c0a8f 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Op.pm
+++ b/lib/LaTeX/TikZ/Set/Op.pm
@@ -15,18 +15,58 @@ Version 0.01
 
 our $VERSION = '0.01';
 
+=head1 DESCRIPTION
+
+Ops are the components of a path.
+They can be built together to form a path.
+Thus, they are all the elements against which we can call the C<path> method.
+
+=cut
+
 use Any::Moose 'Role';
 
+=head1 RELATIONSHIPS
+
+This role consumes the L<LaTeX::TikZ::Set> role, and as such implements the L</draw> method.
+
+=cut
+
+with 'LaTeX::TikZ::Set';
+
+=head1 METHODS
+
+This method is required by the interface :
+
+=over 4
+
+=item *
+
+C<path $formatter>
+
+Returns the TikZ code that builds a path out of the current set object as a string formatted by the L<LaTeX::TikZ::Formatter> object C<$formatter>.
+
+=back
+
+=cut
+
 requires qw(
  path
 );
 
+=head2 C<draw>
+
+=cut
+
 sub draw {
  my $set = shift;
 
  [ "\\draw " . $set->path(@_) . ' ;' ];
 }
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Set>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.