Updating doc blocks.

This commit is contained in:
Mark Story 2010-01-05 20:56:25 -05:00
parent faafe5a0dc
commit f228990c58
3 changed files with 18 additions and 2 deletions

View file

@ -83,6 +83,7 @@ class CakeBaseReporter extends SimpleReporter {
* but in a separate function to reduce dependancies. * but in a separate function to reduce dependancies.
* *
* @return float Time in microseconds * @return float Time in microseconds
* @access protected
*/ */
function _getTime() { function _getTime() {
list($usec, $sec) = explode(' ', microtime()); list($usec, $sec) = explode(' ', microtime());

View file

@ -87,6 +87,7 @@ class CakeHtmlReporter extends SimpleReporter {
* title to the name of the starting test. * title to the name of the starting test.
* *
* @param string $test_name Name class of test. * @param string $test_name Name class of test.
* @return void
* @access public * @access public
*/ */
function paintHeader($testName) { function paintHeader($testName) {
@ -100,8 +101,8 @@ class CakeHtmlReporter extends SimpleReporter {
* reloaded on every request. Otherwise you could be * reloaded on every request. Otherwise you could be
* scratching your head over out of date test data. * scratching your head over out of date test data.
* *
* @return void
* @access public * @access public
* @static
*/ */
function sendNoCacheHeaders() { function sendNoCacheHeaders() {
if (!headers_sent()) { if (!headers_sent()) {
@ -118,6 +119,7 @@ class CakeHtmlReporter extends SimpleReporter {
* the passes and failures. * the passes and failures.
* *
* @param string $test_name Name class of test. * @param string $test_name Name class of test.
* @return void
* @access public * @access public
*/ */
function paintFooter($test_name) { function paintFooter($test_name) {
@ -147,6 +149,7 @@ class CakeHtmlReporter extends SimpleReporter {
* *
* @param string $message Failure message displayed in * @param string $message Failure message displayed in
* the context of the other tests. * the context of the other tests.
* @return void
* @access public * @access public
*/ */
function paintFail($message) { function paintFail($message) {
@ -166,6 +169,7 @@ class CakeHtmlReporter extends SimpleReporter {
* top level test. * top level test.
* *
* @param string $message Pass message displayed in the context of the other tests. * @param string $message Pass message displayed in the context of the other tests.
* @return void
* @access public * @access public
*/ */
function paintPass($message) { function paintPass($message) {
@ -186,6 +190,7 @@ class CakeHtmlReporter extends SimpleReporter {
* Paints a PHP error. * Paints a PHP error.
* *
* @param string $message Message is ignored. * @param string $message Message is ignored.
* @return void
* @access public * @access public
*/ */
function paintError($message) { function paintError($message) {
@ -203,6 +208,7 @@ class CakeHtmlReporter extends SimpleReporter {
* Paints a PHP exception. * Paints a PHP exception.
* *
* @param Exception $exception Exception to display. * @param Exception $exception Exception to display.
* @return void
* @access public * @access public
*/ */
function paintException($exception) { function paintException($exception) {
@ -223,7 +229,8 @@ class CakeHtmlReporter extends SimpleReporter {
/** /**
* Prints the message for skipping tests. * Prints the message for skipping tests.
* *
* @param string $message Text of skip condition. * @param string $message Text of skip condition.
* @return void
* @access public * @access public
*/ */
function paintSkip($message) { function paintSkip($message) {
@ -238,6 +245,7 @@ class CakeHtmlReporter extends SimpleReporter {
* Paints formatted text such as dumped variables. * Paints formatted text such as dumped variables.
* *
* @param string $message Text to show. * @param string $message Text to show.
* @return void
* @access public * @access public
*/ */
function paintFormattedMessage($message) { function paintFormattedMessage($message) {

View file

@ -31,6 +31,7 @@ class CakeTextReporter extends CakeBaseReporter {
* the passes and failures. * the passes and failures.
* *
* @param string $test_name Name class of test. * @param string $test_name Name class of test.
* @return void
* @access public * @access public
*/ */
function paintFooter($test_name) { function paintFooter($test_name) {
@ -54,6 +55,7 @@ class CakeTextReporter extends CakeBaseReporter {
* Paints the title only. * Paints the title only.
* *
* @param string $test_name Name class of test. * @param string $test_name Name class of test.
* @return void
* @access public * @access public
*/ */
function paintHeader($test_name) { function paintHeader($test_name) {
@ -69,6 +71,7 @@ class CakeTextReporter extends CakeBaseReporter {
* *
* @param string $message Failure message displayed in * @param string $message Failure message displayed in
* the context of the other tests. * the context of the other tests.
* @return void
* @access public * @access public
*/ */
function paintFail($message) { function paintFail($message) {
@ -84,6 +87,7 @@ class CakeTextReporter extends CakeBaseReporter {
* Paints a PHP error. * Paints a PHP error.
* *
* @param string $message Message to be shown. * @param string $message Message to be shown.
* @return void
* @access public * @access public
*/ */
function paintError($message) { function paintError($message) {
@ -99,6 +103,7 @@ class CakeTextReporter extends CakeBaseReporter {
* Paints a PHP exception. * Paints a PHP exception.
* *
* @param Exception $exception Exception to describe. * @param Exception $exception Exception to describe.
* @return void
* @access public * @access public
*/ */
function paintException($exception) { function paintException($exception) {
@ -118,6 +123,7 @@ class CakeTextReporter extends CakeBaseReporter {
* Prints the message for skipping tests. * Prints the message for skipping tests.
* *
* @param string $message Text of skip condition. * @param string $message Text of skip condition.
* @return void
* @access public * @access public
*/ */
function paintSkip($message) { function paintSkip($message) {
@ -129,6 +135,7 @@ class CakeTextReporter extends CakeBaseReporter {
* Paints formatted text such as dumped variables. * Paints formatted text such as dumped variables.
* *
* @param string $message Text to show. * @param string $message Text to show.
* @return void
* @access public * @access public
*/ */
function paintFormattedMessage($message) { function paintFormattedMessage($message) {