Updating doc blocks.

cakephp · Jan 6, 2010 · f228990 · f228990
1 parent faafe5a
commit f228990
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/cake/tests/lib/reporter/cake_base_reporter.php b/cake/tests/lib/reporter/cake_base_reporter.php
@@ -83,6 +83,7 @@ function paintGroupEnd($test_name) {
  * 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
@@ -87,6 +87,7 @@ function CakeHtmlReporter($character_set = 'ISO-8859-1') {
  * 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 @@ function paintHeader($testName) {
  * 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 @@ function sendNoCacheHeaders() {
  * the passes and failures.
  *
  * @param string $test_name Name class of test.
+ * @return void
  * @access public
  */
 	function paintFooter($test_name) {
@@ -147,6 +149,7 @@ function paintFooter($test_name) {
  *
  * @param string $message Failure message displayed in
  *   the context of the other tests.
+ * @return void
  * @access public
  */
 	function paintFail($message) {
@@ -166,6 +169,7 @@ function paintFail($message) {
  * 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 @@ function paintPass($message) {
  * Paints a PHP error.
  *
  * @param string $message Message is ignored.
+ * @return void
  * @access public
  */
 	function paintError($message) {
@@ -203,6 +208,7 @@ function paintError($message) {
  * Paints a PHP exception.
  *
  * @param Exception $exception Exception to display.
+ * @return void
  * @access public
  */
 	function paintException($exception) {
@@ -223,7 +229,8 @@ function paintException($exception) {
 /**
  * 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 @@ function paintSkip($message) {
  * 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
@@ -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 @@ function paintFooter($test_name) {
  * Paints the title only.
  *
  * @param string $test_name Name class of test.
+ * @return void
  * @access public
  */
 	function paintHeader($test_name) {
@@ -69,6 +71,7 @@ function paintHeader($test_name) {
  *
  * @param string $message Failure message displayed in
  *    the context of the other tests.
+ * @return void
  * @access public
  */
 	function paintFail($message) {
@@ -84,6 +87,7 @@ function paintFail($message) {
  * Paints a PHP error.
  *
  * @param string $message Message to be shown.
+ * @return void
  * @access public
  */
 	function paintError($message) {
@@ -99,6 +103,7 @@ function paintError($message) {
  * Paints a PHP exception.
  *
  * @param Exception $exception Exception to describe.
+ * @return void
  * @access public
  */
 	function paintException($exception) {
@@ -118,6 +123,7 @@ function paintException($exception) {
  * Prints the message for skipping tests.
  *
  * @param string $message Text of skip condition.
+ * @return void
  * @access public
  */
 	function paintSkip($message) {
@@ -129,6 +135,7 @@ function paintSkip($message) {
  * Paints formatted text such as dumped variables.
  *
  * @param string $message Text to show.
+ * @return void
  * @access public
  */
 	function paintFormattedMessage($message) {