X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FLaTeX%2FTikZ%2FMod.pm;h=c904d26162f812e3a24d81deb3e303f47e81af4a;hb=4f696c03a66ef6b52ee7b9b3c74a71d5abc64f7e;hp=dbee13dbeef4db32039a8cdde8de9661b120c311;hpb=e8f0879ade07eed4f58cd52c0771f4e1ecc90b09;p=perl%2Fmodules%2FLaTeX-TikZ.git

diff --git a/lib/LaTeX/TikZ/Mod.pm b/lib/LaTeX/TikZ/Mod.pm
index dbee13d..c904d26 100644
--- a/lib/LaTeX/TikZ/Mod.pm
+++ b/lib/LaTeX/TikZ/Mod.pm
@@ -9,25 +9,71 @@ LaTeX::TikZ::Mod - Base role for LaTeX::TikZ modifiers.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.03
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.03';
 
-use Any::Moose 'Role';
-use Any::Moose 'Util::TypeConstraints';
+=head1 DESCRIPTION
 
-requires qw(
+This role should be consumed by all the modifier classes.
+
+=cut
+
+use Mouse::Role;
+use Mouse::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<covers> on them.
+
+=item *
+
+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 $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
+ covers
  declare
  apply
-);
+>;
 
 coerce 'LaTeX::TikZ::Mod'
     => from 'Str'
-    => via { LaTeX::TikZ::Mod::Raw->new($_) };
+    => via { LaTeX::TikZ::Mod::Raw->new(content => $_) };
+
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>.
 
 =head1 AUTHOR
 
@@ -48,7 +94,7 @@ You can find documentation for this module with the perldoc command.
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2010 Vincent Pit, all rights reserved.
+Copyright 2010,2011,2012,2013,2014,2015 Vincent Pit, all rights reserved.
 
 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.