[mud4j-commit] SF.net SVN: mud4j: [127] trunk/mud4j-core/src/java/net/sf/mud4j/world/Room. java

[<mpu...@us...>]

Revision: 127
          http://mud4j.svn.sourceforge.net/mud4j/?rev=127&view=rev
Author:   mpurland
Date:     2007-06-02 18:25:14 -0700 (Sat, 02 Jun 2007)

Log Message:
-----------
Fix javadoc.

Modified Paths:
--------------
    trunk/mud4j-core/src/java/net/sf/mud4j/world/Room.java

Modified: trunk/mud4j-core/src/java/net/sf/mud4j/world/Room.java
===================================================================
--- trunk/mud4j-core/src/java/net/sf/mud4j/world/Room.java	2007-06-03 01:24:36 UTC (rev 126)
+++ trunk/mud4j-core/src/java/net/sf/mud4j/world/Room.java	2007-06-03 01:25:14 UTC (rev 127)
@@ -21,13 +21,11 @@
 
 import net.sf.mud4j.effect.EffectBehavior;
 
-
 /**
- * Defines rooms interface as a location that events happen within.
+ * Defines rooms interface as a location that events happen within. TODO
+ * implement events for when a Placeable becomes moved TODO keep internal list
+ * of Placeables within room
  * 
- * TODO implement events for when a Placeable becomes moved
- * TODO keep internal list of Placeables within room
- * 
  * @author Matthew Purland
  */
 public class Room implements TileLocation {
@@ -36,24 +34,31 @@
     private List<Direction> directionList = new ArrayList<Direction>();
     private EffectBehavior effectBehavior;
     private String roomName;
-    
+
+    /**
+     * Constructor to create a default room.
+     */
     public Room() {
     }
-    
+
     /**
      * Get the name of the location.
+     * 
+     * @return Returns the name of the room.
      */
-    public String getName() {
+    public String getRoomName() {
         return roomName;
     }
-    
+
     /**
-     * Set the name of the location;
+     * Set the name of the room.
+     * 
+     * @param roomName Text of the room name
      */
-    public void setName(String name) {
-        this.roomName = name;
+    public void setRoomName(String roomName) {
+        this.roomName = roomName;
     }
-    
+
     /**
      * {@inheritDoc}
      */
@@ -66,8 +71,8 @@
      */
     public void removeDirection(Direction direction) {
         directionList.remove(direction);
-    }    
-    
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -79,7 +84,6 @@
      * {@inheritDoc}
      */
     public void move(Placeable placeable) {
-        
         placeable.place(this);
     }
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.