Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
start docs for Parameter
  • Loading branch information
moritz committed Jul 20, 2012
1 parent 36fe0e4 commit af791a4
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions lib/Parameter.pod
@@ -0,0 +1,44 @@
=begin pod
=TITLE class Parameter
class Parameter { }
Represents a parameter, for purpose of introspection.
=head1 Methods
=head2 name
Returns the variable name
=head2 constraints
Returns additional constraints on the parameter (usually as an
C<all>-Junction).
=head2 type
Returns the nominal type constraint of the paramter
=head2 named
Returns C<True> if it's a named parameter
=head2 named_names
Returns a list of names/aliases for this parameter
=head2 positional
Returns C<True> if the parameter is positional.
=head2 slurpy
Returns C<True> for slurpy parameters
=head2 optional
Returns C<True> for optional parameters
=end pod

0 comments on commit af791a4

Please sign in to comment.