Add description to ArrayAssertsTrait

Author: PhrozenByte

src/ArrayAssertsTrait.php

@@ -31,6 +31,21 @@
 use PhrozenByte\PHPUnitArrayAsserts\Constraint\SequentialArray;
 use Traversable;
 
+/**
+ * A set of array-related assertion methods.
+ *
+ * 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}.
+ */
 trait ArrayAssertsTrait
 {
     /**

src/Assert.php

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