Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jazzy doc actualization #2347

Merged
merged 4 commits into from
Mar 11, 2020
Merged

Jazzy doc actualization #2347

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ddedabb
2314: fixed documantation podspec and removed deleted entities from .…
Mar 4, 2020
9fd092a
2314: appended new entities to jazzy categories
Mar 4, 2020
7e66c8f
2314: marked nodoc entities, added short doc to ManeuverView, explici…
Mar 10, 2020
c264a8f
2314: CI build fix. returned MapboxNavigation.podspec to it's origina…
Mar 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MapboxNavigation-Documentation.podspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Pod::Spec.new do |s|

# ――― Source Code ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #

s.source_files = ["MapboxNavigation/*", "MapboxCoreNavigation/*"]
s.source_files = ["MapboxNavigation/**/*.{h,m,swift}","MapboxCoreNavigation"]

# ――― Resources ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #

Expand Down
78 changes: 59 additions & 19 deletions docs/jazzy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,68 +22,108 @@ custom_categories:
- NavigationViewController
- NavigationViewControllerDelegate
- RouteVoiceController
- VoiceControllerDelegate
- MapboxVoiceController
- NavigationOptions
- NavigationView
Comment on lines +25 to +28
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to group items to where they belong, but I might be mistaken :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good place to put these types. 👍

- 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
- NavigationMapViewDelegate
- MGLMapView
- name: Styling
children:
- LanesStyleKit
- ManeuversStyleKit
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These classes are internal implementation details that don’t have any documentation, so we don’t need to list them in the table of contents. If they’re triggering jazzy warnings, let’s add a :nodoc: comment to them.

- Style
- StyleKitArrows
- StylableButton
- StylableLabel
- StylableView
- StylableTextView
- StylableButton
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These classes are :nodoc:’d because they’re intentionally left undocumented: the NSAppearance system requires them to be public, but developers unknowingly use them as proxy objects when configuring the appearance of the associated views.

- 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
- ManeuverView
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wow, this class got renamed a long time ago in #745. 😅 ManeuverView is marked :nodoc:, but we should actually document it, because developers may need to adjust its appearance() when creating a new Style. Let’s go with this description for now:

A view that contains a simple image indicating a type of maneuver.

- WayNameLabel
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some Items are explicitly marked with :nodoc:. Seems like we need to provide some description to include them.

- 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
Comment on lines +97 to +99
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somehow we missed these constants when removing the class prefix from global symbols. As a separate task, we should rename these symbols to remove the class prefix. To avoid conflicts with other modules, we should nest them inside the class that uses them, NavigationMapView.

/cc @JThramer

- NavigationMapViewMinimumDistanceForOverheadZooming
- NavigationViewMinimumVolumeForWarning
- RouteControllerIncorrectCourseMultiplier
- RouteControllerLinkedInstructionBufferMultiplier
- RouteControllerMaximumSpeedForUsingCurrentStep
- RouteControllerMinNumberOfInCorrectCourses
- RouteControllerMinimumBacktrackingDistanceForRerouting
- RouteControllerMinimumDistanceForContinueInstruction
- RouteControllerMinimumDurationRemainingForProactiveRerouting
- RouteControllerMinimumNumberLocationUpdatesBackwards
- RouteControllerNumberOfSecondsForRerouteFeedback
- RouteControllerProactiveReroutingInterval
- RouteSnappingMinimumHorizontalAccuracy
- RouteSnappingMinimumSpeed
- NavigationSettings