Skip to content

Commit f57b558

Browse files
authored
Annotate throws with FQN (#54)
* Annotate thrown exceptions with FQN * Fix documentation of Module\Yii2::setCookie() * Documentation described a `$value` parameter, function signature had `$val` as parameter name.
1 parent 3fecea9 commit f57b558

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/Codeception/Module/Yii2.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -423,7 +423,7 @@ public function _parts()
423423
* Requires the `user` component to be enabled and configured.
424424
*
425425
* @param $user
426-
* @throws ModuleException
426+
* @throws \Codeception\Exception\ModuleException
427427
*/
428428
public function amLoggedInAs($user)
429429
{
@@ -521,7 +521,7 @@ function ($fixturesStore) {
521521
*
522522
* @param $name
523523
* @return mixed
524-
* @throws ModuleException if the fixture is not found
524+
* @throws \Codeception\Exception\ModuleException if the fixture is not found
525525
* @part fixtures
526526
*/
527527
public function grabFixture($name, $index = null)
@@ -714,7 +714,7 @@ protected function clientRequest($method, $uri, array $parameters = [], array $f
714714
*
715715
* @param $component
716716
* @return mixed
717-
* @throws ModuleException
717+
* @throws \Codeception\Exception\ModuleException
718718
* @deprecated in your tests you can use \Yii::$app directly.
719719
*/
720720
public function grabComponent($component)
@@ -739,7 +739,7 @@ public function grabComponent($component)
739739
* ```
740740
*
741741
* @param int $num
742-
* @throws ModuleException
742+
* @throws \Codeception\Exception\ModuleException
743743
* @part email
744744
*/
745745
public function seeEmailIsSent($num = null)
@@ -775,7 +775,7 @@ public function dontSeeEmailIsSent()
775775
*
776776
* @part email
777777
* @return array
778-
* @throws ModuleException
778+
* @throws \Codeception\Exception\ModuleException
779779
*/
780780
public function grabSentEmails()
781781
{
@@ -826,7 +826,7 @@ private function defineConstants()
826826
/**
827827
* Sets a cookie and, if validation is enabled, signs it.
828828
* @param string $name The name of the cookie
829-
* @param string $value The value of the cookie
829+
* @param string $val The value of the cookie
830830
* @param array $params Additional cookie params like `domain`, `path`, `expires` and `secure`.
831831
*/
832832
public function setCookie($name, $val, array $params = [])

0 commit comments

Comments
 (0)