From 3b02d9ee91314a9c89657399a36107040cfc4ae0 Mon Sep 17 00:00:00 2001
From: ElgarL <ElgarL@palmergames.com>
Date: Sun, 5 Feb 2012 16:41:34 +0000
Subject: Add some commenting

---
 .../org/anjocaido/groupmanager/data/DataUnit.java    |  4 +++-
 .../groupmanager/dataholder/GroupsDataHolder.java    | 17 ++---------------
 .../groupmanager/dataholder/UsersDataHolder.java     | 20 ++------------------
 .../groupmanager/dataholder/WorldDataHolder.java     |  7 +++++--
 4 files changed, 12 insertions(+), 36 deletions(-)

(limited to 'EssentialsGroupManager/src/org')

diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/data/DataUnit.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/data/DataUnit.java
index 03d31b848..e3250a1c1 100644
--- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/data/DataUnit.java
+++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/data/DataUnit.java
@@ -67,7 +67,7 @@ public abstract class DataUnit {
     }
     
     /**
-     * Set the data source to point to a new worldDataHolder
+     * Set the data source to point to a different worldDataHolder
      * 
      * @param source
      */
@@ -76,6 +76,8 @@ public abstract class DataUnit {
     }
 
     /**
+     * Get the current worldDataHolder this object is pointing to
+     * 
      * @return the dataSource
      */
     public WorldDataHolder getDataSource() {
diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/GroupsDataHolder.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/GroupsDataHolder.java
index 444939251..5d681013e 100644
--- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/GroupsDataHolder.java
+++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/GroupsDataHolder.java
@@ -9,15 +9,13 @@ import org.anjocaido.groupmanager.data.Group;
 
 
 /**
+ * This container holds all Groups loaded from the relevant groupsFile.
+ * 
  * @author ElgarL
  * 
  */
 public class GroupsDataHolder {
 
-	/**
-	 * Root World name this set of groups is associated with.
-	 */
-	//private String name;
 	private WorldDataHolder dataSource;
 	private Group defaultGroup = null;
 	private File groupsFile;
@@ -42,17 +40,6 @@ public class GroupsDataHolder {
 			group.setDataSource(this.dataSource);
 	}
 
-	//protected void setWorldName(String worldName) {
-	//	name = worldName;
-	//}
-
-	/**
-	 * @return the name
-	 */
-	//public String getWorldName() {
-	//	return name;
-	//}
-
 	/**
 	 * @return the defaultGroup
 	 */
diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/UsersDataHolder.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/UsersDataHolder.java
index 1d7bbb704..fa2ccaf84 100644
--- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/UsersDataHolder.java
+++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/UsersDataHolder.java
@@ -9,15 +9,13 @@ import org.anjocaido.groupmanager.data.User;
 
 
 /**
+ * This container holds all Users loaded from the relevant usersFile.
+ * 
  * @author ElgarL
  * 
  */
 public class UsersDataHolder {
 
-	/**
-	 * Root World name this set of groups is associated with.
-	 */
-	//private String name;
 	private WorldDataHolder dataSource;
 	private File usersFile;
 	private boolean haveUsersChanged = false;
@@ -42,20 +40,6 @@ public class UsersDataHolder {
 		
 	}
 
-	/**
-	 * @param worldName
-	 */
-	//public void setWorldName(String worldName) {
-	//	this.name = worldName;
-	//}
-	
-	/**
-	 * @return the name
-	 */
-	//public String getWorldName() {
-	//	return this.name;
-	//}
-
 	/**
 	 * @return the users
 	 */
diff --git a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/WorldDataHolder.java b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/WorldDataHolder.java
index 69305f360..8115b1a75 100644
--- a/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/WorldDataHolder.java
+++ b/EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/WorldDataHolder.java
@@ -36,8 +36,11 @@ import org.yaml.snakeyaml.constructor.SafeConstructor;
 import org.yaml.snakeyaml.reader.UnicodeReader;
 
 /**
- *
- * @author gabrielcouto
+ * One instance of this should exist per world/mirror
+ * it contains all functions to manage these data sets
+ * and points to the relevant users and groups objects.
+ * 
+ * @author gabrielcouto, ElgarL
  */
 public class WorldDataHolder {
 
-- 
cgit v1.2.3