silverstripe / silverstripe-framework

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;

forms/SelectionGroup.php

Doc Comments +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
 	/**
 	 * Create a new selection group.
 	 * 
-	 * @param name The field name of the selection group.
+	 * @param name string field name of the selection group.
 	 * @param items The list of {@link SelectionGroup_Item}
 	 */
 	public function __construct($name, $items) {
@@ -128,7 +128,7 @@ 
 
 	/**
 	 * @param String $value Form field identifier
-	 * @param FormField $field Contents of the option
+	 * @param FormField $fields Contents of the option
 	 * @param String $title Title to show for the radio button option
 	 */
 	function __construct($value, $fields = null, $title = null) {

forms/TabSet.php

Doc Comments +6 added lines, -4 removed lines

@@ -29,8 +29,6 @@ 
 	
 	/**
 	 * @param string $name Identifier
-	 * @param string $title (Optional) Natural language title of the tabset
-	 * @param Tab|TabSet $unknown All further parameters are inserted as children into the TabSet
 	 */
 	public function __construct($name) {
 		$args = func_get_args();
@@ -148,8 +146,8 @@ 
 	/**
 	 * Inserts a field before a particular field in a FieldList.
 	 *
-	 * @param FormField $item The form field to insert
-	 * @param string $name Name of the field to insert before
+	 * @param TextField $field
+	 * @param string $insertBefore
 	 */
 	public function insertBefore($field, $insertBefore) {
 		parent::insertBefore($field, $insertBefore);
@@ -157,6 +155,10 @@ 
 		$this->sequentialSet = null;
 	}
 	
+	/**
+	 * @param TextField $field
+	 * @param string $insertAfter
+	 */
 	public function insertAfter($field, $insertAfter) {
 		parent::insertAfter($field, $insertAfter);
 		if($field instanceof Tab) $field->setTabSet($this);

forms/TreeDropdownField.php

Doc Comments +3 added lines, -4 removed lines

@@ -75,7 +75,7 @@ 
 	 *
 	 * @param string $name the field name
 	 * @param string $title the field label
-	 * @param string|array $sourceObject The object-type to list in the tree. This could
+	 * @param string $sourceObject The object-type to list in the tree. This could
 	 * be one of the following:
 	 * - A DataObject class name with the {@link Hierarchy} extension.
 	 * - An array of key/value pairs, like a {@link DropdownField} source. In
@@ -203,7 +203,7 @@ 
 	}
 
 	/**
-	 * @return string
+	 * @return HTMLText
 	 */
 	public function Field($properties = array()) {
 		Requirements::add_i18n_javascript(FRAMEWORK_DIR . '/javascript/lang');
@@ -384,7 +384,7 @@ 
 	 * If a filter function has been set, that will be called. And if search text is set,
 	 * filter on that too. Return true if all applicable conditions are true, false otherwise.
 	 * @param $node
-	 * @return unknown_type
+	 * @return boolean
 	 */
 	public function filterMarking($node) {
 		if ($this->filterCallback && !call_user_func($this->filterCallback, $node)) return false;
@@ -435,7 +435,6 @@ 
 	}
 
 	/**
-	 * @param String $field
 	 */
 	public function setSourceObject($class) {
 		$this->sourceObject = $class;

forms/UploadField.php

Doc Comments +3 added lines, -5 removed lines

@@ -194,7 +194,6 @@ 
 	 * @param string $title The field label.
 	 * @param SS_List $items If no items are defined, the field will try to auto-detect an existing relation on
 	 *                       @link $record}, with the same name as the field name.
-	 * @param Form $form Reference to the container form
 	 */
 	public function __construct($name, $title = null, SS_List $items = null) {
 		
@@ -600,7 +599,6 @@ 
 	 * for each of these categories
 	 * 
 	 * @param string $category Category name
-	 * @param string,... $categories Additional category names
 	 * @return UploadField Self reference
 	 */
 	public function setAllowedFileCategories($category) {
@@ -1086,7 +1084,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return UploadField_ItemHandler
+	 * @return UploadField_SelectHandler
 	 */
 	public function handleSelect(SS_HTTPRequest $request) {
 		if(!$this->canAttachExisting()) return $this->httpError(403);
@@ -1380,7 +1378,7 @@ 
 
 	/**
 	 * @param UploadFIeld $parent
-	 * @param int $item
+	 * @param int $itemID
 	 */
 	public function __construct($parent, $itemID) {
 		$this->parent = $parent;
@@ -1449,7 +1447,7 @@ 
 	 * Action to handle editing of a single file
 	 * 
 	 * @param SS_HTTPRequest $request
-	 * @return ViewableData_Customised
+	 * @return HTMLText
 	 */
 	public function edit(SS_HTTPRequest $request) {
 		// Check form field state

forms/Validator.php

Doc Comments +1 added lines

@@ -109,6 +109,7 @@
 	 * Used by FormField to return a value for FormField::Required(), to do things like show *s on the form template.
 	 *
 	 * By default, it always returns false.
+	 * @param string $fieldName
 	 */
 	public function fieldIsRequired($fieldName) {
 		return false;