First cut at the documentation

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

diff --git a/lib/LaTeX/TikZ/Set/Polyline.pm b/lib/LaTeX/TikZ/Set/Polyline.pm
index 76656afc88c4c89ac4e0234f458b63b49f2f86b6..e1172eb36b0f25590138aca3e33d04fcaf0a679f 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Polyline.pm
+++ b/lib/LaTeX/TikZ/Set/Polyline.pm
@@ -5,7 +5,7 @@ use warnings;
 
 =head1 NAME
 
-LaTeX::TikZ::Set::Polyline - A set object representing a line.
+LaTeX::TikZ::Set::Polyline - A set object representing a possibly closed path composed of contiguous lines.
 
 =head1 VERSION
 
@@ -17,11 +17,18 @@ our $VERSION = '0.01';
 
 use LaTeX::TikZ::Set::Point;
 
+use LaTeX::TikZ::Interface;
 use LaTeX::TikZ::Functor;
 
 use Any::Moose;
 use Any::Moose 'Util::TypeConstraints';
 
+=head1 RELATIONSHIPS
+
+This class consumes the L<LaTeX::TikZ::Set::Op> role, and as such implements the L</path> method.
+
+=cut
+
 with 'LaTeX::TikZ::Set::Op';
 
 subtype 'LaTeX::TikZ::Set::Polyline::Vertices'
@@ -33,6 +40,14 @@ coerce 'LaTeX::TikZ::Set::Polyline::Vertices'
     => from 'ArrayRef[Any]'
     => via { [ map LaTeX::TikZ::Set::Point->new(point => $_), @$_ ] };
 
+=head1 ATTRIBUTES
+
+=head2 C<points>
+
+The list of the successive vertices of the path.
+
+=cut
+
 has '_points' => (
  is       => 'ro',
  isa      => 'LaTeX::TikZ::Set::Polyline::Vertices',
@@ -43,12 +58,24 @@ has '_points' => (
 
 sub points { @{$_[0]->_points} }
 
+=head2 C<closed>
+
+A boolean that indicates whether the path is closed or not.
+
+=cut
+
 has 'closed' => (
  is      => 'ro',
  isa     => 'Bool',
  default => 0,
 );
 
+=head1 METHODS
+
+=head2 C<path>
+
+=cut
+
 sub path {
  my $set = shift;
 
@@ -56,17 +83,18 @@ sub path {
               ($set->closed ? 'cycle' : ());
 }
 
-use LaTeX::TikZ::Interface polyline => sub {
- shift;
+LaTeX::TikZ::Interface->register(
+ polyline => sub {
+  shift;
 
- __PACKAGE__->new(points => \@_);
-};
+  __PACKAGE__->new(points => \@_);
+ },
+ closed_polyline => sub {
+  shift;
 
-use LaTeX::TikZ::Interface closed_polyline => sub {
- shift;
-
- __PACKAGE__->new(points => \@_, closed => 1);
-};
+  __PACKAGE__->new(points => \@_, closed => 1);
+ },
+);
 
 LaTeX::TikZ::Functor->default_rule(
  (__PACKAGE__) => sub {