More documentation boilerplate

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

diff --git a/lib/LaTeX/TikZ/Mod/Pattern.pm b/lib/LaTeX/TikZ/Mod/Pattern.pm
index ddae7e2b00f8b0b0ecc2f72526be2985927d7655..230af5b135b3fb3585fbe6935b07f377bad86f2d 100644 (file)
--- a/lib/LaTeX/TikZ/Mod/Pattern.pm
+++ b/lib/LaTeX/TikZ/Mod/Pattern.pm
@@ -19,8 +19,20 @@ 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<template>
+
+=cut
+
 has 'template' => (
  is       => 'ro',
  isa      => 'ArrayRef[Str]',
@@ -34,6 +46,12 @@ has '_cache' => (
  default  => sub { +{ } },
 );
 
+=head1 METHODS
+
+=head2 C<name>
+
+=cut
+
 sub name {
  my ($pat, $tikz) = @_;
 
@@ -50,10 +68,22 @@ my %handlers = (
  width => sub { sprintf '%0.1fpt', $_[1]->thickness($_[2]) },
 );
 
+=head2 C<tag>
+
+=cut
+
 sub tag { ref $_[0] }
 
+=head2 C<cover>
+
+=cut
+
 sub cover { 1 }
 
+=head2 C<declare>
+
+=cut
+
 sub declare {
  my ($pat, $tikz) = @_;
 
@@ -75,6 +105,10 @@ sub declare {
  return @$template;
 }
 
+=head2 C<apply>
+
+=cut
+
 sub apply { 'fill', 'pattern=' . $_[0]->name($_[1]) }
 
 LaTeX::TikZ::Interface->register(
@@ -96,6 +130,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>.