Merge pull request #2347 from mapbox/2314-jazzy-doc-actualization

Jazzy doc actualization
mapbox · Mar 11, 2020 · d7891cf · d7891cf
2 parents 9d78861 + c264a8f
commit d7891cf
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 35 deletions.
diff --git a/MapboxCoreNavigation/MBNavigator.swift b/MapboxCoreNavigation/MBNavigator.swift
@@ -14,6 +14,7 @@ extension MBFixLocation {
     }
 }
 
+/// :nodoc:
 extension MBRouteState: CustomStringConvertible {
     public var description: String {
         switch self {

diff --git a/MapboxNavigation-Documentation.podspec b/MapboxNavigation-Documentation.podspec
@@ -32,7 +32,7 @@ Pod::Spec.new do |s|
 
   # ――― Source Code ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
 
-  s.source_files = ["MapboxNavigation/*", "MapboxCoreNavigation/*"]
+  s.source_files = ["MapboxNavigation/**/*.swift","MapboxCoreNavigation"]
 
   # ――― Resources ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
 

diff --git a/MapboxNavigation/LanesStyleKit.swift b/MapboxNavigation/LanesStyleKit.swift
@@ -13,7 +13,7 @@
 
 import UIKit
 
-
+/// :nodoc:
 public class LanesStyleKit : NSObject {
 
     //// Drawing Methods

diff --git a/MapboxNavigation/ManeuverView.swift b/MapboxNavigation/ManeuverView.swift
@@ -3,7 +3,7 @@ import MapboxDirections
 import MapboxCoreNavigation
 import Turf
 
-/// :nodoc:
+/// A view that contains a simple image indicating a type of maneuver.
 @IBDesignable
 open class ManeuverView: UIView {
 

diff --git a/MapboxNavigation/ManeuversStyleKit.swift b/MapboxNavigation/ManeuversStyleKit.swift
@@ -1,6 +1,6 @@
 import UIKit
 
-
+/// :nodoc:
 public class ManeuversStyleKit: NSObject {
 
     //// Drawing Methods

diff --git a/MapboxNavigation/Style.swift b/MapboxNavigation/Style.swift
@@ -38,7 +38,7 @@ open class Style: NSObject {
     /**
      URL of the style to display on the map when previewing a route, for example on CarPlay or your own route preview map.
      */
-    @objc open var previewMapStyleURL = MGLStyle.navigationPreviewDayStyleURL
+    @objc open var previewMapStyleURL: URL = MGLStyle.navigationPreviewDayStyleURL
 
     /**
      Applies the style for all changed properties.
@@ -228,7 +228,7 @@ open class StylableLabel: UILabel {
     }
 }
 
-/// :nodoc
+/// :nodoc:
 @objc(MBStylableView)
 open class StylableView: UIView {
     @objc dynamic var borderWidth: CGFloat = 0.0 {

diff --git a/docs/jazzy.yml b/docs/jazzy.yml
@@ -22,16 +22,31 @@ custom_categories:
       - NavigationViewController
       - NavigationViewControllerDelegate
       - RouteVoiceController
+      - VoiceControllerDelegate
+      - MapboxVoiceController
+      - NavigationOptions
+      - NavigationView
   - name: Core Navigation Logic
     children:
       - NavigationService
+      - NavigationServiceDelegate
       - MapboxNavigationService
+      - Router
+      - RouterDataSource
       - RouteController
-      - RouteControllerDelegate
+      - RouterDelegate
       - RouteProgress
       - RouteLegProgress
       - RouteStepProgress
-      - RouteControllerNotificationUserInfoKey
+      - NavigationEventsManager
+      - EventsManagerDataSource
+      - NavigationLocationManager
+      - ReplayLocationManager
+      - SimulatedLocationManager
+      - NavigationRouteOptions
+      - NavigationMatchOptions
+      - NavigationDirections
+      - SimulationMode
   - name: Maps
     children:
       - NavigationMapView
@@ -40,50 +55,60 @@ custom_categories:
   - name: Styling
     children:
       - Style
-      - StyleKitArrows
-      - StylableButton
-      - StylableLabel
+      - StyleManager
+      - StyleManagerNotificationUserInfoKey
+      - StyleManagerDelegate
+      - DayStyle
+      - NightStyle
   - name: Formatters
     children:
       - DistanceFormatter
-      - RouteStepFormatter
   - name: UI Components
     children:
-      - RouteTableViewController
-      - NavigationPulleyViewController
-      - Button
-      - CellSubtitleLabel
-      - CellTitleLabel
-      - DashedLineView
-      - HighlightedButton
-      - LineView
-      - ProgressBar
-      - SeparatorView
-      - SubtitleLabel
-      - TitleLabel
-      - TurnArrowView
-      - WayNameLabel
+      - ManeuverView
+      - BottomBannerViewController
+      - BottomBannerViewControllerDelegate
+      - SpeedLimitView
+      - UserPuckCourseView
+      - CourseUpdatable
+      - GenericRouteShield
+      - NavigationComponent
   - name: CarPlay
     children:
       - CarPlayManager
       - CarPlayManagerDelegate
       - CarPlayNavigationViewController
       - CarPlayNavigationDelegate
       - CarPlayActivity
+      - CarPlayCompassView
+      - CarPlayMapViewController
+      - CarPlaySearchController
+      - CarPlayConnectionObserver
   - name: Configuration
     children:
-      - MaxSecondsSpentTravelingAwayFromStartOfRoute
       - RouteControllerDeadReckoningTimeInterval
+      - RouteControllerMediumAlertInterval
       - RouteControllerHighAlertInterval
       - RouteControllerManeuverZoneRadius
-      - RouteControllerMaxManipulatedCourseAngle
+      - RouteSnappingMaxManipulatedCourseAngle
       - RouteControllerMaximumAllowedDegreeOffsetForTurnCompletion
       - RouteControllerMaximumDistanceBeforeRecalculating
-      - RouteControllerMediumAlertInterval
-      - RouteControllerMinimumDistanceForHighAlertCycling
-      - RouteControllerMinimumDistanceForHighAlertDriving
-      - RouteControllerMinimumDistanceForHighAlertWalking
-      - RouteControllerMinimumDistanceForMediumAlertCycling
-      - RouteControllerMinimumDistanceForMediumAlertDriving
-      - RouteControllerMinimumDistanceForMediumAlertWalking
       - RouteControllerUserLocationSnappingDistance
+      - MBCongestionAttribute
+      - MBCurrentLegAttribute
+      - MBRouteLineWidthByZoomLevel
+      - NavigationMapViewMinimumDistanceForOverheadZooming
+      - NavigationViewMinimumVolumeForWarning
+      - RouteControllerIncorrectCourseMultiplier
+      - RouteControllerLinkedInstructionBufferMultiplier
+      - RouteControllerMaximumSpeedForUsingCurrentStep
+      - RouteControllerMinNumberOfInCorrectCourses
+      - RouteControllerMinimumBacktrackingDistanceForRerouting
+      - RouteControllerMinimumDistanceForContinueInstruction
+      - RouteControllerMinimumDurationRemainingForProactiveRerouting
+      - RouteControllerMinimumNumberLocationUpdatesBackwards
+      - RouteControllerNumberOfSecondsForRerouteFeedback
+      - RouteControllerProactiveReroutingInterval
+      - RouteSnappingMinimumHorizontalAccuracy
+      - RouteSnappingMinimumSpeed
+      - NavigationSettings