silverstripe / silverstripe-framework

forms/gridfield/GridFieldDetailForm.php

Doc Comments +10 added lines

@@ -192,6 +192,7 @@ 
 
 	/**
 	 * @param String
+	 * @param string $class
 	 */
 	public function setItemRequestClass($class) {
 		$this->itemRequestClass = $class;
@@ -299,6 +300,9 @@ 
 		parent::__construct();
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		return Controller::join_links($this->gridField->Link('item'),
 			$this->record->ID ? $this->record->ID : 'new', $action);
@@ -524,6 +528,9 @@ 
 		return $c;
 	}
 
+	/**
+	 * @return string
+	 */
 	protected function getBackLink(){
 		// TODO Coupling with CMS
 		$backlink = '';
@@ -625,6 +632,9 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $errorCode
+	 */
 	public function httpError($errorCode, $errorMessage = null) {
 		$controller = $this->getToplevelController();
 		return $controller->httpError($errorCode, $errorMessage);

forms/TreeDropdownField.php

Doc Comments +4 added lines, -5 removed lines

@@ -80,7 +80,7 @@ 
 	 *
 	 * @param string $name the field name
 	 * @param string $title the field label
-	 * @param string|array $sourceObject The object-type to list in the tree. This could
+	 * @param string $sourceObject The object-type to list in the tree. This could
 	 * be one of the following:
 	 * - A DataObject class name with the {@link Hierarchy} extension.
 	 * - An array of key/value pairs, like a {@link DropdownField} source. In
@@ -208,7 +208,7 @@ 
 	}
 
 	/**
-	 * @return HTMLText
+	 * @return DBField
 	 */
 	public function Field($properties = array()) {
 		Requirements::add_i18n_javascript(FRAMEWORK_DIR . '/javascript/lang');
@@ -262,7 +262,7 @@ 
 	/**
 	 * Get the whole tree of a part of the tree via an AJAX request.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @return string
 	 */
 	public function tree(HTTPRequest $request) {
@@ -389,7 +389,7 @@ 
 	 * If a filter function has been set, that will be called. And if search text is set,
 	 * filter on that too. Return true if all applicable conditions are true, false otherwise.
 	 * @param $node
-	 * @return unknown_type
+	 * @return boolean
 	 */
 	public function filterMarking($node) {
 		if ($this->filterCallback && !call_user_func($this->filterCallback, $node)) return false;
@@ -440,7 +440,6 @@ 
 	}
 
 	/**
-	 * @param String $field
 	 */
 	public function setSourceObject($class) {
 		$this->sourceObject = $class;

model/versioning/Versioned.php

Doc Comments +6 added lines, -6 removed lines

@@ -1066,7 +1066,7 @@ 
 	/**
 	 * Find objects in the given relationships, merging them into the given list
 	 *
-	 * @param array $source Config property to extract relationships from
+	 * @param string $source Config property to extract relationships from
 	 * @param bool $recursive True if recursive
 	 * @param ArrayList $list Optional list to add items to
 	 * @return ArrayList The list
@@ -1186,7 +1186,7 @@ 
 	/**
 	 * Check if the current user can delete this record from live
 	 *
-	 * @param null $member
+	 * @param Member|null $member
 	 * @return mixed
 	 */
 	public function canUnpublish($member = null) {
@@ -1219,7 +1219,7 @@ 
 	 * If extended, ensure that both canDelete and canUnpublish are extended also
 	 *
 	 * @param Member $member
-	 * @return bool
+	 * @return null|boolean
 	 */
 	public function canArchive($member = null) {
 		// Skip if invoked by extendedCan()
@@ -1296,7 +1296,7 @@ 
 	 * Extend permissions to include additional security for objects that are not published to live.
 	 *
 	 * @param Member $member
-	 * @return bool|null
+	 * @return false|null
 	 */
 	public function canView($member = null) {
 		// Invoke default version-gnostic canView
@@ -1918,7 +1918,7 @@ 
 	/**
 	 * Determine if the current user is able to set the given site stage / archive
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param SilverStripe\Control\HTTPRequest $request
 	 * @return bool
 	 */
 	public static function can_choose_site_stage($request) {
@@ -2422,7 +2422,7 @@ 
 	/**
 	 * Returns an array of possible stages.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getVersionedStages() {
 		if($this->hasStages()) {

security/ChangePasswordForm.php

Doc Comments +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
 	/**
 	 * Constructor
 	 *
-	 * @param Controller $controller The parent controller, necessary to
+	 * @param Controller|null $controller The parent controller, necessary to
 	 *                               create the appropriate form action tag.
 	 * @param string $name The method on the controller that will return this
 	 *                     form object.

tests/filesystem/ProtectedFileControllerTest.php

Doc Comments +1 added lines, -1 removed lines

@@ -188,7 +188,7 @@
 	 *
 	 * @param int $code HTTP code
 	 * @param string $body Body expected for 200 responses
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 */
 	protected function assertResponseEquals($code, $body, HTTPResponse $response) {
 		$this->assertEquals($code, $response->getStatusCode());

view/Requirements.php

Doc Comments +5 added lines, -3 removed lines

@@ -68,6 +68,7 @@ 
 	 * while automatically busting this cache every time the file is changed.
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public static function set_suffix_requirements($var) {
 		self::backend()->setSuffixRequirements($var);
@@ -276,7 +277,7 @@ 
 	 * Attach requirements inclusion to X-Include-JS and X-Include-CSS headers on the given
 	 * HTTP Response
 	 *
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 */
 	public static function include_in_response(HTTPResponse $response) {
 		self::backend()->includeInResponse($response);
@@ -339,7 +340,7 @@ 
 	 * </code>
 	 *
 	 * @param string $combinedFileName Filename of the combined file relative to docroot
-	 * @param array  $files            Array of filenames relative to docroot
+	 * @param string[]  $files            Array of filenames relative to docroot
 	 * @param string $media
 	 *
 	 * @return bool|void
@@ -764,6 +765,7 @@ 
 	 * Forces the JavaScript requirements to the end of the body, right before the closing tag
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 * @return $this
 	 */
 	public function setForceJSToBottom($var) {
@@ -1263,7 +1265,7 @@ 
 	 * Attach requirements inclusion to X-Include-JS and X-Include-CSS headers on the given
 	 * HTTP Response
 	 *
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 */
 	public function includeInResponse(HTTPResponse $response) {
 		$this->processCombinedFiles();

admin/code/CampaignAdmin.php

Doc Comments +5 added lines, -5 removed lines

@@ -194,7 +194,7 @@ 
 	/**
 	 * REST endpoint to get a list of campaigns.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 *
 	 * @return HTTPResponse
 	 */
@@ -335,7 +335,7 @@ 
 	/**
 	 * Gets viewable list of campaigns
 	 *
-	 * @return SS_List
+	 * @return SilverStripe\Model\ArrayList
 	 */
 	protected function getListItems() {
 		return ChangeSet::get()
@@ -349,7 +349,7 @@ 
 	/**
 	 * REST endpoint to get a campaign.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 *
 	 * @return HTTPResponse
 	 */
@@ -382,7 +382,7 @@ 
 	/**
 	 * REST endpoint to delete a campaign.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 *
 	 * @return HTTPResponse
 	 */
@@ -409,7 +409,7 @@ 
 	/**
 	 * REST endpoint to publish a {@link ChangeSet} and all of its items.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 *
 	 * @return HTTPResponse
 	 */

control/Controller.php

Doc Comments +5 added lines, -5 removed lines

@@ -143,7 +143,7 @@ 
 	 * $this->pushCurrent() and end the method with $this->popCurrent(). Failure to do this will create
 	 * weird session errors.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @param DataModel $model
 	 *
 	 * @return HTTPResponse
@@ -281,7 +281,7 @@ 
 	/**
 	 * Sets the SS_HTTPResponse object that this controller is building up.
 	 *
-	 * @param SS_HTTPResponse $response
+	 * @param HTTPResponse $response
 	 *
 	 * @return $this
 	 */
@@ -322,7 +322,7 @@ 
 	 *
 	 * @param string $action
 	 *
-	 * @return HTMLText
+	 * @return \SilverStripe\Model\FieldType\DBField
 	 */
 	public function defaultAction($action) {
 		return $this->getViewer($action)->process($this);
@@ -458,7 +458,7 @@ 
 	 *
 	 * @param array $params
 	 *
-	 * @return string
+	 * @return \SilverStripe\Model\FieldType\DBField
 	 */
 	public function render($params = null) {
 		$template = $this->getViewer($this->getAction());
@@ -623,7 +623,7 @@ 
 	 * Tests whether a redirection has been requested. If redirect() has been called, it will return
 	 * the URL redirected to. Otherwise, it will return null.
 	 *
-	 * @return null|string
+	 * @return boolean
 	 */
 	public function redirectedTo() {
 		return $this->getResponse() && $this->getResponse()->getHeader('Location');

control/Director.php

Doc Comments +5 added lines, -5 removed lines

@@ -278,7 +278,7 @@ 
 	 * @param array|Cookie_Backend $cookies to populate $_COOKIE.
 	 * @param HTTP_Request $request The {@see HTTP_Request} object generated as a part of this request.
 	 *
-	 * @return SilverStripe\Control\HTTPResponse
+	 * @return HTTPResponse
 	 *
 	 * @throws SilverStripe\Control\HTTPResponse_Exception
 	 */
@@ -414,7 +414,7 @@ 
 	/**
 	 * Handle an HTTP request, defined with a SS_HTTPRequest object.
 	 *
-	 * @param SS_HTTPRequest $request
+	 * @param HTTPRequest $request
 	 * @param Session $session
 	 * @param DataModel $model
 	 *
@@ -560,7 +560,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('SilverStripe\Control\Director', 'alternate_base_url');
@@ -893,7 +893,7 @@ 
 	/**
 	 * Returns true if the given file exists. Filename should be relative to the site root.
 	 *
-	 * @param $file
+	 * @param string $file
 	 *
 	 * @return bool
 	 */
@@ -1111,7 +1111,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()) {