silverstripe / silverstripe-framework

forms/HtmlEditorField.php

Doc Comments +4 added lines, -4 removed lines

@@ -46,7 +46,7 @@ 
 	 *
 	 * @param string $name The internal field name, passed to forms.
 	 * @param string $title The human-readable field label.
-	 * @param mixed $value The value of the field.
+	 * @param integer $value The value of the field.
 	 * @param string $config HTMLEditorConfig identifier to be used. Default to the active one.
 	 */
 	public function __construct($name, $title = null, $value = '', $config = null) {
@@ -174,7 +174,7 @@ 
 	/**
 	 * Searches the SiteTree for display in the dropdown
 	 *
-	 * @return callback
+	 * @return DataList
 	 */
 	public function siteTreeSearchCallback($sourceObject, $labelField, $search) {
 		return DataObject::get($sourceObject)->filterAny(array(
@@ -454,7 +454,7 @@ 
 	/**
 	 * Find all anchors available on the given page.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getanchors() {
 		$id = (int)$this->getRequest()->getVar('PageID');
@@ -1006,7 +1006,7 @@ 
 	/**
 	 * Get OEmbed type
 	 *
-	 * @return string
+	 * @return boolean
 	 */
 	public function getType() {
 		return $this->oembed->type;

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/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;

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
 	 */

forms/SelectionGroup.php

Doc Comments +1 added lines, -1 removed lines

@@ -134,7 +134,7 @@
 
 	/**
 	 * @param String $value Form field identifier
-	 * @param FormField $field Contents of the option
+	 * @param FormField $fields Contents of the option
 	 * @param String $title Title to show for the radio button option
 	 */
 	function __construct($value, $fields = null, $title = null) {