Merge pull request #166 from php-school/docblock-cleanup

Docblock cleanup

Author: AydinHassan

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
 {