silverstripe / silverstripe-framework

forms/gridfield/GridFieldSortableHeader.php

Doc Comments +2 added lines, -1 removed lines

@@ -29,6 +29,7 @@ 
 	 *
 	 * By default, this is set to true so that it's clearer what's happening, but the predefined
 	 * {@link GridFieldConfig} subclasses set this to false for flexibility.
+	 * @param boolean $throwExceptionOnBadDataType
 	 */
 	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
 		$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;
@@ -61,7 +62,7 @@ 
 	 * Specify sortings with fieldname as the key, and actual fieldname to sort as value.
 	 * Example: array("MyCustomTitle"=>"Title", "MyCustomBooleanField" => "ActualBooleanField")
 	 *
-	 * @param array $casting
+	 * @param array $sorting
 	 */
 	public function setFieldSorting($sorting) {
 		$this->fieldSorting = $sorting;

forms/gridfield/GridState.php

Doc Comments +1 added lines, -2 removed lines

@@ -24,8 +24,7 @@
 
 	/**
 	 *
-	 * @param GridField $name
-	 * @param string $data - json encoded string
+	 * @param GridField $grid
 	 */
 	public function __construct($grid, $value = null) {
 		$this->grid = $grid;

forms/HiddenField.php

Doc Comments +1 added lines, -1 removed lines

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

forms/HtmlEditorSanitiser.php

Doc Comments +2 added lines, -1 removed lines

@@ -39,7 +39,7 @@ 
 	/**
 	 * Given a TinyMCE pattern (close to unix glob style), create a regex that does the match
 	 *
-	 * @param $str - The TinyMCE pattern
+	 * @param string|null $str - The TinyMCE pattern
 	 * @return string - The equivalent regex
 	 */
 	protected function patternToRegex($str) {
@@ -180,6 +180,7 @@ 
 	/**
 	 * Given an attribute name, return the rule structure for that attribute
 	 * @param string $name - The attribute name
+	 * @param stdClass $elementRule
 	 * @return stdClass - The attribute rule
 	 */
 	protected function getRuleForAttribute($elementRule, $name) {

forms/InlineFormAction.php

Doc Comments +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 
 	/**
 	 * Create a new action button.
-	 * @param action The method to call when the button is clicked
+	 * @param action string method to call when the button is clicked
 	 * @param title The label on the button
 	 * @param extraClass A CSS class to apply to the button in addition to 'action'
 	 */

forms/MoneyField.php

Doc Comments +8 added lines

@@ -32,6 +32,10 @@ 
 	 */
 	protected $fieldCurrency = null;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = "") {
 		// naming with underscores to prevent values from actually being saved somewhere
 		$this->fieldAmount = new NumericField("{$name}[Amount]", _t('MoneyField.FIELDLABELAMOUNT', 'Amount'));
@@ -135,6 +139,7 @@ 
 	/**
 	 * @todo Implement removal of readonly state with $bool=false
 	 * @todo Set readonly state whenever field is recreated, e.g. in setAllowedCurrencies()
+	 * @param boolean $bool
 	 */
 	public function setReadonly($bool) {
 		parent::setReadonly($bool);
@@ -175,6 +180,9 @@ 
 		return $this->allowedCurrencies;
 	}
 
+	/**
+	 * @param string $locale
+	 */
 	public function setLocale($locale) {
 		$this->_locale = $locale;
 		return $this;

forms/NestedForm.php

Doc Comments +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
 
 	/**
 	 * Represent the given form in a tabular style
-	 * @param form The form to decorate.
+	 * @param form Form form to decorate.
 	 */
 	public function __construct(Form $form) {
 		$this->form = $form;

forms/PhoneNumberField.php

Doc Comments +4 added lines, -1 removed lines

@@ -29,7 +29,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return FieldGroup|HTMLText
+	 * @return FieldGroup
 	 */
 	public function Field($properties = array()) {
 		$fields = new FieldGroup( $this->name );
@@ -73,6 +73,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function joinPhoneNumber( $value ) {
 		if( is_array( $value ) ) {
 			$completeNumber = '';

forms/RequiredFields.php

Doc Comments +1 added lines

@@ -176,6 +176,7 @@
 	 * Add {@link RequiredField} objects together
 	 *
 	 * @param RequiredFields
+	 * @param RequiredFields $requiredFields
 	 *
 	 * @return RequiredFields
 	 */