silverstripe / silverstripe-framework

filesystem/File.php

Doc Comments +2 added lines, -2 removed lines

@@ -234,7 +234,7 @@ 
 	 * Find a File object by the given filename.
 	 *
 	 * @param String $filename Matched against the "Name" property.
-	 * @return mixed null if not found, File object of found file
+	 * @return null|DataObject null if not found, File object of found file
 	 */
 	public static function find($filename) {
 		// Get the base file if $filename points to a resampled file
@@ -449,6 +449,7 @@ 
 	 * showing icons on filelinks, etc.
 	 * Possible group values are: "audio", "mov", "zip", "image".
 	 *
+	 * @param string $ext
 	 * @return String
 	 */
 	public static function get_app_category($ext) {
@@ -872,7 +873,6 @@ 
 	/**
 	 * Convert a php.ini value (eg: 512M) to bytes
 	 *
-	 * @param string $phpIniValue
 	 * @return int
 	 */
 	public static function ini2bytes($PHPiniValue) {

filesystem/GD.php

Doc Comments +8 added lines

@@ -150,6 +150,7 @@ 
 	 * successfully, the manipulation's cache key is removed.
 	 *
 	 * @param string $filename
+	 * @param string $manipulation
 	 * @return boolean
 	 */
 	public function failedResample($filename, $manipulation) {
@@ -417,6 +418,10 @@ 
 			return $useAsMinimum ? $this->resizeByWidth( $maxWidth ) : $this->resizeByHeight( $maxHeight );
 	}
 
+	/**
+	 * @param resource $image
+	 * @param string $webColor
+	 */
 	public static function color_web2gd($image, $webColor) {
 		if(substr($webColor,0,1) == "#") $webColor = substr($webColor,1);
 		$r = hexdec(substr($webColor,0,2));
@@ -521,6 +526,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $dirname
+	 */
 	public function makeDir($dirname) {
 		if(!file_exists(dirname($dirname))) $this->makeDir(dirname($dirname));
 		if(!file_exists($dirname)) mkdir($dirname, Config::inst()->get('Filesystem', 'folder_create_mask'));

filesystem/ImagickBackend.php

Doc Comments +9 added lines, -9 removed lines

@@ -80,7 +80,7 @@ 
 	 *
 	 * Get the backend-specific resource handling the manipulations. Replaces Image::getGD()
 	 *
-	 * @return mixed
+	 * @return ImagickBackend
 	 */
 	public function getImageResource() {
 		return $this;
@@ -111,7 +111,7 @@ 
 	 *
 	 * @param int $width
 	 * @param int $height
-	 * @return Image_Backend
+	 * @return null|ImagickBackend
 	 */
 	public function resize($width, $height) {
 		if(!$this->valid()) return;
@@ -141,9 +141,9 @@ 
 	/**
 	 * resizeRatio
 	 *
-	 * @param int $width
-	 * @param int $height
-	 * @return Image_Backend
+	 * @param integer $maxWidth
+	 * @param integer $maxHeight
+	 * @return null|ImagickBackend
 	 */
 	public function resizeRatio($maxWidth, $maxHeight, $useAsMinimum = false) {
 		if(!$this->valid()) return;
@@ -163,7 +163,7 @@ 
 	 * resizeByWidth
 	 *
 	 * @param int $width
-	 * @return Image_Backend
+	 * @return null|ImagickBackend
 	 */
 	public function resizeByWidth($width) {
 		if(!$this->valid()) return;
@@ -178,7 +178,7 @@ 
 	 * resizeByHeight
 	 *
 	 * @param int $height
-	 * @return Image_Backend
+	 * @return null|ImagickBackend
 	 */
 	public function resizeByHeight($height) {
 		if(!$this->valid()) return;
@@ -194,7 +194,7 @@ 
 	 *
 	 * @param int $width
 	 * @param int $height
-	 * @return Image_Backend
+	 * @return null|ImagickBackend
 	 */
 	public function paddedResize($width, $height, $backgroundColor = "FFFFFF") {
 		$new = $this->resizeRatio($width, $height);
@@ -211,7 +211,7 @@ 
 	 *
 	 * @param int $width
 	 * @param int $height
-	 * @return Image_Backend
+	 * @return null|ImagickBackend
 	 */
 	public function croppedResize($width, $height) {
 		if(!$this->valid()) return;

filesystem/Upload.php

Doc Comments +5 added lines, -4 removed lines

@@ -102,7 +102,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;
@@ -115,7 +115,7 @@ 
 	 *
 	 * @param $tmpFile array Indexed array that PHP generated for every file it uploads.
 	 * @param $folderPath string Folder path relative to /assets
-	 * @return Boolean|string Either success or error-message.
+	 * @return boolean Either success or error-message.
 	 */
 	public function load($tmpFile, $folderPath = false) {
 		$this->clearErrors();
@@ -231,7 +231,8 @@ 
 	}
 
 	/**
-	 * @return Boolean
+	 * @param boolean $bool
+	 * @return boolean|null
 	 */
 	public function setReplaceFile($bool) {
 		$this->replaceFile = $bool;
@@ -295,7 +296,7 @@ 
 	/**
 	 * Determines wether previous operations caused an error.
 	 *
-	 * @return boolean
+	 * @return integer
 	 */
 	public function isError() {
 		return (count($this->errors));

forms/DateField.php

Doc Comments +8 added lines, -1 removed lines

@@ -90,6 +90,10 @@ 
 	 */
 	protected $valueObj = null;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = null) {
 		if(!$this->locale) {
 			$this->locale = i18n::get_locale();
@@ -288,6 +292,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function castedCopy($class) {
 		$copy = new $class($this->name);
 		if($copy->hasMethod('setConfig')) {
@@ -326,7 +333,7 @@ 
 	 * @deprecated 4.0 Use the "DateField.default_config" config setting instead
 	 * @param String $k
 	 * @param mixed $v
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public static function set_default_config($k, $v) {
 		Deprecation::notice('4.0', 'Use the "DateField.default_config" config setting instead');

forms/FileField.php

Doc Comments +1 added lines, -3 removed lines

@@ -85,7 +85,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge($properties, array(
@@ -148,7 +148,6 @@ 
 	/**
 	 * Get custom validator for this field
 	 *
-	 * @param Upload_Validator $validator
 	 */
 	public function getValidator() {
 		return $this->upload->getValidator();
@@ -244,7 +243,6 @@ 
 	 * for each of these categories
 	 *
 	 * @param string $category Category name
-	 * @param string,... $categories Additional category names
 	 * @return $this
 	 */
 	public function setAllowedFileCategories($category) {

forms/Form.php

Doc Comments +10 added lines, -5 removed lines

@@ -532,7 +532,7 @@ 
 	/**
 	 * Fields can have action to, let's check if anyone of the responds to $funcname them
 	 *
-	 * @param SS_List|array $fields
+	 * @param FieldList|null $fields
 	 * @param callable $funcName
 	 * @return FormField
 	 */
@@ -791,6 +791,7 @@ 
 	}
 
 	/**
+	 * @param string $name
 	 * @return string $name
 	 */
 	public function getAttribute($name) {
@@ -825,6 +826,7 @@ 
 	 *
 	 * @param array Custom attributes to process. Falls back to {@link getAttributes()}.
 	 * If at least one argument is passed as a string, all arguments act as excludes by name.
+	 * @param string $attrs
 	 *
 	 * @return string HTML attributes, ready for insertion into an HTML tag
 	 */
@@ -1032,7 +1034,7 @@ 
 	 * If set to false (the default), then the form method is only used to construct the default
 	 * form.
 	 *
-	 * @param $bool boolean
+	 * @param boolean $bool boolean
 	 * @return $this
 	 */
 	public function setStrictFormMethodCheck($bool) {
@@ -1529,7 +1531,7 @@ 
 	 * This is returned when you access a form as $FormObject rather
 	 * than <% with FormObject %>
 	 *
-	 * @return HTML
+	 * @return HTMLText
 	 */
 	public function forTemplate() {
 		$return = $this->renderWith(array_merge(
@@ -1549,7 +1551,7 @@ 
 	 * It triggers slightly different behaviour, such as disabling the rewriting
 	 * of # links.
 	 *
-	 * @return HTML
+	 * @return HTMLText
 	 */
 	public function forAjaxTemplate() {
 		$view = new SSViewer(array(
@@ -1572,7 +1574,7 @@ 
 	 * and _form_enctype.  These are the attributes of the form.  These fields
 	 * can be used to send the form to Ajax.
 	 *
-	 * @return HTML
+	 * @return string
 	 */
 	public function formHtmlContent() {
 		$this->IncludeFormTag = false;
@@ -1830,6 +1832,9 @@ 
 
 	protected $form;
 
+	/**
+	 * @param Form $form
+	 */
 	public function __construct($form) {
 		$this->form = $form;
 		parent::__construct();

forms/FormField.php

Doc Comments +2 added lines, -2 removed lines

@@ -532,6 +532,7 @@ 
 	 *
 	 * Caution: this doesn't work on all fields, see {@link setAttribute()}.
 	 *
+	 * @param string $name
 	 * @return null|string
 	 */
 	public function getAttribute($name) {
@@ -643,7 +644,6 @@ 
 	 * Set the field value.
 	 *
 	 * @param mixed $value
-	 * @param null|array|DataObject $data {@see Form::loadDataFrom}
 	 *
 	 * @return $this
 	 */
@@ -1185,7 +1185,7 @@ 
 	 *
 	 * @param FieldList $containerFieldList
 	 *
-	 * @return FieldList
+	 * @return FormField
 	 */
 	public function setContainerFieldList($containerFieldList) {
 		$this->containerFieldList = $containerFieldList;

forms/gridfield/GridFieldDetailForm.php

Doc Comments +7 added lines

@@ -164,6 +164,7 @@ 
 
 	/**
 	 * @param String
+	 * @param string $class
 	 */
 	public function setItemRequestClass($class) {
 		$this->itemRequestClass = $class;
@@ -271,6 +272,9 @@ 
 		parent::__construct();
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		return Controller::join_links($this->gridField->Link('item'),
 			$this->record->ID ? $this->record->ID : 'new', $action);
@@ -299,6 +303,9 @@ 
 		}
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	public function edit($request) {
 		$controller = $this->getToplevelController();
 		$form = $this->ItemEditForm($this->gridField, $request);