sebastianbergmann/phpunit — Issue #521: PHPDoc for PHPUnit_Framework_ComparisonFailure::__construct is incomplete
Author: oliverklee
Created: 2012-03-09 18:12:49+00:00
State: open

This is in version 3.6.10:

/**
* Initialises with the expected value and the actual value.
*
* @param mixed $expected Expected value retrieved.
* @param mixed $actual Actual value retrieved.
* @param boolean $identical
* @param string $message A string which is prefixed on all returned lines
* in the difference output.
*/
public function __construct($expected, $actual, $expectedAsString, $actualAsString, $identical = FALSE, $message = '')

$expectedAsString and $actualAsString are missing the @param altogether, and $identical needs some more explanation. (I don't suppose it means that the expected and actual values are identical as in that case a ComparisonFailure would not occur).

The @var for the member $identical also needs to be enhanced. And maybe $identical needs a new name (thinking in the way of the "Clean Code" book ...)