silverstripe / silverstripe-framework

src/Forms/FieldList.php

Doc Comments +6 added lines, -2 removed lines

@@ -79,6 +79,9 @@ 
 		$this->sequentialSaveableSet = null;
 	}
 
+	/**
+	 * @param FormField[] $list
+	 */
 	protected function collateDataFields(&$list, $saveableOnly = false) {
 		foreach($this as $field) {
 			if($field instanceof CompositeField) {
@@ -175,7 +178,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();
@@ -568,7 +571,7 @@ 
 	}
 
 	/**
-	 * @param $field
+	 * @param CompositeField $field
 	 * @return $this
 	 */
 	public function setContainerField($field) {
@@ -638,6 +641,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.
 	 */

src/Forms/FileField.php

Doc Comments +1 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return string
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge($properties, array(
@@ -259,7 +259,6 @@ 
 	 * for each of these categories
 	 *
 	 * @param string $category Category name
-	 * @param string,... $categories Additional category names
 	 * @return $this
 	 */
 	public function setAllowedFileCategories($category) {

src/Forms/Form.php

Doc Comments +4 added lines, -3 removed lines

@@ -533,7 +533,7 @@ 
 	 * The callback can opt out of handling specific responses by returning NULL,
 	 * in which case the default form behaviour will kick in.
 	 *
-	 * @param $callback
+	 * @param \Closure $callback
 	 * @return self
 	 */
 	public function setValidationResponseCallback($callback) {
@@ -593,7 +593,7 @@ 
 	/**
 	 * Fields can have action to, let's check if anyone of the responds to $funcname them
 	 *
-	 * @param SS_List|array $fields
+	 * @param FieldList $fields
 	 * @param callable $funcName
 	 * @return FormField
 	 */
@@ -734,6 +734,7 @@ 
 	 * Set actions that are exempt from validation
 	 *
 	 * @param array
+	 * @param string[] $actions
 	 * @return $this
 	 */
 	public function setValidationExemptActions($actions) {
@@ -1131,7 +1132,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) {

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

src/Forms/FormField.php

Doc Comments +2 added lines, -3 removed lines

@@ -769,7 +769,6 @@ 
 	 * Set the field value.
 	 *
 	 * @param mixed $value
-	 * @param null|array|DataObject $data {@see Form::loadDataFrom}
 	 * @return $this
 	 */
 	public function setValue($value) {
@@ -1188,7 +1187,7 @@ 
 	/**
 	 * @param FormTransformation $transformation
 	 *
-	 * @return mixed
+	 * @return FormField
 	 */
 	public function transform(FormTransformation $transformation) {
 		return $transformation->transform($this);
@@ -1291,7 +1290,7 @@ 
 	 * This function is used by the template processor. If you refer to a field as a $ variable, it
 	 * will return the $Field value.
 	 *
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function forTemplate() {
 		return $this->Field();

src/Forms/GridField/GridField.php

Doc Comments +1 added lines, -1 removed lines

@@ -200,7 +200,7 @@
 	 *
 	 * @todo refactor this into GridFieldComponent
 	 *
-	 * @param mixed $value
+	 * @param string $value
 	 * @param string|array $castingDefinition
 	 *
 	 * @return mixed

src/Forms/GridField/GridFieldAddExistingAutocompleter.php

Doc Comments +2 added lines, -2 removed lines

@@ -142,7 +142,7 @@ 
 	/**
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getActions($gridField) {
 		return array('addto', 'find');
@@ -273,7 +273,7 @@ 
 	}
 
 	/**
-	 * @param array $fields
+	 * @param string[] $fields
 	 * @return $this
 	 */
 	public function setSearchFields($fields) {

src/Forms/GridField/GridFieldDetailForm_ItemRequest.php

Doc Comments +9 added lines

@@ -92,6 +92,9 @@ 
 		parent::__construct();
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null)
 	{
 		return Controller::join_links($this->gridField->Link('item'),
@@ -339,6 +342,9 @@ 
 		return $c;
 	}
 
+	/**
+	 * @return string
+	 */
 	protected function getBackLink()
 	{
 		// TODO Coupling with CMS
@@ -446,6 +452,9 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $errorCode
+	 */
 	public function httpError($errorCode, $errorMessage = null)
 	{
 		$controller = $this->getToplevelController();

src/Forms/GridField/GridFieldEditButton.php

Doc Comments +2 added lines, -2 removed lines

@@ -60,7 +60,7 @@ 
 	 * Which columns are handled by this component
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getColumnsHandled($gridField) {
 		return array('Actions');
@@ -80,7 +80,7 @@ 
 	 * @param GridField $gridField
 	 * @param DataObject $record
 	 * @param string $columnName
-	 * @return string The HTML for the column
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText The HTML for the column
 	 */
 	public function getColumnContent($gridField, $record, $columnName) {
 		// No permission checks, handled through GridFieldDetailForm,