More documentation boilerplate

[perl/modules/LaTeX-TikZ.git] / lib / LaTeX / TikZ / Set / Line.pm

diff --git a/lib/LaTeX/TikZ/Set/Line.pm b/lib/LaTeX/TikZ/Set/Line.pm
index 819ccb9972c5ed3d9483f326ce0a718a18819786..b34c730168259452f213ec1f3926069e98571b70 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Line.pm
+++ b/lib/LaTeX/TikZ/Set/Line.pm
@@ -17,12 +17,27 @@ our $VERSION = '0.01';
 
 use LaTeX::TikZ::Set::Point;
 
+use LaTeX::TikZ::Interface;
 use LaTeX::TikZ::Functor;
 
 use Any::Moose;
 
+=head1 RELATIONSHIPS
+
+This class consumes the L<LaTeX::TikZ::Set::Op> role, and as such implements the L</path> method.
+
+=cut
+
 with 'LaTeX::TikZ::Set::Op';
 
+=head1 ATTRIBUTES
+
+=head2 C<from>
+
+The first endpoint of the line, as a L<LaTeX::TikZ::Set::Point> object.
+
+=cut
+
 has 'from' => (
  is       => 'ro',
  isa      => 'LaTeX::TikZ::Set::Point',
@@ -30,6 +45,12 @@ has 'from' => (
  coerce   => 1,
 );
 
+=head2 C<to>
+
+The second endpoint of the line, also as a L<LaTeX::TikZ::Set::Point> object.
+
+=cut
+
 has 'to' => (
  is       => 'ro',
  isa      => 'LaTeX::TikZ::Set::Point',
@@ -37,17 +58,25 @@ has 'to' => (
  coerce   => 1,
 );
 
+=head1 METHODS
+
+=head2 C<path>
+
+=cut
+
 sub path {
  my $set = shift;
 
  $set->from->path(@_) . ' -- ' . $set->to->path(@_);
 }
 
-use LaTeX::TikZ::Interface line => sub {
- shift;
+LaTeX::TikZ::Interface->register(
+ line => sub {
+  shift;
 
- __PACKAGE__->new(from => $_[0], to => $_[1]);
-};
+  __PACKAGE__->new(from => $_[0], to => $_[1]);
+ },
+);
 
 LaTeX::TikZ::Functor->default_rule(
  (__PACKAGE__) => sub {
@@ -58,6 +87,10 @@ LaTeX::TikZ::Functor->default_rule(
 
 __PACKAGE__->meta->make_immutable;
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Set::Op>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.