@@ -110,8 +110,9 @@ class PHP_CodeCoverage
110110 /**
111111 * Constructor.
112112 *
113- * @param PHP_CodeCoverage_Driver $driver
114- * @param PHP_CodeCoverage_Filter $filter
113+ * @param PHP_CodeCoverage_Driver $driver
114+ * @param PHP_CodeCoverage_Filter $filter
115+ *
115116 * @throws PHP_CodeCoverage_RuntimeException
116117 */
117118 public function __construct (PHP_CodeCoverage_Driver $ driver = null , PHP_CodeCoverage_Filter $ filter = null )
@@ -135,6 +136,7 @@ public function __construct(PHP_CodeCoverage_Driver $driver = null, PHP_CodeCove
135136 * for this PHP_CodeCoverage object.
136137 *
137138 * @return PHP_CodeCoverage_Report_Node_Directory
139+ *
138140 * @since Method available since Release 1.1.0
139141 */
140142 public function getReport ()
@@ -168,8 +170,10 @@ public function filter()
168170 * Returns the collected code coverage data.
169171 * Set $raw = true to bypass all filters.
170172 *
171- * @param bool $raw
173+ * @param bool $raw
174+ *
172175 * @return array
176+ *
173177 * @since Method available since Release 1.1.0
174178 */
175179 public function getData ($ raw = false )
@@ -185,6 +189,7 @@ public function getData($raw = false)
185189 * Sets the coverage data.
186190 *
187191 * @param array $data
192+ *
188193 * @since Method available since Release 2.0.0
189194 */
190195 public function setData (array $ data )
@@ -196,6 +201,7 @@ public function setData(array $data)
196201 * Returns the test data.
197202 *
198203 * @return array
204+ *
199205 * @since Method available since Release 1.1.0
200206 */
201207 public function getTests ()
@@ -207,6 +213,7 @@ public function getTests()
207213 * Sets the test data.
208214 *
209215 * @param array $tests
216+ *
210217 * @since Method available since Release 2.0.0
211218 */
212219 public function setTests (array $ tests )
@@ -217,8 +224,9 @@ public function setTests(array $tests)
217224 /**
218225 * Start collection of code coverage information.
219226 *
220- * @param mixed $id
221- * @param bool $clear
227+ * @param mixed $id
228+ * @param bool $clear
229+ *
222230 * @throws PHP_CodeCoverage_InvalidArgumentException
223231 */
224232 public function start ($ id , $ clear = false )
@@ -242,10 +250,12 @@ public function start($id, $clear = false)
242250 /**
243251 * Stop collection of code coverage information.
244252 *
245- * @param bool $append
246- * @param mixed $linesToBeCovered
247- * @param array $linesToBeUsed
253+ * @param bool $append
254+ * @param mixed $linesToBeCovered
255+ * @param array $linesToBeUsed
256+ *
248257 * @return array
258+ *
249259 * @throws PHP_CodeCoverage_InvalidArgumentException
250260 */
251261 public function stop ($ append = true , $ linesToBeCovered = [], array $ linesToBeUsed = [])
@@ -275,11 +285,12 @@ public function stop($append = true, $linesToBeCovered = [], array $linesToBeUse
275285 /**
276286 * Appends code coverage data.
277287 *
278- * @param array $data
279- * @param mixed $id
280- * @param bool $append
281- * @param mixed $linesToBeCovered
282- * @param array $linesToBeUsed
288+ * @param array $data
289+ * @param mixed $id
290+ * @param bool $append
291+ * @param mixed $linesToBeCovered
292+ * @param array $linesToBeUsed
293+ *
283294 * @throws PHP_CodeCoverage_RuntimeException
284295 */
285296 public function append (array $ data , $ id = null , $ append = true , $ linesToBeCovered = [], array $ linesToBeUsed = [])
@@ -384,12 +395,13 @@ public function merge(PHP_CodeCoverage $that)
384395 }
385396
386397 $ this ->tests = array_merge ($ this ->tests , $ that ->getTests ());
387-
388398 }
389399
390400 /**
391- * @param bool $flag
401+ * @param bool $flag
402+ *
392403 * @throws PHP_CodeCoverage_InvalidArgumentException
404+ *
393405 * @since Method available since Release 1.1.0
394406 */
395407 public function setCacheTokens ($ flag )
@@ -413,8 +425,10 @@ public function getCacheTokens()
413425 }
414426
415427 /**
416- * @param bool $flag
428+ * @param bool $flag
429+ *
417430 * @throws PHP_CodeCoverage_InvalidArgumentException
431+ *
418432 * @since Method available since Release 2.0.0
419433 */
420434 public function setCheckForUnintentionallyCoveredCode ($ flag )
@@ -430,7 +444,8 @@ public function setCheckForUnintentionallyCoveredCode($flag)
430444 }
431445
432446 /**
433- * @param bool $flag
447+ * @param bool $flag
448+ *
434449 * @throws PHP_CodeCoverage_InvalidArgumentException
435450 */
436451 public function setForceCoversAnnotation ($ flag )
@@ -446,8 +461,10 @@ public function setForceCoversAnnotation($flag)
446461 }
447462
448463 /**
449- * @param bool $flag
464+ * @param bool $flag
465+ *
450466 * @throws PHP_CodeCoverage_InvalidArgumentException
467+ *
451468 * @since Method available since Release 3.2.0
452469 */
453470 public function setCheckForMissingCoversAnnotation ($ flag )
@@ -463,7 +480,8 @@ public function setCheckForMissingCoversAnnotation($flag)
463480 }
464481
465482 /**
466- * @param bool $flag
483+ * @param bool $flag
484+ *
467485 * @throws PHP_CodeCoverage_InvalidArgumentException
468486 */
469487 public function setCheckForUnexecutedCoveredCode ($ flag )
@@ -480,15 +498,18 @@ public function setCheckForUnexecutedCoveredCode($flag)
480498
481499 /**
482500 * @deprecated
483- * @param bool $flag
501+ *
502+ * @param bool $flag
503+ *
484504 * @throws PHP_CodeCoverage_InvalidArgumentException
485505 */
486506 public function setMapTestClassNameToCoveredClassName ($ flag )
487507 {
488508 }
489509
490510 /**
491- * @param bool $flag
511+ * @param bool $flag
512+ *
492513 * @throws PHP_CodeCoverage_InvalidArgumentException
493514 */
494515 public function setAddUncoveredFilesFromWhitelist ($ flag )
@@ -504,7 +525,8 @@ public function setAddUncoveredFilesFromWhitelist($flag)
504525 }
505526
506527 /**
507- * @param bool $flag
528+ * @param bool $flag
529+ *
508530 * @throws PHP_CodeCoverage_InvalidArgumentException
509531 */
510532 public function setProcessUncoveredFilesFromWhitelist ($ flag )
@@ -520,7 +542,8 @@ public function setProcessUncoveredFilesFromWhitelist($flag)
520542 }
521543
522544 /**
523- * @param bool $flag
545+ * @param bool $flag
546+ *
524547 * @throws PHP_CodeCoverage_InvalidArgumentException
525548 */
526549 public function setDisableIgnoredLines ($ flag )
@@ -536,8 +559,10 @@ public function setDisableIgnoredLines($flag)
536559 }
537560
538561 /**
539- * @param bool $flag
562+ * @param bool $flag
563+ *
540564 * @throws PHP_CodeCoverage_InvalidArgumentException
565+ *
541566 * @since Method available since Release 3.0.2
542567 */
543568 public function setIgnoreDeprecatedCode ($ flag )
@@ -554,6 +579,7 @@ public function setIgnoreDeprecatedCode($flag)
554579
555580 /**
556581 * @param array $whitelist
582+ *
557583 * @since Method available since Release 3.3.0
558584 */
559585 public function setUnintentionallyCoveredSubclassesWhitelist (array $ whitelist )
@@ -564,9 +590,10 @@ public function setUnintentionallyCoveredSubclassesWhitelist(array $whitelist)
564590 /**
565591 * Applies the @covers annotation filtering.
566592 *
567- * @param array $data
568- * @param mixed $linesToBeCovered
569- * @param array $linesToBeUsed
593+ * @param array $data
594+ * @param mixed $linesToBeCovered
595+ * @param array $linesToBeUsed
596+ *
570597 * @throws PHP_CodeCoverage_MissingCoversAnnotationException
571598 * @throws PHP_CodeCoverage_UnintentionallyCoveredCodeException
572599 */
@@ -645,6 +672,7 @@ private function applyIgnoredLinesFilter(array &$data)
645672
646673 /**
647674 * @param array $data
675+ *
648676 * @since Method available since Release 1.1.0
649677 */
650678 private function initializeFilesThatAreSeenTheFirstTime (array $ data )
@@ -724,9 +752,12 @@ private function processUncoveredFileFromWhitelist($uncoveredFile, array &$data,
724752 /**
725753 * Returns the lines of a source file that should be ignored.
726754 *
727- * @param string $filename
755+ * @param string $filename
756+ *
728757 * @return array
758+ *
729759 * @throws PHP_CodeCoverage_InvalidArgumentException
760+ *
730761 * @since Method available since Release 2.0.0
731762 */
732763 private function getLinesToBeIgnored ($ filename )
@@ -896,10 +927,12 @@ private function getLinesToBeIgnored($filename)
896927 }
897928
898929 /**
899- * @param array $data
900- * @param array $linesToBeCovered
901- * @param array $linesToBeUsed
930+ * @param array $data
931+ * @param array $linesToBeCovered
932+ * @param array $linesToBeUsed
933+ *
902934 * @throws PHP_CodeCoverage_UnintentionallyCoveredCodeException
935+ *
903936 * @since Method available since Release 2.0.0
904937 */
905938 private function performUnintentionallyCoveredCodeCheck (array &$ data , array $ linesToBeCovered , array $ linesToBeUsed )
@@ -929,9 +962,10 @@ private function performUnintentionallyCoveredCodeCheck(array &$data, array $lin
929962 }
930963
931964 /**
932- * @param array $data
933- * @param array $linesToBeCovered
934- * @param array $linesToBeUsed
965+ * @param array $data
966+ * @param array $linesToBeCovered
967+ * @param array $linesToBeUsed
968+ *
935969 * @throws PHP_CodeCoverage_CoveredCodeNotExecutedException
936970 */
937971 private function performUnexecutedCoveredCodeCheck (array &$ data , array $ linesToBeCovered , array $ linesToBeUsed )
@@ -969,9 +1003,11 @@ private function performUnexecutedCoveredCodeCheck(array &$data, array $linesToB
9691003 }
9701004
9711005 /**
972- * @param array $linesToBeCovered
973- * @param array $linesToBeUsed
1006+ * @param array $linesToBeCovered
1007+ * @param array $linesToBeUsed
1008+ *
9741009 * @return array
1010+ *
9751011 * @since Method available since Release 2.0.0
9761012 */
9771013 private function getAllowedLines (array $ linesToBeCovered , array $ linesToBeUsed )
@@ -1011,6 +1047,7 @@ private function getAllowedLines(array $linesToBeCovered, array $linesToBeUsed)
10111047
10121048 /**
10131049 * @return PHP_CodeCoverage_Driver
1050+ *
10141051 * @throws PHP_CodeCoverage_RuntimeException
10151052 */
10161053 private function selectDriver ()
0 commit comments