silverstripe / silverstripe-framework

forms/Form.php

Doc Comments +7 added lines, -2 removed lines

@@ -496,7 +496,7 @@ 
 	/**
 	 * Fields can have action to, let's check if anyone of the responds to $funcname them
 	 *
-	 * @param SS_List|array $fields
+	 * @param FieldList|null $fields
 	 * @param callable $funcName
 	 * @return FormField
 	 */
@@ -755,6 +755,7 @@ 
 	}
 
 	/**
+	 * @param string $name
 	 * @return string $name
 	 */
 	public function getAttribute($name) {
@@ -788,6 +789,7 @@ 
 	 *
 	 * @param array Custom attributes to process. Falls back to {@link getAttributes()}.
 	 * If at least one argument is passed as a string, all arguments act as excludes by name.
+	 * @param string $attrs
 	 *
 	 * @return string HTML attributes, ready for insertion into an HTML tag
 	 */
@@ -963,7 +965,7 @@ 
 	 * If set to false (the default), then the form method is only used to construct the default
 	 * form.
 	 *
-	 * @param $bool boolean
+	 * @param boolean $bool boolean
 	 * @return $this
 	 */
 	public function setStrictFormMethodCheck($bool) {
@@ -1707,6 +1709,9 @@ 
 class Form_FieldMap extends ViewableData {
 	protected $form;
 
+	/**
+	 * @param Form $form
+	 */
 	public function __construct($form) {
 		$this->form = $form;
 		parent::__construct();

forms/FormAction.php

Doc Comments +1 added lines

@@ -89,6 +89,7 @@
 	 * Determines if the field should render open or closed by default.
 	 * 
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function startClosed($bool) {
 		($bool) ? $this->addExtraClass('startClosed') : $this->removeExtraClass('startClosed');

forms/gridfield/GridFieldConfig.php

Doc Comments +2 added lines, -1 removed lines

@@ -27,7 +27,6 @@ 
 	protected $components = null;
 	
 	/**
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return GridFieldConfig
 	 */
 	public static function create() {
@@ -87,6 +86,7 @@ 
 	
 	/**
 	 * @param String Class name or interface
+	 * @param string $type
 	 * @return GridFieldConfig $this
 	 */
 	public function removeComponentsByType($type) {
@@ -125,6 +125,7 @@ 
 	 * Returns the first available component with the given class or interface.
 	 * 
 	 * @param String ClassName
+	 * @param string $type
 	 * @return GridFieldComponent
 	 */
 	public function getComponentByType($type) {

forms/gridfield/GridFieldDeleteAction.php

Doc Comments +2 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
 	 * Which columns are handled by this component
 	 * 
 	 * @param type $gridField
-	 * @return type 
+	 * @return string[] 
 	 */
 	public function getColumnsHandled($gridField) {
 		return array('Actions');
@@ -90,7 +90,7 @@ 
 	 * Which GridField actions are this component handling
 	 *
 	 * @param GridField $gridField
-	 * @return array 
+	 * @return string[] 
 	 */
 	public function getActions($gridField) {
 		return array('deleterecord', 'unlinkrelation');

forms/gridfield/GridFieldEditButton.php

Doc Comments +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
 	 * Which columns are handled by this component
 	 * 
 	 * @param type $gridField
-	 * @return type 
+	 * @return string[] 
 	 */
 	public function getColumnsHandled($gridField) {
 		return array('Actions');
@@ -76,7 +76,7 @@ 
 	 * @param DataObject $record
 	 * @param string $columnName
 	 *
-	 * @return string - the HTML for the column 
+	 * @return HTMLText - the HTML for the column 
 	 */
 	public function getColumnContent($gridField, $record, $columnName) {
 		// No permission checks, handled through GridFieldDetailForm,

forms/gridfield/GridState.php

Doc Comments +2 added lines, -3 removed lines

@@ -24,8 +24,7 @@ 
 	
 	/**
 	 *
-	 * @param GridField $name
-	 * @param string $data - json encoded string
+	 * @param GridField $grid
 	 */
 	public function __construct($grid, $value = null) {
 		$this->grid = $grid;
@@ -108,7 +107,7 @@ 
 
 	/**
 	 *
-	 * @return type 
+	 * @return string 
 	 */
 	public function __toString() {
 		return $this->Value();

forms/HtmlEditorField.php

Doc Comments +12 added lines, -2 removed lines

@@ -57,6 +57,7 @@ 
 	
 	/**
 	 * @see TextareaField::__construct()
+	 * @param string $name
 	 */
 	public function __construct($name, $title = null, $value = '') {
 		parent::__construct($name, $title, $value);
@@ -234,7 +235,7 @@ 
 	/**
 	 * Searches the SiteTree for display in the dropdown
 	 *  
-	 * @return callback
+	 * @return DataList
 	 */	
 	public function siteTreeSearchCallback($sourceObject, $labelField, $search) {
 		return DataObject::get($sourceObject, "\"MenuTitle\" LIKE '%$search%' OR \"Title\" LIKE '%$search%'");
@@ -529,7 +530,7 @@ 
 	/**
 	 * Find all anchors available on the given page.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function getanchors() {
 		$id = (int)$this->request->getVar('PageID');
@@ -567,6 +568,7 @@ 
 	 * not the "master record" in the database - hence there's no form or saving logic.
 	 * 
 	 * @param String Relative or absolute URL to file
+	 * @param HtmlEditorField_File $file
 	 * @return FieldList
 	 */
 	protected function getFieldsForFile($url, $file) {
@@ -588,6 +590,7 @@ 
 	}
 
 	/**
+	 * @param HtmlEditorField_Embed $file
 	 * @return FieldList
 	 */
 	protected function getFieldsForOembed($url, $file) {
@@ -797,6 +800,7 @@ 
 
 	/**
 	 * @param Int
+	 * @param integer $parentID
 	 * @return DataList
 	 */
 	protected function getFiles($parentID = null) {
@@ -923,6 +927,9 @@ 
 
 	protected $oembed;
 
+	/**
+	 * @param DataObject $file
+	 */
 	public function __construct($url, $file = null) {
 		parent::__construct($url, $file);
 		$this->oembed = Oembed::get_oembed_from_url($url);
@@ -1015,6 +1022,9 @@ 
 
 	protected $height;
 
+	/**
+	 * @param DataObject $file
+	 */
 	public function __construct($url, $file = null) {
 		parent::__construct($url, $file);
 

forms/ListboxField.php

Doc Comments +1 added lines

@@ -204,6 +204,7 @@
 
 	/**
 	 * Load a value into this CheckboxSetField
+	 * @param DataObject $obj
 	 */
 	public function setValue($val, $obj = null) {
 		// If we're not passed a value directly, 

forms/LookupField.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
 	/**
 	 * Override parent behavior by not merging arrays.
 	 *
-	 * @return array
+	 * @return boolean
 	 */
 	public function getSource() {
 		return $this->source;