Skip to content
This repository has been archived by the owner on Mar 14, 2021. It is now read-only.

Commit

Permalink
Document what everything does.
Browse files Browse the repository at this point in the history
  • Loading branch information
nrr committed Apr 17, 2012
1 parent 57621f6 commit 4b41906
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions lib/Data/UUID/Concise.pm
Expand Up @@ -22,19 +22,20 @@ use feature qw[ say ];

=head1 SYNOPSIS
Quick summary of what the module does.
Perhaps a little code snippet.
use Data::UUID::Concise;
my $foo = Data::UUID::Concise->new();
...
my $duc = Data::UUID::Concise->new();
my $encoded_uuid = $duc->encode((Data::UUID->new)->create);
my $decoded_uuid = $duc->decode('M55djt9tt4WoFaL68da9Ef');
=cut

=attr alphabet
This is the collection of symbols that are used for the encoding scheme. By
default, a reasonably unambiguous set of characters is used that is reminiscent
of the base 58 scheme used by a rather prominent photo site's URL shortener.
=cut

has 'alphabet' => (
Expand All @@ -47,6 +48,8 @@ has 'alphabet' => (

=method encode
Encode a Data::UUID instance as a string with the appropriate set of symbols.
=cut

sub encode
Expand All @@ -68,6 +71,9 @@ sub encode

=method decode
Decode a string with the appropriate set of symbols and return a Data::UUID
instance representing the decoded UUID.
=cut

sub decode
Expand Down

0 comments on commit 4b41906

Please sign in to comment.