Missing class doc-blocks

Author: AydinHassan

src/Application.php

@@ -4,16 +4,16 @@
 
 use Assert\Assertion;
 use DI\ContainerBuilder;
-use PhpSchool\PhpWorkshop\Check\CheckInterface;
 use PhpSchool\PhpWorkshop\Check\CheckRepository;
 use PhpSchool\PhpWorkshop\Exception\MissingArgumentException;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Factory\ResultRendererFactory;
 use PhpSchool\PhpWorkshop\Output\OutputInterface;
-use PhpSchool\PhpWorkshop\ResultRenderer\ResultRendererInterface;
 
 /**
- * Class Application
+ * This is the main application class, this takes care of bootstrapping, routing and
+ * output.
+ *
  * @package PhpSchool\PhpWorkshop
  * @author Aydin Hassan <aydin@hotmail.co.uk>
  */
@@ -60,7 +60,7 @@ final class Application
     private $bgColour = 'black';
 
     /**
-     * This is the main application class. It should be instantiated with the title of
+     * It should be instantiated with the title of
      * the workshop and the path to the DI configuration file.
      *
      * @param string $workshopTitle The workshop title - this is used throughout the application

src/Check/DatabaseCheck.php

@@ -7,8 +7,6 @@
 use PhpSchool\PhpWorkshop\Event\CliExecuteEvent;
 use PhpSchool\PhpWorkshop\Event\Event;
 use PhpSchool\PhpWorkshop\Event\EventDispatcher;
-use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
-use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
 use PhpSchool\PhpWorkshop\Exercise\TemporaryDirectoryTrait;
 use PhpSchool\PhpWorkshop\ExerciseCheck\DatabaseExerciseCheck;
 use PhpSchool\PhpWorkshop\Result\Failure;

src/Check/ListenableCheckInterface.php

@@ -5,7 +5,8 @@
 use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 
 /**
- * Interface ListenableCheckInterface
+ * The interface for advanced listener checks which can execute logic at any dispatched event.
+ *
  * @package PhpSchool\PhpWorkshop\Check
  * @author Aydin Hassan <aydin@hotmail.co.uk>
  */

src/Check/PhpLintCheck.php

@@ -9,7 +9,9 @@
 use Symfony\Component\Process\Process;
 
 /**
- * Class PhpLintCheck
+ * This check attempts to lint a student's solution and returns
+ * a success or failure based on the result of the linting.
+ *
  * @package PhpSchool\PhpWorkshop\Check
  * @author Aydin Hassan <aydin@hotmail.co.uk>
  */

src/Check/SimpleCheckInterface.php

@@ -7,7 +7,9 @@
 use PhpSchool\PhpWorkshop\Result\ResultInterface;
 
 /**
- * Class CheckInterface
+ * The interface for simple checks, checks that execute at one defined point, before or after
+ * output verification.
+ *
  * @package PhpSchool\PhpWorkshop\Comparator
  * @author Aydin Hassan <aydin@hotmail.co.uk>
  */

src/ExerciseDispatcher.php

@@ -19,7 +19,9 @@
 use Symfony\Component\Process\Process;
 
 /**
- * Class ExerciseDispatcher
+ * This class is used to verify/run a student's solution to an exercise. It routes to the correct
+ * runner based on the exercise type.
+ *
  * @package PhpSchool\PhpWorkshop
  * @author Aydin Hassan <aydin@hotmail.co.uk>
  */

src/ExerciseRenderer.php

@@ -7,7 +7,9 @@
 use PhpSchool\PhpWorkshop\Output\OutputInterface;
 
 /**
- * Class ExerciseRenderer
+ * This class is used to render the exercise problem to the student, it also set's the current exercise
+ * on to the user state object.
+ *
  * @package PhpSchool\PhpWorkshop
  * @author Aydin Hassan <aydin@hotmail.co.uk>
  */

src/ExerciseRepository.php

@@ -9,7 +9,8 @@
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 
 /**
- * Class ExerciseRepository
+ * Exercise repository, use to locate individual/all exercises by certain criteria.
+ *
  * @package PhpSchool\PhpWorkshop
  * @author Aydin Hassan <aydin@hotmail.co.uk>
  */

src/MarkdownRenderer.php

@@ -6,7 +6,9 @@
 use AydinHassan\CliMdRenderer\CliRenderer;
 
 /**
- * Class MarkdownRenderer
+ * Utility to render a markdown string to a string formatted with ANSI escape codes for output
+ * on the console.
+ *
  * @package PhpSchool\PhpWorkshop
  * @author Aydin Hassan <aydin@hotmail.co.uk>
  */