Improve PHPDoc

Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2017-04-13 12:16:12 -05:00 · 2017-04-13 12:16:12 -05:00 · ac05d6dd67
parent fbadb37b9b
commit ac05d6dd67
1 changed files with 1 additions and 1 deletions
--- a/lib/private/User/Session.php
+++ b/lib/private/User/Session.php
@ -329,7 +329,7 @@ class Session implements IUserSession, Emitter {
 	 * @param IUser $user
 	 * @param array $loginDetails
 	 * @param bool $regenerateSessionId
-	 * @return bool
+	 * @return true returns true if login successful or an exception otherwise
 	 * @throws LoginException
 	 */
 	public function completeLogin(IUser $user, array $loginDetails, $regenerateSessionId = true) {