First cut at the documentation

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

diff --git a/lib/LaTeX/TikZ/Functor.pm b/lib/LaTeX/TikZ/Functor.pm
index 8c97432f2c57e1f7df9712b6cced21c4ffff30ef..344816438038170d7a7f5668f9929fc14b67ade9 100644 (file)
--- a/lib/LaTeX/TikZ/Functor.pm
+++ b/lib/LaTeX/TikZ/Functor.pm
@@ -15,6 +15,12 @@ Version 0.01
 
 our $VERSION = '0.01';
 
+=head1 DESCRIPTION
+
+A functor takes a L<LaTeX::TikZ::Set> tree and clones it according to certain rules.
+
+=cut
+
 use Carp ();
 
 use Sub::Name ();
@@ -76,6 +82,12 @@ BEGIN {
  });
 }
 
+=head1 METHODS
+
+=head2 C<default_rule>
+
+=cut
+
 sub default_rule {
  shift;
 
@@ -84,6 +96,10 @@ sub default_rule {
  $insert_rule->($rule, $rule->[2] ? \@default_set_rules : \@default_mod_rules);
 }
 
+=head2 C<< new rules => [ $class_name => sub { ... }, ... ] >>
+
+=cut
+
 sub new {
  my ($class, %args) = @_;