fix some more phpdoc

3 files changed, 61 insertions, 40 deletions

diff --git a/lib/group/backend.php b/lib/group/backend.php
index 1ba34c940cf..9ff432d0663 100644
--- a/lib/group/backend.php
+++ b/lib/group/backend.php
@@ -47,7 +47,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
 
 	/**
 	* @brief Get all supported actions
-	* @returns bitwise-or'ed actions
+	* @return int bitwise-or'ed actions
 	*
 	* Returns the supported actions as int to be
 	* compared with OC_USER_BACKEND_CREATE_USER etc.
@@ -65,8 +65,8 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
 
 	/**
 	* @brief Check if backend implements actions
-	* @param $actions bitwise-or'ed actions
-	* @returns boolean
+	* @param int $actions bitwise-or'ed actions
+	* @return boolean
 	*
 	* Returns the supported actions as int to be
 	* compared with OC_GROUP_BACKEND_CREATE_GROUP etc.
@@ -77,9 +77,9 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
 
 	/**
 	 * @brief is user in group?
-	 * @param $uid uid of the user
-	 * @param $gid gid of the group
-	 * @returns true/false
+	 * @param string $uid uid of the user
+	 * @param string $gid gid of the group
+	 * @return bool
 	 *
 	 * Checks whether the user is member of a group or not.
 	 */
@@ -89,8 +89,8 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
 
 	/**
 	 * @brief Get all groups a user belongs to
-	 * @param $uid Name of the user
-	 * @returns array with group names
+	 * @param string $uid Name of the user
+	 * @return array with group names
 	 *
 	 * This function fetches all groups a user belongs to. It does not check
 	 * if the user exists at all.
@@ -101,7 +101,10 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
 
 	/**
 	 * @brief get a list of all groups
-	 * @returns array with group names
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
+	 * @return array with group names
 	 *
 	 * Returns a list with all groups
 	 */
@@ -121,7 +124,11 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
 
 	/**
 	 * @brief get a list of all users in a group
-	 * @returns array with user ids
+	 * @param string $gid
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
+	 * @return array with user ids
 	 */
 	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
 		return array();
