Merge branch 'master' into feature/path-coverage

Author: sebastianbergmann

src/CodeCoverage.php

@@ -13,13 +13,7 @@
 /**
  * Provides collection functionality for PHP code coverage information.
  *
- * @category   PHP
- * @package    CodeCoverage
- * @author     Sebastian Bergmann <sebastian@phpunit.de>
- * @copyright  Sebastian Bergmann <sebastian@phpunit.de>
- * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
- * @link       http://github.com/sebastianbergmann/php-code-coverage
- * @since      Class available since Release 1.0.0
+ * @since Class available since Release 1.0.0
  */
 class PHP_CodeCoverage
 {

src/CodeCoverage/Driver.php

@@ -11,13 +11,7 @@
 /**
  * Interface for code coverage drivers.
  *
- * @category   PHP
- * @package    CodeCoverage
- * @author     Sebastian Bergmann <sebastian@phpunit.de>
- * @copyright  Sebastian Bergmann <sebastian@phpunit.de>
- * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
- * @link       http://github.com/sebastianbergmann/php-code-coverage
- * @since      Class available since Release 1.0.0
+ * @since Class available since Release 1.0.0
  */
 interface PHP_CodeCoverage_Driver
 {

src/CodeCoverage/Driver/Xdebug.php

@@ -11,13 +11,7 @@
 /**
  * Driver for Xdebug's code coverage functionality.
  *
- * @category   PHP
- * @package    CodeCoverage
- * @author     Sebastian Bergmann <sebastian@phpunit.de>
- * @copyright  Sebastian Bergmann <sebastian@phpunit.de>
- * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
- * @link       http://github.com/sebastianbergmann/php-code-coverage
- * @since      Class available since Release 1.0.0
+ * @since Class available since Release 1.0.0
  * @codeCoverageIgnore
  */
 class PHP_CodeCoverage_Driver_Xdebug implements PHP_CodeCoverage_Driver

src/CodeCoverage/Exception.php

@@ -11,13 +11,7 @@
 /**
  * Exception class for PHP_CodeCoverage component.
  *
- * @category   PHP
- * @package    CodeCoverage
- * @author     Sebastian Bergmann <sebastian@phpunit.de>
- * @copyright  Sebastian Bergmann <sebastian@phpunit.de>
- * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
- * @link       http://github.com/sebastianbergmann/php-code-coverage
- * @since      Class available since Release 1.1.0
+ * @since Class available since Release 1.1.0
  */
 class PHP_CodeCoverage_Exception extends RuntimeException
 {

src/CodeCoverage/Exception/UnintentionallyCoveredCode.php

@@ -11,13 +11,7 @@
 /**
  * Exception that is raised when code is unintentionally covered.
  *
- * @category   PHP
- * @package    CodeCoverage
- * @author     Sebastian Bergmann <sebastian@phpunit.de>
- * @copyright  Sebastian Bergmann <sebastian@phpunit.de>
- * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
- * @link       http://github.com/sebastianbergmann/php-code-coverage
- * @since      Class available since Release 2.0.0
+ * @since Class available since Release 2.0.0
  */
 class PHP_CodeCoverage_Exception_UnintentionallyCoveredCode extends PHP_CodeCoverage_Exception
 {

src/CodeCoverage/Filter.php

@@ -11,13 +11,7 @@
 /**
  * Filter for blacklisting and whitelisting of code coverage information.
  *
- * @category   PHP
- * @package    CodeCoverage
- * @author     Sebastian Bergmann <sebastian@phpunit.de>
- * @copyright  Sebastian Bergmann <sebastian@phpunit.de>
- * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
- * @link       http://github.com/sebastianbergmann/php-code-coverage
- * @since      Class available since Release 1.0.0
+ * @since Class available since Release 1.0.0
  */
 class PHP_CodeCoverage_Filter
 {

src/CodeCoverage/Report/Clover.php

@@ -11,13 +11,7 @@
 /**
  * Generates a Clover XML logfile from an PHP_CodeCoverage object.
  *
- * @category   PHP
- * @package    CodeCoverage
- * @author     Sebastian Bergmann <sebastian@phpunit.de>
- * @copyright  Sebastian Bergmann <sebastian@phpunit.de>
- * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
- * @link       http://github.com/sebastianbergmann/php-code-coverage
- * @since      Class available since Release 1.0.0
+ * @since Class available since Release 1.0.0
  */
 class PHP_CodeCoverage_Report_Clover
 {

src/CodeCoverage/Report/Crap4j.php

@@ -9,17 +9,29 @@
  */
 
 /**
- * @category   PHP
- * @package    CodeCoverage
- * @author     Zsolt Takács <zsolt@takacs.cc>
- * @copyright  Sebastian Bergmann <sebastian@phpunit.de>
- * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
- * @link       http://github.com/sebastianbergmann/php-code-coverage
- * @since      Class available since Release 2.0.0
+ * @since Class available since Release 2.0.0
  */
 class PHP_CodeCoverage_Report_Crap4j
 {
-    private $threshold = 30;
+    /**
+     * @var int
+     */
+    private $threshold;
+
+    /**
+     * @param int $threshold
+     */
+    public function __construct($threshold = 30)
+    {
+        if (!is_int($threshold)) {
+            throw PHP_CodeCoverage_Util_InvalidArgumentHelper::factory(
+                1,
+                'integer'
+            );
+        }
+
+        $this->threshold = $threshold;
+    }
 
     /**
      * @param  PHP_CodeCoverage $coverage
@@ -116,9 +128,16 @@ public function process(PHP_CodeCoverage $coverage, $target = null, $name = null
         }
     }
 
+    /**
+     * @param  float   $crapValue
+     * @param  integer $cyclomaticComplexity
+     * @param  float   $coveragePercent
+     * @return float
+     */
     private function getCrapLoad($crapValue, $cyclomaticComplexity, $coveragePercent)
     {
         $crapLoad = 0;
+
         if ($crapValue >= $this->threshold) {
             $crapLoad += $cyclomaticComplexity * (1.0 - $coveragePercent / 100);
             $crapLoad += $cyclomaticComplexity / $this->threshold;
@@ -127,6 +146,10 @@ private function getCrapLoad($crapValue, $cyclomaticComplexity, $coveragePercent
         return $crapLoad;
     }
 
+    /**
+     * @param  float $value
+     * @return float
+     */
     private function roundValue($value)
     {
         return round($value, 2);

src/CodeCoverage/Report/Factory.php

@@ -11,13 +11,7 @@
 /**
  * Factory for PHP_CodeCoverage_Report_Node_* object graphs.
  *
- * @category   PHP
- * @package    CodeCoverage
- * @author     Sebastian Bergmann <sebastian@phpunit.de>
- * @copyright  Sebastian Bergmann <sebastian@phpunit.de>
- * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
- * @link       http://github.com/sebastianbergmann/php-code-coverage
- * @since      Class available since Release 1.1.0
+ * @since Class available since Release 1.1.0
  */
 class PHP_CodeCoverage_Report_Factory
 {

src/CodeCoverage/Report/HTML.php

@@ -11,13 +11,7 @@
 /**
  * Generates an HTML report from an PHP_CodeCoverage object.
  *
- * @category   PHP
- * @package    CodeCoverage
- * @author     Sebastian Bergmann <sebastian@phpunit.de>
- * @copyright  Sebastian Bergmann <sebastian@phpunit.de>
- * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
- * @link       http://github.com/sebastianbergmann/php-code-coverage
- * @since      Class available since Release 1.0.0
+ * @since Class available since Release 1.0.0
  */
 class PHP_CodeCoverage_Report_HTML
 {