Docblock cleanup

src/Command/HelpCommand.php

@@ -6,8 +6,7 @@
 use PhpSchool\PhpWorkshop\Output\OutputInterface;
 
 /**
- * Class HelpCommand
- * @author Aydin Hassan <[email protected]>
+ * A command to display help on running the workshop.
  */
 class HelpCommand
 {

src/Command/MenuCommand.php

@@ -4,6 +4,9 @@
 
 use PhpSchool\CliMenu\CliMenu;
 
+/**
+ * A command to open the app menu
+ */
 class MenuCommand
 {
     /**

src/Command/MenuCommandInvoker.php

@@ -4,9 +4,11 @@
 
 use PhpSchool\CliMenu\CliMenu;
 
+/**
+ * A helper to expose commands as callables for menu items
+ */
 class MenuCommandInvoker
 {
-
     /**
      * @var callable
      */

src/Command/PrintCommand.php

@@ -8,8 +8,7 @@
 use PhpSchool\PhpWorkshop\UserState;
 
 /**
- * Class PrintCommand
- * @author Aydin Hassan <[email protected]>
+ * A command to print the exercise's readme
  */
 class PrintCommand
 {

src/Command/RunCommand.php

@@ -7,8 +7,10 @@
 use PhpSchool\PhpWorkshop\Input\Input;
 use PhpSchool\PhpWorkshop\Output\OutputInterface;
 use PhpSchool\PhpWorkshop\UserState;
-use PhpSchool\PhpWorkshop\UserStateSerializer;
 
+/**
+ * A command to run the users solution
+ */
 class RunCommand
 {
     /**

src/Command/VerifyCommand.php

@@ -11,6 +11,9 @@
 use PhpSchool\PhpWorkshop\UserState;
 use PhpSchool\PhpWorkshop\UserStateSerializer;
 
+/**
+ * A command to verify the users solution
+ */
 class VerifyCommand
 {
     /**

src/CommandArgument.php

@@ -3,7 +3,7 @@
 namespace PhpSchool\PhpWorkshop;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * Command argument definition
  */
 class CommandArgument
 {

src/ComposerUtil/LockFileParser.php

@@ -6,8 +6,6 @@
 
 /**
  * Utility for reading installed package versions from a `composer.lock` file.
- *
- * @author Aydin Hassan <[email protected]>
  */
 class LockFileParser
 {

src/Event/CgiExecuteEvent.php

@@ -2,7 +2,6 @@
 
 namespace PhpSchool\PhpWorkshop\Event;
 
-use Assert\Assertion;
 use Psr\Http\Message\RequestInterface;
 
 /**

src/Event/ContainerListenerHelper.php

@@ -3,7 +3,7 @@
 namespace PhpSchool\PhpWorkshop\Event;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * A utility to reference listeners in the container
  */
 class ContainerListenerHelper
 {

src/Event/ExerciseRunnerEvent.php

@@ -6,7 +6,7 @@
 use PhpSchool\PhpWorkshop\Input\Input;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * An event which is dispatched during exercise running
  */
 class ExerciseRunnerEvent extends Event
 {

src/Exception/SolutionExecutionException.php

@@ -7,7 +7,6 @@
 /**
  * Represents the situation where a reference solution cannot be executed (this should only really happen during
  * workshop development).
- * @author Aydin Hassan <[email protected]>
  */
 class SolutionExecutionException extends RuntimeException
 {

src/Exercise/CustomVerifyingExercise.php

@@ -5,7 +5,7 @@
 use PhpSchool\PhpWorkshop\Result\ResultInterface;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * This interface describes the methods for a CUSTOM type exercise.
  */
 interface CustomVerifyingExercise
 {

src/Exercise/ProvidesSolution.php

@@ -5,7 +5,7 @@
 use PhpSchool\PhpWorkshop\Solution\SolutionInterface;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * Exercises can implement this method if they provide solutions
  */
 interface ProvidesSolution
 {

src/ExerciseRunner/CgiRunner.php

@@ -29,8 +29,6 @@
 /**
  * The `CGI` runner. This runner executes solutions as if they were behind a web-server. They populate the `$_SERVER`,
  * `$_GET` & `$_POST` super globals with information based of the request objects returned from the exercise.
- *
- * @author Aydin Hassan <[email protected]>
  */
 class CgiRunner implements ExerciseRunnerInterface
 {

src/ExerciseRunner/CliRunner.php

@@ -29,8 +29,6 @@
  * ```bash
  * php my-solution.php arg1 arg2 arg3
  * ```
- *
- * @author Aydin Hassan <[email protected]>
  */
 class CliRunner implements ExerciseRunnerInterface
 {

src/ExerciseRunner/CustomVerifyingRunner.php

@@ -8,7 +8,7 @@
 use PhpSchool\PhpWorkshop\Result\ResultInterface;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * The `CUSTOM` runner. This runner delegates to the exercise for verifying.
  */
 class CustomVerifyingRunner implements ExerciseRunnerInterface
 {

src/ExerciseRunner/Factory/CgiRunnerFactory.php

@@ -12,7 +12,7 @@
 use PhpSchool\PhpWorkshop\Utils\RequestRenderer;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * Factory class for `CgiRunner`
  */
 class CgiRunnerFactory implements ExerciseRunnerFactoryInterface
 {

src/ExerciseRunner/Factory/CliRunnerFactory.php

@@ -11,7 +11,7 @@
 use PhpSchool\PhpWorkshop\ExerciseRunner\ExerciseRunnerInterface;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * Factory class for `CliRunner`
  */
 class CliRunnerFactory implements ExerciseRunnerFactoryInterface
 {

src/ExerciseRunner/Factory/CustomVerifyingRunnerFactory.php

@@ -9,7 +9,7 @@
 use PhpSchool\PhpWorkshop\ExerciseRunner\ExerciseRunnerInterface;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * Factory class for `CustomVerifyingRunner`
  */
 class CustomVerifyingRunnerFactory implements ExerciseRunnerFactoryInterface
 {

src/ExerciseRunner/Factory/ExerciseRunnerFactoryInterface.php

@@ -7,7 +7,7 @@
 use PhpSchool\PhpWorkshop\ExerciseRunner\ExerciseRunnerInterface;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * Exercise runner factory interface
  */
 interface ExerciseRunnerFactoryInterface
 {

src/ExerciseRunner/RunnerManager.php

@@ -8,7 +8,7 @@
 use PhpSchool\PhpWorkshop\ExerciseRunner\Factory\ExerciseRunnerFactoryInterface;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * Allow factories to configure input and fetch the correct runner for the exercise
  */
 class RunnerManager
 {

src/Factory/EventDispatcherFactory.php

@@ -9,6 +9,9 @@
 use PhpSchool\PhpWorkshop\ResultAggregator;
 use PhpSchool\PhpWorkshop\Utils\Collection;
 
+/**
+ * Create an EventDispatcher populating with listeners from the config
+ */
 class EventDispatcherFactory
 {
 

src/Factory/MarkdownCliRendererFactory.php

@@ -36,8 +36,7 @@
 use AydinHassan\CliMdRenderer\CliRenderer;
 
 /**
- * Class MarkdownCliRendererFactory
- * @author Aydin Hassan <[email protected]>
+ * Factory for CliRenderer
  */
 class MarkdownCliRendererFactory
 {

src/Factory/MenuFactory.php

@@ -23,8 +23,7 @@
 use PhpSchool\PhpWorkshop\WorkshopType;
 
 /**
- * Class MenuFactory
- * @author Aydin Hassan <[email protected]>
+ * Configure the menu
  */
 class MenuFactory
 {

src/Factory/ResultRendererFactory.php

@@ -6,6 +6,9 @@
 use PhpSchool\PhpWorkshop\Result\ResultInterface;
 use PhpSchool\PhpWorkshop\ResultRenderer\ResultRendererInterface;
 
+/**
+ * Manages and creates renderers for results
+ */
 class ResultRendererFactory
 {
     /**

src/Input/Input.php

@@ -6,7 +6,7 @@
 use PhpSchool\PhpWorkshop\Exception\InvalidArgumentException;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * Container for command arguments
  */
 class Input
 {

src/Listener/CheckExerciseAssignedListener.php

@@ -6,9 +6,6 @@
 use PhpSchool\PhpWorkshop\Event\Event;
 use PhpSchool\PhpWorkshop\UserState;
 
-/**
- * @author Aydin Hassan <[email protected]>
- */
 class CheckExerciseAssignedListener
 {
     /**

src/Listener/CodePatchListener.php

@@ -8,6 +8,9 @@
 use PhpSchool\PhpWorkshop\Input\Input;
 use RuntimeException;
 
+/**
+ * Listener which patches student's solutions
+ */
 class CodePatchListener
 {
     /**
@@ -21,7 +24,6 @@ class CodePatchListener
     private $originalCode;
 
     /**
-     * CodePatchListener constructor.
      * @param CodePatcher $codePatcher
      */
     public function __construct(CodePatcher $codePatcher)

src/Listener/ConfigureCommandListener.php

@@ -9,7 +9,7 @@
 use PhpSchool\PhpWorkshop\UserState;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * Listener to allow runners to modify command arguments
  */
 class ConfigureCommandListener
 {

src/Listener/PrepareSolutionListener.php

@@ -2,14 +2,12 @@
 
 namespace PhpSchool\PhpWorkshop\Listener;
 
-use PhpSchool\PhpWorkshop\Event\Event;
 use PhpSchool\PhpWorkshop\Event\ExerciseRunnerEvent;
 use RuntimeException;
 use Symfony\Component\Process\Process;
 
 /**
- * Class PrepareSolutionListener
- * @author Aydin Hassan <[email protected]>
+ * Listener to install composer deps for an exercise solution
  */
 class PrepareSolutionListener
 {

src/Listener/RealPathListener.php

@@ -9,7 +9,7 @@
 use PhpSchool\PhpWorkshop\UserState;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * Replace program arg with absolute path
  */
 class RealPathListener
 {

src/Listener/SelfCheckListener.php

@@ -6,6 +6,9 @@
 use PhpSchool\PhpWorkshop\ExerciseCheck\SelfCheck;
 use PhpSchool\PhpWorkshop\ResultAggregator;
 
+/**
+ * Listener to handle exercises which inject their own checks
+ */
 class SelfCheckListener
 {
     /**

src/MenuItem/ResetProgress.php

@@ -3,10 +3,12 @@
 namespace PhpSchool\PhpWorkshop\MenuItem;
 
 use PhpSchool\CliMenu\CliMenu;
-use PhpSchool\PhpWorkshop\Output\OutputInterface;
 use PhpSchool\PhpWorkshop\UserState;
 use PhpSchool\PhpWorkshop\UserStateSerializer;
 
+/**
+ * Menu action to reset the workshop progress
+ */
 class ResetProgress
 {
     /**

src/NodeVisitor/FunctionVisitor.php

@@ -6,6 +6,9 @@
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\NodeVisitorAbstract;
 
+/**
+ * AST visitor to look for required and missing function requirements
+ */
 class FunctionVisitor extends NodeVisitorAbstract
 {
     /**

src/Output/OutputInterface.php

@@ -4,6 +4,9 @@
 
 use Psr\Http\Message\RequestInterface;
 
+/**
+ * Output interface
+ */
 interface OutputInterface
 {
     /**

src/Output/StdOutput.php

@@ -5,6 +5,9 @@
 use Colors\Color;
 use PhpSchool\Terminal\Terminal;
 
+/**
+ * Console output interface
+ */
 class StdOutput implements OutputInterface
 {
     /**

src/Result/Cgi/CgiResult.php

@@ -9,8 +9,6 @@
 /**
  * A result which encompasses all the results for each individual request made during
  * the CGI verification process.
- *
- * @author  Aydin Hassan <[email protected]>
  */
 class CgiResult implements ResultGroupInterface, IteratorAggregate
 {

src/Result/Cgi/FailureInterface.php

@@ -5,8 +5,6 @@
 /**
  * This interface represents a failure. Any result implementing this interface will
  * be treated as a failure.
- *
- * @author Aydin Hassan <[email protected]>
  */
 interface FailureInterface extends ResultInterface
 {

src/Result/Cgi/GenericFailure.php

@@ -7,7 +7,7 @@
 use Psr\Http\Message\RequestInterface;
 
 /**
- * @author Aydin Hassan <[email protected]>
+ * Generic CGI failure.
  */
 class GenericFailure extends Failure implements FailureInterface
 {