diff --git a/lib/group/database.php b/lib/group/database.php
index f3012563acf..6eca98ba019 100644
--- a/lib/group/database.php
+++ b/lib/group/database.php
@@ -44,10 +44,10 @@ class OC_Group_Database extends OC_Group_Backend {
 
 	/**
 	 * @brief Try to create a new group
-	 * @param $gid The name of the group to create
-	 * @returns true/false
+	 * @param string $gid The name of the group to create
+	 * @return bool
 	 *
-	 * Trys to create a new group. If the group name already exists, false will
+	 * Tries to create a new group. If the group name already exists, false will
 	 * be returned.
 	 */
 	public function createGroup( $gid ) {
@@ -70,28 +70,28 @@ class OC_Group_Database extends OC_Group_Backend {
 
 	/**
 	 * @brief delete a group
-	 * @param $gid gid of the group to delete
-	 * @returns true/false
+	 * @param string $gid gid of the group to delete
+	 * @return bool
 	 *
 	 * Deletes a group and removes it from the group_user-table
 	 */
 	public function deleteGroup( $gid ) {
 		// Delete the group
 		$stmt = OC_DB::prepare( "DELETE FROM `*PREFIX*groups` WHERE `gid` = ?" );
-		$result = $stmt->execute( array( $gid ));
+		$stmt->execute( array( $gid ));
 
 		// Delete the group-user relation
 		$stmt = OC_DB::prepare( "DELETE FROM `*PREFIX*group_user` WHERE `gid` = ?" );
-		$result = $stmt->execute( array( $gid ));
+		$stmt->execute( array( $gid ));
 
 		return true;
 	}
 
 	/**
 	 * @brief is user in group?
-	 * @param $uid uid of the user
-	 * @param $gid gid of the group
-	 * @returns true/false
+	 * @param string $uid uid of the user
+	 * @param string $gid gid of the group
+	 * @return bool
 	 *
 	 * Checks whether the user is member of a group or not.
 	 */
@@ -105,9 +105,9 @@ class OC_Group_Database extends OC_Group_Backend {
 
 	/**
 	 * @brief Add a user to a group
-	 * @param $uid Name of the user to add to group
-	 * @param $gid Name of the group in which add the user
-	 * @returns true/false
+	 * @param string $uid Name of the user to add to group
+	 * @param string $gid Name of the group in which add the user
+	 * @return bool
 	 *
 	 * Adds a user to a group.
 	 */
@@ -124,9 +124,9 @@ class OC_Group_Database extends OC_Group_Backend {
 
 	/**
 	 * @brief Removes a user from a group
-	 * @param $uid Name of the user to remove from group
-	 * @param $gid Name of the group from which remove the user
-	 * @returns true/false
+	 * @param string $uid Name of the user to remove from group
+	 * @param string $gid Name of the group from which remove the user
+	 * @return bool
 	 *
 	 * removes the user from a group.
 	 */
@@ -139,8 +139,8 @@ class OC_Group_Database extends OC_Group_Backend {
 
 	/**
 	 * @brief Get all groups a user belongs to
-	 * @param $uid Name of the user
-	 * @returns array with group names
+	 * @param string $uid Name of the user
+	 * @return array with group names
 	 *
 	 * This function fetches all groups a user belongs to. It does not check
 	 * if the user exists at all.
@@ -160,7 +160,10 @@ class OC_Group_Database extends OC_Group_Backend {
 
 	/**
 	 * @brief get a list of all groups
-	 * @returns array with group names
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
+	 * @return array with group names
 	 *
 	 * Returns a list with all groups
 	 */
@@ -190,7 +193,11 @@ class OC_Group_Database extends OC_Group_Backend {
 
 	/**
 	 * @brief get a list of all users in a group
-	 * @returns array with user ids
+	 * @param string $gid
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
+	 * @return array with user ids
 	 */
 	public function usersInGroup($gid, $search = '', $limit = null, $offset = null) {
 		$stmt = OC_DB::prepare('SELECT `uid` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` LIKE ?', $limit, $offset);
diff --git a/lib/group/interface.php b/lib/group/interface.php
index 12cc07a5374..4ef3663837f 100644
--- a/lib/group/interface.php
+++ b/lib/group/interface.php
@@ -24,8 +24,8 @@
 interface OC_Group_Interface {
 	/**
 	* @brief Check if backend implements actions
-	* @param $actions bitwise-or'ed actions
-	* @returns boolean
+	* @param int $actions bitwise-or'ed actions
+	* @return boolean
 	*
 	* Returns the supported actions as int to be
 	* compared with OC_GROUP_BACKEND_CREATE_GROUP etc.
@@ -34,9 +34,9 @@ interface OC_Group_Interface {
 
 	/**
 	 * @brief is user in group?
-	 * @param $uid uid of the user
-	 * @param $gid gid of the group
-	 * @returns true/false
+	 * @param string $uid uid of the user
+	 * @param string $gid gid of the group
+	 * @return bool
 	 *
 	 * Checks whether the user is member of a group or not.
 	 */
@@ -44,8 +44,8 @@ interface OC_Group_Interface {
 
 	/**
 	 * @brief Get all groups a user belongs to
-	 * @param $uid Name of the user
-	 * @returns array with group names
+	 * @param string $uid Name of the user
+	 * @return array with group names
 	 *
 	 * This function fetches all groups a user belongs to. It does not check
 	 * if the user exists at all.
@@ -54,7 +54,10 @@ interface OC_Group_Interface {
 
 	/**
 	 * @brief get a list of all groups
-	 * @returns array with group names
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
+	 * @return array with group names
 	 *
 	 * Returns a list with all groups
 	 */
@@ -69,8 +72,12 @@ interface OC_Group_Interface {
 
 	/**
 	 * @brief get a list of all users in a group
-	 * @returns array with user ids
+	 * @param string $gid
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
+	 * @return array with user ids
 	 */
 	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0);
 
-}
\ No newline at end of file
+}