This is 0.03

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

diff --git a/lib/LaTeX/TikZ/Set/Circle.pm b/lib/LaTeX/TikZ/Set/Circle.pm
index 06a692aec4f8149a2ac3475b104083b406eb6889..070cac62cbe335eba304243ad170b53744344338 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Circle.pm
+++ b/lib/LaTeX/TikZ/Set/Circle.pm
@@ -9,11 +9,11 @@ LaTeX::TikZ::Set::Circle - A set object representing a circle.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.03
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.03';
 
 use LaTeX::TikZ::Set::Point;
 
@@ -22,10 +22,24 @@ use LaTeX::TikZ::Functor;
 
 use LaTeX::TikZ::Tools;
 
-use Any::Moose;
-use Any::Moose 'Util::TypeConstraints';
+use Mouse;
+use Mouse::Util::TypeConstraints;
 
-with 'LaTeX::TikZ::Set::Op';
+=head1 RELATIONSHIPS
+
+This class consumes the L<LaTeX::TikZ::Set::Path> role, and as such implements the L</path> method.
+
+=cut
+
+with 'LaTeX::TikZ::Set::Path';
+
+=head1 ATTRIBUTES
+
+=head2 C<center>
+
+A L<LaTeX::TikZ::Set::Point> object describing the center of the circle.
+
+=cut
 
 has 'center' => (
  is       => 'ro',
@@ -34,17 +48,24 @@ has 'center' => (
  coerce   => 1,
 );
 
-subtype 'LaTeX::TikZ::Set::Circle::Radius'
-     => as 'Num'
-     => where { LaTeX::TikZ::Tools::numcmp($_, 0) >= 1 }
-     => message { "$_ isn't a non-negative real number" };
+=head2 C<radius>
+
+The radius of the circle as a non-negative real number.
+
+=cut
 
 has 'radius' => (
  is       => 'ro',
- isa      => 'LaTeX::TikZ::Set::Circle::Radius',
+ isa      => subtype('Num' => where { LaTeX::TikZ::Tools::numcmp($_, 0) > 0 }),
  required => 1,
 );
 
+=head1 METHODS
+
+=head2 C<path>
+
+=cut
+
 sub path {
  my $set  = shift;
  my $tikz = $_[0];
@@ -52,6 +73,18 @@ sub path {
  $set->center->path(@_) . ' circle (' . $tikz->len($set->radius) . ')';
 }
 
+=head2 C<begin>
+
+=cut
+
+sub begin { $_[0]->center->begin }
+
+=head2 C<end>
+
+=cut
+
+sub end { $_[0]->center->end }
+
 LaTeX::TikZ::Interface->register(
  circle => sub {
   shift;
@@ -72,6 +105,10 @@ LaTeX::TikZ::Functor->default_rule(
 
 __PACKAGE__->meta->make_immutable;
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Set>, L<LaTeX::TikZ::Set::Path>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
@@ -91,7 +128,7 @@ You can find documentation for this module with the perldoc command.
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2010 Vincent Pit, all rights reserved.
+Copyright 2010,2011,2012,2013,2014,2015 Vincent Pit, all rights reserved.
 
 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.