Jazzy doc actualization #2347
Jazzy doc actualization #2347
Conversation
Udumft
added
topic: documentation
build
| - VoiceControllerDelegate | ||
| - MapboxVoiceController | ||
| - NavigationOptions | ||
| - NavigationView |
There was a problem hiding this comment.
I tried to group items to where they belong, but I might be mistaken :)
There was a problem hiding this comment.
This is a good place to put these types. 👍
docs/jazzy.yml
Outdated
| - DashedLineView | ||
| - HighlightedButton | ||
| - LineView | ||
| - ProgressBar | ||
| - SeparatorView | ||
| - SubtitleLabel | ||
| - TitleLabel | ||
| - TurnArrowView | ||
| - ManeuverView | ||
| - WayNameLabel |
There was a problem hiding this comment.
Some Items are explicitly marked with :nodoc:. Seems like we need to provide some description to include them.
|
I could use some help with checking what to do with |
| - VoiceControllerDelegate | ||
| - MapboxVoiceController | ||
| - NavigationOptions | ||
| - NavigationView |
There was a problem hiding this comment.
This is a good place to put these types. 👍
docs/jazzy.yml
Outdated
| - name: Maps | ||
| children: | ||
| - NavigationMapView | ||
| - NavigationMapViewDelegate | ||
| - MGLMapView | ||
| - name: Styling | ||
| children: | ||
| - LanesStyleKit | ||
| - ManeuversStyleKit |
There was a problem hiding this comment.
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.
docs/jazzy.yml
Outdated
| - StylableView | ||
| - StylableTextView | ||
| - StylableButton |
There was a problem hiding this comment.
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.
| - DashedLineView | ||
| - HighlightedButton | ||
| - LineView | ||
| - ProgressBar | ||
| - SeparatorView | ||
| - SubtitleLabel | ||
| - TitleLabel | ||
| - TurnArrowView | ||
| - ManeuverView |
There was a problem hiding this comment.
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.
| - MBCongestionAttribute | ||
| - MBCurrentLegAttribute | ||
| - MBRouteLineWidthByZoomLevel |
There was a problem hiding this comment.
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
…tly specified type for Style.previewMapStyleURL for correct doc generation, updated podspec source file search mask, actualized jazzy config for custom categories.
| @@ -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 | |||
There was a problem hiding this comment.
Added type explicitly to silence Jazzy warning and correct type displaying in a doc.
Resolves #2314.
This PR actualizes Jazzy config with current public classes, protocols and other entities.
I tried to group all entities to where they belong.