silverstripe / silverstripe-framework

Assets/File.php

Doc Comments +5 added lines, -5 removed lines

@@ -412,7 +412,7 @@ 
 	 * Check if this file can be modified
 	 *
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canEdit($member = null) {
 		if(!$member) {
@@ -432,7 +432,7 @@ 
 	 *
 	 * @param Member $member
 	 * @param array $context
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canCreate($member = null, $context = array()) {
 		if(!$member) {
@@ -451,7 +451,7 @@ 
 	 * Check if this file can be deleted
 	 *
 	 * @param Member $member
-	 * @return boolean
+	 * @return boolean|string
 	 */
 	public function canDelete($member = null) {
 		if(!$member) {
@@ -647,7 +647,7 @@ 
 	 *
 	 * @param string $condition The PHP condition to be evaluated.  The page will be called $item
 	 * @param array $collator An array, passed by reference, to collect all of the matching descendants.
-	 * @return true|null
+	 * @return boolean|null
 	 */
 	public function collateDescendants($condition, &$collator) {
 		if($children = $this->Children()) {
@@ -1020,6 +1020,7 @@ 
 	 *
 	 * @param String File extension, without dot prefix. Use an asterisk ('*')
 	 * to specify a generic fallback if no mapping is found for an extension.
+	 * @param string $ext
 	 * @return String Classname for a subclass of {@link File}
 	 */
 	public static function get_class_for_file_extension($ext) {
@@ -1163,7 +1164,6 @@ 
 	 * Note that the result will not have a leading slash, and should not be used
 	 * with local file paths.
 	 *
-	 * @param string $part,... Parts
 	 * @return string
 	 */
 	public static function join_paths($part = null) {

Assets/Flysystem/AssetAdapter.php

Doc Comments +3 added lines

@@ -40,6 +40,9 @@
         ]
 	);
 
+	/**
+	 * @param string $root
+	 */
 	public function __construct($root = null, $writeFlags = LOCK_EX, $linkHandling = self::DISALLOW_LINKS) {
 		// Get root path
 		$root = $this->findRoot($root);

Assets/GDBackend.php

Doc Comments +3 added lines, -4 removed lines

@@ -191,7 +191,7 @@ 
 	 * Check if this image has previously crashed GD when attempting to open it - if it's opened
 	 * successfully, the manipulation's cache key is removed.
 	 *
-	 * @param string $arg,... Any number of args that identify this image
+	 * @param string $arg
 	 * @return bool True if failed
 	 */
 	public function failedResample($arg = null) {
@@ -202,7 +202,7 @@ 
 	/**
 	 * Mark a file as failed
 	 *
-	 * @param string $arg,... Any number of args that identify this image
+	 * @param string $arg
 	 */
 	protected function markFailed($arg = null) {
 		$key = sha1(implode('|', func_get_args()));
@@ -212,7 +212,6 @@ 
 	/**
 	 * Mark a file as succeeded
 	 *
-	 * @param string $arg,... Any number of args that identify this image
 	 */
 	protected function markSucceeded($arg = null) {
 		$key = sha1(implode('|', func_get_args()));
@@ -363,7 +362,7 @@ 
 	 * using built-in function. Used when imagerotate function is not available(i.e. Ubuntu)
 	 *
 	 * @param float $angle Angle in degrees
-	 * @return static
+	 * @return null|resource
 	 */
 	public function rotatePixelByPixel($angle) {
 		if(!$this->gd) {

Assets/ImageManipulation.php

Doc Comments -1 removed lines

@@ -762,7 +762,6 @@
 	 * Name a variant based on a format with arbitrary parameters
 	 *
 	 * @param string $format The format name.
-	 * @param mixed $arg,... Additional arguments
 	 * @return string
 	 * @throws InvalidArgumentException
 	 */

Assets/Upload.php

Doc Comments +2 added lines, -2 removed lines

@@ -114,7 +114,7 @@ 
 	 * Set a different instance than {@link Upload_Validator}
 	 * for this upload session.
 	 *
-	 * @param object $validator
+	 * @param Upload_Validator $validator
 	 */
 	public function setValidator($validator) {
 		$this->validator = $validator;
@@ -363,7 +363,7 @@ 
 	/**
 	 * Determines wether previous operations caused an error.
 	 *
-	 * @return boolean
+	 * @return integer
 	 */
 	public function isError() {
 		return (count($this->errors));

Control/CookieJar.php

Doc Comments +1 added lines, -1 removed lines

@@ -147,7 +147,7 @@
 	 * @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

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/Email/Email.php

Doc Comments +1 added lines, -1 removed lines

@@ -390,7 +390,7 @@
 	}
 
 	/**
-	 * @return Email|ViewableData_Customised
+	 * @return ViewableData
 	 */
 	protected function templateData() {
 		if($this->template_data) {

Control/Email/Mailer.php

Doc Comments +1 added lines, -1 removed lines

@@ -321,7 +321,7 @@
 	/**
 	 * Encode an array of parts using multipart
 	 *
-	 * @param array $parts List of parts
+	 * @param string[] $parts List of parts
 	 * @param string $contentType Content-type of parts
 	 * @param array $headers Existing headers to include in response
 	 * @return array Array with two items, the body followed by headers