silverstripe / silverstripe-framework

tests/php/Security/SecurityTest.php

Doc Comments +4 added lines

@@ -676,6 +676,8 @@ 
     /**
      * Execute a log-in form using Director::test().
      * Helper method for the tests above
+     * @param string $email
+     * @param string $password
      */
     public function doTestLoginForm($email, $password, $backURL = 'test/link')
     {
@@ -697,6 +699,8 @@ 
 
     /**
      * Helper method to execute a change password form
+     * @param string $oldPassword
+     * @param string $newPassword
      */
     public function doTestChangepasswordForm($oldPassword, $newPassword)
     {

tests/php/View/SSViewerCacheBlockTest/VersionedModel.php

Doc Comments +3 added lines

@@ -16,6 +16,9 @@
         Versioned::class
     );
 
+    /**
+     * @param string $entropy
+     */
     public function setEntropy($entropy)
     {
         $this->entropy = $entropy;

tests/php/View/SSViewerTest.php

Doc Comments +13 added lines

@@ -173,6 +173,10 @@ 
         );
     }
 
+    /**
+     * @param \SilverStripe\ORM\FieldType\DBHTMLText $result
+     * @param string[] $expected
+     */
     private function assertExpectedStrings($result, $expected)
     {
         foreach ($expected as $expectedStr) {
@@ -1088,6 +1092,10 @@ 
         $this->assertEquals('A A1 A1 i A1 ii A2 A3', $rationalisedResult);
     }
 
+    /**
+     * @param string $a
+     * @param string $b
+     */
     public function assertEqualIgnoringWhitespace($a, $b, $message = '')
     {
         $this->assertEquals(preg_replace('/\s+/', '', $a), preg_replace('/\s+/', '', $b), $message);
@@ -1819,6 +1827,11 @@ 
             $this->_renderWithSourceFileComments('SSViewerTestComments/'.$template['name'], $template['expected']);
         }
     }
+
+    /**
+     * @param string $name
+     * @param string $expected
+     */
     private function _renderWithSourceFileComments($name, $expected)
     {
         $viewer = new SSViewer(array($name));

src/Control/Email/Email.php

Doc Comments +14 added lines, -14 removed lines

@@ -135,12 +135,12 @@ 
 
     /**
      * Email constructor.
-     * @param string|array|null $from
-     * @param string|array|null $to
+     * @param string $from
+     * @param string $to
      * @param string|null $subject
      * @param string|null $body
-     * @param string|array|null $cc
-     * @param string|array|null $bcc
+     * @param string $cc
+     * @param string $bcc
      * @param string|null $returnPath
      */
     public function __construct(
@@ -226,7 +226,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -238,7 +238,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string
      */
     public function getSender()
     {
@@ -303,7 +303,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -335,7 +335,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -367,7 +367,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -384,7 +384,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -396,7 +396,7 @@ 
     }
 
     /**
-     * @param string|array $address
+     * @param string $address
      * @param string|null $name
      * @return $this
      */
@@ -502,7 +502,7 @@ 
     }
 
     /**
-     * @param string|array $name The data name to add or array to names => value
+     * @param string $name The data name to add or array to names => value
      * @param string|null $value The value of the data to add
      * @return $this
      */
@@ -672,7 +672,7 @@ 
     }
 
     /**
-     * @return array|bool
+     * @return boolean
      */
     public function sendPlain()
     {
@@ -728,7 +728,7 @@ 
     }
 
     /**
-     * @return Swift_MimePart|false
+     * @return \Swift_Mime_MimeEntity
      */
     public function findPlainPart()
     {

src/Security/Member.php

Doc Comments +5 added lines, -5 removed lines

@@ -889,9 +889,9 @@ 
      * });
      * </code>
      *
-     * @param Member|null|int $member Member or member ID to log in as.
+     * @param null|Member $member Member or member ID to log in as.
      * Set to null or 0 to act as a logged out user.
-     * @param $callback
+     * @param \Closure $callback
      */
     public static function actAs($member, $callback)
     {
@@ -1661,7 +1661,7 @@ 
      * This is likely to be customized for social sites etc. with a looser permission model.
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canView($member = null)
     {
@@ -1692,7 +1692,7 @@ 
      * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canEdit($member = null)
     {
@@ -1727,7 +1727,7 @@ 
      * Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
      *
      * @param Member $member
-     * @return bool
+     * @return boolean|string
      */
     public function canDelete($member = null)
     {

src/Forms/GridField/GridFieldAddExistingAutocompleter.php

Doc Comments +3 added lines, -3 removed lines

@@ -155,7 +155,7 @@ 
     /**
      *
      * @param GridField $gridField
-     * @return array
+     * @return string[]
      */
     public function getActions($gridField)
     {
@@ -219,7 +219,7 @@ 
      *
      * @param GridField $gridField
      * @param HTTPRequest $request
-     * @return string
+     * @return HTTPResponse
      */
     public function doSearch($gridField, $request)
     {
@@ -299,7 +299,7 @@ 
     }
 
     /**
-     * @param array $fields
+     * @param string[] $fields
      * @return $this
      */
     public function setSearchFields($fields)

src/ORM/ListDecorator.php

Doc Comments +1 added lines

@@ -41,6 +41,7 @@
      * Useful for keeping a decorator/paginated list configuration intact while modifying
      * the underlying list.
      *
+     * @param SS_List $list
      * @return SS_List
      */
     public function setList($list)

admin/code/ModelAdmin.php

Doc Comments +2 added lines, -1 removed lines

@@ -162,6 +162,7 @@ 
      * currently viewing) is included in the URL.
      *
      * @inheritdoc
+     * @param string $action
      */
     public function Link($action = null)
     {
@@ -441,7 +442,7 @@ 
     /**
      * Generate a CSV import form for a single {@link DataObject} subclass.
      *
-     * @return Form|false
+     * @return Form
      */
     public function ImportForm()
     {

src/View/SSViewer_DataPresenter.php

Doc Comments +7 added lines

@@ -33,6 +33,10 @@ 
      */
     protected $underlay;
 
+    /**
+     * @param ViewableData $item
+     * @param ViewableData $inheritedScope
+     */
     public function __construct($item, $overlay = null, $underlay = null, $inheritedScope = null)
     {
         parent::__construct($item, $inheritedScope);
@@ -65,6 +69,9 @@ 
         $this->underlay = $underlay ? $underlay : array();
     }
 
+    /**
+     * @param string $variableMethod
+     */
     protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false)
     {
         $implementers = ClassInfo::implementorsOf($interfaceToQuery);