adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2025-01-31 09:06:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updating doc blocks.

Browse source
This commit is contained in:
mark_story 2009-09-13 13:11:37 -04:00
parent e9c747badc
commit edf5f2d6e2
1 changed files with 23 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
cake/tests/lib/cake_reporter.php
View file

@ -27,7 +27,8 @@
*/ */
/** /**
* Short description for class. * CakeHtmlReporter Reports Results of TestSuites and Test Cases
* in an HTML format / context.
* *
* @package cake * @package cake
* @subpackage cake.cake.tests.lib * @subpackage cake.cake.tests.lib
@ -40,6 +41,7 @@ class CakeHtmlReporter extends SimpleReporter {
* Does nothing yet. The first output will * Does nothing yet. The first output will
* be sent on the first test start. For use * be sent on the first test start. For use
* by a web browser. * by a web browser.
*
* @access public * @access public
*/ */
function CakeHtmlReporter($character_set = 'ISO-8859-1') { function CakeHtmlReporter($character_set = 'ISO-8859-1') {
@ -53,6 +55,7 @@ class CakeHtmlReporter extends SimpleReporter {
/** /**
* Paints the top of the web page setting the * Paints the top of the web page setting the
* 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.
* @access public * @access public
*/ */
@ -66,6 +69,7 @@ class CakeHtmlReporter extends SimpleReporter {
* Send the headers necessary to ensure the page is * Send the headers necessary to ensure the page is
* 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.
*
* @access public * @access public
* @static * @static
*/ */
@ -82,6 +86,7 @@ class CakeHtmlReporter extends SimpleReporter {
/** /**
* Paints the end of the test with a summary of * Paints the end of the test with a summary of
* the passes and failures. * the passes and failures.
*
* @param string $test_name Name class of test. * @param string $test_name Name class of test.
* @access public * @access public
*/ */
@ -103,6 +108,7 @@ class CakeHtmlReporter extends SimpleReporter {
* Paints the test failure with a breadcrumbs * Paints the test failure with a breadcrumbs
* trail of the nesting test suites below the * trail of the nesting test suites below the
* top level test. * top level test.
*
* @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.
* @access public * @access public
@ -122,8 +128,8 @@ class CakeHtmlReporter extends SimpleReporter {
* Paints the test pass with a breadcrumbs * Paints the test pass with a breadcrumbs
* trail of the nesting test suites below the * trail of the nesting test suites below the
* 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.
* @access public * @access public
*/ */
function paintPass($message) { function paintPass($message) {
@ -142,6 +148,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.
* @access public * @access public
*/ */
@ -158,6 +165,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.
* @access public * @access public
*/ */
@ -178,6 +186,7 @@ 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.
* @access public * @access public
*/ */
@ -191,6 +200,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.
* @access public * @access public
*/ */
@ -200,6 +210,7 @@ class CakeHtmlReporter extends SimpleReporter {
/** /**
* Character set adjusted entity conversion. * Character set adjusted entity conversion.
*
* @param string $message Plain text or Unicode message. * @param string $message Plain text or Unicode message.
* @return string Browser readable message. * @return string Browser readable message.
* @access protected * @access protected