Generate documentation for dependencies (mapbox#2262)

SharperShape · Aug 22, 2024 · e469fc8 · e469fc8
1 parent 4eb4d65
commit e469fc8
Show file tree

Hide file tree

Showing 20 changed files with 195 additions and 155 deletions.
diff --git a/Sources/MapboxMaps/Documentation.docc/API Catalogs/Common.md b/Sources/MapboxMaps/Documentation.docc/API Catalogs/Common.md
diff --git a/Sources/MapboxMaps/Documentation.docc/API Catalogs/CommonInternal.md b/Sources/MapboxMaps/Documentation.docc/API Catalogs/CommonInternal.md
diff --git a/Sources/MapboxMaps/Documentation.docc/API Catalogs/CoreMaps.md b/Sources/MapboxMaps/Documentation.docc/API Catalogs/CoreMaps.md
@@ -1,11 +1,12 @@
-#  Core Maps
+#  Core Maps API
 
 Maps rendering SDK also known as GL-Native
 
 ## Topics
 
 ### Offline
-- <doc:Offline>
+- <doc://MapboxMaps/Offline>
 
 ### Free Camera
-- <doc:Free-Camera>
+- <doc://MapboxMaps/Free-Camera>
+
diff --git a/Sources/MapboxMaps/Documentation.docc/API Catalogs/CoreMapsInternal.md b/Sources/MapboxMaps/Documentation.docc/API Catalogs/CoreMapsInternal.md
@@ -5,6 +5,13 @@ Maps rendering SDK also known as GL-Native. These are for internal use only.
 ## Topics
 
 ### Symbols
+
+- ``MapRecorder-240jd``
+- ``FeatureExtensionValue``
+- ``Size``
+- ``StylePackError-class``
+- ``RequestErrorType``
+
 <!-- functions -->
 - ``MBMMapLoadingErrorTypeToString(_:)``
 - ``MBMRenderModeTypeToString(_:)``

diff --git a/Sources/MapboxMaps/Documentation.docc/API Catalogs/Events.md b/Sources/MapboxMaps/Documentation.docc/API Catalogs/Events.md
@@ -39,7 +39,7 @@ The simplified diagram of the events emitted by the map is displayed below.
 
 - ``Signal``
 - ``AnyCancelable``
-- ``Cancelable``
+- ``MapboxCommon/Cancelable``
 - ``EventTimeInterval``
 
 ### Extras

diff --git a/Sources/MapboxMaps/Documentation.docc/API Catalogs/Location APIs.md b/Sources/MapboxMaps/Documentation.docc/API Catalogs/Location APIs.md
@@ -11,24 +11,25 @@
 - ``Puck3DConfiguration``
 - ``Model``
 - ``PuckBearing``
-- ``Location``
-- ``LocationProvider``
+- ``MapboxCommon/Location``
+- ``MapboxCommon/LocationProvider``
 - ``AppleLocationProviderDelegate``
 - ``AppleLocationProvider``
-- ``LocationError``
-- ``Coordinate2D``
-- ``LocationExtraKeys``
-- ``LocationProviderRequest``
+- ``MapboxCommon/LocationError``
+- ``MapboxCommon/Coordinate2D``
+- ``MapboxCommon/LocationExtraKeys``
+- ``MapboxCommon/LocationProviderRequest``
 <!-- There are no methods or fields available. Should we remove it? -->
-- ``LocationServiceFactory``
-- ``DeviceLocationProvider``
+- ``MapboxCommon/LocationServiceFactory``
+- ``MapboxCommon/DeviceLocationProvider``
 - ``HeadingObserver``
 - ``HeadingProvider``
-- ``LocationObserver``
-- ``LocationServiceObserver``
+- ``MapboxCommon/LocationObserver``
+- ``MapboxCommon/LocationServiceObserver``
 - ``Heading``
 - ``PuckRenderingData``
-- ``AccuracyAuthorization``
-- ``AccuracyLevel``
-- ``LocationErrorCode``
-- ``PermissionStatus``
+- ``MapboxCommon/AccuracyAuthorization``
+- ``MapboxCommon/AccuracyLevel``
+- ``MapboxCommon/LocationErrorCode``
+- ``MapboxCommon/PermissionStatus``
+- ``MapboxCommon/IntervalSettings``
diff --git a/Sources/MapboxMaps/Documentation.docc/API Catalogs/Performance.md b/Sources/MapboxMaps/Documentation.docc/API Catalogs/Performance.md
@@ -8,7 +8,6 @@
 
 ### Map Recording
 
-- ``MapRecorder``
 - ``MapRecorderOptions-struct``
 - ``MapPlayerOptions-struct``
 
@@ -24,9 +23,9 @@
 
 ### Logs
 
-- ``LogConfiguration``
-- ``LogWriterBackend``
-- ``LoggingLevel``
+- ``MapboxCommon/LogConfiguration``
+- ``MapboxCommon/LogWriterBackend``
+- ``MapboxCommon/LoggingLevel``
 
 ### Debug
 
@@ -35,4 +34,4 @@
 
 ### Crashes
 
-- ``NSExceptionHandler``
+- ``MapboxCommon/NSExceptionHandler``
diff --git a/Sources/MapboxMaps/Documentation.docc/API Catalogs/Settings and Constants.md b/Sources/MapboxMaps/Documentation.docc/API Catalogs/Settings and Constants.md
@@ -5,20 +5,17 @@
 
 ### Settings
 
-- ``MapboxCommonSettings``
-- ``MapboxOptions``
+- ``MapboxCommon/MapboxCommonSettings``
+- ``MapboxCommon/MapboxOptions``
 - ``MapboxMapsOptions``
 
 ### Common Settings
 
-- ``SettingsService``
-- ``SettingsServiceFactory``
-- ``SettingsServiceError``
-- ``SettingsServiceStorageType``
-
-<!-- What is this? oO -->
-- ``IntervalSettings``
-- ``SdkInformation``
+- ``MapboxCommon/SettingsService``
+- ``MapboxCommon/SettingsServiceFactory``
+- ``MapboxCommon/SettingsServiceError``
+- ``MapboxCommon/SettingsServiceStorageType``
+- ``MapboxCommon/SdkInformation``
 
 ### Constants
 

diff --git a/Sources/MapboxMaps/Documentation.docc/API Catalogs/TileStore APIs.md b/Sources/MapboxMaps/Documentation.docc/API Catalogs/TileStore APIs.md
@@ -7,34 +7,34 @@
 
 ### TileStore
 
-- ``TileStore``
-- ``TileStoreOptions``
+- ``MapboxCommon/TileStore``
+- ``MapboxCommon/TileStoreOptions``
 - ``TileCacheBudget``
 - ``TileCacheBudgetInMegabytes``
 - ``TileCacheBudgetInTiles``
 - ``TileCoverOptions-struct``
 - ``TileOptions``
-- ``TileRegion``
+- ``MapboxCommon/TileRegion``
 - ``TileRegionError-enum``
-- ``TileRegionLoadOptions``
-- ``TileRegionLoadProgress``
+- ``MapboxCommon/TileRegionLoadOptions``
+- ``MapboxCommon/TileRegionLoadProgress``
 <!--- Should we hide it? There are no fields available -->
-- ``TilesetDescriptor``
+- ``MapboxCommon/TilesetDescriptor``
 - ``TilesetDescriptorOptions``
 - ``CanonicalTileID``
 - ``TileStoreObserver``
-- ``TileRegionLoadProgressCallback``
+- ``MapboxCommon/TileRegionLoadProgressCallback``
 - ``TileStoreUsageMode``
 - ``TileRegionError-enum``
 <!--should next item be public?-->
-- ``TileDataDomain``
+- ``MapboxCommon/TileDataDomain``
 - ``TileCacheBudgetType``
-- ``TileRegionEstimateOptions``
-- ``TileRegionEstimateProgress``
-- ``TileRegionEstimateResult``
-- ``TileRegionEstimateProgressCallback``
-- ``CacheClearingError``
-- ``CacheClearingErrorType``
+- ``MapboxCommon/TileRegionEstimateOptions``
+- ``MapboxCommon/TileRegionEstimateProgress``
+- ``MapboxCommon/TileRegionEstimateResult``
+- ``MapboxCommon/TileRegionEstimateProgressCallback``
+- ``MapboxCommon/CacheClearingError``
+- ``MapboxCommon/CacheClearingErrorType``
 
 ### Style pack
 

diff --git a/Sources/MapboxMaps/Documentation.docc/API Catalogs/Turf.md b/Sources/MapboxMaps/Documentation.docc/API Catalogs/Turf.md
diff --git a/Sources/MapboxMaps/Documentation.docc/API Catalogs/TurfAPI.md b/Sources/MapboxMaps/Documentation.docc/API Catalogs/TurfAPI.md
@@ -0,0 +1,12 @@
+# Turf
+
+Describes `turf-swift` dependency objects
+
+##  Topics
+
+### GeoJSON
+
+- ``Feature-swift.typealias``
+- ``Geometry-swift.typealias``
+- ``MapboxCommon/GeometryType``
+- ``Turf``
diff --git a/Sources/MapboxMaps/Documentation.docc/Documentation.md b/Sources/MapboxMaps/Documentation.docc/Documentation.md
@@ -46,11 +46,10 @@ The Mapbox Maps SDK for iOS is a public library for displaying interactive, thor
 - <doc:Gestures>
 - <doc:Settings-and-Constants>
 
+
 ### Dependencies
 - <doc:CoreMaps>
-- <doc:Common>
-- <doc:Turf>
+- <doc:TurfAPI>
 
 ### Internal
 - <doc:CoreMapsInternal>
-- <doc:CommonInternal>
diff --git a/Sources/MapboxMaps/Documentation.docc/Extensions/MapboxMap.md b/Sources/MapboxMaps/Documentation.docc/Extensions/MapboxMap.md
@@ -1,4 +1,4 @@
-# ``MapboxMap``
+# ``/MapboxMaps/MapboxMap``
 
 ## Topics
 

diff --git a/Sources/MapboxMaps/Documentation.docc/Overview.md b/Sources/MapboxMaps/Documentation.docc/Overview.md
@@ -0,0 +1,11 @@
+# MapboxMaps Documentation
+
+@Metadata {
+    @TechnologyRoot
+}
+
+## Topics
+
+- ``/MapboxMaps``
+- ``/MapboxCommon``
+- ``/Turf``
diff --git a/Sources/MapboxMaps/Foundation/MapRecorder.swift b/Sources/MapboxMaps/Foundation/MapRecorder.swift
@@ -27,8 +27,8 @@ import Foundation
     }
 
     /// Stops the current recording session.
