silverstripe / silverstripe-framework

forms/CheckboxSetField.php

Doc Comments +1 added lines, -1 removed lines

@@ -169,7 +169,7 @@
 	 * Note: Items marked as disabled through {@link setDisabledItems()} can still be
 	 * selected by default through this method.
 	 *
-	 * @param Array $items Collection of array keys, as defined in the $source array
+	 * @param integer[] $items Collection of array keys, as defined in the $source array
 	 */
 	public function setDefaultItems($items) {
 		$this->defaultItems = $items;

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

Doc Comments +18 added lines, -3 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);
 
@@ -90,7 +100,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function FieldHolder($properties = array()) {
 		$config = array(
@@ -240,6 +250,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param DateField $field
 	 */
 	public function setDateField($field) {
 		$expected = $this->getName() . '[date]';
@@ -265,6 +276,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param TimeField $field
 	 */
 	public function setTimeField($field) {
 		$expected = $this->getName() . '[time]';
@@ -303,7 +315,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;
@@ -321,7 +333,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) {
@@ -331,6 +343,9 @@ 
 		}
 	}
 
+	/**
+	 * @param RequiredFields $validator
+	 */
 	public function validate($validator) {
 		$dateValid = $this->dateField->validate($validator);
 		$timeValid = $this->timeField->validate($validator);

forms/DropdownField.php

Doc Comments +1 added lines, -1 removed lines

@@ -130,7 +130,7 @@
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function Field($properties = array()) {
 		$source = $this->getSource();

forms/FieldList.php

Doc Comments +10 added lines, -2 removed lines

@@ -118,6 +118,7 @@ 
 	 *                        or TabSet.Tab.Subtab.
 	 * This function will create any missing tabs.
 	 * @param array $fields An array of {@link FormField} objects.
+	 * @param string $insertBefore
 	 */
 	public function addFieldsToTab($tabName, $fields, $insertBefore = null) {
 		$this->flushFieldsCache();
@@ -157,7 +158,7 @@ 
 	 * Removes a number of fields from a Tab/TabSet within this FieldList.
 	 *
 	 * @param string $tabName The name of the Tab or TabSet field
-	 * @param array $fields A list of fields, e.g. array('Name', 'Email')
+	 * @param string[] $fields A list of fields, e.g. array('Name', 'Email')
 	 */
 	public function removeFieldsFromTab($tabName, $fields) {
 		$this->flushFieldsCache();
@@ -426,6 +427,7 @@ 
 
 	/**
 	 * Handler method called before the FieldList is going to be manipulated.
+	 * @param FormField $item
 	 */
 	protected function onBeforeInsert($item) {
 		$this->flushFieldsCache();
@@ -498,6 +500,7 @@ 
 	 * Transform this FieldList with a given tranform method,
 	 * e.g. $this->transform(new ReadonlyTransformation())
 	 *
+	 * @param ReadonlyTransformation $trans
 	 * @return FieldList
 	 */
 	public function transform($trans) {
@@ -517,6 +520,9 @@ 
 		else return $this;
 	}
 
+	/**
+	 * @param CompositeField $field
+	 */
 	public function setContainerField($field) {
 		$this->containerField = $field;
 		return $this;
@@ -535,6 +541,7 @@ 
 	 * Transform the named field into a readonly feld.
 	 *
 	 * @param string|FormField
+	 * @param string $field
 	 */
 	public function makeFieldReadonly($field) {
 		$fieldName = ($field instanceof FormField) ? $field->getName() : $field;
@@ -584,6 +591,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.
 	 */
@@ -631,7 +639,7 @@ 
 	 * Support function for backwards compatibility purposes.
 	 * Caution: Volatile API, might be removed in 3.1 or later.
 	 *
-	 * @param  String $tabname Path to a tab, e.g. "Root.Content.Main"
+	 * @param  String $name Path to a tab, e.g. "Root.Content.Main"
 	 * @return String Rewritten path, based on {@link tabPathRewrites}
 	 */
 	protected function rewriteTabPath($name) {

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');