minor symfony#23732 [2.8][Security][Guard] Docblock improvement (vudaltsov)

chalasr · chalasr · commit 12dc1ce33ea6 · 2017-08-01T17:16:41.000+02:00
This PR was merged into the 2.8 branch. Discussion ---------- [2.8][Security][Guard] Docblock improvement | Q | A | ------------- | --- | Branch? | 2.8 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a Added this small detail which might prevent [exception](https://github.com/symfony/symfony/blob/2.8/src/Symfony/Component/Security/Guard/Firewall/GuardAuthenticationListener.php#L193) when developing Commits ------- ce86449 Docblock improvement
diff --git a/src/Symfony/Component/Security/Guard/GuardAuthenticatorInterface.php b/src/Symfony/Component/Security/Guard/GuardAuthenticatorInterface.php
@@ -153,6 +153,7 @@ public function onAuthenticationSuccess(Request $request, TokenInterface $token,
      *      done by having a _remember_me checkbox in your form, but
      *      can be configured by the "always_remember_me" and "remember_me_parameter"
      *      parameters under the "remember_me" firewall key
+     *  D) The onAuthenticationSuccess method returns a Response object
      *
      * @return bool
      */

Original file line number	Diff line number	Diff line change
`@@ -153,6 +153,7 @@ public function onAuthenticationSuccess(Request $request, TokenInterface $token,`
`153`	`153`	`* done by having a _remember_me checkbox in your form, but`
`154`	`154`	`* can be configured by the "always_remember_me" and "remember_me_parameter"`
`155`	`155`	`* parameters under the "remember_me" firewall key`
	`156`	`+ * D) The onAuthenticationSuccess method returns a Response object`
`156`	`157`	`*`
`157`	`158`	`* @return bool`
`158`	`159`	`*/`