Skip to content

Commit 81504bb

Browse files
committed
Fixed Route documentation
The Route class documentation comment was attached to the private CodingKeys enumeration for some reason. Also removed an extraneous import statement.
1 parent 62a3d81 commit 81504bb

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

Sources/MapboxDirections/Route.swift

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
1-
import Polyline
2-
31
/**
42
A `Route` object defines a single route that the user can follow to visit a series of waypoints in order. The route object includes information about the route, such as its distance and expected travel time. Depending on the criteria used to calculate the route, the route object may also include detailed turn-by-turn instructions.
53

64
Typically, you do not create instances of this class directly. Instead, you receive route objects when you request directions using the `Directions.calculate(_:completionHandler:)` method. However, if you use the `Directions.url(forCalculating:)` method instead, you can pass the results of the HTTP request into this class’s initializer.
75
*/
8-
private enum CodingKeys: String, CodingKey {
9-
case routeOptions
10-
}
11-
126
open class Route: DirectionsResult {
7+
private enum CodingKeys: String, CodingKey {
8+
case routeOptions
9+
}
10+
1311
public required init(from decoder: Decoder) throws {
1412
if let matchOptions = decoder.userInfo[.options] as? MatchOptions {
1513
routeOptions = RouteOptions(matchOptions: matchOptions)

0 commit comments

Comments
 (0)