Skip to content

Commit

Permalink
Docstring cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
Archdoog committed Jul 26, 2024
1 parent 097a32b commit 7e65d65
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 10 deletions.
14 changes: 5 additions & 9 deletions apple/Sources/FerrostarMapLibreUI/Views/NavigationMapView.swift
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,11 @@ public struct NavigationMapView: View {
/// Initialize a map view tuned for turn by turn navigation.
///
/// - Parameters:
/// - styleURL: The style URL for the map. This can dynamically change between light and dark mode.
/// - navigationState: The ferrostar navigations state. This is used primarily to drive user location on the map.
/// - camera: The camera which is controlled by the navigation state, but may also be pushed to for other cases
/// (e.g. user pan).
/// - snappedZoom: The zoom for the snapped camera. This can be fixed, customized or controlled by the camera.
/// - useSnappedCamera: Whether to use the ferrostar snapped camera or the camer binding itself.
/// - snappingBreakawayVelocity: The drag gesture velocity used to disable snapping. This can be tuned to prevent
/// accidental drags.
/// - content: Any additional MapLibre symbols to show on the map.
/// - styleURL: The map's style url.
/// - camera: The camera binding that represents the current camera on the map.
/// - navigationState: The current ferrostar navigation state provided by ferrostar core.
/// - onStyleLoaded: The map's style has loaded and the camera can be manipulated (e.g. to user tracking).
/// - makeMapContent: Custom maplibre symbols to display on the map view.
public init(
styleURL: URL,
camera: Binding<MapViewCamera>,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ struct PortraitNavigationOverlayView: View, CustomizableNavigatingInnerGridView
// when both the visualInstructions and progress are nil.
// It will automatically reduce height if and when either
// view appears
// TODO: Add dynamic speed, zoom & centering.
NavigatingInnerGridView(
speedLimit: speedLimit,
showZoom: showZoom,
Expand Down

0 comments on commit 7e65d65

Please sign in to comment.