[phpdoc] Add API documentation.

This is a starting point to add a documentation of the whole set of APIs and
classes of Predis. The next step will be to actually improve and extend it.
This commit is contained in:
Daniele Alessandri
2011-10-18 17:55:58 +02:00
parent 1f2104ef7f
commit 4e6ed3f26d
210 changed files with 3818 additions and 48 deletions
+17
View File
@@ -11,8 +11,25 @@
namespace Predis;
/**
* Represents an error returned by Redis (replies identified by "-" in the
* Redis response protocol) during the execution of an operation on the server.
*
* @author Daniele Alessandri <suppakilla@gmail.com>
*/
interface IRedisServerError extends IReplyObject
{
/**
* Returns the error message
*
* @return string
*/
public function getMessage();
/**
* Returns the error type (e.g. ERR, ASK, MOVED)
*
* @return string
*/
public function getErrorType();
}