X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FLaTeX%2FTikZ%2FMod%2FClip.pm;h=1b61b4db0f996ddf3bc2caff61a0a598920713c9;hb=b8f42942311854cb0ef8a3e34c0145846639cd2e;hp=69c401edf70b84a4ca7a10bff2d343f24e2d78e5;hpb=af7d6a5aef3bf5fec0c187b3a13a14adc88251fd;p=perl%2Fmodules%2FLaTeX-TikZ.git

diff --git a/lib/LaTeX/TikZ/Mod/Clip.pm b/lib/LaTeX/TikZ/Mod/Clip.pm
index 69c401e..1b61b4d 100644
--- a/lib/LaTeX/TikZ/Mod/Clip.pm
+++ b/lib/LaTeX/TikZ/Mod/Clip.pm
@@ -9,11 +9,11 @@ LaTeX::TikZ::Mod::Clip - A modifier that clips sequences with a path.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.02
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
 
 use Sub::Name ();
 
@@ -27,11 +27,25 @@ use LaTeX::TikZ::Tools;
 
 use Any::Moose;
 
+=head1 RELATIONSHIPS
+
+This class consumes the L<LaTeX::TikZ::Mod> role, and as such implements the L</tag>, L</covers>, L</declare> and L</apply> methods.
+
+=cut
+
 with 'LaTeX::TikZ::Mod';
 
+=head1 ATTRIBUTES
+
+=head2 C<clip>
+
+The path that specifies the clipped area.
+
+=cut
+
 has clip => (
  is       => 'ro',
- does     => 'LaTeX::TikZ::Set::Op',
+ does     => 'LaTeX::TikZ::Set::Path',
  required => 1,
 );
 
@@ -41,8 +55,18 @@ my $default_formatter = LaTeX::TikZ::Formatter->new(
  scale  => 1,
 );
 
+=head1 METHODS
+
+=head2 C<tag>
+
+=cut
+
 sub tag { ref $_[0] }
 
+=head2 C<covers>
+
+=cut
+
 my $get_tc = do {
  my %tc;
 
@@ -116,7 +140,7 @@ my @handlers = (
  [ 'LaTeX::TikZ::Set::Circle'    => $cover_circle    ],
 );
 
-sub cover {
+sub covers {
  my ($old, $new) = map $_->clip, @_[0, 1];
 
  for (@handlers) {
@@ -128,8 +152,16 @@ sub cover {
  $old->path($default_formatter) eq $new->path($default_formatter);
 }
 
+=head2 C<declare>
+
+=cut
+
 sub declare { }
 
+=head2 C<apply>
+
+=cut
+
 sub apply {
  my ($self) = @_;
 
@@ -156,6 +188,10 @@ LaTeX::TikZ::Functor->default_rule(
 
 __PACKAGE__->meta->make_immutable;
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Mod>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.