This is 0.02

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

diff --git a/lib/LaTeX/TikZ/Set/Point.pm b/lib/LaTeX/TikZ/Set/Point.pm
index b45adaf41411a21415fcba9a9966bb977c1b940c..ff861b0c0aac61dee84bbc9de8e68810c6821445 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Point.pm
+++ b/lib/LaTeX/TikZ/Set/Point.pm
@@ -9,11 +9,11 @@ LaTeX::TikZ::Set::Point - A set object representing a point.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.02
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
 
 use LaTeX::TikZ::Point;
 
@@ -23,8 +23,22 @@ 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';
 
+=head1 ATTRIBUTES
+
+=head2 C<point>
+
+The L<LaTeX::TikZ::Point> object representing the underlying geometrical point.
+
+=cut
+
 has 'point' => (
  is       => 'ro',
  isa      => 'LaTeX::TikZ::Point::Autocoerce',
@@ -33,12 +47,24 @@ has 'point' => (
  handles  => [ qw/x y/ ],
 );
 
+=head2 C<label>
+
+An optional label for the point.
+
+=cut
+
 has 'label' => (
  is      => 'rw',
  isa     => 'Maybe[Str]',
  default => undef,
 );
 
+=head2 C<pos>
+
+The position of the label around the point.
+
+=cut
+
 enum 'LaTeX::TikZ::Set::Point::Positions' => (
  'below left',
  'below',
@@ -63,6 +89,12 @@ coerce 'LaTeX::TikZ::Point::Autocoerce'
     => from 'LaTeX::TikZ::Set::Point'
     => via { $_->point };
 
+=head1 METHODS
+
+=head2 C<path>
+
+=cut
+
 sub path {
  my ($set, $tikz) = @_;
 
@@ -112,6 +144,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>.