First cut at the documentation

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

diff --git a/lib/LaTeX/TikZ/Interface.pm b/lib/LaTeX/TikZ/Interface.pm
index adf63f90802f2a2d5ee44fbe5d1779ed4cf0b207..ef78fa8b1644abb7765861bb95699028f21d0a05 100644 (file)
--- a/lib/LaTeX/TikZ/Interface.pm
+++ b/lib/LaTeX/TikZ/Interface.pm
@@ -17,6 +17,14 @@ our $VERSION = '0.01';
 
 use Sub::Name ();
 
+=head1 METHODS
+
+=head2 C<< register $keyword => $code >>
+
+Registers C<$code> to be available with C<< Tikz->$keyword >>.
+
+=cut
+
 sub register {
  shift;
 
@@ -49,6 +57,12 @@ sub register {
  return;
 }
 
+=head2 C<load>
+
+Load all the modules of the L<LaTeX::TikZ> official suite that register a keyword in the interface.
+
+=cut
+
 sub load {
  require LaTeX::TikZ::Formatter;      # formatter
  require LaTeX::TikZ::Functor;        # functor