better event emitter example

mojolicious · Oct 11, 2011 · 702f19c · 702f19c
1 parent 714de84
commit 702f19c
Showing 1 changed file with 13 additions and 9 deletions.
diff --git a/lib/Mojo/EventEmitter.pm b/lib/Mojo/EventEmitter.pm
@@ -98,20 +98,24 @@ Mojo::EventEmitter - Event emitter base class
 
 =head1 SYNOPSIS
 
-  # Subclass
   package Cat;
   use Mojo::Base 'Mojo::EventEmitter';
 
+  # Emit events
+  sub poke {
+    my $self = shift;
+    $self->emit(roar => 3);
+  }
+
   package main;
 
+  # Subscribe to events
   my $tiger = Cat->new;
-
   $tiger->on(roar => sub {
     my ($self, $times) = @_;
     say 'RAWR!' for 1 .. $times;
   });
-
-  $tiger->emit(roar => 5);
+  $tiger->poke;
 
 =head1 DESCRIPTION
 
@@ -125,17 +129,17 @@ implements the following new ones.
 
 =head2 C<emit>
 
-  $e->emit('foo');
-  $e->emit('foo', 123);
+  $e = $e->emit('foo');
+  $e = $e->emit('foo', 123);
 
 Emit event.
 
 =head2 C<emit_safe>
 
-  $e->emit_safe('foo');
-  $e->emit_safe('foo', 123);
+  $e = $e->emit_safe('foo');
+  $e = $e->emit_safe('foo', 123);
 
-Emit event safely.
+Emit event safely and emit C<error> event on failure.
 
 =head2 C<has_subscribers>