Rename LT::Mod->cover to ->covers

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

diff --git a/lib/LaTeX/TikZ/Mod.pm b/lib/LaTeX/TikZ/Mod.pm
index 2bb7c94e0f2331598feaaba17060fe3778b772f7..5c907387ba71cec8d92820fe88b943f678c9db86 100644 (file)
--- 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<covers> on them.
+
 =item *
 
-C<cover>
+C<covers $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
 
@@ -52,7 +62,7 @@ C<apply>
 
 requires qw(
  tag
- cover
+ covers
  declare
  apply
 );