Merge pull request #9 from markmcd/fixjavadoc

🚧 fixed javadoc warnings
googlemaps · Sep 1, 2014 · dd15aed · dd15aed
2 parents d2f9efc + 66931b8
commit dd15aed
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 20 deletions.
diff --git a/src/main/java/com/google/maps/DirectionsApiRequest.java b/src/main/java/com/google/maps/DirectionsApiRequest.java
@@ -100,8 +100,8 @@ public DirectionsApiRequest mode(TravelMode mode) {
   /**
    * Indicates that the calculated route(s) should avoid the indicated features.
    *
-   * @param restrictions one or more of {@link Restriction#TOLLS},
-   *     {@link Restriction#HIGHWAYS}, {@link Restriction#FERRIES}
+   * @param restrictions one or more of {@link RouteRestriction#TOLLS},
+   *     {@link RouteRestriction#HIGHWAYS}, {@link RouteRestriction#FERRIES}
    */
   public DirectionsApiRequest avoid(RouteRestriction... restrictions) {
     return param("avoid", join('|', restrictions));

diff --git a/src/main/java/com/google/maps/DistanceMatrixApiRequest.java b/src/main/java/com/google/maps/DistanceMatrixApiRequest.java
@@ -106,8 +106,8 @@ public DistanceMatrixApiRequest mode(TravelMode mode) {
   /**
    * Introduces restrictions to the route. Only one restriction can be specified.
    *
-   * @param restriction  One of {@link Restriction#TOLLS}, {@link Restriction#FERRIES} or {@link
-   * Restriction#HIGHWAYS}.
+   * @param restriction  One of {@link RouteRestriction#TOLLS}, {@link RouteRestriction#FERRIES} or
+   * {@link RouteRestriction#HIGHWAYS}.
    */
   public DistanceMatrixApiRequest avoid(RouteRestriction restriction) {
     return param("avoid", restriction);

diff --git a/src/main/java/com/google/maps/model/DirectionsLeg.java b/src/main/java/com/google/maps/model/DirectionsLeg.java
@@ -20,7 +20,8 @@
 /**
  * A component of a Directions API result.
  *
- * See {@url https://developers.google.com/maps/documentation/directions/#Legs} for more detail.
+ * See <a href="https://developers.google.com/maps/documentation/directions/#Legs">the Legs
+ * documentation</a> for more detail.
  */
 public class DirectionsLeg {
 

diff --git a/src/main/java/com/google/maps/model/DirectionsRoute.java b/src/main/java/com/google/maps/model/DirectionsRoute.java
@@ -20,7 +20,8 @@
  * array. Even if the service returns no results (such as if the origin and/or destination doesn't
  * exist) it still returns an empty routes array.
  *
- * <p>Please see {@url https://developers.google.com/maps/documentation/directions/#Routes} for
+ * <p>Please see <a href="https://developers.google
+ * .com/maps/documentation/directions/#Routes">Routes</a> for
  * more detail.
  */
 public class DirectionsRoute {

diff --git a/src/main/java/com/google/maps/model/DirectionsStep.java b/src/main/java/com/google/maps/model/DirectionsStep.java
@@ -25,13 +25,12 @@
  * that the next step is 37 miles/40 minutes from this step.
  *
  * <p>When using the Directions API to search for transit directions, the steps array will include
- * additional Transit Details
- * {@url https://developers.google.com/maps/documentation/directions/#TransitDetails}
- * in the form of a {@code transitDetails} array. If the directions include multiple modes of
- * transportation, detailed directions will be provided for walking or driving steps in a
- * {@code subSteps} array. For example, a walking step will include directions from the start and
- * end locations: "Walk to Innes Ave & Fitch St". That step will include detailed walking
- * directions for that route in the {@code subSteps} array, such as: "Head north-west",
+ * additional <a href="https://developers.google.com/maps/documentation/directions/#TransitDetails">
+ * Transit Details</a> in the form of a {@code transitDetails} array. If the directions include
+ * multiple modes of transportation, detailed directions will be provided for walking or driving
+ * steps in a {@code subSteps} array. For example, a walking step will include directions from
+ * the start and end locations: "Walk to Innes Ave & Fitch St". That step will include detailed
+ * walking directions for that route in the {@code subSteps} array, such as: "Head north-west",
  * "Turn left onto Arelious Walker", and "Turn left onto Innes Ave".
  */
 public class DirectionsStep {
@@ -75,8 +74,8 @@ public class DirectionsStep {
 
   /**
    * {@code travelMode} is the travel mode of this step. See
-   * {@url https://developers.google.com/maps/documentation/directions/#TravelModes} for
-   * more detail.
+   * <a href="https://developers.google.com/maps/documentation/directions/#TravelModes">Travel
+   * Modes</a> for more detail.
    */
   public TravelMode travelMode;
 }
diff --git a/src/main/java/com/google/maps/model/EncodedPolyline.java b/src/main/java/com/google/maps/model/EncodedPolyline.java
@@ -22,14 +22,15 @@
 /**
  * Encoded Polylines are used by the API to represent paths.
  *
- * <p>See {@url https://developers.google.com/maps/documentation/utilities/polylinealgorithm} for
- * more detail on the protocol.
+ * <p>See <a href="https://developers.google
+ * .com/maps/documentation/utilities/polylinealgorithm">Encoded Polyline Algorithm</a> for more
+ * detail on the protocol.
  */
 public class EncodedPolyline {
   private String points;
 
   /**
-   * @param encodedPath A string representation of a path, encoded with the Polyline Algorithm.
+   * @param encodedPoints A string representation of a path, encoded with the Polyline Algorithm.
    */
   public EncodedPolyline(String encodedPoints) {
     this.points = encodedPoints;

diff --git a/src/test/java/com/google/maps/internal/UrlSignerTest.java b/src/test/java/com/google/maps/internal/UrlSignerTest.java
@@ -19,11 +19,11 @@
 
 import com.google.maps.SmallTests;
 
+import okio.ByteString;
+
 import org.junit.Test;
 import org.junit.experimental.categories.Category;
 
-import okio.ByteString;
-
 /**
  * Test case for {@link UrlSigner}.
  */