silverstripe / silverstripe-framework

src/Forms/HTMLEditor/EmbedShortcodeProvider.php

Doc Comments +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
 	/**
 	 * Gets the list of shortcodes provided by this handler
 	 *
-	 * @return mixed
+	 * @return string[]
 	 */
 	public static function get_shortcodes()
 	{

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

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

src/Forms/HTMLEditor/HTMLEditorField_Embed.php

Doc Comments +1 added lines, -1 removed lines

@@ -140,7 +140,7 @@
 	}
 
 	/**
-	 * @return AdapterInterface
+	 * @return Embed
 	 */
 	public function getEmbed()
 	{

src/Forms/HTMLEditor/HTMLEditorField_Toolbar.php

Doc Comments +5 added lines, -1 removed lines

@@ -67,6 +67,10 @@ 
 	 */
 	protected $name;
 
+	/**
+	 * @param Controller|null $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name)
 	{
 		parent::__construct();
@@ -487,7 +491,7 @@ 
 	/**
 	 * Find all anchors available on the given page.
 	 *
-	 * @return array
+	 * @return string
 	 * @throws SS_HTTPResponse_Exception
 	 */
 	public function getanchors()

src/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) {

src/Forms/ListboxField.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');

src/Forms/LookupField.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');

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