silverstripe / silverstripe-framework

control/RequestHandler.php

Doc Comments +6 added lines

@@ -121,6 +121,7 @@ 
 
 	/**
 	 * Set the DataModel for this request.
+	 * @param DataModel $model
 	 */
 	public function setDataModel($model) {
 		$this->model = $model;
@@ -238,6 +239,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	protected function findAction($request) {
 		$handlerClass = ($this->class) ? $this->class : get_class($this);
 
@@ -384,6 +388,7 @@ 
 
 	/**
 	 * Return the class that defines the given action, so that we know where to check allowed_actions.
+	 * @return string|null
 	 */
 	protected function definingClassForAction($actionOrigCasing) {
 		$action = strtolower($actionOrigCasing);
@@ -492,6 +497,7 @@ 
 	 * or {@link handleRequest()}, but in some based we want to set it manually.
 	 *
 	 * @param SS_HTTPRequest
+	 * @param SS_HTTPRequest $request
 	 */
 	public function setRequest($request) {
 		$this->request = $request;

control/Session.php

Doc Comments +6 added lines, -1 removed lines

@@ -273,7 +273,6 @@ 
 	 *
 	 * @deprecated 4.0 Use the "Session.timeout_ips" config setting instead
 	 *
-	 * @param array $session_ips Array of IPv4 rules.
 	 */
 	public static function set_timeout_ips($ips) {
 		Deprecation::notice('4.0', 'Use the "Session.timeout_ips" config setting instead');
@@ -410,6 +409,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function inst_set($name, $val) {
 		// Quicker execution path for "."-free names
 		if(strpos($name, '.') === false) {
@@ -458,6 +460,9 @@ 
 		$diffVar[sizeof($var)-1] = $val;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function inst_get($name) {
 		// Quicker execution path for "."-free names
 		if(strpos($name, '.') === false) {

core/ArrayLib.php

Doc Comments +1 added lines, -1 removed lines

@@ -168,7 +168,7 @@
 	 *
 	 * Actually only one array argument is supported.
 	 *
-	 * @param $f callback to apply
+	 * @param string $f callback to apply
 	 * @param $array array
 	 * @return array
 	 */

core/Config.php

Doc Comments +26 added lines, -9 removed lines

@@ -470,11 +470,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}";
@@ -647,15 +653,6 @@ 
 	 *
 	 * @param string $class The class to remove a configuration value from
 	 * @param string $name The configuration name
-	 * @param mixed $key An optional key to filter against.
-	 *   If referenced config value is an array, only members of that array that match this key will be removed
-	 *   Must also match value if provided to be removed
-	 * @param mixed $value And optional value to filter against.
-	 *   If referenced config value is an array, only members of that array that match this value will be removed
-	 *   If referenced config value is not an array, value will be removed only if it matches this argument
-	 *   Must also match key if provided and referenced config value is an array to be removed
-	 *
-	 * Matching is always by "==", not by "==="
 	 */
 	public function remove($class, $name /*,$key = null*/ /*,$value = null*/) {
 		$argc = func_num_args();
@@ -734,6 +731,10 @@ 
 		$this->cache = $cloned;
 	}
 
+	/**
+	 * @param integer $key
+	 * @param integer $val
+	 */
 	public function set($key, $val, $tags = array()) {
 		// Find an index to set at
 		$replacing = null;
@@ -769,6 +770,9 @@ 
 		return $this->miss ? ($this->hit / $this->miss) : 0;
 	}
 
+	/**
+	 * @param integer $key
+	 */
 	public function get($key) {
 		if (isset($this->indexing[$key])) {
 			$this->hit++;
@@ -782,6 +786,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $tag
+	 */
 	public function clean($tag = null) {
 		if ($tag) {
 			foreach ($this->cache as $i => $v) {
@@ -813,6 +820,10 @@ 
 		$this->cache = array();
 	}
 
+	/**
+	 * @param integer $key
+	 * @param integer $val
+	 */
 	public function set($key, $val, $tags = array()) {
 		foreach($tags as $t) {
 			if(!isset($this->tags[$t])) {
@@ -831,6 +842,9 @@ 
 		return $this->miss ? ($this->hit / $this->miss) : 0;
 	}
 
+	/**
+	 * @param integer $key
+	 */
 	public function get($key) {
 		if(isset($this->cache[$key])) {
 			++$this->hit;
@@ -841,6 +855,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $tag
+	 */
 	public function clean($tag = null) {
 		if($tag) {
 			if(isset($this->tags[$tag])) {

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