silverstripe / silverstripe-framework

Forms/GridField/GridFieldDetailForm_ItemRequest.php

Doc Comments +9 added lines

@@ -92,6 +92,9 @@ 
 		parent::__construct();
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null)
 	{
 		return Controller::join_links($this->gridField->Link('item'),
@@ -339,6 +342,9 @@ 
 		return $c;
 	}
 
+	/**
+	 * @return string
+	 */
 	protected function getBackLink()
 	{
 		// TODO Coupling with CMS
@@ -446,6 +452,9 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $errorCode
+	 */
 	public function httpError($errorCode, $errorMessage = null)
 	{
 		$controller = $this->getToplevelController();

Forms/GridField/GridFieldEditButton.php

Doc Comments +2 added lines, -2 removed lines

@@ -60,7 +60,7 @@ 
 	 * Which columns are handled by this component
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getColumnsHandled($gridField) {
 		return array('Actions');
@@ -80,7 +80,7 @@ 
 	 * @param GridField $gridField
 	 * @param DataObject $record
 	 * @param string $columnName
-	 * @return string The HTML for the column
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText The HTML for the column
 	 */
 	public function getColumnContent($gridField, $record, $columnName) {
 		// No permission checks, handled through GridFieldDetailForm,

Forms/GridField/GridFieldExportButton.php

Doc Comments +2 added lines, -2 removed lines

@@ -72,7 +72,7 @@ 
 	 * export is an action button
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getActions($gridField) {
 		return array('export');
@@ -141,7 +141,7 @@ 
 	 * Generate export fields for CSV.
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string
 	 */
 	public function generateExportFileData($gridField) {
 		$csvColumns = $this->getExportColumnsForGridField($gridField);

Forms/GridField/GridFieldPrintButton.php

Doc Comments +1 added lines, -1 removed lines

@@ -129,7 +129,7 @@
 	/**
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string[]
 	 */
 	public function getActions($gridField) {
 		return array('addto');

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()
 	{

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

Doc Comments +1 added lines, -1 removed lines

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

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