sminnee / silverstripe-framework

admin/code/GroupImportForm.php

Doc Comments +4 added lines

@@ -14,6 +14,10 @@
 	 */
 	protected $group;
 
+	/**
+	 * @param SecurityAdmin $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name, $fields = null, $actions = null, $validator = null) {
 		if(!$fields) {
 			$helpHtml = _t(

control/ContentNegotiator.php

Doc Comments +1 added lines

@@ -109,6 +109,7 @@
 	/**
 	 * Returns true if negotiation is enabled for the given response. By default, negotiation is only
 	 * enabled for pages that have the xml header.
+	 * @param SS_HTTPResponse $response
 	 */
 	public static function enabled_for($response) {
 		$contentType = $response->getHeader("Content-Type");

control/CookieJar.php

Doc Comments +2 added lines, -2 removed lines

@@ -146,13 +146,13 @@
 	 * @see http://uk3.php.net/manual/en/function.setcookie.php
 	 *
 	 * @param string $name The name of the cookie
-	 * @param string|array $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/Director.php

Doc Comments +3 added lines, -3 removed lines

@@ -534,7 +534,7 @@ 
 	 * Returns the domain part of the URL 'http://www.mysite.com'. Returns FALSE is this environment
 	 * variable isn't set.
 	 *
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function protocolAndHost() {
 		$alternate = Config::inst()->get('Director', 'alternate_base_url');
@@ -869,7 +869,7 @@ 
 	/**
 	 * Returns true if the given file exists. Filename should be relative to the site root.
 	 *
-	 * @param $file
+	 * @param string $file
 	 *
 	 * @return bool
 	 */
@@ -1087,7 +1087,7 @@ 
 	 * Can also be checked with {@link Director::isDev()}, {@link Director::isTest()}, and
 	 * {@link Director::isLive()}.
 	 *
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function get_environment_type() {
 		if(Director::isLive()) {

control/PjaxResponseNegotiator.php

Doc Comments +2 added lines, -3 removed lines

@@ -35,9 +35,9 @@ 
 	protected $fragmentOverride = null;
 
 	/**
-	 * @param RequestHandler $controller
 	 * @param SS_HTTPResponse An existing response to reuse (optional)
 	 * @param Array $callbacks
+	 * @param SS_HTTPResponse $response
 	 */
 	public function __construct($callbacks = array(), $response = null) {
 		$this->callbacks = $callbacks;
@@ -61,7 +61,6 @@ 
 	 * @param array $extraCallbacks List of anonymous functions or callables returning either a string
 	 * or SS_HTTPResponse, keyed by their fragment identifier. The 'default' key can
 	 * be used as a fallback for non-ajax responses.
-	 * @param array $fragmentOverride Change the response fragments.
 	 * @return SS_HTTPResponse
 	 */
 	public function respond(SS_HTTPRequest $request, $extraCallbacks = array()) {
@@ -109,7 +108,7 @@ 
 	/**
 	 * Set up fragment overriding - will completely replace the incoming fragments.
 	 *
-	 * @param array $fragments Fragments to insert.
+	 * @param string[] $fragments Fragments to insert.
 	 */
 	public function setFragmentOverride($fragments) {
 		if (!is_array($fragments)) throw new InvalidArgumentException();

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/Diff.php

Doc Comments +10 added lines, -1 removed lines

@@ -242,6 +242,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;
 
@@ -352,6 +356,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
@@ -549,7 +558,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/manifest/ClassLoader.php

Doc Comments +1 added lines

@@ -83,6 +83,7 @@
 	 * Returns the path for a class or interface in the currently active manifest,
 	 * or any previous ones if later manifests aren't set to "exclusive".
 	 *
+	 * @param string $class
 	 * @return String
 	 */
 	public function getItemPath($class) {