From 07a87d8c2e986c2605fd90f8c0e50ccb00248c0f Mon Sep 17 00:00:00 2001 From: Ivan Persidsky Date: Wed, 15 Jan 2025 12:38:51 +0200 Subject: [PATCH] Fix docc errors --- .../SwiftUI Examples/StandardStyleLocationsExample.swift | 2 +- .../API Catalogs/Featuresets and Interactions.md | 3 +-- .../Documentation.docc/API Catalogs/MapboxMap APIs.md | 1 - Sources/MapboxMaps/Foundation/RenderedQueryGeometry.swift | 2 +- Sources/MapboxMaps/Style/MapStyle.swift | 2 +- 5 files changed, 4 insertions(+), 6 deletions(-) diff --git a/Sources/Examples/SwiftUI Examples/StandardStyleLocationsExample.swift b/Sources/Examples/SwiftUI Examples/StandardStyleLocationsExample.swift index 7864ef1873bb..3fd7c5600ceb 100644 --- a/Sources/Examples/SwiftUI Examples/StandardStyleLocationsExample.swift +++ b/Sources/Examples/SwiftUI Examples/StandardStyleLocationsExample.swift @@ -4,7 +4,7 @@ import SwiftUI struct StandardStyleLocationsExample: View { /// This model is created in root application views for each platform: /// - /// - ``VisionOSMain`` for visionOS + /// - `VisionOSMain` for visionOS /// - ``SwiftUIWrapper`` view for iOS @EnvironmentObject var model: StandardStyleLocationsModel @State private var settingsHeight: CGFloat = 0 diff --git a/Sources/MapboxMaps/Documentation.docc/API Catalogs/Featuresets and Interactions.md b/Sources/MapboxMaps/Documentation.docc/API Catalogs/Featuresets and Interactions.md index 420196046340..0755959dd117 100644 --- a/Sources/MapboxMaps/Documentation.docc/API Catalogs/Featuresets and Interactions.md +++ b/Sources/MapboxMaps/Documentation.docc/API Catalogs/Featuresets and Interactions.md @@ -129,9 +129,8 @@ In UIKit applications, use ``MapboxMap/setFeatureState(_:state:callback:)`` and - ``LongPressInteraction`` ### Featuresets -- ``FeaturesetDescriptor-struct`` +- ``FeaturesetDescriptor`` - ``FeaturesetFeatureId`` -- ``FeaturesetQueryTarget`` ### Feature types - ``FeaturesetFeatureType`` diff --git a/Sources/MapboxMaps/Documentation.docc/API Catalogs/MapboxMap APIs.md b/Sources/MapboxMaps/Documentation.docc/API Catalogs/MapboxMap APIs.md index 968b97e8eb21..b0d55ffcef1c 100644 --- a/Sources/MapboxMaps/Documentation.docc/API Catalogs/MapboxMap APIs.md +++ b/Sources/MapboxMaps/Documentation.docc/API Catalogs/MapboxMap APIs.md @@ -34,4 +34,3 @@ - ``QueriedSourceFeature`` - ``RenderedQueryOptions`` - ``AnnotatedFeature`` -- ``FeaturesetDescriptor-class`` diff --git a/Sources/MapboxMaps/Foundation/RenderedQueryGeometry.swift b/Sources/MapboxMaps/Foundation/RenderedQueryGeometry.swift index 74d869b88269..edf5126d1753 100644 --- a/Sources/MapboxMaps/Foundation/RenderedQueryGeometry.swift +++ b/Sources/MapboxMaps/Foundation/RenderedQueryGeometry.swift @@ -1,6 +1,6 @@ /// A geometry to define a portion of screen that should be queried for rendered features. /// -/// See ``MapboxMap/queryRenderedFeatures(with:targets:completion:)`` and ``MapboxMap/queryRenderedFeatures(with:options:completion:)`` for more information. +/// See ``MapboxMap/queryRenderedFeatures(featureset:filter:completion:)`` and ``MapboxMap/queryRenderedFeatures(with:options:completion:)`` for more information. public struct RenderedQueryGeometry { let core: CoreRenderedQueryGeometry diff --git a/Sources/MapboxMaps/Style/MapStyle.swift b/Sources/MapboxMaps/Style/MapStyle.swift index bae389ca33d9..adf9a5717c72 100644 --- a/Sources/MapboxMaps/Style/MapStyle.swift +++ b/Sources/MapboxMaps/Style/MapStyle.swift @@ -32,7 +32,7 @@ import MapboxCoreMaps /// } /// ``` /// -/// The ``MapStyle/standard(theme:lightPreset:font:showPointOfInterestLabels:showTransitLabels:showPlaceLabels:showRoadLabels:show3dObjects:)`` factory method lists the predefined parameters that Standard Style supports. You can also use the Classic Mapbox-designed styles such as ``MapStyle/satelliteStreets``, ``MapStyle/outdoors``, and many more. Or use custom styles that you design with [Mapbox Studio](https://www.mapbox.com/mapbox-studio). +/// The ``MapStyle/standard(theme:lightPreset:font:showPointOfInterestLabels:showTransitLabels:showPlaceLabels:showRoadLabels:showPedestrianRoads:show3dObjects:colorMotorways:colorPlaceLabelHighlight:colorPlaceLabelSelect:colorRoads:colorTrunks:themeData:)`` factory method lists the predefined parameters that Standard Style supports. You can also use the Classic Mapbox-designed styles such as ``MapStyle/satelliteStreets``, ``MapStyle/outdoors``, and many more. Or use custom styles that you design with [Mapbox Studio](https://www.mapbox.com/mapbox-studio). /// /// /// - Important: Configuration can be applied only to `.standard` style or styles that uses `.standard` as import. For any other styles configuration will make no effect.