-    /// Recorded section can be replayed with ``replay()`` function.
-    /// Returns the ``Data`` containing the recorded sequence in raw format.
+    /// Recorded section can be replayed with ``replay(recordedSequence:options:completion:)`` function.
+    /// Returns the `Data` containing the recorded sequence in raw format.
     public func stop() -> Data {
         recorder.stopRecording().data
     }

diff --git a/Sources/MapboxMaps/Foundation/MapboxMap.swift b/Sources/MapboxMaps/Foundation/MapboxMap.swift
@@ -1453,7 +1453,7 @@ extension MapboxMap {
 
 extension MapboxMap {
 
-    /// Create a ``MapRecorder`` to record the current MapboxMap
+    /// Create a ``MapRecorder-4soa`` to record the current MapboxMap
     @_spi(Experimental) public final func makeRecorder() throws -> MapRecorder {
         try MapRecorder(mapView: __map)
     }

diff --git a/project.yml b/project.yml
@@ -46,4 +46,4 @@ targets:
     settings:
       base:
         RUN_DOCUMENTATION_COMPILER: YES
-        OTHER_DOCC_FLAGS: "--warnings-as-errors"
+        OTHER_DOCC_FLAGS: "--help" # Disable embedded documentation compiler in favor of custom docc behavior. That should fix missing documentation symbols issue (MAPSIOS-1467).
diff --git a/scripts/doc-generation/build-docc.sh b/scripts/doc-generation/build-docc.sh
@@ -23,8 +23,9 @@ process_template() {
 
 build_doc() {
     pushd "$public_repo_root/"
+    xcodegen
     xcodebuild docbuild -config Release -scheme MapboxMaps -destination "generic/platform=iOS" \
-        COMPILER_INDEX_STORE_ENABLE=NO OTHER_DOCC_FLAGS="--warnings-as-errors --experimental-enable-custom-templates --output-path $docc_archive --hosting-base-path $hosting_base_path"
+        COMPILER_INDEX_STORE_ENABLE=NO OTHER_DOCC_FLAGS_UNIFIED="--experimental-enable-custom-templates --output-path $docc_archive --hosting-base-path $hosting_base_path"
     popd
 }