From: Vincent Pit Date: Fri, 23 Jul 2010 08:30:03 +0000 (+0200) Subject: More documentation boilerplate X-Git-Tag: v0.01~2 X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2FLaTeX-TikZ.git;a=commitdiff_plain;h=0f9d7c1a2d11bc7001fe450cb2086e67c13a39e9 More documentation boilerplate --- diff --git a/lib/LaTeX/TikZ/Formatter.pm b/lib/LaTeX/TikZ/Formatter.pm index 426263f..bd637e8 100644 --- a/lib/LaTeX/TikZ/Formatter.pm +++ b/lib/LaTeX/TikZ/Formatter.pm @@ -284,6 +284,10 @@ LaTeX::TikZ::Interface->register( __PACKAGE__->meta->make_immutable; +=head1 SEE ALSO + +L. + =head1 AUTHOR Vincent Pit, C<< >>, L. diff --git a/lib/LaTeX/TikZ/Functor.pm b/lib/LaTeX/TikZ/Functor.pm index 3448164..e7ee0a6 100644 --- a/lib/LaTeX/TikZ/Functor.pm +++ b/lib/LaTeX/TikZ/Functor.pm @@ -160,6 +160,10 @@ LaTeX::TikZ::Interface->register( }, ); +=head1 SEE ALSO + +L. + =head1 AUTHOR Vincent Pit, C<< >>, L. diff --git a/lib/LaTeX/TikZ/Interface.pm b/lib/LaTeX/TikZ/Interface.pm index ef78fa8..93b0043 100644 --- a/lib/LaTeX/TikZ/Interface.pm +++ b/lib/LaTeX/TikZ/Interface.pm @@ -91,6 +91,10 @@ sub load { require LaTeX::TikZ::Mod::Pattern; # pattern } +=head1 SEE ALSO + +L. + =head1 AUTHOR Vincent Pit, C<< >>, L. diff --git a/lib/LaTeX/TikZ/Mod.pm b/lib/LaTeX/TikZ/Mod.pm index 87cec11..2bb7c94 100644 --- a/lib/LaTeX/TikZ/Mod.pm +++ b/lib/LaTeX/TikZ/Mod.pm @@ -61,6 +61,10 @@ coerce 'LaTeX::TikZ::Mod' => from 'Str' => via { LaTeX::TikZ::Mod::Raw->new(content => $_) }; +=head1 SEE ALSO + +L. + =head1 AUTHOR Vincent Pit, C<< >>, L. diff --git a/lib/LaTeX/TikZ/Mod/Clip.pm b/lib/LaTeX/TikZ/Mod/Clip.pm index 69c401e..f9d9022 100644 --- a/lib/LaTeX/TikZ/Mod/Clip.pm +++ b/lib/LaTeX/TikZ/Mod/Clip.pm @@ -27,8 +27,22 @@ use LaTeX::TikZ::Tools; use Any::Moose; +=head1 RELATIONSHIPS + +This class consumes the L role, and as such implements the L, L, L and L methods. + +=cut + with 'LaTeX::TikZ::Mod'; +=head1 ATTRIBUTES + +=head2 C + +The path that specifies the clipped area. + +=cut + has clip => ( is => 'ro', does => 'LaTeX::TikZ::Set::Op', @@ -41,8 +55,18 @@ my $default_formatter = LaTeX::TikZ::Formatter->new( scale => 1, ); +=head1 METHODS + +=head2 C + +=cut + sub tag { ref $_[0] } +=head2 C + +=cut + my $get_tc = do { my %tc; @@ -128,8 +152,16 @@ sub cover { $old->path($default_formatter) eq $new->path($default_formatter); } +=head2 C + +=cut + sub declare { } +=head2 C + +=cut + sub apply { my ($self) = @_; @@ -156,6 +188,10 @@ LaTeX::TikZ::Functor->default_rule( __PACKAGE__->meta->make_immutable; +=head1 SEE ALSO + +L, L. + =head1 AUTHOR Vincent Pit, C<< >>, L. diff --git a/lib/LaTeX/TikZ/Mod/Color.pm b/lib/LaTeX/TikZ/Mod/Color.pm index 99cfe5f..48e67db 100644 --- a/lib/LaTeX/TikZ/Mod/Color.pm +++ b/lib/LaTeX/TikZ/Mod/Color.pm @@ -19,20 +19,50 @@ use LaTeX::TikZ::Interface; use Any::Moose; +=head1 RELATIONSHIPS + +This class consumes the L role, and as such implements the L, L, L and L methods. + +=cut + with 'LaTeX::TikZ::Mod'; +=head1 ATTRIBUTES + +=head2 C + +=cut + has 'color' => ( is => 'ro', isa => 'Str', required => 1, ); +=head1 METHODS + +=head2 C + +=cut + sub tag { ref $_[0] } +=head2 C + +=cut + sub cover { $_[0]->color eq $_[1]->color } +=head2 C + +=cut + sub declare { } +=head2 C + +=cut + sub apply { 'color=' . $_[0]->color } LaTeX::TikZ::Interface->register( @@ -45,6 +75,10 @@ LaTeX::TikZ::Interface->register( __PACKAGE__->meta->make_immutable; +=head1 SEE ALSO + +L, L. + =head1 AUTHOR Vincent Pit, C<< >>, L. diff --git a/lib/LaTeX/TikZ/Mod/Fill.pm b/lib/LaTeX/TikZ/Mod/Fill.pm index daee627..61aef2b 100644 --- a/lib/LaTeX/TikZ/Mod/Fill.pm +++ b/lib/LaTeX/TikZ/Mod/Fill.pm @@ -19,20 +19,50 @@ use LaTeX::TikZ::Interface; use Any::Moose; +=head1 RELATIONSHIPS + +This class consumes the L role, and as such implements the L, L, L and L methods. + +=cut + with 'LaTeX::TikZ::Mod'; +=head1 ATTRIBUTES + +=head2 C + +=cut + has 'color' => ( is => 'ro', isa => 'Str', required => 1, ); +=head1 METHODS + +=head2 C + +=cut + sub tag { ref $_[0] } +=head2 C + +=cut + sub cover { $_[0]->color eq $_[1]->color } +=head2 C + +=cut + sub declare { } +=head2 C + +=cut + sub apply { 'fill=' . $_[0]->color } LaTeX::TikZ::Interface->register( @@ -45,6 +75,10 @@ LaTeX::TikZ::Interface->register( __PACKAGE__->meta->make_immutable; +=head1 SEE ALSO + +L, L. + =head1 AUTHOR Vincent Pit, C<< >>, L. diff --git a/lib/LaTeX/TikZ/Mod/Formatted.pm b/lib/LaTeX/TikZ/Mod/Formatted.pm index 5bda247..e9b67a9 100644 --- a/lib/LaTeX/TikZ/Mod/Formatted.pm +++ b/lib/LaTeX/TikZ/Mod/Formatted.pm @@ -18,12 +18,22 @@ our $VERSION = '0.01'; use Any::Moose; use Any::Moose 'Util::TypeConstraints'; +=head1 ATTRIBUTES + +=head2 C + +=cut + has 'type' => ( is => 'ro', isa => enum([ qw/clip layer raw/ ]), required => 1, ); +=head2 C + +=cut + has 'content' => ( is => 'ro', isa => 'Str', @@ -34,6 +44,12 @@ coerce 'LaTeX::TikZ::Mod::Formatted' => from 'Str' => via { LaTeX::TikZ::Mod::Formatted->new(type => 'raw', content => $_) }; +=head1 METHODS + +=head2 C + +=cut + sub tag { my ($self) = @_; @@ -42,6 +58,10 @@ sub tag { __PACKAGE__->meta->make_immutable; +=head1 SEE ALSO + +L. + =head1 AUTHOR Vincent Pit, C<< >>, L. diff --git a/lib/LaTeX/TikZ/Mod/Layer.pm b/lib/LaTeX/TikZ/Mod/Layer.pm index 0dd0a84..fda3d59 100644 --- a/lib/LaTeX/TikZ/Mod/Layer.pm +++ b/lib/LaTeX/TikZ/Mod/Layer.pm @@ -25,14 +25,30 @@ use LaTeX::TikZ::Interface; use Any::Moose; use Any::Moose 'Util::TypeConstraints'; +=head1 RELATIONSHIPS + +This class consumes the L role, and as such implements the L, L, L and L methods. + +=cut + with 'LaTeX::TikZ::Mod'; +=head1 ATTRIBUTES + +=head2 C + +=cut + has 'name' => ( is => 'ro', isa => 'Str', required => 1, ); +=head2 C + +=cut + subtype 'LaTeX::TikZ::Mod::LevelList' => as 'ArrayRef[LaTeX::TikZ::Mod::Layer]'; @@ -54,6 +70,10 @@ has '_above' => ( sub above { @{$_[0]->_above} } +=head2 C + +=cut + has '_below' => ( is => 'ro', isa => 'LaTeX::TikZ::Mod::LevelList', @@ -72,6 +92,10 @@ has '_score' => ( builder => '_build_score', ); +=head1 METHODS + +=cut + my %layers; around 'new' => sub { @@ -105,14 +129,26 @@ sub DEMOLISH { delete $layers{$self->name}; } +=head2 C + +=cut + sub tag { my ($self) = @_; ref($self) . '/' . $self->name; } +=head2 C + +=cut + sub cover { $_[0]->name eq $_[1]->name } +=head2 C + +=cut + { our %score; @@ -162,6 +198,10 @@ sub cover { $_[0]->name eq $_[1]->name } $score{$name} } +=head2 C + +=cut + sub declare { shift; @@ -186,6 +226,10 @@ sub cover { $_[0]->name eq $_[1]->name } } } +=head2 C + +=cut + sub apply { my ($self) = @_; @@ -208,6 +252,10 @@ __PACKAGE__->meta->make_immutable( inline_constructor => 0, ); +=head1 SEE ALSO + +L, L. + =head1 AUTHOR Vincent Pit, C<< >>, L. diff --git a/lib/LaTeX/TikZ/Mod/Pattern.pm b/lib/LaTeX/TikZ/Mod/Pattern.pm index ddae7e2..230af5b 100644 --- a/lib/LaTeX/TikZ/Mod/Pattern.pm +++ b/lib/LaTeX/TikZ/Mod/Pattern.pm @@ -19,8 +19,20 @@ use LaTeX::TikZ::Interface; use Any::Moose; +=head1 RELATIONSHIPS + +This class consumes the L role, and as such implements the L, L, L and L methods. + +=cut + with 'LaTeX::TikZ::Mod'; +=head1 ATTRIBUTES + +=head2 C