Revision: 120
http://mud4j.svn.sourceforge.net/mud4j/?rev=120&view=rev
Author: mpurland
Date: 2007-06-02 17:23:42 -0700 (Sat, 02 Jun 2007)
Log Message:
-----------
Fix javadoc warnings by adding return type, formatting, and organizing imports.
Modified Paths:
--------------
trunk/mud4j-core/src/java/net/sf/mud4j/world/area/Area.java
Modified: trunk/mud4j-core/src/java/net/sf/mud4j/world/area/Area.java
===================================================================
--- trunk/mud4j-core/src/java/net/sf/mud4j/world/area/Area.java 2007-01-14 20:52:09 UTC (rev 119)
+++ trunk/mud4j-core/src/java/net/sf/mud4j/world/area/Area.java 2007-06-03 00:23:42 UTC (rev 120)
@@ -16,7 +16,6 @@
package net.sf.mud4j.world.area;
-import java.util.Collection;
import java.util.List;
import net.sf.mud4j.character.Character;
@@ -27,27 +26,34 @@
* Area interface for different types of areas.
*
* @author Matthew Purland
- *
*/
public interface Area {
-
+
/**
* Get name of the area.
+ *
+ * @return Get name of the area.
*/
public String getAreaName();
-
+
/**
* Retrieve list of rooms contained in the area.
+ *
+ * @return Returns a list of rooms in the area.
*/
public List<Room> getRooms();
-
+
/**
* Retrieve list of players contained in the area.
+ *
+ * @return Returns a list of characters in the area.
*/
public List<Character> getCharacters();
-
+
/**
* Retrieve list of items contained in area.
+ *
+ * @return Returns a list of items in the area.
*/
public List<Item> getItems();
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
