Fix api doc comment errors in Error/

This commit is contained in:
mark_story 2014-05-31 21:57:17 -04:00
parent fe2003888b
commit 86a071353d
3 changed files with 21 additions and 14 deletions

View file

@ -102,7 +102,7 @@ class ErrorHandler {
* This will either use custom exception renderer class if configured,
* or use the default ExceptionRenderer.
*
* @param Exception $exception
* @param Exception $exception The exception to render.
* @return void
* @see http://php.net/manual/en/function.set-exception-handler.php
*/
@ -132,6 +132,7 @@ class ErrorHandler {
/**
* Generates a formatted error message
*
* @param Exception $exception Exception instance
* @return string Formatted message
*/
@ -159,8 +160,8 @@ class ErrorHandler {
/**
* Handles exception logging
*
* @param Exception $exception
* @param array $config
* @param Exception $exception The exception to render.
* @param array $config An array of configuration for logging.
* @return boolean
*/
protected static function _log(Exception $exception, $config) {

View file

@ -180,7 +180,7 @@ class ExceptionRenderer {
/**
* Generic handler for the internal framework errors CakePHP can generate.
*
* @param CakeException $error
* @param CakeException $error The exception to render.
* @return void
*/
protected function _cakeError(CakeException $error) {
@ -202,7 +202,7 @@ class ExceptionRenderer {
/**
* Convenience method to display a 400 series page.
*
* @param Exception $error
* @param Exception $error The exception to render.
* @return void
*/
public function error400($error) {
@ -225,7 +225,7 @@ class ExceptionRenderer {
/**
* Convenience method to display a 500 page.
*
* @param Exception $error
* @param Exception $error The exception to render.
* @return void
*/
public function error500($error) {
@ -249,7 +249,7 @@ class ExceptionRenderer {
/**
* Convenience method to display a PDOException.
*
* @param PDOException $error
* @param PDOException $error The exception to render.
* @return void
*/
public function pdoError(PDOException $error) {

View file

@ -34,9 +34,9 @@ class CakeBaseException extends RuntimeException {
/**
* Get/set the response header to be used
*
* @param string|array $header. An array of header strings or a single header string
* - an associative array of "header name" => "header value"
* - an array of string headers is also accepted
* @param string|array $header An array of header strings or a single header string
* - an associative array of "header name" => "header value"
* - an array of string headers is also accepted
* @param string $value The header value.
* @return array
* @see CakeResponse::header()
@ -378,6 +378,12 @@ class MissingConnectionException extends CakeException {
protected $_messageTemplate = 'Database connection "%s" is missing, or could not be created.';
/**
* Constructor
*
* @param string|array $message The error message.
* @param int $code The error code.
*/
public function __construct($message, $code = 500) {
if (is_array($message)) {
$message += array('enabled' => true);
@ -587,10 +593,10 @@ class FatalErrorException extends CakeException {
/**
* Constructor
*
* @param string $message
* @param integer $code
* @param string $file
* @param integer $line
* @param string $message The error message.
* @param integer $code The error code.
* @param string $file The file the error occurred in.
* @param integer $line The line the error occurred on.
*/
public function __construct($message, $code = 500, $file = null, $line = null) {
parent::__construct($message, $code);