First cut at the documentation

[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..c7b6b57bebe97a9b0f8f83dc8069c686269f2d5b 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Op.pm
+++ b/lib/LaTeX/TikZ/Set/Op.pm
@@ -15,16 +15,50 @@ 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>
+
+=back
+
+=cut
+
 requires qw(
  path
 );
 
+=head2 C<draw>
+
+=cut
+
 sub draw {
  my $set = shift;
 
- "\\draw " . $set->path(@_) . " ;\n";
+ [ "\\draw " . $set->path(@_) . ' ;' ];
 }
 
 =head1 AUTHOR