First cut at the documentation

[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 6e73e38b5bb24106c6ecceb85f552b031c239efa..bf41d14ac24fcfedbb30e20560765df3897726ff 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Line.pm
+++ b/lib/LaTeX/TikZ/Set/Line.pm
@@ -15,33 +15,75 @@ Version 0.01
 
 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',
- does     => 'LaTeX::TikZ::Point',
+ isa      => 'LaTeX::TikZ::Set::Point',
  required => 1,
+ 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',
- does     => 'LaTeX::TikZ::Point',
+ isa      => 'LaTeX::TikZ::Set::Point',
  required => 1,
+ 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 {
+  my ($functor, $set, @args) = @_;
+  $set->new(map { $_ => $set->$_->$functor(@args) } qw/from to/)
+ }
+);
 
 __PACKAGE__->meta->make_immutable;