This is 0.02

[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..d1f7317bb69ba6f70d232ced9b359831ee92455a 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.02
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
 
 use LaTeX::TikZ::Set::Point;
 
@@ -25,8 +25,22 @@ use LaTeX::TikZ::Tools;
 use Any::Moose;
 use Any::Moose 'Util::TypeConstraints';
 
+=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<center>
+
+A L<LaTeX::TikZ::Set::Point> object describing the center of the circle.
+
+=cut
+
 has 'center' => (
  is       => 'ro',
  isa      => 'LaTeX::TikZ::Set::Point',
@@ -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];
@@ -72,6 +93,10 @@ LaTeX::TikZ::Functor->default_rule(
 
 __PACKAGE__->meta->make_immutable;
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Set>, L<LaTeX::TikZ::Set::Op>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.