Adjust event docs to use fake docblocks

igorw · igorw · commit a5a0f9eb63a5 · 2012-12-14T01:58:14.000+01:00
diff --git a/src/React/Http/RequestHeaderParser.php b/src/React/Http/RequestHeaderParser.php
@@ -5,7 +5,10 @@
 use Evenement\EventEmitter;
 use Guzzle\Parser\Message\MessageParser;
 
-// Events: headers, error
+/**
+ * @event headers
+ * @event error
+ */
 class RequestHeaderParser extends EventEmitter
 {
     private $buffer = '';
diff --git a/src/React/Http/Server.php b/src/React/Http/Server.php
@@ -6,7 +6,7 @@
 use React\Socket\ServerInterface as SocketServerInterface;
 use React\Socket\ConnectionInterface;
 
-// Events: request
+/** @event request */
 class Server extends EventEmitter implements ServerInterface
 {
     private $io;
diff --git a/src/React/HttpClient/Request.php b/src/React/HttpClient/Request.php
@@ -13,7 +13,10 @@
 use React\Stream\Stream;
 use React\Stream\WritableStreamInterface;
 
-// Events: headers-written, response
+/**
+ * @event headers-written
+ * @event response
+ */
 class Request extends EventEmitter implements WritableStreamInterface
 {
     const STATE_INIT = 0;
diff --git a/src/React/Socket/Server.php b/src/React/Socket/Server.php
@@ -5,7 +5,7 @@
 use Evenement\EventEmitter;
 use React\EventLoop\LoopInterface;
 
-// Events: connection
+/** @event connection */
 class Server extends EventEmitter implements ServerInterface
 {
     public $master;
diff --git a/src/React/Socket/ServerInterface.php b/src/React/Socket/ServerInterface.php
@@ -4,7 +4,7 @@
 
 use Evenement\EventEmitterInterface;
 
-// Events: connection
+/** @event connection */
 interface ServerInterface extends EventEmitterInterface
 {
     public function listen($port, $host = '127.0.0.1');
diff --git a/src/React/Stream/Buffer.php b/src/React/Stream/Buffer.php
@@ -6,7 +6,7 @@
 use React\EventLoop\LoopInterface;
 use React\Stream\WritableStreamInterface;
 
-// Events: full-drain
+/** @event full-drain */
 class Buffer extends EventEmitter implements WritableStreamInterface
 {
     public $stream;
diff --git a/src/React/Stream/ReadableStreamInterface.php b/src/React/Stream/ReadableStreamInterface.php
@@ -4,7 +4,12 @@
 
 use Evenement\EventEmitterInterface;
 
-// Events: data, end, error, close
+/**
+ * @event data
+ * @event end
+ * @event error
+ * @event close
+ */
 interface ReadableStreamInterface extends StreamInterface
 {
     public function isReadable();
diff --git a/src/React/Stream/WritableStreamInterface.php b/src/React/Stream/WritableStreamInterface.php
@@ -4,7 +4,12 @@
 
 use Evenement\EventEmitterInterface;
 
-// Events: drain, error, close, pipe
+/**
+ * @event drain
+ * @event error
+ * @event close
+ * @event pipe
+ */
 interface WritableStreamInterface extends StreamInterface
 {
     public function isWritable();

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`use React\Socket\ServerInterface as SocketServerInterface;`
`7`	`7`	`use React\Socket\ConnectionInterface;`
`8`	`8`
`9`		`-// Events: request`
	`9`	`+/** @event request */`
`10`	`10`	`class Server extends EventEmitter implements ServerInterface`
`11`	`11`	`{`
`12`	`12`	`private $io;`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`use Evenement\EventEmitter;`
`6`	`6`	`use React\EventLoop\LoopInterface;`
`7`	`7`
`8`		`-// Events: connection`
	`8`	`+/** @event connection */`
`9`	`9`	`class Server extends EventEmitter implements ServerInterface`
`10`	`10`	`{`
`11`	`11`	`public $master;`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`use Evenement\EventEmitterInterface;`
`6`	`6`
`7`		`-// Events: connection`
	`7`	`+/** @event connection */`
`8`	`8`	`interface ServerInterface extends EventEmitterInterface`
`9`	`9`	`{`
`10`	`10`	`public function listen($port, $host = '127.0.0.1');`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`use React\EventLoop\LoopInterface;`
`7`	`7`	`use React\Stream\WritableStreamInterface;`
`8`	`8`
`9`		`-// Events: full-drain`
	`9`	`+/** @event full-drain */`
`10`	`10`	`class Buffer extends EventEmitter implements WritableStreamInterface`
`11`	`11`	`{`
`12`	`12`	`public $stream;`