Skip to content

Commit 9ed67d7

Browse files
authored
mapmathing: - added to services docs; - fix api-ref docs (#1400)
1 parent f55c0f8 commit 9ed67d7

3 files changed

Lines changed: 27 additions & 11 deletions

File tree

services-matching/src/main/java/com/mapbox/api/matching/v5/MapboxMapMatching.java

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,10 @@ public Builder waypointIndices(@Nullable @IntRange(from = 0) Integer... waypoint
422422
* Setting this will determine whether to return steps and turn-by-turn instructions. Can be
423423
* set to either true or false to enable or disable respectively. null can also optionally be
424424
* passed in to set the default behavior to match what the API does by default.
425+
*<p>
426+
* If `steps` is set to `true`, the following guidance-related parameters will be available:
427+
* `banner_instructions`, `language`, `roundabout_exits`, `voice_instructions`,
428+
* `voice_units`, `waypoint_names`, and `waypoints`.
425429
*
426430
* @param steps true if you'd like step information
427431
* @return this builder for chaining options together
@@ -443,11 +447,12 @@ public Builder waypointIndices(@Nullable @IntRange(from = 0) Integer... waypoint
443447
public abstract Builder overview(@Nullable @OverviewCriteria String overview);
444448

445449
/**
446-
* Setting this will determine Whether or not to return banner objects associated with
447-
* the `routeSteps`. Should be used in conjunction with `steps`.
448-
* Can be set to either true or false to enable or
450+
* Setting this will determine whether or not to return banner objects associated with
451+
* the `routeSteps`. Can be set to either true or false to enable or
449452
* disable respectively. null can also optionally be
450453
* passed in to set the default behavior to match what the API does by default.
454+
* <p>
455+
* Must be used in conjunction with `steps=true`.
451456
*
452457
* @param bannerInstructions true if you'd like step information
453458
* @return this builder for chaining options together
@@ -457,9 +462,11 @@ public Builder waypointIndices(@Nullable @IntRange(from = 0) Integer... waypoint
457462

458463

459464
/**
460-
* Setting this will determine whether to return steps and turn-by-turn instructions. Can be
461-
* set to either true or false to enable or disable respectively. null can also optionally be
462-
* passed in to set the default behavior to match what the API does by default.
465+
* Setting can be set to either true or false to enable or disable SSML marked-up text for
466+
* voice guidance along the route. null can also optionally be passed in to set the default
467+
* behavior to match what the API does by default.
468+
* <p>
469+
* Must be used in conjunction with `steps=true`.
463470
*
464471
* @param voiceInstructions true if you'd like step information
465472
* @return this builder for chaining options together
@@ -469,7 +476,8 @@ public Builder waypointIndices(@Nullable @IntRange(from = 0) Integer... waypoint
469476

470477
/**
471478
* Specify what unit you'd like voice and banner instructions to use.
472-
*
479+
* <p>
480+
* Must be used in conjunction with `steps=true` and `voice_instructions=true`.
473481
* @param voiceUnits either Imperial (default) or Metric
474482
* @return this builder for chaining options together
475483
* @since 3.0.0
@@ -479,9 +487,11 @@ public abstract Builder voiceUnits(
479487
);
480488

481489
/**
482-
* Setting this will determine whether to return steps and turn-by-turn instructions. Can be
483-
* set to either true or false to enable or disable respectively. null can also optionally be
484-
* passed in to set the default behavior to match what the API does by default.
490+
* Setting can be set to either true or false to enable or disable respectively.
491+
* null can also optionally be passed in to set the default behavior to match what the API
492+
* does by default.
493+
* <p>
494+
* Must be used in conjunction with `steps=true`.
485495
*
486496
* @param roundaboutExits true if you'd like step information
487497
* @return this builder for chaining options together
@@ -568,6 +578,8 @@ public Builder coordinate(@NonNull Point coordinate) {
568578
* Set the instruction language for the map matching request, the default is english. Only a
569579
* select number of languages are currently supported, reference the table provided in the see
570580
* link below.
581+
* <p>
582+
* Must be used in conjunction with `steps=true`.
571583
*
572584
* @param language a Locale value representing the language you'd like the instructions to be
573585
* written in when returned
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/**
2+
* Contains classes for accessing the Mapbox MapMatching API.
3+
*/
4+
package com.mapbox.api.matching.v5;

services/build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sourceSets {
66
'../services-optimization/src/main/java', '../services-staticmap/src/main/java',
77
'../services-speech/src/main/java', '../services-tilequery/src/main/java',
88
'../services-route-tiles/src/main/java', '../services-directions-refresh/src/main/java',
9-
'../services-isochrone/src/main/java']
9+
'../services-isochrone/src/main/java', '../services-matching/src/main/java']
1010
}
1111

1212
dependencies {

0 commit comments

Comments
 (0)