Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
start docs for Parameter
- Loading branch information
Showing
1 changed file
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |