Add docblocks for classes and interface in Ramsey\Uuid\Builder namespace

This commit is contained in:
Ben Ramsey
2015-09-03 23:00:55 -04:00
parent d5276bdba6
commit 67fe80dc1b
3 changed files with 51 additions and 6 deletions
+10 -2
View File
@@ -15,12 +15,20 @@
namespace Ramsey\Uuid\Builder;
use Ramsey\Uuid\Codec\CodecInterface;
use Ramsey\Uuid\Uuid;
use Ramsey\Uuid\UuidInterface;
/**
* UuidBuilderInterface builds instances UuidInterface
*/
interface UuidBuilderInterface
{
/**
* @return Uuid
* Builds an instance of a UuidInterface
*
* @param CodecInterface $codec The codec to use for building this UuidInterface instance
* @param array $fields An array of fields from which to construct a UuidInterface instance;
* see {@see \Ramsey\Uuid\Uuid::getFields()} for array structure.
* @return UuidInterface
*/
public function build(CodecInterface $codec, array $fields);
}