Skip to content

Commit 8baa2ed

Browse files
persidskiygithub-actions[bot]
authored andcommitted
Update viewport doc (#3568)
https://mapbox.atlassian.net/browse/MAPSIOS-1798 Users tend to directly call methods that are not indended for that cc @mapbox/sdk-ci GitOrigin-RevId: 292073e79d0c58d133e4fb5ed16737224ab0a406
1 parent bb47955 commit 8baa2ed

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

Sources/MapboxMaps/Viewport/ViewportState.swift

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,10 @@ public protocol ViewportState: AnyObject {
4949
/// ``ViewportManager`` calls this method at the end of a successful transition into this state.
5050
///
5151
/// Implementations typically have a dependency on either ``MapboxMap`` so that they can use its
52-
/// ``MapboxMap/setCamera(to:)`` method to change the camea or on
52+
/// ``MapboxMap/setCamera(to:)`` method to change the camera or on
5353
/// ``CameraAnimationsManager`` so that they can run camera animations.
54+
///
55+
/// - Important: Don't call this method directly, instead activate the viewport via ``ViewportManager/transition(to:transition:completion:)``.
5456
func startUpdatingCamera()
5557

5658
/// Tells this state that it is no longer responsible for updating the camera.
@@ -59,5 +61,7 @@ public protocol ViewportState: AnyObject {
5961
///
6062
/// Implementations must stop updating the camera immediately and should typically cancel any
6163
/// ongoing animations that they started when this method is invoked.
64+
///
65+
/// - Important: Don't call this method directly. Instead, use ``ViewportManager/idle()`` to stop animations in progress.
6266
func stopUpdatingCamera()
6367
}

0 commit comments

Comments
 (0)