Rename LT::Set::Mutable to ::Container

[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..70176a1fb65c061a298a792e9b5001906cc004d5 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 ();
 
@@ -24,20 +24,34 @@ use LaTeX::TikZ::Functor;
 
 use Any::Moose;
 use Any::Moose 'Util::TypeConstraints'
-               => [ qw/subtype as where find_type_constraint/ ];
+               => [ qw<subtype as where find_type_constraint> ];
 
-with qw(
+=head1 RELATIONSHIPS
+
+This class consumes the L<LaTeX::TikZ::Set> and L<LaTeX::TikZ::Set::Container> roles, and as such implements the L</draw>, L</kids> and L</add> methods.
+
+=cut
+
+with qw<
  LaTeX::TikZ::Set
- LaTeX::TikZ::Set::Mutable
-);
+ LaTeX::TikZ::Set::Container
+>;
 
 subtype 'LaTeX::TikZ::Set::Sequence::Elements'
      => as 'Object'
      => where {
-             $_->does('LaTeX::TikZ::Set::Op')
+             $_->does('LaTeX::TikZ::Set::Path')
           or $_->isa('LaTeX::TikZ::Set::Sequence')
      };
 
+=head1 ATTRIBUTES
+
+=head2 C<kids>
+
+The L<LaTeX::TikZ::Set::Path> 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,12 +79,19 @@ sub add {
  $set;
 }
 
+=head2 C<draw>
+
+=cut
+
 sub draw {
  my $set = shift;
 
+ my @kids = $set->kids;
+ return [ ] unless @kids;
+
  List::Util::reduce { LaTeX::TikZ::Scope::fold($a, $b) }
   map $_->draw(@_),
-   $set->kids;
+   @kids;
 }
 
 LaTeX::TikZ::Interface->register(
@@ -84,6 +111,10 @@ LaTeX::TikZ::Functor->default_rule(
 
 __PACKAGE__->meta->make_immutable;
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Set::Path>, L<LaTeX::TikZ::Set::Container>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.