More documentation boilerplate

[perl/modules/LaTeX-TikZ.git] / lib / LaTeX / TikZ / Mod / Clip.pm

diff --git a/lib/LaTeX/TikZ/Mod/Clip.pm b/lib/LaTeX/TikZ/Mod/Clip.pm
index 69c401edf70b84a4ca7a10bff2d343f24e2d78e5..f9d90228d96018431886455545323fc1bc7d2cd8 100644 (file)
--- a/lib/LaTeX/TikZ/Mod/Clip.pm
+++ b/lib/LaTeX/TikZ/Mod/Clip.pm
@@ -27,8 +27,22 @@ 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</cover>, 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',
@@ -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<cover>
+
+=cut
+
 my $get_tc = do {
  my %tc;
 
@@ -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>.