silverstripe / silverstripe-framework

view/ViewableData.php

Doc Comments +4 added lines, -4 removed lines

@@ -189,8 +189,6 @@ 
 	/**
 	 * Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
 	 *
-	 * @param string $field
-	 * @param array $arguments
 	 * @param string $identifier an optional custom cache identifier
 	 * @return unknown
 	 */
@@ -251,7 +249,7 @@ 
 	 *  - castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")
 	 *
 	 * @param string $field
-	 * @return array
+	 * @return string
 	 */
 	public function castingHelperPair($field) {
 		Deprecation::notice('2.5', 'use castingHelper() instead');
@@ -501,6 +499,7 @@ 
 
 	/**
 	 * Return the value of a field in an SQL-safe format.
+	 * @param string $field
 	 */
 	public function SQL_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2sql($this->RAW_val($field, $arguments, $cache));
@@ -508,6 +507,7 @@ 
 
 	/**
 	 * Return the value of a field in a JavaScript-save format.
+	 * @param string $field
 	 */
 	public function JS_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2js($this->RAW_val($field, $arguments, $cache));
@@ -515,6 +515,7 @@ 
 
 	/**
 	 * Return the value of a field escaped suitable to be inserted into an XML node attribute.
+	 * @param string $field
 	 */
 	public function ATT_val($field, $arguments = null, $cache = true) {
 		return Convert::raw2att($this->RAW_val($field, $arguments, $cache));
@@ -525,7 +526,6 @@ 
 	/**
 	 * Get an array of XML-escaped values by field name
 	 *
-	 * @param array $elements an array of field names
 	 * @return array
 	 */
 	public function getXMLValues($fields) {

admin/code/CMSForm.php

Doc Comments +1 added lines

@@ -53,6 +53,7 @@
 	 * Set actions that are exempt from validation
 	 *
 	 * @param array
+	 * @param string[] $actions
 	 */
 	public function setValidationExemptActions($actions) {
 		$this->validationExemptActions = $actions;

control/Controller.php

Doc Comments +5 added lines, -2 removed lines

@@ -322,6 +322,9 @@ 
 		return new SSViewer($templates);
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function hasAction($action) {
 		return parent::hasAction($action) || $this->hasActionTemplate($action);
 	}
@@ -385,7 +388,7 @@ 
 	 * by {@link getViewer()}.
 	 *
 	 * @param array $params Key-value array for custom template variables (Optional)
-	 * @return string Parsed template content
+	 * @return HTMLText Parsed template content
 	 */
 	public function render($params = null) {
 		$template = $this->getViewer($this->getAction());
@@ -540,7 +543,7 @@ 
 
 	/**
 	 * Tests whether a redirection has been requested.
-	 * @return string If redirect() has been called, it will return the URL redirected to.  Otherwise, it will
+	 * @return boolean If redirect() has been called, it will return the URL redirected to.  Otherwise, it will
 	 * return null;
 	 */
 	public function redirectedTo() {

control/Director.php

Doc Comments +2 added lines, -3 removed lines

@@ -463,7 +463,7 @@ 
 	/**
 	 * Returns the part of the URL, 'http://www.mysite.com'.
 	 *
-	 * @return boolean|string The domain from the PHP environment. Returns FALSE is this environment variable isn't
+	 * @return string|false The domain from the PHP environment. Returns FALSE is this environment variable isn't
 	 *                        set.
 	 */
 	public static function protocolAndHost() {
@@ -747,7 +747,6 @@ 
 	/**
 	 * Takes a $_SERVER data array and extracts HTTP request headers.
 	 *
-	 * @param  array $data
 	 * @return array
 	 */
 	public static function extract_request_headers(array $server) {
@@ -780,7 +779,7 @@ 
 
 	/**
 	 * Returns true if the given file exists.
-	 * @param $file Filename specified relative to the site root
+	 * @param string $file Filename specified relative to the site root
 	 */
 	public static function fileExists($file) {
 		// replace any appended query-strings, e.g. /path/to/foo.php?bar=1 to /path/to/foo.php

core/manifest/ConfigStaticManifest.php

Doc Comments +1 added lines

@@ -296,6 +296,7 @@
 	 *
 	 * Seperated out from parse partially so that we can recurse if there are multiple statics
 	 * being declared in a comma seperated list
+	 * @param string $class
 	 */
 	function parseStatic($access, $class) {
 		$variable = null;

dev/Deprecation.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
 	 * greater than or equal to this version, a message will be raised
 	 *
 	 * @static
-	 * @param $ver string -
+	 * @param string|null $ver string -
 	 *     A php standard version string, see http://php.net/manual/en/function.version-compare.php for details.
 	 * @param null $forModule string -
 	 *    The name of a module. The passed version will be used as the check value for

filesystem/File.php

Doc Comments +2 added lines, -2 removed lines

@@ -234,7 +234,7 @@ 
 	 * Find a File object by the given filename.
 	 *
 	 * @param String $filename Matched against the "Name" property.
-	 * @return mixed null if not found, File object of found file
+	 * @return null|DataObject null if not found, File object of found file
 	 */
 	public static function find($filename) {
 		// Get the base file if $filename points to a resampled file
@@ -449,6 +449,7 @@ 
 	 * showing icons on filelinks, etc.
 	 * Possible group values are: "audio", "mov", "zip", "image".
 	 *
+	 * @param string $ext
 	 * @return String
 	 */
 	public static function get_app_category($ext) {
@@ -872,7 +873,6 @@ 
 	/**
 	 * Convert a php.ini value (eg: 512M) to bytes
 	 *
-	 * @param string $phpIniValue
 	 * @return int
 	 */
 	public static function ini2bytes($PHPiniValue) {

forms/DateField.php

Doc Comments +8 added lines, -1 removed lines

@@ -90,6 +90,10 @@ 
 	 */
 	protected $valueObj = null;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = null) {
 		if(!$this->locale) {
 			$this->locale = i18n::get_locale();
@@ -288,6 +292,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function castedCopy($class) {
 		$copy = new $class($this->name);
 		if($copy->hasMethod('setConfig')) {
@@ -326,7 +333,7 @@ 
 	 * @deprecated 4.0 Use the "DateField.default_config" config setting instead
 	 * @param String $k
 	 * @param mixed $v
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public static function set_default_config($k, $v) {
 		Deprecation::notice('4.0', 'Use the "DateField.default_config" config setting instead');

forms/FileField.php

Doc Comments +1 added lines, -3 removed lines

@@ -85,7 +85,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return HTMLText
+	 * @return string
 	 */
 	public function Field($properties = array()) {
 		$properties = array_merge($properties, array(
@@ -148,7 +148,6 @@ 
 	/**
 	 * Get custom validator for this field
 	 *
-	 * @param Upload_Validator $validator
 	 */
 	public function getValidator() {
 		return $this->upload->getValidator();
@@ -244,7 +243,6 @@ 
 	 * for each of these categories
 	 *
 	 * @param string $category Category name
-	 * @param string,... $categories Additional category names
 	 * @return $this
 	 */
 	public function setAllowedFileCategories($category) {