This is 0.02

[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 705cac313083fdb4e13a9a86fb2e4a7230910204..dbd9b0ab8c95a9d0697a21625fe4d0b638a74f8c 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Polyline.pm
+++ b/lib/LaTeX/TikZ/Set/Polyline.pm
@@ -5,15 +5,15 @@ 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
 
-Version 0.01
+Version 0.02
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
 
 use LaTeX::TikZ::Set::Point;
 
@@ -23,6 +23,12 @@ 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'
@@ -34,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',
@@ -44,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;
 
@@ -82,6 +108,10 @@ LaTeX::TikZ::Functor->default_rule(
 
 __PACKAGE__->meta->make_immutable;
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Set::Op>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.