CodeInsertion docs

Author: AydinHassan

src/CodeInsertion.php

@@ -5,13 +5,24 @@
 use Assert\Assertion;
 
 /**
- * Class CodeInsertion.
+ * This class is a simple DTO to represent a code insertion which should
+ * be performed on a students solution.
+ *
  * @package PhpSchool\PhpWorkshop
  * @author Aydin Hassan <[email protected]>
  */
 class CodeInsertion
 {
+    /**
+     * Denotes that the block of code this insertion
+     * represents, should be inserted at the top of the solution.
+     */
     const TYPE_BEFORE   = 'before';
+
+    /**
+     * Denotes that the block of code this insertion
+     * represents, should be inserted at the bottom of the solution.
+     */
     const TYPE_AFTER    = 'after';
 
     /**
@@ -33,6 +44,9 @@ class CodeInsertion
     private $code;
 
     /**
+     * Accepts the type on insertion, either static::TYPE_BEFORE or static::TYPE_AFTER
+     * and a string containing the code to be inserted.
+     *
      * @param string $type
      * @param string $code
      */
@@ -46,6 +60,8 @@ public function __construct($type, $code)
     }
 
     /**
+     * Get the type of insertion, either static::TYPE_BEFORE or static::TYPE_AFTER.
+     *
      * @return string
      */
     public function getType()
@@ -54,6 +70,8 @@ public function getType()
     }
 
     /**
+     * Get a string containing the code be inserted
+     *
      * @return string
      */
     public function getCode()