silverstripe / silverstripe-framework

forms/gridfield/GridFieldFilterHeader.php

Doc Comments +1 added lines

@@ -23,6 +23,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;

forms/gridfield/GridFieldPageCount.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
 	protected $itemClass = 'GridFieldPageCount';
 
 	/**
-	 * @param string $targetFrament The fragment indicating the placement of this page count
+	 * @param string $targetFragment The fragment indicating the placement of this page count
 	 */
 	public function __construct($targetFragment = 'before') {
 		$this->targetFragment = $targetFragment;

forms/gridfield/GridFieldPaginator.php

Doc Comments +2 added lines

@@ -50,6 +50,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;
@@ -65,6 +66,7 @@ 
 	/**
 	 * Check that this dataList is of the right data type.
 	 * Returns false if it's a bad data type, and if appropriate, throws an exception.
+	 * @param SS_List $dataList
 	 */
 	protected function checkDataType($dataList) {
 		if($dataList instanceof SS_Limitable) {

forms/gridfield/GridFieldPrintButton.php

Doc Comments +2 added lines, -1 removed lines

@@ -66,7 +66,7 @@ 
 	 *
 	 * @param GridField
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getActions($gridField) {
 		return array('print');
@@ -100,6 +100,7 @@ 
 
 	/**
 	 * Handle the print, for both the action button and the URL
+ 	 * @param GridField $gridField
  	 */
 	public function handlePrint($gridField, $request = null) {
 		set_time_limit(60);

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

Doc Comments +1 added lines, -1 removed lines

@@ -103,7 +103,7 @@
 	 * Mark certain elements as disabled,
 	 * regardless of the {@link setDisabled()} settings.
 	 *
-	 * @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 setDisabledItems($items) {
 		$this->disabledItems = $items;