sminnee / silverstripe-framework

model/fieldtypes/PrimaryKey.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
 
 	/**
 	 * @param string $name
-	 * @param DataOject $object The object that this is primary key for (should have a relation with $name)
+	 * @param DataObject $object The object that this is primary key for (should have a relation with $name)
 	 */
 	public function __construct($name = null, $object) {
 		$this->object = $object;

model/Image_Backend.php

Doc Comments +2 added lines, -2 removed lines

@@ -71,8 +71,8 @@
 	/**
 	 * resizeRatio
 	 *
-	 * @param int $width
-	 * @param int $height
+	 * @param integer $maxWidth
+	 * @param integer $maxHeight
 	 * @return Image_Backend
 	 */
 	public function resizeRatio($maxWidth, $maxHeight, $useAsMinimum = false);

model/queries/SQLQuery.php

Doc Comments +4 added lines

@@ -33,6 +33,7 @@ 
 
 	/**
 	 * @deprecated since version 4.0
+	 * @param boolean $value
 	 */
 	public function setDelete($value) {
 		Deprecation::notice('4.0', 'SQLQuery::setDelete is deprecated. Use toDelete instead');
@@ -47,6 +48,9 @@ 
 		return $this->isDelete;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function sql(&$parameters = array()) {
 		return $this->toAppropriateExpression()->sql($parameters);
 	}

search/filters/SearchFilter.php

Doc Comments +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
 	 *  column. Can contain a relation name in dot notation, which will automatically join
 	 *  the necessary tables (e.g. "Comments.Name" to join the "Comments" has-many relationship and
 	 *  search the "Name" column when applying this filter to a SiteTree class).
-	 * @param mixed $value
+	 * @param boolean|string $value
 	 * @param array $modifiers
 	 */
 	public function __construct($fullName, $value = false, array $modifiers = array()) {
@@ -287,7 +287,7 @@ 
 	/**
 	 * Determines case sensitivity based on {@link getModifiers()}.
 	 *
-	 * @return Mixed TRUE or FALSE to enforce sensitivity, NULL to use field collation.
+	 * @return boolean|null TRUE or FALSE to enforce sensitivity, NULL to use field collation.
 	 */
 	protected function getCaseSensitive() {
 		$modifiers = $this->getModifiers();

tests/filesystem/UploadTest.php

Doc Comments +4 added lines

@@ -304,6 +304,10 @@
 	// Delete files in the default uploads directory that match the name pattern.
 	// @param String $namePattern	A regular expression applied to files in the directory. If the name matches
 	// the pattern, it is deleted. Directories, . and .. are excluded.
+
+	/**
+	 * @param string $namePattern
+	 */
 	public function deleteTestUploadFiles($namePattern) {
 		$tmpFolder = ASSETS_PATH . "/" . Config::inst()->get('Upload', 'uploads_folder');
 		$files = scandir($tmpFolder);

tests/forms/HtmlEditorFieldToolbarTest.php

Doc Comments +6 added lines

@@ -5,10 +5,16 @@
 		return parent::viewfile_getLocalFileByID($id);
 	}
 
+	/**
+	 * @param string $fileUrl
+	 */
 	public function viewfile_getLocalFileByURL($fileUrl) {
 		return parent::viewfile_getLocalFileByURL($fileUrl);
 	}
 
+	/**
+	 * @param string $fileUrl
+	 */
 	public function viewfile_getRemoteFileByURL($fileUrl) {
 		return parent::viewfile_getRemoteFileByURL($fileUrl);
 	}

tests/view/SSViewerTest.php

Doc Comments +13 added lines

@@ -119,6 +119,10 @@ 
 		));
 	}
 
+	/**
+	 * @param HTMLText $result
+	 * @param string[] $expected
+	 */
 	private function assertExpectedStrings($result, $expected) {
 		foreach ($expected as $expectedStr) {
 			$this->assertTrue(
@@ -739,6 +743,10 @@ 
 		$this->assertEquals('A A1 A1 i A1 ii A2 A3', $rationalisedResult);
 	}
 
+	/**
+	 * @param string $a
+	 * @param string $b
+	 */
 	public function assertEqualIgnoringWhitespace($a, $b) {
 		$this->assertEquals(preg_replace('/\s+/', '', $a), preg_replace('/\s+/', '', $b));
 	}
@@ -1353,6 +1361,11 @@ 
 		Config::inst()->update('SSViewer', 'source_file_comments', false);
 		Config::inst()->update('Director', 'environment_type', $origEnv);
 	}
+
+	/**
+	 * @param string $name
+	 * @param string $expected
+	 */
 	private function _renderWithSourceFileComments($name, $expected) {
 		$viewer = new SSViewer(array($name));
 		$data = new ArrayData(array());

view/Requirements.php

Doc Comments +6 added lines, -4 removed lines

@@ -49,6 +49,7 @@ 
 	 * while automatically busting this cache every time the file is changed.
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public static function set_suffix_requirements($var) {
 		self::backend()->set_suffix_requirements($var);
@@ -109,7 +110,7 @@ 
 	/**
 	 * Return all registered custom scripts
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public static function get_custom_scripts() {
 		return self::backend()->get_custom_scripts();
@@ -517,7 +518,7 @@ 
 	/**
 	 * Enable or disable the combination of CSS and JavaScript files
 	 *
-	 * @param $enable
+	 * @param boolean $enable
 	 */
 	public function set_combined_files_enabled($enable) {
 		$this->combined_files_enabled = (bool) $enable;
@@ -585,6 +586,7 @@ 
 	 * Forces the JavaScript requirements to the end of the body, right before the closing tag
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public function set_force_js_to_bottom($var) {
 		$this->force_js_to_bottom = $var;
@@ -624,7 +626,7 @@ 
 	/**
 	 * Return all registered custom scripts
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function get_custom_scripts() {
 		$requirements = "";
@@ -1037,7 +1039,7 @@ 
 	 * @param array  $files            Array of filenames relative to docroot
 	 * @param string $media
 	 *
-	 * @return bool|void
+	 * @return false|null
 	 */
 	public function combine_files($combinedFileName, $files, $media = null) {
 		// duplicate check

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
 	 */
@@ -252,7 +250,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');
@@ -504,6 +502,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));
@@ -511,6 +510,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));
@@ -518,6 +518,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));
@@ -528,7 +529,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) {