silverstripe / silverstripe-framework

Core/Config/Config.php

Doc Comments +7 added lines, -1 removed lines

@@ -483,11 +483,17 @@ 
 
 	protected $extraConfigSources = array();
 
+	/**
+	 * @param string $class
+	 */
 	public function extraConfigSourcesChanged($class) {
 		unset($this->extraConfigSources[$class]);
 		$this->cache->clean("__{$class}");
 	}
 
+	/**
+	 * @param integer $sourceOptions
+	 */
 	protected function getUncached($class, $name, $sourceOptions, &$result, $suppress, &$tags) {
 		$tags[] = "__{$class}";
 		$tags[] = "__{$class}__{$name}";
@@ -575,7 +581,7 @@ 
 	 * caching heavily here.
 	 *
 	 * @param $class string - The name of the class to get the value for
-	 * @param $name string - The property to get the value for
+	 * @param string $name string - The property to get the value for
 	 * @param int $sourceOptions Bitmask which can be set to some combintain of Config::UNINHERITED,
 	 *                           Config::FIRST_SET, and Config::EXCLUDE_EXTENSIONS.
 	 *

Core/Convert.php

Doc Comments +5 added lines, -4 removed lines

@@ -50,9 +50,9 @@ 
 	 *
 	 * @see http://www.w3.org/TR/REC-html40/types.html#type-cdata
 	 *
-	 * @param array|string $val String to escape, or array of strings
+	 * @param string $val String to escape, or array of strings
 	 *
-	 * @return array|string
+	 * @return string
 	 */
 	public static function raw2htmlname($val) {
 		if(is_array($val)) {
@@ -178,7 +178,7 @@ 
 	 * 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' or list of identifiers
+	 * @param string $identifier The identifier to escape. E.g. 'SiteTree.Title' or list of identifiers
 	 * to be joined via the separator.
 	 * @param string $separator The string that delimits subsequent identifiers
 	 * @return string The escaped identifier. E.g. '"SiteTree"."Title"'
@@ -263,6 +263,7 @@ 
 	 * call this function directly, Please use {@link Convert::xml2array()}
 	 *
 	 * @param SimpleXMLElement
+	 * @param SimpleXMLElement $xml
 	 *
 	 * @return mixed
 	 */
@@ -456,7 +457,7 @@ 
 	 * - IDField => idField
 	 * - iDField => iDField
 	 *
-	 * @param $str
+	 * @param string $str
 	 * @return string
 	 */
 	public static function upperCamelToLowerCamel($str) {

Core/Core.php

Doc Comments +4 added lines, -1 removed lines

@@ -161,6 +161,9 @@ 
 	return Injector::inst()->get($className);
 }
 
+/**
+ * @return string
+ */
 function project() {
 	global $project;
 	return $project;
@@ -184,7 +187,7 @@ 
  * Only increases up to the maximum defined in {@link set_increase_memory_limit_max()},
  * and defaults to the 'memory_limit' setting in the PHP configuration.
  *
- * @param string|int $memoryLimit A memory limit string, such as "64M".  If omitted, unlimited memory will be set.
+ * @param integer $memoryLimit A memory limit string, such as "64M".  If omitted, unlimited memory will be set.
  * @return Boolean TRUE indicates a successful change, FALSE a denied change.
  */
 function increase_memory_limit_to($memoryLimit = -1) {

Core/CustomMethods.php

Doc Comments +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
 	/**
 	 * Get meta-data details on a named method
 	 *
-	 * @param array $method
+	 * @param string $method
 	 * @return array List of custom method details, if defined for this method
 	 */
 	protected function getExtraMethodConfig($method) {

Core/Extensible.php

Doc Comments +1 added lines, -1 removed lines

@@ -379,7 +379,7 @@
 	 * @param string $method the method name to call
 	 * @param mixed $a1
 	 * @param mixed $a2
-	 * @param mixed $a3
+	 * @param boolean $a3
 	 * @param mixed $a4
 	 * @param mixed $a5
 	 * @param mixed $a6

Core/Injector/Injector.php

Doc Comments +2 added lines, -2 removed lines

@@ -357,7 +357,7 @@ 
 	 *
 	 * @param string $property
 	 *                the name of the property
-	 * @param object $object
+	 * @param string $object
 	 *                the object to be set
 	 * @return $this
 	 */
@@ -451,7 +451,7 @@ 
 	 *				The name of the service to update the definition for
 	 * @param string $property
 	 *				The name of the property to update.
-	 * @param mixed $value
+	 * @param string $value
 	 *				The value to set
 	 * @param boolean $append
 	 *				Whether to append (the default) when the property is an array

Core/Manifest/ClassManifest.php

Doc Comments +1 added lines, -1 removed lines

@@ -235,7 +235,7 @@
 	 * Returns an array containing all the descendants (direct and indirect)
 	 * of a class.
 	 *
-	 * @param  string|object $class
+	 * @param  string $class
 	 * @return array
 	 */
 	public function getDescendantsOf($class) {

Core/Manifest/ConfigManifest.php

Doc Comments +1 added lines, -1 removed lines

@@ -500,7 +500,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/Startup/ErrorControlChain.php

Doc Comments +2 added lines, -2 removed lines

@@ -100,7 +100,7 @@ 
 	/**
 	 * Get value of display_errors ini value
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	protected function getDisplayErrors() {
 		return ini_get('display_errors');
@@ -110,7 +110,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
 	 */