Improve phpDoc class docs

Author: PhrozenByte

src/ArrayAssertsTrait.php

@@ -37,14 +37,14 @@
  * This trait implements an assertion method and constraint creation method per
  * implemented constraint, namely
  *
- * - the `assertAssociativeArray` and `associativeArray` methods for
- *   {@class PhrozenByte\PHPUnitArrayAsserts\Constraint\AssociativeArray},
- * - the `assertArrayHasKeyWith` and `arrayHasKeyWith` methods for
- *   {@class PhrozenByte\PHPUnitArrayAsserts\Constraint\ArrayHasKeyWith},
- * - the `assertSequentialArray` and `sequentialArray` methods for
- *   {@class PhrozenByte\PHPUnitArrayAsserts\Constraint\SequentialArray}, and
- * - the `assertArrayHasItemWith` and `arrayHasItemWith` methods for
- *   {@class PhrozenByte\PHPUnitArrayAsserts\Constraint\ArrayHasItemWith}.
+ * - the `assertAssociativeArray()` and `associativeArray()` methods for
+ *   {@see AssociativeArray},
+ * - the `assertArrayHasKeyWith()` and `arrayHasKeyWith()` methods for
+ *   {@see ArrayHasKeyWith},
+ * - the `assertSequentialArray()` and `sequentialArray()` methods for
+ *   {@see SequentialArray}, and
+ * - the `assertArrayHasItemWith()` and `arrayHasItemWith()` methods for
+ *   {@see ArrayHasItemWith}.
  */
 trait ArrayAssertsTrait
 {

src/Assert.php

@@ -22,8 +22,8 @@
 /**
  * A set of array-related assertion methods.
  *
- * This static class just uses the `ArrayAssertsTrait` trait. Refer to
- * {@class PhrozenByte\PHPUnitArrayAsserts\ArrayAssertsTrait} for more info.
+ * This static class just uses the {@see ArrayAssertsTrait} trait. Refer to
+ * {@see ArrayAssertsTrait} for more info.
  */
 class Assert
 {

src/Constraint/ArrayHasItemWith.php

@@ -57,7 +57,9 @@ public function __construct(int $index, Constraint $constraint)
     }
 
     /**
-     * {@inheritDoc}
+     * Returns a human-readable string representation of this Constraint.
+     *
+     * @return string string representation of the Constraint
      */
     public function toString(): string
     {
@@ -66,7 +68,11 @@ public function toString(): string
     }
 
     /**
-     * {@inheritDoc}
+     * Returns whether the given value matches the Constraint.
+     *
+     * @param mixed $other the value to evaluate
+     *
+     * @return bool boolean indicating whether the value matches the Constraint
      */
     protected function matches($other): bool
     {
@@ -87,7 +93,7 @@ protected function matches($other): bool
     }
 
     /**
-     * {@inheritDoc}
+     * Returns the number of assertions performed by this Constraint.
      */
     public function count(): int
     {

src/Constraint/ArrayHasKeyWith.php

@@ -60,7 +60,9 @@ public function __construct($key, Constraint $constraint)
     }
 
     /**
-     * {@inheritDoc}
+     * Returns a human-readable string representation of this Constraint.
+     *
+     * @return string string representation of the Constraint
      */
     public function toString(): string
     {
@@ -69,7 +71,11 @@ public function toString(): string
     }
 
     /**
-     * {@inheritDoc}
+     * Returns whether the given value matches the Constraint.
+     *
+     * @param mixed $other the value to evaluate
+     *
+     * @return bool boolean indicating whether the value matches the Constraint
      */
     protected function matches($other): bool
     {
@@ -88,7 +94,7 @@ protected function matches($other): bool
     }
 
     /**
-     * {@inheritDoc}
+     * Returns the number of assertions performed by this Constraint.
      */
     public function count(): int
     {

src/Constraint/AssociativeArray.php

@@ -71,7 +71,9 @@ public function __construct(array $constraints, bool $allowMissing = false, bool
     }
 
     /**
-     * {@inheritDoc}
+     * Returns a human-readable string representation of this Constraint.
+     *
+     * @return string string representation of the Constraint
      */
     public function toString(): string
     {
@@ -105,7 +107,11 @@ public function toString(): string
     }
 
     /**
-     * {@inheritDoc}
+     * Returns whether the given value matches the Constraint.
+     *
+     * @param mixed $other the value to evaluate
+     *
+     * @return bool boolean indicating whether the value matches the Constraint
      */
     protected function matches($other): bool
     {
@@ -130,7 +136,7 @@ protected function matches($other): bool
     }
 
     /**
-     * {@inheritDoc}
+     * Returns the number of assertions performed by this Constraint.
      */
     public function count(): int
     {
@@ -143,7 +149,14 @@ public function count(): int
     }
 
     /**
-     * {@inheritDoc}
+     * Returns the description of the failure.
+     *
+     * The beginning of failure messages is "Failed asserting that" in most
+     * cases. This method should return the second part of that sentence.
+     *
+     * @param mixed $other evaluated value
+     *
+     * @return string the failure description
      */
     protected function failureDescription($other): string
     {
@@ -155,7 +168,11 @@ protected function failureDescription($other): string
     }
 
     /**
-     * {@inheritDoc}
+     * Returns additional failure description.
+     *
+     * @param mixed $other the evaluated value
+     *
+     * @return string the failure description
      */
     protected function additionalFailureDescription($other): string
     {

src/Constraint/SequentialArray.php

@@ -85,7 +85,9 @@ public function __construct(int $minItems = 0, int $maxItems = null, Constraint
     }
 
     /**
-     * {@inheritDoc}
+     * Returns a human-readable string representation of this Constraint.
+     *
+     * @return string string representation of the Constraint
      */
     public function toString(): string
     {
@@ -121,7 +123,11 @@ public function toString(): string
     }
 
     /**
-     * {@inheritDoc}
+     * Returns whether the given value matches the Constraint.
+     *
+     * @param mixed $other the value to evaluate
+     *
+     * @return bool boolean indicating whether the value matches the Constraint
      */
     protected function matches($other): bool
     {
@@ -250,7 +256,7 @@ protected function inspectData($other): array
     }
 
     /**
-     * {@inheritDoc}
+     * Returns the number of assertions performed by this Constraint.
      */
     public function count(): int
     {

tests/Utils/ArrayAccessible.php

@@ -40,31 +40,31 @@ public function __construct(array $data = [])
     }
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     public function offsetExists($offset): bool
     {
         return isset($this->data[$offset]);
     }
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     public function offsetGet($offset)
     {
         return $this->data[$offset] ?? null;
     }
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     public function offsetSet($offset, $value): void
     {
         $this->data[$offset] = $value;
     }
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     public function offsetUnset($offset): void
     {

tests/Utils/IteratorAggregated.php

@@ -43,7 +43,7 @@ public function __construct(Iterator $iterator)
     }
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     public function getIterator(): Traversable
     {

tests/Utils/TestConstraint.php

@@ -48,23 +48,23 @@ public function __construct(array $options = [])
     }
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     public function toString(): string
     {
         return $this->toString;
     }
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     protected function matches($other): bool
     {
         return $this->matches;
     }
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     public function count(): int
     {