Fix phpdocs.

lib/Predis/PubSub/AbstractConsumer.php

@@ -14,7 +14,7 @@ namespace Predis\PubSub;
 use Iterator;
 
 /**
- * Client-side abstraction of a Publish / Subscribe context.
+ * Base implementation of a PUB/SUB consumer abstraction.
  *
  * @author Daniele Alessandri <suppakilla@gmail.com>
  */
@@ -35,7 +35,7 @@ abstract class AbstractConsumer implements Iterator
     private $statusFlags = self::STATUS_VALID;
 
     /**
-     * Automatically closes the context when PHP's garbage collector kicks in.
+     * Automatically stops the consumer when PHP's garbage collector kicks in.
      */
     public function __destruct()
     {
@@ -43,7 +43,7 @@ abstract class AbstractConsumer implements Iterator
     }
 
     /**
-     * Checks if the specified flag is valid in the state of the context.
+     * Checks if the specified flag is valid based on the state of the consumer.
      *
      * @param int $value Flag.
      * @return Boolean
@@ -177,7 +177,7 @@ abstract class AbstractConsumer implements Iterator
     }
 
     /**
-     * Checks if the the context is still in a valid state to continue.
+     * Checks if the the consumer is still in a valid state to continue.
      *
      * @return Boolean
      */
@@ -191,7 +191,7 @@ abstract class AbstractConsumer implements Iterator
     }
 
     /**
-     * Resets the state of the context.
+     * Resets the state of the consumer.
      */
     protected function invalidate()
     {

lib/Predis/PubSub/Consumer.php

@@ -18,7 +18,7 @@ use Predis\NotSupportedException;
 use Predis\Connection\AggregatedConnectionInterface;
 
 /**
- * Client-side abstraction of a Publish / Subscribe context.
+ * PUB/SUB consumer abstraction.
  *
  * @author Daniele Alessandri <suppakilla@gmail.com>
  */
@@ -28,8 +28,8 @@ class Consumer extends AbstractConsumer
     private $options;
 
     /**
-     * @param ClientInterface $client Client instance used by the context.
-     * @param array $options Options for the context initialization.
+     * @param ClientInterface $client Client instance used by the consumer.
+     * @param array $options Options for the consumer initialization.
      */
     public function __construct(ClientInterface $client, Array $options = null)
     {
@@ -53,9 +53,9 @@ class Consumer extends AbstractConsumer
 
     /**
      * Checks if the passed client instance satisfies the required conditions
-     * needed to initialize a Publish / Subscribe context.
+     * needed to initialize a PUB/SUB consumer.
      *
-     * @param ClientInterface $client Client instance used by the context.
+     * @param ClientInterface $client Client instance used by the consumer.
      */
     private function checkCapabilities(ClientInterface $client)
     {