Cleaned up comments

Author: bastianschwarz

src/Check/Result/Collection/ResultCollectionInterface.php

@@ -20,7 +20,7 @@
 use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
 
 /**
- * A collection of results. Can be used to aggregate results from multiple checks, e.g. run multiple http checks and treat them as a group
+ * Interface for collection of results. Can be used to aggregate results from multiple checks, e.g. run multiple http checks and treat them as a group
  *
  * @psalm-api
  */

src/Check/Result/WasSuccessful.php

@@ -22,9 +22,9 @@
  *
  * @psalm-api
  */
-final class WasSuccessful implements ResultInterface {
+final readonly class WasSuccessful implements ResultInterface {
 
-  public function __construct(public readonly bool $successful) {}
+  public function __construct(public bool $successful) {}
 
   public function successful() : bool {
     return $this->successful;

src/Check/Result/WithNameInterface.php

@@ -25,10 +25,5 @@
  */
 interface WithNameInterface {
 
-  /**
-   * Returns the name of the result
-   *
-   * @return string
-   */
   public function name() : string;
 }

src/Check/WithNameInterface.php

@@ -24,10 +24,5 @@
  */
 interface WithNameInterface {
 
-  /**
-   * Returns the name of the check
-   *
-   * @return string
-   */
   public function name() : string;
 }