javadoc documentation improved, warnings fixed.

Ruediger.Lunde · Ruediger.Lunde · commit 27a3f9114ed0 · 2009-09-21T15:15:20.000Z
diff --git a/src/aima/basic/BasicEnvironmentView.java b/src/aima/basic/BasicEnvironmentView.java
@@ -1,12 +1,11 @@
 package aima.basic;
 
+/**
+ * @author Ravi Mohan
+ * 
+ */
 public class BasicEnvironmentView {
 
-	/**
-	 * @author Ravi Mohan
-	 * 
-	 */
-
 	public void envChanged(String command) {
 		System.out.println(command);
 
diff --git a/src/aima/gui/applications/search/map/MapAgentModel.java b/src/aima/gui/applications/search/map/MapAgentModel.java
@@ -11,8 +11,8 @@
  * Provides a ready-to-use implementation of a model for route planning agent
  * applications. It is based on a scenario description and a list of
  * destinations. Some features are not used. Subclasses can support those
- * features by overriding the methods {@link #hasSignpost(String)},
- * {@link #hasInfos(String)}, and {@link #hasObjects(String)}.
+ * features by overriding the methods {@link #hasInfos(String)}, and
+ * {@link #hasObjects(String)}.
  * 
  * @author R. Lunde
  */
diff --git a/src/aima/gui/framework/package.html b/src/aima/gui/framework/package.html
@@ -11,7 +11,8 @@
 frame. It is configurable in many ways, even without subclassing. A
 demo application with model, view, and controller, but still without any content,
 can be seen when starting the <code>SimpleAgentAppDemo</code>. Look for classes
-with the ending ...<code>AppDemo</code> to see agents at work.</p>
+with the ending ...<code>AppDemo</code> in the <code>aima.gui.applications</code>
+package to see agents at work.</p>
 
 <p>This simple framework is strongly based on inheritance. You can extend any
 of the given base classes with the features you need. To be very flexible with
diff --git a/src/aima/learning/framework/DataSetSpecification.java b/src/aima/learning/framework/DataSetSpecification.java
@@ -70,7 +70,7 @@ public void defineStringAttribute(String name, String[] attributeValues) {
 	}
 
 	/**
-	 * @param targetAttribute
+	 * @param target
 	 *            The targetAttribute to set.
 	 */
 	public void setTarget(String target) {
diff --git a/src/aima/logic/fol/inference/InferenceResultPrinter.java b/src/aima/logic/fol/inference/InferenceResultPrinter.java
@@ -12,8 +12,8 @@ public class InferenceResultPrinter {
 	 * Utility method for outputting InferenceResults in a formatted textual
 	 * representation.
 	 * 
-	 * @param an
-	 *            InferenceResult
+	 * @param ir
+	 *            an InferenceResult
 	 * @return a String representation of the InferenceResult.
 	 */
 	public static String printInferenceResult(InferenceResult ir) {
@@ -28,13 +28,14 @@ public static String printInferenceResult(InferenceResult ir) {
 		sb.append("\n");
 		sb.append("InferenceResult.isPartialResultDueToTimeout="
 				+ ir.isPartialResultDueToTimeout());
-		sb.append("\n");		
+		sb.append("\n");
 		sb.append("InferenceResult.#Proofs=" + ir.getProofs().size());
 		sb.append("\n");
 		int proofNo = 0;
 		for (Proof p : ir.getProofs()) {
 			proofNo++;
-			sb.append("InferenceResult.Proof#"+proofNo+"=\n" + ProofPrinter.printProof(p));
+			sb.append("InferenceResult.Proof#" + proofNo + "=\n"
+					+ ProofPrinter.printProof(p));
 		}
 
 		return sb.toString();
diff --git a/src/aima/probability/reasoning/HMMFactory.java b/src/aima/probability/reasoning/HMMFactory.java
@@ -5,13 +5,12 @@
 
 import aima.probability.RandomVariable;
 
+/**
+ * @author Ravi Mohan
+ * 
+ */
 public class HMMFactory {
 
-	/**
-	 * @author Ravi Mohan
-	 * 
-	 */
-
 	public static HiddenMarkovModel createRobotHMM() {
 
 		// Example adopted from Sebastian Thrun's "Probabilistic Robotics"
diff --git a/src/aima/search/map/package.html b/src/aima/search/map/package.html
@@ -1,13 +1,16 @@
 <body>
 <html>
-<p>This package contains classes which are useful to create
-map agents. The contained <code>MapWithSLD</code> class extends
-the original <code>aima.search.map.Map</code> by features
-such as location coordinates and straight-line distances.
+<p>This package contains classes, which are useful to create
+map agents. The contained <code>Map</code> class maintains
+named locations with coordinates, links between them, and
+straight-line distances. The <code>MapEnvironment</code>
+enables a <code>MapAgent</code> to travel trough a world
+whose topology is described by a map.
 Adaptable heuristic functions let the agent modify the
 heuristic function with respect to the current goal. Standardized
-dynamic attribute names make information exchange between environment
-and agent safer without introducing direct dependencies.
+dynamic attribute names in class <code>DynAttributeNames</code>
+make information exchange between environment
+and agent a bit safer without introducing direct dependencies.
 </p>
 </html>
 </body>
diff --git a/src/aima/util/LUDecomposition.java b/src/aima/util/LUDecomposition.java
@@ -25,7 +25,7 @@ public class LUDecomposition implements java.io.Serializable {
 	 * 
 	 * @serial internal array storage.
 	 */
-	private double[][] LU;
+	private final double[][] LU;
 
 	/**
 	 * Row and column dimensions, and pivot sign.
@@ -34,25 +34,26 @@ public class LUDecomposition implements java.io.Serializable {
 	 * @serial row dimension.
 	 * @serial pivot sign.
 	 */
-	private int m, n, pivsign;
+	private final int m, n;
+
+	private int pivsign;
 
 	/**
 	 * Internal storage of pivot vector.
 	 * 
 	 * @serial pivot vector.
 	 */
-	private int[] piv;
+	private final int[] piv;
 
 	/*
 	 * ------------------------ Constructor ------------------------
 	 */
 
 	/**
-	 * LU Decomposition
+	 * LU Decomposition, a structure to access L, U and piv.
 	 * 
 	 * @param A
 	 *            Rectangular matrix
-	 * @return Structure to access L, U and piv.
 	 */
 
 	public LUDecomposition(Matrix A) {
diff --git a/src/aima/util/LabeledGraph.java b/src/aima/util/LabeledGraph.java
@@ -1,7 +1,6 @@
 package aima.util;
 
 import java.util.ArrayList;
-import java.util.Enumeration;
 import java.util.Hashtable;
 import java.util.List;
 
@@ -86,11 +85,8 @@ public List<VertexLabelType> getSuccessors(VertexLabelType v) {
 		List<VertexLabelType> result = new ArrayList<VertexLabelType>();
 		Hashtable<VertexLabelType, EdgeLabelType> localEdgeLookup = globalEdgeLookup
 				.get(v);
-		if (localEdgeLookup != null) {
-			Enumeration<VertexLabelType> successors = localEdgeLookup.keys();
-			while (successors.hasMoreElements())
-				result.add(successors.nextElement());
-		}
+		if (localEdgeLookup != null)
+			result.addAll(localEdgeLookup.keySet());
 		return result;
 	}
 
diff --git a/src/aima/util/Matrix.java b/src/aima/util/Matrix.java
@@ -71,15 +71,15 @@ public class Matrix implements Cloneable, java.io.Serializable {
 	 * 
 	 * @serial internal array storage.
 	 */
-	private double[][] A;
+	private final double[][] A;
 
 	/**
 	 * Row and column dimensions.
 	 * 
 	 * @serial row dimension.
 	 * @serial column dimension.
 	 */
-	private int m, n;
+	private final int m, n;
 
 	/*
 	 * ------------------------ Constructors ------------------------
@@ -436,9 +436,9 @@ public Matrix getMatrix(int i0, int i1, int[] c) {
 	 * 
 	 * @param r
 	 *            Array of row indices.
-	 * @param i0
+	 * @param j0
 	 *            Initial column index
-	 * @param i1
+	 * @param j1
 	 *            Final column index
 	 * @return A(r(:),j0:j1)
 	 * @exception ArrayIndexOutOfBoundsException

Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public void defineStringAttribute(String name, String[] attributeValues) {`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`/**`
`73`		`- * @param targetAttribute`
	`73`	`+ * @param target`
`74`	`74`	`* The targetAttribute to set.`
`75`	`75`	`*/`
`76`	`76`	`public void setTarget(String target) {`