GUACAMOLE-220: Correct documentation of getUserGroups() behavior.

This commit is contained in:
Michael Jumper
2018-04-21 14:11:18 -07:00
parent 393e1ab647
commit b43aa59958

View File

@@ -29,14 +29,15 @@ import org.apache.guacamole.GuacamoleException;
public interface UserGroup extends Identifiable, Attributes, Permissions { public interface UserGroup extends Identifiable, Attributes, Permissions {
/** /**
* Returns a set of all readable user groups that are members of this user * Returns a set of all readable user groups of which this user group is a
* group. If permission is granted for the current user to modify the * member. If permission is granted for the current user to modify the
* members of this group, then the returned set will be mutable, and any * membership of this user group, then the returned set will be mutable,
* such modifications should be made through changes to the returned set. * and any such modifications should be made through changes to the
* returned set.
* *
* @return * @return
* The set of all readable user groups that are members of this user * The set of all readable user groups of which this user group is a
* group, which may be mutable. * member.
* *
* @throws GuacamoleException * @throws GuacamoleException
* If an error occurs while retrieving the user groups. * If an error occurs while retrieving the user groups.