silverstripe / silverstripe-framework

forms/ConfirmedPasswordField.php

Doc Comments +1 added lines, -1 removed lines

@@ -409,7 +409,7 @@
 	 *
 	 * @param DataObjectInterface $record
 	 *
-	 * @return boolean
+	 * @return false|null
 	 */
 	public function saveInto(DataObjectInterface $record) {
 		if(!$this->isSaveable()) {

forms/DatetimeField.php

Doc Comments +17 added lines, -2 removed lines

@@ -56,6 +56,10 @@ 
 	 */
 	protected $config;
 		
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		$this->config = $this->config()->default_config;
 		
@@ -68,6 +72,9 @@ 
 		parent::__construct($name, $title, $value);
 	}
 		
+	/**
+	 * @param Form $form
+	 */
 	public function setForm($form) {
 		parent::setForm($form);
 		
@@ -78,6 +85,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setName($name) {
 		parent::setName($name);
 
@@ -229,6 +239,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param DateField $field
 	 */
 	public function setDateField($field) {
 		$expected = $this->getName() . '[date]';
@@ -254,6 +265,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param TimeField $field
 	 */
 	public function setTimeField($field) {
 		$expected = $this->getName() . '[time]';
@@ -292,7 +304,7 @@ 
 	 * to set field-specific config options.
 	 * 
 	 * @param string $name
-	 * @param mixed $val
+	 * @param string $val
 	 */
 	public function setConfig($name, $val) {
 		$this->config[$name] = $val;
@@ -310,7 +322,7 @@ 
 	 * to get field-specific config options.
 	 * 
 	 * @param String $name Optional, returns the whole configuration array if empty
-	 * @return mixed
+	 * @return string|null
 	 */
 	public function getConfig($name = null) {
 		if($name) {
@@ -320,6 +332,9 @@ 
 		}
 	}
 	
+	/**
+	 * @param RequiredFields $validator
+	 */
 	public function validate($validator) {
 		$dateValid = $this->dateField->validate($validator);
 		$timeValid = $this->timeField->validate($validator);

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

Doc Comments +5 added lines

@@ -32,6 +32,10 @@ 
 	 */
 	protected $fieldCurrency = null;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = "") {
 		// naming with underscores to prevent values from actually being saved somewhere
 		$this->fieldAmount = new NumericField("{$name}[Amount]", _t('MoneyField.FIELDLABELAMOUNT', 'Amount'));
@@ -135,6 +139,7 @@ 
 	/**
 	 * @todo Implement removal of readonly state with $bool=false
 	 * @todo Set readonly state whenever field is recreated, e.g. in setAllowedCurrencies()
+	 * @param boolean $bool
 	 */
 	public function setReadonly($bool) {
 		parent::setReadonly($bool);

api/RSSFeed.php

Doc Comments +1 added lines

@@ -223,6 +223,7 @@
 	 * via the standard template inclusion process.
 	 *
 	 * @param string
+	 * @param string $template
 	 */
 	public function setTemplate($template) {
 		$this->template = $template;

control/Controller.php

Doc Comments +3 added lines, -2 removed lines

@@ -133,6 +133,7 @@ 
 	 * {@inheritdoc}
 	 *
 	 * Also set the URLParams
+	 * @param SS_HTTPRequest $request
 	 */
 	public function setRequest($request) {
 		$return = parent::setRequest($request);
@@ -509,7 +510,7 @@ 
 	 *
 	 * @param array $params
 	 *
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function render($params = null) {
 		$template = $this->getViewer($this->getAction());
@@ -674,7 +675,7 @@ 
 	 * Tests whether a redirection has been requested. If redirect() has been called, it will return
 	 * the URL redirected to. Otherwise, it will return null.
 	 *
-	 * @return null|string
+	 * @return boolean
 	 */
 	public function redirectedTo() {
 		return $this->getResponse() && $this->getResponse()->getHeader('Location');

core/CustomMethods.php

Doc Comments +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
 	/**
 	 * Get meta-data details on a named method
 	 *
-	 * @param array $method
+	 * @param string $method
 	 * @return array List of custom method details, if defined for this method
 	 */
 	protected function getExtraMethodConfig($method) {

filesystem/flysystem/AssetAdapter.php

Doc Comments +4 added lines, -1 removed lines

@@ -38,6 +38,9 @@ 
         ]
 	);
 
+	/**
+	 * @param string $root
+	 */
 	public function __construct($root = null, $writeFlags = LOCK_EX, $linkHandling = self::DISALLOW_LINKS) {
 		// Get root path
 		$root = $this->findRoot($root);
@@ -118,7 +121,7 @@ 
 	 * Render server configuration file from a template file
 	 *
 	 * @param string $template
-	 * @return DBHTMLText Rendered results
+	 * @return string Rendered results
 	 */
 	protected function renderTemplate($template) {
 		// Build allowed extensions

forms/FileField.php

Doc Comments -1 removed lines

@@ -249,7 +249,6 @@
 	 * for each of these categories
 	 *
 	 * @param string $category Category name
-	 * @param string,... $categories Additional category names
 	 * @return $this
 	 */
 	public function setAllowedFileCategories($category) {