]> git.vpit.fr Git - perl/modules/Bit-MorseSignals.git/commitdiff
Make sure the POD headings are linkable
authorVincent Pit <vince@profvince.com>
Fri, 23 Aug 2013 17:12:40 +0000 (14:12 -0300)
committerVincent Pit <vince@profvince.com>
Fri, 23 Aug 2013 17:12:40 +0000 (14:12 -0300)
lib/Bit/MorseSignals/Emitter.pm
lib/Bit/MorseSignals/Receiver.pm

index a384d148a6c48c36e65c93b9254cc57b2a9ae63e..7e11c1dbe66f1865bb9343af5eebaf5f0bb6959e 100644 (file)
@@ -64,6 +64,8 @@ sub _count_bits {
 
 =head2 C<new>
 
+    my $bme = Bit::MorseSignals::Emitter->new;
+
 L<Bit::MorseSignals::Emitter> 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<post>
+
+    $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<type> option : C<$type> is then one of the C<BM_DATA_*> constants listed in L<Bit::MorseSignals/CONSTANTS>
 
index 9cbb8b19bce2c3d3690f180bda2fb05106005c7e..1eb7befe980215f25a39526ba1335299e42c68ce 100644 (file)
@@ -46,7 +46,9 @@ sub _check_self {
 
 =head1 METHODS
 
-=head2 C<< new < done => $cb > >>
+=head2 C<new>
+
+    my $bmr = Bit::MorseSignals::Receiver->new(done => $cb);
 
 L<Bit::MorseSignals::Receiver> 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<push $bit>
+=head2 C<push>
+
+    $bmr->push($bit);
 
 Tells the receiver that you have received the bit C<$bit>. Returns true while the message isn't completed, and C<undef> as soon as it is.