Skip to content

Commit c7234e2

Browse files
pjleonard37github-actions[bot]
authored andcommitted
Add documentation for SymbolScaleBehavior (#10865)
Adds documentation for SymbolScaleBehavior introduced [here](mapbox/mapbox-sdk#9946). <img width="676" height="550" alt="Screenshot 2026-03-09 at 9 42 55 AM" src="https://github.com/user-attachments/assets/da2d4353-3868-4660-bd54-b57883cceec5" /> cc @mapbox/maps-ios GitOrigin-RevId: dc5d4613c595c9dd5788d168d4b9df2e9c317c05
1 parent 544197d commit c7234e2

File tree

4 files changed

+6
-0
lines changed

4 files changed

+6
-0
lines changed

Sources/MapboxMaps/Documentation.docc/API Catalogs/MapboxMap APIs.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
- ``MapCenterAltitudeMode``
2121
- ``RenderedQueryGeometry``
2222
- ``RenderedQueryGeometryConvertible``
23+
- ``SymbolScaleBehavior``
2324

2425
### Camera
2526
- ``FreeCameraOptions``

Sources/MapboxMaps/Foundation/MapboxMap.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1120,6 +1120,7 @@ public final class MapboxMap: StyleManager {
11201120
/// symbolScaleBehavior = .system // Auto-scale
11211121
/// symbolScaleBehavior = .system { min($0 * 1.2, 1.5) } // Custom
11221122
/// ```
1123+
@_documentation(visibility: public)
11231124
@_spi(Experimental)
11241125
public var symbolScaleBehavior: SymbolScaleBehavior = .fixed(scaleFactor: 1.0) {
11251126
didSet {

Sources/MapboxMaps/Foundation/SymbolScaleBehavior.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import UIKit
66
/// Use factory methods to create instances:
77
/// - `.system` - Automatic scaling with default or custom mapping
88
/// - `.fixed(scaleFactor:)` - Fixed scale factor, no dynamic updates
9+
@_documentation(visibility: public)
910
@_spi(Experimental)
1011
public struct SymbolScaleBehavior: Equatable {
1112
internal enum Mode {

scripts/api-compatibility-check/breakage_allowlist.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2254,3 +2254,6 @@ Extension String has removed conformance to RegexComponent
22542254
Constructor Model.init(id:uri:position:orientation:) has been removed
22552255
// Update experimental Marker interaction APIs
22562256
Func Marker.onTapGesture(perform:) has been removed
2257+
2258+
Struct SymbolScaleBehavior is now with @_documentation
2259+
Var MapboxMap.symbolScaleBehavior is now with @_documentation

0 commit comments

Comments
 (0)