X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FLaTeX%2FTikZ%2FMod.pm;h=de90607ee1ac9e210b2cfd19d43aef8d28ccf721;hb=70bf7dc15c8554386d2eb47fbc3d8233e5d52928;hp=b5921e9bcd3199d79b662e84a1481804e56af81c;hpb=17bd99ecff97751a8323f7f89a97bacb7cd29ec2;p=perl%2Fmodules%2FLaTeX-TikZ.git

diff --git a/lib/LaTeX/TikZ/Mod.pm b/lib/LaTeX/TikZ/Mod.pm
index b5921e9..de90607 100644
--- a/lib/LaTeX/TikZ/Mod.pm
+++ b/lib/LaTeX/TikZ/Mod.pm
@@ -15,9 +15,51 @@ Version 0.01
 
 our $VERSION = '0.01';
 
+=head1 DESCRIPTION
+
+This role should be consumed by all the modifier classes.
+
+=cut
+
 use Any::Moose 'Role';
 use Any::Moose 'Util::TypeConstraints';
 
+=head1 METHODS
+
+These methods are required by the interface :
+
+=over 4
+
+=item *
+
+C<tag>
+
+Returns an identifier for the mod object.
+It is used to gather mods together when calling C<cover> on them.
+
+=item *
+
+C<cover $mod>
+
+Returns true if and only if the effects of the mod C<$mod> are already ensured by the current mod object, in which case no actual TikZ code will be emitted for C<$mod>.
+Both mod objects are guaranteed to have the same C<tag>.
+
+=item *
+
+C<declare $formatter>
+
+Returns an array reference of TikZ code lines required to declare this mod before using it, formatted by the L<LaTeX::TikZ::Formatter> object C<$formatter> ; or C<undef> if no declarations are needed for this mod.
+
+=item *
+
+C<apply $formatter>
+
+Returns the TikZ code that activates the current mod as a string formatted by the L<LaTeX::TikZ::Formatter> object C<$formatter>.
+
+=back
+
+=cut
+
 requires qw(
  tag
  cover
@@ -29,6 +71,10 @@ coerce 'LaTeX::TikZ::Mod'
     => from 'Str'
     => via { LaTeX::TikZ::Mod::Raw->new(content => $_) };
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.