From: Vincent Pit Date: Fri, 23 Aug 2013 17:12:40 +0000 (-0300) Subject: Make sure the POD headings are linkable X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2FBit-MorseSignals.git;a=commitdiff_plain;h=68eb455d71803aa45fd67f97c9dd628fff59e1c4 Make sure the POD headings are linkable --- diff --git a/lib/Bit/MorseSignals/Emitter.pm b/lib/Bit/MorseSignals/Emitter.pm index a384d14..7e11c1d 100644 --- a/lib/Bit/MorseSignals/Emitter.pm +++ b/lib/Bit/MorseSignals/Emitter.pm @@ -64,6 +64,8 @@ sub _count_bits { =head2 C + my $bme = Bit::MorseSignals::Emitter->new; + L object constructor. Currently does not take any optional argument. =cut @@ -81,7 +83,9 @@ sub new { return $self; } -=head2 C<< post $msg, < type => $type > >> +=head2 C + + $bme->post($msg, type => $type); Adds C<$msg> to the message queue and, if no other message is currently processed, dequeue the oldest item and prepare it. The type is automatically chosen, but you may want to try to force it with the C option : C<$type> is then one of the C constants listed in L diff --git a/lib/Bit/MorseSignals/Receiver.pm b/lib/Bit/MorseSignals/Receiver.pm index 9cbb8b1..1eb7bef 100644 --- a/lib/Bit/MorseSignals/Receiver.pm +++ b/lib/Bit/MorseSignals/Receiver.pm @@ -46,7 +46,9 @@ sub _check_self { =head1 METHODS -=head2 C<< new < done => $cb > >> +=head2 C + + my $bmr = Bit::MorseSignals::Receiver->new(done => $cb); L object constructor. With the C<'done'> option, you can specify a callback that will be triggered every time a message is completed, and in which C<$_[0]> will be the receiver object and C<$_[1]> the message received. @@ -66,7 +68,9 @@ sub new { return $self; } -=head2 C +=head2 C + + $bmr->push($bit); Tells the receiver that you have received the bit C<$bit>. Returns true while the message isn't completed, and C as soon as it is.