From 32e45ff1c563d941b82bff8a9f1e86443fba7599 Mon Sep 17 00:00:00 2001 From: Cory Watson Date: Fri, 8 May 2009 13:22:39 -0500 Subject: [PATCH 1/2] Document sig --- lib/Parse/Method/Signatures/Sig.pm | 48 ++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/lib/Parse/Method/Signatures/Sig.pm b/lib/Parse/Method/Signatures/Sig.pm index d51034a..882a001 100644 --- a/lib/Parse/Method/Signatures/Sig.pm +++ b/lib/Parse/Method/Signatures/Sig.pm @@ -106,3 +106,51 @@ sub to_string { __PACKAGE__->meta->make_immutable; 1; + +__END__ + +=head1 NAME + +Parse::Method::Signatures::Sig - Method Signature + +=head1 DESCRIPTION + +Represents the parsed method signature. + +=head1 ATTRIBUTES + +=head2 invocant + +=head2 named_params + +A ParamCollection representing the name parameters of this signature. + +=head2 positional_params + +A ParamCollection representing the positional parameters of this signature. + +=head1 METHODS + +=head2 has_named_params + +Predicate returning true if this signature has named parameters. + +=head2 has_positional_params + +Predicate returning true if this signature has positional parameters. + +=head2 named_param + +Returns the Param with the specified name. + +=head2 to_string + +Returns a string representation of this signature. + +=head1 AUTHOR + +Florian Ragwitz . + +=head1 LICENSE + +Licensed under the same terms as Perl itself. \ No newline at end of file From e8bd48ab636a3c48e423ab4a560e0c4486ed1b3d Mon Sep 17 00:00:00 2001 From: Cory Watson Date: Fri, 8 May 2009 13:24:18 -0500 Subject: [PATCH 2/2] Remove author, since it doesn't matter. --- lib/Parse/Method/Signatures/Sig.pm | 4 ---- 1 file changed, 4 deletions(-) diff --git a/lib/Parse/Method/Signatures/Sig.pm b/lib/Parse/Method/Signatures/Sig.pm index 882a001..1942007 100644 --- a/lib/Parse/Method/Signatures/Sig.pm +++ b/lib/Parse/Method/Signatures/Sig.pm @@ -147,10 +147,6 @@ Returns the Param with the specified name. Returns a string representation of this signature. -=head1 AUTHOR - -Florian Ragwitz . - =head1 LICENSE Licensed under the same terms as Perl itself. \ No newline at end of file