Skip to content

Commit

Permalink
Remove topics marked for hiding (#1939)
Browse files Browse the repository at this point in the history
* Remove internal topics

* Move Core and Common Internals to Separate Section

* Updates based on review
  • Loading branch information
pjleonard37 authored Dec 14, 2023
1 parent de35dcb commit bdd8d86
Show file tree
Hide file tree
Showing 7 changed files with 93 additions and 75 deletions.
38 changes: 0 additions & 38 deletions Sources/MapboxMaps/Documentation.docc/API Catalogs/Common.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,41 +12,3 @@ Mapbox SDK to share objects and utilities across SDKs.
- ``Feature-class``
- ``FeatureExtensionValue``
- <doc:Network>

<!--### Consider to hide-->

- ``NSExceptionHandler``

<!--### Internal (need to hide)-->
- ``OfflineSwitch-7t81h``
- ``StylePackError-class``
- ``ValueConverter``
- ``TileRegionError-class``

<!-- functions -->
- ``MBXAccuracyAuthorizationToString(_:)``
- ``MBXHttpMethodToString(_:)``
- ``MBXHttpRequestErrorTypeToString(_:)``
- ``MBXLocationErrorCodeToString(_:)``
- ``MBXLoggingLevelToString(_:)``
- ``MBXPermissionStatusToString(_:)``
- ``MBXTileDataDomainToString(_:)``
- ``MBXTileRegionErrorTypeToString(_:)``

<!-- global variables -->
- ``GeometryType_Empty``
- ``GeometryType_GeometryCollection``
- ``GeometryType_Line``
- ``GeometryType_MultiLine``
- ``GeometryType_MultiPoint``
- ``GeometryType_MultiPolygon``
- ``GeometryType_Point``
- ``GeometryType_Polygon``


<!-- type aliases -->
- ``GetLocationCallback``
- ``HttpResponseCallback``

<!-- enums -->
- ``TileRegionErrorType``
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Common SDK - Internal

Mapbox SDK to share objects and utilities across SDKs. These are for internal use only.

## Topics

### Symbols

- ``NSExceptionHandler``
- ``OfflineSwitch-7t81h``
- ``StylePackError-class``
- ``ValueConverter``
- ``TileRegionError-class``

<!-- functions -->
- ``MBXAccuracyAuthorizationToString(_:)``
- ``MBXHttpMethodToString(_:)``
- ``MBXHttpRequestErrorTypeToString(_:)``
- ``MBXLocationErrorCodeToString(_:)``
- ``MBXLoggingLevelToString(_:)``
- ``MBXPermissionStatusToString(_:)``
- ``MBXTileDataDomainToString(_:)``
- ``MBXTileRegionErrorTypeToString(_:)``

<!-- global variables -->
- ``GeometryType_Empty``
- ``GeometryType_GeometryCollection``
- ``GeometryType_Line``
- ``GeometryType_MultiLine``
- ``GeometryType_MultiPoint``
- ``GeometryType_MultiPolygon``
- ``GeometryType_Point``
- ``GeometryType_Polygon``

<!-- type aliases -->
- ``GetLocationCallback``
- ``HttpResponseCallback``

<!-- enums -->
- ``TileRegionErrorType``
39 changes: 2 additions & 37 deletions Sources/MapboxMaps/Documentation.docc/API Catalogs/CoreMaps.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,5 @@ Maps rendering SDK also known as GL-Native
### Offline
- <doc:Offline>

<!--### Decide what to do-->
- ``Vec3``
- ``Vec4``

<!--### Internal (to hide)-->

<!-- functions -->
- ``MBMMapLoadingErrorTypeToString(_:)``
- ``MBMRenderModeTypeToString(_:)``
- ``MBMRequestDataSourceTypeToString(_:)``
- ``MBMRequestErrorTypeToString(_:)``
- ``MBMRequestLoadingMethodTypeToString(_:)``
- ``MBMRequestPriorityTypeToString(_:)``
- ``MBMRequestPriorityTypeToString(_:)``
- ``MBMRequestResourceTypeToString(_:)``
- ``MBMResponseSourceTypeToString(_:)``
- ``MBMSourceDataLoadedTypeToString(_:)``
- ``MBMStyleDataLoadedTypeToString(_:)``
- ``MBMTileStoreUsageModeToString(_:)``

<!-- type aliases -->
- ``CameraChangedCallback``
- ``GenericEventCallback``
- ``PerfStatsCollectedCallback``
- ``MapLoadingErrorCallback``
- ``RenderFrameFinishedCallback``
- ``RenderFrameStartedCallback``
- ``ResourceRequestCallback``
- ``SourceAddedCallback``
- ``SourceDataLoadedCallback``
- ``SourceRemovedCallback``
- ``StyleDataLoadedCallback``
- ``StyleImageMissingCallback``
- ``MapIdleCallback``
- ``MapLoadedCallback``
- ``StyleImageRemoveUnusedCallback``
- ``StyleLoadedCallback``
### Free Camera
- <doc:Free-Camera>
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# CoreMaps - Internal

Maps rendering SDK also known as GL-Native. These are for internal use only.

## Topics

### Symbols
<!-- functions -->
- ``MBMMapLoadingErrorTypeToString(_:)``
- ``MBMRenderModeTypeToString(_:)``
- ``MBMRequestDataSourceTypeToString(_:)``
- ``MBMRequestErrorTypeToString(_:)``
- ``MBMRequestLoadingMethodTypeToString(_:)``
- ``MBMRequestPriorityTypeToString(_:)``
- ``MBMRequestPriorityTypeToString(_:)``
- ``MBMRequestResourceTypeToString(_:)``
- ``MBMResponseSourceTypeToString(_:)``
- ``MBMSourceDataLoadedTypeToString(_:)``
- ``MBMStyleDataLoadedTypeToString(_:)``
- ``MBMTileStoreUsageModeToString(_:)``

<!-- type aliases -->
- ``CameraChangedCallback``
- ``GenericEventCallback``
- ``PerfStatsCollectedCallback``
- ``MapLoadingErrorCallback``
- ``RenderFrameFinishedCallback``
- ``RenderFrameStartedCallback``
- ``ResourceRequestCallback``
- ``SourceAddedCallback``
- ``SourceDataLoadedCallback``
- ``SourceRemovedCallback``
- ``StyleDataLoadedCallback``
- ``StyleImageMissingCallback``
- ``MapIdleCallback``
- ``MapLoadedCallback``
- ``StyleImageRemoveUnusedCallback``
- ``StyleLoadedCallback``
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Free Camera

## Topics

### Symbols

- ``Vec3``
- ``Vec4``
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@
- ``CustomLayerRenderParameters``
- ``CustomLayerHost``
- ``ElevationData``
- ``Slot``
4 changes: 4 additions & 0 deletions Sources/MapboxMaps/Documentation.docc/Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,7 @@ The Mapbox Maps SDK for iOS is a public library for displaying interactive, thor
- <doc:CoreMaps>
- <doc:Common>
- <doc:Turf>

### Internal
- <doc:CoreMapsInternal>
- <doc:CommonInternal>

0 comments on commit bdd8d86

Please sign in to comment.