Fix ->content description of raw mods and sets

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

diff --git a/lib/LaTeX/TikZ/Mod/Raw.pm b/lib/LaTeX/TikZ/Mod/Raw.pm
index 1d0572086adacf3e7f80c4f1588f099c339ba6a9..a4caa72d6ff32c8345e8f1c2eefd01302fff01e5 100644 (file)
--- a/lib/LaTeX/TikZ/Mod/Raw.pm
+++ b/lib/LaTeX/TikZ/Mod/Raw.pm
@@ -9,42 +9,82 @@ LaTeX::TikZ::Mod::Raw - A literal TikZ modifier.
 
 =head1 VERSION
 
-Version 0.01
+Version 0.02
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
+
+use LaTeX::TikZ::Interface;
 
 use Any::Moose;
 
+=head1 RELATIONSHIPS
+
+This class consumes the L<LaTeX::TikZ::Mod> role, and as such implements the L</tag>, L</covers>, L</declare> and L</apply> methods.
+
+=cut
+
 with 'LaTeX::TikZ::Mod';
 
+=head1 ATTRIBUTES
+
+=head2 C<content>
+
+The bare string the raw mod is made of.
+
+=cut
+
 has 'content' => (
  is       => 'ro',
  isa      => 'Str',
  required => 1,
 );
 
+=head1 METHODS
+
+=head2 C<tag>
+
+=cut
+
 sub tag {
  my ($self) = @_;
 
  ref($self) . '/' . $self->content;
 }
 
-sub cover { 1 }
+=head2 C<covers>
+
+=cut
+
+sub covers { 0 }
+
+=head2 C<declare>
+
+=cut
 
 sub declare { }
 
+=head2 C<apply>
+
+=cut
+
 sub apply { $_[0]->content }
 
-use LaTeX::TikZ::Interface raw_mod => sub {
- shift;
+LaTeX::TikZ::Interface->register(
+ raw_mod => sub {
+  shift;
 
- __PACKAGE__->new(content => $_[0]);
-};
+  __PACKAGE__->new(content => $_[0]);
+ },
+);
 
 __PACKAGE__->meta->make_immutable;
 
+=head1 SEE ALSO
+
+L<LaTeX::TikZ>, L<LaTeX::TikZ::Mod>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.