First cut at the documentation

[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..b226fd41ec6b0efed1ce2bfdf54277fae09d7198 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Point.pm
+++ b/lib/LaTeX/TikZ/Set/Point.pm
@@ -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) = @_;