Clean up docblocks, code, and note new deprecations

The following are deprecated:

* `Ramsey\Uuid\Codec\OrderedTimeCodec`
* `Ramsey\Uuid\Codec\TimestampFirstCombCodec`
* `Ramsey\Uuid\Codec\TimestampLastCombCodec`
* `Ramsey\Uuid\Generator\CombGenerator`

src/DeprecatedUuidMethodsTrait.php

@@ -27,8 +27,7 @@ use function substr;
 use const STR_PAD_LEFT;
 
 /**
- * This trait encapsulates deprecated methods for ramsey/uuid; this trait and
- * its methods will be removed in ramsey/uuid 5.0.0.
+ * This trait encapsulates deprecated methods for ramsey/uuid; this trait and its methods will be removed in ramsey/uuid 5.0.0.
  *
  * @deprecated This trait and its methods will be removed in ramsey/uuid 5.0.0.
  *
@@ -37,12 +36,10 @@ use const STR_PAD_LEFT;
 trait DeprecatedUuidMethodsTrait
 {
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getClockSeqHiAndReserved()}
-     *     and use the arbitrary-precision math library of your choice to
-     *     convert it to a string integer.
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getClockSeqHiAndReserved()} and use the arbitrary-precision math
+     *     library of your choice to convert it to a string integer.
      */
     public function getClockSeqHiAndReserved(): string
     {
@@ -50,9 +47,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
      *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getClockSeqHiAndReserved()}.
      */
     public function getClockSeqHiAndReservedHex(): string
@@ -61,12 +57,10 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getClockSeqLow()}
-     *     and use the arbitrary-precision math library of your choice to
-     *     convert it to a string integer.
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getClockSeqLow()} and use the arbitrary-precision math library of
+     *     your choice to convert it to a string integer.
      */
     public function getClockSeqLow(): string
     {
@@ -74,9 +68,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
      *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getClockSeqLow()}.
      */
     public function getClockSeqLowHex(): string
@@ -85,12 +78,10 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getClockSeq()}
-     *     and use the arbitrary-precision math library of your choice to
-     *     convert it to a string integer.
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getClockSeq()} and use the arbitrary-precision math library of
+     *     your choice to convert it to a string integer.
      */
     public function getClockSequence(): string
     {
@@ -98,9 +89,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
      *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getClockSeq()}.
      */
     public function getClockSequenceHex(): string
