X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FLaTeX%2FTikZ%2FMod.pm;h=de90607ee1ac9e210b2cfd19d43aef8d28ccf721;hb=d3870fa6f9401ebca85af896fa46b8b594871354;hp=87cec117c14162236baeeff5f8dbf6ca6811f994;hpb=e6c6fbca8df4f8df7bbce2eb98dd260ed51d9141;p=perl%2Fmodules%2FLaTeX-TikZ.git

diff --git a/lib/LaTeX/TikZ/Mod.pm b/lib/LaTeX/TikZ/Mod.pm
index 87cec11..de90607 100644
--- a/lib/LaTeX/TikZ/Mod.pm
+++ b/lib/LaTeX/TikZ/Mod.pm
@@ -34,17 +34,27 @@ These methods are required by the interface :
 
 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>
+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>
+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>
+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
 
@@ -61,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>.