Reworded use-lane documentation

mapbox · Nov 10, 2016 · d7c0af0 · d7c0af0
1 parent e00ff06
commit d7c0af0
Showing 1 changed file with 13 additions and 11 deletions.
diff --git a/MapboxDirections/MBRouteStep.swift b/MapboxDirections/MBRouteStep.swift
@@ -175,6 +175,15 @@ public enum ManeuverType: Int, CustomStringConvertible {
      The exit index indicates the number of rotary exits up to and including the exit that the user must take.
      */
     case TakeRotary
+
+    /**
+     The step requires the user to get into a specific lane in order to continue along the current road.
+     
+     The `maneuverDirection` property is set to `StraightAhead`. Each lane specified by the first intersection’s `usableApproachLanes` property also has an `indications` property set to `StraightAhead`. A maneuver in a different direction would instead have a maneuver type of `Turn`.
+     
+     This maneuver type is called out separately so that the application can present the user with lane guidance based on the first element in the `intersections` property. If lane guidance is unimportant to you, you may treat the maneuver as an ordinary `Continue` or ignore it.
+     */
+    case UseLane
 
     /**
      The step requires the user to enter, traverse, and exit a roundabout (traffic circle or rotary).
@@ -199,13 +208,6 @@ public enum ManeuverType: Int, CustomStringConvertible {
      */
     case HeedWarning
 
-    /**
-     The step requires the user to use certain lanes
-    
-     The modifiers and lane indications of the lanes will always be straight
-     */
-    case UseLane
-
     /**
      The step requires the user to arrive at a waypoint.
      
@@ -241,6 +243,8 @@ public enum ManeuverType: Int, CustomStringConvertible {
             type = .ReachFork
         case "end of road":
             type = .ReachEnd
+        case "use lane":
+            type = .UseLane
         case "rotary":
             type = .TakeRotary
         case "roundabout":
@@ -249,8 +253,6 @@ public enum ManeuverType: Int, CustomStringConvertible {
             type = .TurnAtRoundabout
         case "notification":
             type = .HeedWarning
-        case "use lane":
-            type = .UseLane
         case "arrive":
             type = .Arrive
         case "waypoint": // v4
@@ -281,6 +283,8 @@ public enum ManeuverType: Int, CustomStringConvertible {
             return "fork"
         case .ReachEnd:
             return "end of road"
+        case .UseLane:
+            return "use lane"
         case .TakeRotary:
             return "rotary"
         case .TakeRoundabout:
@@ -289,8 +293,6 @@ public enum ManeuverType: Int, CustomStringConvertible {
             return "roundabout turn"
         case .HeedWarning:
             return "notification"
-        case .UseLane:
-            return "use lane"
         case .Arrive:
             return "arrive"
         case .PassWaypoint: // v4