Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
add some basic Enum documentation
  • Loading branch information
moritz committed Jun 13, 2012
1 parent 6e05ed4 commit 27f60af
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions lib/Enum.pod
@@ -0,0 +1,31 @@
=begin pod
=head1 Enum
class Enum does Associative { ... }
An C<Enum> consists of a key and a value. It is the immutable version of
C<Pair> (which inherits from Enum).
=head2 Methods
=head3 key
multi method key(Enum:D:)
Returns the key part of the Enum
=head3 value
multi method value(Enum:D:)
Returns the value part of the Enum
=head3 invert
multi method invert(Enum:D:) returns Enum:D
Returns a new C<Enum> with the original enum's value as the key, and the
original enum's key as value.
=end pod

0 comments on commit 27f60af

Please sign in to comment.