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 6496b06ebb9e8971d44ba95b1047de2daeba982c..ef78fa8b1644abb7765861bb95699028f21d0a05 100644 (file)
--- a/lib/LaTeX/TikZ/Interface.pm
+++ b/lib/LaTeX/TikZ/Interface.pm
@@ -17,13 +17,17 @@ our $VERSION = '0.01';
 
 use Sub::Name ();
 
-sub import {
- shift;
+=head1 METHODS
 
- register(@_);
-}
+=head2 C<< register $keyword => $code >>
+
+Registers C<$code> to be available with C<< Tikz->$keyword >>.
+
+=cut
 
 sub register {
+ shift;
+
  while (@_ >= 2) {
   my ($name, $code) = splice @_, 0, 2;
 
@@ -53,8 +57,15 @@ 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
 
  require LaTeX::TikZ::Set::Raw;       # raw
 
@@ -66,6 +77,8 @@ sub load {
  require LaTeX::TikZ::Set::Polyline;  # polyline, closed_polyline
  require LaTeX::TikZ::Set::Rectangle; # rectangle
  require LaTeX::TikZ::Set::Circle;    # circle
+ require LaTeX::TikZ::Set::Arc;       # arc
+ require LaTeX::TikZ::Set::Arrow;     # arrow
 
  require LaTeX::TikZ::Mod::Raw;       # raw_mod
 
@@ -75,6 +88,7 @@ sub load {
  require LaTeX::TikZ::Mod::Width;     # width
  require LaTeX::TikZ::Mod::Color;     # color
  require LaTeX::TikZ::Mod::Fill;      # fill
+ require LaTeX::TikZ::Mod::Pattern;   # pattern
 }
 
 =head1 AUTHOR