summaryrefslogtreecommitdiffstats
path: root/lib/public
diff options
context:
space:
mode:
authorChristoph Wurst <christoph@winzerhof-wurst.at>2016-11-08 11:59:09 +0100
committerRoeland Jago Douma <roeland@famdouma.nl>2017-01-11 19:20:10 +0100
commit730442cd8fbe305b0b136bb7a5251a39d24af0c9 (patch)
tree68040b954f30341e9e7fd171249f60f0357178f6 /lib/public
parenta6dca9e7a0c344f0914ce53982e1c6f926e620ac (diff)
downloadnextcloud-server-730442cd8fbe305b0b136bb7a5251a39d24af0c9.tar.gz
nextcloud-server-730442cd8fbe305b0b136bb7a5251a39d24af0c9.zip
add @since annotations and document methods
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
Diffstat (limited to 'lib/public')
-rw-r--r--lib/public/Authentication/LoginCredentials/ICredentials.php12
-rw-r--r--lib/public/Authentication/LoginCredentials/IStore.php2
2 files changed, 14 insertions, 0 deletions
diff --git a/lib/public/Authentication/LoginCredentials/ICredentials.php b/lib/public/Authentication/LoginCredentials/ICredentials.php
index 97c88dda5de..46c6f26701f 100644
--- a/lib/public/Authentication/LoginCredentials/ICredentials.php
+++ b/lib/public/Authentication/LoginCredentials/ICredentials.php
@@ -30,16 +30,28 @@ namespace OCP\Authentication\LoginCredentials;
interface ICredentials {
/**
+ * Get the user UID
+ *
+ * @since 9.2
+ *
* @return string
*/
public function getUID();
/**
+ * Get the login name the users used to login
+ *
+ * @since 9.2
+ *
* @return string
*/
public function getLoginName();
/**
+ * Get the password
+ *
+ * @since 9.2
+ *
* @return string
*/
public function getPassword();
diff --git a/lib/public/Authentication/LoginCredentials/IStore.php b/lib/public/Authentication/LoginCredentials/IStore.php
index a35e9214e7e..549f0e7759b 100644
--- a/lib/public/Authentication/LoginCredentials/IStore.php
+++ b/lib/public/Authentication/LoginCredentials/IStore.php
@@ -32,6 +32,8 @@ use OCP\Authentication\Exceptions\CredentialsUnavailableException;
interface IStore {
/**
+ * Get login credentials of the currently logged in user
+ *
* @since 9.2
*
* @throws CredentialsUnavailableException