silverstripe / silverstripe-framework

dev/FixtureFactory.php

Doc Comments +5 added lines, -4 removed lines

@@ -117,6 +117,7 @@ 
 	/**
 	 * Return all of the IDs in the fixture of a particular class name.
 	 * 
+	 * @param string $class
 	 * @return A map of fixture-identifier => object-id
 	 */
 	public function getIds($class) {
@@ -131,6 +132,7 @@ 
 	 * @param String 
 	 * @param String $identifier
 	 * @param Int $databaseId
+	 * @param string $class
 	 */
 	public function setId($class, $identifier, $databaseId) {
 		$this->fixtures[$class][$identifier] = $databaseId;
@@ -140,8 +142,8 @@ 
 	/**
 	 * Get an object from the fixture.
 	 * 
-	 * @param $class The data class, as specified in your fixture file.  Parent classes won't work
-	 * @param $identifier The identifier string, as provided in your fixture file
+	 * @param string $class The data class, as specified in your fixture file.  Parent classes won't work
+	 * @param string $identifier The identifier string, as provided in your fixture file
 	 */
 	public function get($class, $identifier) {
 		$id = $this->getId($class, $identifier);
@@ -161,7 +163,7 @@ 
 	 * or {@link createRaw()}, both from the internal fixture mapping and the database.
 	 * If the $class argument is set, limit clearing to items of this class.
 	 * 
-	 * @param String $class
+	 * @param string $limitToClass
 	 */
 	public function clear($limitToClass = null) {
 		$classes = ($limitToClass) ? array($limitToClass) : array_keys($this->fixtures);
@@ -202,7 +204,6 @@ 
 	 * Parse a value from a fixture file.  If it starts with => 
 	 * it will get an ID from the fixture dictionary
 	 *
-	 * @param String $fieldVal
 	 * @return String Fixture database ID, or the original value
 	 */
 	protected function parseValue($value) {

dev/FunctionalTest.php

Doc Comments +3 added lines, -3 removed lines

@@ -215,7 +215,7 @@ 
 	 * Find an attribute in a SimpleXMLElement object by name.
 	 * @param SimpleXMLElement $object
 	 * @param string $attribute Name of attribute to find
-	 * @return SimpleXMLElement object of the attribute
+	 * @return boolean object of the attribute
 	 */
 	public function findAttribute($object, $attribute) {
 		$found = false;
@@ -245,7 +245,7 @@ 
 	 * Note:   characters are stripped from the content; make sure that your assertions take this into account.
 	 *
 	 * @param string $selector A basic CSS selector, e.g. 'li.jobs h3'
-	 * @param array|string $expectedMatches The content of at least one of the matched tags
+	 * @param string[] $expectedMatches The content of at least one of the matched tags
 	 * @throws PHPUnit_Framework_AssertionFailedError
 	 * @return boolean
 	 */
@@ -342,7 +342,7 @@ 
 	 * @param string $selector A basic CSS selector, e.g. 'li.jobs h3'
 	 * @param array|string $expectedMatches The content of *all* matched tags as an array
 	 * @throws PHPUnit_Framework_AssertionFailedError
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function assertExactHTMLMatchBySelector($selector, $expectedMatches) {
 		$items = $this->cssParser()->getBySelector($selector);

dev/SapphireTestReporter.php

Doc Comments +4 added lines, -1 removed lines

@@ -319,7 +319,7 @@ 
 	 * @access private
 	 * @param obj PHPUnit_Framework_Test, current test that is being run
 	 * @param obj PHPUnit_Framework_AssertationFailedError, PHPUnit error
-	 * @return array
+	 * @return string
 	 */
 	private function getTestException(PHPUnit_Framework_Test $test, Exception $e) {
 		// get the name of the testFile from the test
@@ -406,6 +406,9 @@ 
 
 	}
 
+	/**
+	 * @param string $name
+	 */
 	protected function testNameToPhrase($name) {
 		return ucfirst(preg_replace("/([a-z])([A-Z])/", "$1 $2", $name));
 	}

dev/TestListener.php

Doc Comments +1 added lines

@@ -52,6 +52,7 @@
 
 	/**
 	 * @param String Classname
+	 * @param string $name
 	 * @return boolean
 	 */
 	protected function isValidClass($name) {

filesystem/FileNameFilter.php

Doc Comments +1 added lines, -1 removed lines

@@ -99,7 +99,7 @@
 	protected $transliterator;
 
 	/**
-	 * @return SS_Transliterator|NULL
+	 * @return SS_Transliterator
 	 */
 	public function getTransliterator() {
 		if($this->transliterator === null && $this->config()->default_use_transliterator) {

filesystem/Folder.php

Doc Comments +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
 	 * Find the given folder or create it as a database record
 	 *
 	 * @param string $folderPath Directory path relative to assets root
-	 * @return Folder|null
+	 * @return null|DataObject
 	 */
 	public static function find_or_make($folderPath) {
 		// replace leading and trailing slashes

filesystem/GDBackend.php

Doc Comments +1 added lines, -4 removed lines

@@ -184,7 +184,6 @@ 
 	 * Check if this image has previously crashed GD when attempting to open it - if it's opened
 	 * successfully, the manipulation's cache key is removed.
 	 *
-	 * @param string $args,... Any number of args that identify this image
 	 * @return bool True if failed
 	 */
 	public function failedResample() {
@@ -195,7 +194,6 @@ 
 	/**
 	 * Mark a file as failed
 	 *
-	 * @param string $args,... Any number of args that identify this image
 	 */
 	protected function markFailed() {
 		$key = sha1(implode('|', func_get_args()));
@@ -205,7 +203,6 @@ 
 	/**
 	 * Mark a file as succeeded
 	 *
-	 * @param string $args,... Any number of args that identify this image
 	 */
 	protected function markSucceeded() {
 		$key = sha1(implode('|', func_get_args()));
@@ -347,7 +344,7 @@ 
 	 * using built-in function. Used when imagerotate function is not available(i.e. Ubuntu)
 	 *
 	 * @param float $angle Angle in degrees
-	 * @return static
+	 * @return null|resource
 	 */
 	public function rotatePixelByPixel($angle) {
 		if(!$this->gd) {

filesystem/ImageManipulation.php

Doc Comments +1 added lines, -1 removed lines

@@ -509,7 +509,7 @@
 	/**
 	 * Get HTML for img containing the icon for this file
 	 *
-	 * @return type
+	 * @return DBField
 	 */
 	public function IconTag() {
 		return DBField::create_field(

forms/AssetField.php

Doc Comments +4 added lines, -1 removed lines

@@ -144,7 +144,6 @@ 
 	 *
 	 * @param string $name The internal field name, passed to forms.
 	 * @param string $title The field label.
-	 * @param Form $form Reference to the container form
 	 */
 	public function __construct($name, $title = null) {
 		$this->addExtraClass('ss-upload'); // class, used by js
@@ -256,6 +255,10 @@ 
 		return $this->record;
 	}
 
+	/**
+	 * @param null|DataObject $value
+	 * @param DataObject $record
+	 */
 	public function setValue($value, $record = null) {
 		// Extract value from underlying record
 		if(empty($value) && $this->getName() && $record instanceof DataObject) {