doc block fixes

Author: AydinHassan

src/Result/Cgi/FailureInterface.php

@@ -6,7 +6,6 @@
  * This interface represents a failure. Any result implementing this interface will
  * be treated as a failure.
  *
- * @package PhpSchool\PhpWorkshop\Result
  * @author Aydin Hassan <aydin@hotmail.co.uk>
  */
 interface FailureInterface extends ResultInterface

src/Result/Cgi/GenericFailure.php

@@ -47,7 +47,7 @@ public static function fromRequestAndReason(RequestInterface $request, $reason)
     /**
      * Static constructor to create from a `PhpSchool\PhpWorkshop\Exception\CodeExecutionException` exception.
      *
-     * @param RequestInterface $request The request that caused the failure
+     * @param RequestInterface $request The request that caused the failure.
      * @param CodeExecutionException $e The exception.
      * @return static The result.
      */
@@ -57,6 +57,8 @@ public static function fromRequestAndCodeExecutionFailure(RequestInterface $requ
     }
 
     /**
+     * Get the request that caused the failure.
+     *
      * @return RequestInterface
      */
     public function getRequest()

src/Result/Cgi/RequestFailure.php

@@ -60,7 +60,7 @@ public function __construct(
     }
 
     /**
-     * Get the request object associated with this failure.
+     * Get the request that caused the failure.
      *
      * @return RequestInterface
      */

src/Result/Cgi/ResultInterface.php

@@ -10,6 +10,8 @@
 interface ResultInterface extends \PhpSchool\PhpWorkshop\Result\ResultInterface
 {
     /**
+     * Get the request associated with this result.
+     *
      * @return RequestInterface
      */
     public function getRequest();

src/Result/Cgi/Success.php

@@ -6,9 +6,8 @@
 use Psr\Http\Message\RequestInterface;
 
 /**
- * Default implementation of `PhpSchool\PhpWorkshop\Result\SuccessInterface`.
+ * Default implementation of `PhpSchool\PhpWorkshop\Result\Cgi\SuccessInterface`.
  *
- * @package PhpSchool\PhpWorkshop
  * @author Aydin Hassan <aydin@hotmail.co.uk>
  */
 class Success implements SuccessInterface
@@ -24,7 +23,7 @@ class Success implements SuccessInterface
     private $name = 'CGI Program Runner';
 
     /**
-     * @param RequestInterface $request The request that caused the failure.
+     * @param RequestInterface $request The request for this success.
      */
     public function __construct(RequestInterface $request)
     {
@@ -42,6 +41,8 @@ public function getCheckName()
     }
 
     /**
+     * Get the request for this success.
+     *
      * @return RequestInterface
      */
     public function getRequest()

src/Result/Cgi/SuccessInterface.php

@@ -6,7 +6,6 @@
  * This interface represents a success. Any result implementing this interface will
  * be treated as a success.
  *
- * @package PhpSchool\PhpWorkshop\Result
  * @author Aydin Hassan <aydin@hotmail.co.uk>
  */
 interface SuccessInterface extends ResultInterface

src/Result/Cli/FailureInterface.php

@@ -6,7 +6,6 @@
  * This interface represents a failure. Any result implementing this interface will
  * be treated as a failure.
  *
- * @package PhpSchool\PhpWorkshop\Result
  * @author Aydin Hassan <aydin@hotmail.co.uk>
  */
 interface FailureInterface extends ResultInterface

src/Result/Cli/GenericFailure.php

@@ -23,8 +23,8 @@ class GenericFailure extends Failure implements FailureInterface
     private static $name = 'CLI Program Runner';
 
     /**
-     * @param ArrayObject $args
-     * @param null $reason
+     * @param ArrayObject $args The arguments that caused the failure.
+     * @param null $reason The reason (if any) of the failure.
      */
     public function __construct(ArrayObject $args, $reason = null)
     {

src/Result/Cli/RequestFailure.php

@@ -29,7 +29,7 @@ class RequestFailure implements FailureInterface
     private $actualOutput;
 
     /**
-     * @param ArrayObject $args
+     * @param ArrayObject $args The arguments that caused the failure.
      * @param string $expectedOutput The expected output.
      * @param string $actualOutput The actual output.
      */
@@ -43,7 +43,7 @@ public function __construct(ArrayObject $args, $expectedOutput, $actualOutput)
     /**
      * Named constructor, for added code legibility.
      *
-     * @param ArrayObject $args
+     * @param ArrayObject $args The arguments that caused the failure.
      * @param string $expectedOutput The expected result.
      * @param string $actualOutput The actual output.
      * @return static The result.
@@ -54,6 +54,8 @@ public static function fromArgsAndOutput(ArrayObject $args, $expectedOutput, $ac
     }
 
     /**
+     * Get the arguments that caused the failure.
+     *
      * @return ArrayObject
      */
     public function getArgs()

src/Result/Cli/ResultInterface.php

@@ -10,6 +10,8 @@
 interface ResultInterface extends \PhpSchool\PhpWorkshop\Result\ResultInterface
 {
     /**
+     * Get the arguments associated with this result.
+     *
      * @return ArrayObject
      */
     public function getArgs();