@@ -109,8 +99,7 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated This method will be removed in 5.0.0. There is no alternative
-     *     recommendation, so plan accordingly.
+     * @deprecated This method will be removed in 5.0.0. There is no alternative recommendation, so plan accordingly.
      */
     public function getNumberConverter(): NumberConverterInterface
     {
@@ -118,8 +107,7 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated In ramsey/uuid version 5.0.0, this will be removed.
-     *     It is available at {@see UuidV1::getDateTime()}.
+     * @deprecated In ramsey/uuid version 5.0.0, this will be removed. It is available at {@see UuidV1::getDateTime()}.
      *
      * @return DateTimeImmutable An immutable instance of DateTimeInterface
      *
@@ -147,8 +135,7 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
      *
      * @return string[]
      */
@@ -165,9 +152,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated This method will be removed in 5.0.0. There is no direct
-     *     alternative, but the same information may be obtained by splitting
-     *     in half the value returned by {@see UuidInterface::getHex()}.
+     * @deprecated This method will be removed in 5.0.0. There is no direct alternative, but the same information may be
+     *     obtained by splitting in half the value returned by {@see UuidInterface::getHex()}.
      */
     public function getLeastSignificantBits(): string
     {
@@ -177,9 +163,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated This method will be removed in 5.0.0. There is no direct
-     *     alternative, but the same information may be obtained by splitting
-     *     in half the value returned by {@see UuidInterface::getHex()}.
+     * @deprecated This method will be removed in 5.0.0. There is no direct alternative, but the same information may be
+     *     obtained by splitting in half the value returned by {@see UuidInterface::getHex()}.
      */
     public function getLeastSignificantBitsHex(): string
     {
@@ -187,9 +172,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated This method will be removed in 5.0.0. There is no direct
-     *     alternative, but the same information may be obtained by splitting
-     *     in half the value returned by {@see UuidInterface::getHex()}.
+     * @deprecated This method will be removed in 5.0.0. There is no direct alternative, but the same information may be
+     *     obtained by splitting in half the value returned by {@see UuidInterface::getHex()}.
      */
     public function getMostSignificantBits(): string
     {
@@ -199,9 +183,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated This method will be removed in 5.0.0. There is no direct
-     *     alternative, but the same information may be obtained by splitting
-     *     in half the value returned by {@see UuidInterface::getHex()}.
+     * @deprecated This method will be removed in 5.0.0. There is no direct alternative, but the same information may be
+     *     obtained by splitting in half the value returned by {@see UuidInterface::getHex()}.
      */
     public function getMostSignificantBitsHex(): string
     {
@@ -209,12 +192,10 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getNode()} and use the
-     *     arbitrary-precision math library of your choice to convert it to a
-     *     string integer.
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getNode()} and use the arbitrary-precision math library of your
+     *     choice to convert it to a string integer.
      */
     public function getNode(): string
     {
@@ -222,9 +203,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
      *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getNode()}.
      */
     public function getNodeHex(): string
@@ -233,12 +213,10 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getTimeHiAndVersion()}
-     *     and use the arbitrary-precision math library of your choice to
-     *     convert it to a string integer.
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getTimeHiAndVersion()} and use the arbitrary-precision math
+     *     library of your choice to convert it to a string integer.
      */
     public function getTimeHiAndVersion(): string
     {
@@ -246,9 +224,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
      *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getTimeHiAndVersion()}.
      */
     public function getTimeHiAndVersionHex(): string
@@ -257,12 +234,10 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getTimeLow()} and use the
-     *     arbitrary-precision math library of your choice to convert it to a
-     *     string integer.
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getTimeLow()} and use the arbitrary-precision math library of
+     *     your choice to convert it to a string integer.
      */
     public function getTimeLow(): string
     {
@@ -270,9 +245,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
      *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getTimeLow()}.
      */
     public function getTimeLowHex(): string
@@ -281,12 +255,10 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getTimeMid()} and use the
-     *     arbitrary-precision math library of your choice to convert it to a
-     *     string integer.
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getTimeMid()} and use the arbitrary-precision math library of
+     *     your choice to convert it to a string integer.
      */
     public function getTimeMid(): string
     {
@@ -294,9 +266,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
      *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getTimeMid()}.
      */
     public function getTimeMidHex(): string
@@ -305,12 +276,10 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getTimestamp()} and use
-     *     the arbitrary-precision math library of your choice to convert it to
-     *     a string integer.
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getTimestamp()} and use the arbitrary-precision math library of
+     *     your choice to convert it to a string integer.
      */
     public function getTimestamp(): string
     {
@@ -322,9 +291,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
      *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getTimestamp()}.
      */
     public function getTimestampHex(): string
@@ -337,9 +305,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
      *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getVariant()}.
      */
     public function getVariant(): ?int
@@ -348,9 +315,8 @@ trait DeprecatedUuidMethodsTrait
     }
 
     /**
-     * @deprecated Use {@see UuidInterface::getFields()} to get a
-     *     {@see \Ramsey\Uuid\Fields\FieldsInterface} instance. If it is a
-     *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
+     * @deprecated Use {@see UuidInterface::getFields()} to get a {@see \Ramsey\Uuid\Fields\FieldsInterface} instance.
+     *     If it is a {@see \Ramsey\Uuid\Rfc4122\FieldsInterface} instance, you may call
      *     {@see \Ramsey\Uuid\Rfc4122\FieldsInterface::getVersion()}.
      */
     public function getVersion(): ?int