aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/group/example.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/group/example.php')
-rw-r--r--lib/private/group/example.php28
1 files changed, 14 insertions, 14 deletions
diff --git a/lib/private/group/example.php b/lib/private/group/example.php
index 12be5421c1c..cfcc0d245d1 100644
--- a/lib/private/group/example.php
+++ b/lib/private/group/example.php
@@ -28,8 +28,8 @@
abstract class OC_Group_Example {
/**
* @brief Try to create a new group
- * @param $gid The name of the group to create
- * @return 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
* be returned.
@@ -38,8 +38,8 @@ abstract class OC_Group_Example {
/**
* @brief delete a group
- * @param $gid gid of the group to delete
- * @return true/false
+ * @param string $gid gid of the group to delete
+ * @return bool
*
* Deletes a group and removes it from the group_user-table
*/
@@ -47,9 +47,9 @@ abstract class OC_Group_Example {
/**
* @brief is user in group?
- * @param $uid uid of the user
- * @param $gid gid of the group
- * @return 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.
*/
@@ -57,9 +57,9 @@ abstract class OC_Group_Example {
/**
* @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
- * @return 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.
*/
@@ -67,9 +67,9 @@ abstract class OC_Group_Example {
/**
* @brief Removes a user from a group
- * @param $uid NameUSER of the user to remove from group
- * @param $gid Name of the group from which remove the user
- * @return 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.
*/
@@ -77,7 +77,7 @@ abstract class OC_Group_Example {
/**
* @brief Get all groups a user belongs to
- * @param $uid Name of the user
+ * @param string $uid Name of the user
* @return array an array of group names
*
* This function fetches all groups a user belongs to. It does not check