silverstripe / silverstripe-framework

forms/AssetField.php

Doc Comments +4 added lines, -1 removed lines

@@ -144,7 +144,6 @@ 
 	 *
 	 * @param string $name The internal field name, passed to forms.
 	 * @param string $title The field label.
-	 * @param Form $form Reference to the container form
 	 */
 	public function __construct($name, $title = null) {
 		$this->addExtraClass('ss-upload'); // class, used by js
@@ -256,6 +255,10 @@ 
 		return $this->record;
 	}
 
+	/**
+	 * @param null|DataObject $value
+	 * @param DataObject $record
+	 */
 	public function setValue($value, $record = null) {
 		// Extract value from underlying record
 		if(empty($value) && $this->getName() && $record instanceof DataObject) {

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

@@ -90,6 +90,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();
@@ -288,6 +293,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function castedCopy($class) {
 		$copy = new $class($this->name);
 		if($copy->hasMethod('setConfig')) {
@@ -326,7 +334,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, -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');

forms/gridfield/GridFieldComponent.php

Doc Comments +4 added lines, -1 removed lines

@@ -33,6 +33,7 @@ 
 	 * If you attempt to return HTML for a fragment that doesn't exist, an
 	 * exception will be thrown when the {@link GridField} is rendered.
 	 *
+	 * @param GridField $gridField
 	 * @return array
 	 */
 	public function getHTMLFragments($gridField);
@@ -57,6 +58,7 @@ 
 	 * @param GridField $gridField
 	 * @param arary $columns List of columns
 	 * @param array - List reference of all column names.
+	 * @return void
 	 */
 	public function augmentColumns($gridField, &$columns);
 
@@ -139,6 +141,7 @@ 
 	 * @param String Action identifier, see {@link getActions()}.
 	 * @param Array Arguments relevant for this
 	 * @param Array All form data
+	 * @param string $actionName
 	 */
 	public function handleAction(GridField $gridField, $actionName, $arguments, $data);
 }
@@ -189,6 +192,7 @@ 
 	 *
 	 * Handler methods will be called on the component, rather than the
 	 * {@link GridField}.
+	 * @param GridField $gridField
 	 */
 	public function getURLHandlers($gridField);
 }
@@ -205,7 +209,6 @@ 
 	/**
 	 * Called when a grid field is saved - i.e. the form is submitted.
 	 *
-	 * @param GridField $field
 	 * @param DataObjectInterface $record
 	 */
 	public function handleSave(GridField $grid, DataObjectInterface $record);