First cut at the documentation

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

diff --git a/lib/LaTeX/TikZ/Set/Sequence.pm b/lib/LaTeX/TikZ/Set/Sequence.pm
index a92ad89d7dd93e267870cefa4a046047575688c9..ca7143f8e3f1bce3a26cf5664409a7489660d080 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Sequence.pm
+++ b/lib/LaTeX/TikZ/Set/Sequence.pm
@@ -19,12 +19,19 @@ use List::Util ();
 
 use LaTeX::TikZ::Scope;
 
+use LaTeX::TikZ::Interface;
 use LaTeX::TikZ::Functor;
 
 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> and L<LaTeX::TikZ::Set::Mutable> roles, and as such implements the L</draw> and L</add> methods.
+
+=cut
+
 with qw(
  LaTeX::TikZ::Set
  LaTeX::TikZ::Set::Mutable
@@ -37,6 +44,14 @@ subtype 'LaTeX::TikZ::Set::Sequence::Elements'
           or $_->isa('LaTeX::TikZ::Set::Sequence')
      };
 
+=head1 ATTRIBUTES
+
+=head2 C<kids>
+
+The L<LaTeX::TikZ::Set::Op> or L<LaTeX::TikZ::Set::Sequence> objects that from the sequence.
+
+=cut
+
 has '_kids' => (
  is       => 'ro',
  isa      => 'Maybe[ArrayRef[LaTeX::TikZ::Set::Sequence::Elements]]',
@@ -46,6 +61,12 @@ has '_kids' => (
 
 sub kids { @{$_[0]->_kids} }
 
+=head1 METHODS
+
+=head2 C<add>
+
+=cut
+
 my $ltsse_tc = find_type_constraint('LaTeX::TikZ::Set::Sequence::Elements');
 
 sub add {
@@ -58,6 +79,10 @@ sub add {
  $set;
 }
 
+=head2 C<draw>
+
+=cut
+
 sub draw {
  my $set = shift;
 
@@ -66,11 +91,13 @@ sub draw {
    $set->kids;
 }
 
-use LaTeX::TikZ::Interface seq => sub {
- shift;
+LaTeX::TikZ::Interface->register(
+ seq => sub {
+  shift;
 
- __PACKAGE__->new(kids => \@_);
-};
+  __PACKAGE__->new(kids => \@_);
+ },
+);
 
 LaTeX::TikZ::Functor->default_rule(
  (__PACKAGE__) => sub {