From: Vincent Pit <vince@profvince.com>
Date: Sun, 1 Aug 2010 13:05:43 +0000 (+0200)
Subject: Document the Mod role
X-Git-Tag: v0.02~20
X-Git-Url: http://git.vpit.fr/?a=commitdiff_plain;h=d3870fa6f9401ebca85af896fa46b8b594871354;p=perl%2Fmodules%2FLaTeX-TikZ.git

Document the Mod role
---

diff --git a/lib/LaTeX/TikZ/Mod.pm b/lib/LaTeX/TikZ/Mod.pm
index 2bb7c94..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