Minor tweaks to phpdoc descriptions.

This commit is contained in:
Daniele Alessandri
2013-11-09 18:51:16 +01:00
parent d431ea6dba
commit b38f640ac9
9 changed files with 9 additions and 13 deletions
@@ -31,7 +31,7 @@ interface ProtocolProcessorInterface
public function write(ComposableConnectionInterface $connection, CommandInterface $command);
/**
* Reads a response from the specified connection and deserializes it.
* Reads a response from the specified connection.
*
* @param ComposableConnectionInterface $connection Connection to Redis.
* @return mixed
@@ -22,7 +22,7 @@ use Predis\Connection\ComposableConnectionInterface;
interface ResponseReaderInterface
{
/**
* Reads responses from the connection.
* Reads a response from the connection.
*
* @param ComposableConnectionInterface $connection Connection to Redis.
* @return mixed
@@ -16,7 +16,7 @@ use Predis\Connection\ComposableConnectionInterface;
use Predis\Protocol\ProtocolException;
/**
* Handler for the bulk response type of the standard Redis wire protocol.
* Handler for the bulk response type in the standard Redis wire protocol.
* It translates the payload to a string or a NULL.
*
* @link http://redis.io/topics/protocol
@@ -15,12 +15,9 @@ use Predis\ResponseError;
use Predis\Connection\ComposableConnectionInterface;
/**
* Handler for the error response type of the standard Redis wire protocol.
* Handler for the error response type in the standard Redis wire protocol.
* It translates the payload to a complex response object for Predis.
*
* This handler returns a reply object to notify the user that an error has
* occurred on the server.
*
* @link http://redis.io/topics/protocol
* @author Daniele Alessandri <suppakilla@gmail.com>
*/
@@ -16,7 +16,7 @@ use Predis\Connection\ComposableConnectionInterface;
use Predis\Protocol\ProtocolException;
/**
* Handler for the integer response type of the standard Redis wire protocol.
* Handler for the integer response type in the standard Redis wire protocol.
* It translates the payload an integer or NULL.
*
* @link http://redis.io/topics/protocol
@@ -16,7 +16,7 @@ use Predis\Connection\ComposableConnectionInterface;
use Predis\Protocol\ProtocolException;
/**
* Handler for the multibulk response type of the standard Redis wire protocol.
* Handler for the multibulk response type in the standard Redis wire protocol.
* It returns multibulk responses as PHP arrays.
*
* @link http://redis.io/topics/protocol
@@ -15,7 +15,7 @@ use Predis\ResponseQueued;
use Predis\Connection\ComposableConnectionInterface;
/**
* Handler for the status response type of the standard Redis wire protocol.
* Handler for the status response type in the standard Redis wire protocol.
* It translates certain classes of status response to PHP objects or just
* returns the payload as a string.
*
@@ -17,7 +17,7 @@ use Predis\Iterator\MultiBulkResponseSimple;
use Predis\Protocol\ProtocolException;
/**
* Handler for the multibulk response type of the standard Redis wire protocol.
* Handler for the multibulk response type in the standard Redis wire protocol.
* It returns multibulk responses as iterators that can stream bulk elements.
*
* Please note that streamable multibulk replies are not globally supported
+1 -2
View File
@@ -51,8 +51,7 @@ class ResponseReader implements ResponseReaderInterface
}
/**
* Sets a response handler for a certain prefix that identifies a type of
* response that can be returned by Redis.
* Sets the handler for the specified prefix identifying the response type.
*
* @param string $prefix Identifier of the type of response.
* @param Handler\ResponseHandlerInterface $handler Response handler.