summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2014-12-22 10:01:39 +0100
committerMorris Jobke <hey@morrisjobke.de>2014-12-22 10:01:39 +0100
commit5d296aa6b1fca69cfa14cc29eeb5f757a4b7dfad (patch)
tree09c5af98de13cfca3eeb838c0b2bb86e591b2342
parenteab4c029c20c333c467c659d6841cbde82f9da43 (diff)
parentdbbf56819227af9501cf35a018c4d18c4af31e70 (diff)
downloadnextcloud-server-5d296aa6b1fca69cfa14cc29eeb5f757a4b7dfad.tar.gz
nextcloud-server-5d296aa6b1fca69cfa14cc29eeb5f757a4b7dfad.zip
Merge pull request #12969 from owncloud/clarify-docs
Clarify return values
-rw-r--r--lib/private/user/session.php4
-rw-r--r--lib/public/iusersession.php4
2 files changed, 4 insertions, 4 deletions
diff --git a/lib/private/user/session.php b/lib/private/user/session.php
index 9324ef2f42c..3cd83aae52f 100644
--- a/lib/private/user/session.php
+++ b/lib/private/user/session.php
@@ -121,7 +121,7 @@ class Session implements IUserSession, Emitter {
/**
* get the current active user
*
- * @return \OC\User\User
+ * @return \OCP\IUser|null Current user, otherwise null
*/
public function getUser() {
// FIXME: This is a quick'n dirty work-around for the incognito mode as
@@ -143,7 +143,7 @@ class Session implements IUserSession, Emitter {
}
/**
- * Checks wether the user is logged in
+ * Checks whether the user is logged in
*
* @return bool if logged in
*/
diff --git a/lib/public/iusersession.php b/lib/public/iusersession.php
index 4c5b4d1ba51..7128366590f 100644
--- a/lib/public/iusersession.php
+++ b/lib/public/iusersession.php
@@ -61,12 +61,12 @@ interface IUserSession {
/**
* get the current active user
*
- * @return \OCP\IUser
+ * @return \OCP\IUser|null Current user, otherwise null
*/
public function getUser();
/**
- * Checks wether the user is logged in
+ * Checks whether the user is logged in
*
* @return bool if logged in
*/