X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FBit%2FMorseSignals.pm;h=44501760e3b584ea8c9937abcdf00a1014584cc4;hb=35563d8644a10b1ac4a4434e000708abb9c5f476;hp=a8d13f6faa85c191c537a6f7f19d2030ab61ed06;hpb=ed888890547450e75030085fadb958c5ea2a6421;p=perl%2Fmodules%2FBit-MorseSignals.git

diff --git a/lib/Bit/MorseSignals.pm b/lib/Bit/MorseSignals.pm
index a8d13f6..4450176 100644
--- a/lib/Bit/MorseSignals.pm
+++ b/lib/Bit/MorseSignals.pm
@@ -9,11 +9,22 @@ Bit::MorseSignals - The MorseSignals protocol.
 
 =head1 VERSION
 
-Version 0.02
+Version 0.08
 
 =cut
 
-our $VERSION = '0.02';
+our $VERSION = '0.08';
+
+=head1 SYNOPSIS
+
+    use Bit::MorseSignals::Emitter;
+    use Bit::MorseSignals::Receiver;
+
+    my $deuce = Bit::MorseSignals::Emitter->new;
+    my $pants = Bit::MorseSignals::Receiver->new(done => sub { print $_[1], "\n" });
+
+    $deuce->post('HLAGH') for 1 .. 3;
+    $pants->push while defined ($_ = $deuce->pop);
 
 =head1 DESCRIPTION
 
@@ -23,9 +34,13 @@ An actual implementation is also provided :
 
 =over 4
 
-=item L<Bit::MorseSignals::Emitter> is a base class for emitters ;
+=item *
+
+L<Bit::MorseSignals::Emitter> is a base class for emitters ;
+
+=item *
 
-=item L<Bit::MorseSignals::Receiver> is a base class for receivers ;
+L<Bit::MorseSignals::Receiver> is a base class for receivers.
 
 =back
 
@@ -39,9 +54,13 @@ The header is composed of three bits (lowest weight coming first) :
 
 =over 4
 
-=item - The 2 first ones denote the data type : a value of 0 is used for a plain string, 1 for an UTF-8 encoded string, and 2 for a L<Storable> object. See also the L</CONSTANTS> section ;
+=item *
 
-=item - The third one is reserved. For compatibility reasons, the receiver should for now enforce the message data type to plain when this bit is lit.
+The 2 first ones denote the data type : a value of 0 is used for a plain string, 1 for an UTF-8 encoded string, and 2 for a L<Storable> object. See also the L</CONSTANTS> section ;
+
+=item *
+
+The third one is reserved. For compatibility reasons, the receiver should for now enforce the message data type to plain when this bit is lit.
 
 =back
 
@@ -49,9 +68,13 @@ The emitter computes then the longuest sequence of successives 0 (say, m) and 1
 
 =over 4
 
-=item - If m > n, we take n+1 times 1 followed by one 0 ;
+=item *
+
+If m > n, we take n+1 times 1 followed by one 0 ;
 
-=item - Otherwise, we take m+1 times 0 followed by one 1.
+=item *
+
+Otherwise, we take m+1 times 0 followed by one 1.
 
 =back
 
@@ -95,11 +118,11 @@ The constants L</BM_DATA_AUTO>, L</BM_DATA_PLAIN>, L</BM_DATA_UTF8> and L</BM_DA
 
 =cut
 
-use base qw/Exporter/;
+use base qw<Exporter>;
 
 our @EXPORT         = ();
 our %EXPORT_TAGS    = (
- 'consts' => [ qw/BM_DATA_AUTO BM_DATA_PLAIN BM_DATA_UTF8 BM_DATA_STORABLE/ ]
+ 'consts' => [ qw<BM_DATA_AUTO BM_DATA_PLAIN BM_DATA_UTF8 BM_DATA_STORABLE> ]
 );
 our @EXPORT_OK      = map { @$_ } values %EXPORT_TAGS;
 $EXPORT_TAGS{'all'} = [ @EXPORT_OK ];
@@ -114,9 +137,9 @@ L<Bit::MorseSignals::Emitter>, L<Bit::MorseSignals::Receiver>.
 
 =head1 AUTHOR
 
-Vincent Pit, C<< <perl at profvince.com> >>
+Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
 
-You can contact me by mail or on #perl @ FreeNode (vincent or Prof_Vince).
+You can contact me by mail or on C<irc.perl.org> (vincent).
 
 =head1 BUGS
 
@@ -128,6 +151,8 @@ You can find documentation for this module with the perldoc command.
 
     perldoc Bit::MorseSignals
 
+Tests code coverage report is available at L<http://www.profvince.com/perl/cover/Bit-MorseSignals>.
+
 =head1 COPYRIGHT & LICENSE
 
 Copyright 2008 Vincent Pit, all rights reserved.