Fixed up javadoc comment errors

3 files changed, 32 insertions, 29 deletions

diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/OverloadedWorldHolder.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/OverloadedWorldHolder.java
index 42c78cccf..e7fa81627 100644
--- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/OverloadedWorldHolder.java
+++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/OverloadedWorldHolder.java
@@ -39,7 +39,7 @@ public class OverloadedWorldHolder extends WorldDataHolder {
     /**
      *
      * @param userName
-     * @return
+     * @return user object or a new user if none exists.
      */
     @Override
     public User getUser(String userName) {
@@ -86,7 +86,7 @@ public class OverloadedWorldHolder extends WorldDataHolder {
     /**
      *
      * @param userName
-     * @return
+     * @return true if removed/false if not found.
      */
     @Override
     public boolean removeUser(String userName) {
@@ -137,7 +137,7 @@ public class OverloadedWorldHolder extends WorldDataHolder {
 
     /**
      *
-     * @return
+     * @return Collection of all users
      */
     @Override
     public Collection<User> getUserList() {
@@ -156,7 +156,7 @@ public class OverloadedWorldHolder extends WorldDataHolder {
     /**
      *
      * @param userName
-     * @return
+     * @return true if user is overloaded.
      */
     public boolean isOverloaded(String userName) {
         return overloadedUsers.containsKey(userName.toLowerCase());
@@ -189,8 +189,9 @@ public class OverloadedWorldHolder extends WorldDataHolder {
      * Gets the user in normal state. Surpassing the overload state.
      * It doesn't affect permissions. But it enables plugins change the
      * actual user permissions even in overload mode.
+     * 
      * @param userName
-     * @return
+     * @return user object
      */
     public User surpassOverload(String userName) {
         if (!isOverloaded(userName)) {
diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/WorldDataHolder.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/WorldDataHolder.java
index d71fc64c0..4140cbfea 100644
--- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/WorldDataHolder.java
+++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/WorldDataHolder.java
@@ -163,7 +163,7 @@ public class WorldDataHolder {
     /**
      *
      * @param userName
-     * @return
+     * @return true if we have data for this player.
      */
     public boolean isUserDeclared(String userName) {
         return users.containsKey(userName.toLowerCase());
@@ -355,9 +355,11 @@ public class WorldDataHolder {
 
     /**
      * Returns a data holder for the given file
+     * 
      * @param worldName
      * @param file
-     * @return
+     * @return a new WorldDataHolder
+     * 
      * @throws Exception
      * @deprecated
      */
@@ -506,7 +508,7 @@ public class WorldDataHolder {
      * @param worldName
      * @param groupsFile
      * @param usersFile
-     * @return
+     * 
      * @throws FileNotFoundException
      * @throws IOException
      */
@@ -527,7 +529,7 @@ public class WorldDataHolder {
      * @param ph
      * @param groupsFile
      * @param usersFile
-     * @return
+     * 
      * @throws FileNotFoundException
      * @throws IOException
      */
@@ -547,9 +549,9 @@ public class WorldDataHolder {
     /**
      * Updates the WorldDataHolder from the Groups file
      * 
-     * @param worldName
+     * @param ph
      * @param groupsFile
-     * @return
+     * 
      * @throws FileNotFoundException
      * @throws IOException
      */
@@ -668,9 +670,9 @@ public class WorldDataHolder {
     /**
      * Updates the WorldDataHolder from the Users file
      * 
-     * @param worldName
+     * @param ph
      * @param usersFile
-     * @return
+     * 
      * @throws FileNotFoundException
      * @throws IOException
      */
@@ -1030,7 +1032,7 @@ public class WorldDataHolder {
 
     /**
      *
-     * @return
+     * @return true if any user data has changed
      */
     public boolean haveUsersChanged() {
         if (haveUsersChanged) {
@@ -1046,7 +1048,7 @@ public class WorldDataHolder {
 
     /**
      *
-     * @return
+     * @return true if any group data has changed.
      */
     public boolean haveGroupsChanged() {
         if (haveGroupsChanged) {
diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/worlds/WorldsHolder.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/worlds/WorldsHolder.java
index 8ea8e28c9..bf7b290ae 100644
--- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/worlds/WorldsHolder.java
+++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/worlds/WorldsHolder.java
@@ -265,7 +265,7 @@ public class WorldsHolder {
      * Mirrors prevails original data.
      *
      * @param worldName
-     * @return
+     * @return OverloadedWorldHolder
      */
     public OverloadedWorldHolder getWorldData(String worldName) {
         OverloadedWorldHolder data = worldsData.get(worldName.toLowerCase());
@@ -295,31 +295,31 @@ public class WorldsHolder {
     }
 
     /**
-     * Retrieves the field p.getWorld().getName() and do
+     * Retrieves the field player.getWorld().getName() and do
      * getWorld(worldName)
-     * @param p
-     * @return
+     * @param player
+     * @return OverloadedWorldHolder
      */
-    public OverloadedWorldHolder getWorldData(Player p) {
-        return getWorldData(p.getWorld().getName());
+    public OverloadedWorldHolder getWorldData(Player player) {
+        return getWorldData(player.getWorld().getName());
     }
 
     /**
      * It does getWorld(worldName).getPermissionsHandler()
      * @param worldName
-     * @return
+     * @return AnjoPermissionsHandler
      */
     public AnjoPermissionsHandler getWorldPermissions(String worldName) {
         return getWorldData(worldName).getPermissionsHandler();
     }
 
     /**
-     *It does getWorldData(p).getPermission
-     * @param p
-     * @return
+     * Returns the PermissionsHandler for this player data
+     * @param player
+     * @return AnjoPermissionsHandler
      */
-    public AnjoPermissionsHandler getWorldPermissions(Player p) {
-        return getWorldData(p).getPermissionsHandler();
+    public AnjoPermissionsHandler getWorldPermissions(Player player) {
+        return getWorldData(player).getPermissionsHandler();
     }
 
     /**
@@ -408,7 +408,7 @@ public class WorldsHolder {
      * Copies the specified world data to another world
      * @param fromWorld
      * @param toWorld
-     * @return
+     * @return true if successfully copied.
      */
     public boolean cloneWorld(String fromWorld, String toWorld) {
         File fromWorldFolder = new File(worldsFolder, fromWorld);
@@ -514,7 +514,7 @@ public class WorldsHolder {
 
     /**
      * Returns all physically loaded worlds.
-     * @return
+     * @return ArrayList<OverloadedWorldHolder> of all loaded worlds
      */
     public ArrayList<OverloadedWorldHolder> allWorldsDataList() {
         ArrayList<OverloadedWorldHolder> list = new ArrayList<OverloadedWorldHolder>();