More documentation boilerplate

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

diff --git a/lib/LaTeX/TikZ/Mod/Width.pm b/lib/LaTeX/TikZ/Mod/Width.pm
index 345b3575d41ef3ce4f69d2123b9aa9996e0fb200..58a8804faced24824db0f39df6f2c9451f6cc178 100644 (file)
--- a/lib/LaTeX/TikZ/Mod/Width.pm
+++ b/lib/LaTeX/TikZ/Mod/Width.pm
@@ -15,34 +15,72 @@ Version 0.01
 
 our $VERSION = '0.01';
 
+use LaTeX::TikZ::Interface;
+
 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<width>
+
+=cut
+
 has 'width' => (
  is       => 'ro',
  isa      => 'Int',
  required => 1,
 );
 
+=head1 METHODS
+
+=head2 C<tag>
+
+=cut
+
 sub tag { ref $_[0] }
 
+=head2 C<cover>
+
+=cut
+
 sub cover { LaTeX::TikZ::Tools::numeq($_[0]->width, $_[1]->width) }
 
+=head2 C<declare>
+
+=cut
+
 sub declare { }
 
+=head2 C<apply>
+
+=cut
+
 sub apply { sprintf 'line width=%0.1fpt', $_[1]->thickness($_[0]->width) }
 
-use LaTeX::TikZ::Interface width => sub {
- shift;
+LaTeX::TikZ::Interface->register(
+ width => sub {
+  shift;
 
- __PACKAGE__->new(width => $_[0]);
-};
+  __PACKAGE__->new(width => $_[0]);
+ },
+);
 
 __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>.