silverstripe / silverstripe-framework

Forms/HTMLEditor/HTMLEditorConfig.php

Doc Comments +2 added lines, -2 removed lines

@@ -140,14 +140,14 @@
 	 * Get the current value of an option
      *
 	 * @param string $key The key of the option to get
-	 * @return mixed The value of the specified option
+	 * @return string The value of the specified option
 	 */
 	abstract public function getOption($key);
 
 	/**
 	 * Set the value of one option
 	 * @param string $key The key of the option to set
-	 * @param mixed $value The value of the option to set
+	 * @param string $value The value of the option to set
 	 * @return $this
 	 */
 	abstract public function setOption($key, $value);

Forms/HTMLEditor/HTMLEditorField.php

Doc Comments +5 added lines, -2 removed lines

@@ -68,7 +68,7 @@ 
 	/**
 	 * Assign a new configuration instance or identifier
 	 *
-	 * @param string|HTMLEditorConfig $config
+	 * @param string $config
 	 * @return $this
 	 */
 	public function setEditorConfig($config) {
@@ -82,7 +82,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) {
@@ -127,6 +127,9 @@ 
 		$record->{$this->name} = $htmlValue->getContent();
 	}
 
+	/**
+	 * @param string|null $value
+	 */
 	public function setValue($value) {
 		// Regenerate links prior to preview, so that the editor can see them.
 		$value = Image::regenerate_html_links($value);

Forms/HTMLEditor/HTMLEditorSanitiser.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,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) {

Forms/MoneyField.php

Doc Comments +11 added lines, -1 removed lines

@@ -57,6 +57,10 @@ 
 		return $this->fieldAmount;
 	}
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = "") {
 		$this->setName($name);
 
@@ -129,7 +133,7 @@ 
 	 *
 	 * (see @link MoneyFieldTest_CustomSetter_Object for more information)
 	 *
-	 * @param DataObjectInterface|Object $dataObject
+	 * @param DataObjectInterface $dataObject
 	 */
 	public function saveInto(DataObjectInterface $dataObject) {
 		$fieldName = $this->getName();
@@ -158,6 +162,9 @@ 
 		return $clone;
 	}
 
+	/**
+	 * @param boolean $bool
+	 */
 	public function setReadonly($bool) {
 		parent::setReadonly($bool);
 
@@ -198,6 +205,9 @@ 
 		return $this->allowedCurrencies;
 	}
 
+	/**
+	 * @param string $locale
+	 */
 	public function setLocale($locale) {
 		$this->_locale = $locale;
 		return $this;

Forms/PrintableTransformation_TabSet.php

Doc Comments +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
 class PrintableTransformation_TabSet extends TabSet
 {
 	/**
-	 * @param array $tabs
+	 * @param FieldList $tabs
 	 */
 	public function __construct($tabs)
 	{

Forms/ReadonlyField.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
 	 * If $dontEscape is false the returned value will be safely encoded,
 	 * but should not be escaped by the frontend.
 	 *
-	 * @return mixed|string
+	 * @return string
 	 */
 	public function Value() {
 		// Get raw value

Forms/Schema/FormSchema.php

Doc Comments +3 added lines

@@ -74,6 +74,9 @@
 		return $state;
 	}
 
+	/**
+	 * @param \SilverStripe\Forms\FieldList $fields
+	 */
 	protected function getFieldStates($fields) {
 		$states = [];
 		foreach ($fields as $field) {

Forms/SelectionGroup_Item.php

Doc Comments +6 added lines

@@ -152,6 +152,9 @@ 
 		return $this->title;
 	}
 
+	/**
+	 * @param string $title
+	 */
 	function setTitle($title) {
 		$this->title = $title;
 		return $this;
@@ -161,6 +164,9 @@ 
 		return $this->value;
 	}
 
+	/**
+	 * @param string $Value
+	 */
 	function setValue($Value) {
 		$this->value = $Value;
 		return $this;

Forms/TextField.php

Doc Comments +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
 	}
 
 	/**
-	 * @return string
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	public function InternallyLabelledField() {
 		Deprecation::notice('4.0', 'Please use ->setValue() instead');