Document parameters

Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>
nextcloud · Mar 22, 2018 · 385374d · 385374d
1 parent fe60156
commit 385374d
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 0 deletions.
diff --git a/lib/public/User/Backend/ABackend.php b/lib/public/User/Backend/ABackend.php
@@ -35,6 +35,9 @@ abstract class ABackend implements IUserBackend, UserInterface {
 
 	/**
 	 * @deprecated 14.0.0
+	 *
+	 * @param int $actions The action to check for
+	 * @return bool
 	 */
 	public function implementsActions($actions): bool {
 		$implements = 0;

diff --git a/lib/public/User/Backend/ICheckPasswordBackend.php b/lib/public/User/Backend/ICheckPasswordBackend.php
@@ -30,6 +30,10 @@
 interface ICheckPasswordBackend {
 	/**
 	 * @since 14.0.0
+	 *
+	 * @param string $uid The username
+	 * @param string $password The password
+	 * @return string|bool The uid on success false on failure
 	 */
 	public function checkPassword(string $loginName, string $password);
 }
diff --git a/lib/public/User/Backend/ICountUsersBackend.php b/lib/public/User/Backend/ICountUsersBackend.php
@@ -31,6 +31,8 @@ interface ICountUsersBackend {
 
 	/**
 	 * @since 14.0.0
+	 *
+	 * @return int|bool The number of users on success false on failure
 	 */
 	public function countUsers();
 }
diff --git a/lib/public/User/Backend/ICreateUserBackend.php b/lib/public/User/Backend/ICreateUserBackend.php
@@ -31,6 +31,10 @@ interface ICreateUserBackend {
 
 	/**
 	 * @since 14.0.0
+	 *
+	 * @param string $uid The username of the user to create
+	 * @param string $password The password of the new user
+	 * @return bool
 	 */
 	public function createUser(string $uid, string $password): bool;
 }
diff --git a/lib/public/User/Backend/IGetDisplayNameBackend.php b/lib/public/User/Backend/IGetDisplayNameBackend.php
@@ -31,6 +31,9 @@ interface IGetDisplayNameBackend {
 
 	/**
 	 * @since 14.0.0
+	 *
+	 * @param string $uid user ID of the user
+	 * @return string display name
 	 */
 	public function getDisplayName($uid): string;
 }
diff --git a/lib/public/User/Backend/IGetHomeBackend.php b/lib/public/User/Backend/IGetHomeBackend.php
@@ -31,6 +31,9 @@ interface IGetHomeBackend {
 
 	/**
 	 * @since 14.0.0
+	 *
+	 * @param string $uid the username
+	 * @return string|bool Datadir on success false on failure
 	 */
 	public function getHome(string $uid);
 }
diff --git a/lib/public/User/Backend/IProvideAvatarBackend.php b/lib/public/User/Backend/IProvideAvatarBackend.php
@@ -31,6 +31,9 @@ interface IProvideAvatarBackend {
 
 	/**
 	 * @since 14.0.0
+	 *
+	 * @param string $uid
+	 * @return bool
 	 */
 	public function canChangeAvatar(string $uid): bool;
 }
diff --git a/lib/public/User/Backend/ISetDisplayNameBackend.php b/lib/public/User/Backend/ISetDisplayNameBackend.php
@@ -31,6 +31,10 @@ interface ISetDisplayNameBackend {
 
 	/**
 	 * @since 14.0.0
+	 *
+	 * @param string $uid The username
+	 * @param string $displayName The new display name
+	 * @return bool
 	 */
 	public function setDisplayName(string $uid, string $displayName): bool;
 }
diff --git a/lib/public/User/Backend/ISetPasswordBackend.php b/lib/public/User/Backend/ISetPasswordBackend.php
@@ -31,6 +31,10 @@ interface ISetPasswordBackend {
 
 	/**
 	 * @since 14.0.0
+	 *
+	 * @param string $uid The username
+	 * @param string $password The new password
+	 * @return bool
 	 */
 	public function setPassword(string $uid, string $password): bool;
 }