First cut at the documentation

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

diff --git a/lib/LaTeX/TikZ/Set/Rectangle.pm b/lib/LaTeX/TikZ/Set/Rectangle.pm
index 79dda06e264f662f83eb6c26bf916f300c250cac..3d11cc57a5aaf1f514edfdf18d2cd626ab00453b 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Rectangle.pm
+++ b/lib/LaTeX/TikZ/Set/Rectangle.pm
@@ -22,8 +22,22 @@ 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 corner of the rectangle, as a L<LaTeX::TikZ::Set::Point> object.
+
+=cut
+
 has 'from' => (
  is       => 'ro',
  isa      => 'LaTeX::TikZ::Set::Point',
@@ -31,6 +45,12 @@ has 'from' => (
  coerce   => 1,
 );
 
+=head2 C<to>
+
+The opposite endpoint of the rectangle, also as a L<LaTeX::TikZ::Set::Point> object.
+
+=cut
+
 has 'to' => (
  is       => 'ro',
  isa      => 'LaTeX::TikZ::Set::Point',
@@ -38,16 +58,34 @@ has 'to' => (
  coerce   => 1,
 );
 
+=head2 C<width>
+
+The algebraic width of the rectangle.
+
+=cut
+
 has 'width' => (
  is  => 'ro',
  isa => 'Num',
 );
 
+=head2 C<height>
+
+The algebraic height of the rectangle.
+
+=cut
+
 has 'height' => (
  is  => 'ro',
  isa => 'Num',
 );
 
+=head1 METHODS
+
+=head2 C<path>
+
+=cut
+
 sub path {
  my $set = shift;
 
@@ -63,9 +101,12 @@ around 'BUILDARGS' => sub {
  my $class = shift;
 
  if (@_ == 2 and $tc1->check($_[0]) and $tc2->check($_[1])) {
+  my ($from, $to) = @_;
   @_ = (
-   from => $_[0],
-   to   => $_[1],
+   from   => $from,
+   to     => $to,
+   width  => $to->x - $from->x,
+   height => $to->y - $from->y,
   );
  } else {
   my %args = @_;