sminnee / 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/Object.php

Doc Comments +8 added lines, -10 removed lines

@@ -55,7 +55,7 @@ 
 
 	/**
 	 * Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
-	 * @return Config_ForClass|null
+	 * @return Config_ForClass
 	 */
 	static public function config() {
 		return Config::inst()->forClass(get_called_class());
@@ -125,8 +125,6 @@ 
 	 *    $list = DataList::create('SiteTree');
 	 *	  $list = SiteTree::get();
 	 *
-	 * @param string $class the class name
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return static
 	 */
 	public static function create() {
@@ -149,7 +147,6 @@ 
 	 * way to access instance methods which don't rely on instance
 	 * data (e.g. the custom SilverStripe static handling).
 	 *
-	 * @param string $className Optional classname (if called on Object directly)
 	 * @return static The singleton instance
 	 */
 	public static function singleton() {
@@ -297,8 +294,6 @@ 
 	 * Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to
 	 * TRUE when using {@link Object::useCustomClass()}
 	 *
-	 * @param string $class the class name
-	 * @param mixed $arguments,... arguments to pass to the constructor
 	 * @return static
 	 */
 	public static function strong_create() {
@@ -350,8 +345,8 @@ 
 	 * without any inheritance, merging or parent lookup if it doesn't exist on the given class.
 	 *
 	 * @static
-	 * @param $class - The class to get the static from
-	 * @param $name - The property to get from the class
+	 * @param string $class - The class to get the static from
+	 * @param string $name - The property to get from the class
 	 * @param null $default - The value to return if property doesn't exist on class
 	 * @return any - The value of the static property $name on class $class, or $default if that property is not
 	 *               defined
@@ -823,6 +818,7 @@ 
 
 	/**
 	 * @see Object::get_static()
+	 * @param string $name
 	 */
 	public function stat($name, $uncached = false) {
 		return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::FIRST_SET);
@@ -830,6 +826,8 @@ 
 
 	/**
 	 * @see Object::set_static()
+	 * @param string $name
+	 * @param string $value
 	 */
 	public function set_stat($name, $value) {
 		Config::inst()->update(($this->class ? $this->class : get_class($this)), $name, $value);
@@ -837,6 +835,7 @@ 
 
 	/**
 	 * @see Object::uninherited_static()
+	 * @param string $name
 	 */
 	public function uninherited($name) {
 		return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::UNINHERITED);
@@ -887,7 +886,7 @@ 
 	 * all results into an array
 	 *
 	 * @param string $method the method name to call
-	 * @param mixed $argument a single argument to pass
+	 * @param string $argument a single argument to pass
 	 * @return mixed
 	 * @todo integrate inheritance rules
 	 */
@@ -910,7 +909,6 @@ 
 	 * The extension methods are defined during {@link __construct()} in {@link defineMethods()}.
 	 *
 	 * @param string $method the name of the method to call on each extension
-	 * @param mixed $a1,... up to 7 arguments to be passed to the method
 	 * @return array
 	 */
 	public function extend($method, &$a1=null, &$a2=null, &$a3=null, &$a4=null, &$a5=null, &$a6=null, &$a7=null) {

core/startup/ErrorControlChain.php

Doc Comments +4 added lines, -1 removed lines

@@ -67,6 +67,9 @@ 
 		$this->error = (bool)$error;
 	}
 
+	/**
+	 * @param boolean $suppression
+	 */
 	public function setSuppression($suppression) {
 		$this->suppression = (bool)$suppression;
 		if ($this->handleFatalErrors) ini_set('display_errors', !$suppression);
@@ -76,7 +79,7 @@ 
 	 * Add this callback to the chain of callbacks to call along with the state
 	 * that $error must be in this point in the chain for the callback to be called
 	 *
-	 * @param $callback - The callback to call
+	 * @param callable $callback - The callback to call
 	 * @param $onErrorState - false if only call if no errors yet, true if only call if already errors, null for either
 	 * @return $this
 	 */

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/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/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
 	 */