Updated phpunit.xml

Updated Faker comments
schalkt · Apr 6, 2024 · b407e47 · b407e47
1 parent 8eafecb
commit b407e47
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 3 deletions.
diff --git a/phpunit.xml b/phpunit.xml
@@ -13,4 +13,10 @@
       <file>./src/Faker.php</file>
     </include>
   </source>
+  <coverage>
+    <report>
+      <html outputDirectory="./tests/coverage" />
+      <text outputFile="./tests/coverage/result.txt" />
+    </report>
+  </coverage>
 </phpunit>
diff --git a/src/Faker.php b/src/Faker.php
@@ -41,6 +41,7 @@ class Faker
      * __construct
      *
      * @param  array $options
+     * 
      * @return Faker
      */
     public function __construct(array $options = [])
@@ -71,6 +72,7 @@ public function __construct(array $options = [])
      * init
      *
      * @param  array $options
+     * 
      * @return Faker
      */
     public static function init(array $options = [])
@@ -84,6 +86,7 @@ public static function init(array $options = [])
      *
      * @param  mixed $length
      * @param  mixed $first
+     * 
      * @return string
      */
     public function word($length = null, $first = null, $suffixes = [])
@@ -112,6 +115,7 @@ public function word($length = null, $first = null, $suffixes = [])
      * words
      *
      * @param  mixed $count
+     * 
      * @return string
      */
     public function words($count = 4, $glue = ' ', $min = 4, $max = 7, $first = null, $suffixes = [])
@@ -131,6 +135,7 @@ public function words($count = 4, $glue = ' ', $min = 4, $max = 7, $first = null
      * sentence
      *
      * @param  mixed $words
+     * 
      * @return string
      */
     public function sentence($words = null)
@@ -149,6 +154,7 @@ public function sentence($words = null)
      * @param  mixed $max
      * @param  mixed $segments
      * @param  mixed $glue
+     * 
      * @return string
      */
     public function repeat($chars = null, $min = 2, $max = 21, $segments = 1, $glue = '-')
@@ -181,6 +187,7 @@ public function repeat($chars = null, $min = 2, $max = 21, $segments = 1, $glue
      * text
      *
      * @param  int $sentences
+     * 
      * @return string
      */
     public function text($sentences = 5, $min = 4, $max = 7)
@@ -201,6 +208,7 @@ public function text($sentences = 5, $min = 4, $max = 7)
      * getRandomConsonant
      *
      * @param  mixed $double
+     * 
      * @return string
      */
     protected function getRandomConsonant($double = false)
@@ -220,6 +228,7 @@ protected function getRandomConsonant($double = false)
      * getRandomVowel
      *
      * @param  mixed $double
+     * 
      * @return string
      */
     protected function getRandomVowel($double = false)
@@ -239,6 +248,7 @@ protected function getRandomVowel($double = false)
      * getRandomNextChar
      *
      * @param  mixed $prev
+     * 
      * @return string
      */
     protected function getRandomNextChar($prev)
@@ -265,6 +275,7 @@ protected function getRandomNextChar($prev)
      * isVowel
      *
      * @param  mixed $char
+     * 
      * @return string
      */
     protected function isVowel($char)
@@ -278,6 +289,7 @@ protected function isVowel($char)
      *
      * @param  mixed $length
      * @param  mixed $first
+     * 
      * @return string
      */
     public function firstname($min = 5, $max = 7, $first = null, $suffixes = [])
@@ -294,6 +306,7 @@ public function firstname($min = 5, $max = 7, $first = null, $suffixes = [])
      *
      * @param  mixed $length
      * @param  mixed $first
+     * 
      * @return string
      */
     public function lastname($min = 5, $max = 7, $first = null, $suffixes = [])
@@ -312,6 +325,7 @@ public function lastname($min = 5, $max = 7, $first = null, $suffixes = [])
      * @param  mixed $lengthFirst
      * @param  mixed $lengthLast
      * @param  mixed $reverse
+     * 
      * @return string
      */
     public function fullname($lengthFirst = null, $lengthLast = null, $reverse = false)
@@ -335,6 +349,7 @@ public function fullname($lengthFirst = null, $lengthLast = null, $reverse = fal
      *
      * @param  mixed $min
      * @param  mixed $max
+     * 
      * @return integer
      */
     public function int($min = 0, $max = 10000)
@@ -347,7 +362,8 @@ public function int($min = 0, $max = 10000)
      * float
      *
      * @param int $precision 
-     * @return void
+     * 
+     * @return float
      */
     public function float($min = 0, $max = 10000, $precision = 2)
     {
@@ -363,6 +379,7 @@ public function float($min = 0, $max = 10000, $precision = 2)
      *
      * @param  mixed $min
      * @param  mixed $max
+     * 
      * @return boolean
      */
     public function boolean()
@@ -376,6 +393,7 @@ public function boolean()
      *
      * @param  mixed $mask
      * @param  mixed $input
+     * 
      * @return string
      */
     public function mask($mask = '###-###-###', $input = 'ABCDEFGHJKLMNPRSTUVWXYZ0123456789')
@@ -426,7 +444,8 @@ public function password($min = 8, $max = 16, $segments = 2, $glue = '-')
      * @param mixed $items 
      * @param int $howmuch 
      * @param mixed $implode 
-     * @return void
+     * 
+     * @return array
      */
     public function pick($items, $howmuch = 1, $implode = null)
     {
@@ -459,7 +478,8 @@ public function pick($items, $howmuch = 1, $implode = null)
      * @param string $min 
      * @param mixed $max 
      * @param string $format 
-     * @return void
+     * 
+     * @return string
      */
     public function date($min = null, $max = null, $format = 'Y-m-d')
     {