[Pkg-owncloud-commits] [owncloud] 105/172: Fix PHPDoc and typos

[David Prévot]

This is an automated email from the git hooks/post-receive script.

taffit pushed a commit to branch master
in repository owncloud.

commit 7e448a376f96b31dc9c41d0e0ff6492aa8c9f8ca
Author: Lukas Reschke <lukas at statuscode.ch>
Date:   Sat May 10 22:32:13 2014 +0200

    Fix PHPDoc and typos
    
    Some things my IDE complained about while creating a custom backend.
    
    Fix PHPDoc and typos
    
    Some things my IDE complained about while creating a custom backend.
    
    Conflicts:
    	lib/private/group/database.php
    	lib/private/group/dummy.php
    	lib/private/group/example.php
---
 lib/private/group/backend.php  |  2 +-
 lib/private/group/database.php |  3 +--
 lib/private/group/dummy.php    | 23 ++++++++++++++++-------
 lib/private/group/example.php  | 14 +++++++++-----
 4 files changed, 27 insertions(+), 15 deletions(-)

diff --git a/lib/private/group/backend.php b/lib/private/group/backend.php
index c1de99b..38522d0 100644
--- a/lib/private/group/backend.php
+++ b/lib/private/group/backend.php
@@ -69,7 +69,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface {
 	/**
 	* @brief Check if backend implements actions
 	* @param int $actions bitwise-or'ed actions
-	* @return boolean
+	* @return bool
 	*
 	* Returns the supported actions as int to be
 	* compared with OC_GROUP_BACKEND_CREATE_GROUP etc.
diff --git a/lib/private/group/database.php b/lib/private/group/database.php
index 18c060e..91baa31 100644
--- a/lib/private/group/database.php
+++ b/lib/private/group/database.php
@@ -215,9 +215,8 @@ class OC_Group_Database extends OC_Group_Backend {
 	 * @brief get the number of all users matching the search string in a group
 	 * @param string $gid
 	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
 	 * @return int|false
+	 * @throws DatabaseException
 	 */
 	public function countUsersInGroup($gid, $search = '') {
 		$stmt = OC_DB::prepare('SELECT COUNT(`uid`) AS `count` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` LIKE ?');
diff --git a/lib/private/group/dummy.php b/lib/private/group/dummy.php
index 553aae5..75bab31 100644
--- a/lib/private/group/dummy.php
+++ b/lib/private/group/dummy.php
@@ -31,7 +31,7 @@ class OC_Group_Dummy extends OC_Group_Backend {
 	 * @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) {
@@ -136,18 +136,23 @@ class OC_Group_Dummy extends OC_Group_Backend {
 	}
 
 	/**
-	 * @brief get a list of all groups
+	 * @brief Get a list of all groups
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
 	 * @return array an array of group names
-	 *
-	 * Returns a list with all groups
 	 */
 	public function getGroups($search = '', $limit = -1, $offset = 0) {
 		return array_keys($this->groups);
 	}
 
 	/**
-	 * @brief get a list of all users in a group
-	 * @return array an array of user ids
+	 * @brief Get a list of all users in a group
+	 * @param string $gid
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
+	 * @return array an array of user IDs
 	 */
 	public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
 		if(isset($this->groups[$gid])) {
@@ -159,7 +164,11 @@ class OC_Group_Dummy extends OC_Group_Backend {
 
 	/**
 	 * @brief get the number of all users in a group
-	 * @return int|bool
+	 * @param string $gid
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
+	 * @return int
 	 */
 	public function countUsersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
 		if(isset($this->groups[$gid])) {
diff --git a/lib/private/group/example.php b/lib/private/group/example.php
index cfcc0d2..76c9ce2 100644
--- a/lib/private/group/example.php
+++ b/lib/private/group/example.php
@@ -31,7 +31,7 @@ abstract class OC_Group_Example {
 	 * @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.
 	 */
 	abstract public static function createGroup($gid);
@@ -87,14 +87,15 @@ abstract class OC_Group_Example {
 
 	/**
 	 * @brief get a list of all groups
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
 	 * @return array an array of group names
-	 *
-	 * Returns a list with all groups
 	 */
 	abstract public static function getGroups($search = '', $limit = -1, $offset = 0);
 
 	/**
-	 * check if a group exists
+	 * @brief Check if a group exists
 	 * @param string $gid
 	 * @return bool
 	 */
@@ -102,8 +103,11 @@ abstract class OC_Group_Example {
 
 	/**
 	 * @brief get a list of all users in a group
+	 * @param string $gid
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
 	 * @return array an array of user ids
 	 */
 	abstract public static function usersInGroup($gid, $search = '', $limit = -1, $offset = 0);
-
 }

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud.git