More documentation boilerplate

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

diff --git a/lib/LaTeX/TikZ/Mod/Layer.pm b/lib/LaTeX/TikZ/Mod/Layer.pm
index 0dd0a84a76dec2a4b0f06a9c470d9ca253a31de3..fda3d59559a0bd3623b9682655dadc58103eb4a7 100644 (file)
--- a/lib/LaTeX/TikZ/Mod/Layer.pm
+++ b/lib/LaTeX/TikZ/Mod/Layer.pm
@@ -25,14 +25,30 @@ use LaTeX::TikZ::Interface;
 use Any::Moose;
 use Any::Moose 'Util::TypeConstraints';
 
+=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<name>
+
+=cut
+
 has 'name' => (
  is       => 'ro',
  isa      => 'Str',
  required => 1,
 );
 
+=head2 C<above>
+
+=cut
+
 subtype 'LaTeX::TikZ::Mod::LevelList'
      => as 'ArrayRef[LaTeX::TikZ::Mod::Layer]';
 
@@ -54,6 +70,10 @@ has '_above' => (
 
 sub above { @{$_[0]->_above} }
 
+=head2 C<below>
+
+=cut
+
 has '_below' => (
  is       => 'ro',
  isa      => 'LaTeX::TikZ::Mod::LevelList',
@@ -72,6 +92,10 @@ has '_score' => (
  builder  => '_build_score',
 );
 
+=head1 METHODS
+
+=cut
+
 my %layers;
 
 around 'new' => sub {
@@ -105,14 +129,26 @@ sub DEMOLISH {
  delete $layers{$self->name};
 }
 
+=head2 C<tag>
+
+=cut
+
 sub tag {
  my ($self) = @_;
 
  ref($self) . '/' . $self->name;
 }
 
+=head2 C<cover>
+
+=cut
+
 sub cover { $_[0]->name eq $_[1]->name }
 
+=head2 C<score>
+
+=cut
+
 {
  our %score;
 
@@ -162,6 +198,10 @@ sub cover { $_[0]->name eq $_[1]->name }
   $score{$name}
  }
 
+=head2 C<declare>
+
+=cut
+
  sub declare {
   shift;
 
@@ -186,6 +226,10 @@ sub cover { $_[0]->name eq $_[1]->name }
  }
 }
 
+=head2 C<apply>
+
+=cut
+
 sub apply {
  my ($self) = @_;
 
@@ -208,6 +252,10 @@ __PACKAGE__->meta->make_immutable(
  inline_constructor => 0,
 );
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Mod>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.