+ * If `steps` is set to `true`, the following guidance-related parameters will be available: + * `banner_instructions`, `language`, `roundabout_exits`, `voice_instructions`, + * `voice_units`, `waypoint_names`, and `waypoints`. * * @param steps true if you'd like step information * @return this builder for chaining options together @@ -443,11 +447,12 @@ public Builder waypointIndices(@Nullable @IntRange(from = 0) Integer... waypoint public abstract Builder overview(@Nullable @OverviewCriteria String overview); /** - * Setting this will determine Whether or not to return banner objects associated with - * the `routeSteps`. Should be used in conjunction with `steps`. - * Can be set to either true or false to enable or + * Setting this will determine whether or not to return banner objects associated with + * the `routeSteps`. Can be set to either true or false to enable or * disable respectively. null can also optionally be * passed in to set the default behavior to match what the API does by default. + *
+ * Must be used in conjunction with `steps=true`. * * @param bannerInstructions true if you'd like step information * @return this builder for chaining options together @@ -457,9 +462,11 @@ public Builder waypointIndices(@Nullable @IntRange(from = 0) Integer... waypoint /** - * Setting this will determine whether to return steps and turn-by-turn instructions. Can be - * set to either true or false to enable or disable respectively. null can also optionally be - * passed in to set the default behavior to match what the API does by default. + * Setting can be set to either true or false to enable or disable SSML marked-up text for + * voice guidance along the route. null can also optionally be passed in to set the default + * behavior to match what the API does by default. + *
+ * Must be used in conjunction with `steps=true`. * * @param voiceInstructions true if you'd like step information * @return this builder for chaining options together @@ -469,7 +476,8 @@ public Builder waypointIndices(@Nullable @IntRange(from = 0) Integer... waypoint /** * Specify what unit you'd like voice and banner instructions to use. - * + *
+ * Must be used in conjunction with `steps=true` and `voice_instructions=true`. * @param voiceUnits either Imperial (default) or Metric * @return this builder for chaining options together * @since 3.0.0 @@ -479,9 +487,11 @@ public abstract Builder voiceUnits( ); /** - * Setting this will determine whether to return steps and turn-by-turn instructions. Can be - * set to either true or false to enable or disable respectively. null can also optionally be - * passed in to set the default behavior to match what the API does by default. + * Setting can be set to either true or false to enable or disable respectively. + * null can also optionally be passed in to set the default behavior to match what the API + * does by default. + *
+ * Must be used in conjunction with `steps=true`. * * @param roundaboutExits true if you'd like step information * @return this builder for chaining options together @@ -568,6 +578,8 @@ public Builder coordinate(@NonNull Point coordinate) { * Set the instruction language for the map matching request, the default is english. Only a * select number of languages are currently supported, reference the table provided in the see * link below. + *
+ * Must be used in conjunction with `steps=true`. * * @param language a Locale value representing the language you'd like the instructions to be * written in when returned diff --git a/services-matching/src/test/java/com/mapbox/api/matching/v5/package-info.java b/services-matching/src/test/java/com/mapbox/api/matching/v5/package-info.java new file mode 100644 index 000000000..412ca4086 --- /dev/null +++ b/services-matching/src/test/java/com/mapbox/api/matching/v5/package-info.java @@ -0,0 +1,4 @@ +/** + * Contains classes for accessing the Mapbox MapMatching API. + */ +package com.mapbox.api.matching.v5; diff --git a/services/build.gradle b/services/build.gradle index 837f08815..1fba4157c 100644 --- a/services/build.gradle +++ b/services/build.gradle @@ -6,7 +6,7 @@ sourceSets { '../services-optimization/src/main/java', '../services-staticmap/src/main/java', '../services-speech/src/main/java', '../services-tilequery/src/main/java', '../services-route-tiles/src/main/java', '../services-directions-refresh/src/main/java', - '../services-isochrone/src/main/java'] + '../services-isochrone/src/main/java', '../services-matching/src/main/java'] } dependencies {