added doc comment

Vignesh C · Vignesh C · commit 09ed581dfc68 · 2018-07-31T17:42:23.000+05:30
diff --git a/src/TestCaseGenerator.php b/src/TestCaseGenerator.php
@@ -14,12 +14,21 @@ class TestCaseGenerator
 
     protected $rules;
     
+    /**
+     * Initiates the global parameters
+     */
     public function __construct()
     {
         $this->faker = Faker\Factory::create();
         $this->cases = [];
     }
 
+    /**
+     * Initialize the params and rules and generates the test cases
+     *
+     * @param array $rules
+     * @return array
+     */
     public function generate($rules)
     {
         $this->params = array_keys($rules);

Original file line number	Diff line number	Diff line change
`@@ -14,12 +14,21 @@ class TestCaseGenerator`
`14`	`14`
`15`	`15`	`protected $rules;`
`16`	`16`
	`17`	`+ /**`
	`18`	`+ * Initiates the global parameters`
	`19`	`+ */`
`17`	`20`	`public function __construct()`
`18`	`21`	`{`
`19`	`22`	`$this->faker = Faker\Factory::create();`
`20`	`23`	`$this->cases = [];`
`21`	`24`	`}`
`22`	`25`
	`26`	`+ /**`
	`27`	`+ * Initialize the params and rules and generates the test cases`
	`28`	`+ *`
	`29`	`+ * @param array $rules`
	`30`	`+ * @return array`
	`31`	`+ */`
`23`	`32`	`public function generate($rules)`
`24`	`33`	`{`
`25`	`34`	`$this->params = array_keys($rules);`