]> git.vpit.fr Git - perl/modules/LaTeX-TikZ.git/blob - lib/LaTeX/TikZ/Mod.pm
First cut at the documentation
[perl/modules/LaTeX-TikZ.git] / lib / LaTeX / TikZ / Mod.pm
1 package LaTeX::TikZ::Mod;
2
3 use strict;
4 use warnings;
5
6 =head1 NAME
7
8 LaTeX::TikZ::Mod - Base role for LaTeX::TikZ modifiers.
9
10 =head1 VERSION
11
12 Version 0.01
13
14 =cut
15
16 our $VERSION = '0.01';
17
18 =head1 DESCRIPTION
19
20 This role should be consumed by all the modifier classes.
21
22 =cut
23
24 use Any::Moose 'Role';
25 use Any::Moose 'Util::TypeConstraints';
26
27 =head1 METHODS
28
29 These methods are required by the interface :
30
31 =over 4
32
33 =item *
34
35 C<tag>
36
37 =item *
38
39 C<cover>
40
41 =item *
42
43 C<declare>
44
45 =item *
46
47 C<apply>
48
49 =back
50
51 =cut
52
53 requires qw(
54  tag
55  cover
56  declare
57  apply
58 );
59
60 coerce 'LaTeX::TikZ::Mod'
61     => from 'Str'
62     => via { LaTeX::TikZ::Mod::Raw->new(content => $_) };
63
64 =head1 AUTHOR
65
66 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
67
68 You can contact me by mail or on C<irc.perl.org> (vincent).
69
70 =head1 BUGS
71
72 Please report any bugs or feature requests to C<bug-latex-tikz at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=LaTeX-TikZ>.
73 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
74
75 =head1 SUPPORT
76
77 You can find documentation for this module with the perldoc command.
78
79     perldoc LaTeX::TikZ
80
81 =head1 COPYRIGHT & LICENSE
82
83 Copyright 2010 Vincent Pit, all rights reserved.
84
85 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
86
87 =cut
88
89 1; # End of LaTeX::TikZ::Mod