Stylable UI components should be documented.

mapbox / mapbox-navigation-ios

Turn-by-turn navigation logic and UI in Swift on iOS

https://docs.mapbox.com/ios/navigation/

Other

862 stars 311 forks source link

Stylable UI components should be documented. #3584

Open MaximAlien opened 2 years ago

MaximAlien commented 2 years ago

In scope of this ticket UI components, which are available publicly and marked with /// :nodoc: should be documented. Some examples include classes in Style.swift, WayNameView.swift, NextBannerView.swift etc.

1ec5 commented 2 years ago

In the process, we should ensure that the various class members are named according to Swift/Cocoa naming conventions. Some of them might be a bit rough. Renaming these members generally shouldn’t break backwards compatibility, except that we have documented some of them being used as part of a Style subclass.