First cut at the documentation

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

diff --git a/lib/LaTeX/TikZ/Set/Path.pm b/lib/LaTeX/TikZ/Set/Path.pm
index 5a9e59c283432bd5b814cb52fc4b28fd15ba22a9..7a8793d1232e9cd82167e273d2c3dbe74bd9d8de 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Path.pm
+++ b/lib/LaTeX/TikZ/Set/Path.pm
@@ -22,11 +22,25 @@ use Any::Moose;
 use Any::Moose 'Util::TypeConstraints'
                => [ qw/subtype as where find_type_constraint/ ];
 
+=head1 RELATIONSHIPS
+
+This class consumes the L<LaTeX::TikZ::Set::Op> and L<LaTeX::TikZ::Set::Mutable> roles, and as such implements the L</path> and L</add> methods.
+
+=cut
+
 with qw(
  LaTeX::TikZ::Set::Op
  LaTeX::TikZ::Set::Mutable
 );
 
+=head1 ATTRIBUTES
+
+=head2 C<ops>
+
+The L<LaTeX::TikZ::Set::Op> objects that from the path.
+
+=cut
+
 subtype 'LaTeX::TikZ::Set::Path::Elements'
      => as 'Object'
      => where { $_->does('LaTeX::TikZ::Set::Op') };
@@ -40,6 +54,12 @@ has '_ops' => (
 
 sub ops { @{$_[0]->_ops} }
 
+=head1 METHODS
+
+=head2 C<add>
+
+=cut
+
 my $ltspe_tc = find_type_constraint('LaTeX::TikZ::Set::Path::Elements');
 
 sub add {
@@ -52,6 +72,10 @@ sub add {
  $set;
 }
 
+=head2 C<path>
+
+=cut
+
 sub path {
  my $set = shift;