summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicoleYarroch <nicole@livio.io>2021-01-07 09:56:47 -0500
committerGitHub <noreply@github.com>2021-01-07 09:56:47 -0500
commit18dfd8ae8d239eef2f6984a23cd4f137e1465c55 (patch)
tree55ef3c3aa7019057e29dd8ee9e23384efa42e35c
parent70105202d82543469fd4325eef6a1e9b8f5a987d (diff)
parent63d7bd71ef10bb70dcceac7b08c81e3f03cd0f32 (diff)
downloadsdl_ios-18dfd8ae8d239eef2f6984a23cd4f137e1465c55.tar.gz
Merge pull request #1877 from LuxoftSDL/feature/SDL0285_constantTBT_update
SDL0285: ShowConstantTBT Description Update
-rw-r--r--SmartDeviceLink/public/SDLShowConstantTBT.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/SmartDeviceLink/public/SDLShowConstantTBT.h b/SmartDeviceLink/public/SDLShowConstantTBT.h
index 3ac01780d..b45774838 100644
--- a/SmartDeviceLink/public/SDLShowConstantTBT.h
+++ b/SmartDeviceLink/public/SDLShowConstantTBT.h
@@ -25,8 +25,8 @@ NS_ASSUME_NONNULL_BEGIN
/// @param totalDistance The distance to the final destination
/// @param turnIcon An icon to show with the turn description
/// @param nextTurnIcon An icon to show with the next turn description
-/// @param distanceToManeuver Fraction of distance till next maneuver
-/// @param distanceToManeuverScale Distance till next maneuver
+/// @param distanceToManeuver Distance (in meters) until next maneuver.
+/// @param distanceToManeuverScale Distance (in meters) from previous maneuver to next maneuver.
/// @param maneuverComplete If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay. If omitted the value will be assumed as FALSE
/// @param softButtons Three dynamic SoftButtons available (first SoftButton is fixed to "Turns")
/// @return An SDLShowConstantTBT object
@@ -86,14 +86,14 @@ NS_ASSUME_NONNULL_BEGIN
@property (strong, nonatomic, nullable) SDLImage *nextTurnIcon;
/**
- * Fraction of distance till next maneuver (starting from when AlertManeuver is triggered). Used to calculate progress bar.
+ * Distance (in meters) until next maneuver. May be used to calculate progress bar.
*
* Optional, Float, 0 - 1,000,000,000
*/
@property (strong, nonatomic, nullable) NSNumber<SDLFloat> *distanceToManeuver;
/**
- * Distance till next maneuver (starting from) from previous maneuver. Used to calculate progress bar.
+ * Distance (in meters) from previous maneuver to next maneuver. May be used to calculate progress bar.
*
* Optional, Float, 0 - 1,000,000,000
*/