From d8b0083632bc97f6e80918ddb10075a104b269c8 Mon Sep 17 00:00:00 2001
From: mark_story <mark@mark-story.com>
Date: Fri, 6 Jun 2014 13:57:48 -0400
Subject: [PATCH] Fix api doc errors in TestSuite/

---
 lib/Cake/TestSuite/CakeTestCase.php           |  2 +-
 lib/Cake/TestSuite/CakeTestSuiteCommand.php   |  8 ++--
 .../TestSuite/Coverage/BaseCoverageReport.php |  4 +-
 .../TestSuite/Coverage/HtmlCoverageReport.php | 14 +++----
 .../TestSuite/Reporter/CakeBaseReporter.php   | 38 +++++++++----------
 .../TestSuite/Reporter/CakeHtmlReporter.php   | 12 +++---
 6 files changed, 39 insertions(+), 39 deletions(-)

diff --git a/lib/Cake/TestSuite/CakeTestCase.php b/lib/Cake/TestSuite/CakeTestCase.php
index 687ce1e70..ff3b95651 100644
--- a/lib/Cake/TestSuite/CakeTestCase.php
+++ b/lib/Cake/TestSuite/CakeTestCase.php
@@ -373,7 +373,7 @@ abstract class CakeTestCase extends PHPUnit_Framework_TestCase {
  *
  * @param string $string An HTML/XHTML/XML string
  * @param array $expected An array, see above
- * @param string $message SimpleTest failure output string
+ * @param string $fullDebug Whether or not more verbose output should be used.
  * @return boolean
  */
 	public function assertTags($string, $expected, $fullDebug = false) {
diff --git a/lib/Cake/TestSuite/CakeTestSuiteCommand.php b/lib/Cake/TestSuite/CakeTestSuiteCommand.php
index 1af5baa8e..60caa54f8 100644
--- a/lib/Cake/TestSuite/CakeTestSuiteCommand.php
+++ b/lib/Cake/TestSuite/CakeTestSuiteCommand.php
@@ -35,7 +35,7 @@ class CakeTestSuiteCommand extends PHPUnit_TextUI_Command {
 /**
  * Construct method
  *
- * @param mixed $loader
+ * @param mixed $loader The loader instance to use.
  * @param array $params list of options to be used for this run
  * @throws MissingTestLoaderException When a loader class could not be found.
  */
@@ -55,8 +55,8 @@ class CakeTestSuiteCommand extends PHPUnit_TextUI_Command {
 /**
  * Ugly hack to get around PHPUnit having a hard coded class name for the Runner. :(
  *
- * @param array   $argv
- * @param boolean $exit
+ * @param array $argv The command arguments
+ * @param boolean $exit The exit mode.
  * @return void
  */
 	public function run(array $argv, $exit = true) {
@@ -131,7 +131,7 @@ class CakeTestSuiteCommand extends PHPUnit_TextUI_Command {
 /**
  * Handles output flag used to change printing on webrunner.
  *
- * @param string $reporter
+ * @param string $reporter The reporter class to use.
  * @return void
  */
 	public function handleReporter($reporter) {
diff --git a/lib/Cake/TestSuite/Coverage/BaseCoverageReport.php b/lib/Cake/TestSuite/Coverage/BaseCoverageReport.php
index 0c9ecb2f3..37ac3e868 100644
--- a/lib/Cake/TestSuite/Coverage/BaseCoverageReport.php
+++ b/lib/Cake/TestSuite/Coverage/BaseCoverageReport.php
@@ -134,8 +134,8 @@ abstract class BaseCoverageReport {
  * 3.5 uses -1 for uncovered, and -2 for dead.
  * 3.6 uses array() for uncovered and null for dead.
  *
- * @param array $fileLines
- * @param array $coverageData
+ * @param array $fileLines The lines in the file.
+ * @param array $coverageData The raw coverage data.
  * @return array Array of covered, total lines.
  */
 	protected function _calculateCoveredLines($fileLines, $coverageData) {
diff --git a/lib/Cake/TestSuite/Coverage/HtmlCoverageReport.php b/lib/Cake/TestSuite/Coverage/HtmlCoverageReport.php
index 136cec4fe..2ff5e6c0f 100644
--- a/lib/Cake/TestSuite/Coverage/HtmlCoverageReport.php
+++ b/lib/Cake/TestSuite/Coverage/HtmlCoverageReport.php
@@ -127,7 +127,7 @@ HTML;
 /**
  * Guess the class name the test was for based on the test case filename.
  *
- * @param ReflectionClass $testReflection.
+ * @param ReflectionClass $testReflection The class to reflect
  * @return string Possible test subject name.
  */
 	protected function _guessSubjectName($testReflection) {
@@ -143,10 +143,10 @@ HTML;
 /**
  * Renders the HTML for a single line in the HTML diff.
  *
- * @param string $line
- * @param integer $linenumber
- * @param string $class
- * @param array $coveringTests
+ * @param string $line The line content.
+ * @param integer $linenumber The line number
+ * @param string $class The classname to use.
+ * @param array $coveringTests The tests covering the line.
  * @return string
  */
 	protected function _paintLine($line, $linenumber, $class, $coveringTests) {
@@ -195,8 +195,8 @@ HTML;
 /**
  * Generate an HTML snippet for coverage headers
  *
- * @param string $filename
- * @param string $percent
+ * @param string $filename The file name being covered
+ * @param string $percent The percentage covered
  * @return string
  */
 	public function coverageHeader($filename, $percent) {
diff --git a/lib/Cake/TestSuite/Reporter/CakeBaseReporter.php b/lib/Cake/TestSuite/Reporter/CakeBaseReporter.php
index f98cde85c..12b70b5dd 100644
--- a/lib/Cake/TestSuite/Reporter/CakeBaseReporter.php
+++ b/lib/Cake/TestSuite/Reporter/CakeBaseReporter.php
@@ -121,7 +121,7 @@ class CakeBaseReporter extends PHPUnit_TextUI_ResultPrinter {
 /**
  * Print result
  *
- * @param PHPUnit_Framework_TestResult $result
+ * @param PHPUnit_Framework_TestResult $result The result object
  * @return void
  */
 	public function printResult(PHPUnit_Framework_TestResult $result) {
@@ -131,7 +131,7 @@ class CakeBaseReporter extends PHPUnit_TextUI_ResultPrinter {
 /**
  * Paint result
  *
- * @param PHPUnit_Framework_TestResult $result
+ * @param PHPUnit_Framework_TestResult $result The result object
  * @return void
  */
 	public function paintResult(PHPUnit_Framework_TestResult $result) {
@@ -141,9 +141,9 @@ class CakeBaseReporter extends PHPUnit_TextUI_ResultPrinter {
 /**
  * An error occurred.
  *
- * @param  PHPUnit_Framework_Test $test
- * @param  Exception              $e
- * @param  float                  $time
+ * @param  PHPUnit_Framework_Test $test The test to add an error for.
+ * @param  Exception $e The exception object to add.
+ * @param  float $time The current time.
  * @return void
  */
 	public function addError(PHPUnit_Framework_Test $test, Exception $e, $time) {
@@ -153,9 +153,9 @@ class CakeBaseReporter extends PHPUnit_TextUI_ResultPrinter {
 /**
  * A failure occurred.
  *
- * @param  PHPUnit_Framework_Test $test
- * @param  PHPUnit_Framework_AssertionFailedError $e
- * @param  float $time
+ * @param  PHPUnit_Framework_Test $test The test that failed
+ * @param  PHPUnit_Framework_AssertionFailedError $e The assertion that failed.
+ * @param  float $time The current time.
  * @return void
  */
 	public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time) {
@@ -165,9 +165,9 @@ class CakeBaseReporter extends PHPUnit_TextUI_ResultPrinter {
 /**
  * Incomplete test.
  *
- * @param  PHPUnit_Framework_Test $test
- * @param  Exception $e
- * @param  float $time
+ * @param  PHPUnit_Framework_Test $test The test that was incomplete.
+ * @param  Exception $e The incomplete exception
+ * @param  float $time The current time.
  * @return void
  */
 	public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time) {
@@ -177,9 +177,9 @@ class CakeBaseReporter extends PHPUnit_TextUI_ResultPrinter {
 /**
  * Skipped test.
  *
- * @param  PHPUnit_Framework_Test $test
- * @param  Exception $e
- * @param  float $time
+ * @param  PHPUnit_Framework_Test $test The test that failed.
+ * @param  Exception $e The skip object.
+ * @param  float $time The current time.
  * @return void
  */
 	public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time) {
@@ -189,7 +189,7 @@ class CakeBaseReporter extends PHPUnit_TextUI_ResultPrinter {
 /**
  * A test suite started.
  *
- * @param  PHPUnit_Framework_TestSuite $suite
+ * @param  PHPUnit_Framework_TestSuite $suite The suite to start
  * @return void
  */
 	public function startTestSuite(PHPUnit_Framework_TestSuite $suite) {
@@ -202,7 +202,7 @@ class CakeBaseReporter extends PHPUnit_TextUI_ResultPrinter {
 /**
  * A test suite ended.
  *
- * @param  PHPUnit_Framework_TestSuite $suite
+ * @param  PHPUnit_Framework_TestSuite $suite The suite that ended.
  * @return void
  */
 	public function endTestSuite(PHPUnit_Framework_TestSuite $suite) {
@@ -211,7 +211,7 @@ class CakeBaseReporter extends PHPUnit_TextUI_ResultPrinter {
 /**
  * A test started.
  *
- * @param  PHPUnit_Framework_Test $test
+ * @param  PHPUnit_Framework_Test $test The test that started.
  * @return void
  */
 	public function startTest(PHPUnit_Framework_Test $test) {
@@ -220,8 +220,8 @@ class CakeBaseReporter extends PHPUnit_TextUI_ResultPrinter {
 /**
  * A test ended.
  *
- * @param  PHPUnit_Framework_Test $test
- * @param  float $time
+ * @param  PHPUnit_Framework_Test $test The test that ended
+ * @param  float $time The current time.
  * @return void
  */
 	public function endTest(PHPUnit_Framework_Test $test, $time) {
diff --git a/lib/Cake/TestSuite/Reporter/CakeHtmlReporter.php b/lib/Cake/TestSuite/Reporter/CakeHtmlReporter.php
index 407045739..d67373682 100644
--- a/lib/Cake/TestSuite/Reporter/CakeHtmlReporter.php
+++ b/lib/Cake/TestSuite/Reporter/CakeHtmlReporter.php
@@ -169,7 +169,7 @@ class CakeHtmlReporter extends CakeBaseReporter {
 /**
  * Paints a code coverage report.
  *
- * @param array $coverage
+ * @param array $coverage The coverage data
  * @return void
  */
 	public function paintCoverage(array $coverage) {
@@ -243,7 +243,7 @@ class CakeHtmlReporter extends CakeBaseReporter {
  *
  * @param PHPUnit_Framework_AssertionFailedError $message Failure object displayed in
  *   the context of the other tests.
- * @param mixed $test
+ * @param mixed $test The test case to paint a failure for.
  * @return void
  */
 	public function paintFail($message, $test) {
@@ -278,7 +278,7 @@ class CakeHtmlReporter extends CakeBaseReporter {
  * trail of the nesting test suites below the
  * top level test.
  *
- * @param PHPUnit_Framework_Test test method that just passed
+ * @param PHPUnit_Framework_Test $test Test method that just passed
  * @param float $time time spent to run the test method
  * @return void
  */
@@ -295,8 +295,8 @@ class CakeHtmlReporter extends CakeBaseReporter {
 /**
  * Paints a PHP exception.
  *
- * @param Exception $exception Exception to display.
- * @param mixed $test
+ * @param Exception $message Exception to display.
+ * @param mixed $test The test that failed.
  * @return void
  */
 	public function paintException($message, $test) {
@@ -370,7 +370,7 @@ class CakeHtmlReporter extends CakeBaseReporter {
 /**
  * A test suite started.
  *
- * @param PHPUnit_Framework_TestSuite $suite
+ * @param PHPUnit_Framework_TestSuite $suite The test suite to start.
  * @return void
  */
 	public function startTestSuite(PHPUnit_Framework_TestSuite $suite) {