sminnee / silverstripe-framework

api/RestfulService.php

Doc Comments +2 added lines, -2 removed lines

@@ -335,8 +335,8 @@
 	/**
 	 * Extracts the response body and headers from a full curl response
 	 *
-	 * @param curl_handle $ch The curl handle for the request
-	 * @param string $rawResponse The raw response text
+	 * @param resource $ch The curl handle for the request
+	 * @param string $rawHeaders
 	 *
 	 * @return RestfulService_Response The response object
 	 */

cache/CacheProxy.php

Doc Comments +12 added lines

@@ -42,6 +42,9 @@ 
         $this->cache->setOption($name, $value);
     }
 
+    /**
+     * @param string $name
+     */
     public function getOption($name) {
         return $this->cache->getOption($name);
     }
@@ -82,6 +85,9 @@ 
         return $this->cache->touch($this->getKeyID($id), $extraLifetime);
     }
 
+    /**
+     * @return string
+     */
     public function load($id, $doNotTestCacheValidity = false, $doNotUnserialize = false) {
         return $this->cache->load($this->getKeyID($id), $doNotTestCacheValidity, $doNotUnserialize);
     }
@@ -90,6 +96,9 @@ 
         return $this->cache->test($this->getKeyID($id));
     }
 
+    /**
+     * @param string $data
+     */
     public function save($data, $id = null, $tags = array(), $specificLifetime = false, $priority = 8) {
         return $this->cache->save(
             $data,
@@ -100,6 +109,9 @@ 
         );
     }
 
+    /**
+     * @param string $id
+     */
     public function remove($id) {
         return $this->cache->remove($this->getKeyID($id));
     }

control/CookieJar.php

Doc Comments +2 added lines, -2 removed lines

@@ -144,13 +144,13 @@
 	 * @see http://uk3.php.net/manual/en/function.setcookie.php
 	 *
 	 * @param string $name The name of the cookie
-	 * @param string|array|false $value The value for the cookie to hold
+	 * @param false|string $value The value for the cookie to hold
 	 * @param int $expiry The number of days until expiry
 	 * @param string $path The path to save the cookie on (falls back to site base)
 	 * @param string $domain The domain to make the cookie available on
 	 * @param boolean $secure Can the cookie only be sent over SSL?
 	 * @param boolean $httpOnly Prevent the cookie being accessible by JS
-	 * @return boolean If the cookie was set or not; doesn't mean it's accepted by the browser
+	 * @return boolean|null If the cookie was set or not; doesn't mean it's accepted by the browser
 	 */
 	protected function outputCookie(
 		$name, $value, $expiry = 90, $path = null, $domain = null, $secure = false, $httpOnly = true

control/HTTP.php

Doc Comments +10 added lines, -2 removed lines

@@ -282,6 +282,9 @@ 
 		return count($result) ? $result : null;
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public static function getLinksIn($content) {
 		return self::findByTagAndAttribute($content, array("a" => "href"));
 	}
@@ -338,11 +341,17 @@ 
 			self::$modification_date = $timestamp;
 	}
 
+	/**
+	 * @param integer $timestamp
+	 */
 	public static function register_modification_timestamp($timestamp) {
 		if($timestamp > self::$modification_date)
 			self::$modification_date = $timestamp;
 	}
 
+	/**
+	 * @param string $etag
+	 */
 	public static function register_etag($etag) {
 		if (0 !== strpos($etag, '"')) {
 			$etag = sprintf('"%s"', $etag);
@@ -507,7 +516,7 @@ 
 	}
 
 	/**
-	 * @param SS_HTTPResponse|string $response
+	 * @param SS_HTTPResponse|null $response
 	 *
 	 * @return string|false
 	 */
@@ -549,7 +558,6 @@ 
 	/**
 	 * Combine vary strings
 	 *
-	 * @param string $vary,... Each vary as a separate arg
 	 * @return string
 	 */
 	protected static function combineVary($vary)

control/RequestHandler.php

Doc Comments +6 added lines, -1 removed lines

@@ -129,6 +129,7 @@ 
 
 	/**
 	 * Set the DataModel for this request.
+	 * @param DataModel $model
 	 */
 	public function setDataModel($model) {
 		$this->model = $model;
@@ -246,6 +247,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	protected function findAction($request) {
 		$handlerClass = ($this->class) ? $this->class : get_class($this);
 
@@ -392,6 +396,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);
@@ -500,6 +505,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;
@@ -508,7 +514,6 @@ 
 	/**
 	 * Returns a link to this controller.  Overload with your own Link rules if they exist.
 	 *
-	 * @param string $action Optional action (soft-supported via func_get_args)
 	 * @return string
 	 */
 	public function Link() {

control/Session.php

Doc Comments +3 added lines, -1 removed lines

@@ -265,7 +265,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');
@@ -462,6 +461,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/Config.php

Doc Comments +24 added lines, -1 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}";
@@ -604,7 +610,7 @@ 
 	 *
 	 * @param string $class The class to update a configuration value for
 	 * @param string $name  The configuration property name to update
-	 * @param mixed $value The value to update with
+	 * @param mixed $val The value to update with
 	 *
 	 * Arrays are recursively merged into current configuration as "latest" - for associative arrays the passed value
 	 * replaces any item with the same key, for sequential arrays the items are placed at the end of the array, for
@@ -728,6 +734,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;
@@ -796,6 +806,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $tag
+	 */
 	public function clean($tag = null) {
 		if ($tag) {
 			foreach ($this->cache as $i => $v) {
@@ -827,6 +840,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])) {
@@ -845,6 +862,9 @@ 
 		return $this->miss ? ($this->hit / $this->miss) : 0;
 	}
 
+	/**
+	 * @param integer $key
+	 */
 	public function get($key) {
 		list($hit, $result) = $this->checkAndGet($key);
 		return $hit ? $result : false;
@@ -864,6 +884,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $tag
+	 */
 	public function clean($tag = null) {
 		if($tag) {
 			if(isset($this->tags[$tag])) {

core/Object.php

Doc Comments +8 added lines, -9 removed lines

@@ -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() {
@@ -334,8 +331,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() {
@@ -387,8 +382,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
@@ -955,6 +950,7 @@ 
 
 	/**
 	 * @see SS_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);
@@ -962,6 +958,8 @@ 
 
 	/**
 	 * @see SS_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);
@@ -969,6 +967,7 @@ 
 
 	/**
 	 * @see SS_Object::uninherited_static()
+	 * @param string $name
 	 */
 	public function uninherited($name) {
 		return Config::inst()->get(($this->class ? $this->class : get_class($this)), $name, Config::UNINHERITED);
@@ -1019,7 +1018,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
 	 */
@@ -1045,7 +1044,7 @@ 
 	 * @param mixed $a1
 	 * @param mixed $a2
 	 * @param mixed $a3
-	 * @param mixed $a4
+	 * @param DataObject $a4
 	 * @param mixed $a5
 	 * @param mixed $a6
 	 * @param mixed $a7

dev/Backtrace.php

Doc Comments +2 added lines, -2 removed lines

@@ -115,7 +115,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);
@@ -132,7 +132,7 @@ 
 	 * shown
 	 *
 	 * @param SS_Object $item
-	 * @param boolean $showArg
+	 * @param boolean $showArgs
 	 * @param Int $argCharLimit
 	 * @return String
 	 */