Documentation improved.

Author: Ruediger.Lunde

src/aima/search/map/DynAttributeNames.java

@@ -1,58 +1,51 @@
 package aima.search.map;
 
 /**
- * The AIMA framework uses dynamic attributes to make implementations
- * of agents and environments completely independent of each other. The
- * disadvantage of this concept is, that it's error-prone. This set
- * of constants is designed to make information exchange more reliable
- * for map agents. Two kinds of attributes are distinguished.
- * Percept attributes are attached to percepts.
- * They are generated by the environment and read by by the agent.
- * Agent attributes are attached to agents. They are also generated
- * by the environment but the agents are not allowed to access them. 
+ * The AIMA framework uses dynamic attributes to make implementations of agents
+ * and environments completely independent of each other. The disadvantage of
+ * this concept is, that it's error-prone. This set of constants is designed to
+ * make information exchange more reliable for map agents. Two kinds of
+ * attributes are distinguished. Percept attributes are attached to percepts.
+ * They are generated by the environment and read by by the agent. Agent
+ * attributes are attached to agents. They are also generated by the environment
+ * but the agents are not allowed to access them.
+ * 
  * @author R. Lunde
  */
 public class DynAttributeNames {
 	/**
-	 * Name of a dynamic attribute, which contains the current
-	 * location of the agent. To be compatible with
-	 * {@code aima.search.map.MapEnvironment} it is advisable,
-	 * not to change the value. 
+	 * Name of a dynamic attribute, which contains the current location of the
+	 * agent.
 	 */
 	public static final String AGENT_LOCATION = "location";
 	/**
-	 * Name of a dynamic attribute, which maintains the total
-	 * traveling distance of the agent since birth.
-	 * Should be of type Integer.
+	 * Name of a dynamic attribute, which maintains the total traveling distance
+	 * of the agent since birth. Should be of type Integer.
 	 */
 	public static final String AGENT_TRAVEL_DISTANCE = "travelDistance";
 	/**
-	 * Name of a dynamic attribute, which indicates the current
-	 * status of the agent, such as traveling, completed or aborted. 
+	 * Name of a dynamic attribute, which indicates the current status of the
+	 * agent, such as traveling, completed or aborted.
 	 */
 	public static final String AGENT_STATUS = "status";
-	
+
 	/**
 	 * Name of a dynamic attribute, which tells the agent where it is.
-	 * To be compatible with
-	 * {@code aima.search.map.MapEnvironment#STATE_IN}
-	 * it is advisable not to change the value.
-	 */ 
+	 */
 	public static final String PERCEPT_IN = "In";
 	/**
-	 * Name of a dynamic attribute, which tells the agent which
-	 * actions are possible at the current location of the agent.
+	 * Name of a dynamic attribute, which tells the agent which actions are
+	 * possible at the current location of the agent.
 	 */
 	public static final String PERCEPT_POSSIBLE_ACTIONS = "Signpost";
 	/**
-	 * Name of a dynamic attribute. It provides access to
-	 * informations which are available at the current location
-	 * of the agent.
+	 * Name of a dynamic attribute. It provides access to informations which are
+	 * available at the current location of the agent.
 	 */
 	public static final String PERCEPT_INFOS = "Infos";
 	/**
-	 * Name of a dynamic attribute. It provides access to objects,
-	 * which are visible at the current location of the agent.
+	 * Name of a dynamic attribute. It provides access to objects, which are
+	 * visible at the current location of the agent.
 	 */
 	public static final String PERCEPT_OBJECTS = "Objects";
 }