First cut at the documentation

[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 8efdd9841155eb25a12275eac0522ab9a368bd49..c035562cad6fbe0d5505fec979dd8e25c634796a 100644 (file)
--- a/lib/LaTeX/TikZ/Set/Circle.pm
+++ b/lib/LaTeX/TikZ/Set/Circle.pm
@@ -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,12 +48,24 @@ has 'center' => (
  coerce   => 1,
 );
 
+=head2 C<radius>
+
+The radius of the circle as a non-negative real number.
+
+=cut
+
 has 'radius' => (
  is       => 'ro',
  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];