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

This commit is contained in:
Ben Ramsey
2015-09-03 23:28:07 -04:00
parent 67fe80dc1b
commit 77a34348d5
3 changed files with 107 additions and 7 deletions
+16 -2
View File
@@ -16,24 +16,38 @@ namespace Ramsey\Uuid\Codec;
use Ramsey\Uuid\UuidInterface;
/**
* CodecInterface represents a UUID coder-decoder
*/
interface CodecInterface
{
/**
* @return string
* Encodes a UuidInterface as a string representation of a UUID
*
* @param UuidInterface $uuid
* @return string Hexadecimal string representation of a UUID
*/
public function encode(UuidInterface $uuid);
/**
* @return string
* Encodes a UuidInterface as a binary representation of a UUID
*
* @param UuidInterface $uuid
* @return string Binary string representation of a UUID
*/
public function encodeBinary(UuidInterface $uuid);
/**
* Decodes a string representation of a UUID into a UuidInterface object instance
*
* @param string $encodedUuid
* @return UuidInterface
*/
public function decode($encodedUuid);
/**
* Decodes a binary representation of a UUID into a UuidInterface object instance
*
* @param string $bytes
* @return UuidInterface
*/