This is 0.02

[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 0bf9222d28e1e0f38a30b45959aeb0ee219e6b68..dfb30f73e19799542d05091a9847d11adbc34b79 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Sequence.pm
+++ b/lib/LaTeX/TikZ/Set/Sequence.pm
@@ -9,11 +9,11 @@ LaTeX::TikZ::Set::Sequence - A set object grouping a sequence of objects.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.02
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
 
 use List::Util ();
 
@@ -26,6 +26,12 @@ 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
@@ -38,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]]',
@@ -47,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 {
@@ -59,6 +79,10 @@ sub add {
  $set;
 }
 
+=head2 C<draw>
+
+=cut
+
 sub draw {
  my $set = shift;
 
@@ -84,6 +108,10 @@ LaTeX::TikZ::Functor->default_rule(
 
 __PACKAGE__->meta->make_immutable;
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Set::Op>, L<LaTeX::TikZ::Set::Mutable>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.