silverstripe / silverstripe-framework

dev/Backtrace.php

Doc Comments +2 added lines, -2 removed lines

@@ -114,7 +114,7 @@ 
 	 *
 	 * @param unknown_type $returnVal
 	 * @param unknown_type $ignoreAjax
-	 * @return unknown
+	 * @return string|null
 	 */
 	public static function backtrace($returnVal = false, $ignoreAjax = false, $ignoredFunctions = null) {
 		$plainText = Director::is_cli() || (Director::is_ajax() && !$ignoreAjax);
@@ -131,7 +131,7 @@ 
 	 * shown
 	 *
 	 * @param Object $item
-	 * @param boolean $showArg
+	 * @param boolean $showArgs
 	 * @param Int $argCharLimit
 	 * @return String
 	 */

dev/BulkLoader.php

Doc Comments +4 added lines, -4 removed lines

@@ -211,7 +211,7 @@ 
 	 *
 	 * @todo Mix in custom column mappings
 	 *
-	 * @return array
+	 * @return string
 	 **/
 	public function getImportSpec() {
 		$spec = array();
@@ -237,7 +237,7 @@ 
 	 * so this is mainly a customization method.
 	 *
 	 * @param mixed $val
-	 * @param string $field Name of the field as specified in the array-values for {@link self::$columnMap}.
+	 * @param string $fieldName Name of the field as specified in the array-values for {@link self::$columnMap}.
 	 * @return boolean
 	 */
 	protected function isNullValue($val, $fieldName = null) {
@@ -357,7 +357,7 @@ 
 
 	/**
 	 * @param $obj DataObject
-	 * @param $message string
+	 * @param string $message string
 	 */
 	public function addCreated($obj, $message = null) {
 		$this->created[] = $this->lastChange = array(
@@ -370,7 +370,7 @@ 
 
 	/**
 	 * @param $obj DataObject
-	 * @param $message string
+	 * @param string $message string
 	 */
 	public function addUpdated($obj, $message = null) {
 		$this->updated[] = $this->lastChange = array(

dev/CSVParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
 	 *
 	 * You can use the object returned in a foreach loop to extract the data.
 	 *
-	 * @param $filename The name of the file.  If relative, it will be relative to the site's base dir
+	 * @param string $filename The name of the file.  If relative, it will be relative to the site's base dir
 	 * @param $delimiter The character for seperating columns
 	 * @param $enclosure The character for quoting or enclosing columns
 	 */

dev/FixtureBlueprint.php

Doc Comments +6 added lines, -1 removed lines

@@ -253,6 +253,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $type
+	 */
 	protected function invokeCallbacks($type, $args = array()) {
 		foreach($this->callbacks[$type] as $callback) {
 			call_user_func_array($callback, $args);
@@ -263,7 +266,6 @@ 
 	 * Parse a value from a fixture file.  If it starts with =>
 	 * it will get an ID from the fixture dictionary
 	 *
-	 * @param string $fieldVal
 	 * @param array $fixtures See {@link createObject()}
 	 * @param string $class If the value parsed is a class relation, this parameter
 	 * will be given the value of that class's name
@@ -292,6 +294,9 @@ 
 		$obj->$name = $this->parseValue($value, $fixtures);
 	}
 
+	/**
+	 * @param string $fieldName
+	 */
 	protected function overrideField($obj, $fieldName, $value, $fixtures = null) {
 		$table = ClassInfo::table_for_object_field(get_class($obj), $fieldName);
 		$value = $this->parseValue($value, $fixtures);

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

Doc Comments +9 added lines, -7 removed lines

@@ -142,6 +142,7 @@ 
 
 	/**
 	 * Set the manifest to be used to look up test classes by helper functions
+	 * @param SS_ClassManifest $manifest
 	 */
 	public static function set_test_class_manifest($manifest) {
 		self::$test_class_manifest = $manifest;
@@ -398,7 +399,7 @@ 
 	/**
 	 * Get the ID of an object from the fixture.
 	 *
-	 * @param $className The data class, as specified in your fixture file.  Parent classes won't work
+	 * @param string $className 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
 	 * @return int
 	 */
@@ -421,7 +422,7 @@ 
 	 * Will collate all IDs form all fixtures if multiple fixtures are provided.
 	 *
 	 * @param string $className
-	 * @return array A map of fixture-identifier => object-id
+	 * @return A A map of fixture-identifier => object-id
 	 */
 	protected function allFixtureIDs($className) {
 		return $this->getFixtureFactory()->getIds($className);
@@ -578,7 +579,7 @@ 
 	/**
 	 * Assert that the matching email was sent since the last call to clearEmails()
 	 * All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
-	 * @param $to
+	 * @param string $to
 	 * @param $from
 	 * @param $subject
 	 * @param $content
@@ -742,7 +743,7 @@ 
 	 * @param string $expectedSQL
 	 * @param string $actualSQL
 	 * @param string $message
-	 * @param float $delta
+	 * @param integer $delta
 	 * @param integer $maxDepth
 	 * @param boolean $canonicalize
 	 * @param boolean $ignoreCase
@@ -941,6 +942,7 @@ 
 	/**
 	 * Create a member and group with the given permission code, and log in with it.
 	 * Returns the member ID.
+	 * @return integer
 	 */
 	public function logInWithPermission($permCode = "ADMIN") {
 		if(!isset($this->cache_generatedMembers[$permCode])) {
@@ -980,9 +982,9 @@ 
 	/**
 	 * Test against a theme.
 	 *
-	 * @param $themeBaseDir string - themes directory
-	 * @param $theme string - theme name
-	 * @param $callback Closure
+	 * @param string $themeBaseDir string - themes directory
+	 * @param string $theme string - theme name
+	 * @param Closure $callback Closure
 	 */
 	protected function useTestTheme($themeBaseDir, $theme, $callback) {
 		Config::nest();

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) {