sminnee / silverstripe-framework

filesystem/GDBackend.php

Doc Comments +1 added lines, -4 removed lines

@@ -184,7 +184,6 @@ 
 	 * 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 $args,... Any number of args that identify this image
 	 * @return bool True if failed
 	 */
 	public function failedResample() {
@@ -195,7 +194,6 @@ 
 	/**
 	 * Mark a file as failed
 	 *
-	 * @param string $args,... Any number of args that identify this image
 	 */
 	protected function markFailed() {
 		$key = sha1(implode('|', func_get_args()));
@@ -205,7 +203,6 @@ 
 	/**
 	 * Mark a file as succeeded
 	 *
-	 * @param string $args,... Any number of args that identify this image
 	 */
 	protected function markSucceeded() {
 		$key = sha1(implode('|', func_get_args()));
@@ -347,7 +344,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) {

forms/CompositeField.php

Doc Comments +8 added lines

@@ -94,6 +94,7 @@ 
 
 	/**
 	 * @param string
+	 * @param string $tag
 	 */
 	public function setTag($tag) {
 		$this->tag = $tag;
@@ -110,6 +111,7 @@ 
 
 	/**
 	 * @param string
+	 * @param string $legend
 	 */
 	public function setLegend($legend) {
 		$this->legend = $legend;
@@ -200,6 +202,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function fieldByName($name) {
 		return $this->children->fieldByName($name);
 	}
@@ -224,6 +229,8 @@ 
 
 	/**
 	 * @uses FieldList->insertAfter()
+	 * @param string $insertAfter
+	 * @param FormField $field
 	 */
 	public function insertAfter($insertAfter, $field) {
 		$ret = $this->children->insertAfter($insertAfter, $field);
@@ -309,6 +316,7 @@ 
 	 * the children collection. Doesn't work recursively.
 	 *
 	 * @param string|FormField
+	 * @param string $field
 	 * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't
 	 *             be found.
 	 */

forms/ConfirmedPasswordField.php

Doc Comments +2 added lines, -2 removed lines

@@ -120,7 +120,7 @@ 
 	/**
 	 * @param array $properties
 	 *
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function Field($properties = array()) {
 		Requirements::javascript(FRAMEWORK_DIR . '/thirdparty/jquery/jquery.js');
@@ -417,7 +417,7 @@ 
 	 *
 	 * @param DataObjectInterface $record
 	 *
-	 * @return boolean
+	 * @return false|null
 	 */
 	public function saveInto(DataObjectInterface $record) {
 		if(!$this->isSaveable()) {

forms/DateField.php

Doc Comments +9 added lines, -1 removed lines

@@ -93,6 +93,11 @@ 
 	 */
 	protected $valueObj = null;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 * @param string $value
+	 */
 	public function __construct($name, $title = null, $value = null) {
 		if(!$this->locale) {
 			$this->locale = i18n::get_locale();
@@ -291,6 +296,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function castedCopy($class) {
 		$copy = new $class($this->name);
 		if($copy->hasMethod('setConfig')) {
@@ -329,7 +337,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/DatetimeField.php

Doc Comments +19 added lines, -4 removed lines

@@ -59,6 +59,10 @@ 
 	 */
 	protected $config;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		$this->config = $this->config()->default_config;
 
@@ -71,6 +75,9 @@ 
 		parent::__construct($name, $title, $value);
 	}
 
+	/**
+	 * @param Form $form
+	 */
 	public function setForm($form) {
 		parent::setForm($form);
 
@@ -81,6 +88,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setName($name) {
 		parent::setName($name);
 
@@ -93,7 +103,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function FieldHolder($properties = array()) {
 		$config = array(
@@ -108,7 +118,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		Requirements::css(FRAMEWORK_DIR . '/css/DatetimeField.css');
@@ -243,6 +253,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param DateField $field
 	 */
 	public function setDateField($field) {
 		$expected = $this->getName() . '[date]';
@@ -268,6 +279,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param TimeField $field
 	 */
 	public function setTimeField($field) {
 		$expected = $this->getName() . '[time]';
@@ -306,7 +318,7 @@ 
 	 * to set field-specific config options.
 	 *
 	 * @param string $name
-	 * @param mixed $val
+	 * @param string $val
 	 */
 	public function setConfig($name, $val) {
 		$this->config[$name] = $val;
@@ -324,7 +336,7 @@ 
 	 * to get field-specific config options.
 	 *
 	 * @param String $name Optional, returns the whole configuration array if empty
-	 * @return mixed
+	 * @return string
 	 */
 	public function getConfig($name = null) {
 		if($name) {
@@ -334,6 +346,9 @@ 
 		}
 	}
 
+	/**
+	 * @param RequiredFields $validator
+	 */
 	public function validate($validator) {
 		$dateValid = $this->dateField->validate($validator);
 		$timeValid = $this->timeField->validate($validator);

forms/FileField.php

Doc Comments +1 added lines, -2 removed lines

@@ -85,7 +85,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge($properties, array(
@@ -249,7 +249,6 @@ 
 	 * for each of these categories
 	 *
 	 * @param string $category Category name
-	 * @param string,... $categories Additional category names
 	 * @return $this
 	 */
 	public function setAllowedFileCategories($category) {

forms/FormAction.php

Doc Comments +3 added lines, -2 removed lines

@@ -76,7 +76,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge(
@@ -93,7 +93,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function FieldHolder($properties = array()) {
 		return $this->Field($properties);
@@ -157,6 +157,7 @@ 
 	 * Enable or disable the rendering of this action as a <button />
 	 *
 	 * @param boolean
+	 * @param boolean $bool
 	 * @return $this
 	 */
 	public function setUseButtonTag($bool) {

forms/FormScaffolder.php

Doc Comments -1 removed lines

@@ -49,7 +49,6 @@
 
 	/**
 	 * @param DataObject $obj
-	 * @param array $params
 	 */
 	public function __construct($obj) {
 		$this->obj = $obj;

forms/gridfield/GridFieldAddExistingAutocompleter.php

Doc Comments +1 added lines, -1 removed lines

@@ -129,7 +129,7 @@
 	/**
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getActions($gridField) {
 		return array('addto');