upgrading Javadoc

jcartign
1 parent 5418cb05
Showing 3 changed files with 5 additions and 4 deletions Show diff stats
src/main/java/fr/plil/sio/persistence/api/GroupService.java
src/main/java/fr/plil/sio/persistence/api/RightService.java
src/main/java/fr/plil/sio/persistence/api/UserService.java
@@ -9,7 +9,7 @@ public interface GroupService {
      * @param name the name of the group
      * @return an instance of the group
      * @throws IllegalArgumentException if name is null
-     * @throws IllegalStateException    if a group with the same name is already present
+     * @throws IllegalStateException if a group with the same name is already present
      */
     Group create(String name);
  
@@ -24,11 +24,11 @@ public interface RightService {
     Right create(String name, Right parent);
  
     /**
-     * Delete a right in the database.
+     * Delete a right in the database. Delete sibling rights if present.
      *
      * @param right the right to delete
-     * @return true if right has been deleted
-     * @throws IllegalArgumentException if right is null or if right is not found in the database.
+     * @return true if right has been deleted, false else.
+     * @throws IllegalArgumentException if right is null.
      */
     boolean delete(Right right);
  
@@ -7,6 +7,7 @@ public interface UserService {
      * There is no two users with the same name in the database.
      *
      * @param name the name of the user
+     * @param groupName the name of the group
      * @return an instance of the user
      * @throws IllegalArgumentException if name or groupName is null, or if group does not exist.
      * @throws IllegalStateException    if an user with the same name is already present