Add examples to PHPdoc for typed values and introduce FloatType, IntType, and StrType alias classes

- Enhanced PHPdoc comments across multiple classes with usage examples for clarity and better documentation.
- Introduced alias classes (`FloatType`, `IntType`, `StrType`) for core types to improve extensibility and consistency.
- Updated `psalmTest.php` with added alias usage demonstrations.

Author: georgedeploy

src/DateTime/DateTimeAtom.php

@@ -14,6 +14,8 @@
 /**
  * ATOM RFC 3339 format based on ISO 8601.
  *
+ * Example "2025-01-02T03:04:05+00:00"
+ *
  * @psalm-immutable
  */
 readonly class DateTimeAtom extends DateTimeType

src/DateTime/DateTimeRFC3339.php

@@ -14,6 +14,8 @@
 /**
  * RFC 3339 format based on ISO 8601.
  *
+ * Example "2025-01-02T03:04:05+00:00"
+ *
  * @psalm-immutable
  */
 readonly class DateTimeRFC3339 extends DateTimeType

src/DateTime/DateTimeRFC3339Extended.php

@@ -12,7 +12,9 @@
 use PhpTypedValues\Code\Exception\DateTimeTypeException;
 
 /**
- * RFC 3339 EXTENDED format based on ISO 8601.
+ * RFC 3339 EXTENDED format based on ISO 8601 (with microseconds).
+ *
+ * Example "2025-01-02T03:04:05.123456+00:00"
  *
  * @psalm-immutable
  */

src/DateTime/DateTimeW3C.php

@@ -14,6 +14,8 @@
 /**
  * W3C RFC 3339 format based on ISO 8601.
  *
+ * Example "2025-01-02T03:04:05+00:00"
+ *
  * @psalm-immutable
  */
 readonly class DateTimeW3C extends DateTimeType

src/DateTime/Timestamp/TimestampMilliseconds.php

@@ -12,7 +12,9 @@
 use function sprintf;
 
 /**
- * Unix timestamp in milliseconds since Unix epoch (UTC), e.g. "1732445696123".
+ * Unix timestamp in milliseconds since Unix epoch (UTC).
+ *
+ * Example "1732445696123"
  *
  * @psalm-immutable
  */

src/DateTime/Timestamp/TimestampSeconds.php

@@ -9,7 +9,9 @@
 use PhpTypedValues\Code\Exception\DateTimeTypeException;
 
 /**
- * Unix timestamp (seconds since Unix epoch, UTC), e.g. "1732445696".
+ * Unix timestamp (seconds since Unix epoch, UTC).
+ *
+ * Example "1732445696"
  *
  * @psalm-immutable
  */

src/Float/Alias/FloatType.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\Float\Alias;
+
+use PhpTypedValues\Float\FloatStandard;
+
+/**
+ * @psalm-immutable
+ */
+readonly class FloatType extends FloatStandard
+{
+}

src/Float/Alias/NonNegativeFloat.php

@@ -7,6 +7,10 @@
 use PhpTypedValues\Float\FloatNonNegative;
 
 /**
+ * Alias of Non-negative float (>= 0.0).
+ *
+ * Example "0.0"
+ *
  * @psalm-immutable
  */
 readonly class NonNegativeFloat extends FloatNonNegative

src/Float/FloatNonNegative.php

@@ -10,6 +10,10 @@
 use function sprintf;
 
 /**
+ * Non-negative float (>= 0.0).
+ *
+ * Example "0.0"
+ *
  * @psalm-immutable
  */
 readonly class FloatNonNegative extends FloatType

src/Float/FloatStandard.php

@@ -10,6 +10,8 @@
 /**
  * Represents any PHP float (double).
  *
+ * Example "3.14"
+ *
  * @psalm-immutable
  */
 readonly class FloatStandard extends FloatType