Skip to content
This repository
Browse code

Minor doc block improvements

http://ch1.php.net/manual/de/exception.construct.php
Second parameter gets only passed by. Exception constructor uses an int for the second parameter,not a string.

Replaced text by docblock @see
http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/see.html
  • Loading branch information...
commit 85a75906d4d809150ca79d9f01ae4841ed8538bf 1 parent e876906
Marc Würth authored July 06, 2013

Showing 1 changed file with 8 additions and 9 deletions. Show diff stats Hide diff stats

  1. 17  lib/Cake/Error/exceptions.php
17  lib/Cake/Error/exceptions.php
@@ -36,13 +36,12 @@ class CakeBaseException extends RuntimeException {
36 36
 /**
37 37
  * Get/set the response header to be used
38 38
  *
39  
- * See also CakeResponse::header()
40  
- *
41 39
  * @param string|array $header. An array of header strings or a single header string
42 40
  *	- an associative array of "header name" => "header value"
43 41
  *	- an array of string headers is also accepted
44 42
  * @param string $value. The header value.
45 43
  * @return array
  44
+ * @see CakeResponse::header() See also
46 45
  */
47 46
 	public function responseHeader($header = null, $value = null) {
48 47
 		if ($header) {
@@ -79,7 +78,7 @@ class BadRequestException extends HttpException {
79 78
  * Constructor
80 79
  *
81 80
  * @param string $message If no message is given 'Bad Request' will be the message
82  
- * @param string $code Status code, defaults to 400
  81
+ * @param int $code Status code, defaults to 400
83 82
  */
84 83
 	public function __construct($message = null, $code = 400) {
85 84
 		if (empty($message)) {
@@ -101,7 +100,7 @@ class UnauthorizedException extends HttpException {
101 100
  * Constructor
102 101
  *
103 102
  * @param string $message If no message is given 'Unauthorized' will be the message
104  
- * @param string $code Status code, defaults to 401
  103
+ * @param int $code Status code, defaults to 401
105 104
  */
106 105
 	public function __construct($message = null, $code = 401) {
107 106
 		if (empty($message)) {
@@ -123,7 +122,7 @@ class ForbiddenException extends HttpException {
123 122
  * Constructor
124 123
  *
125 124
  * @param string $message If no message is given 'Forbidden' will be the message
126  
- * @param string $code Status code, defaults to 403
  125
+ * @param int $code Status code, defaults to 403
127 126
  */
128 127
 	public function __construct($message = null, $code = 403) {
129 128
 		if (empty($message)) {
@@ -145,7 +144,7 @@ class NotFoundException extends HttpException {
145 144
  * Constructor
146 145
  *
147 146
  * @param string $message If no message is given 'Not Found' will be the message
148  
- * @param string $code Status code, defaults to 404
  147
+ * @param int $code Status code, defaults to 404
149 148
  */
150 149
 	public function __construct($message = null, $code = 404) {
151 150
 		if (empty($message)) {
@@ -167,7 +166,7 @@ class MethodNotAllowedException extends HttpException {
167 166
  * Constructor
168 167
  *
169 168
  * @param string $message If no message is given 'Method Not Allowed' will be the message
170  
- * @param string $code Status code, defaults to 405
  169
+ * @param int $code Status code, defaults to 405
171 170
  */
172 171
 	public function __construct($message = null, $code = 405) {
173 172
 		if (empty($message)) {
@@ -189,7 +188,7 @@ class InternalErrorException extends HttpException {
189 188
  * Constructor
190 189
  *
191 190
  * @param string $message If no message is given 'Internal Server Error' will be the message
192  
- * @param string $code Status code, defaults to 500
  191
+ * @param int $code Status code, defaults to 500
193 192
  */
194 193
 	public function __construct($message = null, $code = 500) {
195 194
 		if (empty($message)) {
@@ -231,7 +230,7 @@ class CakeException extends CakeBaseException {
231 230
  *
232 231
  * @param string|array $message Either the string of the error message, or an array of attributes
233 232
  *   that are made available in the view, and sprintf()'d into CakeException::$_messageTemplate
234  
- * @param string $code The code of the error, is also the HTTP status code for the error.
  233
+ * @param int $code The code of the error, is also the HTTP status code for the error.
235 234
  */
236 235
 	public function __construct($message, $code = 500) {
237 236
 		if (is_array($message)) {

0 notes on commit 85a7590

Please sign in to comment.
Something went wrong with that request. Please try again.