[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
@@ -14,8 +14,16 @@ namespace Predis\Options;
use Predis\IConnectionFactory;
use Predis\ConnectionFactory;
/**
* Option class that returns a connection factory to be used by a client.
*
* @author Daniele Alessandri <suppakilla@gmail.com>
*/
class ClientConnectionFactory extends Option
{
/**
* {@inheritdoc}
*/
public function validate($value)
{
if ($value instanceof IConnectionFactory) {
@@ -26,6 +34,9 @@ class ClientConnectionFactory extends Option
}
}
/**
* {@inheritdoc}
*/
public function getDefault()
{
return new ConnectionFactory();