silverstripe / silverstripe-framework

filesystem/GD.php

Doc Comments +7 added lines

@@ -342,6 +342,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));
@@ -446,6 +450,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'));

forms/CompositeField.php

Doc Comments +8 added lines, -2 removed lines

@@ -93,7 +93,8 @@ 
 	}
 
 	/** 
-	 * @param string 
+	 * @param string
+	 * @param string $tag 
 	 */
 	public function setTag($tag) {
 		$this->tag = $tag;
@@ -109,7 +110,8 @@ 
 	}
 
 	/** 
-	 * @param string 
+	 * @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);
 	}
@@ -306,6 +311,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 +1 added lines, -1 removed lines

@@ -409,7 +409,7 @@
 	 *
 	 * @param DataObjectInterface $record
 	 *
-	 * @return boolean
+	 * @return false|null
 	 */
 	public function saveInto(DataObjectInterface $record) {
 		if(!$this->isSaveable()) {

forms/DatetimeField.php

Doc Comments +17 added lines, -2 removed lines

@@ -56,6 +56,10 @@ 
 	 */
 	protected $config;
 		
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		$this->config = $this->config()->default_config;
 		
@@ -68,6 +72,9 @@ 
 		parent::__construct($name, $title, $value);
 	}
 		
+	/**
+	 * @param Form $form
+	 */
 	public function setForm($form) {
 		parent::setForm($form);
 		
@@ -78,6 +85,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setName($name) {
 		parent::setName($name);
 
@@ -229,6 +239,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param DateField $field
 	 */
 	public function setDateField($field) {
 		$expected = $this->getName() . '[date]';
@@ -254,6 +265,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param TimeField $field
 	 */
 	public function setTimeField($field) {
 		$expected = $this->getName() . '[time]';
@@ -292,7 +304,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;
@@ -310,7 +322,7 @@ 
 	 * to get field-specific config options.
 	 * 
 	 * @param String $name Optional, returns the whole configuration array if empty
-	 * @return mixed
+	 * @return string|null
 	 */
 	public function getConfig($name = null) {
 		if($name) {
@@ -320,6 +332,9 @@ 
 		}
 	}
 	
+	/**
+	 * @param RequiredFields $validator
+	 */
 	public function validate($validator) {
 		$dateValid = $this->dateField->validate($validator);
 		$timeValid = $this->timeField->validate($validator);

forms/FileField.php

Doc Comments -1 removed lines

@@ -132,7 +132,6 @@
 	/**
 	 * Get custom validator for this field
 	 * 
-	 * @param Upload_Validator $validator
 	 */
 	public function getValidator() {
 		return $this->upload->getValidator();

forms/Form.php

Doc Comments +7 added lines, -2 removed lines

@@ -496,7 +496,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
 	 */
@@ -755,6 +755,7 @@ 
 	}
 
 	/**
+	 * @param string $name
 	 * @return string $name
 	 */
 	public function getAttribute($name) {
@@ -788,6 +789,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
 	 */
@@ -963,7 +965,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) {
@@ -1707,6 +1709,9 @@ 
 class Form_FieldMap extends ViewableData {
 	protected $form;
 
+	/**
+	 * @param Form $form
+	 */
 	public function __construct($form) {
 		$this->form = $form;
 		parent::__construct();

forms/FormAction.php

Doc Comments +1 added lines

@@ -89,6 +89,7 @@
 	 * Determines if the field should render open or closed by default.
 	 * 
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function startClosed($bool) {
 		($bool) ? $this->addExtraClass('startClosed') : $this->removeExtraClass('startClosed');

forms/gridfield/GridFieldConfig.php

Doc Comments +2 added lines, -1 removed lines

@@ -27,7 +27,6 @@ 
 	protected $components = null;
 	
 	/**
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return GridFieldConfig
 	 */
 	public static function create() {
@@ -87,6 +86,7 @@ 
 	
 	/**
 	 * @param String Class name or interface
+	 * @param string $type
 	 * @return GridFieldConfig $this
 	 */
 	public function removeComponentsByType($type) {
@@ -125,6 +125,7 @@ 
 	 * Returns the first available component with the given class or interface.
 	 * 
 	 * @param String ClassName
+	 * @param string $type
 	 * @return GridFieldComponent
 	 */
 	public function getComponentByType($type) {

forms/gridfield/GridFieldDeleteAction.php

Doc Comments +2 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
 	 * Which columns are handled by this component
 	 * 
 	 * @param type $gridField
-	 * @return type 
+	 * @return string[] 
 	 */
 	public function getColumnsHandled($gridField) {
 		return array('Actions');
@@ -90,7 +90,7 @@ 
 	 * Which GridField actions are this component handling
 	 *
 	 * @param GridField $gridField
-	 * @return array 
+	 * @return string[] 
 	 */
 	public function getActions($gridField) {
 		return array('deleterecord', 'unlinkrelation');