silverstripe / silverstripe-framework

admin/code/CMSMenuItem.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
 	/**
 	 * @param array
 	 *
-	 * @return HTML
+	 * @return string
 	 */
 	public function getAttributesHTML($attrs = null) {
 		$exclude = (is_string($attrs)) ? func_get_args() : null;

admin/code/GroupImportForm.php

Doc Comments +4 added lines

@@ -14,6 +14,10 @@
 	 */
 	protected $group;
 
+	/**
+	 * @param SecurityAdmin $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name, $fields = null, $actions = null, $validator = null) {
 		if(!$fields) {
 			$helpHtml = _t(

admin/code/MemberImportForm.php

Doc Comments +5 added lines, -1 removed lines

@@ -14,6 +14,10 @@ 
 	 */
 	protected $group;
 
+	/**
+	 * @param SecurityAdmin $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name, $fields = null, $actions = null, $validator = null) {
 		if(!$fields) {
 			$helpHtml = _t(
@@ -100,7 +104,7 @@ 
 	}
 
 	/**
-	 * @param $group Group
+	 * @param DataObject $group Group
 	 */
 	public function setGroup($group) {
 		$this->group = $group;

control/ContentNegotiator.php

Doc Comments +1 added lines

@@ -109,6 +109,7 @@
 	/**
 	 * Returns true if negotiation is enabled for the given response. By default, negotiation is only
 	 * enabled for pages that have the xml header.
+	 * @param SS_HTTPResponse $response
 	 */
 	public static function enabled_for($response) {
 		$contentType = $response->getHeader("Content-Type");

control/CookieJar.php

Doc Comments +2 added lines, -2 removed lines

@@ -144,13 +144,13 @@
 	 * @see http://uk3.php.net/manual/en/function.setcookie.php
 	 *
 	 * @param string $name The name of the cookie
-	 * @param string|array $value The value for the cookie to hold
+	 * @param false|string $value The value for the cookie to hold
 	 * @param int $expiry The number of days until expiry
 	 * @param string $path The path to save the cookie on (falls back to site base)
 	 * @param string $domain The domain to make the cookie available on
 	 * @param boolean $secure Can the cookie only be sent over SSL?
 	 * @param boolean $httpOnly Prevent the cookie being accessible by JS
-	 * @return boolean If the cookie was set or not; doesn't mean it's accepted by the browser
+	 * @return boolean|null If the cookie was set or not; doesn't mean it's accepted by the browser
 	 */
 	protected function outputCookie(
 		$name, $value, $expiry = 90, $path = null, $domain = null, $secure = false, $httpOnly = true

control/Director.php

Doc Comments +3 added lines, -3 removed lines

@@ -534,7 +534,7 @@ 
 	 * Returns the domain part of the URL 'http://www.mysite.com'. Returns FALSE is this environment
 	 * variable isn't set.
 	 *
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function protocolAndHost() {
 		$alternate = Config::inst()->get('Director', 'alternate_base_url');
@@ -869,7 +869,7 @@ 
 	/**
 	 * Returns true if the given file exists. Filename should be relative to the site root.
 	 *
-	 * @param $file
+	 * @param string $file
 	 *
 	 * @return bool
 	 */
@@ -1087,7 +1087,7 @@ 
 	 * Can also be checked with {@link Director::isDev()}, {@link Director::isTest()}, and
 	 * {@link Director::isLive()}.
 	 *
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function get_environment_type() {
 		if(Director::isLive()) {

control/HTTP.php

Doc Comments +1 added lines, -1 removed lines

@@ -104,7 +104,7 @@
 	 * @param string|callable $code Either a string that can evaluate to an expression to rewrite links
 	 * (depreciated), or a callable that takes a single parameter and returns the rewritten URL.
 	 *
-	 * @return The content with all links rewritten as per the logic specified in $code.
+	 * @return string content with all links rewritten as per the logic specified in $code.
 	 */
 	public static function urlRewriter($content, $code) {
 		if(!is_callable($code)) {

control/HTTPRequest.php

Doc Comments +4 added lines, -4 removed lines

@@ -186,7 +186,7 @@ 
 	}
 
 	/**
-	 * @return null|string
+	 * @return string
 	 */
 	public function getBody() {
 		return $this->body;
@@ -385,9 +385,9 @@ 
 	 * it's only advisable to send small files through this method.
 	 *
 	 * @static
-	 * @param $fileData
+	 * @param string $fileData
 	 * @param $fileName
-	 * @param null $mimeType
+	 * @param string $mimeType
 	 * @return SS_HTTPResponse
 	 */
 	public static function send_file($fileData, $fileName, $mimeType = null) {
@@ -605,7 +605,7 @@ 
 	 * This is used by the request handler to prevent infinite parsing loops.
 	 *
 	 * @param $pattern
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function isEmptyPattern($pattern) {
 		if(preg_match('/^([A-Za-z]+) +(.*)$/', $pattern, $matches)) {

control/HTTPResponse.php

Doc Comments +8 added lines, -7 removed lines

@@ -109,7 +109,7 @@ 
 	 *  No newlines are allowed in the description.
 	 *  If omitted, will default to the standard HTTP description
 	 *  for the given $code value (see {@link $status_codes}).
-	 * @return SS_HTTPRequest $this
+	 * @return SS_HTTPResponse $this
 	 */
 	public function setStatusCode($code, $description = null) {
 		if(isset(self::$status_codes[$code])) $this->statusCode = $code;
@@ -125,7 +125,7 @@ 
 	 * Caution: Will be overwritten by {@link setStatusCode()}.
 	 *
 	 * @param string $description
-	 * @return SS_HTTPRequest $this
+	 * @return SS_HTTPResponse $this
 	 */
 	public function setStatusDescription($description) {
 		$this->statusDescription = $description;
@@ -157,7 +157,7 @@ 
 
 	/**
 	 * @param string $body
-	 * @return SS_HTTPRequest $this
+	 * @return SS_HTTPResponse $this
 	 */
 	public function setBody($body) {
 		$this->body = $body ? (string) $body : $body; // Don't type-cast false-ish values, eg null is null not ''
@@ -165,7 +165,7 @@ 
 	}
 
 	/**
-	 * @return null|string
+	 * @return string
 	 */
 	public function getBody() {
 		return $this->body;
@@ -176,7 +176,7 @@ 
 	 *
 	 * @param string $header Example: "Content-Type"
 	 * @param string $value Example: "text/xml"
-	 * @return SS_HTTPRequest $this
+	 * @return SS_HTTPResponse $this
 	 */
 	public function addHeader($header, $value) {
 		$this->headers[$header] = $value;
@@ -206,7 +206,7 @@ 
 	 * e.g. "Content-Type".
 	 *
 	 * @param string $header
-	 * @return SS_HTTPRequest $this
+	 * @return SS_HTTPResponse $this
 	 */
 	public function removeHeader($header) {
 		if(isset($this->headers[$header])) unset($this->headers[$header]);
@@ -216,7 +216,7 @@ 
 	/**
 	 * @param string $dest
 	 * @param int $code
-	 * @return SS_HTTPRequest $this
+	 * @return SS_HTTPResponse $this
 	 */
 	public function redirect($dest, $code=302) {
 		if(!in_array($code, self::$redirect_codes)) $code = 302;
@@ -316,6 +316,7 @@ 
 	 * @param string|SS_HTTPResponse body Either the plaintext content of the error message, or an SS_HTTPResponse
 	 *                                     object representing it.  In either case, the $statusCode and
 	 *                                     $statusDescription will be the HTTP status of the resulting response.
+	 * @param string $statusDescription
 	 * @see SS_HTTPResponse::__construct();
 	 */
 	public function __construct($body = null, $statusCode = null, $statusDescription = null) {