silverstripe / silverstripe-framework

core/Convert.php

Doc Comments +4 added lines, -3 removed lines

@@ -50,7 +50,7 @@ 
 	 *
 	 * @param array|string $val String to escape, or array of strings
 	 *
-	 * @return array|string
+	 * @return string
 	 */
 	public static function raw2htmlname($val) {
 		if(is_array($val)) {
@@ -176,9 +176,9 @@ 
 	 * table, or column name. Supports encoding of multi identfiers separated by
 	 * a delimiter (e.g. ".")
 	 *
-	 * @param string|array $identifier The identifier to escape. E.g. 'SiteTree.Title'
+	 * @param string $identifier The identifier to escape. E.g. 'SiteTree.Title'
 	 * @param string $separator The string that delimits subsequent identifiers
-	 * @return string|array The escaped identifier. E.g. '"SiteTree"."Title"'
+	 * @return string The escaped identifier. E.g. '"SiteTree"."Title"'
 	 */
 	public static function symbol2sql($identifier, $separator = '.') {
 		if(is_array($identifier)) {
@@ -263,6 +263,7 @@ 
 	 * call this function directly, Please use {@link Convert::xml2array()}
 	 *
 	 * @param SimpleXMLElement
+	 * @param SimpleXMLElement $xml
 	 *
 	 * @return mixed
 	 */

core/Diff.php

Doc Comments +10 added lines, -1 removed lines

@@ -247,6 +247,10 @@ 
 	 * match.  The caller must trim matching lines from the beginning and end
 	 * of the portions it is going to specify.
 	 */
+
+	/**
+	 * @param double $nchunks
+	 */
 	public function _diag ($xoff, $xlim, $yoff, $ylim, $nchunks) {
 	$flip = false;
 
@@ -357,6 +361,11 @@ 
 	 * Note that XLIM, YLIM are exclusive bounds.
 	 * All line numbers are origin-0 and discarded lines are not counted.
 	 */
+
+	/**
+	 * @param integer $xoff
+	 * @param integer $yoff
+	 */
 	public function _compareseq ($xoff, $xlim, $yoff, $ylim) {
 	// Slide down the bottom initial diagonal.
 	while ($xoff < $xlim && $yoff < $ylim
@@ -554,7 +563,7 @@ 
 	 *
 	 *  $diff = new Diff($lines1, $lines2);
 	 *  $rev = $diff->reverse();
-	 * @return object A Diff object representing the inverse of the
+	 * @return Diff A Diff object representing the inverse of the
 	 *                original diff.
 	 */
 	public function reverse () {

core/Extension.php

Doc Comments +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
 
 	/**
 	 * Set the owner of this extension.
-	 * @param Object $owner The owner object,
+	 * @param Group $owner The owner object,
 	 * @param string $ownerBaseClass The base class that the extension is applied to; this may be
 	 * the class of owner, or it may be a parent.  For example, if Versioned was applied to SiteTree,
 	 * and then a Page object was instantiated, $owner would be a Page object, but $ownerBaseClass

core/manifest/ConfigManifest.php

Doc Comments +4 added lines, -1 removed lines

@@ -244,6 +244,9 @@ 
 	 * splt/complete before and after matchers)
 	 *
 	 * Public so that ManifestFileFinder can call it. Not for general use.
+	 * @param string $basename
+	 * @param string $pathname
+	 * @param boolean $depth
 	 */
 	public function addYAMLConfigFile($basename, $pathname, $depth) {
 		if (!preg_match('{/([^/]+)/_config/}', $pathname, $match)) return;
@@ -467,7 +470,7 @@ 
 	 * Returns false if the prefilterable parts of the rule aren't met, and true if they are
 	 *
 	 * @param  $rules array - A hash of rules as allowed in the only or except portion of a config fragment header
-	 * @return bool - True if the rules are met, false if not. (Note that depending on whether we were passed an
+	 * @return boolean|string - True if the rules are met, false if not. (Note that depending on whether we were passed an
 	 *                only or an except rule,
 	 * which values means accept or reject a fragment
 	 */

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