More documentation boilerplate

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

diff --git a/lib/LaTeX/TikZ/Mod/Raw.pm b/lib/LaTeX/TikZ/Mod/Raw.pm
index 28b1d1dc69c420e41fc85efd81a506f686c648b8..60b2453163fc43ab005d49913f013049051edd8f 100644 (file)
--- a/lib/LaTeX/TikZ/Mod/Raw.pm
+++ b/lib/LaTeX/TikZ/Mod/Raw.pm
@@ -19,24 +19,54 @@ use LaTeX::TikZ::Interface;
 
 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<content>
+
+=cut
+
 has 'content' => (
  is       => 'ro',
  isa      => 'Str',
  required => 1,
 );
 
+=head1 METHODS
+
+=head2 C<tag>
+
+=cut
+
 sub tag {
  my ($self) = @_;
 
  ref($self) . '/' . $self->content;
 }
 
+=head2 C<cover>
+
+=cut
+
 sub cover { 1 }
 
+=head2 C<declare>
+
+=cut
+
 sub declare { }
 
+=head2 C<apply>
+
+=cut
+
 sub apply { $_[0]->content }
 
 LaTeX::TikZ::Interface->register(
@@ -49,6 +79,10 @@ LaTeX::TikZ::Interface->register(
 
 __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>.