Add some more doc blocks

exussum12 · Jan 12, 2017 · e1330b1 · e1330b1
1 parent 34e21ce
commit e1330b1
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 7 deletions.
diff --git a/src/FileMatcher.php b/src/FileMatcher.php
@@ -8,6 +8,7 @@ interface FileMatcher
      * @param string[] $haystack list of potential file matches
      *
      * @return string the matched file
+     * @throws FileNotFound
      */
     public function match($needle, array $haystack);
 }
diff --git a/src/FileMatchers/EndsWith.php b/src/FileMatchers/EndsWith.php
@@ -4,9 +4,16 @@
 use exussum12\CoverageChecker\FileMatcher;
 use exussum12\CoverageChecker\Exceptions\FileNotFound;
 
+/**
+ * Class EndsWith
+ * @package exussum12\CoverageChecker\FileMatchers
+ */
 class EndsWith implements FileMatcher
 {
 
+    /**
+     * {@inheritdoc}
+     */
     public function match($needle, array $haystack)
     {
         foreach ($haystack as $file) {
@@ -18,6 +25,12 @@ public function match($needle, array $haystack)
         throw new FileNotFound();
     }
 
+    /**
+     * Month for finding if two strings end in the same way
+     * @param $haystack
+     * @param $needle
+     * @return bool
+     */
     protected function endsWith($haystack, $needle)
     {
         $length = strlen($needle);

diff --git a/src/FileMatchers/Prefix.php b/src/FileMatchers/Prefix.php
@@ -25,10 +25,7 @@ public function __construct($prefix)
     }
 
     /**
-     * @param string $needle
-     * @param array $haystack
-     * @return mixed
-     * @throws FileNotFound
+     * {@inheritdoc}
      */
     public function match($needle, array $haystack)
     {

diff --git a/tests/FileMatchers/PrefixTest.php b/tests/FileMatchers/PrefixTest.php
@@ -2,6 +2,7 @@
 namespace exussum12\CoverageChecker\tests\FileMatchers;
 
 use PHPUnit\Framework\TestCase;
+use exussum12\CoverageChecker\Exceptions\FileNotFound;
 use exussum12\CoverageChecker\FileMatchers\Prefix;
 
 class PrefixTest extends TestCase
@@ -22,11 +23,9 @@ public function testPrefix()
         );
     }
 
-    /**
-     * @expectedException exussum12\CoverageChecker\Exceptions\FileNotFound
-     */
     public function testDoesNotExist()
     {
+        $this->expectException(FileNotFound::class);
         $prefixMatcher = new Prefix('/full/path/to/');
         $needle = "fileDoesNotExist.php";
         $haystack = [];