Improve docs by adding missing functions#4198
Conversation
acae6d1 to
9f45184
Compare
mfazekas
left a comment
There was a problem hiding this comment.
Thanks for going through all these components and filling in the missing JSDoc — the locationManager methods and Viewport docs in particular were a real gap.
One thing to fix: the @default for pitch in Viewport's FollowPuckOptions is changed to 0 degrees (top-down view), but the iOS SDK actually defaults to 45 degrees (see FollowPuckViewportStateOptions.swift: pitch: CGFloat? = 45). Should either use the correct value or keep referencing the constant name.
Thanks for the review and catching that! |
Description
While reviewing the docs I noticed that several public functions and types were missing JSDoc, so a number of docs/*.md pages were either empty or only listed prop names without any explanation. I went through the affected source files (locationManager, Camera, Viewport, UserLocation, LocationPuck, CustomLocationProvider, etc.), added the missing JSDoc, fixed a few typos along the way, and regenerated the markdown docs with yarn generate.
No runtime behavior is changed — this is documentation only.
Checklist
CONTRIBUTING.mdyarn generatein the root folder/exampleapp./example)