This is 0.02

[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 ffd79a5633256fe4b801e4556e28f70d535cfbcd..6d93d028ec4c8aedbee1edca0c69bd6a4da83b88 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Op.pm
+++ b/lib/LaTeX/TikZ/Set/Op.pm
@@ -9,24 +9,64 @@ LaTeX::TikZ::Set::Op - A role for set objects that can be part of a path.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.02
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
+
+=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(@_) . " ;\n";
+ [ "\\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>.