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

index c6961ebe50fe989d9f51f7de209b5d156f952f00..ae7afdaccbe21687cba47d7dce6e716054e5d5a4 100644 (file)
@@ -43,7 +43,13 @@ sub _check_self {
 
 =head1 METHODS
 
-=head2 C<< new < delay => $seconds, speed => $bauds, %bme_options > >>
+=head2 C<new>
+
+    my $ime = IPC::MorseSignals::Emitter->new(
+     delay => $seconds,
+     speed => $bauds,
+     %bme_options,
+    );
 
 Creates a new emitter object. C<delay> specifies the delay between two sends, in seconds, while C<speed> is the number of bits sent per second. The delay value has priority over the speed. Default delay is 1 second. Extra arguments are passed to L<Bit::MorseSignals::Emitter/new>.
 
@@ -66,7 +72,9 @@ sub new {
  bless $self, $class;
 }
 
-=head2 C<send $pid>
+=head2 C<send>
+
+    $ime->send($pid);
 
 Sends messages enqueued with L<Bit::MorseSignals::Emitter/post> to the process C<$pid> (or to all the C<@$pid> if C<$pid> is an array reference, in which case duplicated targets are stripped off).
 
@@ -89,7 +97,10 @@ sub send {
  }
 }
 
-=head2 C<< delay < $seconds > >>
+=head2 C<delay>
+
+    my $delay = $ime->delay;
+    $ime->delay($seconds);
 
 Returns the current delay in seconds, or set it if an argument is provided.
 
@@ -102,7 +113,10 @@ sub delay {
  return $self->{delay};
 }
 
-=head2 C<< speed < $bauds > >>
+=head2 C<speed>
+
+    my $speed = $ime->speed;
+    $ime->speed($bauds);
 
 Returns the current speed in bauds, or set it if an argument is provided.
 
index 714bfe29eb61705c7ad72110ed06ced641a5e287..1d8472f5acd31f74299d85a61b83d8f137e67a15 100644 (file)
@@ -37,6 +37,8 @@ This module installs C<$SIG{qw/USR1 USR2/}> handlers and forwards the bits recei
 
 =head2 C<new>
 
+    my $imr = IPC::MorseSignals::Receiver->new(%bmr_options);
+
 Creates a new receiver object. Its arguments are passed to L<Bit::MorseSignals::Receiver/new>, in particular the C<done> callback.
 
 =cut