Add docblocks for classes and interfaces in top-level Ramsey\Uuid namespace

src/UuidFactoryInterface.php

@@ -14,19 +14,76 @@
 
 namespace Ramsey\Uuid;
 
+/**
+ * UuidFactoryInterface defines common functionality all `UuidFactory` instances
+ * must implement
+ */
 interface UuidFactoryInterface
 {
+    /**
+     * Generate a version 1 UUID from a host ID, sequence number, and the current time.
+     *
+     * @param int|string $node A 48-bit number representing the hardware address
+     *     This number may be represented as an integer or a hexadecimal string.
+     * @param int $clockSeq A 14-bit number used to help avoid duplicates that
+     *     could arise when the clock is set backwards in time or if the node ID
+     *     changes.
+     * @return UuidInterface
+     */
     public function uuid1($node = null, $clockSeq = null);
 
+    /**
+     * Generate a version 3 UUID based on the MD5 hash of a namespace identifier
+     * (which is a UUID) and a name (which is a string).
+     *
+     * @param string $ns The UUID namespace in which to create the named UUID
+     * @param string $name The name to create a UUID for
+     * @return UuidInterface
+     */
     public function uuid3($ns, $name);
 
+    /**
+     * Generate a version 4 (random) UUID.
+     *
+     * @return UuidInterface
+     */
     public function uuid4();
 
+    /**
+     * Generate a version 5 UUID based on the SHA-1 hash of a namespace
+     * identifier (which is a UUID) and a name (which is a string).
+     *
+     * @param string $ns The UUID namespace in which to create the named UUID
+     * @param string $name The name to create a UUID for
+     * @return UuidInterface
+     */
     public function uuid5($ns, $name);
 
+    /**
+     * Creates a UUID from a byte string.
+     *
+     * @param string $bytes A 16-byte string representation of a UUID
+     * @return UuidInterface
+     */
     public function fromBytes($bytes);
 
-    public function fromString($name);
+    /**
+     * Creates a UUID from the string standard representation
+     *
+     * @param string $uuid A string representation of a UUID
+     * @return UuidInterface
+     */
+    public function fromString($uuid);
 
+    /**
+     * Creates a `Uuid` from an integer representation
+     *
+     * The integer representation may be a real integer, a string integer, or
+     * an integer representation supported by a configured number converter.
+     *
+     * @param mixed $integer The integer to use when creating a `Uuid` from an
+     *     integer; may be of any type understood by the configured number converter
+     * @return UuidInterface
+     */
     public function fromInteger($integer);
 }