This is 0.02

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

diff --git a/lib/LaTeX/TikZ/Set/Line.pm b/lib/LaTeX/TikZ/Set/Line.pm
index ffe5975c89a27be0db00f3ec03860b0903fb1829..807b56dc869011ee1628549e755b992a1a6b1b46 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Line.pm
+++ b/lib/LaTeX/TikZ/Set/Line.pm
@@ -9,11 +9,11 @@ LaTeX::TikZ::Set::Line - A set object representing a line.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.02
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
 
 use LaTeX::TikZ::Set::Point;
 
@@ -22,8 +22,22 @@ use LaTeX::TikZ::Functor;
 
 use Any::Moose;
 
+=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';
 
+=head1 ATTRIBUTES
+
+=head2 C<from>
+
+The first endpoint of the line, as a L<LaTeX::TikZ::Set::Point> object.
+
+=cut
+
 has 'from' => (
  is       => 'ro',
  isa      => 'LaTeX::TikZ::Set::Point',
@@ -31,6 +45,12 @@ has 'from' => (
  coerce   => 1,
 );
 
+=head2 C<to>
+
+The second endpoint of the line, also as a L<LaTeX::TikZ::Set::Point> object.
+
+=cut
+
 has 'to' => (
  is       => 'ro',
  isa      => 'LaTeX::TikZ::Set::Point',
@@ -38,6 +58,12 @@ has 'to' => (
  coerce   => 1,
 );
 
+=head1 METHODS
+
+=head2 C<path>
+
+=cut
+
 sub path {
  my $set = shift;
 
@@ -61,6 +87,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>.