From f228990c58829d57251f8e307481908f0d38295c Mon Sep 17 00:00:00 2001 From: Mark Story Date: Tue, 5 Jan 2010 20:56:25 -0500 Subject: [PATCH] Updating doc blocks. --- cake/tests/lib/reporter/cake_base_reporter.php | 1 + cake/tests/lib/reporter/cake_html_reporter.php | 12 ++++++++++-- cake/tests/lib/reporter/cake_text_reporter.php | 7 +++++++ 3 files changed, 18 insertions(+), 2 deletions(-) diff --git a/cake/tests/lib/reporter/cake_base_reporter.php b/cake/tests/lib/reporter/cake_base_reporter.php index ad1fd5bf0..f7275b15d 100644 --- a/cake/tests/lib/reporter/cake_base_reporter.php +++ b/cake/tests/lib/reporter/cake_base_reporter.php @@ -83,6 +83,7 @@ class CakeBaseReporter extends SimpleReporter { * but in a separate function to reduce dependancies. * * @return float Time in microseconds + * @access protected */ function _getTime() { list($usec, $sec) = explode(' ', microtime()); diff --git a/cake/tests/lib/reporter/cake_html_reporter.php b/cake/tests/lib/reporter/cake_html_reporter.php index 97d0c15a9..6f7c699f0 100644 --- a/cake/tests/lib/reporter/cake_html_reporter.php +++ b/cake/tests/lib/reporter/cake_html_reporter.php @@ -87,6 +87,7 @@ class CakeHtmlReporter extends SimpleReporter { * title to the name of the starting test. * * @param string $test_name Name class of test. + * @return void * @access public */ function paintHeader($testName) { @@ -100,8 +101,8 @@ class CakeHtmlReporter extends SimpleReporter { * reloaded on every request. Otherwise you could be * scratching your head over out of date test data. * + * @return void * @access public - * @static */ function sendNoCacheHeaders() { if (!headers_sent()) { @@ -118,6 +119,7 @@ class CakeHtmlReporter extends SimpleReporter { * the passes and failures. * * @param string $test_name Name class of test. + * @return void * @access public */ function paintFooter($test_name) { @@ -147,6 +149,7 @@ class CakeHtmlReporter extends SimpleReporter { * * @param string $message Failure message displayed in * the context of the other tests. + * @return void * @access public */ function paintFail($message) { @@ -166,6 +169,7 @@ class CakeHtmlReporter extends SimpleReporter { * top level test. * * @param string $message Pass message displayed in the context of the other tests. + * @return void * @access public */ function paintPass($message) { @@ -186,6 +190,7 @@ class CakeHtmlReporter extends SimpleReporter { * Paints a PHP error. * * @param string $message Message is ignored. + * @return void * @access public */ function paintError($message) { @@ -203,6 +208,7 @@ class CakeHtmlReporter extends SimpleReporter { * Paints a PHP exception. * * @param Exception $exception Exception to display. + * @return void * @access public */ function paintException($exception) { @@ -223,7 +229,8 @@ class CakeHtmlReporter extends SimpleReporter { /** * Prints the message for skipping tests. * - * @param string $message Text of skip condition. + * @param string $message Text of skip condition. + * @return void * @access public */ function paintSkip($message) { @@ -238,6 +245,7 @@ class CakeHtmlReporter extends SimpleReporter { * Paints formatted text such as dumped variables. * * @param string $message Text to show. + * @return void * @access public */ function paintFormattedMessage($message) { diff --git a/cake/tests/lib/reporter/cake_text_reporter.php b/cake/tests/lib/reporter/cake_text_reporter.php index 70038f65c..6a4ff7b76 100644 --- a/cake/tests/lib/reporter/cake_text_reporter.php +++ b/cake/tests/lib/reporter/cake_text_reporter.php @@ -31,6 +31,7 @@ class CakeTextReporter extends CakeBaseReporter { * the passes and failures. * * @param string $test_name Name class of test. + * @return void * @access public */ function paintFooter($test_name) { @@ -54,6 +55,7 @@ class CakeTextReporter extends CakeBaseReporter { * Paints the title only. * * @param string $test_name Name class of test. + * @return void * @access public */ function paintHeader($test_name) { @@ -69,6 +71,7 @@ class CakeTextReporter extends CakeBaseReporter { * * @param string $message Failure message displayed in * the context of the other tests. + * @return void * @access public */ function paintFail($message) { @@ -84,6 +87,7 @@ class CakeTextReporter extends CakeBaseReporter { * Paints a PHP error. * * @param string $message Message to be shown. + * @return void * @access public */ function paintError($message) { @@ -99,6 +103,7 @@ class CakeTextReporter extends CakeBaseReporter { * Paints a PHP exception. * * @param Exception $exception Exception to describe. + * @return void * @access public */ function paintException($exception) { @@ -118,6 +123,7 @@ class CakeTextReporter extends CakeBaseReporter { * Prints the message for skipping tests. * * @param string $message Text of skip condition. + * @return void * @access public */ function paintSkip($message) { @@ -129,6 +135,7 @@ class CakeTextReporter extends CakeBaseReporter { * Paints formatted text such as dumped variables. * * @param string $message Text to show. + * @return void * @access public */ function paintFormattedMessage($message) {