minor #13211 [Security] fixed wrong phpdoc (fabpot)

fabpot · fabpot · commit 6de747e2ec6d · 2015-01-03T14:33:53.000+01:00
This PR was merged into the 2.3 branch. Discussion ---------- [Security] fixed wrong phpdoc | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #12597 | License | MIT | Doc PR | n/a Commits ------- 064062d [Security] fixed wrong phpdoc
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.php b/src/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.php
@@ -47,8 +47,10 @@ public function getCredentials();
     /**
      * Returns a user representation.
      *
-     * @return mixed either returns an object which implements __toString(), or
-     *               a primitive string is returned.
+     * @return mixed Can be a UserInterface instance, an object implementing a __toString method,
+     *               or the username as a regular string
+     *
+     * @see AbstractToken::setUser()
      */
     public function getUser();
 
