Skip to content

Commit

Permalink
mapmathing: - added to services docs; - fix api-ref docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RingerJK committed Apr 13, 2022
1 parent f55c0f8 commit 8cc26da
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,10 @@ 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.
*<p>
* 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
Expand All @@ -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.
* <p>
* Must be used in conjunction with `steps=true`.
*
* @param bannerInstructions true if you'd like step information
* @return this builder for chaining options together
Expand All @@ -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.
* <p>
* Must be used in conjunction with `steps=true`.
*
* @param voiceInstructions true if you'd like step information
* @return this builder for chaining options together
Expand All @@ -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.
*
* <p>
* 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
Expand All @@ -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.
* <p>
* Must be used in conjunction with `steps=true`.
*
* @param roundaboutExits true if you'd like step information
* @return this builder for chaining options together
Expand Down Expand Up @@ -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.
* <p>
* 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
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/**
* Contains classes for accessing the Mapbox MapMatching API.
*/
package com.mapbox.api.matching.v5;
2 changes: 1 addition & 1 deletion services/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down

0 comments on commit 8cc26da

Please sign in to comment.