More documentation boilerplate

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

diff --git a/lib/LaTeX/TikZ/Mod/Pattern/Lines.pm b/lib/LaTeX/TikZ/Mod/Pattern/Lines.pm
index a86844020ded2e165e087dea465d31adf8fe87f5..d495ffd2067e7c72eff771c24d5d8ce150bc8b12 100644 (file)
--- a/lib/LaTeX/TikZ/Mod/Pattern/Lines.pm
+++ b/lib/LaTeX/TikZ/Mod/Pattern/Lines.pm
@@ -22,8 +22,20 @@ use LaTeX::TikZ::Tools;
 use Any::Moose;
 use Any::Moose 'Util::TypeConstraints';
 
+=head1 RELATIONSHIPS
+
+This class inherits the L<LaTeX::TikZ::Mod::Pattern> class and its L</tag>, L</cover>, L<LaTeX::TikZ::Mod::Pattern/declare> and L<LaTeX::TikZ::Mod::Pattern/apply> methods.
+
+=cut
+
 extends 'LaTeX::TikZ::Mod::Pattern';
 
+=head1 ATTRIBUTES
+
+=head2 C<direction>
+
+=cut
+
 enum 'LaTeX::TikZ::Mod::Pattern::Direction' => (
  'horizontal', 'vertical', 'north east', 'north west',
 );
@@ -34,12 +46,20 @@ has 'direction' => (
  default => 'horizontal',
 );
 
+=head2 C<line_width>
+
+=cut
+
 has 'line_width' => (
  is      => 'ro',
  isa     => subtype('Num' => where { LaTeX::TikZ::Tools::numcmp($_, 0) >= 0 }),
  default => 1,
 );
 
+=head2 C<space_width>
+
+=cut
+
 has 'space_width' => (
  is      => 'ro',
  isa     => subtype('Num' => where { LaTeX::TikZ::Tools::numcmp($_, 0) >= 0 }),
@@ -119,8 +139,18 @@ around 'BUILDARGS' => sub {
  $class->$orig(%args);
 };
 
+=head1 METHODS
+
+=head2 C<tag>
+
+=cut
+
 sub tag { join '/', ref $_[0], $_[0]->direction }
 
+=head2 C<cover>
+
+=cut
+
 sub cover {
  my ($this, $other) = @_;
 
@@ -133,6 +163,10 @@ sub cover {
 
 __PACKAGE__->meta->make_immutable;
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Mod::Pattern>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.