silverstripe / silverstripe-framework

forms/gridfield/GridFieldDetailForm.php

Doc Comments +10 added lines

@@ -164,6 +164,7 @@ 
 
 	/**
 	 * @param String
+	 * @param string $class
 	 */
 	public function setItemRequestClass($class) {
 		$this->itemRequestClass = $class;
@@ -271,6 +272,9 @@ 
 		parent::__construct();
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		return Controller::join_links($this->gridField->Link('item'),
 			$this->record->ID ? $this->record->ID : 'new', $action);
@@ -299,6 +303,9 @@ 
 		}
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	public function edit($request) {
 		$controller = $this->getToplevelController();
 		$form = $this->ItemEditForm($this->gridField, $request);
@@ -480,6 +487,9 @@ 
 		return $c;
 	}
 
+	/**
+	 * @return string
+	 */
 	protected function getBackLink(){
 		// TODO Coupling with CMS
 		$backlink = '';

forms/gridfield/GridFieldEditButton.php

Doc Comments +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
 	 * Which columns are handled by this component
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @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/GridFieldExportButton.php

Doc Comments +3 added lines, -1 removed lines

@@ -86,6 +86,7 @@ 
 
 	/**
 	 * Handle the export, for both the action button and the URL
+ 	 * @param GridField $gridField
  	 */
 	public function handleExport($gridField, $request = null) {
 		$now = Date("d-m-Y-H-i");
@@ -100,7 +101,7 @@ 
 	 * Generate export fields for CSV.
 	 *
 	 * @param GridField $gridField
-	 * @return array
+	 * @return string
 	 */
 	public function generateExportFileData($gridField) {
 		$csvColumns = ($this->exportColumns)
@@ -227,6 +228,7 @@ 
 
 	/**
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function setCsvHasHeader($bool) {
 		$this->csvHasHeader = $bool;

forms/gridfield/GridFieldFilterHeader.php

Doc Comments +1 added lines

@@ -23,6 +23,7 @@
 	 *
 	 * By default, this is set to true so that it's clearer what's happening, but the predefined
 	 * {@link GridFieldConfig} subclasses set this to false for flexibility.
+	 * @param boolean $throwExceptionOnBadDataType
 	 */
 	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
 		$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;

forms/gridfield/GridFieldPageCount.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
 	protected $itemClass = 'GridFieldPageCount';
 
 	/**
-	 * @param string $targetFrament The fragment indicating the placement of this page count
+	 * @param string $targetFragment The fragment indicating the placement of this page count
 	 */
 	public function __construct($targetFragment = 'before') {
 		$this->targetFragment = $targetFragment;

forms/gridfield/GridFieldPaginator.php

Doc Comments +2 added lines

@@ -50,6 +50,7 @@ 
 	 *
 	 * By default, this is set to true so that it's clearer what's happening, but the predefined
 	 * {@link GridFieldConfig} subclasses set this to false for flexibility.
+	 * @param boolean $throwExceptionOnBadDataType
 	 */
 	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
 		$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;
@@ -65,6 +66,7 @@ 
 	/**
 	 * Check that this dataList is of the right data type.
 	 * Returns false if it's a bad data type, and if appropriate, throws an exception.
+	 * @param SS_List $dataList
 	 */
 	protected function checkDataType($dataList) {
 		if($dataList instanceof SS_Limitable) {

forms/gridfield/GridFieldPrintButton.php

Doc Comments +2 added lines, -1 removed lines

@@ -66,7 +66,7 @@ 
 	 *
 	 * @param GridField
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getActions($gridField) {
 		return array('print');
@@ -100,6 +100,7 @@ 
 
 	/**
 	 * Handle the print, for both the action button and the URL
+ 	 * @param GridField $gridField
  	 */
 	public function handlePrint($gridField, $request = null) {
 		set_time_limit(60);

forms/gridfield/GridFieldSortableHeader.php

Doc Comments +2 added lines, -1 removed lines

@@ -29,6 +29,7 @@ 
 	 *
 	 * By default, this is set to true so that it's clearer what's happening, but the predefined
 	 * {@link GridFieldConfig} subclasses set this to false for flexibility.
+	 * @param boolean $throwExceptionOnBadDataType
 	 */
 	public function setThrowExceptionOnBadDataType($throwExceptionOnBadDataType) {
 		$this->throwExceptionOnBadDataType = $throwExceptionOnBadDataType;
@@ -61,7 +62,7 @@ 
 	 * Specify sortings with fieldname as the key, and actual fieldname to sort as value.
 	 * Example: array("MyCustomTitle"=>"Title", "MyCustomBooleanField" => "ActualBooleanField")
 	 *
-	 * @param array $casting
+	 * @param array $sorting
 	 */
 	public function setFieldSorting($sorting) {
 		$this->fieldSorting = $sorting;

forms/gridfield/GridState.php

Doc Comments +1 added lines, -2 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;