This is 0.02

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

diff --git a/lib/LaTeX/TikZ/Tools.pm b/lib/LaTeX/TikZ/Tools.pm
index 9a33324ea1dce4eb933e5f40b62b54088b5a5724..4650acfba5336c7b4f893d4fa4829aa9d04a6274 100644 (file)
--- a/lib/LaTeX/TikZ/Tools.pm
+++ b/lib/LaTeX/TikZ/Tools.pm
@@ -5,30 +5,56 @@ use warnings;
 
 =head1 NAME
 
-LaTeX::TikZ::Tools - Miscellanous tools for LaTeX::TikZ classes.
+LaTeX::TikZ::Tools - Miscellaneous tools for LaTeX::TikZ classes.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.02
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
 
 use Any::Moose 'Util::TypeConstraints' => [ 'find_type_constraint' ];
 
+=head1 CONSTANTS
+
+=head2 C<EPS>
+
+=cut
+
 use constant EPS => 1e-10;
 
+=head1 FUNCTIONS
+
+=head2 C<numeq>
+
+=cut
+
 sub numeq { abs($_[0] - $_[1]) < EPS }
 
+=head2 C<numcmp>
+
+=cut
+
 sub numcmp { $_[0] < $_[1] - EPS ? -1 : $_[0] > $_[1] + EPS ? 1 : 0 }
 
+=head2 C<numround>
+
+=cut
+
 sub numround {
  my $x = $_[0];
  my $i = int $x;
  $x + EPS < $i + 0.5 ? $i : $i + 1;
 }
 
+=head2 C<type_constraint $class>
+
+Find the type constraint for C<$class> by loading the relevant F<.pm> file beforehand.
+
+=cut
+
 sub type_constraint {
  my ($class) = @_;
 
@@ -40,6 +66,10 @@ sub type_constraint {
  find_type_constraint($class);
 }
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.