silverstripe / silverstripe-framework

core/manifest/ManifestCache.php

Doc Comments +12 added lines

@@ -7,9 +7,21 @@
  * @subpackage manifest
  */
 interface ManifestCache {
+
+	/**
+	 * @return void
+	 */
 	public function __construct($name);
 	public function load($key);
+
+	/**
+	 * @return void
+	 */
 	public function save($data, $key);
+
+	/**
+	 * @return void
+	 */
 	public function clear();
 }
 

core/startup/ParameterConfirmationToken.php

Doc Comments +4 added lines, -1 removed lines

@@ -36,6 +36,9 @@ 
 	 */
 	protected $token = null;
 
+	/**
+	 * @param string $token
+	 */
 	protected function pathForToken($token) {
 		return TEMP_FOLDER.'/token_'.preg_replace('/[^a-z0-9]+/', '', $token);
 	}
@@ -235,7 +238,7 @@ 
 	 * Given a list of token names, suppress all tokens that have not been validated, and
 	 * return the non-validated token with the highest priority
 	 *
-	 * @param array $keys List of token keys in ascending priority (low to high)
+	 * @param string[] $keys List of token keys in ascending priority (low to high)
 	 * @return ParameterConfirmationToken The token container for the unvalidated $key given with the highest priority
 	 */
 	public static function prepare_tokens($keys) {

core/TempPath.php

Doc Comments +1 added lines, -1 removed lines

@@ -5,7 +5,7 @@
  * @package framework
  * @subpackage core
  *
- * @param $base The base path to use for determining the temporary path
+ * @param string $base The base path to use for determining the temporary path
  * @return string Path to temp
  */
 function getTempFolder($base = null) {

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

Doc Comments +1 added lines, -1 removed lines

@@ -93,7 +93,7 @@
 	 * @param string $path Path to large file to split
 	 * @param int $lines Number of lines per file
 	 *
-	 * @return array List of file paths
+	 * @return string[] List of file paths
 	 */
 	protected function splitFile($path, $lines = null) {
 		$previous = ini_get('auto_detect_line_endings');

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