Resolved Javadoc errors and warnings.

Author: Tyler Coles

src/main/java/com/javadocmd/simplelatlng/Geohasher.java

@@ -35,12 +35,12 @@ public class Geohasher {
 
 	/**
 	 * <p>Number of hash characters supported.</p> 
-	 * <p>Translates to binary bits per value by the formula:<br/>
-	 * BITS = ((PRECISION * 5) / 2) + PRECISION % 2.</p>
+	 * <p>Translates to binary bits per value by the formula:</p>
+	 * <pre>BITS = ((PRECISION * 5) / 2) + PRECISION % 2.</pre>
 	 * <p>BITS in turn translates to numerical precision
-	 * by the formula:<br/>
-	 * LATITUDE_ERROR = 90.0 / (2 ^ (BITS + 1))<br/>
-	 * LONGITUDE_ERROR = 180.0 / (2 ^ (BITS + 1))</p>
+	 * by the formula:</p>
+	 * <pre>LATITUDE_ERROR = 90.0 / (2 ^ (BITS + 1))
+	 *LONGITUDE_ERROR = 180.0 / (2 ^ (BITS + 1))</pre>
 	 */
 	public static final int PRECISION = 12;
 	private static final int BITS = ((PRECISION * 5) / 2) + PRECISION % 2;
@@ -88,7 +88,10 @@ public static LatLng decode(String hash) {
 	}
 
 	/**
-	 * Converts a hash string into a string of bits.
+	 * Converts a hash string into a series of bits.
+	 * 
+	 * @param hash the geohash string.
+	 * @return the bits in the geohash.
 	 */
 	protected static BitSet hashToBits(String hash) {
 		try {

src/main/java/com/javadocmd/simplelatlng/LatLng.java

@@ -37,6 +37,8 @@ public class LatLng implements Serializable {
 
 	/**
 	 * Creates a random latitude and longitude. (Not inclusive of (-90, 0))
+	 * 
+	 * @return the random LatLng.
 	 */
 	public static LatLng random() {
 		return random(new Random());
@@ -47,6 +49,7 @@ public static LatLng random() {
 	 * 
 	 * @param r the random number generator to use, if you want to be 
 	 * specific or are creating many LatLngs at once.
+	 * @return the random LatLng.
 	 */
 	public static LatLng random(Random r) {
 		return new LatLng((r.nextDouble() * -180.0) + 90.0,
@@ -159,7 +162,7 @@ private void setLongitude(double longitude) {
 	}
 
 	/**
-	 * Returns true if this LatLng represents a polar coordinate (+/- 90 degrees latitude).
+	 * @return true if this LatLng represents a polar coordinate (+/- 90 degrees latitude).
 	 */
 	public boolean isPolar() {
 		return this.latitude == 90000000L || this.latitude == -90000000L;

src/main/java/com/javadocmd/simplelatlng/LatLngTool.java

@@ -83,6 +83,10 @@ public static double distance(LatLng point1, LatLng point2, LengthUnit unit) {
 	 * to get the length of the arc.
 	 * </p>
 	 * 
+	 * @param point1
+	 *            the first point.
+	 * @param point2
+	 *            the second point.
 	 * @return the internal angle for the arc connecting the two points in
 	 *         radians.
 	 */

src/main/java/com/javadocmd/simplelatlng/window/FilterHelper.java

@@ -18,14 +18,14 @@
 import com.javadocmd.simplelatlng.LatLng;
 
 /**
- * An abstract class to help LatLngWindows with the task of 
+ * <p>An abstract class to help LatLngWindows with the task of 
  * filtering collections based on whether or not a point
  * is contained within the window. Rather than only filter
  * collections of LatLng, this helper enables you to filter
  * any class that has a LatLng value or for which a LatLng
- * value can be computed.<br/><br/>
- * An example of how you would instantiate a helper for 
- * filtering on a collection of type MyObject:<br/>
+ * value can be computed.</p>
+ * <p>An example of how you would instantiate a helper for 
+ * filtering on a collection of type MyObject:</p>
  * <pre>FilterHelper&lt;MyObject&gt; helper = new FilterHelper&lt;MyObject&gt;() {
  *    &#64;Override
  *    public LatLng getLatLng(MyObject object) {
@@ -40,8 +40,8 @@
 public abstract class FilterHelper<S> {
 
 	/**
-	 * Returns <code>object</code>'s <code>LatLng</code>
-	 * value to be filtered.
+	 * @param object the object being filtered.
+	 * @return the <code>LatLng</code> value to use in the filter.
 	 */
 	public abstract LatLng getLatLng(S object);
 }